/** * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ 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 List from '@ckeditor/ckeditor5-list/src/list'; import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; import Input from '../src/input'; import Writer from '@ckeditor/ckeditor5-engine/src/model/writer'; import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range'; import ViewText from '@ckeditor/ckeditor5-engine/src/view/text'; import ViewElement from '@ckeditor/ckeditor5-engine/src/view/element'; import ViewSelection from '@ckeditor/ckeditor5-engine/src/view/selection'; 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'; /* global document */ describe( 'Input feature', () => { let editor, model, modelRoot, view, viewDocument, viewRoot, listenter; testUtils.createSinonSandbox(); beforeEach( () => { listenter = Object.create( EmitterMixin ); const domElement = document.createElement( 'div' ); document.body.appendChild( domElement ); return ClassicTestEditor.create( domElement, { plugins: [ Input, Paragraph, Bold, List ] } ) .then( newEditor => { // Mock image feature. newEditor.model.schema.register( 'image', { allowWhere: '$text' } ); newEditor.conversion.elementToElement( { model: 'image', view: 'img' } ); editor = newEditor; model = editor.model; modelRoot = model.document.getRoot(); view = editor.editing.view; viewDocument = view.document; viewRoot = viewDocument.getRoot(); } ); } ); after( () => { return editor.destroy(); } ); beforeEach( () => { editor.setData( '

foobar

' ); model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 3, modelRoot.getChild( 0 ), 3 ) ); } ); } ); afterEach( () => { listenter.stopListening(); } ); describe( 'mutations handling', () => { it( 'should handle text mutation', () => { viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'fooxbar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foox[]bar' ); expect( getViewData( view ) ).to.equal( '

foox{}bar

' ); } ); it( 'should handle text mutation change', () => { viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foodar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'food[]ar' ); expect( getViewData( view ) ).to.equal( '

food{}ar

' ); } ); it( 'should handle text node insertion', () => { editor.setData( '

' ); viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'x' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'x[]' ); expect( getViewData( view ) ).to.equal( '

x{}

' ); } ); it( 'should apply selection attributes to the inserted text', () => { setModelData( model, '[]', { selectionAttributes: { bold: true, italic: true } } ); viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'x' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( '<$text bold="true" italic="true">x[]' ); } ); it( 'should handle multiple text mutations', () => { editor.setData( '

foobar

' ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foo', newText: 'foob', node: viewRoot.getChild( 0 ).getChild( 0 ) }, { type: 'text', oldText: 'bar', newText: 'ar', node: viewRoot.getChild( 0 ).getChild( 1 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foob[]<$text bold="true">ar' ); expect( getViewData( view ) ).to.equal( '

foob{}ar

' ); } ); it( 'should handle multiple text node insertion', () => { editor.setData( '

' ); viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'x' ) ], node: viewRoot.getChild( 0 ) }, { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'y' ) ], node: viewRoot.getChild( 1 ) } ] ); expect( getModelData( model ) ).to.equal( 'xy[]' ); expect( getViewData( view ) ).to.equal( '

x

y{}

' ); } ); it( 'should do nothing when two nodes were inserted', () => { editor.setData( '

' ); viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewText( 'x' ), new ViewElement( 'img' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( '[]' ); expect( getViewData( view ) ).to.equal( '

[]

' ); } ); it( 'should do nothing when two nodes were inserted and one removed', () => { viewDocument.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' ); expect( getViewData( view ) ).to.equal( '

foo{}bar

' ); } ); it( 'should handle multiple children in the node', () => { editor.setData( '

foo

' ); viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [ new ViewText( 'foo' ), viewRoot.getChild( 0 ).getChild( 1 ) ], newChildren: [ new ViewText( 'foo' ), viewRoot.getChild( 0 ).getChild( 1 ), new ViewText( 'x' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foox[]' ); expect( getViewData( view ) ).to.equal( '

foox{}

' ); } ); it( 'should do nothing when node was removed', () => { viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [ new ViewText( 'foobar' ) ], newChildren: [], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foo[]bar' ); expect( getViewData( view ) ).to.equal( '

foo{}bar

' ); } ); it( 'should do nothing when element was inserted', () => { editor.setData( '

' ); viewDocument.fire( 'mutations', [ { type: 'children', oldChildren: [], newChildren: [ new ViewElement( 'img' ) ], node: viewRoot.getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( '[]' ); expect( getViewData( view ) ).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.setTo( viewRoot.getChild( 0 ).getChild( 0 ), 6 ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foodar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( getModelData( model ) ).to.equal( 'foodar[]' ); expect( getViewData( view ) ).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.setTo( viewRoot.getChild( 0 ).getChild( 0 ), 6 ); testUtils.sinon.spy( Writer.prototype, 'insert' ); testUtils.sinon.spy( Writer.prototype, 'remove' ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'fxobxr', node: viewRoot.getChild( 0 ).getChild( 0 ) } ], viewSelection ); expect( Writer.prototype.insert.calledOnce ).to.be.true; expect( Writer.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.setTo( viewRoot.getChild( 0 ).getChild( 0 ), 9 ); viewDocument.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' ); expect( getViewData( view ) ).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.setTo( viewRoot.getChild( 0 ).getChild( 0 ), 8 ); viewDocument.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' ); expect( getViewData( view ) ).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.setTo( viewRoot.getChild( 0 ).getChild( 0 ), 9 ); viewDocument.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[]' ); expect( getViewData( view ) ).to.equal( '

Foo house{}

' ); } ); it( 'should place non-collapsed selection after changing single character (composition)', () => { editor.setData( '

Foo house

' ); const viewSelection = new ViewSelection(); viewSelection.setTo( viewRoot.getChild( 0 ).getChild( 0 ), 8 ); viewSelection.setFocus( viewRoot.getChild( 0 ).getChild( 0 ), 9 ); viewDocument.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]' ); expect( getViewData( view ) ).to.equal( '

Foo hous{a}

' ); } ); it( 'should replace last   with space', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 6, modelRoot.getChild( 0 ), 6 ) ); } ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foobar\u00A0', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foobar []' ); expect( getViewData( view ) ).to.equal( '

foobar {}

' ); } ); it( 'should replace first   with space', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 0, modelRoot.getChild( 0 ), 0 ) ); } ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: '\u00A0foobar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( ' []foobar' ); expect( getViewData( view ) ).to.equal( '

{}foobar

' ); } ); it( 'should replace all   with spaces', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 6, modelRoot.getChild( 0 ), 6 ) ); } ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foobar', newText: 'foobar\u00A0\u00A0\u00A0baz', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); expect( getModelData( model ) ).to.equal( 'foobar baz[]' ); expect( getViewData( view ) ).to.equal( '

foobar baz{}

' ); } ); // ckeditor5#718. it( 'should not crash and prevent all changes if view common ancestor of mutations cannot be mapped to model', () => { editor.setData( '

Foo

' ); const ul = viewRoot.getChild( 1 ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'Bar', newText: 'Bx', node: ul.getChild( 0 ) }, { type: 'children', oldChildren: [ ul.getChild( 0 ), ul.getChild( 1 ) ], newChildren: [ ul.getChild( 0 ) ], node: ul } ] ); expect( getViewData( view ) ).to.equal( '

{}Foo

' ); } ); } ); describe( 'keystroke handling', () => { it( 'should remove contents', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); listenter.listenTo( viewDocument, 'keydown', () => { expect( getModelData( model ) ).to.equal( 'fo[]ar' ); }, { priority: 'lowest' } ); } ); // #97 it( 'should remove contents and merge blocks', () => { setModelData( model, 'fo[ob]ar' ); listenter.listenTo( viewDocument, 'keydown', () => { expect( getModelData( model ) ).to.equal( 'fo[]ar' ); viewDocument.fire( 'mutations', [ { type: 'text', oldText: 'foar', newText: 'foyar', node: viewRoot.getChild( 0 ).getChild( 0 ) } ] ); }, { priority: 'lowest' } ); viewDocument.fire( 'keydown', { keyCode: getCode( 'y' ) } ); expect( getModelData( model ) ).to.equal( 'foy[]ar' ); expect( getViewData( view ) ).to.equal( '

foy{}ar

' ); } ); it( 'should do nothing on arrow key', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); viewDocument.fire( 'keydown', { keyCode: getCode( 'arrowdown' ) } ); expect( getModelData( model ) ).to.equal( 'fo[ob]ar' ); } ); it( 'should do nothing on ctrl combinations', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); viewDocument.fire( 'keydown', { ctrlKey: true, keyCode: getCode( 'c' ) } ); expect( getModelData( model ) ).to.equal( 'fo[ob]ar' ); } ); it( 'should do nothing on non printable keys', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); viewDocument.fire( 'keydown', { keyCode: 16 } ); // Shift viewDocument.fire( 'keydown', { keyCode: 35 } ); // Home viewDocument.fire( 'keydown', { keyCode: 112 } ); // F1 expect( getModelData( model ) ).to.equal( 'fo[ob]ar' ); } ); // #69 it( 'should do nothing on tab key', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); viewDocument.fire( 'keydown', { keyCode: 9 } ); // Tab expect( getModelData( model ) ).to.equal( 'fo[ob]ar' ); } ); // #82 it( 'should do nothing on composition start key', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); viewDocument.fire( 'keydown', { keyCode: 229 } ); expect( getModelData( model ) ).to.equal( 'fo[ob]ar' ); } ); it( 'should do nothing if selection is collapsed', () => { viewDocument.fire( 'keydown', { ctrlKey: true, keyCode: getCode( 'c' ) } ); expect( getModelData( model ) ).to.equal( 'foo[]bar' ); } ); it( 'should lock buffer if selection is not collapsed', () => { const buffer = editor.commands.get( 'input' )._buffer; const lockSpy = testUtils.sinon.spy( buffer, 'lock' ); const unlockSpy = testUtils.sinon.spy( buffer, 'unlock' ); model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 2, modelRoot.getChild( 0 ), 4 ) ); } ); viewDocument.fire( 'keydown', { keyCode: getCode( 'y' ) } ); expect( lockSpy.calledOnce ).to.be.true; expect( unlockSpy.calledOnce ).to.be.true; } ); it( 'should not lock buffer on non printable keys', () => { const buffer = editor.commands.get( 'input' )._buffer; const lockSpy = testUtils.sinon.spy( buffer, 'lock' ); const unlockSpy = testUtils.sinon.spy( buffer, 'unlock' ); viewDocument.fire( 'keydown', { keyCode: 16 } ); // Shift viewDocument.fire( 'keydown', { keyCode: 35 } ); // Home viewDocument.fire( 'keydown', { keyCode: 112 } ); // F1 expect( lockSpy.callCount ).to.be.equal( 0 ); expect( unlockSpy.callCount ).to.be.equal( 0 ); } ); it( 'should not lock buffer on collapsed selection', () => { const buffer = editor.commands.get( 'input' )._buffer; const lockSpy = testUtils.sinon.spy( buffer, 'lock' ); const unlockSpy = testUtils.sinon.spy( buffer, 'unlock' ); viewDocument.fire( 'keydown', { keyCode: getCode( 'b' ) } ); viewDocument.fire( 'keydown', { keyCode: getCode( 'a' ) } ); viewDocument.fire( 'keydown', { keyCode: getCode( 'z' ) } ); expect( lockSpy.callCount ).to.be.equal( 0 ); expect( unlockSpy.callCount ).to.be.equal( 0 ); } ); it( 'should not modify document when input command is disabled and selection is collapsed', () => { setModelData( model, 'foo[]bar' ); editor.commands.get( 'input' ).isEnabled = false; viewDocument.fire( 'keydown', { keyCode: getCode( 'b' ) } ); expect( getModelData( model ) ).to.equal( 'foo[]bar' ); } ); it( 'should not modify document when input command is disabled and selection is non-collapsed', () => { setModelData( model, 'fo[ob]ar' ); editor.commands.get( 'input' ).isEnabled = false; viewDocument.fire( 'keydown', { keyCode: getCode( 'b' ) } ); expect( getModelData( model ) ).to.equal( 'fo[ob]ar' ); } ); } ); } );