/* * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ /* global document */ import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor'; import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor'; import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; import Bold from '@ckeditor/ckeditor5-basic-styles/src/boldengine'; import Italic from '@ckeditor/ckeditor5-basic-styles/src/italicengine'; import LinkEngine from '@ckeditor/ckeditor5-link/src/linkengine'; import Input from '../src/input'; import Batch from '@ckeditor/ckeditor5-engine/src/model/batch'; import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range'; import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter'; import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter'; import ViewText from '@ckeditor/ckeditor5-engine/src/view/text'; import ViewElement from '@ckeditor/ckeditor5-engine/src/view/element'; import ViewContainerElement from '@ckeditor/ckeditor5-engine/src/view/containerelement'; import ViewSelection from '@ckeditor/ckeditor5-engine/src/view/selection'; import MutationObserver from '@ckeditor/ckeditor5-engine/src/view/observer/mutationobserver'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard'; 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'; describe( 'Input feature', () => { let editor, model, modelRoot, view, viewRoot, listenter; testUtils.createSinonSandbox(); before( () => { listenter = Object.create( EmitterMixin ); return VirtualTestEditor .create( { plugins: [ Input, Paragraph ] } ) .then( newEditor => { // Mock image feature. newEditor.document.schema.registerItem( 'image', '$inline' ); buildModelConverter().for( newEditor.data.modelToView, newEditor.editing.modelToView ) .fromElement( 'image' ) .toElement( 'img' ); buildViewConverter().for( newEditor.data.viewToModel ) .fromElement( 'img' ) .toElement( 'image' ); editor = newEditor; model = editor.editing.model; modelRoot = model.getRoot(); view = editor.editing.view; viewRoot = view.getRoot(); } ); } ); after( () => { return editor.destroy(); } ); beforeEach( () => { editor.setData( '
foobar
' ); model.enqueueChanges( () => { model.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 3, modelRoot.getChild( 0 ), 3 ) ] ); } ); } ); afterEach( () => { listenter.stopListening(); } ); describe( 'mutations handling', () => { it( 'should handle text mutation', () => { view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'fooxbar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foox{}bar
' ); } ); it( 'should handle text mutation change', () => { view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foodar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'food{}ar
' ); } ); it( 'should handle text node insertion', () => { editor.setData( '' ); view.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'x' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'x{}
' ); } ); it( 'should do nothing when two nodes were inserted', () => { editor.setData( '' ); view.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'x' ), new ViewElement( 'img' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( '[]
' ); } ); it( 'should do nothing when two nodes were inserted and one removed', () => { view.fire( 'mutations', [ { type: 'children', oldChildren: [ new ViewText( 'foobar' ) ], newChildren: [ new ViewText( 'x' ), new ViewElement( 'img' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foo{}bar
' ); } ); it( 'should handle multiple children in the node', () => { editor.setData( 'foo
foox{}
foo{}bar
' ); } ); it( 'should do nothing when element was inserted', () => { editor.setData( '' ); view.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewElement( 'img' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( '[]
' ); } ); it( 'should set model selection appropriately to view selection passed in mutations event', () => { // This test case emulates spellchecker correction. const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( viewRoot.getChild( 0 ).getChild( 0 ), 6 ); view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foodar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( getModelData( model ) ).to.equal( 'foodar{}
' ); } ); it( 'should use up to one insert and remove operations (spellchecker)', () => { // This test case emulates spellchecker correction. const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( viewRoot.getChild( 0 ).getChild( 0 ), 6 ); testUtils.sinon.spy( Batch.prototype, 'weakInsert' ); testUtils.sinon.spy( Batch.prototype, 'remove' ); view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'fxobxr', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( Batch.prototype.weakInsert.calledOnce ).to.be.true; expect( Batch.prototype.remove.calledOnce ).to.be.true; } ); it( 'should place selection after when correcting to longer word (spellchecker)', () => { // This test case emulates spellchecker correction. editor.setData( 'Foo hous a
' ); const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( viewRoot.getChild( 0 ).getChild( 0 ), 9 ); view.fire( 'mutations', [ { type: 'text', oldText: 'Foo hous a', newText: 'Foo house a', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( getModelData( model ) ).to.equal( 'Foo house{} a
' ); } ); it( 'should place selection after when correcting to shorter word (spellchecker)', () => { // This test case emulates spellchecker correction. editor.setData( 'Bar athat foo
' ); const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( viewRoot.getChild( 0 ).getChild( 0 ), 8 ); view.fire( 'mutations', [ { type: 'text', oldText: 'Bar athat foo', newText: 'Bar that foo', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( getModelData( model ) ).to.equal( 'Bar that{} foo
' ); } ); it( 'should place selection after when merging two words (spellchecker)', () => { // This test case emulates spellchecker correction. editor.setData( 'Foo hous e
' ); const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( viewRoot.getChild( 0 ).getChild( 0 ), 9 ); view.fire( 'mutations', [ { type: 'text', oldText: 'Foo hous e', newText: 'Foo house', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( getModelData( model ) ).to.equal( 'Foo house{}
' ); } ); it( 'should place non-collapsed selection after changing single character (composition)', () => { editor.setData( 'Foo house
' ); const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( viewRoot.getChild( 0 ).getChild( 0 ), 8 ); viewSelection.moveFocusTo( viewRoot.getChild( 0 ).getChild( 0 ), 9 ); view.fire( 'mutations', [ { type: 'text', oldText: 'Foo house', newText: 'Foo housa', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( getModelData( model ) ).to.equal( 'Foo hous{a}
' ); } ); it( 'should replace last with space', () => { model.enqueueChanges( () => { model.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 6, modelRoot.getChild( 0 ), 6 ) ] ); } ); view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foobar\u00A0', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foobar {}
' ); } ); it( 'should replace first with space', () => { model.enqueueChanges( () => { model.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 0, modelRoot.getChild( 0 ), 0 ) ] ); } ); view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: '\u00A0foobar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( '{}foobar
' ); } ); it( 'should replace all with spaces', () => { model.enqueueChanges( () => { model.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 6, modelRoot.getChild( 0 ), 6 ) ] ); } ); view.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foobar\u00A0\u00A0\u00A0baz', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foobar baz{}
' ); } ); } ); describe( 'keystroke handling', () => { it( 'should remove contents', () => { model.enqueueChanges( () => { model.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ] ); } ); listenter.listenTo( view, 'keydown', () => { expect( getModelData( model ) ).to.equal( 'foy{}ar
' ); } ); it( 'should do nothing on arrow key', () => { model.enqueueChanges( () => { model.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ] ); } ); view.fire( 'keydown', { keyCode: getCode( 'arrowdown' ) } ); expect( getModelData( model ) ).to.equal( 'xxxtext{}
' ); const paragraph = viewRoot.getChild( 0 ); const textBefore = paragraph.getChild( 0 ); const link = paragraph.getChild( 1 ); const italic = link.getChild( 0 ); const text = italic.getChild( 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'xxxtextx'; view.fire( 'mutations', [ // First mutation - remove all children from link element. { type: 'children', node: link, oldChildren: [ italic ], newChildren: [] }, // Second mutation - remove link from paragraph and put italic there. { type: 'children', node: paragraph, oldChildren: [ textBefore, link ], newChildren: [ new ViewText( 'xxx' ), new ViewElement( 'i' ) ] }, // Third mutation - italic's new children. { type: 'children', node: italic, oldChildren: [ text ], newChildren: [ new ViewElement( 'a', null, 'text' ), new ViewText( 'x' ) ] } ] ); expect( getViewData( view ) ).to.equal( 'xxxtextx{}
' ); } ); // This happens when spell checker is applied on element and changes it to . it( 'should handle mutations replacing node', () => { setModelData( model, 'text{}
' ); const paragraph = viewRoot.getChild( 0 ); const strong = paragraph.getChild( 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'fixed text'; view.fire( 'mutations', [ // Replace `` with ``. { type: 'children', node: paragraph, oldChildren: [ strong ], newChildren: [ new ViewElement( 'b', null, 'fixed text' ) ] } ] ); expect( getViewData( view, { withoutSelection: true } ) ).to.equal( 'fixed text
' ); } ); // Spell checker splits text inside attributes to two text nodes. it( 'should handle mutations inside attribute element', () => { setModelData( model, 'this is foo text{}
' ); const paragraph = viewRoot.getChild( 0 ); const strong = paragraph.getChild( 0 ); const text = strong.getChild( 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].childNodes[ 0 ].innerHTML = 'this is bar text'; view.fire( 'mutations', [ { type: 'children', node: strong, oldChildren: [ text ], newChildren: [ new ViewText( 'this is bar' ), new ViewText( ' text' ) ] } ] ); expect( getViewData( view, { withoutSelection: true } ) ).to.equal( 'this is bar text
' ); } ); it( 'should do nothing if elements mutated', () => { setModelData( model, 'text{}
' ); const paragraph = viewRoot.getChild( 0 ); const strong = paragraph.getChild( 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'texttext{}
' ); } ); it( 'should do nothing if text is not changed', () => { setModelData( model, 'text{}
' ); const paragraph = viewRoot.getChild( 0 ); const strong = paragraph.getChild( 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'text'; view.fire( 'mutations', [ { type: 'children', node: paragraph, oldChildren: [ strong ], newChildren: [ new ViewElement( 'strong', null, new ViewText( 'text' ) ) ] } ] ); expect( getViewData( view ) ).to.equal( 'text{}
' ); } ); it( 'should do nothing on empty mutations', () => { setModelData( model, 'text{}
' ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'text'; view.fire( 'mutations', [] ); expect( getViewData( view ) ).to.equal( 'text{}
' ); } ); it( 'should do nothing if mutations does not have common ancestor', () => { setModelData( model, 'text{}
' ); const paragraph = viewRoot.getChild( 0 ); const strong = paragraph.getChild( 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'text'; view.fire( 'mutations', [ { type: 'children', node: paragraph, oldChildren: [ strong ], newChildren: [ strong ] }, { type: 'children', node: new ViewContainerElement( 'div' ), oldChildren: [], newChildren: [ new ViewText( 'foo' ), new ViewText( 'bar' ) ] } ] ); expect( getViewData( view ) ).to.equal( 'text{}
' ); } ); it( 'should handle view selection if one is returned from mutations', () => { setModelData( model, 'text{}
' ); const paragraph = viewRoot.getChild( 0 ); const strong = paragraph.getChild( 0 ); const viewSelection = new ViewSelection(); viewSelection.setCollapsedAt( paragraph, 0 ); // Simulate mutations and DOM change. domRoot.childNodes[ 0 ].innerHTML = 'textx'; view.fire( 'mutations', [ // Replace `` with ``. { type: 'children', node: paragraph, oldChildren: [ strong ], newChildren: [ new ViewElement( 'b', null, new ViewText( 'textx' ) ) ] } ], viewSelection ); expect( getModelData( model ) ).to.equal( '{}textx
' ); } ); // #117. it( 'should handle mixed mutations', () => { setModelData( model, '{}Foo bar apple
' ); } ); } ); } );