8
0

range.js 36 KB

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