mergedelta.js 8.5 KB

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