range.js 53 KB

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