| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351 |
- /**
- * @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 ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor';
- import Batch from '@ckeditor/ckeditor5-engine/src/model/batch';
- import UndoCommand from '../src/undocommand';
- import { itemAt, getText } from '@ckeditor/ckeditor5-engine/tests/model/_utils/utils';
- describe( 'UndoCommand', () => {
- let editor, model, doc, root, undo;
- beforeEach( () => {
- return ModelTestEditor.create().then( newEditor => {
- editor = newEditor;
- undo = new UndoCommand( editor );
- model = editor.model;
- doc = model.document;
- root = doc.getRoot();
- } );
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- describe( 'UndoCommand', () => {
- const p = pos => model.createPositionFromPath( root, [].concat( pos ) );
- const r = ( a, b ) => model.createRange( p( a ), p( b ) );
- describe( 'execute()', () => {
- let batch0, batch1, batch2, batch3;
- beforeEach( () => {
- /*
- [root]
- - {}
- */
- model.change( writer => {
- writer.setSelection( r( 0, 0 ) );
- } );
- batch0 = model.createBatch();
- undo.addBatch( batch0 );
- model.enqueueChange( batch0, writer => {
- writer.insertText( 'foobar', p( 0 ) );
- } );
- /*
- [root]
- - f
- - o
- - o
- - b
- - a
- - r{}
- */
- // Let's make things spicy and this time, make a backward selection.
- model.change( writer => {
- writer.setSelection( r( 2, 4 ), { backward: true } );
- } );
- batch1 = model.createBatch();
- undo.addBatch( batch1 );
- model.enqueueChange( batch1, writer => {
- writer.setAttribute( 'key', 'value', r( 2, 4 ) );
- } );
- /*
- [root]
- - f
- - o
- - {o (key: value)
- - b} (key: value)
- - a
- - r
- */
- model.change( writer => {
- writer.setSelection( r( 1, 3 ) );
- } );
- batch2 = model.createBatch();
- undo.addBatch( batch2 );
- model.enqueueChange( batch2, writer => {
- writer.move( r( 1, 3 ), p( 6 ) );
- } );
- /*
- [root]
- - f
- - b (key: value)
- - a
- - r
- - {o
- - o} (key: value)
- */
- model.change( writer => {
- writer.setSelection( r( 1, 4 ) );
- } );
- batch3 = model.createBatch();
- undo.addBatch( batch3 );
- model.enqueueChange( batch3, writer => {
- writer.wrap( r( 1, 4 ), 'p' );
- } );
- /*
- [root]
- - f
- - [p]
- - {b (key: value)
- - a
- - r}
- - o
- - o (key: value)
- */
- model.change( writer => {
- writer.setSelection( r( 0, 1 ) );
- } );
- model.enqueueChange( batch2, writer => {
- writer.move( r( 0, 1 ), p( 3 ) );
- } );
- /*
- [root]
- - [p]
- - b (key: value)
- - a
- - r
- - o
- - f
- - o{} (key: value)
- */
- model.change( writer => {
- writer.setSelection( r( 4, 4 ) );
- } );
- } );
- it( 'should revert changes done by operations from the batch that was most recently added to the command stack', () => {
- undo.execute();
- // Selection is restored. Wrap is removed:
- /*
- [root]
- - {b (key: value)
- - a
- - r}
- - o
- - f
- - o (key: value)
- */
- expect( getText( root ) ).to.equal( 'barofo' );
- expect( itemAt( root, 0 ).getAttribute( 'key' ) ).to.equal( 'value' );
- expect( itemAt( root, 5 ).getAttribute( 'key' ) ).to.equal( 'value' );
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 0, 3 ) ) ).to.be.true;
- expect( editor.model.document.selection.isBackward ).to.be.false;
- undo.execute();
- // Two moves are removed:
- /*
- [root]
- - f
- - {o
- - o} (key: value)
- - b (key: value)
- - a
- - r
- */
- expect( getText( root ) ).to.equal( 'foobar' );
- expect( itemAt( root, 2 ).getAttribute( 'key' ) ).to.equal( 'value' );
- expect( itemAt( root, 3 ).getAttribute( 'key' ) ).to.equal( 'value' );
- // Since selection restoring is not 100% accurate, selected range is not perfectly correct
- // with what is expected in comment above. The correct result would be if range was [ 1 ] - [ 3 ].
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 0, 3 ) ) ).to.be.true;
- expect( editor.model.document.selection.isBackward ).to.be.false;
- undo.execute();
- // Set attribute is undone:
- /*
- [root]
- - f
- - o
- - {o
- - b}
- - a
- - r
- */
- expect( getText( root ) ).to.equal( 'foobar' );
- expect( itemAt( root, 2 ).hasAttribute( 'key' ) ).to.be.false;
- expect( itemAt( root, 3 ).hasAttribute( 'key' ) ).to.be.false;
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 2, 4 ) ) ).to.be.true;
- expect( editor.model.document.selection.isBackward ).to.be.true;
- undo.execute();
- // Insert is undone:
- /*
- [root]
- */
- expect( root.childCount ).to.equal( 0 );
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 0, 0 ) ) ).to.be.true;
- } );
- it( 'should revert changes done by deltas from given batch, if parameter was passed (test: revert set attribute)', () => {
- undo.execute( batch1 );
- // Remove attribute:
- /*
- [root]
- - [p]
- - b
- - a
- - r
- - o
- - f
- - o
- */
- expect( itemAt( root, 0 ).name ).to.equal( 'p' );
- expect( getText( root.getChild( 0 ) ) ).to.equal( 'bar' );
- expect( root.getChild( 1 ).data ).to.equal( 'ofo' );
- expect( itemAt( root.getChild( 0 ), 0 ).hasAttribute( 'key' ) ).to.be.false;
- expect( itemAt( root, 2 ).hasAttribute( 'key' ) ).to.be.false;
- expect( itemAt( root, 3 ).hasAttribute( 'key' ) ).to.be.false;
- // Selection is only partially restored because the range got broken.
- // The selection would have to best on letter "b" and letter "o", but it is set only on letter "b".
- expect( editor.model.document.selection.getFirstRange().isEqual( r( [ 0, 0 ], [ 0, 1 ] ) ) ).to.be.true;
- expect( editor.model.document.selection.isBackward ).to.be.true;
- } );
- it( 'should revert changes done by deltas from given batch, if parameter was passed (test: revert insert foobar)', () => {
- undo.execute( batch0 );
- // Remove foobar:
- /*
- [root]
- - p
- */
- expect( root.childCount ).to.equal( 1 );
- expect( root.getChild( 0 ).name ).to.equal( 'p' );
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 1, 1 ) ) ).to.be.true;
- expect( editor.model.document.selection.isBackward ).to.be.false;
- undo.execute( batch1 );
- // Remove attributes.
- // This does nothing in the `root` because attributes were set on nodes that already got removed.
- // But those nodes should change in the graveyard and we can check them there.
- expect( root.childCount ).to.equal( 1 );
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 1, 1 ) ) ).to.be.true;
- expect( editor.model.document.selection.isBackward ).to.be.false;
- // Graveyard contains "foobar".
- expect( doc.graveyard.maxOffset ).to.equal( 6 );
- for ( const item of model.createRangeIn( doc.graveyard ).getItems() ) {
- expect( item.hasAttribute( 'key' ) ).to.be.false;
- }
- } );
- it( 'should omit deltas with non-document operations', () => {
- let element;
- model.change( writer => {
- element = writer.createElement( 'p' );
- undo.addBatch( writer.batch );
- writer.setAttribute( 'foo', 'bar', element );
- writer.setAttribute( 'foo', 'bar', root );
- undo.execute();
- } );
- expect( element.getAttribute( 'foo' ) ).to.equal( 'bar' );
- expect( root.getAttribute( 'foo' ) ).to.not.equal( 'bar' );
- } );
- it( 'should pass undoing batch to enqueueChange method', () => {
- const enqueueChangeSpy = sinon.spy( model, 'enqueueChange' );
- const undoSpy = sinon.spy( undo, '_undo' );
- undo.execute();
- sinon.assert.calledOnce( enqueueChangeSpy );
- sinon.assert.calledOnce( undoSpy );
- const undoingBatch = enqueueChangeSpy.firstCall.args[ 0 ];
- expect( undoingBatch instanceof Batch ).to.be.true;
- expect( undoSpy.firstCall.args[ 1 ] ).to.equal( undoingBatch );
- } );
- } );
- it( 'merges touching ranges when restoring selection', () => {
- function getCaseText( root ) {
- let text = '';
- for ( let i = 0; i < root.childCount; i++ ) {
- const node = root.getChild( i );
- text += node.getAttribute( 'uppercase' ) ? node.data.toUpperCase() : node.data;
- }
- return text;
- }
- model.change( writer => {
- writer.appendText( 'abcdef', root );
- } );
- expect( getCaseText( root ) ).to.equal( 'abcdef' );
- model.change( writer => {
- writer.setSelection( r( 1, 4 ) );
- } );
- const batch0 = model.createBatch();
- undo.addBatch( batch0 );
- model.enqueueChange( batch0, writer => {
- writer.setAttribute( 'uppercase', true, r( 1, 4 ) );
- } );
- expect( getCaseText( root ) ).to.equal( 'aBCDef' );
- model.change( writer => {
- writer.setSelection( r( 3, 4 ) );
- } );
- const batch1 = model.createBatch();
- undo.addBatch( batch1 );
- model.enqueueChange( batch1, writer => {
- writer.move( r( 3, 4 ), p( 1 ) );
- } );
- expect( getCaseText( root ) ).to.equal( 'aDBCef' );
- undo.execute( batch0 );
- // After undo-attr: acdbef <--- "cdb" should be selected, it would look weird if only "cd" or "b" is selected
- // but the whole unbroken part "cdb" changed attribute.
- expect( getCaseText( root ) ).to.equal( 'adbcef' );
- expect( editor.model.document.selection.getFirstRange().isEqual( r( 1, 4 ) ) ).to.be.true;
- } );
- } );
- } );
|