range.js 52 KB

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