/**
* @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(
'
f{}oo
bar
' ); } ); it( 'should convert split', () => { expect( getViewData( editing.view ) ).to.equal( 'f{}oo
bar
' ); 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( 'f
{}oo
bar
' ); } ); it( 'should convert rename', () => { expect( getViewData( editing.view ) ).to.equal( 'f{}oo
bar
' ); model.change( writer => { writer.rename( modelRoot.getChild( 0 ), 'div' ); } ); expect( getViewData( editing.view ) ).to.equal( 'bar
' ); } ); 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( 'f{}o
bar
' ); } ); it( 'should convert selection from view to model', done => { listener.listenTo( editing.view.document, 'selectionChange', () => { setTimeout( () => { expect( getModelData( model ) ).to.equal( 'foo
b{}ar
' ); } ); 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( 'foo
b{a}r
' ); } ); 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( 'foo
b{}ar
' ); 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( 'foo
ba{}r
' ); } ); 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( 'foo
bar
' ); } ); 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( 'foo
bar
' ); } ); 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( 'foo
bar
' ); } ); 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( 'foo
xyz
bar
' ); } ); 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( 'foor
ba
' ); } ); 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( 'f
baroo
' ); } ); 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( 'foo
bar
' ); } ); 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( '