mergedelta.js 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  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.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 treeModelTestUtils from '/tests/core/treemodel/_utils/utils.js';
  15. const getNodesAndText = treeModelTestUtils.getNodesAndText;
  16. import {
  17. applyDelta,
  18. expectDelta,
  19. getFilledDocument,
  20. getInsertDelta,
  21. getMergeDelta,
  22. getMoveDelta
  23. } from '/tests/core/treemodel/delta/transform/_utils/utils.js';
  24. describe( 'transform', () => {
  25. let doc, root, gy, baseVersion;
  26. beforeEach( () => {
  27. doc = getFilledDocument();
  28. root = doc.getRoot( 'root' );
  29. gy = doc.graveyard;
  30. baseVersion = doc.version;
  31. } );
  32. describe( 'MergeDelta by', () => {
  33. let mergeDelta, mergePosition;
  34. beforeEach( () => {
  35. mergePosition = new Position( root, [ 3, 3, 3 ] );
  36. mergeDelta = getMergeDelta( mergePosition, 4, 12, baseVersion );
  37. } );
  38. describe( 'InsertDelta', () => {
  39. let nodeA, nodeB;
  40. beforeEach( () => {
  41. nodeA = new Element( 'a' );
  42. nodeB = new Element( 'b' );
  43. } );
  44. it( 'insert at same position as merge', () => {
  45. let insertDelta = getInsertDelta( mergePosition, [ nodeA, nodeB ], baseVersion );
  46. let transformed = transform( mergeDelta, insertDelta );
  47. // Expected: MergeDelta gets ignored and is not applied.
  48. expect( transformed.length ).to.equal( 1 );
  49. expectDelta( transformed[ 0 ], {
  50. type: Delta,
  51. operations: []
  52. } );
  53. // Test if deltas do what they should after applying transformed delta.
  54. applyDelta( insertDelta, doc );
  55. applyDelta( transformed[ 0 ], doc );
  56. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 6 ) );
  57. // InsertDelta is applied. Merge between X and P is discarded.
  58. expect( nodesAndText ).to.equal( 'XXXXXabcdXAABBPabcfoobarxyzP' );
  59. } );
  60. it( 'insert inside merged node (sticky move test)', () => {
  61. let insertDelta = getInsertDelta( new Position( root, [ 3, 3, 3, 12 ] ), [ nodeA, nodeB ], baseVersion );
  62. let transformed = transform( mergeDelta, insertDelta );
  63. baseVersion = insertDelta.operations.length;
  64. expect( transformed.length ).to.equal( 1 );
  65. // Expected: MoveOperation in MergeDelta has it's "range" expanded.
  66. expectDelta( transformed[ 0 ], {
  67. type: MergeDelta,
  68. operations: [
  69. {
  70. type: MoveOperation,
  71. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  72. howMany: 14,
  73. targetPosition: new Position( root, [ 3, 3, 2, 4 ] ),
  74. baseVersion: baseVersion
  75. },
  76. {
  77. // This is `MoveOperation` instead of `RemoveOperation` because during OT,
  78. // `RemoveOperation` may get converted to `MoveOperation`. Still, this expectation is
  79. // correct because `RemoveOperation` is deriving from `MoveOperation`. So we can expect
  80. // that something that was `RemoveOperation` is a `MoveOperation`.
  81. type: MoveOperation,
  82. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  83. howMany: 1,
  84. targetPosition: new Position( gy, [ 0 ] ),
  85. baseVersion: baseVersion + 1
  86. }
  87. ]
  88. } );
  89. // Test if deltas do what they should after applying transformed delta.
  90. applyDelta( insertDelta, doc );
  91. applyDelta( transformed[ 0 ], doc );
  92. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3, 0 ] ), 3 ) );
  93. // InsertDelta is applied. Merge between X and P is discarded.
  94. expect( nodesAndText ).to.equal( 'XXXXXabcdabcfoobarxyzAABBX' );
  95. } );
  96. } );
  97. describe( 'by MoveDelta', () => {
  98. it( 'node on the right side of merge was moved', () => {
  99. let moveDelta = getMoveDelta( new Position( root, [ 3, 3, 3 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  100. let transformed = transform( mergeDelta, moveDelta );
  101. expect( transformed.length ).to.equal( 1 );
  102. expectDelta( transformed[ 0 ], {
  103. type: Delta,
  104. operations: []
  105. } );
  106. // Test if deltas do what they should after applying transformed delta.
  107. applyDelta( moveDelta, doc );
  108. applyDelta( transformed[ 0 ], doc );
  109. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  110. // MoveDelta is applied. MergeDelta is discarded.
  111. expect( nodesAndText ).to.equal( 'DIVPabcfoobarxyzPXXXXXabcdXDIV' );
  112. } );
  113. it( 'node on the left side of merge was moved', () => {
  114. let moveDelta = getMoveDelta( new Position( root, [ 3, 3, 2 ] ), 1, new Position( root, [ 3, 3, 0 ] ), baseVersion );
  115. let transformed = transform( mergeDelta, moveDelta );
  116. expect( transformed.length ).to.equal( 1 );
  117. baseVersion = moveDelta.operations.length;
  118. expectDelta( transformed[ 0 ], {
  119. type: MergeDelta,
  120. operations: [
  121. {
  122. type: MoveOperation,
  123. sourcePosition: new Position( root, [ 3, 3, 3, 0 ] ),
  124. howMany: 12,
  125. targetPosition: new Position( root, [ 3, 3, 0, 4 ] ),
  126. baseVersion: baseVersion
  127. },
  128. {
  129. // This is `MoveOperation` instead of `RemoveOperation` because during OT,
  130. // `RemoveOperation` may get converted to `MoveOperation`. Still, this expectation is
  131. // correct because `RemoveOperation` is deriving from `MoveOperation`. So we can expect
  132. // that something that was `RemoveOperation` is a `MoveOperation`.
  133. type: MoveOperation,
  134. sourcePosition: new Position( root, [ 3, 3, 3 ] ),
  135. howMany: 1,
  136. targetPosition: new Position( gy, [ 0 ] ),
  137. baseVersion: baseVersion + 1
  138. }
  139. ]
  140. } );
  141. // Test if deltas do what they should after applying transformed delta.
  142. applyDelta( moveDelta, doc );
  143. applyDelta( transformed[ 0 ], doc );
  144. let nodesAndText = getNodesAndText( Range.createFromPositionAndShift( new Position( root, [ 3, 3 ] ), 1 ) );
  145. // MoveDelta is applied. MergeDelta is discarded.
  146. expect( nodesAndText ).to.equal( 'DIVXabcdabcfoobarxyzXXXXXDIV' );
  147. } );
  148. } );
  149. } );
  150. } );