/**
* @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
/* globals setTimeout, document */
import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
import EditingController from '../../src/controller/editingcontroller';
import ViewDocument from '../../src/view/document';
import Mapper from '../../src/conversion/mapper';
import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
import { downcastElementToElement, downcastMarkerToHighlight } from '../../src/conversion/downcast-converters';
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 { parse, getData as getModelData } from '../../src/dev-utils/model';
import { getData as getViewData } from '../../src/dev-utils/view';
describe( 'EditingController', () => {
describe( 'constructor()', () => {
let model, editing;
beforeEach( () => {
model = new Model();
editing = new EditingController( model );
} );
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( ViewDocument );
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.roots ).to.length( 0 );
const modelRoot = model.document.createRoot();
expect( model.document.roots ).to.length( 2 );
expect( editing.view.roots ).to.length( 1 );
expect( editing.view.getRoot().document ).to.equal( editing.view );
expect( editing.view.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 );
domRoot = document.createElement( 'div' );
domRoot.contentEditable = true;
document.body.appendChild( domRoot );
viewRoot = editing.view.getRoot();
editing.view.attachDomRoot( domRoot );
model.schema.register( 'paragraph', { inheritAllFrom: '$block' } );
model.schema.register( 'div', { inheritAllFrom: '$block' } );
downcastElementToElement( { model: 'paragraph', view: 'p' } )( editing.downcastDispatcher );
downcastElementToElement( { model: 'div', view: 'div' } )( editing.downcastDispatcher );
downcastMarkerToHighlight( { model: 'marker', view: {} } )( editing.downcastDispatcher );
// 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( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, 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( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, 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, 'selectionChange', () => { setTimeout( () => { expect( getModelData( model ) ).to.equal( 'foo
b{}ar
' ); } ); it( 'should convert not collapsed selection', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 ) ); } ); expect( getViewData( editing.view ) ).to.equal( 'foo
b{a}r
' ); } ); it( 'should clear previous selection', () => { model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 ) ); } ); expect( getViewData( editing.view ) ).to.equal( 'foo
b{}ar
' ); model.change( writer => { writer.setSelection( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, 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.setMarker( 'marker', range ); } ); 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.setMarker( 'marker', range ); } ); 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.setMarker( 'marker', range ); } ); const range2 = new ModelRange( new ModelPosition( modelRoot, [ 0, 0 ] ), new ModelPosition( modelRoot, [ 0, 2 ] ) ); model.change( writer => { writer.setMarker( 'marker', 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.setMarker( 'marker', range ); 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.setMarker( 'marker', range ); } ); 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.setMarker( 'marker', range ); } ); 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.setMarker( 'marker', range ); } ); 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( 'marker clearing', () => { let model, modelRoot, editing, domRoot, mcd, p1; beforeEach( () => { model = new Model(); modelRoot = model.document.createRoot(); editing = new EditingController( model ); domRoot = document.createElement( 'div' ); domRoot.contentEditable = true; document.body.appendChild( domRoot ); model.schema.register( 'paragraph', { inheritAllFrom: '$block' } ); model.schema.register( 'div', { inheritAllFrom: '$block' } ); downcastElementToElement( { model: 'paragraph', view: 'p' } )( editing.downcastDispatcher ); downcastElementToElement( { model: 'div', view: 'div' } )( editing.downcastDispatcher ); downcastMarkerToHighlight( { model: 'marker', view: {} } )( editing.downcastDispatcher ); const modelData = new ModelDocumentFragment( parse( 'foo
bar
' ); }, { priority: 'high' } ); model.change( writer => { writer.insertText( 'a', p1, 0 ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'afoo
bar
' ); } ); it( 'should remove marker from view if it will be affected by remove operation', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); // Adding with 'high' priority, because `applyOperation` is decorated - its default callback is fired with 'normal' priority. model.on( 'applyOperation', () => { expect( mcd.convertMarkerRemove.calledOnce ).to.be.true; expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); }, { priority: 'high' } ); model.change( writer => { writer.remove( ModelRange.createFromParentsAndOffsets( p1, 0, p1, 1 ) ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'oo
bar
' ); } ); it( 'should remove marker from view if it will be affected by move operation', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); // Adding with 'high' priority, because `applyOperation` is decorated - its default callback is fired with 'normal' priority. model.on( 'applyOperation', () => { expect( mcd.convertMarkerRemove.calledOnce ).to.be.true; expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); }, { priority: 'high' } ); model.change( writer => { const p2 = p1.nextSibling; writer.move( ModelRange.createFromParentsAndOffsets( p2, 0, p2, 2 ), p1, 0 ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'bafoo
r
' ); } ); it( 'should remove marker from view if it will be affected by rename operation', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ), { usingOperation: true } ); } ); // Adding with 'high' priority, because `applyOperation` is decorated - its default callback is fired with 'normal' priority. model.on( 'applyOperation', () => { expect( mcd.convertMarkerRemove.calledOnce ).to.be.true; expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); }, { priority: 'high' } ); model.change( writer => { writer.rename( p1, 'div' ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'bar
' ); } ); it( 'should remove marker from view if it will be affected by marker operation', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); // Adding with 'high' priority, because `applyOperation` is decorated - its default callback is fired with 'normal' priority. model.on( 'applyOperation', () => { expect( mcd.convertMarkerRemove.calledOnce ).to.be.true; expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); }, { priority: 'high' } ); model.change( writer => { const p2 = p1.nextSibling; writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p2, 1, p2, 2 ), { usingOperation: true } ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); } ); it( 'should remove marker from view if it is removed through marker collection', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); // Adding with 'high' priority, because `applyOperation` is decorated - its default callback is fired with 'normal' priority. model.markers.on( 'remove:marker', () => { expect( mcd.convertMarkerRemove.calledOnce ).to.be.true; expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); }, { priority: 'low' } ); model.change( writer => { writer.removeMarker( 'marker' ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); } ); it( 'should not remove marker if applied operation is an attribute operation', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); // Adding with 'high' priority, because `applyOperation` is decorated - its default callback is fired with 'normal' priority. model.on( 'applyOperation', () => { expect( mcd.convertMarkerRemove.calledOnce ).to.be.false; expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); }, { priority: 'high' } ); model.change( writer => { writer.setAttribute( 'foo', 'bar', ModelRange.createFromParentsAndOffsets( p1, 0, p1, 2 ) ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); } ); it( 'should not crash if multiple operations affect a marker', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); model.change( writer => { writer.insertText( 'a', p1, 0 ); writer.insertText( 'a', p1, 0 ); writer.insertText( 'a', p1, 0 ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'aaafoo
bar
' ); } ); it( 'should not crash if marker is removed, added and removed #1', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); model.change( writer => { writer.insertText( 'a', p1, 0 ); writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 3, p1, 4 ), { usingOperation: true } ); writer.insertText( 'a', p1, 0 ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'aafoo
bar
' ); } ); it( 'should not crash if marker is removed, added and removed #2', () => { model.change( writer => { writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 1, p1, 2 ), { usingOperation: true } ); } ); model.change( writer => { writer.removeMarker( 'marker', { usingOperation: true } ); writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( p1, 0, p1, 1 ), { usingOperation: true } ); writer.removeMarker( 'marker', { usingOperation: true } ); } ); expect( getViewData( editing.view, { withoutSelection: true } ) ).to.equal( 'foo
bar
' ); } ); } ); describe( 'destroy()', () => { it( 'should remove listenters', () => { const model = new Model(); model.document.createRoot(); model.schema.register( 'paragraph', { inheritAllFrom: '$block' } ); const editing = new EditingController( model ); const spy = sinon.spy(); editing.downcastDispatcher.on( 'insert:$element', spy ); editing.destroy(); model.change( writer => { const modelData = parse( '