mergedelta.js 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: model, operation */
  6. 'use strict';
  7. import transformations from '/ckeditor5/engine/model/delta/basic-transformations.js';
  8. /*jshint unused: false*/
  9. import transform from '/ckeditor5/engine/model/delta/transform.js';
  10. import Element from '/ckeditor5/engine/model/element.js';
  11. import Position from '/ckeditor5/engine/model/position.js';
  12. import Range from '/ckeditor5/engine/model/range.js';
  13. import Delta from '/ckeditor5/engine/model/delta/delta.js';
  14. import MergeDelta from '/ckeditor5/engine/model/delta/mergedelta.js';
  15. import MoveOperation from '/ckeditor5/engine/model/operation/moveoperation.js';
  16. import RemoveOperation from '/ckeditor5/engine/model/operation/removeoperation.js';
  17. import NoOperation from '/ckeditor5/engine/model/operation/nooperation.js';
  18. import { getNodesAndText, jsonParseStringify } from '/tests/engine/model/_utils/utils.js';
  19. import {
  20. applyDelta,
  21. expectDelta,
  22. getFilledDocument,
  23. getInsertDelta,
  24. getMergeDelta,
  25. getMoveDelta
  26. } from '/tests/engine/model/delta/transform/_utils/utils.js';
  27. describe( 'transform', () => {
  28. let doc, root, gy, baseVersion;
  29. beforeEach( () => {
  30. doc = getFilledDocument();
  31. root = doc.getRoot();
  32. gy = doc.graveyard;
  33. baseVersion = doc.version;
  34. } );
  35. describe( 'MergeDelta by', () => {
  36. let mergeDelta, mergePosition;
  37. beforeEach( () => {
  38. mergePosition = new Position( root, [ 3, 3, 3 ] );
  39. mergeDelta = getMergeDelta( mergePosition, 4, 12, baseVersion );
  40. } );
  41. describe( 'InsertDelta', () => {
  42. let nodeA, nodeB;
  43. beforeEach( () => {
  44. nodeA = new Element( 'a' );
  45. nodeB = new Element( 'b' );
  46. } );
  47. it( 'insert at same position as merge', () => {
  48. let insertDelta = getInsertDelta( mergePosition, [ nodeA, nodeB ], baseVersion );
  49. let transformed = transform( mergeDelta, insertDelta );
  50. // Expected: MergeDelta gets ignored and is not applied.
  51. baseVersion = insertDelta.operations.length;
  52. expect( transformed.length ).to.equal( 1 );
  53. expectDelta( transformed[ 0 ], {
  54. type: Delta,
  55. operations: [
  56. {
  57. type: NoOperation,
  58. baseVersion: baseVersion
  59. }
  60. ]
  61. } );
  62. // Test if deltas do what they should after applying transformed delta.
  63. applyDelta( insertDelta, doc );
  64. applyDelta( transformed[ 0 ], doc );
  65. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 6 ) );
  66. // InsertDelta is applied. Merge between X and P is discarded.
  67. expect( nodesAndText ).to.equal( 'XXXXXabcdXAABBPabcfoobarxyzP' );
  68. } );
  69. it( 'insert inside merged node (sticky move test)', () => {
  70. let insertDelta = getInsertDelta( new Position( root, [ 3, 3, 3, 12 ] ), [ nodeA, nodeB ], baseVersion );
  71. let transformed = transform( mergeDelta, insertDelta );
  72. baseVersion = insertDelta.operations.length;
  73. expect( transformed.length ).to.equal( 1 );
  74. // Expected: MoveOperation in MergeDelta has it's "range" expanded.
  75. expectDelta( transformed[ 0 ], {
  76. type: MergeDelta,
  77. operations: [
  78. {
  79. type: MoveOperation,
  80. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  81. howMany: 14,
  82. targetPosition: new Position( root, [ 3, 3, 2, 4 ] ),
  83. baseVersion: baseVersion
  84. },
  85. {
  86. type: RemoveOperation,
  87. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  88. howMany: 1,
  89. targetPosition: new Position( gy, [ 0, 0 ] ),
  90. baseVersion: baseVersion + 1
  91. }
  92. ]
  93. } );
  94. // Test if deltas do what they should after applying transformed delta.
  95. applyDelta( insertDelta, doc );
  96. applyDelta( transformed[ 0 ], doc );
  97. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 3 ) );
  98. // InsertDelta is applied. Merge between X and P is discarded.
  99. expect( nodesAndText ).to.equal( 'XXXXXabcdabcfoobarxyzAABBX' );
  100. } );
  101. } );
  102. describe( 'MoveDelta', () => {
  103. it( 'node on the right side of merge was moved', () => {
  104. let moveDelta = getMoveDelta( new Position( root, [ 3, 3, 3 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  105. let transformed = transform( mergeDelta, moveDelta );
  106. baseVersion = moveDelta.operations.length;
  107. expect( transformed.length ).to.equal( 1 );
  108. expectDelta( transformed[ 0 ], {
  109. type: Delta,
  110. operations: [
  111. {
  112. type: NoOperation,
  113. baseVersion: baseVersion
  114. }
  115. ]
  116. } );
  117. // Test if deltas do what they should after applying transformed delta.
  118. applyDelta( moveDelta, doc );
  119. applyDelta( transformed[ 0 ], doc );
  120. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  121. // MoveDelta is applied. MergeDelta is discarded.
  122. expect( nodesAndText ).to.equal( 'DIVPabcfoobarxyzPXXXXXabcdXDIV' );
  123. } );
  124. it( 'node on the left side of merge was moved', () => {
  125. let moveDelta = getMoveDelta( new Position( root, [ 3, 3, 2 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  126. let transformed = transform( mergeDelta, moveDelta );
  127. expect( transformed.length ).to.equal( 1 );
  128. baseVersion = moveDelta.operations.length;
  129. expectDelta( transformed[ 0 ], {
  130. type: MergeDelta,
  131. operations: [
  132. {
  133. type: MoveOperation,
  134. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  135. howMany: 12,
  136. targetPosition: new Position( root, [ 3, 3, 0, 4 ] ),
  137. baseVersion: baseVersion
  138. },
  139. {
  140. type: RemoveOperation,
  141. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  142. howMany: 1,
  143. baseVersion: baseVersion + 1
  144. }
  145. ]
  146. } );
  147. // Test if deltas do what they should after applying transformed delta.
  148. applyDelta( moveDelta, doc );
  149. applyDelta( transformed[ 0 ], doc );
  150. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  151. // MoveDelta is applied. MergeDelta is discarded.
  152. expect( nodesAndText ).to.equal( 'DIVXabcdabcfoobarxyzXXXXXDIV' );
  153. } );
  154. } );
  155. describe( 'MergeDelta', () => {
  156. it( 'merge two consecutive elements, transformed merge is after', () => {
  157. let mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  158. let transformed = transform( mergeDelta, mergeDeltaB );
  159. expect( transformed.length ).to.equal( 1 );
  160. baseVersion = mergeDelta.operations.length;
  161. expectDelta( transformed[ 0 ], {
  162. type: MergeDelta,
  163. operations: [
  164. {
  165. type: MoveOperation,
  166. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  167. howMany: 12,
  168. targetPosition: new Position( root, [ 3, 3, 1, 4 ] ),
  169. baseVersion: baseVersion
  170. },
  171. {
  172. type: RemoveOperation,
  173. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  174. howMany: 1
  175. }
  176. ]
  177. } );
  178. // Test if deltas do what they should after applying transformed delta.
  179. applyDelta( mergeDeltaB, doc );
  180. applyDelta( transformed[ 0 ], doc );
  181. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  182. // Both merge deltas are applied and merged nodes children are together in one node.
  183. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  184. } );
  185. it( 'merge two consecutive elements, transformed merge is before', () => {
  186. mergeDelta = getMergeDelta( new Position( root, [ 3, 3, 2 ] ), 0, 4, baseVersion );
  187. let mergeDeltaB = getMergeDelta( new Position( root, [ 3, 3, 3 ] ), 4, 12, baseVersion );
  188. let transformed = transform( mergeDelta, mergeDeltaB );
  189. expect( transformed.length ).to.equal( 1 );
  190. baseVersion = mergeDelta.operations.length;
  191. expectDelta( transformed[ 0 ], {
  192. type: MergeDelta,
  193. operations: [
  194. {
  195. type: MoveOperation,
  196. sourcePosition: new Position( root, [ 3, 3, 2, 0 ] ),
  197. howMany: 16,
  198. targetPosition: new Position( root, [ 3, 3, 1, 0 ] ),
  199. baseVersion: baseVersion
  200. },
  201. {
  202. type: RemoveOperation,
  203. sourcePosition: new Position( root, [ 3, 3, 2 ] ),
  204. howMany: 1
  205. }
  206. ]
  207. } );
  208. // Test if deltas do what they should after applying transformed delta.
  209. applyDelta( mergeDeltaB, doc );
  210. applyDelta( transformed[ 0 ], doc );
  211. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 2 ) );
  212. // Both merge deltas are applied and merged nodes children are together in one node.
  213. expect( nodesAndText ).to.equal( 'XXXabcdabcfoobarxyzX' );
  214. } );
  215. } );
  216. } );
  217. } );