/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import VirtualTestEditor from 'ckeditor5-core/tests/_utils/virtualtesteditor';
import Widget from 'ckeditor5-image/src/widget/widget';
import MouseObserver from 'ckeditor5-engine/src/view/observer/mouseobserver';
import buildModelConverter from 'ckeditor5-engine/src/conversion/buildmodelconverter';
import { widgetize } from 'ckeditor5-image/src/widget/utils';
import ViewContainer from 'ckeditor5-engine/src/view/containerelement';
import DomEventData from 'ckeditor5-engine/src/view/observer/domeventdata';
import AttributeContainer from 'ckeditor5-engine/src/view/attributeelement';
import { setData as setModelData, getData as getModelData } from 'ckeditor5-engine/src/dev-utils/model';
import { keyCodes } from 'ckeditor5-utils/src/keyboard';
/* global document */
describe( 'Widget', () => {
let editor, doc, viewDocument;
beforeEach( () => {
return VirtualTestEditor.create( {
plugins: [ Widget ]
} )
.then( newEditor => {
editor = newEditor;
doc = editor.document;
viewDocument = editor.editing.view;
doc.schema.registerItem( 'widget', '$block' );
doc.schema.objects.add( 'widget' );
doc.schema.registerItem( 'paragraph', '$block' );
doc.schema.registerItem( 'inline', '$inline' );
doc.schema.objects.add( 'inline' );
buildModelConverter().for( editor.editing.modelToView )
.fromElement( 'paragraph' )
.toElement( 'p' );
buildModelConverter().for( editor.editing.modelToView )
.fromElement( 'widget' )
.toElement( () => {
const b = new AttributeContainer( 'b' );
const div = new ViewContainer( 'div', null, b );
return widgetize( div );
} );
buildModelConverter().for( editor.editing.modelToView )
.fromElement( 'inline' )
.toElement( 'figure' );
} );
} );
it( 'should be loaded', () => {
expect( editor.plugins.get( Widget ) ).to.be.instanceOf( Widget );
} );
it( 'should add MouseObserver', () => {
expect( editor.editing.view.getObserver( MouseObserver ) ).to.be.instanceof( MouseObserver );
} );
it( 'should create selection over clicked widget', () => {
setModelData( doc, '[]' );
const viewDiv = viewDocument.getRoot().getChild( 0 );
const domEventDataMock = {
target: viewDiv,
preventDefault: sinon.spy()
};
viewDocument.fire( 'mousedown', domEventDataMock );
expect( getModelData( doc ) ).to.equal( '[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
} );
it( 'should create selection when clicked in nested element', () => {
setModelData( doc, '[]' );
const viewDiv = viewDocument.getRoot().getChild( 0 );
const viewB = viewDiv.getChild( 0 );
const domEventDataMock = {
target: viewB,
preventDefault: sinon.spy()
};
viewDocument.fire( 'mousedown', domEventDataMock );
expect( getModelData( doc ) ).to.equal( '[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
} );
it( 'should do nothing if clicked in non-widget element', () => {
setModelData( doc, '[]foo bar' );
const viewP = viewDocument.getRoot().getChild( 0 );
const domEventDataMock = {
target: viewP,
preventDefault: sinon.spy()
};
viewDocument.focus();
viewDocument.fire( 'mousedown', domEventDataMock );
expect( getModelData( doc ) ).to.equal( '[]foo bar' );
sinon.assert.notCalled( domEventDataMock.preventDefault );
} );
it( 'should not focus editable if already is focused', () => {
setModelData( doc, '' );
const widget = viewDocument.getRoot().getChild( 0 );
const domEventDataMock = {
target: widget,
preventDefault: sinon.spy()
};
const focusSpy = sinon.spy( viewDocument, 'focus' );
viewDocument.isFocused = true;
viewDocument.fire( 'mousedown', domEventDataMock );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
sinon.assert.notCalled( focusSpy );
expect( getModelData( doc ) ).to.equal( '[]' );
} );
describe( 'keys handling', () => {
describe( 'delete and backspace', () => {
test(
'should select widget when backspace is pressed',
'[]foo',
keyCodes.backspace,
'[]foo'
);
test(
'should remove empty element after selecting widget when backspace is pressed',
'[]',
keyCodes.backspace,
'[]'
);
test(
'should select widget when delete is pressed',
'foo[]',
keyCodes.delete,
'foo[]'
);
test(
'should remove empty element after selecting widget when delete is pressed',
'[]',
keyCodes.delete,
'[]'
);
test(
'should not respond to other keys',
'[]foo',
65,
'[]foo'
);
test(
'should do nothing on non-collapsed selection',
'[f]oo',
keyCodes.backspace,
'[f]oo'
);
test(
'should do nothing on non-object elements',
'foo[]bar',
keyCodes.backspace,
'foo[]bar'
);
test(
'should work correctly with modifier key: backspace + ctrl',
'[]foo',
{ keyCode: keyCodes.backspace, ctrlKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: backspace + alt',
'[]foo',
{ keyCode: keyCodes.backspace, altKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: backspace + shift',
'[]foo',
{ keyCode: keyCodes.backspace, shiftKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: delete + ctrl',
'foo[]',
{ keyCode: keyCodes.delete, ctrlKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: delete + alt',
'foo[]',
{ keyCode: keyCodes.delete, altKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: delete + shift',
'foo[]',
{ keyCode: keyCodes.delete, shiftKey: true },
'foo[]'
);
test(
'should not modify backspace default behaviour in single paragraph boundaries',
'[]foo',
keyCodes.backspace,
'[]foo'
);
test(
'should not modify delete default behaviour in single paragraph boundaries',
'foo[]',
keyCodes.delete,
'foo[]'
);
test(
'should do nothing on selected widget preceded by a paragraph - backspace',
'foo[]',
keyCodes.backspace,
'foo[]'
);
test(
'should do nothing on selected widget preceded by another widget - backspace',
'[]',
keyCodes.backspace,
'[]'
);
test(
'should do nothing on selected widget before paragraph - backspace',
'[]foo',
keyCodes.backspace,
'[]foo'
);
test(
'should do nothing on selected widget before another widget - backspace',
'[]',
keyCodes.backspace,
'[]'
);
test(
'should do nothing on selected widget between paragraphs - backspace',
'bar[]foo',
keyCodes.backspace,
'bar[]foo'
);
test(
'should do nothing on selected widget between other widgets - backspace',
'[]',
keyCodes.backspace,
'[]'
);
test(
'should do nothing on selected widget preceded by a paragraph - delete',
'foo[]',
keyCodes.delete,
'foo[]'
);
test(
'should do nothing on selected widget preceded by another widget - delete',
'[]',
keyCodes.delete,
'[]'
);
test(
'should do nothing on selected widget before paragraph - delete',
'[]foo',
keyCodes.delete,
'[]foo'
);
test(
'should do nothing on selected widget before another widget - delete',
'[]',
keyCodes.delete,
'[]'
);
test(
'should do nothing on selected widget between paragraphs - delete',
'bar[]foo',
keyCodes.delete,
'bar[]foo'
);
test(
'should do nothing on selected widget between other widgets - delete',
'[]',
keyCodes.delete,
'[]'
);
test(
'should select inline objects - backspace',
'foo[]bar',
keyCodes.backspace,
'foo[]bar'
);
test(
'should select inline objects - delete',
'foo[]bar',
keyCodes.delete,
'foo[]bar'
);
test(
'should do nothing on selected inline objects - backspace',
'foo[]bar',
keyCodes.backspace,
'foo[]bar'
);
test(
'should do nothing on selected inline objects - delete',
'foo[]bar',
keyCodes.delete,
'foo[]bar'
);
test(
'should do nothing if selection is placed after first letter - backspace',
'a[]',
keyCodes.backspace,
'a[]'
);
test(
'should do nothing if selection is placed before first letter - delete',
'[]a',
keyCodes.delete,
'[]a'
);
it( 'should prevent default behaviour and stop event propagation', () => {
const keydownHandler = sinon.spy();
const domEventDataMock = {
keyCode: keyCodes.delete,
preventDefault: sinon.spy(),
};
setModelData( doc, 'foo[]' );
viewDocument.on( 'keydown', keydownHandler );
viewDocument.fire( 'keydown', domEventDataMock );
expect( getModelData( doc ) ).to.equal( 'foo[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
sinon.assert.notCalled( keydownHandler );
} );
} );
describe( 'arrows', () => {
test(
'should move selection forward from selected object - right arrow',
'[]foo',
keyCodes.arrowright,
'[]foo'
);
test(
'should move selection forward from selected object - down arrow',
'[]foo',
keyCodes.arrowdown,
'[]foo'
);
test(
'should move selection backward from selected object - left arrow',
'foo[]',
keyCodes.arrowleft,
'foo[]'
);
test(
'should move selection backward from selected object - up arrow',
'foo[]',
keyCodes.arrowup,
'foo[]'
);
test(
'should move selection to next widget - right arrow',
'[]',
keyCodes.arrowright,
'[]'
);
test(
'should move selection to next widget - down arrow',
'[]',
keyCodes.arrowdown,
'[]'
);
test(
'should move selection to previous widget - left arrow',
'[]',
keyCodes.arrowleft,
'[]'
);
test(
'should move selection to previous widget - up arrow',
'[]',
keyCodes.arrowup,
'[]'
);
test(
'should do nothing on non-collapsed selection next to object - right arrow',
'ba[r]',
keyCodes.arrowright,
'ba[r]'
);
test(
'should do nothing on non-collapsed selection next to object - down arrow',
'ba[r]',
keyCodes.arrowdown,
'ba[r]'
);
test(
'should do nothing on non-collapsed selection next to object - left arrow',
'[b]ar',
keyCodes.arrowleft,
'[b]ar'
);
test(
'should do nothing on non-collapsed selection next to object - up arrow',
'[b]ar',
keyCodes.arrowup,
'[b]ar'
);
test(
'should not move selection if there is no correct location - right arrow',
'foo[]',
keyCodes.arrowright,
'foo[]'
);
test(
'should not move selection if there is no correct location - down arrow',
'foo[]',
keyCodes.arrowdown,
'foo[]'
);
test(
'should not move selection if there is no correct location - left arrow',
'[]foo',
keyCodes.arrowleft,
'[]foo'
);
test(
'should not move selection if there is no correct location - up arrow',
'[]foo',
keyCodes.arrowup,
'[]foo'
);
it( 'should prevent default behaviour when there is no correct location - document end', () => {
const keydownHandler = sinon.spy();
const domEventDataMock = {
keyCode: keyCodes.arrowright,
preventDefault: sinon.spy(),
};
setModelData( doc, 'foo[]' );
viewDocument.on( 'keydown', keydownHandler );
viewDocument.fire( 'keydown', domEventDataMock );
expect( getModelData( doc ) ).to.equal( 'foo[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
sinon.assert.notCalled( keydownHandler );
} );
it( 'should prevent default behaviour when there is no correct location - document start', () => {
const keydownHandler = sinon.spy();
const domEventDataMock = {
keyCode: keyCodes.arrowleft,
preventDefault: sinon.spy(),
};
setModelData( doc, '[]foo' );
viewDocument.on( 'keydown', keydownHandler );
viewDocument.fire( 'keydown', domEventDataMock );
expect( getModelData( doc ) ).to.equal( '[]foo' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
sinon.assert.notCalled( keydownHandler );
} );
test(
'should move selection to object element - right arrow',
'foo[]',
keyCodes.arrowright,
'foo[]'
);
test(
'should move selection to object element - down arrow',
'foo[]',
keyCodes.arrowdown,
'foo[]'
);
test(
'should move selection to object element - left arrow',
'[]foo',
keyCodes.arrowleft,
'[]foo'
);
test(
'should move selection to object element - up arrow',
'[]foo',
keyCodes.arrowup,
'[]foo'
);
test(
'do nothing on non objects - right arrow',
'foo[]bar',
keyCodes.arrowright,
'foo[]bar'
);
test(
'do nothing on non objects - down arrow',
'foo[]bar',
keyCodes.arrowdown,
'foo[]bar'
);
test(
'do nothing on non objects - left arrow',
'foo[]bar',
keyCodes.arrowleft,
'foo[]bar'
);
test(
'do nothing on non objects - up arrow',
'foo[]bar',
keyCodes.arrowup,
'foo[]bar'
);
test(
'should work correctly with modifier key: right arrow + ctrl',
'[]foo',
{ keyCode: keyCodes.arrowright, ctrlKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: right arrow + alt',
'[]foo',
{ keyCode: keyCodes.arrowright, altKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: right arrow + shift',
'[]foo',
{ keyCode: keyCodes.arrowright, shiftKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: down arrow + ctrl',
'[]foo',
{ keyCode: keyCodes.arrowdown, ctrlKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: down arrow + alt',
'[]foo',
{ keyCode: keyCodes.arrowdown, altKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: down arrow + shift',
'[]foo',
{ keyCode: keyCodes.arrowdown, shiftKey: true },
'[]foo'
);
test(
'should work correctly with modifier key: left arrow + ctrl',
'foo[]',
{ keyCode: keyCodes.arrowleft, ctrlKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: left arrow + alt',
'foo[]',
{ keyCode: keyCodes.arrowleft, altKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: left arrow + shift',
'foo[]',
{ keyCode: keyCodes.arrowleft, shiftKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: up arrow + ctrl',
'foo[]',
{ keyCode: keyCodes.arrowup, ctrlKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: up arrow + alt',
'foo[]',
{ keyCode: keyCodes.arrowup, altKey: true },
'foo[]'
);
test(
'should work correctly with modifier key: up arrow + shift',
'foo[]',
{ keyCode: keyCodes.arrowup, shiftKey: true },
'foo[]'
);
test(
'should do nothing if there is more than one selection in model',
'[foo][bar]',
keyCodes.arrowright,
'[foo][bar]'
);
} );
function test( name, data, keyCodeOrMock, expected ) {
it( name, () => {
const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
keyCode: keyCodeOrMock
};
setModelData( doc, data );
viewDocument.fire( 'keydown', new DomEventData(
viewDocument,
{ target: document.createElement( 'div' ), preventDefault: () => {} },
domEventDataMock
) );
expect( getModelData( doc ) ).to.equal( expected );
} );
}
} );
} );