/** * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor'; import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor'; import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; import { getData, setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; import InputCommand from '../src/inputcommand'; import ChangeBuffer from '../src/utils/changebuffer'; import Input from '../src/input'; describe( 'InputCommand', () => { let editor, model, doc, buffer, inputCommand; testUtils.createSinonSandbox(); beforeEach( () => { return ModelTestEditor.create() .then( newEditor => { editor = newEditor; model = editor.model; doc = model.document; inputCommand = new InputCommand( editor, 20 ); editor.commands.add( 'input', inputCommand ); buffer = inputCommand.buffer; buffer.size = 0; model.schema.register( 'paragraph', { inheritAllFrom: '$block' } ); model.schema.register( 'heading1', { inheritAllFrom: '$block' } ); } ); } ); afterEach( () => { return editor.destroy(); } ); describe( 'buffer', () => { it( 'has buffer getter', () => { expect( editor.commands.get( 'input' ).buffer ).to.be.an.instanceof( ChangeBuffer ); } ); it( 'has a buffer limit configured to default value of 20', () => { expect( editor.commands.get( 'input' )._buffer ).to.have.property( 'limit', 20 ); } ); it( 'has a buffer configured to config.typing.undoStep', () => { return VirtualTestEditor .create( { plugins: [ Input ], typing: { undoStep: 5 } } ) .then( editor => { expect( editor.commands.get( 'input' )._buffer ).to.have.property( 'limit', 5 ); } ); } ); } ); describe( 'execute()', () => { it( 'uses enqueueChange', () => { setData( model, 'foo[]bar' ); model.enqueueChange( () => { editor.execute( 'input', { text: 'x' } ); // We expect that command is executed in enqueue changes block. Since we are already in // an enqueued block, the command execution will be postponed. Hence, no changes. expect( getData( model ) ).to.equal( 'foo[]bar' ); } ); // After all enqueued changes are done, the command execution is reflected. expect( getData( model ) ).to.equal( 'foox[]bar' ); } ); it( 'should lock and unlock buffer', () => { setData( model, 'foo[]bar' ); const spyLock = testUtils.sinon.spy( buffer, 'lock' ); const spyUnlock = testUtils.sinon.spy( buffer, 'unlock' ); editor.execute( 'input', { text: '' } ); expect( spyLock.calledOnce ).to.be.true; expect( spyUnlock.calledOnce ).to.be.true; } ); it( 'inserts text for collapsed range', () => { setData( model, 'foo[]' ); editor.execute( 'input', { text: 'bar', range: doc.selection.getFirstRange() } ); expect( getData( model ) ).to.equal( 'foobar[]' ); expect( buffer.size ).to.equal( 3 ); } ); it( 'replaces text for range within single element on the beginning', () => { setData( model, '[fooba]r' ); editor.execute( 'input', { text: 'rab', range: doc.selection.getFirstRange() } ); expect( getData( model ) ).to.equal( 'rab[]r' ); expect( buffer.size ).to.equal( 3 ); } ); it( 'replaces text for range within single element in the middle', () => { setData( model, 'fo[oba]r' ); editor.execute( 'input', { text: 'bazz', range: doc.selection.getFirstRange() } ); expect( getData( model ) ).to.equal( 'fobazz[]r' ); expect( buffer.size ).to.equal( 4 ); } ); it( 'replaces text for range within single element on the end', () => { setData( model, 'fooba[r]' ); editor.execute( 'input', { text: 'zzz', range: doc.selection.getFirstRange() } ); expect( getData( model ) ).to.equal( 'foobazzz[]' ); expect( buffer.size ).to.equal( 3 ); } ); it( 'replaces text for range within multiple elements', () => { setData( model, 'F[OOb]ar' ); editor.execute( 'input', { text: 'unny c', range: doc.selection.getFirstRange() } ); expect( getData( model ) ).to.equal( 'Funny c[]ar' ); expect( buffer.size ).to.equal( 6 ); } ); it( 'uses current selection when range is not given', () => { setData( model, 'foob[ar]' ); editor.execute( 'input', { text: 'az' } ); expect( getData( model ) ).to.equal( 'foobaz[]' ); expect( buffer.size ).to.equal( 2 ); } ); it( 'only removes content when empty text given', () => { setData( model, '[fo]obar' ); editor.execute( 'input', { text: '', range: doc.selection.getFirstRange() } ); expect( getData( model ) ).to.equal( '[]obar' ); expect( buffer.size ).to.equal( 0 ); } ); it( 'should set selection according to passed resultRange (collapsed)', () => { setData( model, '[foo]bar' ); editor.execute( 'input', { text: 'new', resultRange: editor.model.createRange( editor.model.createPositionFromPath( doc.getRoot(), [ 0, 5 ] ) ) } ); expect( getData( model ) ).to.equal( 'newba[]r' ); expect( buffer.size ).to.equal( 3 ); } ); it( 'should set selection according to passed resultRange (non-collapsed)', () => { setData( model, '[foo]bar' ); editor.execute( 'input', { text: 'new', resultRange: editor.model.createRange( editor.model.createPositionFromPath( doc.getRoot(), [ 0, 3 ] ), editor.model.createPositionFromPath( doc.getRoot(), [ 0, 6 ] ) ) } ); expect( getData( model ) ).to.equal( 'new[bar]' ); expect( buffer.size ).to.equal( 3 ); } ); it( 'only removes content when no text given (with default non-collapsed range)', () => { setData( model, '[fo]obar' ); editor.execute( 'input' ); expect( getData( model ) ).to.equal( '[]obar' ); expect( buffer.size ).to.equal( 0 ); } ); it( 'does not change selection and content when no text given (with default collapsed range)', () => { setData( model, 'fo[]obar' ); editor.execute( 'input' ); expect( getData( model ) ).to.equal( 'fo[]obar' ); expect( buffer.size ).to.equal( 0 ); } ); it( 'does not create insert delta when no text given', () => { setData( model, 'foo[]bar' ); const version = doc.version; editor.execute( 'input' ); expect( doc.version ).to.equal( version ); } ); it( 'handles multi-range selection', () => { model.schema.register( 'object', { allowWhere: '$block', allowContentOf: '$block', isObject: true } ); setData( model, 'x' + '[y]' + 'y' + '[y]' + 'z' ); // deleteContent() does not support multi-range selections yet, so we need to mock it here. // See https://github.com/ckeditor/ckeditor5/issues/6328. model.on( 'deleteContent', ( evt, args ) => { const [ selection ] = args; if ( selection.rangeCount != 2 ) { return; } evt.stop(); model.change( writer => { let rangeSelection; for ( const range of Array.from( selection.getRanges() ) ) { rangeSelection = writer.createSelection( range ); model.deleteContent( rangeSelection ); } writer.setSelection( rangeSelection ); } ); }, { priority: 'high' } ); editor.execute( 'input', { text: 'foo' } ); expect( getData( model ) ).to.equal( 'x' + '' + 'y' + 'foo[]' + 'z' ); } ); it( 'uses typing batch while removing and inserting the content', () => { expect( inputCommand._batches.has( getCurrentBatch() ), 'batch before typing' ).to.equal( false ); model.on( 'deleteContent', () => { expect( inputCommand._batches.has( getCurrentBatch() ), 'batch when deleting content' ).to.equal( true ); }, { priority: 'highest' } ); model.on( 'insertContent', () => { expect( inputCommand._batches.has( getCurrentBatch() ), 'batch when inserting content' ).to.equal( true ); }, { priority: 'lowest' } ); setData( model, '[foo]' ); editor.execute( 'input', { text: 'bar' } ); expect( getData( model ) ).to.equal( 'bar[]' ); function getCurrentBatch() { return editor.model.change( writer => writer.batch ); } } ); } ); describe( 'destroy()', () => { it( 'should destroy change buffer', () => { const command = editor.commands.get( 'input' ); const destroy = command._buffer.destroy = testUtils.sinon.spy(); command.destroy(); expect( destroy.calledOnce ).to.be.true; } ); } ); } );