/** * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import Model from '../../src/model/model'; import Document from '../../src/model/document'; import RootElement from '../../src/model/rootelement'; import Text from '../../src/model/text'; import Batch from '../../src/model/batch'; import Delta from '../../src/model/delta/delta'; import Range from '../../src/model/range'; import Collection from '@ckeditor/ckeditor5-utils/src/collection'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import count from '@ckeditor/ckeditor5-utils/src/count'; import { jsonParseStringify } from './_utils/utils'; import { setData, getData } from '../../src/dev-utils/model'; describe( 'Document', () => { let model, doc; beforeEach( () => { model = new Model(); doc = new Document( model ); // Normally Model is the one who creates Document instance and keeps it as reference. // We have to be sure that Model uses the right Document instance. model.document = doc; } ); describe( 'constructor()', () => { it( 'should create Document with no data, empty graveyard and selection set to default range', () => { const doc = new Document( model ); expect( doc ).to.have.property( 'model' ).to.equal( model ); expect( doc ).to.have.property( 'roots' ).that.is.instanceof( Collection ); expect( doc.roots.length ).to.equal( 1 ); expect( doc.graveyard ).to.be.instanceof( RootElement ); expect( doc.graveyard.maxOffset ).to.equal( 0 ); expect( count( doc.selection.getRanges() ) ).to.equal( 1 ); } ); } ); describe( 'model#applyOperation listener', () => { let operation, data, delta, batch; beforeEach( () => { data = { data: 'x' }; operation = { type: 't', baseVersion: 0, isDocumentOperation: true, _execute: sinon.stub().returns( data ), _validate: () => {} }; delta = new Delta(); delta.addOperation( operation ); delta.type = 'delta'; batch = new Batch(); batch.addDelta( delta ); } ); it( 'for document operation: should increase document version and execute operation', () => { model.applyOperation( operation ); expect( doc.version ).to.equal( 1 ); expect( doc.history._deltas.length ).to.equal( 1 ); sinon.assert.calledOnce( operation._execute ); } ); it( 'for non-document operation: should only execute operation', () => { operation.isDocumentOperation = false; model.applyOperation( operation ); expect( doc.version ).to.equal( 0 ); expect( doc.history._deltas.length ).to.equal( 0 ); sinon.assert.calledOnce( operation._execute ); } ); it( 'should do nothing if operation event was cancelled', () => { model.on( 'applyOperation', evt => evt.stop(), { priority: 'highest' } ); model.applyOperation( operation ); expect( doc.version ).to.equal( 0 ); expect( operation._execute.called ).to.be.false; } ); it( 'should throw an error on the operation base version and the document version is different', () => { const operation = { baseVersion: 1, isDocumentOperation: true, _execute: () => {} }; expect( () => { model.applyOperation( operation ); } ).to.throw( CKEditorError, /^model-document-applyOperation-wrong-version/ ); } ); } ); describe( 'getRootNames()', () => { it( 'should return empty iterator if no roots exist', () => { expect( count( doc.getRootNames() ) ).to.equal( 0 ); } ); it( 'should return an iterator of all roots without the graveyard', () => { doc.createRoot( '$root', 'a' ); doc.createRoot( '$root', 'b' ); expect( Array.from( doc.getRootNames() ) ).to.deep.equal( [ 'a', 'b' ] ); } ); } ); describe( 'createRoot()', () => { it( 'should create a new RootElement with default element and root names, add it to roots map and return it', () => { const root = doc.createRoot(); expect( doc.roots.length ).to.equal( 2 ); expect( root ).to.be.instanceof( RootElement ); expect( root.maxOffset ).to.equal( 0 ); expect( root ).to.have.property( 'name', '$root' ); expect( root ).to.have.property( 'rootName', 'main' ); } ); it( 'should create a new RootElement with custom element and root names, add it to roots map and return it', () => { const root = doc.createRoot( 'customElementName', 'customRootName' ); expect( doc.roots.length ).to.equal( 2 ); expect( root ).to.be.instanceof( RootElement ); expect( root.maxOffset ).to.equal( 0 ); expect( root ).to.have.property( 'name', 'customElementName' ); expect( root ).to.have.property( 'rootName', 'customRootName' ); } ); it( 'should throw an error when trying to create a second root with the same name', () => { doc.createRoot( '$root', 'rootName' ); expect( () => { doc.createRoot( '$root', 'rootName' ); } ).to.throw( CKEditorError, /model-document-createRoot-name-exists/ ); } ); } ); describe( 'getRoot()', () => { it( 'should return a RootElement with default "main" name', () => { const newRoot = doc.createRoot( 'main' ); expect( doc.getRoot() ).to.equal( newRoot ); } ); it( 'should return a RootElement with custom name', () => { const newRoot = doc.createRoot( 'custom', 'custom' ); expect( doc.getRoot( 'custom' ) ).to.equal( newRoot ); } ); it( 'should return null when trying to get non-existent root', () => { expect( doc.getRoot( 'not-existing' ) ).to.null; } ); } ); describe( 'getNearestSelectionRange()', () => { let selection; beforeEach( () => { model.schema.register( 'paragraph', { inheritAllFrom: '$block' } ); model.schema.register( 'emptyBlock', { allowIn: '$root' } ); model.schema.register( 'widget', { allowIn: '$root', isObject: true } ); model.schema.register( 'blockWidget', { allowIn: '$root', allowContentOf: '$block', isObject: true } ); doc.createRoot(); selection = doc.selection; } ); test( 'should return collapsed range if text node can be placed at that position - both', '[]', 'both', '[]' ); test( 'should return collapsed range if text node can be placed at that position - forward', '[]', 'forward', '[]' ); test( 'should return collapsed range if text node can be placed at that position - backward', '[]', 'backward', '[]' ); test( 'should return null in empty document - both', '', 'both', null ); test( 'should return null in empty document - backward', '', 'backward', null ); test( 'should return null in empty document - forward', '', 'forward', null ); test( 'should find range before when searching both ways', '[]', 'both', '[]' ); test( 'should find range before when searching backward', '[]', 'backward', '[]' ); test( 'should find range after when searching forward', '[]', 'forward', '[]' ); test( 'should find range after when searching both ways when it is closer', '[]', 'both', '[]' ); test( 'should find range before when searching both ways when it is closer', '[]', 'both', '[]' ); test( 'should return null if there is no valid range', '[]', 'both', null ); test( 'should return null if there is no valid range in given direction - backward', '[]', 'backward', null ); test( 'should return null if there is no valid range in given direction - forward', '[]', 'forward', null ); test( 'should move forward when placed at root start', '[]', 'both', '[]' ); test( 'should move backward when placed at root end', '[]', 'both', '[]' ); describe( 'in case of objects which do not allow text inside', () => { test( 'should select nearest object (o[]o) - both', '[]', 'both', '[]' ); test( 'should select nearest object (o[]o) - forward', '[]', 'forward', '[]' ); test( 'should select nearest object (o[]o) - backward', '[]', 'both', '[]' ); test( 'should select nearest object (p[]o) - forward', '[]', 'forward', '[]' ); test( 'should select nearest object (o[]p) - both', '[]', 'both', '[]' ); test( 'should select nearest object (o[]p) - backward', '[]', 'backward', '[]' ); test( 'should select nearest object ([]o) - both', '[]', 'both', '[]' ); test( 'should select nearest object ([]o) - forward', '[]', 'forward', '[]' ); test( 'should select nearest object (o[]) - both', '[]', 'both', '[]' ); test( 'should select nearest object (o[]) - backward', '[]', 'both', '[]' ); } ); describe( 'in case of objects which allow text inside', () => { test( 'should select nearest object which allows text (o[]o) - both', '[]', 'both', '[]' ); test( 'should select nearest object (o[]p) - both', '[]', 'both', '[]' ); test( 'should select nearest object which allows text ([]o) - both', '[]', 'both', '[]' ); } ); function test( testName, data, direction, expected ) { it( testName, () => { setData( model, data ); const range = doc.getNearestSelectionRange( selection.anchor, direction ); if ( expected === null ) { expect( range ).to.be.null; } else { selection.setRanges( [ range ] ); expect( getData( model ) ).to.equal( expected ); } } ); } } ); describe( '_getDefaultRoot()', () => { it( 'should return graveyard root if there are no other roots in the document', () => { expect( doc._getDefaultRoot() ).to.equal( doc.graveyard ); } ); it( 'should return the first root added to the document', () => { const rootA = doc.createRoot( '$root', 'rootA' ); doc.createRoot( '$root', 'rootB' ); doc.createRoot( '$root', 'rootC' ); expect( doc._getDefaultRoot() ).to.equal( rootA ); } ); } ); describe( 'destroy()', () => { it( 'should destroy selection instance', () => { const spy = sinon.spy( doc.selection, 'destroy' ); doc.destroy(); sinon.assert.calledOnce( spy ); } ); it( 'should stop listening to events', () => { const spy = sinon.spy(); doc.listenTo( model, 'something', spy ); model.fire( 'something' ); sinon.assert.calledOnce( spy ); doc.destroy(); model.fire( 'something' ); // Still once. sinon.assert.calledOnce( spy ); } ); } ); describe( 'differ', () => { beforeEach( () => { doc.createRoot(); } ); it( 'should buffer document operations in differ', () => { sinon.spy( doc.differ, 'bufferOperation' ); model.change( writer => { writer.insertText( 'foo', doc.getRoot(), 0 ); } ); expect( doc.differ.bufferOperation.called ).to.be.true; } ); it( 'should not buffer changes not done on document', () => { sinon.spy( doc.differ, 'bufferOperation' ); model.change( writer => { const docFrag = writer.createDocumentFragment(); writer.insertText( 'foo', docFrag, 0 ); } ); expect( doc.differ.bufferOperation.called ).to.be.false; } ); it( 'should buffer marker changes in differ', () => { sinon.spy( doc.differ, 'bufferMarkerChange' ); model.change( () => { model.markers.set( 'marker', Range.createCollapsedAt( doc.getRoot(), 0 ) ); } ); expect( doc.differ.bufferMarkerChange.called ).to.be.true; } ); it( 'should reset differ after change block is done', () => { model.change( writer => { writer.insertText( 'foo', doc.getRoot(), 0 ); expect( doc.differ.getChanges().length > 0 ).to.be.true; } ); expect( doc.differ.getChanges().length ).to.equal( 0 ); } ); } ); describe( 'registerPostFixer()', () => { beforeEach( () => { doc.createRoot(); } ); it( 'should add a callback that is fired after changes are done', () => { const spy = sinon.spy(); doc.registerPostFixer( spy ); model.change( writer => { writer.insertText( 'foo', doc.getRoot(), 0 ); } ); expect( spy.calledOnce ).to.be.true; } ); it( 'should not fire callbacks if no changes on document were done', () => { const spy = sinon.spy(); doc.registerPostFixer( spy ); model.change( writer => { const docFrag = writer.createDocumentFragment(); writer.insertText( 'foo', docFrag, 0 ); } ); expect( spy.called ).to.be.false; } ); it( 'should call all already processed callbacks again if a callback returned true', () => { const callA = sinon.spy(); const callB = sinon.stub().onFirstCall().returns( true ).onSecondCall().returns( false ); const callC = sinon.spy(); doc.registerPostFixer( callA ); doc.registerPostFixer( callB ); doc.registerPostFixer( callC ); model.change( writer => { writer.insertText( 'foo', doc.getRoot(), 0 ); } ); expect( callA.calledTwice ).to.be.true; expect( callB.calledTwice ).to.be.true; expect( callC.calledOnce ).to.be.true; } ); } ); describe( 'event change', () => { it( 'should be fired if there was a change in a document tree in a change block and have a batch as a param', () => { doc.createRoot(); const spy = sinon.spy(); doc.on( 'change', ( evt, batch ) => { spy(); expect( batch ).to.be.instanceof( Batch ); } ); model.change( writer => { writer.insertText( 'foo', doc.getRoot(), 0 ); } ); expect( spy.calledOnce ).to.be.true; } ); it( 'should be fired if there was a change in a document tree in a change block and have a batch as param', () => { doc.createRoot(); const spy = sinon.spy(); doc.on( 'change', ( evt, batch ) => { spy(); expect( batch ).to.be.instanceof( Batch ); } ); model.enqueueChange( writer => { writer.insertText( 'foo', doc.getRoot(), 0 ); } ); expect( spy.calledOnce ).to.be.true; } ); it( 'should be fired if there was a selection change in an (enqueue)change block', () => { doc.createRoot(); const spy = sinon.spy(); const root = doc.getRoot(); root.appendChildren( new Text( 'foo' ) ); doc.on( 'change', spy ); model.change( () => { doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 2, root, 2 ) ] ); } ); expect( spy.calledOnce ).to.be.true; } ); it( 'should not be fired if writer was used on non-document tree', () => { const spy = sinon.spy(); doc.on( 'change', ( evt, batch ) => { spy(); expect( batch ).to.be.instanceof( Batch ); } ); model.change( writer => { const docFrag = writer.createDocumentFragment(); writer.insertText( 'foo', docFrag, 0 ); } ); expect( spy.calledOnce ).to.be.false; } ); } ); it( 'should be correctly converted to json', () => { const serialized = jsonParseStringify( doc ); expect( serialized.selection ).to.equal( '[engine.model.DocumentSelection]' ); expect( serialized.model ).to.equal( '[engine.model.Model]' ); } ); } );