range.js 48 KB

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