| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals setTimeout, document */
- import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
- import EditingController from '../../src/controller/editingcontroller';
- import View from '../../src/view/view';
- import Mapper from '../../src/conversion/mapper';
- import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
- import DowncastHelpers from '../../src/conversion/downcasthelpers';
- import Model from '../../src/model/model';
- import ModelPosition from '../../src/model/position';
- import ModelRange from '../../src/model/range';
- import ModelDocumentFragment from '../../src/model/documentfragment';
- import { getData as getModelData, parse } from '../../src/dev-utils/model';
- import { getData as getViewData } from '../../src/dev-utils/view';
- import { StylesProcessor } from '../../src/view/stylesmap';
- describe( 'EditingController', () => {
- describe( 'constructor()', () => {
- let model, editing;
- beforeEach( () => {
- model = new Model();
- editing = new EditingController( model, new StylesProcessor() );
- } );
- afterEach( () => {
- editing.destroy();
- } );
- it( 'should create controller with properties', () => {
- expect( editing ).to.have.property( 'model' ).that.equals( model );
- expect( editing ).to.have.property( 'view' ).that.is.instanceof( View );
- expect( editing ).to.have.property( 'mapper' ).that.is.instanceof( Mapper );
- expect( editing ).to.have.property( 'downcastDispatcher' ).that.is.instanceof( DowncastDispatcher );
- editing.destroy();
- } );
- it( 'should be observable', () => {
- const spy = sinon.spy();
- editing.on( 'change:foo', spy );
- editing.set( 'foo', 'bar' );
- sinon.assert.calledOnce( spy );
- } );
- it( 'should bind view roots to model roots', () => {
- expect( model.document.roots ).to.length( 1 ); // $graveyard
- expect( editing.view.document.roots ).to.length( 0 );
- const modelRoot = model.document.createRoot();
- expect( model.document.roots ).to.length( 2 );
- expect( editing.view.document.roots ).to.length( 1 );
- expect( editing.view.document.getRoot().document ).to.equal( editing.view.document );
- expect( editing.view.document.getRoot().name ).to.equal( modelRoot.name ).to.equal( '$root' );
- } );
- } );
- describe( 'conversion', () => {
- let model, modelRoot, viewRoot, domRoot, editing, listener;
- beforeEach( () => {
- listener = Object.create( EmitterMixin );
- model = new Model();
- modelRoot = model.document.createRoot();
- editing = new EditingController( model, new StylesProcessor() );
- domRoot = document.createElement( 'div' );
- domRoot.contentEditable = true;
- document.body.appendChild( domRoot );
- viewRoot = editing.view.document.getRoot();
- editing.view.attachDomRoot( domRoot );
- model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
- model.schema.register( 'div', { inheritAllFrom: '$block' } );
- const downcastHelpers = new DowncastHelpers( [ editing.downcastDispatcher ] );
- downcastHelpers.elementToElement( { model: 'paragraph', view: 'p' } );
- downcastHelpers.elementToElement( { model: 'div', view: 'div' } );
- downcastHelpers.markerToHighlight( { model: 'marker', view: {} } );
- // Note: The below code is highly overcomplicated due to #455.
- model.change( writer => {
- writer.setSelection( null );
- } );
- modelRoot._removeChildren( 0, modelRoot.childCount );
- viewRoot._removeChildren( 0, viewRoot.childCount );
- const modelData = new ModelDocumentFragment( parse(
- '<paragraph>foo</paragraph>' +
- '<paragraph></paragraph>' +
- '<paragraph>bar</paragraph>',
- model.schema
- )._children );
- model.change( writer => {
- writer.insert( modelData, model.document.getRoot() );
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 0 ), 1 ),
- writer.createPositionAt( modelRoot.getChild( 0 ), 1 )
- ) );
- } );
- } );
- afterEach( () => {
- document.body.removeChild( domRoot );
- listener.stopListening();
- editing.destroy();
- } );
- it( 'should convert insertion', () => {
- expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
- } );
- it( 'should convert split', () => {
- expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
- model.change( writer => {
- writer.split( model.document.selection.getFirstPosition() );
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 1 ), 0 ),
- writer.createPositionAt( modelRoot.getChild( 1 ), 0 )
- ) );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<p>f</p><p>{}oo</p><p></p><p>bar</p>' );
- } );
- it( 'should convert rename', () => {
- expect( getViewData( editing.view ) ).to.equal( '<p>f{}oo</p><p></p><p>bar</p>' );
- model.change( writer => {
- writer.rename( modelRoot.getChild( 0 ), 'div' );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<div>f{}oo</div><p></p><p>bar</p>' );
- } );
- it( 'should convert delete', () => {
- model.change( writer => {
- writer.remove(
- ModelRange._createFromPositionAndShift( model.document.selection.getFirstPosition(), 1 )
- );
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 0 ), 1 ),
- writer.createPositionAt( modelRoot.getChild( 0 ), 1 )
- ) );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<p>f{}o</p><p></p><p>bar</p>' );
- } );
- it( 'should convert selection from view to model', done => {
- listener.listenTo( editing.view.document, 'selectionChange', () => {
- setTimeout( () => {
- expect( getModelData( model ) ).to.equal(
- '<paragraph>foo</paragraph>' +
- '<paragraph></paragraph>' +
- '<paragraph>b[a]r</paragraph>'
- );
- done();
- }, 1 );
- } );
- editing.view.document.isFocused = true;
- editing.view.forceRender();
- const domSelection = document.getSelection();
- domSelection.removeAllRanges();
- const domBar = domRoot.childNodes[ 2 ].childNodes[ 0 ];
- const domRange = document.createRange();
- domRange.setStart( domBar, 1 );
- domRange.setEnd( domBar, 2 );
- domSelection.addRange( domRange );
- } );
- it( 'should convert collapsed selection', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 2 ), 1 ),
- writer.createPositionAt( modelRoot.getChild( 2 ), 1 )
- ) );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
- } );
- it( 'should convert not collapsed selection', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 2 ), 1 ),
- writer.createPositionAt( modelRoot.getChild( 2 ), 2 )
- ) );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{a}r</p>' );
- } );
- it( 'should clear previous selection', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 2 ), 1 ),
- writer.createPositionAt( modelRoot.getChild( 2 ), 1 )
- ) );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>b{}ar</p>' );
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionAt( modelRoot.getChild( 2 ), 2 ),
- writer.createPositionAt( modelRoot.getChild( 2 ), 2 )
- ) );
- } );
- expect( getViewData( editing.view ) ).to.equal( '<p>foo</p><p></p><p>ba{}r</p>' );
- } );
- it( 'should convert adding marker', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p>f<span>oo</span></p><p></p><p><span>ba</span>r</p>' );
- } );
- it( 'should convert removing marker', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- model.change( writer => {
- writer.removeMarker( 'marker' );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p>foo</p><p></p><p>bar</p>' );
- } );
- it( 'should convert changing marker', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- const range2 = new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 2 ] ) );
- model.change( writer => {
- writer.updateMarker( 'marker', { range: range2 } );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p><span>fo</span>o</p><p></p><p>bar</p>' );
- } );
- it( 'should convert insertion into marker', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- writer.insertText( 'xyz', new ModelPosition( modelRoot, [ 1, 0 ] ) );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p>f<span>oo</span></p><p><span>xyz</span></p><p><span>ba</span>r</p>' );
- } );
- it( 'should convert move to marker', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- model.change( writer => {
- writer.move(
- new ModelRange( new ModelPosition( modelRoot, [ 2, 2 ] ), new ModelPosition( modelRoot, [ 2, 3 ] ) ),
- new ModelPosition( modelRoot, [ 0, 3 ] )
- );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p>f<span>oor</span></p><p></p><p><span>ba</span></p>' );
- } );
- it( 'should convert move from marker', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- model.change( writer => {
- writer.move(
- new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
- new ModelPosition( modelRoot, [ 2, 3 ] )
- );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p>f</p><p></p><p><span>ba</span>roo</p>' );
- } );
- it( 'should convert the whole marker move', () => {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) );
- model.change( writer => {
- writer.addMarker( 'marker', { range, usingOperation: false } );
- } );
- model.change( writer => {
- writer.move(
- new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 3 ] ) ),
- new ModelPosition( modelRoot, [ 1, 0 ] )
- );
- } );
- expect( getViewData( editing.view, { withoutSelection: true } ) )
- .to.equal( '<p></p><p>f<span>oo</span></p><p>bar</p>' );
- } );
- describe( 'preventing rendering while in the model.change() block', () => {
- let renderSpy;
- beforeEach( () => {
- renderSpy = sinon.spy();
- editing.view.on( 'render', renderSpy );
- } );
- it( 'should not call render in the model.change() block', () => {
- model.change( writer => {
- executeSomeModelChange( writer );
- expect( renderSpy.called ).to.be.false;
- } );
- expect( renderSpy.called ).to.be.true;
- } );
- it( 'should not call render in the model.change() block even if view.change() was called', () => {
- model.change( writer => {
- executeSomeModelChange( writer );
- editing.view.change( writer => executeSomeViewChange( writer ) );
- expect( renderSpy.called ).to.be.false;
- } );
- expect( renderSpy.called ).to.be.true;
- } );
- it( 'should not call render in enqueued changes', () => {
- model.enqueueChange( writer => {
- executeSomeModelChange( writer );
- expect( renderSpy.called ).to.be.false;
- model.enqueueChange( writer => {
- executeSomeOtherModelChange( writer );
- expect( renderSpy.called ).to.be.false;
- } );
- expect( renderSpy.called ).to.be.false;
- } );
- expect( renderSpy.called ).to.be.true;
- } );
- it( 'should not call render if some model changes were executed in the post fixer', () => {
- const postfixerSpy = sinon.spy();
- model.document.registerPostFixer( () => {
- model.change( writer => executeSomeOtherModelChange( writer ) );
- expect( renderSpy.called ).to.be.false;
- postfixerSpy();
- } );
- model.change( writer => {
- executeSomeModelChange( writer );
- expect( renderSpy.called ).to.be.false;
- } );
- expect( renderSpy.called ).to.be.true;
- expect( postfixerSpy.calledOnce ).to.be.true;
- } );
- it( 'should not call render if some view changes were executed in the change listener', () => {
- const changeListenerSpy = sinon.spy();
- model.document.on( 'change', () => {
- editing.view.change( writer => executeSomeViewChange( writer ) );
- expect( renderSpy.called ).to.be.false;
- changeListenerSpy();
- } );
- model.change( writer => {
- executeSomeModelChange( writer );
- expect( renderSpy.called ).to.be.false;
- } );
- expect( renderSpy.called ).to.be.true;
- expect( changeListenerSpy.calledOnce ).to.be.true;
- } );
- it( 'should call view post-fixers once for model.change() block', () => {
- const postfixerSpy = sinon.spy();
- editing.view.document.registerPostFixer( postfixerSpy );
- model.change( writer => {
- executeSomeModelChange( writer );
- editing.view.change( writer => {
- executeSomeViewChange( writer );
- } );
- } );
- sinon.assert.calledOnce( postfixerSpy );
- } );
- function executeSomeModelChange( writer ) {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- writer.addMarker( 'marker1', { range, usingOperation: true } );
- }
- function executeSomeOtherModelChange( writer ) {
- const range = new ModelRange( new ModelPosition( modelRoot, [ 0, 1 ] ), new ModelPosition( modelRoot, [ 2, 2 ] ) );
- writer.addMarker( 'marker2', { range, usingOperation: true } );
- }
- function executeSomeViewChange( writer ) {
- writer.addClass( 'foo', editing.view.document.getRoot() );
- }
- } );
- } );
- describe( 'destroy()', () => {
- it( 'should remove listenters', () => {
- const model = new Model();
- model.document.createRoot();
- model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
- const editing = new EditingController( model, new StylesProcessor() );
- const spy = sinon.spy();
- editing.downcastDispatcher.on( 'insert:$element', spy );
- editing.destroy();
- model.change( writer => {
- const modelData = parse( '<paragraph>foo</paragraph>', model.schema ).getChild( 0 );
- writer.insert( modelData, model.document.getRoot() );
- } );
- expect( spy.called ).to.be.false;
- editing.destroy();
- } );
- it( 'should destroy view', () => {
- const model = new Model();
- model.document.createRoot();
- model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
- const editing = new EditingController( model, new StylesProcessor() );
- const spy = sinon.spy( editing.view, 'destroy' );
- editing.destroy();
- expect( spy.called ).to.be.true;
- } );
- } );
- } );
|