/**
* @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import LinkEditing from '../src/linkediting';
import LinkCommand from '../src/linkcommand';
import UnlinkCommand from '../src/unlinkcommand';
import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import Enter from '@ckeditor/ckeditor5-enter/src/enter';
import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
import { isLinkElement } from '../src/utils';
import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
import { downcastAttributeToElement } from '@ckeditor/ckeditor5-engine/src/conversion/downcast-converters';
/* global document */
describe( 'LinkEditing', () => {
let editor, model, view;
beforeEach( () => {
return VirtualTestEditor
.create( {
plugins: [ Paragraph, LinkEditing, Enter ]
} )
.then( newEditor => {
editor = newEditor;
model = editor.model;
view = editor.editing.view;
} );
} );
it( 'should be loaded', () => {
expect( editor.plugins.get( LinkEditing ) ).to.be.instanceOf( LinkEditing );
} );
it( 'should set proper schema rules', () => {
expect( model.schema.checkAttribute( [ '$block', '$text' ], 'linkHref' ) ).to.be.true;
expect( model.schema.checkAttribute( [ '$clipboardHolder', '$text' ], 'linkHref' ) ).to.be.true;
expect( model.schema.checkAttribute( [ '$block' ], 'linkHref' ) ).to.be.false;
} );
it( 'should bind two-step caret movement to `linkHref` attribute', () => {
// Let's check only the minimum to not duplicated `bindTwoStepCaretToAttribute()` tests.
// Testing minimum is better then testing using spies that might give false positive results.
// Put selection before the link element.
setModelData( editor.model, 'foo[]<$text linkHref="url">b$text>ar' );
// The selection's gravity is not overridden because selection land here not as a result of `keydown`.
expect( editor.model.document.selection.isGravityOverridden ).to.false;
// So let's simulate `keydown` event.
editor.editing.view.document.fire( 'keydown', {
keyCode: keyCodes.arrowright,
preventDefault: () => {},
domTarget: document.body
} );
expect( editor.model.document.selection.isGravityOverridden ).to.true;
} );
describe( 'command', () => {
it( 'should register link command', () => {
const command = editor.commands.get( 'link' );
expect( command ).to.be.instanceOf( LinkCommand );
} );
it( 'should register unlink command', () => {
const command = editor.commands.get( 'unlink' );
expect( command ).to.be.instanceOf( UnlinkCommand );
} );
} );
describe( 'data pipeline conversions', () => {
it( 'should convert `` to `linkHref="url"` attribute', () => {
editor.setData( 'foobar
' );
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '<$text linkHref="url">foo$text>bar' );
expect( editor.getData() ).to.equal( 'foobar
' );
} );
it( 'should be integrated with autoparagraphing', () => {
editor.setData( 'foobar' );
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '<$text linkHref="url">foo$text>bar' );
expect( editor.getData() ).to.equal( '
foobar
' );
} );
// https://github.com/ckeditor/ckeditor5/issues/500
it( 'should not pick up ``', () => {
editor.setData( 'foobar
' );
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( 'foobar' );
} );
// CKEditor 4 does. And CKEditor 5's balloon allows creating such links.
it( 'should pick up ``', () => {
editor.setData( 'foobar
' );
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '<$text linkHref="">foo$text>bar' );
expect( editor.getData() ).to.equal( 'foobar
' );
} );
} );
describe( 'editing pipeline conversion', () => {
it( 'should convert attribute', () => {
setModelData( model, '<$text linkHref="url">foo$text>bar' );
expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal( 'foobar
' );
} );
it( 'should convert to link element instance', () => {
setModelData( model, '<$text linkHref="url">foo$text>bar' );
const element = editor.editing.view.document.getRoot().getChild( 0 ).getChild( 0 );
expect( isLinkElement( element ) ).to.be.true;
} );
// https://github.com/ckeditor/ckeditor5-link/issues/121
it( 'should should set priority for `linkHref` higher than all other attribute elements', () => {
model.schema.extend( '$text', { allowAttributes: 'foo' } );
editor.conversion.for( 'downcast' ).add( downcastAttributeToElement( { model: 'foo', view: 'f' } ) );
setModelData( model,
'' +
'<$text linkHref="url">a$text><$text foo="true" linkHref="url">b$text><$text linkHref="url">c$text>' +
'' );
expect( editor.getData() ).to.equal( 'abc
' );
} );
} );
describe( 'highlight link boundaries', () => {
it( 'should create marker in model when selection is inside a link', () => {
expect( model.markers.has( 'linkBoundaries' ) ).to.be.false;
setModelData( model,
'foo <$text linkHref="url">b{}ar$text> baz'
);
expect( model.markers.has( 'linkBoundaries' ) ).to.be.true;
const marker = model.markers.get( 'linkBoundaries' );
expect( marker.getStart().path ).to.deep.equal( [ 0, 4 ] );
expect( marker.getEnd().path ).to.deep.equal( [ 0, 7 ] );
} );
it( 'should convert link boundaries marker to proper view', () => {
setModelData( model,
'foo <$text linkHref="url">b{}ar$text> baz'
);
expect( getViewData( view ) ).to.equal(
'foo b{}ar baz
'
);
} );
it( 'should work whenever selection has linkHref attribute', () => {
setModelData( model,
'foo {}<$text linkHref="url">bar$text> baz'
);
expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.false;
model.change( writer => {
writer.setSelectionAttribute( 'linkHref', 'url' );
} );
expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.true;
expect( model.markers.has( 'linkBoundaries' ) ).to.be.true;
const marker = model.markers.get( 'linkBoundaries' );
expect( marker.getStart().path ).to.deep.equal( [ 0, 4 ] );
expect( marker.getEnd().path ).to.deep.equal( [ 0, 7 ] );
} );
it( 'should render highlight correctly after splitting the link', () => {
setModelData( model,
'foo <$text linkHref="url">li{}nk$text> baz'
);
editor.execute( 'enter' );
expect( getModelData( model ) ).to.equal(
'foo <$text linkHref="url">li$text>' +
'<$text linkHref="url">[]nk$text> baz'
);
expect( model.document.selection.hasAttribute( 'linkHref' ) ).to.be.true;
expect( model.markers.has( 'linkBoundaries' ) ).to.be.true;
const marker = model.markers.get( 'linkBoundaries' );
expect( marker.getStart().path ).to.deep.equal( [ 1, 0 ] );
expect( marker.getEnd().path ).to.deep.equal( [ 1, 2 ] );
} );
} );
} );