liverange.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Document from '../../src/model/document';
  6. import Element from '../../src/model/element';
  7. import Position from '../../src/model/position';
  8. import LiveRange from '../../src/model/liverange';
  9. import Range from '../../src/model/range';
  10. import Text from '../../src/model/text';
  11. describe( 'LiveRange', () => {
  12. let doc, root, ul, p;
  13. before( () => {
  14. doc = new Document();
  15. root = doc.createRoot();
  16. let lis = [
  17. new Element( 'li', [], new Text( 'aaaaaaaaaa' ) ),
  18. new Element( 'li', [], new Text( 'bbbbbbbbbb' ) ),
  19. new Element( 'li', [], new Text( 'cccccccccc' ) ),
  20. new Element( 'li', [], new Text( 'dddddddddd' ) ),
  21. new Element( 'li', [], new Text( 'eeeeeeeeee' ) ),
  22. new Element( 'li', [], new Text( 'ffffffffff' ) ),
  23. new Element( 'li', [], new Text( 'gggggggggg' ) ),
  24. new Element( 'li', [], new Text( 'hhhhhhhhhh' ) )
  25. ];
  26. ul = new Element( 'ul', [], lis );
  27. p = new Element( 'p', [], new Text( 'qwertyuiop' ) );
  28. root.insertChildren( 0, [ ul, p, new Text( 'xyzxyz' ) ] );
  29. } );
  30. it( 'should be an instance of Range', () => {
  31. let live = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  32. live.detach();
  33. expect( live ).to.be.instanceof( Range );
  34. } );
  35. it( 'should listen to a change event of the document that owns this range', () => {
  36. sinon.spy( LiveRange.prototype, 'listenTo' );
  37. let live = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  38. live.detach();
  39. expect( live.listenTo.calledWith( doc, 'change' ) ).to.be.true;
  40. LiveRange.prototype.listenTo.restore();
  41. } );
  42. it( 'should stop listening when detached', () => {
  43. sinon.spy( LiveRange.prototype, 'stopListening' );
  44. let live = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
  45. live.detach();
  46. expect( live.stopListening.called ).to.be.true;
  47. LiveRange.prototype.stopListening.restore();
  48. } );
  49. it( 'createIn should return LiveRange', () => {
  50. let range = LiveRange.createIn( p );
  51. expect( range ).to.be.instanceof( LiveRange );
  52. range.detach();
  53. } );
  54. it( 'createFromParentsAndOffsets should return LiveRange', () => {
  55. let range = LiveRange.createFromParentsAndOffsets( root, 0, p, 2 );
  56. expect( range ).to.be.instanceof( LiveRange );
  57. range.detach();
  58. } );
  59. it( 'createFromPositionAndShift should return LiveRange', () => {
  60. let range = LiveRange.createFromPositionAndShift( new Position( root, [ 0, 1 ] ), 4 );
  61. expect( range ).to.be.instanceof( LiveRange );
  62. range.detach();
  63. } );
  64. it( 'createFromRange should return LiveRange', () => {
  65. let range = LiveRange.createFromRange( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ) );
  66. expect( range ).to.be.instanceof( LiveRange );
  67. range.detach();
  68. } );
  69. // Examples may seem weird when you compare them with the tree structure generated at the beginning of tests.
  70. // Since change event is fired _after_ operation is executed on tree model, you have to imagine that generated
  71. // structure is representing what is _after_ operation is executed. So live LiveRange properties are describing
  72. // virtual tree that is not existing anymore and event ranges are operating on the tree generated above.
  73. describe( 'should get transformed if', () => {
  74. let live, spy;
  75. beforeEach( () => {
  76. live = new LiveRange( new Position( root, [ 0, 1, 4 ] ), new Position( root, [ 0, 2, 2 ] ) );
  77. spy = sinon.spy();
  78. live.on( 'change', spy );
  79. } );
  80. afterEach( () => {
  81. live.detach();
  82. } );
  83. describe( 'insertion', () => {
  84. it( 'is in the same parent as range start and before it', () => {
  85. let insertRange = new Range( new Position( root, [ 0, 1, 0 ] ), new Position( root, [ 0, 1, 4 ] ) );
  86. doc.fire( 'change', 'insert', { range: insertRange }, null );
  87. expect( live.start.path ).to.deep.equal( [ 0, 1, 8 ] );
  88. expect( live.end.path ).to.deep.equal( [ 0, 2, 2 ] );
  89. expect( spy.calledOnce ).to.be.true;
  90. } );
  91. it( 'is in the same parent as range end and before it', () => {
  92. let insertRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 3 ] ) );
  93. doc.fire( 'change', 'insert', { range: insertRange }, null );
  94. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  95. expect( live.end.path ).to.deep.equal( [ 0, 2, 5 ] );
  96. expect( spy.calledOnce ).to.be.true;
  97. } );
  98. it( 'is at a position before a node from range start path', () => {
  99. let insertRange = new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 2 ] ) );
  100. doc.fire( 'change', 'insert', { range: insertRange }, null );
  101. expect( live.start.path ).to.deep.equal( [ 0, 3, 4 ] );
  102. expect( live.end.path ).to.deep.equal( [ 0, 4, 2 ] );
  103. expect( spy.calledOnce ).to.be.true;
  104. } );
  105. it( 'is at a position before a node from range end path', () => {
  106. let insertRange = new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 0, 3 ] ) );
  107. doc.fire( 'change', 'insert', { range: insertRange }, null );
  108. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  109. expect( live.end.path ).to.deep.equal( [ 0, 3, 2 ] );
  110. expect( spy.calledOnce ).to.be.true;
  111. } );
  112. it( 'is at the live range start position and live range is collapsed', () => {
  113. live.end.path = [ 0, 1, 4 ];
  114. let insertRange = new Range( new Position( root, [ 0, 1, 4 ] ), new Position( root, [ 0, 1, 8 ] ) );
  115. doc.fire( 'change', 'insert', { range: insertRange }, null );
  116. expect( live.start.path ).to.deep.equal( [ 0, 1, 8 ] );
  117. expect( live.end.path ).to.deep.equal( [ 0, 1, 8 ] );
  118. expect( spy.calledOnce ).to.be.true;
  119. } );
  120. } );
  121. describe( 'range move', () => {
  122. it( 'is to the same parent as range start and before it', () => {
  123. let moveSource = new Position( root, [ 2 ] );
  124. let moveRange = new Range( new Position( root, [ 0, 1, 0 ] ), new Position( root, [ 0, 1, 4 ] ) );
  125. let changes = {
  126. range: moveRange,
  127. sourcePosition: moveSource
  128. };
  129. doc.fire( 'change', 'move', changes, null );
  130. expect( live.start.path ).to.deep.equal( [ 0, 1, 8 ] );
  131. expect( live.end.path ).to.deep.equal( [ 0, 2, 2 ] );
  132. expect( spy.calledOnce ).to.be.true;
  133. } );
  134. it( 'is to the same parent as range end and before it', () => {
  135. let moveSource = new Position( root, [ 3 ] );
  136. let moveRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 4 ] ) );
  137. let changes = {
  138. range: moveRange,
  139. sourcePosition: moveSource
  140. };
  141. doc.fire( 'change', 'move', changes, null );
  142. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  143. expect( live.end.path ).to.deep.equal( [ 0, 2, 6 ] );
  144. expect( spy.calledOnce ).to.be.true;
  145. } );
  146. it( 'is to a position before a node from range start path', () => {
  147. let moveSource = new Position( root, [ 2 ] );
  148. let moveRange = new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 2 ] ) );
  149. let changes = {
  150. range: moveRange,
  151. sourcePosition: moveSource
  152. };
  153. doc.fire( 'change', 'move', changes, null );
  154. expect( live.start.path ).to.deep.equal( [ 0, 3, 4 ] );
  155. expect( live.end.path ).to.deep.equal( [ 0, 4, 2 ] );
  156. expect( spy.calledOnce ).to.be.true;
  157. } );
  158. it( 'is to a position before a node from range end path', () => {
  159. let moveSource = new Position( root, [ 2 ] );
  160. let moveRange = new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 0, 3 ] ) );
  161. let changes = {
  162. range: moveRange,
  163. sourcePosition: moveSource
  164. };
  165. doc.fire( 'change', 'move', changes, null );
  166. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  167. expect( live.end.path ).to.deep.equal( [ 0, 3, 2 ] );
  168. expect( spy.calledOnce ).to.be.true;
  169. } );
  170. it( 'is from the same parent as range start and before it', () => {
  171. let moveSource = new Position( root, [ 0, 1, 0 ] );
  172. let moveRange = new Range( new Position( root, [ 2, 0 ] ), new Position( root, [ 2, 3 ] ) );
  173. let changes = {
  174. range: moveRange,
  175. sourcePosition: moveSource
  176. };
  177. doc.fire( 'change', 'move', changes, null );
  178. expect( live.start.path ).to.deep.equal( [ 0, 1, 1 ] );
  179. expect( live.end.path ).to.deep.equal( [ 0, 2, 2 ] );
  180. expect( spy.calledOnce ).to.be.true;
  181. } );
  182. it( 'is from the same parent as range end and before it', () => {
  183. let moveSource = new Position( root, [ 0, 2, 0 ] );
  184. let moveRange = new Range( new Position( root, [ 2, 0 ] ), new Position( root, [ 2, 2 ] ) );
  185. let changes = {
  186. range: moveRange,
  187. sourcePosition: moveSource
  188. };
  189. doc.fire( 'change', 'move', changes, null );
  190. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  191. expect( live.end.path ).to.deep.equal( [ 0, 2, 0 ] );
  192. expect( spy.calledOnce ).to.be.true;
  193. } );
  194. it( 'is from a position before a node from range start path', () => {
  195. let moveSource = new Position( root, [ 0, 0 ] );
  196. let moveRange = new Range( new Position( root, [ 2, 0 ] ), new Position( root, [ 2, 1 ] ) );
  197. let changes = {
  198. range: moveRange,
  199. sourcePosition: moveSource
  200. };
  201. doc.fire( 'change', 'move', changes, null );
  202. expect( live.start.path ).to.deep.equal( [ 0, 0, 4 ] );
  203. expect( live.end.path ).to.deep.equal( [ 0, 1, 2 ] );
  204. expect( spy.calledOnce ).to.be.true;
  205. } );
  206. it( 'intersects on live range left side', () => {
  207. let moveSource = new Position( root, [ 0, 1, 2 ] );
  208. let moveRange = new Range( new Position( root, [ 2, 0 ] ), new Position( root, [ 2, 4 ] ) );
  209. let changes = {
  210. range: moveRange,
  211. sourcePosition: moveSource
  212. };
  213. doc.fire( 'change', 'move', changes, null );
  214. expect( live.start.path ).to.deep.equal( [ 0, 1, 2 ] );
  215. expect( live.end.path ).to.deep.equal( [ 0, 2, 2 ] );
  216. expect( spy.calledOnce ).to.be.true;
  217. } );
  218. it( 'intersects on live range right side', () => {
  219. let moveSource = new Position( root, [ 0, 2, 1 ] );
  220. let moveRange = new Range( new Position( root, [ 2, 0 ] ), new Position( root, [ 2, 4 ] ) );
  221. let changes = {
  222. range: moveRange,
  223. sourcePosition: moveSource
  224. };
  225. doc.fire( 'change', 'move', changes, null );
  226. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  227. expect( live.end.path ).to.deep.equal( [ 0, 2, 1 ] );
  228. expect( spy.calledOnce ).to.be.true;
  229. } );
  230. it( 'intersects with live range and is moved into live range', () => {
  231. let moveSource = new Position( root, [ 0, 2, 1 ] );
  232. let moveRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 5 ] ) );
  233. let changes = {
  234. range: moveRange,
  235. sourcePosition: moveSource
  236. };
  237. doc.fire( 'change', 'move', changes, null );
  238. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  239. expect( live.end.path ).to.deep.equal( [ 0, 2, 6 ] );
  240. expect( spy.calledOnce ).to.be.true;
  241. } );
  242. it( 'is equal to live range', () => {
  243. live.end.path = [ 0, 1, 7 ];
  244. let moveSource = new Position( root, [ 0, 1, 4 ] );
  245. let moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 3 ] ) );
  246. let changes = {
  247. range: moveRange,
  248. sourcePosition: moveSource
  249. };
  250. doc.fire( 'change', 'move', changes, null );
  251. expect( live.start.path ).to.deep.equal( [ 0, 3, 0 ] );
  252. expect( live.end.path ).to.deep.equal( [ 0, 3, 3 ] );
  253. expect( spy.calledOnce ).to.be.true;
  254. } );
  255. it( 'contains live range', () => {
  256. live.end.path = [ 0, 1, 7 ];
  257. let moveSource = new Position( root, [ 0, 1, 3 ] );
  258. let moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 9 ] ) );
  259. let changes = {
  260. range: moveRange,
  261. sourcePosition: moveSource
  262. };
  263. doc.fire( 'change', 'move', changes, null );
  264. expect( live.start.path ).to.deep.equal( [ 0, 3, 1 ] );
  265. expect( live.end.path ).to.deep.equal( [ 0, 3, 4 ] );
  266. expect( spy.calledOnce ).to.be.true;
  267. } );
  268. it( 'is intersecting with live range and points to live range', () => {
  269. live.end.path = [ 0, 1, 12 ];
  270. let moveSource = new Position( root, [ 0, 1, 2 ] );
  271. let moveRange = new Range( new Position( root, [ 0, 1, 7 ] ), new Position( root, [ 0, 1, 10 ] ) );
  272. let changes = {
  273. range: moveRange,
  274. sourcePosition: moveSource
  275. };
  276. doc.fire( 'change', 'move', changes, null );
  277. expect( live.start.path ).to.deep.equal( [ 0, 1, 2 ] );
  278. expect( live.end.path ).to.deep.equal( [ 0, 1, 12 ] );
  279. expect( spy.calledOnce ).to.be.true;
  280. } );
  281. } );
  282. } );
  283. describe( 'should not get transformed if', () => {
  284. let otherRoot, spy;
  285. before( () => {
  286. otherRoot = doc.createRoot( '$root', 'otherRoot' );
  287. } );
  288. let live, clone;
  289. beforeEach( () => {
  290. live = new LiveRange( new Position( root, [ 0, 1, 4 ] ), new Position( root, [ 0, 2, 2 ] ) );
  291. clone = Range.createFromRange( live );
  292. spy = sinon.spy();
  293. live.on( 'change', spy );
  294. } );
  295. afterEach( () => {
  296. live.detach();
  297. } );
  298. describe( 'insertion', () => {
  299. it( 'is in the same parent as range start and after it', () => {
  300. let insertRange = new Range( new Position( root, [ 0, 1, 7 ] ), new Position( root, [ 0, 1, 9 ] ) );
  301. doc.fire( 'change', 'insert', { range: insertRange }, null );
  302. expect( live.isEqual( clone ) ).to.be.true;
  303. expect( spy.called ).to.be.false;
  304. } );
  305. it( 'is in the same parent as range end and after it', () => {
  306. let insertRange = new Range( new Position( root, [ 0, 2, 7 ] ), new Position( root, [ 0, 2, 9 ] ) );
  307. doc.fire( 'change', 'insert', { range: insertRange }, null );
  308. expect( live.isEqual( clone ) ).to.be.true;
  309. expect( spy.called ).to.be.false;
  310. } );
  311. it( 'is to a position after a node from range end path', () => {
  312. let insertRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 4 ] ) );
  313. doc.fire( 'change', 'insert', { range: insertRange }, null );
  314. expect( live.isEqual( clone ) ).to.be.true;
  315. expect( spy.called ).to.be.false;
  316. } );
  317. it( 'is in different root', () => {
  318. let insertRange = new Range( new Position( otherRoot, [ 0, 0 ] ), new Position( otherRoot, [ 0, 2 ] ) );
  319. doc.fire( 'change', 'insert', { range: insertRange }, null );
  320. expect( live.isEqual( clone ) ).to.be.true;
  321. expect( spy.called ).to.be.false;
  322. } );
  323. } );
  324. describe( 'range move', () => {
  325. it( 'is to the same parent as range start and after it', () => {
  326. let moveSource = new Position( root, [ 4 ] );
  327. let moveRange = new Range( new Position( root, [ 0, 1, 7 ] ), new Position( root, [ 0, 1, 9 ] ) );
  328. let changes = {
  329. range: moveRange,
  330. sourcePosition: moveSource
  331. };
  332. doc.fire( 'change', 'move', changes, null );
  333. expect( live.isEqual( clone ) ).to.be.true;
  334. expect( spy.called ).to.be.false;
  335. } );
  336. it( 'is to the same parent as range end and after it', () => {
  337. let moveSource = new Position( root, [ 4 ] );
  338. let moveRange = new Range( new Position( root, [ 0, 2, 3 ] ), new Position( root, [ 0, 2, 5 ] ) );
  339. let changes = {
  340. range: moveRange,
  341. sourcePosition: moveSource
  342. };
  343. doc.fire( 'change', 'move', changes, null );
  344. expect( live.isEqual( clone ) ).to.be.true;
  345. expect( spy.called ).to.be.false;
  346. } );
  347. it( 'is to a position after a node from range end path', () => {
  348. let moveSource = new Position( root, [ 4 ] );
  349. let moveRange = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 5 ] ) );
  350. let changes = {
  351. range: moveRange,
  352. sourcePosition: moveSource
  353. };
  354. doc.fire( 'change', 'move', changes, null );
  355. expect( live.isEqual( clone ) ).to.be.true;
  356. expect( spy.called ).to.be.false;
  357. } );
  358. it( 'is from the same parent as range start and after it', () => {
  359. let moveSource = new Position( root, [ 0, 1, 6 ] );
  360. let moveRange = new Range( new Position( root, [ 4, 0 ] ), new Position( root, [ 4, 3 ] ) );
  361. let changes = {
  362. range: moveRange,
  363. sourcePosition: moveSource
  364. };
  365. doc.fire( 'change', 'move', changes, null );
  366. expect( live.isEqual( clone ) ).to.be.true;
  367. expect( spy.called ).to.be.false;
  368. } );
  369. it( 'is from the same parent as range end and after it', () => {
  370. let moveSource = new Position( root, [ 0, 2, 4 ] );
  371. let moveRange = new Range( new Position( root, [ 4, 0 ] ), new Position( root, [ 4, 2 ] ) );
  372. let changes = {
  373. range: moveRange,
  374. sourcePosition: moveSource
  375. };
  376. doc.fire( 'change', 'move', changes, null );
  377. expect( live.isEqual( clone ) ).to.be.true;
  378. expect( spy.called ).to.be.false;
  379. } );
  380. it( 'is from a position after a node from range end path', () => {
  381. let moveSource = new Position( root, [ 0, 3 ] );
  382. let moveRange = new Range( new Position( root, [ 5, 0 ] ), new Position( root, [ 5, 1 ] ) );
  383. let changes = {
  384. range: moveRange,
  385. sourcePosition: moveSource
  386. };
  387. doc.fire( 'change', 'move', changes, null );
  388. expect( live.isEqual( clone ) ).to.be.true;
  389. expect( spy.called ).to.be.false;
  390. } );
  391. it( 'is to different root', () => {
  392. let moveSource = new Position( root, [ 2 ] );
  393. let moveRange = new Range( new Position( otherRoot, [ 0, 1, 0 ] ), new Position( otherRoot, [ 0, 1, 4 ] ) );
  394. let changes = {
  395. range: moveRange,
  396. sourcePosition: moveSource
  397. };
  398. doc.fire( 'change', 'move', changes, null );
  399. expect( live.isEqual( clone ) ).to.be.true;
  400. expect( spy.called ).to.be.false;
  401. } );
  402. it( 'is from different root', () => {
  403. let moveSource = new Position( otherRoot, [ 0, 2, 0 ] );
  404. let moveRange = new Range( new Position( root, [ 2, 0 ] ), new Position( root, [ 2, 2 ] ) );
  405. let changes = {
  406. range: moveRange,
  407. sourcePosition: moveSource
  408. };
  409. doc.fire( 'change', 'move', changes, null );
  410. expect( live.isEqual( clone ) ).to.be.true;
  411. expect( spy.called ).to.be.false;
  412. } );
  413. it( 'is inside live range and points to live range', () => {
  414. live.end.path = [ 0, 1, 12 ];
  415. let moveSource = new Position( root, [ 0, 1, 6 ] );
  416. let moveRange = new Range( new Position( root, [ 0, 1, 8 ] ), new Position( root, [ 0, 1, 10 ] ) );
  417. let changes = {
  418. range: moveRange,
  419. sourcePosition: moveSource
  420. };
  421. doc.fire( 'change', 'move', changes, null );
  422. expect( live.start.path ).to.deep.equal( [ 0, 1, 4 ] );
  423. expect( live.end.path ).to.deep.equal( [ 0, 1, 12 ] );
  424. expect( spy.calledOnce ).to.be.false;
  425. } );
  426. } );
  427. } );
  428. } );