range.js 52 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354
  1. /**
  2. * @license Copyright (c) 2003-2018, 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 Model from '../../src/model/model';
  10. import TreeWalker from '../../src/model/treewalker';
  11. import MergeDelta from '../../src/model/delta/mergedelta';
  12. import MoveOperation from '../../src/model/operation/moveoperation';
  13. import RemoveOperation from '../../src/model/operation/removeoperation';
  14. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  15. import { jsonParseStringify } from '../../tests/model/_utils/utils';
  16. import {
  17. getAttributeDelta,
  18. getInsertDelta,
  19. getMoveDelta,
  20. getRemoveDelta,
  21. getRenameDelta,
  22. getSplitDelta,
  23. getMergeDelta,
  24. getWrapDelta,
  25. getUnwrapDelta
  26. } from '../../tests/model/delta/transform/_utils/utils';
  27. describe( 'Range', () => {
  28. let doc, range, start, end, root, otherRoot;
  29. beforeEach( () => {
  30. const model = new Model();
  31. doc = model.document;
  32. root = doc.createRoot();
  33. otherRoot = doc.createRoot( '$root', 'otherRoot' );
  34. start = new Position( root, [ 1 ] );
  35. end = new Position( root, [ 2 ] );
  36. range = new Range( start, end );
  37. } );
  38. describe( 'constructor()', () => {
  39. it( 'should create a range with given positions', () => {
  40. expect( range.start.isEqual( start ) ).to.be.true;
  41. expect( range.end.isEqual( end ) ).to.be.true;
  42. } );
  43. it( 'should create collapsed range', () => {
  44. const collapsed = new Range( start );
  45. expect( collapsed.start.isEqual( start ) ).to.be.true;
  46. expect( collapsed.isCollapsed ).to.be.true;
  47. } );
  48. } );
  49. describe( 'root', () => {
  50. it( 'should be equal to start position root', () => {
  51. expect( range.root ).to.equal( start.root );
  52. } );
  53. } );
  54. describe( 'isCollapsed', () => {
  55. it( 'should be true if range start and end positions are equal', () => {
  56. const collapsedRange = new Range( start, start );
  57. expect( collapsedRange.isCollapsed ).to.be.true;
  58. } );
  59. it( 'should be false if range start and end positions are not equal', () => {
  60. expect( range.isCollapsed ).to.be.false;
  61. } );
  62. } );
  63. describe( 'isEqual()', () => {
  64. it( 'should return true if the ranges are the same', () => {
  65. const sameStart = Position.createFromPosition( start );
  66. const sameEnd = Position.createFromPosition( end );
  67. const sameRange = new Range( sameStart, sameEnd );
  68. expect( range.isEqual( sameRange ) ).to.be.true;
  69. } );
  70. it( 'should return false if the start position is different', () => {
  71. const range = new Range( start, end );
  72. const diffStart = new Position( root, [ 0 ] );
  73. const sameEnd = Position.createFromPosition( end );
  74. const diffRange = new Range( diffStart, sameEnd );
  75. expect( range.isEqual( diffRange ) ).to.be.false;
  76. } );
  77. it( 'should return false if the end position is different', () => {
  78. const sameStart = new Position( root, [ 0 ] );
  79. const diffEnd = new Position( root, [ 0 ] );
  80. const diffRange = new Range( sameStart, diffEnd );
  81. expect( range.isEqual( diffRange ) ).to.be.false;
  82. } );
  83. it( 'should return false if ranges are in different roots', () => {
  84. const otherRootStart = new Position( otherRoot, start.path.slice() );
  85. const otherRootEnd = new Position( otherRoot, end.path.slice() );
  86. const otherRootRange = new Range( otherRootStart, otherRootEnd );
  87. expect( range.isEqual( otherRootRange ) ).to.be.false;
  88. } );
  89. } );
  90. describe( 'isIntersecting()', () => {
  91. it( 'should return true if given range is equal', () => {
  92. const otherRange = Range.createFromRange( range );
  93. expect( range.isIntersecting( otherRange ) ).to.be.true;
  94. } );
  95. it( 'should return true if given range contains this range', () => {
  96. const otherRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 3 ] ) );
  97. expect( range.isIntersecting( otherRange ) ).to.be.true;
  98. } );
  99. it( 'should return true if given range ends in this range', () => {
  100. const otherRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 4 ] ) );
  101. expect( range.isIntersecting( otherRange ) ).to.be.true;
  102. } );
  103. it( 'should return true if given range starts in this range', () => {
  104. const otherRange = new Range( new Position( root, [ 1, 4 ] ), new Position( root, [ 3 ] ) );
  105. expect( range.isIntersecting( otherRange ) ).to.be.true;
  106. } );
  107. it( 'should return false if given range is fully before this range', () => {
  108. const otherRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  109. expect( range.isIntersecting( otherRange ) ).to.be.false;
  110. } );
  111. it( 'should return false if given range is fully after this range', () => {
  112. const otherRange = new Range( new Position( root, [ 2 ] ), new Position( root, [ 2, 0 ] ) );
  113. expect( range.isIntersecting( otherRange ) ).to.be.false;
  114. } );
  115. it( 'should return false if ranges are in different roots', () => {
  116. const otherRange = new Range( new Position( otherRoot, [ 0 ] ), new Position( otherRoot, [ 1, 4 ] ) );
  117. expect( range.isIntersecting( otherRange ) ).to.be.false;
  118. } );
  119. } );
  120. describe( 'static constructors', () => {
  121. let p;
  122. // root
  123. // |- p
  124. // |- foz
  125. beforeEach( () => {
  126. p = new Element( 'p', [], new Text( 'foz' ) );
  127. root.insertChildren( 0, [ p ] );
  128. } );
  129. describe( 'createIn()', () => {
  130. it( 'should return range', () => {
  131. const range = Range.createIn( p );
  132. expect( range.start.path ).to.deep.equal( [ 0, 0 ] );
  133. expect( range.end.path ).to.deep.equal( [ 0, 3 ] );
  134. } );
  135. } );
  136. describe( 'createOn()', () => {
  137. it( 'should return range', () => {
  138. const range = Range.createOn( p );
  139. expect( range.start.path ).to.deep.equal( [ 0 ] );
  140. expect( range.end.path ).to.deep.equal( [ 1 ] );
  141. } );
  142. } );
  143. describe( 'createCollapsedAt()', () => {
  144. it( 'should return new collapsed range at the given item position', () => {
  145. const item = new Element( 'p', null, new Text( 'foo' ) );
  146. const range = Range.createCollapsedAt( item );
  147. expect( range.start.parent ).to.equal( item );
  148. expect( range.start.offset ).to.equal( 0 );
  149. expect( range.isCollapsed ).to.be.true;
  150. } );
  151. it( 'should return new collapse range at the given item position and offset', () => {
  152. const item = new Element( 'p', null, new Text( 'foo' ) );
  153. const range = Range.createCollapsedAt( item, 1 );
  154. expect( range.start.parent ).to.equal( item );
  155. expect( range.start.offset ).to.equal( 1 );
  156. expect( range.isCollapsed ).to.be.true;
  157. } );
  158. } );
  159. describe( 'createFromParentsAndOffsets()', () => {
  160. it( 'should return range', () => {
  161. const range = Range.createFromParentsAndOffsets( root, 0, p, 2 );
  162. expect( range.start.path ).to.deep.equal( [ 0 ] );
  163. expect( range.end.path ).to.deep.equal( [ 0, 2 ] );
  164. } );
  165. } );
  166. describe( 'createFromPositionAndShift()', () => {
  167. it( 'should make range from start position and offset', () => {
  168. const position = new Position( root, [ 1, 2, 3 ] );
  169. const range = Range.createFromPositionAndShift( position, 4 );
  170. expect( range ).to.be.instanceof( Range );
  171. expect( range.start.isEqual( position ) ).to.be.true;
  172. expect( range.end.root ).to.equal( range.start.root );
  173. expect( range.end.path ).to.deep.equal( [ 1, 2, 7 ] );
  174. } );
  175. } );
  176. describe( 'createFromRange()', () => {
  177. it( 'should create a new instance of Range that is equal to passed range', () => {
  178. const clone = Range.createFromRange( range );
  179. expect( clone ).not.to.be.equal( range ); // clone is not pointing to the same object as position
  180. expect( clone.isEqual( range ) ).to.be.true; // but they are equal in the position-sense
  181. } );
  182. } );
  183. describe( 'createFromRanges()', () => {
  184. function makeRanges( root, ...points ) {
  185. const ranges = [];
  186. for ( let i = 0; i < points.length; i += 2 ) {
  187. ranges.push( Range.createFromParentsAndOffsets( root, points[ i ], root, points[ i + 1 ] ) );
  188. }
  189. return ranges;
  190. }
  191. beforeEach( () => {
  192. root.appendChildren( new Text( 'abcdefghijklmnopqrtuvwxyz' ) );
  193. } );
  194. it( 'should throw if empty array is passed', () => {
  195. expect( () => {
  196. Range.createFromRanges( [] );
  197. } ).to.throw( CKEditorError, /^range-create-from-ranges-empty-array/ );
  198. } );
  199. it( 'should return a copy of the range if only one range was passed', () => {
  200. const original = Range.createFromParentsAndOffsets( root, 2, root, 3 );
  201. const range = Range.createFromRanges( [ original ] );
  202. expect( range.isEqual( original ) ).to.be.true;
  203. expect( range ).not.to.be.equal( original );
  204. } );
  205. it( 'should combine ranges with reference range', () => {
  206. const range = Range.createFromRanges( makeRanges( root, 3, 7, 2, 3, 7, 9, 11, 14, 0, 1 ) );
  207. expect( range.start.offset ).to.equal( 2 );
  208. expect( range.end.offset ).to.equal( 9 );
  209. } );
  210. } );
  211. } );
  212. describe( 'iterator', () => {
  213. it( 'should iterate over the range returning tree walker values', () => {
  214. prepareRichRoot( root );
  215. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  216. const nodes = Array.from( range ).map( value => value.item );
  217. const lengths = Array.from( range ).map( value => value.length );
  218. const nodeNames = mapNodesToNames( nodes );
  219. expect( nodeNames ).to.deep.equal(
  220. [ 'T:st', 'E:p', 'T:lorem ipsum', 'E:p', 'T:foo', 'E:p', 'T:bar', 'E:div', 'E:h', 'T:se' ] );
  221. expect( lengths ).to.deep.equal( [ 2, 1, 11, 1, 3, 1, 3, 1, 1, 2 ] );
  222. } );
  223. } );
  224. describe( 'getWalker()', () => {
  225. it( 'should be possible to iterate using this method', () => {
  226. prepareRichRoot( root );
  227. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  228. const items = [];
  229. const walker = range.getWalker();
  230. for ( const value of walker ) {
  231. items.push( value.item );
  232. }
  233. expect( mapNodesToNames( items ) ).to.deep.equal(
  234. [ 'T:st', 'E:h', 'E:p', 'T:lorem ipsum', 'E:p', 'E:div', 'E:p',
  235. 'T:foo', 'E:p', 'E:p', 'T:bar', 'E:p', 'E:div', 'E:h', 'T:se' ] );
  236. } );
  237. it( 'should return treewalker with given options', () => {
  238. prepareRichRoot( root );
  239. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  240. const walker = range.getWalker( { singleCharacters: true } );
  241. expect( walker ).to.be.instanceof( TreeWalker );
  242. expect( walker ).to.have.property( 'singleCharacters' ).that.is.true;
  243. expect( walker ).to.have.property( 'boundaries' ).that.equals( range );
  244. expect( walker ).to.have.property( 'shallow' ).that.is.false;
  245. } );
  246. } );
  247. describe( 'getItems()', () => {
  248. it( 'should iterate over all items in the range', () => {
  249. prepareRichRoot( root );
  250. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  251. const items = Array.from( range.getItems() );
  252. const nodeNames = mapNodesToNames( items );
  253. expect( nodeNames ).to.deep.equal(
  254. [ 'T:st', 'E:p', 'T:lorem ipsum', 'E:p', 'T:foo', 'E:p', 'T:bar', 'E:div', 'E:h', 'T:se' ] );
  255. } );
  256. it( 'should iterate over all items in the range as single characters', () => {
  257. const a = new Text( 'a' );
  258. const b = new Text( 'b' );
  259. const x = new Text( 'x' );
  260. const y = new Text( 'y' );
  261. const e1 = new Element( 'e1' );
  262. const e2 = new Element( 'e2' );
  263. e1.insertChildren( 0, [ a, b ] );
  264. e2.insertChildren( 0, [ x, y ] );
  265. root.insertChildren( 0, [ e1, e2 ] );
  266. const range = new Range(
  267. new Position( root, [ 0, 1 ] ),
  268. new Position( root, [ 1, 1 ] )
  269. );
  270. const items = Array.from( range.getItems( { singleCharacters: true } ) );
  271. expect( items.length ).to.equal( 3 );
  272. expect( items[ 0 ].data ).to.equal( 'b' );
  273. expect( items[ 1 ] ).to.equal( e2 );
  274. expect( items[ 2 ].data ).to.equal( 'x' );
  275. } );
  276. } );
  277. describe( 'getPositions()', () => {
  278. beforeEach( () => {
  279. prepareRichRoot( root );
  280. } );
  281. it( 'should iterate over all positions in this range', () => {
  282. const expectedPaths = [
  283. [ 1, 2 ], [ 1, 3 ],
  284. [ 2 ], [ 2, 0 ], [ 2, 3 ],
  285. [ 3 ], [ 3, 0 ], [ 3, 0, 0 ], [ 3, 0, 2 ]
  286. ];
  287. const range = new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 3, 0, 2 ] ) );
  288. let i = 0;
  289. for ( const position of range.getPositions() ) {
  290. expect( position.path ).to.deep.equal( expectedPaths[ i ] );
  291. i++;
  292. }
  293. expect( i ).to.equal( expectedPaths.length );
  294. } );
  295. it( 'should return single nodes iterating over all positions in this range', () => {
  296. const expectedPaths = [
  297. [ 1, 2 ], [ 1, 3 ],
  298. [ 2 ], [ 2, 0 ], [ 2, 1 ], [ 2, 2 ], [ 2, 3 ],
  299. [ 3 ], [ 3, 0 ], [ 3, 0, 0 ], [ 3, 0, 1 ], [ 3, 0, 2 ]
  300. ];
  301. const range = new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 3, 0, 2 ] ) );
  302. let i = 0;
  303. for ( const position of range.getPositions( { singleCharacters: true } ) ) {
  304. expect( position.path ).to.deep.equal( expectedPaths[ i ] );
  305. i++;
  306. }
  307. expect( i ).to.equal( expectedPaths.length );
  308. } );
  309. } );
  310. describe( 'containsPosition()', () => {
  311. beforeEach( () => {
  312. range = new Range( new Position( root, [ 1 ] ), new Position( root, [ 3 ] ) );
  313. } );
  314. it( 'should return false if position is before range', () => {
  315. const position = new Position( root, [ 0, 4 ] );
  316. expect( range.containsPosition( position ) ).to.be.false;
  317. } );
  318. it( 'should return false if position is after range', () => {
  319. const position = new Position( root, [ 3, 0 ] );
  320. expect( range.containsPosition( position ) ).to.be.false;
  321. } );
  322. it( 'should return true if position is inside range', () => {
  323. const position = new Position( root, [ 2, 2 ] );
  324. expect( range.containsPosition( position ) ).to.be.true;
  325. } );
  326. } );
  327. describe( 'containsRange()', () => {
  328. beforeEach( () => {
  329. range = new Range( new Position( root, [ 1 ] ), new Position( root, [ 3 ] ) );
  330. } );
  331. it( 'should return true if ranges are equal and check is not strict', () => {
  332. const otherRange = Range.createFromRange( range );
  333. expect( range.containsRange( otherRange, true ) ).to.be.true;
  334. } );
  335. it( 'should return true if ranges start at the same position and check is not strict', () => {
  336. const otherRange = new Range( range.start, new Position( root, [ 2 ] ) );
  337. expect( range.containsRange( otherRange, true ) ).to.be.true;
  338. } );
  339. it( 'should return true if ranges end at the same position and check is not strict', () => {
  340. const otherRange = new Range( new Position( root, [ 2 ] ), range.end );
  341. expect( range.containsRange( otherRange, true ) ).to.be.true;
  342. } );
  343. it( 'should return false if given range is collapsed and starts or ends at another range boundary', () => {
  344. expect( range.containsRange( new Range( range.start, range.start ) ) ).to.be.false;
  345. expect( range.containsRange( new Range( range.end, range.end ) ) ).to.be.false;
  346. // Collapsed range should always be checked in strict mode.
  347. expect( range.containsRange( new Range( range.start, range.start ), true ) ).to.be.false;
  348. expect( range.containsRange( new Range( range.end, range.end ), true ) ).to.be.false;
  349. } );
  350. } );
  351. describe( 'containsItem()', () => {
  352. let a, b, c, d, xxx;
  353. beforeEach( () => {
  354. a = new Element( 'a' );
  355. b = new Element( 'b' );
  356. c = new Element( 'c' );
  357. d = new Element( 'd' );
  358. xxx = new Text( 'xxx' );
  359. b.appendChildren( xxx );
  360. root.appendChildren( [ a, b, c, d ] );
  361. } );
  362. it( 'should return true if element is inside range and false when it is not inside range', () => {
  363. const range = Range.createFromParentsAndOffsets( root, 1, root, 3 ); // Range over `b` and `c`.
  364. expect( range.containsItem( a ) ).to.be.false;
  365. expect( range.containsItem( b ) ).to.be.true;
  366. expect( range.containsItem( xxx ) ).to.be.true;
  367. expect( range.containsItem( c ) ).to.be.true;
  368. expect( range.containsItem( d ) ).to.be.false;
  369. } );
  370. } );
  371. describe( '_getTransformedByInsertion()', () => {
  372. it( 'should return an array of Range objects', () => {
  373. const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  374. const transformed = range._getTransformedByInsertion( new Position( root, [ 2 ] ), 2 );
  375. expect( transformed ).to.be.instanceof( Array );
  376. expect( transformed[ 0 ] ).to.be.instanceof( Range );
  377. } );
  378. it( 'should update it\'s positions offsets if insertion is before range and they are affected', () => {
  379. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 4 ] ) );
  380. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 1 ] ), 2 );
  381. expect( transformed[ 0 ].start.offset ).to.equal( 4 );
  382. expect( transformed[ 0 ].end.offset ).to.equal( 6 );
  383. } );
  384. it( 'should update it\'s positions paths if insertion is before range and they are affected', () => {
  385. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  386. const transformed = range._getTransformedByInsertion( new Position( root, [ 0 ] ), 2 );
  387. expect( transformed[ 0 ].start.path[ 0 ] ).to.equal( 5 );
  388. expect( transformed[ 0 ].end.path[ 0 ] ).to.equal( 6 );
  389. } );
  390. it( 'should expand range if insertion was in the middle of range', () => {
  391. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  392. const transformed = range._getTransformedByInsertion( new Position( root, [ 5, 0 ] ), 4 );
  393. expect( transformed.length ).to.equal( 1 );
  394. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  395. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 8 ] );
  396. } );
  397. it( 'should return array with two ranges if insertion was in the middle of range and spread flag was set', () => {
  398. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  399. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 1, 6 ] ), 4, true );
  400. expect( transformed.length ).to.equal( 2 );
  401. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  402. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 1, 6 ] );
  403. expect( transformed[ 1 ].start.path ).to.deep.equal( [ 4, 1, 10 ] );
  404. expect( transformed[ 1 ].end.path ).to.deep.equal( [ 5, 4 ] );
  405. } );
  406. it( 'should not expand range if insertion is equal to start boundary of the range', () => {
  407. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  408. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 2 ] ), 3 );
  409. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  410. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  411. } );
  412. it( 'should expand range if insertion is equal to start boundary of the range and sticky flag is set', () => {
  413. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  414. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 2 ] ), 3, false, true );
  415. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  416. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  417. } );
  418. it( 'should not update positions if insertion is before range (but not equal to the start boundary)', () => {
  419. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  420. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 1 ] ), 3 );
  421. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  422. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  423. } );
  424. it( 'should not expand range if insertion is equal to end boundary of the range', () => {
  425. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  426. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 4 ] ), 3 );
  427. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  428. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 4 ] );
  429. } );
  430. it( 'should expand range if insertion is equal to end boundary of the range and sticky flag is set', () => {
  431. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  432. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 4 ] ), 3, false, true );
  433. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  434. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 7 ] );
  435. } );
  436. it( 'should not update positions if insertion is after range (but not equal to the end boundary)', () => {
  437. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  438. const transformed = range._getTransformedByInsertion( new Position( root, [ 4, 5 ] ), 3 );
  439. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  440. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 4 ] );
  441. } );
  442. it( 'should expand range after inserted nodes if the range is collapsed and isSticky is true', () => {
  443. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 2 ] ) );
  444. const transformed = range._getTransformedByInsertion( new Position( root, [ 3, 2 ] ), 3, false, true );
  445. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  446. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 5 ] );
  447. } );
  448. } );
  449. describe( '_getTransformedByMove()', () => {
  450. it( 'should return an array of Range objects', () => {
  451. const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  452. const transformed = range._getTransformedByMove( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ), 2 );
  453. expect( transformed ).to.be.instanceof( Array );
  454. expect( transformed[ 0 ] ).to.be.instanceof( Range );
  455. } );
  456. it( 'should update it\'s positions offsets if target is before range and they are affected', () => {
  457. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 4 ] ) );
  458. const transformed = range._getTransformedByMove( new Position( root, [ 8, 1 ] ), new Position( root, [ 3, 1 ] ), 2 );
  459. expect( transformed[ 0 ].start.offset ).to.equal( 4 );
  460. expect( transformed[ 0 ].end.offset ).to.equal( 6 );
  461. } );
  462. it( 'should update it\'s positions paths if target is before range and they are affected', () => {
  463. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  464. const transformed = range._getTransformedByMove( new Position( root, [ 8 ] ), new Position( root, [ 0 ] ), 2 );
  465. expect( transformed[ 0 ].start.path[ 0 ] ).to.equal( 5 );
  466. expect( transformed[ 0 ].end.path[ 0 ] ).to.equal( 6 );
  467. } );
  468. it( 'should expand range if target was in the middle of range', () => {
  469. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  470. const transformed = range._getTransformedByMove( new Position( root, [ 8 ] ), new Position( root, [ 5, 0 ] ), 4 );
  471. expect( transformed.length ).to.equal( 1 );
  472. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  473. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 8 ] );
  474. } );
  475. it( 'should not expand range if insertion is equal to start boundary of the range', () => {
  476. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 8 ] ) );
  477. const transformed = range._getTransformedByMove( new Position( root, [ 8, 2 ] ), new Position( root, [ 3, 2 ] ), 3 );
  478. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 5 ] );
  479. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 11 ] );
  480. } );
  481. it( 'should not expand range if insertion is equal to end boundary of the range', () => {
  482. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  483. const transformed = range._getTransformedByMove( new Position( root, [ 8, 4 ] ), new Position( root, [ 4, 4 ] ), 3 );
  484. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  485. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 4 ] );
  486. } );
  487. it( 'should update it\'s positions offsets if source is before range and they are affected', () => {
  488. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 4 ] ) );
  489. const transformed = range._getTransformedByMove( new Position( root, [ 3, 0 ] ), new Position( root, [ 8, 1 ] ), 2 );
  490. expect( transformed[ 0 ].start.offset ).to.equal( 0 );
  491. expect( transformed[ 0 ].end.offset ).to.equal( 2 );
  492. } );
  493. it( 'should update it\'s positions paths if source is before range and they are affected', () => {
  494. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 4, 4 ] ) );
  495. const transformed = range._getTransformedByMove( new Position( root, [ 0 ] ), new Position( root, [ 8 ] ), 2 );
  496. expect( transformed[ 0 ].start.path[ 0 ] ).to.equal( 1 );
  497. expect( transformed[ 0 ].end.path[ 0 ] ).to.equal( 2 );
  498. } );
  499. it( 'should shrink range if source was in the middle of range', () => {
  500. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  501. const transformed = range._getTransformedByMove( new Position( root, [ 5, 0 ] ), new Position( root, [ 8 ] ), 4 );
  502. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  503. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 0 ] );
  504. } );
  505. it( 'should shrink range if source contained range start position', () => {
  506. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  507. const transformed = range._getTransformedByMove( new Position( root, [ 3, 1 ] ), new Position( root, [ 8 ] ), 2 );
  508. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 1 ] );
  509. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 4 ] );
  510. } );
  511. it( 'should shrink range if source contained range end position', () => {
  512. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  513. const transformed = range._getTransformedByMove( new Position( root, [ 5, 3 ] ), new Position( root, [ 8 ] ), 2 );
  514. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  515. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 5, 3 ] );
  516. } );
  517. it( 'should move range if it was contained in moved range', () => {
  518. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 7 ] ) );
  519. const transformed = range._getTransformedByMove( new Position( root, [ 3 ] ), new Position( root, [ 6 ] ), 2 );
  520. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 4, 2 ] );
  521. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 4, 7 ] );
  522. } );
  523. it( 'should not stick to moved range, if the transformed range is collapsed #1', () => {
  524. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 2 ] ) );
  525. const transformed = range._getTransformedByMove( new Position( root, [ 3, 0 ] ), new Position( root, [ 6 ] ), 2 );
  526. expect( transformed.length ).to.equal( 1 );
  527. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 0 ] );
  528. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 0 ] );
  529. } );
  530. it( 'should not stick to moved range, if the transformed range is collapsed #2', () => {
  531. const range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 3, 2 ] ) );
  532. const transformed = range._getTransformedByMove( new Position( root, [ 3, 2 ] ), new Position( root, [ 6 ] ), 2 );
  533. expect( transformed.length ).to.equal( 1 );
  534. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  535. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 3, 2 ] );
  536. } );
  537. } );
  538. describe( 'getDifference()', () => {
  539. let range;
  540. beforeEach( () => {
  541. range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  542. } );
  543. it( 'should return an array of Range objects', () => {
  544. const otherRange = new Range( new Position( root, [ 6 ] ), new Position( root, [ 7 ] ) );
  545. const diff = range.getDifference( otherRange );
  546. expect( diff ).to.be.instanceof( Array );
  547. expect( diff[ 0 ] ).to.be.instanceof( Range );
  548. } );
  549. it( 'should return original range if other range does not intersect with it', () => {
  550. const otherRange = new Range( new Position( root, [ 6 ] ), new Position( root, [ 7 ] ) );
  551. const diff = range.getDifference( otherRange );
  552. expect( diff[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  553. expect( diff[ 0 ].end.path ).to.deep.equal( [ 5, 4 ] );
  554. } );
  555. it( 'should return shrunken range if other range intersects with it', () => {
  556. const otherRange = new Range( new Position( root, [ 4, 1 ] ), new Position( root, [ 7 ] ) );
  557. const diff = range.getDifference( otherRange );
  558. expect( diff[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  559. expect( diff[ 0 ].end.path ).to.deep.equal( [ 4, 1 ] );
  560. } );
  561. it( 'should return an empty array if other range contains or is same as the original range', () => {
  562. const otherRange = new Range( new Position( root, [ 2 ] ), new Position( root, [ 6 ] ) );
  563. const diff = range.getDifference( otherRange );
  564. expect( diff.length ).to.equal( 0 );
  565. } );
  566. it( 'should two ranges if other range is contained by the original range', () => {
  567. const otherRange = new Range( new Position( root, [ 3, 7 ] ), new Position( root, [ 4, 1 ] ) );
  568. const diff = range.getDifference( otherRange );
  569. expect( diff.length ).to.equal( 2 );
  570. expect( diff[ 0 ].start.path ).to.deep.equal( [ 3, 2 ] );
  571. expect( diff[ 0 ].end.path ).to.deep.equal( [ 3, 7 ] );
  572. expect( diff[ 1 ].start.path ).to.deep.equal( [ 4, 1 ] );
  573. expect( diff[ 1 ].end.path ).to.deep.equal( [ 5, 4 ] );
  574. } );
  575. } );
  576. describe( 'getIntersection()', () => {
  577. let range;
  578. beforeEach( () => {
  579. range = new Range( new Position( root, [ 3, 2 ] ), new Position( root, [ 5, 4 ] ) );
  580. } );
  581. it( 'should return null if ranges do not intersect', () => {
  582. const otherRange = new Range( new Position( root, [ 5, 4 ] ), new Position( root, [ 7 ] ) );
  583. const common = range.getIntersection( otherRange );
  584. expect( common ).to.be.null;
  585. } );
  586. it( 'should return a range equal to the common part of ranges - original range contains the other range', () => {
  587. const otherRange = new Range( new Position( root, [ 4 ] ), new Position( root, [ 5 ] ) );
  588. const common = range.getIntersection( otherRange );
  589. expect( common.isEqual( otherRange ) ).to.be.true;
  590. } );
  591. it( 'should return a range equal to the common part of ranges - original range is contained by the other range', () => {
  592. const otherRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6 ] ) );
  593. const common = range.getIntersection( otherRange );
  594. expect( common.isEqual( range ) ).to.be.true;
  595. } );
  596. it( 'should return a range equal to the common part of ranges - original range intersects with the other range', () => {
  597. const otherRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 4, 7 ] ) );
  598. const common = range.getIntersection( otherRange );
  599. expect( common.start.path ).to.deep.equal( [ 3, 2 ] );
  600. expect( common.end.path ).to.deep.equal( [ 4, 7 ] );
  601. } );
  602. } );
  603. // Note: We don't create model element structure in these tests because this method
  604. // is used by OT so it must not check the structure.
  605. describe( 'getTransformedByDelta()', () => {
  606. beforeEach( () => {
  607. range = Range.createFromParentsAndOffsets( root, 2, root, 5 );
  608. } );
  609. function expectRange( range, startOffset, endOffset ) {
  610. expect( range.start.offset ).to.equal( startOffset );
  611. expect( range.end.offset ).to.equal( endOffset );
  612. }
  613. describe( 'by AttributeDelta', () => {
  614. it( 'nothing should change', () => {
  615. const delta = getAttributeDelta( Range.createFromParentsAndOffsets( root, 1, root, 6 ), 'key', true, false, 1 );
  616. const transformed = range.getTransformedByDelta( delta );
  617. expectRange( transformed[ 0 ], 2, 5 );
  618. } );
  619. } );
  620. describe( 'by InsertDelta', () => {
  621. it( 'insert before range', () => {
  622. const delta = getInsertDelta( new Position( root, [ 1 ] ), new Text( 'abc' ), 1 );
  623. const transformed = range.getTransformedByDelta( delta );
  624. expectRange( transformed[ 0 ], 5, 8 );
  625. } );
  626. it( 'insert inside range', () => {
  627. const delta = getInsertDelta( new Position( root, [ 3 ] ), new Text( 'abc' ), 1 );
  628. const transformed = range.getTransformedByDelta( delta );
  629. expectRange( transformed[ 0 ], 2, 8 );
  630. } );
  631. it( 'insert after range', () => {
  632. const delta = getInsertDelta( new Position( root, [ 6 ] ), new Text( 'abc' ), 1 );
  633. const transformed = range.getTransformedByDelta( delta );
  634. expectRange( transformed[ 0 ], 2, 5 );
  635. } );
  636. } );
  637. describe( 'by MoveDelta', () => {
  638. it( 'move before range', () => {
  639. const start = new Position( root, [ 0 ] );
  640. const target = new Position( otherRoot, [ 0 ] );
  641. const delta = getMoveDelta( start, 2, target, 1 );
  642. const transformed = range.getTransformedByDelta( delta );
  643. expectRange( transformed[ 0 ], 0, 3 );
  644. } );
  645. it( 'move intersecting with range (and targeting before range)', () => {
  646. const start = new Position( root, [ 4 ] );
  647. const target = new Position( root, [ 0 ] );
  648. const delta = getMoveDelta( start, 2, target, 1 );
  649. const transformed = range.getTransformedByDelta( delta );
  650. expectRange( transformed[ 0 ], 4, 6 );
  651. expectRange( transformed[ 1 ], 0, 1 );
  652. } );
  653. it( 'move inside the range', () => {
  654. range.end.offset = 6;
  655. const start = new Position( root, [ 3 ] );
  656. const target = new Position( root, [ 5 ] );
  657. const delta = getMoveDelta( start, 1, target, 1 );
  658. const transformed = range.getTransformedByDelta( delta );
  659. expectRange( transformed[ 0 ], 2, 4 );
  660. expectRange( transformed[ 1 ], 5, 6 );
  661. expectRange( transformed[ 2 ], 4, 5 );
  662. } );
  663. // #877.
  664. it( 'moved element contains range start and is moved towards inside of range', () => {
  665. // Initial state:
  666. // <w><p>abc</p><p>x[x</p></w><p>d]ef</p>
  667. // Expected state after moving `<p>` out of `<w>`:
  668. // <w><p>abc</p></w><p>x[x</p><p>d]ef</p>
  669. const range = new Range( new Position( root, [ 0, 1, 1 ] ), new Position( root, [ 1, 1 ] ) );
  670. const delta = getMoveDelta( new Position( root, [ 0, 1 ] ), 1, new Position( root, [ 1 ] ), 1 );
  671. const transformed = range.getTransformedByDelta( delta );
  672. expect( transformed.length ).to.equal( 1 );
  673. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 1, 1 ] );
  674. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 2, 1 ] );
  675. } );
  676. it( 'moved element contains range start and is moved out of range', () => {
  677. // Initial state:
  678. // <p>abc</p><p>x[x</p><p>d]ef</p>
  679. // Expected state after moving:
  680. // <p>x[x</p><p>abc</p><p>d]ef</p>
  681. const range = new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 2, 1 ] ) );
  682. const delta = getMoveDelta( new Position( root, [ 1 ] ), 1, new Position( root, [ 0 ] ), 1 );
  683. const transformed = range.getTransformedByDelta( delta );
  684. expect( transformed.length ).to.equal( 1 );
  685. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  686. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 2, 1 ] );
  687. } );
  688. it( 'moved element contains range end and is moved towards range', () => {
  689. // Initial state:
  690. // <p>a[bc</p><p>def</p><p>x]x</p>
  691. // Expected state after moving:
  692. // <p>a[bc</p><p>x]x</p><p>def</p>
  693. const range = new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 2, 1 ] ) );
  694. const delta = getMoveDelta( new Position( root, [ 2 ] ), 1, new Position( root, [ 1 ] ), 1 );
  695. const transformed = range.getTransformedByDelta( delta );
  696. expect( transformed.length ).to.equal( 1 );
  697. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  698. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  699. } );
  700. it( 'moved element contains range end and is moved out of range', () => {
  701. // Initial state:
  702. // <p>a[bc</p><p>x]x</p><p>def</p>
  703. // Expected state after moving:
  704. // <p>a[bc</p><p>def</p><p>x]x</p>
  705. const range = new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 1, 1 ] ) );
  706. const delta = getMoveDelta( new Position( root, [ 1 ] ), 1, new Position( root, [ 3 ] ), 1 );
  707. const transformed = range.getTransformedByDelta( delta );
  708. expect( transformed.length ).to.equal( 1 );
  709. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  710. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 2, 1 ] );
  711. } );
  712. } );
  713. describe( 'by RemoveDelta', () => {
  714. it( 'remove before range', () => {
  715. const start = new Position( root, [ 0 ] );
  716. const delta = getRemoveDelta( start, 2, 1 );
  717. const transformed = range.getTransformedByDelta( delta );
  718. expectRange( transformed[ 0 ], 0, 3 );
  719. } );
  720. it( 'remove intersecting with range', () => {
  721. const start = new Position( root, [ 4 ] );
  722. const delta = getRemoveDelta( start, 2, 1 );
  723. const transformed = range.getTransformedByDelta( delta );
  724. expectRange( transformed[ 0 ], 2, 4 );
  725. expect( transformed[ 1 ].root ).to.equal( doc.graveyard );
  726. expect( transformed[ 1 ].end.offset - transformed[ 1 ].start.offset ).to.equal( 1 );
  727. } );
  728. it( 'remove inside the range', () => {
  729. const start = new Position( root, [ 3 ] );
  730. const delta = getRemoveDelta( start, 2, 1 );
  731. const transformed = range.getTransformedByDelta( delta );
  732. expectRange( transformed[ 0 ], 2, 3 );
  733. expect( transformed[ 1 ].root ).to.equal( doc.graveyard );
  734. expect( transformed[ 1 ].end.offset - transformed[ 1 ].start.offset ).to.equal( 2 );
  735. } );
  736. } );
  737. describe( 'by RenameDelta', () => {
  738. it( 'nothing should change', () => {
  739. const delta = getRenameDelta( new Position( root, [ 3 ] ), 'old', 'new', 1 );
  740. const transformed = range.getTransformedByDelta( delta );
  741. expectRange( transformed[ 0 ], 2, 5 );
  742. } );
  743. } );
  744. describe( 'by SplitDelta', () => {
  745. it( 'split inside range', () => {
  746. range.start = new Position( root, [ 0, 2 ] );
  747. range.end = new Position( root, [ 0, 4 ] );
  748. const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 );
  749. const transformed = range.getTransformedByDelta( delta );
  750. expect( transformed.length ).to.equal( 1 );
  751. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 2 ] );
  752. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  753. } );
  754. it( 'split at the beginning of multi-element range', () => {
  755. range.start = new Position( root, [ 0, 4 ] );
  756. range.end = new Position( root, [ 1, 2 ] );
  757. const delta = getSplitDelta( new Position( root, [ 0, 4 ] ), new Element( 'p' ), 3, 1 );
  758. const transformed = range.getTransformedByDelta( delta );
  759. expect( transformed.length ).to.equal( 1 );
  760. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 1, 0 ] );
  761. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 2, 2 ] );
  762. } );
  763. it( 'split inside range which starts at the beginning of split element', () => {
  764. range.start = new Position( root, [ 0, 0 ] );
  765. range.end = new Position( root, [ 0, 4 ] );
  766. const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 );
  767. const transformed = range.getTransformedByDelta( delta );
  768. expect( transformed.length ).to.equal( 1 );
  769. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 0 ] );
  770. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  771. } );
  772. it( 'split inside range which end is at the end of split element', () => {
  773. range.start = new Position( root, [ 0, 3 ] );
  774. range.end = new Position( root, [ 0, 6 ] );
  775. const delta = getSplitDelta( new Position( root, [ 0, 4 ] ), new Element( 'p' ), 2, 1 );
  776. const transformed = range.getTransformedByDelta( delta );
  777. expect( transformed.length ).to.equal( 1 );
  778. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 3 ] );
  779. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 2 ] );
  780. } );
  781. it( 'split element which has collapsed range at the end', () => {
  782. range.start = new Position( root, [ 0, 6 ] );
  783. range.end = new Position( root, [ 0, 6 ] );
  784. const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 );
  785. const transformed = range.getTransformedByDelta( delta );
  786. expect( transformed.length ).to.equal( 1 );
  787. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 1, 3 ] );
  788. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 3 ] );
  789. } );
  790. } );
  791. describe( 'by MergeDelta', () => {
  792. it( 'merge element with collapsed range', () => {
  793. range.start = new Position( root, [ 1, 0 ] );
  794. range.end = new Position( root, [ 1, 0 ] );
  795. const delta = getMergeDelta( new Position( root, [ 1 ] ), 3, 3, 1 );
  796. const transformed = range.getTransformedByDelta( delta );
  797. expect( transformed.length ).to.equal( 1 );
  798. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 3 ] );
  799. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 0, 3 ] );
  800. } );
  801. // #877.
  802. it( 'merge elements that contain elements with range boundaries', () => {
  803. // Initial state:
  804. // <w><p>x[x</p></w><w><p>y]y</p></w>
  805. // Expected state after merge:
  806. // <w><p>x[x</p><p>y]y</p></w>
  807. const range = new Range( new Position( root, [ 0, 0, 1 ] ), new Position( root, [ 1, 0, 1 ] ) );
  808. const delta = getMergeDelta( new Position( root, [ 1 ] ), 1, 1, 1 );
  809. const transformed = range.getTransformedByDelta( delta );
  810. expect( transformed.length ).to.equal( 1 );
  811. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 0, 1 ] );
  812. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 0, 1, 1 ] );
  813. } );
  814. // #1132.
  815. it( 'merge delta has move operation that does not start from offset 0', () => {
  816. // This scenario is a test for a rare situation, that after some OT, a move operation in
  817. // merge delta does not start from 0 offset.
  818. //
  819. // It happens that move operation in merge delta becomes "do nothing move operation", something like:
  820. //
  821. // move range [ a, x ] - [ a, y ] to [ a, x ]
  822. // for example: move [ 0, 3 ] - [ 0, 6 ] -> [ 0, 3 ]
  823. //
  824. // This is a result of valid transformation and we need to check if range is properly transformed
  825. // when such unusual delta is generated.
  826. // For more see: https://github.com/ckeditor/ckeditor5-engine/pull/1133#issuecomment-329080668.
  827. //
  828. // For this test scenario assume: <p>foobar[]</p>, "bar" is moved between "o" and "b".
  829. // Expect state after transformation is that nothing has changed.
  830. const range = new Range( new Position( root, [ 0, 6 ] ), new Position( root, [ 0, 6 ] ) );
  831. const delta = new MergeDelta();
  832. delta.addOperation( new MoveOperation( new Position( root, [ 0, 3 ] ), 3, new Position( root, [ 0, 3 ] ), 0 ) );
  833. delta.addOperation( new RemoveOperation( new Position( root, [ 1 ] ), 1, new Position( doc.graveyard, [ 0 ] ), 1 ) );
  834. const transformed = range.getTransformedByDelta( delta );
  835. expect( transformed.length ).to.equal( 1 );
  836. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 6 ] );
  837. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 0, 6 ] );
  838. } );
  839. } );
  840. describe( 'by WrapDelta', () => {
  841. it( 'maintans start position when wrapping element in which the range starts and ends', () => {
  842. // <p>f[o]o</p><p>bar</p>
  843. range.start = new Position( root, [ 0, 1 ] );
  844. range.end = new Position( root, [ 0, 2 ] );
  845. const wrapRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  846. const wrapElement = new Element( 'w' );
  847. const delta = getWrapDelta( wrapRange, wrapElement, 1 );
  848. const transformed = range.getTransformedByDelta( delta );
  849. // <w><p>f[o]o</p></w><p>bar</p>
  850. expect( transformed.length ).to.equal( 1 );
  851. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 0, 1 ] );
  852. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 0, 0, 2 ] );
  853. } );
  854. it( 'maintans start position when wrapping element in which the range starts but not ends', () => {
  855. // <p>f[oo</p><p>b]ar</p>
  856. range.start = new Position( root, [ 0, 1 ] );
  857. range.end = new Position( root, [ 1, 1 ] );
  858. const wrapRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  859. const wrapElement = new Element( 'w' );
  860. const delta = getWrapDelta( wrapRange, wrapElement, 1 );
  861. const transformed = range.getTransformedByDelta( delta );
  862. // <w><p>f[oo</p></w><p>b]ar</p>
  863. expect( transformed.length ).to.equal( 1 );
  864. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 0, 1 ] );
  865. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  866. } );
  867. it( 'maintans end position when wrapping element in which the range ends but not starts', () => {
  868. // <p>f[oo</p><p>b]ar</p>
  869. range.start = new Position( root, [ 0, 1 ] );
  870. range.end = new Position( root, [ 1, 1 ] );
  871. const wrapRange = new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) );
  872. const wrapElement = new Element( 'w' );
  873. const delta = getWrapDelta( wrapRange, wrapElement, 1 );
  874. const transformed = range.getTransformedByDelta( delta );
  875. // <p>f[oo</p><w><p>b]ar</p></w>
  876. expect( transformed.length ).to.equal( 1 );
  877. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  878. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 0, 1 ] );
  879. } );
  880. } );
  881. describe( 'by UnwrapDelta', () => {
  882. it( 'maintans start position when wrapping element in which the range starts and ends', () => {
  883. // <w><p>f[o]o</p></w><p>bar</p>
  884. range.start = new Position( root, [ 0, 0, 1 ] );
  885. range.end = new Position( root, [ 0, 0, 2 ] );
  886. const unwrapPosition = new Position( root, [ 0 ] );
  887. const delta = getUnwrapDelta( unwrapPosition, 1, 1 );
  888. const transformed = range.getTransformedByDelta( delta );
  889. // <p>f[o]o</p><p>bar</p>
  890. expect( transformed.length ).to.equal( 1 );
  891. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  892. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 0, 2 ] );
  893. } );
  894. it( 'maintans start position when wrapping element in which the range starts but not ends', () => {
  895. // <w><p>f[oo</p></w><p>b]ar</p>
  896. range.start = new Position( root, [ 0, 0, 1 ] );
  897. range.end = new Position( root, [ 1, 1 ] );
  898. const unwrapPosition = new Position( root, [ 0 ] );
  899. const delta = getUnwrapDelta( unwrapPosition, 1, 1 );
  900. const transformed = range.getTransformedByDelta( delta );
  901. // <p>f[oo</p><p>b]ar</p>
  902. expect( transformed.length ).to.equal( 2 );
  903. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  904. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  905. expect( transformed[ 1 ].root.rootName ).to.equal( '$graveyard' );
  906. } );
  907. it( 'maintans end position when wrapping element in which the range ends but not starts', () => {
  908. // <p>f[oo</p><w><p>b]ar</p></w>
  909. range.start = new Position( root, [ 0, 1 ] );
  910. range.end = new Position( root, [ 1, 0, 1 ] );
  911. const unwrapPosition = new Position( root, [ 1 ] );
  912. const delta = getUnwrapDelta( unwrapPosition, 1, 1 );
  913. const transformed = range.getTransformedByDelta( delta );
  914. // <p>f[oo</p><p>b]ar</p>
  915. expect( transformed.length ).to.equal( 1 );
  916. expect( transformed[ 0 ].start.path ).to.deep.equal( [ 0, 1 ] );
  917. expect( transformed[ 0 ].end.path ).to.deep.equal( [ 1, 1 ] );
  918. } );
  919. } );
  920. } );
  921. describe( 'getTransformedByDeltas()', () => {
  922. beforeEach( () => {
  923. root.appendChildren( new Text( 'foobar' ) );
  924. range = Range.createFromParentsAndOffsets( root, 2, root, 5 );
  925. } );
  926. function expectRange( range, startOffset, endOffset ) {
  927. expect( range.start.offset ).to.equal( startOffset );
  928. expect( range.end.offset ).to.equal( endOffset );
  929. }
  930. it( 'should return a range transformed by multiple deltas', () => {
  931. const transformed = range.getTransformedByDeltas( [
  932. getInsertDelta( new Position( root, [ 1 ] ), new Text( 'abc' ), 1 ), // Range becomes 5..8.
  933. getInsertDelta( new Position( root, [ 6 ] ), new Text( 'xx' ), 2 ) // Range becomes 5..10.
  934. ] );
  935. expectRange( transformed[ 0 ], 5, 10 );
  936. } );
  937. it( 'should correctly handle breaking transformed range and all range "pieces"', () => {
  938. const transformed = range.getTransformedByDeltas( [
  939. getInsertDelta( new Position( root, [ 3 ] ), new Text( 'abc' ), 1 ), // Range becomes 2..8.
  940. getMoveDelta( new Position( root, [ 4 ] ), 3, new Position( root, [ 9 ] ), 2 ), // Range becomes 2..5 and 6..9.
  941. getInsertDelta( new Position( root, [ 0 ] ), new Text( 'x' ), 3 ), // Range becomes 3..6 and 7..10.
  942. getMoveDelta( new Position( root, [ 9 ] ), 1, new Position( root, [ 4 ] ), 4 ), // Range becomes 3..7 and 8..10.
  943. getMoveDelta( new Position( root, [ 6 ] ), 1, new Position( root, [ 1 ] ), 5 ) // Range becomes 1..2, 4..7 and 8..10.
  944. ] );
  945. expect( transformed.length ).to.equal( 3 );
  946. expectRange( transformed[ 0 ], 4, 7 );
  947. expectRange( transformed[ 1 ], 1, 2 );
  948. expectRange( transformed[ 2 ], 8, 10 );
  949. } );
  950. it( 'should return range equal to original range for empty delta set', () => {
  951. const transformed = range.getTransformedByDeltas( [] );
  952. expectRange( transformed[ 0 ], 2, 5 );
  953. } );
  954. } );
  955. describe( 'getMinimalFlatRanges()', () => {
  956. beforeEach( () => {
  957. prepareRichRoot( root );
  958. } );
  959. it( 'should return empty array if range is collapsed', () => {
  960. const range = new Range( new Position( root, [ 1, 3 ] ), new Position( root, [ 1, 3 ] ) );
  961. const flat = range.getMinimalFlatRanges();
  962. expect( flat.length ).to.equal( 0 );
  963. } );
  964. it( 'should return empty array if range does not contain any node', () => {
  965. const range = new Range( new Position( root, [ 1, 3 ] ), new Position( root, [ 2, 0 ] ) );
  966. const flat = range.getMinimalFlatRanges();
  967. expect( flat.length ).to.equal( 0 );
  968. } );
  969. it( 'should return a minimal set of flat ranges that covers the range (start and end in different sub-trees)', () => {
  970. const range = new Range( new Position( root, [ 0, 0, 3 ] ), new Position( root, [ 3, 0, 2 ] ) );
  971. const flat = range.getMinimalFlatRanges();
  972. expect( flat.length ).to.equal( 4 );
  973. expect( flat[ 0 ].start.path ).to.deep.equal( [ 0, 0, 3 ] );
  974. expect( flat[ 0 ].end.path ).to.deep.equal( [ 0, 0, 5 ] );
  975. expect( flat[ 1 ].start.path ).to.deep.equal( [ 0, 1 ] );
  976. expect( flat[ 1 ].end.path ).to.deep.equal( [ 0, 2 ] );
  977. expect( flat[ 2 ].start.path ).to.deep.equal( [ 1 ] );
  978. expect( flat[ 2 ].end.path ).to.deep.equal( [ 3 ] );
  979. expect( flat[ 3 ].start.path ).to.deep.equal( [ 3, 0, 0 ] );
  980. expect( flat[ 3 ].end.path ).to.deep.equal( [ 3, 0, 2 ] );
  981. } );
  982. it( 'should return a minimal set of flat ranges that covers the range (start.path is prefix of end.path)', () => {
  983. const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 0, 1, 4 ] ) );
  984. const flat = range.getMinimalFlatRanges();
  985. expect( flat.length ).to.equal( 2 );
  986. expect( flat[ 0 ].start.path ).to.deep.equal( [ 0, 0 ] );
  987. expect( flat[ 0 ].end.path ).to.deep.equal( [ 0, 1 ] );
  988. expect( flat[ 1 ].start.path ).to.deep.equal( [ 0, 1, 0 ] );
  989. expect( flat[ 1 ].end.path ).to.deep.equal( [ 0, 1, 4 ] );
  990. } );
  991. } );
  992. describe( 'isFlat', () => {
  993. beforeEach( () => {
  994. prepareRichRoot( root );
  995. } );
  996. it( 'should be true if start and end position are in the same parent', () => {
  997. const range = new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 2 ] ) );
  998. expect( range.isFlat ).to.be.true;
  999. } );
  1000. it( 'should be false if start and end position are in different parents', () => {
  1001. const range = new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 3, 0, 1 ] ) );
  1002. expect( range.isFlat ).to.be.false;
  1003. } );
  1004. } );
  1005. describe( 'fromJSON()', () => {
  1006. it( 'should create range from given JSON object', () => {
  1007. const serialized = jsonParseStringify( range );
  1008. const deserialized = Range.fromJSON( serialized, doc );
  1009. expect( deserialized ).to.deep.equal( range );
  1010. } );
  1011. } );
  1012. describe( 'getCommonAncestor()', () => {
  1013. it( 'should return common ancestor for positions from Range', () => {
  1014. expect( range.getCommonAncestor() ).to.equal( root );
  1015. } );
  1016. } );
  1017. function mapNodesToNames( nodes ) {
  1018. return nodes.map( node => {
  1019. return ( node instanceof Element ) ? 'E:' + node.name : 'T:' + node.data;
  1020. } );
  1021. }
  1022. function prepareRichRoot() {
  1023. root.insertChildren( 0, [
  1024. new Element( 'div', [], [
  1025. new Element( 'h', [], new Text( 'first' ) ),
  1026. new Element( 'p', [], new Text( 'lorem ipsum' ) )
  1027. ] ),
  1028. new Element( 'p', [], new Text( 'foo' ) ),
  1029. new Element( 'p', [], new Text( 'bar' ) ),
  1030. new Element( 'div', [], [
  1031. new Element( 'h', [], new Text( 'second' ) ),
  1032. new Element( 'p', [], new Text( 'lorem' ) )
  1033. ] )
  1034. ] );
  1035. }
  1036. } );