| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /* bender-tags: model */
- import Document from 'ckeditor5/engine/model/document.js';
- import Schema from 'ckeditor5/engine/model/schema.js';
- import RootElement from 'ckeditor5/engine/model/rootelement.js';
- import Element from 'ckeditor5/engine/model/element.js';
- import Batch from 'ckeditor5/engine/model/batch.js';
- import Delta from 'ckeditor5/engine/model/delta/delta.js';
- import Position from 'ckeditor5/engine/model/position.js';
- import Range from 'ckeditor5/engine/model/range.js';
- import CKEditorError from 'ckeditor5/utils/ckeditorerror.js';
- import count from 'ckeditor5/utils/count.js';
- import { jsonParseStringify } from 'tests/engine/model/_utils/utils.js';
- describe( 'Document', () => {
- let doc;
- beforeEach( () => {
- doc = new Document();
- } );
- describe( 'constructor()', () => {
- it( 'should create Document with no data, empty graveyard and selection set to default range', () => {
- expect( doc ).to.have.property( '_roots' ).that.is.instanceof( Map );
- expect( doc._roots.size ).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 );
- expect( doc.schema ).to.be.instanceof( Schema );
- } );
- } );
- 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', () => {
- let root = doc.createRoot();
- expect( doc._roots.size ).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', () => {
- let root = doc.createRoot( 'customElementName', 'customRootName' );
- expect( doc._roots.size ).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 previously created with given name', () => {
- let newRoot = doc.createRoot();
- let getRoot = doc.getRoot();
- expect( getRoot ).to.equal( newRoot );
- } );
- it( 'should throw an error when trying to get non-existent root', () => {
- expect(
- () => {
- doc.getRoot( 'root' );
- }
- ).to.throw( CKEditorError, /model-document-getRoot-root-not-exist/ );
- } );
- } );
- describe( 'hasRoot', () => {
- it( 'should return true when Document has RootElement with given name', () => {
- doc.createRoot();
- expect( doc.hasRoot( 'main' ) ).to.be.true;
- } );
- it( 'should return false when Document does not have RootElement with given name', () => {
- expect( doc.hasRoot( 'noroot' ) ).to.be.false;
- } );
- } );
- describe( 'applyOperation', () => {
- it( 'should increase document version, execute operation and fire event with proper data', () => {
- const changeCallback = sinon.spy();
- const type = 't';
- const data = { data: 'x' };
- const batch = new Batch();
- const delta = new Delta();
- let operation = {
- type: type,
- baseVersion: 0,
- _execute: sinon.stub().returns( data )
- };
- delta.addOperation( operation );
- batch.addDelta( delta );
- doc.on( 'change', changeCallback );
- doc.applyOperation( operation );
- expect( doc.version ).to.equal( 1 );
- sinon.assert.calledOnce( operation._execute );
- sinon.assert.calledOnce( changeCallback );
- expect( changeCallback.args[ 0 ][ 1 ] ).to.equal( type );
- expect( changeCallback.args[ 0 ][ 2 ] ).to.equal( data );
- expect( changeCallback.args[ 0 ][ 3 ] ).to.equal( batch );
- } );
- it( 'should throw an error on the operation base version and the document version is different', () => {
- let operation = {
- baseVersion: 1
- };
- expect(
- () => {
- doc.applyOperation( operation );
- }
- ).to.throw( CKEditorError, /model-document-applyOperation-wrong-version/ );
- } );
- } );
- describe( 'batch', () => {
- it( 'should create a new batch with the document property', () => {
- const batch = doc.batch();
- expect( batch ).to.be.instanceof( Batch );
- expect( batch ).to.have.property( 'document' ).that.equals( doc );
- } );
- it( 'should set given batch type', () => {
- const batch = doc.batch( 'ignore' );
- expect( batch ).to.have.property( 'type' ).that.equals( 'ignore' );
- } );
- } );
- describe( 'enqueue', () => {
- it( 'should be executed immediately and fire changesDone event', () => {
- let order = [];
- doc.on( 'changesDone', () => order.push( 'done' ) );
- doc.enqueueChanges( () => order.push( 'enqueue1' ) );
- expect( order ).to.have.length( 2 );
- expect( order[ 0 ] ).to.equal( 'enqueue1' );
- expect( order[ 1 ] ).to.equal( 'done' );
- } );
- it( 'should fire done every time queue is empty', () => {
- let order = [];
- doc.on( 'changesDone', () => order.push( 'done' ) );
- doc.enqueueChanges( () => order.push( 'enqueue1' ) );
- doc.enqueueChanges( () => order.push( 'enqueue2' ) );
- expect( order ).to.have.length( 4 );
- expect( order[ 0 ] ).to.equal( 'enqueue1' );
- expect( order[ 1 ] ).to.equal( 'done' );
- expect( order[ 2 ] ).to.equal( 'enqueue2' );
- expect( order[ 3 ] ).to.equal( 'done' );
- } );
- it( 'should put callbacks in the proper order', () => {
- let order = [];
- doc.on( 'changesDone', () => order.push( 'done' ) );
- doc.enqueueChanges( () => {
- order.push( 'enqueue1 start' );
- doc.enqueueChanges( () => {
- order.push( 'enqueue2 start' );
- doc.enqueueChanges( () => order.push( 'enqueue4' ) );
- order.push( 'enqueue2 end' );
- } );
- doc.enqueueChanges( () => order.push( 'enqueue3' ) );
- order.push( 'enqueue1 end' );
- } );
- expect( order ).to.have.length( 7 );
- expect( order[ 0 ] ).to.equal( 'enqueue1 start' );
- expect( order[ 1 ] ).to.equal( 'enqueue1 end' );
- expect( order[ 2 ] ).to.equal( 'enqueue2 start' );
- expect( order[ 3 ] ).to.equal( 'enqueue2 end' );
- expect( order[ 4 ] ).to.equal( 'enqueue3' );
- expect( order[ 5 ] ).to.equal( 'enqueue4' );
- expect( order[ 6 ] ).to.equal( 'done' );
- } );
- } );
- describe( 'selection', () => {
- it( 'should get updated attributes whenever attribute operation is applied', () => {
- sinon.spy( doc.selection, '_updateAttributes' );
- doc.fire( 'change', 'addAttribute' );
- expect( doc.selection._updateAttributes.called ).to.be.true;
- } );
- it( 'should throw if one of ranges starts or ends inside surrogate pair', () => {
- const root = doc.createRoot();
- root.appendChildren( '\uD83D\uDCA9' );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 0, root, 1 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 2 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- } );
- it( 'should throw if one of ranges starts or ends between base character and combining mark', () => {
- const root = doc.createRoot();
- root.appendChildren( 'foo̻̐ͩbar' );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 3, root, 9 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 4, root, 9 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 5, root, 9 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 3 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 4 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- expect( () => {
- doc.selection.setRanges( [ Range.createFromParentsAndOffsets( root, 1, root, 5 ) ] );
- } ).to.throw( CKEditorError, /document-selection-wrong-position/ );
- } );
- } );
- describe( 'getNearestSelectionPosition', () => {
- let root;
- beforeEach( () => {
- doc.schema.registerItem( 'paragraph', '$block' );
- root = doc.createRoot();
- } );
- it( 'should return equal position if text node can be placed at that position', () => {
- root.appendChildren( new Element( 'paragraph' ) );
- const position = new Position( root, [ 0, 0 ] );
- const selectionPosition = doc.getNearestSelectionPosition( position );
- expect( position.isEqual( selectionPosition ) ).to.be.true;
- } );
- it( 'should return a position before if it is a closer position at which text node can be placed', () => {
- root.appendChildren( [ new Element( 'paragraph' ), new Element( 'paragraph' ) ] );
- const position = new Position( root, [ 1 ] );
- const selectionPosition = doc.getNearestSelectionPosition( position );
- expect( selectionPosition.path ).to.deep.equal( [ 0, 0 ] );
- } );
- it( 'should return a position after if it is a closer position at which text node can be placed', () => {
- root.appendChildren( [ new Element( 'paragraph' ), new Element( 'image' ), new Element( 'paragraph' ) ] );
- const position = new Position( root, [ 2 ] );
- const selectionPosition = doc.getNearestSelectionPosition( position );
- expect( selectionPosition.path ).to.deep.equal( [ 2, 0 ] );
- } );
- it( 'should return first position in root if there is no position where text node can be placed', () => {
- root.appendChildren( new Element( 'table' ) );
- const position = new Position( root, [ 0, 0 ] );
- const selectionPosition = doc.getNearestSelectionPosition( position );
- expect( selectionPosition.path ).to.deep.equal( [ 0 ] );
- } );
- } );
- 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', () => {
- let rootA = doc.createRoot( '$root', 'rootA' );
- doc.createRoot( '$root', 'rootB' );
- doc.createRoot( '$root', 'rootC' );
- expect( doc._getDefaultRoot() ).to.equal( rootA );
- } );
- } );
- it( 'should be correctly converted to json', () => {
- expect( jsonParseStringify( doc ).selection ).to.equal( '[engine.model.LiveSelection]' );
- } );
- } );
|