mergedelta.js 8.6 KB

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