/** * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ /* bender-tags: treemodel */ 'use strict'; import Document from '/ckeditor5/engine/treemodel/document.js'; import Element from '/ckeditor5/engine/treemodel/element.js'; import Text from '/ckeditor5/engine/treemodel/text.js'; import TreeWalker from '/ckeditor5/engine/treemodel/treewalker.js'; import Position from '/ckeditor5/engine/treemodel/position.js'; import Range from '/ckeditor5/engine/treemodel/range.js'; import CKEditorError from '/ckeditor5/utils/ckeditorerror.js'; describe( 'TreeWalker', () => { let expected; let doc, root, img1, paragraph, b, a, r, img2, x; let rootBeginning, rootEnding; before( () => { doc = new Document(); root = doc.createRoot( 'root' ); // root // |- img1 // |- p // |- B -bold // |- A -bold // |- R // | // |- img2 // | // |- X b = new Text( 'b', { bold: true } ); a = new Text( 'a', { bold: true } ); r = new Text( 'r' ); img2 = new Element( 'img2' ); x = new Text( 'x' ); paragraph = new Element( 'p', [], [ b, a, r, img2, x ] ); img1 = new Element( 'img1' ); root.insertChildren( 0, [ img1, paragraph ] ); rootBeginning = new Position( root, [ 0 ] ); rootEnding = new Position( root, [ 2 ] ); } ); describe( 'constructor', () => { it( 'should throw if neither boundaries nor starting position is set', () => { expect( () => { new TreeWalker(); } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ ); expect( () => { new TreeWalker( {} ); } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ ); expect( () => { new TreeWalker( { singleCharacters: true } ); } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ ); } ); it( 'should throw if walking direction is unknown', () => { expect( () => { new TreeWalker( { startPosition: rootBeginning, direction: 'UNKNOWN' } ); } ).to.throw( CKEditorError, /^tree-walker-unknown-direction/ ); } ); } ); describe( 'iterate from start position `startPosition`', () => { beforeEach( () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_END', item: img1 }, { type: 'ELEMENT_START', item: paragraph }, { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] }, { type: 'TEXT', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 }, { type: 'ELEMENT_END', item: img2 }, { type: 'TEXT', text: 'x', attrs: [] }, { type: 'ELEMENT_END', item: paragraph } ]; } ); it( 'should provide iterator interface with default FORWARD direction', () => { let iterator = new TreeWalker( { startPosition: rootBeginning } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should provide iterator interface with FORWARD direction', () => { let iterator = new TreeWalker( { startPosition: rootBeginning, direction: 'FORWARD' } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should provide iterator interface which BACKWARD direction', () => { let iterator = new TreeWalker( { startPosition: rootEnding, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); it( 'should throw if walking direction is unknown', () => { let iterator = new TreeWalker( { startPosition: rootEnding } ); iterator.direction = 'UNKNOWN'; expect( () => { iterator.next(); } ).to.throw( CKEditorError, /^tree-walker-unknown-direction/ ); } ); it( 'should start iterating at the startPosition witch is not a root bound', () => { let iterator = new TreeWalker( { startPosition: new Position( root, [ 1 ] ) } ); let i = 2; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should start iterating at the startPosition witch is not a root bound, going backward', () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_END', item: img1 } ]; let iterator = new TreeWalker( { startPosition: new Position( root, [ 1 ] ), direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); describe( 'iterate trough the range `boundary`', () => { let start, end, range; describe( 'range starts between elements', () => { before( () => { expected = [ { type: 'ELEMENT_START', item: paragraph }, { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] }, { type: 'TEXT', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 }, { type: 'ELEMENT_END', item: img2 } ]; start = new Position( root, [ 1 ] ); end = new Position( root, [ 1, 4 ] ); range = new Range( start, end ); } ); it( 'should iterating over the range', () => { let iterator = new TreeWalker( { boundaries: range } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should iterating over the range going backward', () => { let iterator = new TreeWalker( { boundaries: range, startPosition: range.end, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); describe( 'range starts inside the text', () => { before( () => { expected = [ { type: 'TEXT', text: 'a', attrs: [ [ 'bold', true ] ] }, { type: 'TEXT', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 }, { type: 'ELEMENT_END', item: img2 } ]; start = new Position( root, [ 1, 1 ] ); end = new Position( root, [ 1, 4 ] ); range = new Range( start, end ); } ); it( 'should return part of the text', () => { let iterator = new TreeWalker( { boundaries: range } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should return part of the text going backward', () => { let iterator = new TreeWalker( { boundaries: range, startPosition: range.end, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); describe( 'range ends inside the text', () => { before( () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_END', item: img1 }, { type: 'ELEMENT_START', item: paragraph }, { type: 'TEXT', text: 'b', attrs: [ [ 'bold', true ] ] } ]; start = rootBeginning; end = new Position( root, [ 1, 1 ] ); range = new Range( start, end ); } ); it( 'should return part of the text', () => { let iterator = new TreeWalker( { boundaries: range } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should return part of the text going backward', () => { let iterator = new TreeWalker( { boundaries: range, startPosition: range.end, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); } ); describe( 'iterate by every single characters `singleCharacter`', () => { describe( 'whole root', () => { before( () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_END', item: img1 }, { type: 'ELEMENT_START', item: paragraph }, { type: 'CHARACTER', text: 'b', attrs: [ [ 'bold', true ] ] }, { type: 'CHARACTER', text: 'a', attrs: [ [ 'bold', true ] ] }, { type: 'CHARACTER', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 }, { type: 'ELEMENT_END', item: img2 }, { type: 'CHARACTER', text: 'x', attrs: [] }, { type: 'ELEMENT_END', item: paragraph } ]; } ); it( 'should return single characters', () => { let iterator = new TreeWalker( { startPosition: rootBeginning, singleCharacters: true } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should return single characters going backward', () => { let iterator = new TreeWalker( { startPosition: rootEnding, singleCharacters: true, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); describe( 'range', () => { let start, end, range; before( () => { expected = [ { type: 'CHARACTER', text: 'b', attrs: [ [ 'bold', true ] ] }, { type: 'CHARACTER', text: 'a', attrs: [ [ 'bold', true ] ] }, { type: 'CHARACTER', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 } ]; start = new Position( root, [ 1, 0 ] ); // p, 0 end = new Position( root, [ 1, 3, 0 ] ); // img2, 0 range = new Range( start, end ); } ); it( 'should respect boundaries', () => { let iterator = new TreeWalker( { boundaries: range, singleCharacters: true } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should respect boundaries going backward', () => { let iterator = new TreeWalker( { boundaries: range, singleCharacters: true, startPosition: range.end, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); } ); describe( 'iterate omitting child nodes and ELEMENT_END `shallow`', () => { before( () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_START', item: paragraph } ]; } ); it( 'should not enter elements', () => { let iterator = new TreeWalker( { startPosition: rootBeginning, shallow: true } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ], { shallow: true } ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should not enter elements going backward', () => { let iterator = new TreeWalker( { startPosition: rootEnding, shallow: true, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ], { shallow: true } ); } expect( i ).to.equal( 0 ); } ); } ); describe( 'iterate omitting ELEMENT_END `ignoreElementEnd`', () => { describe( 'merged text', () => { before( () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_START', item: paragraph }, { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] }, { type: 'TEXT', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 }, { type: 'TEXT', text: 'x', attrs: [] } ]; } ); it( 'should iterate ignoring ELEMENT_END', () => { let iterator = new TreeWalker( { startPosition: rootBeginning, ignoreElementEnd: true } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should iterate ignoring ELEMENT_END going backward', () => { let iterator = new TreeWalker( { startPosition: rootEnding, ignoreElementEnd: true, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); describe( 'single character', () => { before( () => { expected = [ { type: 'ELEMENT_START', item: img1 }, { type: 'ELEMENT_START', item: paragraph }, { type: 'CHARACTER', text: 'b', attrs: [ [ 'bold', true ] ] }, { type: 'CHARACTER', text: 'a', attrs: [ [ 'bold', true ] ] }, { type: 'CHARACTER', text: 'r', attrs: [] }, { type: 'ELEMENT_START', item: img2 }, { type: 'CHARACTER', text: 'x', attrs: [] } ]; } ); it( 'should return single characters ignoring ELEMENT_END', () => { let iterator = new TreeWalker( { startPosition: rootBeginning, singleCharacters: true, ignoreElementEnd: true } ); let i = 0; for ( let value of iterator ) { expectValue( value, expected[ i ] ); i++; } expect( i ).to.equal( expected.length ); } ); it( 'should return single characters ignoring ELEMENT_END going backward', () => { let iterator = new TreeWalker( { startPosition: rootEnding, singleCharacters: true, ignoreElementEnd: true, direction: 'BACKWARD' } ); let i = expected.length; for ( let value of iterator ) { expectValue( value, expected[ --i ] ); } expect( i ).to.equal( 0 ); } ); } ); } ); } ); function expectValue( value, expected, options ) { expect( value.type ).to.equal( expected.type ); if ( value.type == 'TEXT' ) { expectText( value, expected, options ); } else if ( value.type == 'CHARACTER' ) { expectCharacter( value, expected, options ); } else if ( value.type == 'ELEMENT_START' ) { expectStart( value, expected, options ); } else if ( value.type == 'ELEMENT_END' ) { expectEnd( value, expected, options ); } } function expectText( value, expected ) { expect( value.item.text ).to.equal( expected.text ); expect( Array.from( value.item.first._attrs ) ).to.deep.equal( expected.attrs ); expect( value.length ).to.equal( value.item.text.length ); expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item.first ) ); expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item.last ) ); } function expectCharacter( value, expected ) { expect( value.item.character ).to.equal( expected.text ); expect( Array.from( value.item._attrs ) ).to.deep.equal( expected.attrs ); expect( value.length ).to.equal( value.item.character.length ); expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) ); expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) ); } function expectStart( value, expected, options ) { expect( value.item ).to.equal( expected.item ); expect( value.length ).to.equal( 1 ); if ( options && options.shallow ) { expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) ); } else { expect( value.nextPosition ).to.deep.equal( Position.createFromParentAndOffset( value.item, 0 ) ); } } function expectEnd( value, expected ) { expect( value.item ).to.equal( expected.item ); expect( value.length ).to.be.undefined; expect( value.previousPosition ).to.deep.equal( Position.createFromParentAndOffset( value.item, value.item.getChildCount() ) ); expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) ); }