|
|
@@ -15,8 +15,12 @@ import Position from '/ckeditor5/core/treemodel/position.js';
|
|
|
import Range from '/ckeditor5/core/treemodel/range.js';
|
|
|
import CKEditorError from '/ckeditor5/core/ckeditorerror.js';
|
|
|
|
|
|
-describe( 'range iterator', () => {
|
|
|
- let doc, expectedItemsSingle, expectedItemsMerged, root, img1, paragraph, b, a, r, img2, x;
|
|
|
+describe( 'TreeWalker', () => {
|
|
|
+ let expectedSingle, expected, expectedIgnoreEnd, expectedSingleIgnoreEnd;
|
|
|
+ let expectedShallow, expectedCroppedStart, expectedCroppedEnd;
|
|
|
+
|
|
|
+ let doc, root, img1, paragraph, b, a, r, img2, x;
|
|
|
+ let rootBeginning;
|
|
|
|
|
|
before( () => {
|
|
|
doc = new Document();
|
|
|
@@ -25,8 +29,8 @@ describe( 'range iterator', () => {
|
|
|
// root
|
|
|
// |- img1
|
|
|
// |- p
|
|
|
- // |- B
|
|
|
- // |- A
|
|
|
+ // |- B -bold
|
|
|
+ // |- A -bold
|
|
|
// |- R
|
|
|
// |
|
|
|
// |- img2
|
|
|
@@ -44,7 +48,37 @@ describe( 'range iterator', () => {
|
|
|
|
|
|
root.insertChildren( 0, [ img1, paragraph ] );
|
|
|
|
|
|
- expectedItemsSingle = [
|
|
|
+ rootBeginning = new Position( root, [ 0 ] );
|
|
|
+
|
|
|
+ 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 }
|
|
|
+ ];
|
|
|
+
|
|
|
+ expectedCroppedEnd = [
|
|
|
+ { type: 'ELEMENT_START', item: img1 },
|
|
|
+ { type: 'ELEMENT_END', item: img1 },
|
|
|
+ { type: 'ELEMENT_START', item: paragraph },
|
|
|
+ { type: 'TEXT', text: 'b', attrs: [ [ 'bold', true ] ] }
|
|
|
+ ];
|
|
|
+
|
|
|
+ expectedCroppedStart = [
|
|
|
+ { type: 'TEXT', text: 'a', 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 }
|
|
|
+ ];
|
|
|
+
|
|
|
+ expectedSingle = [
|
|
|
{ type: 'ELEMENT_START', item: img1 },
|
|
|
{ type: 'ELEMENT_END', item: img1 },
|
|
|
{ type: 'ELEMENT_START', item: paragraph },
|
|
|
@@ -57,36 +91,48 @@ describe( 'range iterator', () => {
|
|
|
{ type: 'ELEMENT_END', item: paragraph }
|
|
|
];
|
|
|
|
|
|
- expectedItemsMerged = [
|
|
|
+ expectedIgnoreEnd = [
|
|
|
{ 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 }
|
|
|
+ { type: 'TEXT', text: 'x', attrs: [] }
|
|
|
+ ];
|
|
|
+
|
|
|
+ expectedSingleIgnoreEnd = [
|
|
|
+ { 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: [] }
|
|
|
+ ];
|
|
|
+
|
|
|
+ expectedShallow = [
|
|
|
+ { type: 'ELEMENT_START', item: img1 },
|
|
|
+ { type: 'ELEMENT_START', item: paragraph }
|
|
|
];
|
|
|
} );
|
|
|
|
|
|
- function expectItem( item, expected ) {
|
|
|
+ function expectItem( item, expected, options ) {
|
|
|
expect( item.done ).to.be.false;
|
|
|
|
|
|
- expectValue( item.value, expected );
|
|
|
+ expectValue( item.value, expected, options );
|
|
|
}
|
|
|
|
|
|
- function expectValue( value, expected ) {
|
|
|
+ function expectValue( value, expected, options ) {
|
|
|
expect( value.type ).to.equal( expected.type );
|
|
|
|
|
|
if ( value.type == 'TEXT' ) {
|
|
|
- expectText( value, expected );
|
|
|
+ expectText( value, expected, options );
|
|
|
} else if ( value.type == 'CHARACTER' ) {
|
|
|
- expectCharacter( value, expected );
|
|
|
+ expectCharacter( value, expected, options );
|
|
|
} else if ( value.type == 'ELEMENT_START' ) {
|
|
|
- expectStart( value, expected );
|
|
|
+ expectStart( value, expected, options );
|
|
|
} else if ( value.type == 'ELEMENT_END' ) {
|
|
|
- expectEnd( value, expected );
|
|
|
+ expectEnd( value, expected, options );
|
|
|
}
|
|
|
}
|
|
|
|
|
|
@@ -106,11 +152,16 @@ describe( 'range iterator', () => {
|
|
|
expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) );
|
|
|
}
|
|
|
|
|
|
- function expectStart( value, expected ) {
|
|
|
+ function expectStart( value, expected, options ) {
|
|
|
expect( value.item ).to.equal( expected.item );
|
|
|
expect( value.length ).to.equal( 1 );
|
|
|
expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) );
|
|
|
- expect( value.nextPosition ).to.deep.equal( Position.createFromParentAndOffset( value.item, 0 ) );
|
|
|
+
|
|
|
+ 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 ) {
|
|
|
@@ -121,124 +172,166 @@ describe( 'range iterator', () => {
|
|
|
expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) );
|
|
|
}
|
|
|
|
|
|
- describe( 'merged characters', () => {
|
|
|
- it( 'should iterate over the range using next', () => {
|
|
|
- let start = new Position( root, [ 1 ] );
|
|
|
- let end = new Position( root, [ 1, 4 ] );
|
|
|
- let range = new Range( start, end );
|
|
|
+ it( 'should provide iterator methods', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: rootBeginning } );
|
|
|
|
|
|
- let iterator = new TreeWalker( { boundaries: range, position: range.start } );
|
|
|
- let i;
|
|
|
+ for ( let i = 0; i <= 8; i++ ) {
|
|
|
+ expectItem( iterator.next(), expected[ i ] );
|
|
|
+ }
|
|
|
+ expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
|
|
|
+ } );
|
|
|
|
|
|
- for ( i = 2; i <= 6; i++ ) {
|
|
|
- expectItem( iterator.next(), expectedItemsMerged[ i ] );
|
|
|
- }
|
|
|
- expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
|
|
|
- } );
|
|
|
+ it( 'should provide iterator interface', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: rootBeginning } );
|
|
|
+ let i = 0;
|
|
|
|
|
|
- it( 'should iterate over the range using previous', () => {
|
|
|
- let start = new Position( root, [ 1 ] );
|
|
|
- let end = new Position( root, [ 1, 4 ] );
|
|
|
- let range = new Range( start, end );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expected[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
|
|
|
- let iterator = new TreeWalker( { boundaries: range, position: range.end } );
|
|
|
+ expect( i ).to.equal( expected.length );
|
|
|
+ } );
|
|
|
|
|
|
- for ( let i = 6; i >= 2; i-- ) {
|
|
|
- expectItem( iterator.previous(), expectedItemsMerged[ i ] );
|
|
|
- }
|
|
|
- expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
|
|
|
- } );
|
|
|
+ it( 'should start at the startPosition', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: new Position( root, [ 1 ] ) } );
|
|
|
+ let i = 2;
|
|
|
|
|
|
- it( 'should respect boundaries when iterating using next', () => {
|
|
|
- let start = new Position( root, [ 1, 0 ] );
|
|
|
- let end = new Position( root, [ 1, 1 ] );
|
|
|
- let range = new Range( start, end );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expected[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
|
|
|
- let iterator = new TreeWalker( { boundaries: range, position: range.start } );
|
|
|
- let val = iterator.next();
|
|
|
+ expect( i ).to.equal( expected.length );
|
|
|
+ } );
|
|
|
|
|
|
- expect( val.done ).to.be.false;
|
|
|
- expect( val.value.item.text ).to.equal( 'b' );
|
|
|
+ it( 'should iterating over the range', () => {
|
|
|
+ let start = new Position( root, [ 1 ] );
|
|
|
+ let end = new Position( root, [ 1, 4 ] );
|
|
|
+ let range = new Range( start, end );
|
|
|
|
|
|
- val = iterator.next();
|
|
|
- expect( val.done ).to.be.true;
|
|
|
- } );
|
|
|
+ let iterator = new TreeWalker( { boundaries: range } );
|
|
|
+ let i = 2;
|
|
|
|
|
|
- it( 'should respect boundaries when iterating using previous', () => {
|
|
|
- let start = new Position( root, [ 1, 1 ] );
|
|
|
- let end = new Position( root, [ 1, 2 ] );
|
|
|
- let range = new Range( start, end );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expected[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
+
|
|
|
+ expect( i ).to.equal( 7 );
|
|
|
+ } );
|
|
|
|
|
|
- let iterator = new TreeWalker( { boundaries: range, position: range.end } );
|
|
|
- let val = iterator.previous();
|
|
|
+ it( 'should start iterating at startPosition even if the range is defined', () => {
|
|
|
+ let start = new Position( root, [ 1 ] );
|
|
|
+ let end = new Position( root, [ 1, 4 ] );
|
|
|
+ let range = new Range( start, end );
|
|
|
|
|
|
- expect( val.done ).to.be.false;
|
|
|
- expect( val.value.item.text ).to.equal( 'a' );
|
|
|
+ let iterator = new TreeWalker( { boundaries: range } );
|
|
|
+ let i = 2;
|
|
|
|
|
|
- val = iterator.previous();
|
|
|
- expect( val.done ).to.be.true;
|
|
|
- } );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expected[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
+
|
|
|
+ expect( i ).to.equal( 7 );
|
|
|
} );
|
|
|
|
|
|
- describe( 'single characters', () => {
|
|
|
- it( 'should iterate over the range using next', () => {
|
|
|
- let iterator = new TreeWalker( { position: new Position( root, [ 0 ] ), singleCharacters: true } ); // beginning of root
|
|
|
- let i, len;
|
|
|
+ it( 'should return part of the text if range starts inside the text', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: new Position( root, [ 1, 1 ] ) } );
|
|
|
+ let i = 0;
|
|
|
|
|
|
- for ( i = 0, len = expectedItemsSingle.length; i < len; i++ ) {
|
|
|
- expectItem( iterator.next(), expectedItemsSingle[ i ] );
|
|
|
- }
|
|
|
- expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
|
|
|
- } );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedCroppedStart[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
+
|
|
|
+ expect( i ).to.equal( expectedCroppedStart.length );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should return part of the text if range ends inside the text', () => {
|
|
|
+ let start = rootBeginning;
|
|
|
+ let end = new Position( root, [ 1, 1 ] );
|
|
|
+ let range = new Range( start, end );
|
|
|
+
|
|
|
+ let iterator = new TreeWalker( { boundaries: range } );
|
|
|
+ let i = 0;
|
|
|
+
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedCroppedEnd[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
+
|
|
|
+ expect( i ).to.equal( expectedCroppedEnd.length );
|
|
|
+ } );
|
|
|
|
|
|
- it( 'should iterate over the range using previous', () => {
|
|
|
- let iterator = new TreeWalker( { position: new Position( root, [ 2 ] ), singleCharacters: true } ); // ending of root
|
|
|
+ describe( 'singleCharacters', () => {
|
|
|
+ it( 'should return single characters', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: rootBeginning, singleCharacters: true } );
|
|
|
+ let i = 0;
|
|
|
|
|
|
- for ( let i = expectedItemsSingle.length - 1; i >= 0; i-- ) {
|
|
|
- expectItem( iterator.previous(), expectedItemsSingle[ i ] );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedSingle[ i ] );
|
|
|
+ i++;
|
|
|
}
|
|
|
- expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
|
|
|
+
|
|
|
+ expect( i ).to.equal( expectedSingle.length );
|
|
|
} );
|
|
|
|
|
|
- it( 'should respect boundaries when iterating using next', () => {
|
|
|
+ it( 'should respect boundaries', () => {
|
|
|
let start = new Position( root, [ 1, 0 ] ); // p, 0
|
|
|
let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
|
|
|
|
|
|
let iterator = new TreeWalker( { boundaries: new Range( start, end ), singleCharacters: true } );
|
|
|
+ let i = 3;
|
|
|
|
|
|
- let i, len;
|
|
|
-
|
|
|
- for ( i = 3, len = expectedItemsSingle.length; i < 7; i++ ) {
|
|
|
- expectItem( iterator.next(), expectedItemsSingle[ i ] );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedSingle[ i ] );
|
|
|
+ i++;
|
|
|
}
|
|
|
- expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
|
|
|
+
|
|
|
+ expect( i ).to.equal( 7 );
|
|
|
} );
|
|
|
+ } );
|
|
|
|
|
|
- it( 'should respect boundaries when iterating using previous', () => {
|
|
|
- let start = new Position( root, [ 1, 0 ] ); // p, 0
|
|
|
- let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
|
|
|
+ describe( 'shallow', () => {
|
|
|
+ it( 'should not enter elements', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: rootBeginning, shallow: true } );
|
|
|
+ let i = 0;
|
|
|
|
|
|
- let iterator = new TreeWalker( { boundaries: new Range( start, end ), position: end, singleCharacters: true } );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedShallow[ i ], { shallow: true } );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
+
|
|
|
+ expect( i ).to.equal( expectedShallow.length );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
|
|
|
- let i, len;
|
|
|
+ describe( 'ignoreElementEnd', () => {
|
|
|
+ it( 'should iterate ignoring ELEMENT_END', () => {
|
|
|
+ let iterator = new TreeWalker( { startPosition: rootBeginning, ignoreElementEnd: true } );
|
|
|
+ let i = 0;
|
|
|
|
|
|
- for ( i = 6, len = expectedItemsSingle.length; i > 2; i-- ) {
|
|
|
- expectItem( iterator.previous(), expectedItemsSingle[ i ] );
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedIgnoreEnd[ i ] );
|
|
|
+ i++;
|
|
|
}
|
|
|
- expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
|
|
|
+
|
|
|
+ expect( i ).to.equal( expectedIgnoreEnd.length );
|
|
|
} );
|
|
|
- } );
|
|
|
|
|
|
- it( 'should provide iterator interface', () => {
|
|
|
- let iterator = new TreeWalker( { position: new Position( root, [ 0 ] ) } );
|
|
|
- let i = 0;
|
|
|
+ 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, expectedItemsMerged[ i ] );
|
|
|
- i++;
|
|
|
- }
|
|
|
+ for ( let value of iterator ) {
|
|
|
+ expectValue( value, expectedSingleIgnoreEnd[ i ] );
|
|
|
+ i++;
|
|
|
+ }
|
|
|
|
|
|
- expect( i ).to.equal( 9 );
|
|
|
+ expect( i ).to.equal( expectedSingleIgnoreEnd.length );
|
|
|
+ } );
|
|
|
} );
|
|
|
|
|
|
it( 'should throw if neither boundaries nor starting position is set', () => {
|