mergedelta.js 8.5 KB

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