8
0

splitoperation.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../../src/model/model';
  6. import SplitOperation from '../../../src/model/operation/splitoperation';
  7. import MergeOperation from '../../../src/model/operation/mergeoperation';
  8. import Position from '../../../src/model/position';
  9. import Element from '../../../src/model/element';
  10. import Text from '../../../src/model/text';
  11. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  12. describe( 'SplitOperation', () => {
  13. let model, doc, root, gy, gyPos;
  14. beforeEach( () => {
  15. model = new Model();
  16. doc = model.document;
  17. root = doc.createRoot();
  18. gy = doc.graveyard;
  19. gyPos = new Position( gy, [ 0 ] );
  20. } );
  21. it( 'should have proper type', () => {
  22. const position = new Position( root, [ 1, 3 ] );
  23. const insertionPosition = SplitOperation.getInsertionPosition( position );
  24. const split = new SplitOperation( position, 2, insertionPosition, null, 1 );
  25. expect( split.type ).to.equal( 'split' );
  26. } );
  27. it( 'should have proper insertionPosition', () => {
  28. const position = new Position( root, [ 1, 3 ] );
  29. const insertionPosition = SplitOperation.getInsertionPosition( position );
  30. const split = new SplitOperation( position, 2, insertionPosition, null, 1 );
  31. expect( split.insertionPosition.path ).to.deep.equal( [ 2 ] );
  32. } );
  33. it( 'should have proper moveTargetPosition', () => {
  34. const position = new Position( root, [ 1, 3 ] );
  35. const insertionPosition = SplitOperation.getInsertionPosition( position );
  36. const split = new SplitOperation( position, 2, insertionPosition, null, 1 );
  37. expect( split.moveTargetPosition.path ).to.deep.equal( [ 2, 0 ] );
  38. } );
  39. it( 'should have proper movedRange', () => {
  40. const position = new Position( root, [ 1, 3 ] );
  41. const insertionPosition = SplitOperation.getInsertionPosition( position );
  42. const split = new SplitOperation( position, 2, insertionPosition, null, 1 );
  43. expect( split.movedRange.start.path ).to.deep.equal( [ 1, 3 ] );
  44. expect( split.movedRange.end.path ).to.deep.equal( [ 1, Number.POSITIVE_INFINITY ] );
  45. } );
  46. it( 'should split an element', () => {
  47. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  48. root._insertChild( 0, [ p1 ] );
  49. const position = new Position( root, [ 0, 3 ] );
  50. const insertionPosition = SplitOperation.getInsertionPosition( position );
  51. model.applyOperation( new SplitOperation( position, 3, insertionPosition, null, doc.version ) );
  52. expect( doc.version ).to.equal( 1 );
  53. expect( root.maxOffset ).to.equal( 2 );
  54. expect( root.getChild( 0 ).name ).to.equal( 'p1' );
  55. expect( root.getChild( 1 ).name ).to.equal( 'p1' );
  56. expect( p1.maxOffset ).to.equal( 3 );
  57. expect( p1.getChild( 0 ).data ).to.equal( 'Foo' );
  58. expect( root.getChild( 1 ).maxOffset ).to.equal( 3 );
  59. expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'bar' );
  60. } );
  61. it( 'should split an element using graveyard element', () => {
  62. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  63. const p2 = new Element( 'p2' );
  64. root._insertChild( 0, [ p1 ] );
  65. gy._insertChild( 0, [ p2 ] );
  66. const position = new Position( root, [ 0, 3 ] );
  67. const insertionPosition = SplitOperation.getInsertionPosition( position );
  68. model.applyOperation( new SplitOperation( position, 3, insertionPosition, gyPos, doc.version ) );
  69. expect( doc.version ).to.equal( 1 );
  70. expect( root.maxOffset ).to.equal( 2 );
  71. expect( root.getChild( 0 ).name ).to.equal( 'p1' );
  72. expect( root.getChild( 1 ).name ).to.equal( 'p2' );
  73. expect( p1.maxOffset ).to.equal( 3 );
  74. expect( p1.getChild( 0 ).data ).to.equal( 'Foo' );
  75. expect( root.getChild( 1 ).maxOffset ).to.equal( 3 );
  76. expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'bar' );
  77. expect( gy.maxOffset ).to.equal( 0 );
  78. } );
  79. it( 'should create a proper MergeOperation as a reverse', () => {
  80. const position = new Position( root, [ 1, 3 ] );
  81. const insertionPosition = SplitOperation.getInsertionPosition( position );
  82. const operation = new SplitOperation( position, 3, insertionPosition, null, doc.version );
  83. const reverse = operation.getReversed();
  84. expect( reverse ).to.be.an.instanceof( MergeOperation );
  85. expect( reverse.baseVersion ).to.equal( 1 );
  86. expect( reverse.howMany ).to.equal( 3 );
  87. expect( reverse.sourcePosition.isEqual( new Position( root, [ 2, 0 ] ) ) ).to.be.true;
  88. expect( reverse.targetPosition.isEqual( new Position( root, [ 1, 3 ] ) ) ).to.be.true;
  89. expect( reverse.graveyardPosition.isEqual( gyPos ) ).to.be.true;
  90. } );
  91. it( 'should undo split by applying reverse operation', () => {
  92. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  93. root._insertChild( 0, [ p1 ] );
  94. const position = new Position( root, [ 0, 3 ] );
  95. const insertionPosition = SplitOperation.getInsertionPosition( position );
  96. const operation = new SplitOperation( position, 3, insertionPosition, null, doc.version );
  97. model.applyOperation( operation );
  98. model.applyOperation( operation.getReversed() );
  99. expect( doc.version ).to.equal( 2 );
  100. expect( root.maxOffset ).to.equal( 1 );
  101. expect( p1.maxOffset ).to.equal( 6 );
  102. expect( p1.getChild( 0 ).data ).to.equal( 'Foobar' );
  103. } );
  104. describe( '_validate()', () => {
  105. it( 'should throw an error if split position is invalid', () => {
  106. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  107. root._insertChild( 0, [ p1 ] );
  108. const position = new Position( root, [ 0, 8 ] );
  109. const insertionPosition = SplitOperation.getInsertionPosition( position );
  110. const operation = new SplitOperation( position, 3, insertionPosition, null, doc.version );
  111. expect( () => operation._validate() ).to.throw( CKEditorError, /split-operation-position-invalid/ );
  112. } );
  113. it( 'should throw an error if split position is in root', () => {
  114. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  115. root._insertChild( 0, [ p1 ] );
  116. const operation = new SplitOperation( new Position( root, [ 1 ] ), 3, new Position( root, [ 2 ] ), null, doc.version );
  117. expect( () => operation._validate() ).to.throw( CKEditorError, /split-operation-split-in-root/ );
  118. } );
  119. it( 'should throw an error if number of nodes to move is invalid', () => {
  120. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  121. root._insertChild( 0, [ p1 ] );
  122. const operation = new SplitOperation( new Position( root, [ 0, 2 ] ), 6, new Position( root, [ 1 ] ), null, doc.version );
  123. expect( () => operation._validate() ).to.throw( CKEditorError, /split-operation-how-many-invalid/ );
  124. } );
  125. it( 'should throw an error if graveyard position is invalid', () => {
  126. const p1 = new Element( 'p1', null, new Text( 'Foobar' ) );
  127. root._insertChild( 0, [ p1 ] );
  128. const operation = new SplitOperation( new Position( root, [ 0, 2 ] ), 4, new Position( root, [ 1 ] ), gyPos, doc.version );
  129. expect( () => operation._validate() ).to.throw( CKEditorError, /split-operation-graveyard-position-invalid/ );
  130. } );
  131. } );
  132. it( 'should create SplitOperation with the same parameters when cloned #1', () => {
  133. const position = new Position( root, [ 1, 2 ] );
  134. const insertionPosition = SplitOperation.getInsertionPosition( position );
  135. const howMany = 4;
  136. const baseVersion = doc.version;
  137. const op = new SplitOperation( position, howMany, insertionPosition, null, baseVersion );
  138. const clone = op.clone();
  139. // New instance rather than a pointer to the old instance.
  140. expect( clone ).not.to.be.equal( op );
  141. expect( clone ).to.be.instanceof( SplitOperation );
  142. expect( clone.splitPosition.isEqual( position ) ).to.be.true;
  143. expect( clone.howMany ).to.equal( howMany );
  144. expect( clone.insertionPosition.isEqual( insertionPosition ) );
  145. expect( clone.graveyardPosition ).to.be.null;
  146. expect( clone.baseVersion ).to.equal( baseVersion );
  147. } );
  148. it( 'should create SplitOperation with the same parameters when cloned #2', () => {
  149. const position = new Position( root, [ 1, 2 ] );
  150. const insertionPosition = SplitOperation.getInsertionPosition( position );
  151. const howMany = 4;
  152. const baseVersion = doc.version;
  153. const op = new SplitOperation( position, howMany, insertionPosition, gyPos, baseVersion );
  154. const clone = op.clone();
  155. // New instance rather than a pointer to the old instance.
  156. expect( clone ).not.to.be.equal( op );
  157. expect( clone ).to.be.instanceof( SplitOperation );
  158. expect( clone.splitPosition.isEqual( position ) ).to.be.true;
  159. expect( clone.howMany ).to.equal( howMany );
  160. expect( clone.insertionPosition.isEqual( insertionPosition ) );
  161. expect( clone.graveyardPosition.isEqual( gyPos ) ).to.be.true;
  162. expect( clone.baseVersion ).to.equal( baseVersion );
  163. } );
  164. describe( 'toJSON', () => {
  165. it( 'should create proper json object #1', () => {
  166. const position = new Position( root, [ 0, 3 ] );
  167. const insertionPosition = SplitOperation.getInsertionPosition( position );
  168. const op = new SplitOperation( position, 2, insertionPosition, null, doc.version );
  169. const serialized = op.toJSON();
  170. expect( serialized ).to.deep.equal( {
  171. __className: 'SplitOperation',
  172. baseVersion: 0,
  173. howMany: 2,
  174. splitPosition: op.splitPosition.toJSON(),
  175. insertionPosition: op.insertionPosition.toJSON(),
  176. graveyardPosition: null
  177. } );
  178. } );
  179. it( 'should create proper json object #2', () => {
  180. const position = new Position( root, [ 0, 3 ] );
  181. const insertionPosition = SplitOperation.getInsertionPosition( position );
  182. const op = new SplitOperation( position, 2, insertionPosition, gyPos, doc.version );
  183. const serialized = op.toJSON();
  184. expect( serialized ).to.deep.equal( {
  185. __className: 'SplitOperation',
  186. baseVersion: 0,
  187. howMany: 2,
  188. splitPosition: op.splitPosition.toJSON(),
  189. insertionPosition: op.insertionPosition.toJSON(),
  190. graveyardPosition: op.graveyardPosition.toJSON()
  191. } );
  192. } );
  193. } );
  194. describe( 'fromJSON', () => {
  195. it( 'should create proper SplitOperation from json object #1', () => {
  196. const position = new Position( root, [ 0, 3 ] );
  197. const insertionPosition = SplitOperation.getInsertionPosition( position );
  198. const op = new SplitOperation( position, 2, insertionPosition, null, doc.version );
  199. const serialized = op.toJSON();
  200. const deserialized = SplitOperation.fromJSON( serialized, doc );
  201. expect( deserialized ).to.deep.equal( op );
  202. } );
  203. it( 'should create proper SplitOperation from json object #2', () => {
  204. const position = new Position( root, [ 0, 3 ] );
  205. const insertionPosition = SplitOperation.getInsertionPosition( position );
  206. const op = new SplitOperation( position, 2, insertionPosition, gyPos, doc.version );
  207. const serialized = op.toJSON();
  208. const deserialized = SplitOperation.fromJSON( serialized, doc );
  209. expect( deserialized ).to.deep.equal( op );
  210. } );
  211. } );
  212. } );