mergedelta.js 8.5 KB

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