/**
* @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import VirtualTestEditor from 'tests/core/_utils/virtualtesteditor.js';
import Widget from 'ckeditor5/image/widget/widget.js';
import MouseObserver from 'ckeditor5/engine/view/observer/mouseobserver.js';
import buildModelConverter from 'ckeditor5/engine/conversion/buildmodelconverter.js';
import { widgetize } from 'ckeditor5/image/widget/utils.js';
import ViewContainer from 'ckeditor5/engine/view/containerelement.js';
import AttributeContainer from 'ckeditor5/engine/view/attributeelement.js';
import { setData as setModelData, getData as getModelData } from 'ckeditor5/engine/dev-utils/model.js';
import { keyCodes } from 'ckeditor5/utils/keyboard.js';
describe( 'Widget', () => {
let editor, document, viewDocument;
beforeEach( () => {
return VirtualTestEditor.create( {
plugins: [ Widget ]
} )
.then( newEditor => {
editor = newEditor;
document = editor.document;
viewDocument = editor.editing.view;
document.schema.registerItem( 'widget', '$block' );
document.schema.objects.add( 'widget' );
document.schema.registerItem( 'paragraph', '$block' );
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 );
} );
} );
} );
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( document, '[]' );
const viewDiv = viewDocument.getRoot().getChild( 0 );
const domEventDataMock = {
target: viewDiv,
preventDefault: sinon.spy()
};
viewDocument.fire( 'mousedown', domEventDataMock );
expect( getModelData( document ) ).to.equal( '[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
} );
it( 'should create selection when clicked in nested element', () => {
setModelData( document, '[]' );
const viewDiv = viewDocument.getRoot().getChild( 0 );
const viewB = viewDiv.getChild( 0 );
const domEventDataMock = {
target: viewB,
preventDefault: sinon.spy()
};
viewDocument.fire( 'mousedown', domEventDataMock );
expect( getModelData( document ) ).to.equal( '[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
} );
it( 'should do nothing if clicked in non-widget element', () => {
setModelData( document, '[]foo bar' );
const viewP = viewDocument.getRoot().getChild( 0 );
const domEventDataMock = {
target: viewP,
preventDefault: sinon.spy()
};
viewDocument.focus();
viewDocument.fire( 'mousedown', domEventDataMock );
expect( getModelData( document ) ).to.equal( '[]foo bar' );
sinon.assert.notCalled( domEventDataMock.preventDefault );
} );
it( 'should not focus editable if already is focused', () => {
setModelData( document, '' );
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( document ) ).to.equal( '[]' );
} );
describe( 'delete and backspace handling', () => {
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 od nothing when entering non-object elements',
'foo[]bar',
keyCodes.backspace,
'foo[]bar'
);
test(
'should work correctly with modifier key: backspace + ctrl',
'[]foo',
{ keyCode: keyCodes.backspace, ctrlKey: true, preventDefault: () => {} },
'[]foo'
);
test(
'should work correctly with modifier key: backspace + alt',
'[]foo',
{ keyCode: keyCodes.backspace, altKey: true, preventDefault: () => {} },
'[]foo'
);
test(
'should work correctly with modifier key: backspace + shift',
'[]foo',
{ keyCode: keyCodes.backspace, shiftKey: true, preventDefault: () => {} },
'[]foo'
);
test(
'should work correctly with modifier key: delete + ctrl',
'foo[]',
{ keyCode: keyCodes.delete, ctrlKey: true, preventDefault: () => {} },
'foo[]'
);
test(
'should work correctly with modifier key: delete + alt',
'foo[]',
{ keyCode: keyCodes.delete, altKey: true, preventDefault: () => {} },
'foo[]'
);
test(
'should work correctly with modifier key: delete + shift',
'foo[]',
{ keyCode: keyCodes.delete, shiftKey: true, preventDefault: () => {} },
'foo[]'
);
it( 'should prevent default behaviour and stop event propagation', () => {
const keydownHandler = sinon.spy();
const domEventDataMock = {
keyCode: keyCodes.delete,
preventDefault: sinon.spy()
};
setModelData( document, 'foo[]' );
viewDocument.on( 'keydown', keydownHandler );
viewDocument.fire( 'keydown', domEventDataMock );
expect( getModelData( document ) ).to.equal( 'foo[]' );
sinon.assert.calledOnce( domEventDataMock.preventDefault );
sinon.assert.notCalled( keydownHandler );
} );
function test( name, data, keyCodeOrMock, expected ) {
it( name, () => {
const domEventDataMock = ( typeof keyCodeOrMock == 'object' ) ? keyCodeOrMock : {
keyCode: keyCodeOrMock,
preventDefault: () => {}
};
setModelData( document, data );
viewDocument.fire( 'keydown', domEventDataMock );
expect( getModelData( document ) ).to.equal( expected );
} );
}
} );
} );