range.js 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Range from '../../src/model/range';
  6. import Position from '../../src/model/position';
  7. import Element from '../../src/model/element';
  8. import Text from '../../src/model/text';
  9. import Document from '../../src/model/document';
  10. import TreeWalker from '../../src/model/treewalker';
  11. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  12. import { jsonParseStringify } from '../../tests/model/_utils/utils';
  13. import {
  14. getAttributeDelta,
  15. getInsertDelta,
  16. getMoveDelta,
  17. getRemoveDelta,
  18. getRenameDelta,
  19. getSplitDelta
  20. } from '../../tests/model/delta/transform/_utils/utils';
  21. describe( 'Range', () => {
  22. let doc, range, start, end, root, otherRoot;
  23. beforeEach( () => {
  24. doc = new Document();
  25. root = doc.createRoot();
  26. otherRoot = doc.createRoot( '$root', 'otherRoot' );
  27. start = new Position( root, [ 1 ] );
  28. end = new Position( root, [ 2 ] );
  29. range = new Range( start, end );
  30. } );
  31. describe( 'constructor()', () => {
  32. it( 'should create a range with given positions', () => {
  33. expect( range.start.isEqual( start ) ).to.be.true;
  34. expect( range.end.isEqual( end ) ).to.be.true;
  35. } );
  36. it( 'should create collapsed range', () => {
  37. const collapsed = new Range( start );
  38. expect( collapsed.start.isEqual( start ) ).to.be.true;
  39. expect( collapsed.isCollapsed ).to.be.true;
  40. } );
  41. } );
  42. describe( 'root', () => {
  43. it( 'should be equal to start position root', () => {
  44. expect( range.root ).to.equal( start.root );
  45. } );
  46. } );
  47. describe( 'isCollapsed', () => {
  48. it( 'should be true if range start and end positions are equal', () => {
  49. let collapsedRange = new Range( start, start );
  50. expect( collapsedRange.isCollapsed ).to.be.true;
  51. } );
  52. it( 'should be false if range start and end positions are not equal', () => {
  53. expect( range.isCollapsed ).to.be.false;
  54. } );
  55. } );
  56. describe( 'isEqual', () => {
  57. it( 'should return true if the ranges are the same', () => {
  58. let sameStart = Position.createFromPosition( start );
  59. let sameEnd = Position.createFromPosition( end );
  60. let sameRange = new Range( sameStart, sameEnd );
  61. expect( range.isEqual( sameRange ) ).to.be.true;
  62. } );
  63. it( 'should return false if the start position is different', () => {
  64. let range = new Range( start, end );
  65. let diffStart = new Position( root, [ 0 ] );
  66. let sameEnd = Position.createFromPosition( end );
  67. let diffRange = new Range( diffStart, sameEnd );
  68. expect( range.isEqual( diffRange ) ).to.be.false;
  69. } );
  70. it( 'should return false if the end position is different', () => {
  71. let sameStart = new Position( root, [ 0 ] );
  72. let diffEnd = new Position( root, [ 0 ] );
  73. let diffRange = new Range( sameStart, diffEnd );
  74. expect( range.isEqual( diffRange ) ).to.be.false;
  75. } );
  76. it( 'should return false if ranges are in different roots', () => {
  77. let otherRootStart = new Position( otherRoot, start.path.slice() );
  78. let otherRootEnd = new Position( otherRoot, end.path.slice() );
  79. let otherRootRange = new Range( otherRootStart, otherRootEnd );
  80. expect( range.isEqual( otherRootRange ) ).to.be.false;
  81. } );
  82. } );
  83. describe( 'isIntersecting', () => {
  84. it( 'should return true if given range is equal', () => {
  85. let otherRange = Range.createFromRange( range );
  86. expect( range.isIntersecting( otherRange ) ).to.be.true;
  87. } );
  88. it( 'should return true if given range contains this range', () => {
  89. let otherRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 3 ] ) );
  90. expect( range.isIntersecting( otherRange ) ).to.be.true;
  91. } );
  92. it( 'should return true if given range ends in this range', () => {
  93. let otherRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 4 ] ) );
  94. expect( range.isIntersecting( otherRange ) ).to.be.true;
  95. } );
  96. it( 'should return true if given range starts in this range', () => {
  97. let otherRange = new Range( new Position( root, [ 1, 4 ] ), new Position( root, [ 3 ] ) );
  98. expect( range.isIntersecting( otherRange ) ).to.be.true;
  99. } );
  100. it( 'should return false if given range is fully before this range', () => {
  101. let otherRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  102. expect( range.isIntersecting( otherRange ) ).to.be.false;
  103. } );
  104. it( 'should return false if given range is fully after this range', () => {
  105. let otherRange = new Range( new Position( root, [ 2 ] ), new Position( root, [ 2, 0 ] ) );
  106. expect( range.isIntersecting( otherRange ) ).to.be.false;
  107. } );
  108. it( 'should return false if ranges are in different roots', () => {
  109. let otherRange = new Range( new Position( otherRoot, [ 0 ] ), new Position( otherRoot, [ 1, 4 ] ) );
  110. expect( range.isIntersecting( otherRange ) ).to.be.false;
  111. } );
  112. } );
  113. describe( 'static constructors', () => {
  114. let p;
  115. // root
  116. // |- p
  117. // |- foz
  118. beforeEach( () => {
  119. p = new Element( 'p', [], new Text( 'foz' ) );
  120. root.insertChildren( 0, [ p ] );
  121. } );
  122. describe( 'createIn', () => {
  123. it( 'should return range', () => {
  124. const range = Range.createIn( p );
  125. expect( range.start.path ).to.deep.equal( [ 0, 0 ] );
  126. expect( range.end.path ).to.deep.equal( [ 0, 3 ] );
  127. } );
  128. } );
  129. describe( 'createOn', () => {
  130. it( 'should return range', () => {
  131. const range = Range.createOn( p );
  132. expect( range.start.path ).to.deep.equal( [ 0 ] );
  133. expect( range.end.path ).to.deep.equal( [ 1 ] );
  134. } );
  135. } );
  136. describe( 'createFromParentsAndOffsets', () => {
  137. it( 'should return range', () => {
  138. const range = Range.createFromParentsAndOffsets( root, 0, p, 2 );
  139. expect( range.start.path ).to.deep.equal( [ 0 ] );
  140. expect( range.end.path ).to.deep.equal( [ 0, 2 ] );
  141. } );
  142. } );
  143. describe( 'createFromPositionAndShift', () => {
  144. it( 'should make range from start position and offset', () => {
  145. const position = new Position( root, [ 1, 2, 3 ] );
  146. const range = Range.createFromPositionAndShift( position, 4 );
  147. expect( range ).to.be.instanceof( Range );
  148. expect( range.start.isEqual( position ) ).to.be.true;
  149. expect( range.end.root ).to.equal( range.start.root );
  150. expect( range.end.path ).to.deep.equal( [ 1, 2, 7 ] );
  151. } );
  152. } );
  153. describe( 'createFromRange', () => {
  154. it( 'should create a new instance of Range that is equal to passed range', () => {
  155. const clone = Range.createFromRange( range );
  156. expect( clone ).not.to.be.equal( range ); // clone is not pointing to the same object as position
  157. expect( clone.isEqual( range ) ).to.be.true; // but they are equal in the position-sense
  158. } );
  159. } );
  160. describe( 'createFromRanges', () => {
  161. function makeRanges( root, ...points ) {
  162. let ranges = [];
  163. for ( let i = 0; i < points.length; i += 2 ) {
  164. ranges.push( Range.createFromParentsAndOffsets( root, points[ i ], root, points[ i + 1 ] ) );
  165. }
  166. return ranges;
  167. }
  168. beforeEach( () => {
  169. root.appendChildren( new Text( 'abcdefghijklmnopqrtuvwxyz' ) );
  170. } );
  171. it( 'should throw if empty array is passed', () => {
  172. expect( () => {
  173. Range.createFromRanges( [] );
  174. } ).to.throw( CKEditorError, /^range-create-from-ranges-empty-array/ );
  175. } );
  176. it( 'should return a copy of the range if only one range was passed', () => {
  177. const original = Range.createFromParentsAndOffsets( root, 2, root, 3 );
  178. const range = Range.createFromRanges( [ original ] );
  179. expect( range.isEqual( original ) ).to.be.true;
  180. expect( range ).not.to.be.equal( original );
  181. } );
  182. it( 'should combine ranges with reference range', () => {
  183. const range = Range.createFromRanges( makeRanges( root, 3, 7, 2, 3, 7, 9, 11, 14, 0, 1 ) );
  184. expect( range.start.offset ).to.equal( 2 );
  185. expect( range.end.offset ).to.equal( 9 );
  186. } );
  187. } );
  188. } );
  189. describe( 'iterator', () => {
  190. it( 'should iterate over the range returning tree walker values', () => {
  191. prepareRichRoot( root );
  192. let range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  193. let nodes = Array.from( range ).map( value => value.item );
  194. let lengths = Array.from( range ).map( value => value.length );
  195. let nodeNames = mapNodesToNames( nodes );
  196. expect( nodeNames ).to.deep.equal(
  197. [ 'T:st', 'E:p', 'T:lorem ipsum', 'E:p', 'T:foo', 'E:p', 'T:bar', 'E:div', 'E:h', 'T:se' ] );
  198. expect( lengths ).to.deep.equal( [ 2, 1, 11, 1, 3, 1, 3, 1, 1, 2 ] );
  199. } );
  200. } );
  201. describe( 'getWalker', () => {
  202. it( 'should be possible to iterate using this method', () => {
  203. prepareRichRoot( root );
  204. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  205. const items = [];
  206. const walker = range.getWalker();
  207. for ( let value of walker ) {
  208. items.push( value.item );
  209. }
  210. expect( mapNodesToNames( items ) ).to.deep.equal(
  211. [ 'T:st', 'E:h', 'E:p', 'T:lorem ipsum', 'E:p', 'E:div', 'E:p',
  212. 'T:foo', 'E:p', 'E:p', 'T:bar', 'E:p', 'E:div', 'E:h', 'T:se' ] );
  213. } );
  214. it( 'should return treewalker with given options', () => {
  215. prepareRichRoot( root );
  216. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  217. const walker = range.getWalker( { singleCharacters: true } );
  218. expect( walker ).to.be.instanceof( TreeWalker );
  219. expect( walker ).to.have.property( 'singleCharacters' ).that.is.true;
  220. expect( walker ).to.have.property( 'boundaries' ).that.equals( range );
  221. expect( walker ).to.have.property( 'shallow' ).that.is.false;
  222. } );
  223. } );
  224. describe( 'getItems', () => {
  225. it( 'should iterate over all items in the range', () => {
  226. prepareRichRoot( root );
  227. let range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  228. let items = Array.from( range.getItems() );
  229. let nodeNames = mapNodesToNames( items );
  230. expect( nodeNames ).to.deep.equal(
  231. [ 'T:st', 'E:p', 'T:lorem ipsum', 'E:p', 'T:foo', 'E:p', 'T:bar', 'E:div', 'E:h', 'T:se' ] );
  232. } );
  233. it( 'should iterate over all items in the range as single characters', () => {
  234. const a = new Text( 'a' );
  235. const b = new Text( 'b' );
  236. const x = new Text( 'x' );
  237. const y = new Text( 'y' );
  238. const e1 = new Element( 'e1' );
  239. const e2 = new Element( 'e2' );
  240. e1.insertChildren( 0, [ a, b ] );
  241. e2.insertChildren( 0, [ x, y ] );
  242. root.insertChildren( 0, [ e1, e2 ] );
  243. let range = new Range(
  244. new Position( root, [ 0, 1 ] ),
  245. new Position( root, [ 1, 1 ] )
  246. );
  247. let items = Array.from( range.getItems( { singleCharacters: true } ) );
  248. expect( items.length ).to.equal( 3 );
  249. expect( items[ 0 ].data ).to.equal( 'b' );
  250. expect( items[ 1 ] ).to.equal( e2 );
  251. expect( items[ 2 ].data ).to.equal( 'x' );
  252. } );
  253. } );
  254. describe( 'getPositions', () => {
  255. beforeEach( () => {
  256. prepareRichRoot( root );
  257. } );
  258. it( 'should iterate over all positions in this range', () => {
  259. let expectedPaths = [
  260. [ 1, 2 ], [ 1, 3 ],
  261. [ 2 ], [ 2, 0 ], [ 2, 3 ],
  262. [ 3 ], [ 3, 0 ], [ 3, 0, 0 ], [ 3, 0, 2 ]
  263. ];
  264. let range = new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 3, 0, 2 ] ) );
  265. let i = 0;
  266. for ( let position of range.getPositions() ) {
  267. expect( position.path ).to.deep.equal( expectedPaths[ i ] );
  268. i++;
  269. }
  270. expect( i ).to.equal( expectedPaths.length );
  271. } );
  272. it( 'should return single nodes iterating over all positions in this range', () => {
  273. let expectedPaths = [
  274. [ 1, 2 ], [ 1, 3 ],
  275. [ 2 ], [ 2, 0 ], [ 2, 1 ], [ 2, 2 ], [ 2, 3 ],
  276. [ 3 ], [ 3, 0 ], [ 3, 0, 0 ], [ 3, 0, 1 ], [ 3, 0, 2 ]
  277. ];
  278. let range = new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 3, 0, 2 ] ) );
  279. let i = 0;
  280. for ( let position of range.getPositions( { singleCharacters: true } ) ) {
  281. expect( position.path ).to.deep.equal( expectedPaths[ i ] );
  282. i++;
  283. }
  284. expect( i ).to.equal( expectedPaths.length );
  285. } );
  286. } );
  287. describe( 'containsPosition', () => {
  288. beforeEach( () => {
  289. range = new Range( new Position( root, [ 1 ] ), new Position( root, [ 3 ] ) );
  290. } );
  291. it( 'should return false if position is before range', () => {
  292. const position = new Position( root, [ 0, 4 ] );
  293. expect( range.containsPosition( position ) ).to.be.false;
  294. } );
  295. it( 'should return false if position is after range', () => {
  296. const position = new Position( root, [ 3, 0 ] );
  297. expect( range.containsPosition( position ) ).to.be.false;
  298. } );
  299. it( 'should return true if position is inside range', () => {
  300. const position = new Position( root, [ 2, 2 ] );
  301. expect( range.containsPosition( position ) ).to.be.true;
  302. } );
  303. } );
  304. describe( '_getTransformedByInsertion', () => {
  305. it( 'should return an array of Range objects', () => {
  306. const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  307. const transformed = range._getTransformedByInsertion( new Position( root, [ 2 ] ), 2 );
  308. expect( transformed ).to.be.instanceof( Array );
  309. expect( transformed[ 0 ] ).to.be.instanceof( Range );
  310. } );
  311. it( 'should update it\'s positions offsets if insertion is before range and they are affected', () => {
  312. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 4 ] ) );
  313. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 1 ] ), 2 );
  314. expect( transformed[ 0 ].start.offset ).to.equal( 4 );
  315. expect( transformed[ 0 ].end.offset ).to.equal( 6 );
  316. } );
  317. it( 'should update it\'s positions paths if insertion is before range and they are affected', () => {
  318. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  319. const transformed = range._getTransformedByInsertion( new Position( root, [ 0 ] ), 2 );
  320. expect( transformed[ 0 ].start.path[ 0 ] ).to.equal( 5 );
  321. expect( transformed[ 0 ].end.path[ 0 ] ).to.equal( 6 );
  322. } );
  323. it( 'should expand range if insertion was in the middle of range', () => {
  324. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  325. const transformed = range._getTransformedByInsertion( new Position( root, [ 5, 0 ] ), 4 );
  326. expect( transformed.length ).to.equal( 1 );
  327. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  328. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 8 ] );
  329. } );
  330. it( 'should return array with two ranges if insertion was in the middle of range and spread flag was set', () => {
  331. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  332. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 1, 6 ] ), 4, true );
  333. expect( transformed.length ).to.equal( 2 );
  334. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  335. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 1, 6 ] );
  336. expect( transformed[ 1 ].start.path ).to.deep.equal( [ 4, 1, 10 ] );
  337. expect( transformed[ 1 ].end.path ).to.deep.equal( [ 5, 4 ] );
  338. } );
  339. it( 'should not expand range if insertion is equal to start boundary of the range', () => {
  340. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  341. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 2 ] ), 3 );
  342. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  343. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  344. } );
  345. it( 'should expand range if insertion is equal to start boundary of the range and sticky flag is set', () => {
  346. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  347. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 2 ] ), 3, false, true );
  348. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  349. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  350. } );
  351. it( 'should not update positions if insertion is before range (but not equal to the start boundary)', () => {
  352. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  353. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 1 ] ), 3 );
  354. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  355. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  356. } );
  357. it( 'should not expand range if insertion is equal to end boundary of the range', () => {
  358. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  359. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 4 ] ), 3 );
  360. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  361. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 4 ] );
  362. } );
  363. it( 'should expand range if insertion is equal to end boundary of the range and sticky flag is set', () => {
  364. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  365. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 4 ] ), 3, false, true );
  366. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  367. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 7 ] );
  368. } );
  369. it( 'should not update positions if insertion is after range (but not equal to the end boundary)', () => {
  370. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  371. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 5 ] ), 3 );
  372. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  373. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 4 ] );
  374. } );
  375. it( 'should move after inserted nodes if the range is collapsed and isSticky is true', () => {
  376. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 2 ] ) );
  377. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 2 ] ), 3, false, true );
  378. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  379. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 5 ] );
  380. } );
  381. } );
  382. describe( '_getTransformedByMove', () => {
  383. it( 'should return an array of Range objects', () => {
  384. const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  385. const transformed = range._getTransformedByMove( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ), 2 );
  386. expect( transformed ).to.be.instanceof( Array );
  387. expect( transformed[ 0 ] ).to.be.instanceof( Range );
  388. } );
  389. it( 'should update it\'s positions offsets if target is before range and they are affected', () => {
  390. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 4 ] ) );
  391. const transformed = range._getTransformedByMove( new Position( root, [ 8, 1 ] ), new Position( root, [ 3, 1 ] ), 2 );
  392. expect( transformed[ 0 ].start.offset ).to.equal( 4 );
  393. expect( transformed[ 0 ].end.offset ).to.equal( 6 );
  394. } );
  395. it( 'should update it\'s positions paths if target is before range and they are affected', () => {
  396. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  397. const transformed = range._getTransformedByMove( new Position( root, [ 8 ] ), new Position( root, [ 0 ] ), 2 );
  398. expect( transformed[ 0 ].start.path[ 0 ] ).to.equal( 5 );
  399. expect( transformed[ 0 ].end.path[ 0 ] ).to.equal( 6 );
  400. } );
  401. it( 'should expand range if target was in the middle of range', () => {
  402. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  403. const transformed = range._getTransformedByMove( new Position( root, [ 8 ] ), new Position( root, [ 5, 0 ] ), 4 );
  404. expect( transformed.length ).to.equal( 1 );
  405. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  406. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 8 ] );
  407. } );
  408. it( 'should not expand range if insertion is equal to start boundary of the range', () => {
  409. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  410. const transformed = range._getTransformedByMove( new Position( root, [ 8, 2 ] ), new Position( root, [ 3, 2 ] ), 3 );
  411. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  412. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  413. } );
  414. it( 'should not expand range if insertion is equal to end boundary of the range', () => {
  415. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  416. const transformed = range._getTransformedByMove( new Position( root, [ 8, 4 ] ), new Position( root, [ 4, 4 ] ), 3 );
  417. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  418. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 4 ] );
  419. } );
  420. it( 'should update it\'s positions offsets if source is before range and they are affected', () => {
  421. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 4 ] ) );
  422. const transformed = range._getTransformedByMove( new Position( root, [ 3, 0 ] ), new Position( root, [ 8, 1 ] ), 2 );
  423. expect( transformed[ 0 ].start.offset ).to.equal( 0 );
  424. expect( transformed[ 0 ].end.offset ).to.equal( 2 );
  425. } );
  426. it( 'should update it\'s positions paths if source is before range and they are affected', () => {
  427. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  428. const transformed = range._getTransformedByMove( new Position( root, [ 0 ] ), new Position( root, [ 8 ] ), 2 );
  429. expect( transformed[ 0 ].start.path[ 0 ] ).to.equal( 1 );
  430. expect( transformed[ 0 ].end.path[ 0 ] ).to.equal( 2 );
  431. } );
  432. it( 'should shrink range if source was in the middle of range', () => {
  433. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  434. const transformed = range._getTransformedByMove( new Position( root, [ 5, 0 ] ), new Position( root, [ 8 ] ), 4 );
  435. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  436. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 0 ] );
  437. } );
  438. it( 'should shrink range if source contained range start position', () => {
  439. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  440. const transformed = range._getTransformedByMove( new Position( root, [ 3, 1 ] ), new Position( root, [ 8 ] ), 2 );
  441. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 1 ] );
  442. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 4 ] );
  443. } );
  444. it( 'should shrink range if source contained range end position', () => {
  445. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  446. const transformed = range._getTransformedByMove( new Position( root, [ 5, 3 ] ), new Position( root, [ 8 ] ), 2 );
  447. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  448. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 3 ] );
  449. } );
  450. it( 'should move range if it was contained in moved range', () => {
  451. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 7 ] ) );
  452. const transformed = range._getTransformedByMove( new Position( root, [ 3 ] ), new Position( root, [ 6 ] ), 2 );
  453. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 4, 2 ] );
  454. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 7 ] );
  455. } );
  456. it( 'should stick to moved range, if the transformed range is collapsed #1', () => {
  457. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 2 ] ) );
  458. const transformed = range._getTransformedByMove( new Position( root, [ 3, 0 ] ), new Position( root, [ 6 ] ), 2 );
  459. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 8 ] );
  460. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 8 ] );
  461. } );
  462. it( 'should stick to moved range, if the transformed range is collapsed #2', () => {
  463. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 2 ] ) );
  464. const transformed = range._getTransformedByMove( new Position( root, [ 3, 2 ] ), new Position( root, [ 6 ] ), 2 );
  465. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 6 ] );
  466. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 6 ] );
  467. } );
  468. } );
  469. describe( 'getDifference', () => {
  470. let range;
  471. beforeEach( () => {
  472. range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  473. } );
  474. it( 'should return an array of Range objects', () => {
  475. const otherRange = new Range( new Position( root, [ 6 ] ), new Position( root, [ 7 ] ) );
  476. const diff = range.getDifference( otherRange );
  477. expect( diff ).to.be.instanceof( Array );
  478. expect( diff[ 0 ] ).to.be.instanceof( Range );
  479. } );
  480. it( 'should return original range if other range does not intersect with it', () => {
  481. const otherRange = new Range( new Position( root, [ 6 ] ), new Position( root, [ 7 ] ) );
  482. const diff = range.getDifference( otherRange );
  483. expect( diff[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  484. expect( diff[ 0 ].end.path ).to.deep.equal( [ 5, 4 ] );
  485. } );
  486. it( 'should return shrunken range if other range intersects with it', () => {
  487. const otherRange = new Range( new Position( root, [ 4, 1 ] ), new Position( root, [ 7 ] ) );
  488. const diff = range.getDifference( otherRange );
  489. expect( diff[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  490. expect( diff[ 0 ].end.path ).to.deep.equal( [ 4, 1 ] );
  491. } );
  492. it( 'should return an empty array if other range contains or is same as the original range', () => {
  493. const otherRange = new Range( new Position( root, [ 2 ] ), new Position( root, [ 6 ] ) );
  494. const diff = range.getDifference( otherRange );
  495. expect( diff.length ).to.equal( 0 );
  496. } );
  497. it( 'should two ranges if other range is contained by the original range', () => {
  498. const otherRange = new Range( new Position( root, [ 3, 7 ] ), new Position( root, [ 4, 1 ] ) );
  499. const diff = range.getDifference( otherRange );
  500. expect( diff.length ).to.equal( 2 );
  501. expect( diff[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  502. expect( diff[ 0 ].end.path ).to.deep.equal( [ 3, 7 ] );
  503. expect( diff[ 1 ].start.path ).to.deep.equal( [ 4, 1 ] );
  504. expect( diff[ 1 ].end.path ).to.deep.equal( [ 5, 4 ] );
  505. } );
  506. } );
  507. describe( 'getIntersection', () => {
  508. let range;
  509. beforeEach( () => {
  510. range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  511. } );
  512. it( 'should return null if ranges do not intersect', () => {
  513. const otherRange = new Range( new Position( root, [ 5, 4 ] ), new Position( root, [ 7 ] ) );
  514. const common = range.getIntersection( otherRange );
  515. expect( common ).to.be.null;
  516. } );
  517. it( 'should return a range equal to the common part of ranges - original range contains the other range', () => {
  518. const otherRange = new Range( new Position( root, [ 4 ] ), new Position( root, [ 5 ] ) );
  519. const common = range.getIntersection( otherRange );
  520. expect( common.isEqual( otherRange ) ).to.be.true;
  521. } );
  522. it( 'should return a range equal to the common part of ranges - original range is contained by the other range', () => {
  523. const otherRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6 ] ) );
  524. const common = range.getIntersection( otherRange );
  525. expect( common.isEqual( range ) ).to.be.true;
  526. } );
  527. it( 'should return a range equal to the common part of ranges - original range intersects with the other range', () => {
  528. const otherRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 4, 7 ] ) );
  529. const common = range.getIntersection( otherRange );
  530. expect( common.start.path ).to.deep.equal( [ 3, 2 ] );
  531. expect( common.end.path ).to.deep.equal( [ 4, 7 ] );
  532. } );
  533. } );
  534. describe( 'getTransformedByDelta', () => {
  535. beforeEach( () => {
  536. root.appendChildren( new Text( 'foobar' ) );
  537. range = Range.createFromParentsAndOffsets( root, 2, root, 5 );
  538. } );
  539. function expectRange( range, startOffset, endOffset ) {
  540. expect( range.start.offset ).to.equal( startOffset );
  541. expect( range.end.offset ).to.equal( endOffset );
  542. }
  543. describe( 'by AttributeDelta', () => {
  544. it( 'nothing should change', () => {
  545. const delta = getAttributeDelta( Range.createFromParentsAndOffsets( root, 1, root, 6 ), 'key', true, false, 1 );
  546. const transformed = range.getTransformedByDelta( delta );
  547. expectRange( transformed[ 0 ], 2, 5 );
  548. } );
  549. } );
  550. describe( 'by InsertDelta', () => {
  551. it( 'insert before range', () => {
  552. const delta = getInsertDelta( new Position( root, [ 1 ] ), new Text( 'abc' ), 1 );
  553. const transformed = range.getTransformedByDelta( delta );
  554. expectRange( transformed[ 0 ], 5, 8 );
  555. } );
  556. it( 'insert inside range', () => {
  557. const delta = getInsertDelta( new Position( root, [ 3 ] ), new Text( 'abc' ), 1 );
  558. const transformed = range.getTransformedByDelta( delta );
  559. expectRange( transformed[ 0 ], 2, 8 );
  560. } );
  561. it( 'insert after range', () => {
  562. const delta = getInsertDelta( new Position( root, [ 6 ] ), new Text( 'abc' ), 1 );
  563. const transformed = range.getTransformedByDelta( delta );
  564. expectRange( transformed[ 0 ], 2, 5 );
  565. } );
  566. } );
  567. describe( 'by MoveDelta', () => {
  568. it( 'move before range', () => {
  569. const start = new Position( root, [ 0 ] );
  570. const end = new Position( otherRoot, [ 0 ] );
  571. const delta = getMoveDelta( start, 2, end, 1 );
  572. const transformed = range.getTransformedByDelta( delta );
  573. expectRange( transformed[ 0 ], 0, 3 );
  574. } );
  575. it( 'move intersecting with range (and targeting before range)', () => {
  576. const start = new Position( root, [ 4 ] );
  577. const end = new Position( root, [ 0 ] );
  578. const delta = getMoveDelta( start, 2, end, 1 );
  579. const transformed = range.getTransformedByDelta( delta );
  580. expectRange( transformed[ 0 ], 4, 6 );
  581. expectRange( transformed[ 1 ], 0, 1 );
  582. } );
  583. it( 'move inside the range', () => {
  584. range.end.offset = 6;
  585. const start = new Position( root, [ 3 ] );
  586. const end = new Position( root, [ 5 ] );
  587. const delta = getMoveDelta( start, 1, end, 1 );
  588. const transformed = range.getTransformedByDelta( delta );
  589. expectRange( transformed[ 0 ], 2, 4 );
  590. expectRange( transformed[ 1 ], 5, 6 );
  591. expectRange( transformed[ 2 ], 4, 5 );
  592. } );
  593. } );
  594. describe( 'by RemoveDelta', () => {
  595. it( 'remove before range', () => {
  596. const start = new Position( root, [ 0 ] );
  597. const delta = getRemoveDelta( start, 2, 1 );
  598. const transformed = range.getTransformedByDelta( delta );
  599. expectRange( transformed[ 0 ], 0, 3 );
  600. } );
  601. it( 'remove intersecting with range', () => {
  602. const start = new Position( root, [ 4 ] );
  603. const delta = getRemoveDelta( start, 2, 1 );
  604. const transformed = range.getTransformedByDelta( delta );
  605. expectRange( transformed[ 0 ], 2, 4 );
  606. expect( transformed[ 1 ].root ).to.equal( doc.graveyard );
  607. expect( transformed[ 1 ].end.offset - transformed[ 1 ].start.offset ).to.equal( 1 );
  608. } );
  609. it( 'remove inside the range', () => {
  610. const start = new Position( root, [ 3 ] );
  611. const delta = getRemoveDelta( start, 2, 1 );
  612. const transformed = range.getTransformedByDelta( delta );
  613. expectRange( transformed[ 0 ], 2, 3 );
  614. expect( transformed[ 1 ].root ).to.equal( doc.graveyard );
  615. expect( transformed[ 1 ].end.offset - transformed[ 1 ].start.offset ).to.equal( 2 );
  616. } );
  617. } );
  618. describe( 'by RenameDelta', () => {
  619. it( 'nothing should change', () => {
  620. const delta = getRenameDelta( new Position( root, [ 3 ] ), 'old', 'new', 1 );
  621. const transformed = range.getTransformedByDelta( delta );
  622. expectRange( transformed[ 0 ], 2, 5 );
  623. } );
  624. } );
  625. describe( 'by SplitDelta', () => {
  626. it( 'split inside range', () => {
  627. root.removeChildren( root.childCount );
  628. root.appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) );
  629. range.start = new Position( root, [ 0, 2 ] );
  630. range.end = new Position( root, [ 0, 4 ] );
  631. const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 );
  632. const transformed = range.getTransformedByDelta( delta );
  633. expect( transformed.length ).to.equal( 1 );
  634. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 2 ] );
  635. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  636. } );
  637. } );
  638. } );
  639. describe( 'getTransformedByDeltas', () => {
  640. beforeEach( () => {
  641. root.appendChildren( new Text( 'foobar' ) );
  642. range = Range.createFromParentsAndOffsets( root, 2, root, 5 );
  643. } );
  644. function expectRange( range, startOffset, endOffset ) {
  645. expect( range.start.offset ).to.equal( startOffset );
  646. expect( range.end.offset ).to.equal( endOffset );
  647. }
  648. it( 'should return a range transformed by multiple deltas', () => {
  649. const transformed = range.getTransformedByDeltas( [
  650. getInsertDelta( new Position( root, [ 1 ] ), new Text( 'abc' ), 1 ), // Range becomes 5..8.
  651. getInsertDelta( new Position( root, [ 6 ] ), new Text( 'xx' ), 2 ) // Range becomes 5..10.
  652. ] );
  653. expectRange( transformed[ 0 ], 5, 10 );
  654. } );
  655. it( 'should correctly handle breaking transformed range and all range "pieces"', () => {
  656. const transformed = range.getTransformedByDeltas( [
  657. getInsertDelta( new Position( root, [ 3 ] ), new Text( 'abc' ), 1 ), // Range becomes 2..8.
  658. getMoveDelta( new Position( root, [ 4 ] ), 3, new Position( root, [ 9 ] ), 2 ), // Range becomes 2..5 and 6..9.
  659. getInsertDelta( new Position( root, [ 0 ] ), new Text( 'x' ), 3 ), // Range becomes 3..6 and 7..10.
  660. getMoveDelta( new Position( root, [ 9 ] ), 1, new Position( root, [ 4 ] ), 4 ), // Range becomes 3..7 and 8..10.
  661. getMoveDelta( new Position( root, [ 6 ] ), 1, new Position( root, [ 1 ] ), 5 ) // Range becomes 1..2, 4..7 and 8..10.
  662. ] );
  663. expect( transformed.length ).to.equal( 3 );
  664. expectRange( transformed[ 0 ], 4, 7 );
  665. expectRange( transformed[ 1 ], 1, 2 );
  666. expectRange( transformed[ 2 ], 8, 10 );
  667. } );
  668. it( 'should return range equal to original range for empty delta set', () => {
  669. const transformed = range.getTransformedByDeltas( [] );
  670. expectRange( transformed[ 0 ], 2, 5 );
  671. } );
  672. } );
  673. describe( 'getMinimalFlatRanges', () => {
  674. beforeEach( () => {
  675. prepareRichRoot( root );
  676. } );
  677. it( 'should return empty array if range is collapsed', () => {
  678. let range = new Range( new Position( root, [ 1, 3 ] ), new Position( root, [ 1, 3 ] ) );
  679. let flat = range.getMinimalFlatRanges();
  680. expect( flat.length ).to.equal( 0 );
  681. } );
  682. it( 'should return empty array if range does not contain any node', () => {
  683. let range = new Range( new Position( root, [ 1, 3 ] ), new Position( root, [ 2, 0 ] ) );
  684. let flat = range.getMinimalFlatRanges();
  685. expect( flat.length ).to.equal( 0 );
  686. } );
  687. it( 'should return a minimal set of flat ranges that covers the range (start and end in different sub-trees)', () => {
  688. let range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  689. let flat = range.getMinimalFlatRanges();
  690. expect( flat.length ).to.equal( 4 );
  691. expect( flat[ 0 ].start.path ).to.deep.equal( [ 0, 0, 3 ] );
  692. expect( flat[ 0 ].end.path ).to.deep.equal( [ 0, 0, 5 ] );
  693. expect( flat[ 1 ].start.path ).to.deep.equal( [ 0, 1 ] );
  694. expect( flat[ 1 ].end.path ).to.deep.equal( [ 0, 2 ] );
  695. expect( flat[ 2 ].start.path ).to.deep.equal( [ 1 ] );
  696. expect( flat[ 2 ].end.path ).to.deep.equal( [ 3 ] );
  697. expect( flat[ 3 ].start.path ).to.deep.equal( [ 3, 0, 0 ] );
  698. expect( flat[ 3 ].end.path ).to.deep.equal( [ 3, 0, 2 ] );
  699. } );
  700. it( 'should return a minimal set of flat ranges that covers the range (start.path is prefix of end.path)', () => {
  701. let range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 0, 1, 4 ] ) );
  702. let flat = range.getMinimalFlatRanges();
  703. expect( flat.length ).to.equal( 2 );
  704. expect( flat[ 0 ].start.path ).to.deep.equal( [ 0, 0 ] );
  705. expect( flat[ 0 ].end.path ).to.deep.equal( [ 0, 1 ] );
  706. expect( flat[ 1 ].start.path ).to.deep.equal( [ 0, 1, 0 ] );
  707. expect( flat[ 1 ].end.path ).to.deep.equal( [ 0, 1, 4 ] );
  708. } );
  709. } );
  710. describe( 'isFlat', () => {
  711. beforeEach( () => {
  712. prepareRichRoot( root );
  713. } );
  714. it( 'should be true if start and end position are in the same parent', () => {
  715. let range = new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 2 ] ) );
  716. expect( range.isFlat ).to.be.true;
  717. } );
  718. it( 'should be false if start and end position are in different parents', () => {
  719. let range = new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 3, 0, 1 ] ) );
  720. expect( range.isFlat ).to.be.false;
  721. } );
  722. } );
  723. describe( 'fromJSON', () => {
  724. it( 'should create range from given JSON object', () => {
  725. const serialized = jsonParseStringify( range );
  726. const deserialized = Range.fromJSON( serialized, doc );
  727. expect( deserialized ).to.deep.equal( range );
  728. } );
  729. } );
  730. function mapNodesToNames( nodes ) {
  731. return nodes.map( ( node ) => {
  732. return ( node instanceof Element ) ? 'E:' + node.name : 'T:' + node.data;
  733. } );
  734. }
  735. function prepareRichRoot() {
  736. root.insertChildren( 0, [
  737. new Element( 'div', [], [
  738. new Element( 'h', [], new Text( 'first' ) ),
  739. new Element( 'p', [], new Text( 'lorem ipsum' ) )
  740. ] ),
  741. new Element( 'p', [], new Text( 'foo' ) ),
  742. new Element( 'p', [], new Text( 'bar' ) ),
  743. new Element( 'div', [], [
  744. new Element( 'h', [], new Text( 'second' ) ),
  745. new Element( 'p', [], new Text( 'lorem' ) )
  746. ] )
  747. ] );
  748. }
  749. } );