range.js 52 KB

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