8
0

insertoperation.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: document */
  6. /* global describe, before, beforeEach, it, expect */
  7. 'use strict';
  8. const modules = bender.amd.require(
  9. 'document/document',
  10. 'document/node',
  11. 'document/nodelist',
  12. 'document/operation/insertoperation',
  13. 'document/operation/removeoperation',
  14. 'document/operation/changeoperation',
  15. 'document/operation/moveoperation',
  16. 'document/operation/nooperation',
  17. 'document/position',
  18. 'document/range',
  19. 'document/character',
  20. 'document/nodelist',
  21. 'document/attribute'
  22. );
  23. describe( 'InsertOperation', () => {
  24. let Document, Node, NodeList, InsertOperation, RemoveOperation, ChangeOperation,
  25. MoveOperation, NoOperation, Position, Range, Character, Attribute;
  26. before( () => {
  27. Document = modules[ 'document/document' ];
  28. Node = modules[ 'document/node' ];
  29. NodeList = modules[ 'document/nodelist' ];
  30. InsertOperation = modules[ 'document/operation/insertoperation' ];
  31. RemoveOperation = modules[ 'document/operation/removeoperation' ];
  32. ChangeOperation = modules[ 'document/operation/changeoperation' ];
  33. MoveOperation = modules[ 'document/operation/moveoperation' ];
  34. NoOperation = modules[ 'document/operation/nooperation' ];
  35. Position = modules[ 'document/position' ];
  36. Range = modules[ 'document/range' ];
  37. Character = modules[ 'document/character' ];
  38. Attribute = modules[ 'document/attribute' ];
  39. } );
  40. let doc, root;
  41. beforeEach( () => {
  42. doc = new Document();
  43. root = doc.createRoot( 'root' );
  44. } );
  45. it( 'should insert node', () => {
  46. doc.applyOperation(
  47. new InsertOperation(
  48. new Position( [ 0 ], root ),
  49. new Character( 'x' ),
  50. doc.version
  51. )
  52. );
  53. expect( doc.version ).to.equal( 1 );
  54. expect( root.getChildCount() ).to.equal( 1 );
  55. expect( root.getChild( 0 ).character ).to.equal( 'x' );
  56. } );
  57. it( 'should insert set of nodes', () => {
  58. doc.applyOperation(
  59. new InsertOperation(
  60. new Position( [ 0 ], root ),
  61. 'bar',
  62. doc.version
  63. )
  64. );
  65. expect( doc.version ).to.equal( 1 );
  66. expect( root.getChildCount() ).to.equal( 3 );
  67. expect( root.getChild( 0 ).character ).to.equal( 'b' );
  68. expect( root.getChild( 1 ).character ).to.equal( 'a' );
  69. expect( root.getChild( 2 ).character ).to.equal( 'r' );
  70. } );
  71. it( 'should insert between existing nodes', () => {
  72. root.insertChildren( 0, 'xy' );
  73. doc.applyOperation(
  74. new InsertOperation(
  75. new Position( [ 1 ], root ),
  76. 'bar',
  77. doc.version
  78. )
  79. );
  80. expect( doc.version ).to.equal( 1 );
  81. expect( root.getChildCount() ).to.equal( 5 );
  82. expect( root.getChild( 0 ).character ).to.equal( 'x' );
  83. expect( root.getChild( 1 ).character ).to.equal( 'b' );
  84. expect( root.getChild( 2 ).character ).to.equal( 'a' );
  85. expect( root.getChild( 3 ).character ).to.equal( 'r' );
  86. expect( root.getChild( 4 ).character ).to.equal( 'y' );
  87. } );
  88. it( 'should insert text', () => {
  89. doc.applyOperation(
  90. new InsertOperation(
  91. new Position( [ 0 ], root ),
  92. [ 'foo', new Character( 'x' ), 'bar' ],
  93. doc.version
  94. )
  95. );
  96. expect( doc.version ).to.equal( 1 );
  97. expect( root.getChildCount() ).to.equal( 7 );
  98. expect( root.getChild( 0 ).character ).to.equal( 'f' );
  99. expect( root.getChild( 1 ).character ).to.equal( 'o' );
  100. expect( root.getChild( 2 ).character ).to.equal( 'o' );
  101. expect( root.getChild( 3 ).character ).to.equal( 'x' );
  102. expect( root.getChild( 4 ).character ).to.equal( 'b' );
  103. expect( root.getChild( 5 ).character ).to.equal( 'a' );
  104. expect( root.getChild( 6 ).character ).to.equal( 'r' );
  105. } );
  106. it( 'should create a remove operation as a reverse', () => {
  107. let position = new Position( [ 0 ], root );
  108. let operation = new InsertOperation(
  109. position,
  110. [ 'foo', new Character( 'x' ), 'bar' ],
  111. 0
  112. );
  113. let reverse = operation.getReversed();
  114. expect( reverse ).to.be.an.instanceof( RemoveOperation );
  115. expect( reverse.baseVersion ).to.equal( 1 );
  116. expect( reverse.sourcePosition ).to.equal( position );
  117. expect( reverse.howMany ).to.equal( 7 );
  118. } );
  119. it( 'should undo insert node by applying reverse operation', () => {
  120. let operation = new InsertOperation(
  121. new Position( [ 0 ], root ),
  122. new Character( 'x' ),
  123. doc.version
  124. );
  125. let reverse = operation.getReversed();
  126. doc.applyOperation( operation );
  127. expect( doc.version ).to.equal( 1 );
  128. doc.applyOperation( reverse );
  129. expect( doc.version ).to.equal( 2 );
  130. expect( root.getChildCount() ).to.equal( 0 );
  131. } );
  132. it( 'should undo insert set of nodes by applying reverse operation', () => {
  133. let operation = new InsertOperation(
  134. new Position( [ 0 ], root ),
  135. 'bar',
  136. doc.version
  137. );
  138. let reverse = operation.getReversed();
  139. doc.applyOperation( operation );
  140. expect( doc.version ).to.equal( 1 );
  141. doc.applyOperation( reverse );
  142. expect( doc.version ).to.equal( 2 );
  143. expect( root.getChildCount() ).to.equal( 0 );
  144. } );
  145. it( 'should create operation with the same parameters when cloned', () => {
  146. let position = new Position( [ 0 ], root );
  147. let nodeA = new Node();
  148. let nodeB = new Node();
  149. let nodes = new NodeList( [ nodeA, nodeB ] );
  150. let baseVersion = doc.version;
  151. let op = new InsertOperation( position, nodes, baseVersion );
  152. let clone = op.clone();
  153. // New instance rather than a pointer to the old instance.
  154. expect( clone ).not.to.be.equal( op );
  155. expect( clone ).to.be.instanceof( InsertOperation );
  156. expect( clone.position.isEqual( position ) ).to.be.true;
  157. expect( clone.nodeList.get( 0 ) ).to.equal( nodeA );
  158. expect( clone.nodeList.get( 1 ) ).to.equal( nodeB );
  159. expect( clone.nodeList.length ).to.equal( 2 );
  160. expect( clone.baseVersion ).to.equal( baseVersion );
  161. } );
  162. describe( 'getTransformedBy', () => {
  163. let nodeA, nodeB, nodeC, nodeD, position, op, baseVersion, expected;
  164. beforeEach( () => {
  165. nodeA = new Node();
  166. nodeB = new Node();
  167. nodeC = new Node();
  168. nodeD = new Node();
  169. baseVersion = doc.version;
  170. position = new Position( [ 0, 2, 1 ], root );
  171. op = new InsertOperation( position, [ nodeA, nodeB ], baseVersion );
  172. expected = {
  173. type: InsertOperation,
  174. position: position.clone(),
  175. baseVersion: baseVersion + 1
  176. };
  177. } );
  178. function expectOperation( op, params ) {
  179. for ( let i in params ) {
  180. if ( params.hasOwnProperty( i ) ) {
  181. if ( i == 'type' ) {
  182. expect( op ).to.be.instanceof( params[ i ] );
  183. }
  184. else if ( params[ i ] instanceof Array ) {
  185. expect( op[ i ].length ).to.equal( params[ i ].length );
  186. for ( let j = 0; j < params[ i ].length; j++ ) {
  187. expect( op[ i ][ j ] ).to.equal( params[ i ][ j ] );
  188. }
  189. } else if ( params[ i ] instanceof Position || params[ i ] instanceof Range ) {
  190. expect( op[ i ].isEqual( params[ i ] ) ).to.be.true;
  191. } else {
  192. expect( op[ i ] ).to.equal( params[ i ] );
  193. }
  194. }
  195. }
  196. }
  197. describe( 'InsertOperation', () => {
  198. it( 'should not change when positions are different', () => {
  199. let transformBy = new InsertOperation(
  200. new Position( [ 1, 3, 2 ], root ),
  201. [ nodeC, nodeD ],
  202. baseVersion
  203. );
  204. let transOp = op.getTransformedBy( transformBy );
  205. expectOperation( transOp[ 0 ], expected );
  206. } );
  207. it( 'should increment offset if addresses are same and offset is after applied operation', () => {
  208. let transformBy = new InsertOperation(
  209. new Position( [ 0, 2, 0 ], root ),
  210. [ nodeC, nodeD ],
  211. baseVersion
  212. );
  213. let transOp = op.getTransformedBy( transformBy );
  214. expected.position.offset += 2;
  215. expectOperation( transOp[ 0 ], expected );
  216. } );
  217. it( 'should increment offset if positions are same and operation to transform is weaker', () => {
  218. let transformBy = new InsertOperation(
  219. new Position( [ 0, 2, 1 ], root ),
  220. [ nodeC, nodeD ],
  221. baseVersion
  222. );
  223. let transOp = op.getTransformedBy( transformBy );
  224. expected.position.offset += 2;
  225. expectOperation( transOp[ 0 ], expected );
  226. } );
  227. it( 'should not increment offset if positions are same and operation to transform is stronger', () => {
  228. let transformBy = new InsertOperation(
  229. new Position( [ 0, 2, 1 ], root ),
  230. [ nodeC, nodeD ],
  231. baseVersion
  232. );
  233. let transOp = op.getTransformedBy( transformBy, true );
  234. expectOperation( transOp[ 0 ], expected );
  235. } );
  236. it( 'should not increment offset if addresses are same and offset is before applied operation', () => {
  237. let transformBy = new InsertOperation(
  238. new Position( [ 0, 2, 2 ], root ),
  239. [ nodeC, nodeD ],
  240. baseVersion
  241. );
  242. let transOp = op.getTransformedBy( transformBy );
  243. expectOperation( transOp[ 0 ], expected );
  244. } );
  245. it( 'should update address at node(i) if applied operation\'s address was a prefix and its offset is before node(i)', () => {
  246. let transformBy = new InsertOperation(
  247. new Position( [ 0, 1 ], root ),
  248. [ nodeC, nodeD ],
  249. baseVersion
  250. );
  251. let transOp = op.getTransformedBy( transformBy );
  252. expected.position.path[ 1 ] += 2;
  253. expectOperation( transOp[ 0 ], expected );
  254. } );
  255. it( 'should not update address at node(i) if applied operation\'s address was a prefix and its offset is after node(i)', () => {
  256. let transformBy = new InsertOperation(
  257. new Position( [ 0, 6 ], root ),
  258. [ nodeC, nodeD ],
  259. baseVersion
  260. );
  261. let transOp = op.getTransformedBy( transformBy );
  262. expectOperation( transOp[ 0 ], expected );
  263. } );
  264. } );
  265. describe( 'ChangeOperation', () => {
  266. it( 'should not get updated', () => {
  267. let rangeStart = position.clone();
  268. let rangeEnd = position.clone();
  269. rangeEnd.offset += 2;
  270. let transformBy = new ChangeOperation(
  271. new Range( rangeStart, rangeEnd ),
  272. null,
  273. new Attribute( 'foo', 'bar' ),
  274. baseVersion
  275. );
  276. let transOp = op.getTransformedBy( transformBy );
  277. expectOperation( transOp[ 0 ], expected );
  278. } );
  279. } );
  280. describe( 'MoveOperation', () => {
  281. it( 'should not change if insert is in different path than move origin and destination', () => {
  282. let transformBy = new MoveOperation(
  283. new Position( [ 1, 3, 2 ], root ),
  284. new Position( [ 2, 1 ], root ),
  285. 2
  286. );
  287. let transOp = op.getTransformedBy( transformBy );
  288. expectOperation( transOp[ 0 ], expected );
  289. } );
  290. it( 'should have it\'s address merged with destination address if insert was inside moved node sub-tree', () => {
  291. let transformBy = new MoveOperation(
  292. new Position( [ 0, 1 ], root ),
  293. new Position( [ 1, 1 ], root ),
  294. 2
  295. );
  296. let transOp = op.getTransformedBy( transformBy );
  297. expected.position.path = [ 1, 2, 1 ];
  298. expectOperation( transOp[ 0 ], expected );
  299. } );
  300. it( 'should decrement offset if address is same as move origin and insert offset is after moved node offset', () => {
  301. let transformBy = new MoveOperation(
  302. new Position( [ 0, 2, 0 ], root ),
  303. new Position( [ 1, 1 ], root ),
  304. 1
  305. );
  306. let transOp = op.getTransformedBy( transformBy );
  307. expected.position.offset--;
  308. expectOperation( transOp[ 0 ], expected );
  309. } );
  310. it( 'should not decrement offset if address is same as move origin and insert offset is after moved node offset', () => {
  311. let transformBy = new MoveOperation(
  312. new Position( [ 0, 2, 4 ], root ),
  313. new Position( [ 1, 1 ], root ),
  314. 1
  315. );
  316. let transOp = op.getTransformedBy( transformBy );
  317. expectOperation( transOp[ 0 ], expected );
  318. } );
  319. it( 'should increment offset if address is same as move destination and insert offset is after move-to offset', () => {
  320. let transformBy = new MoveOperation(
  321. new Position( [ 1, 1 ], root ),
  322. new Position( [ 0, 2, 0 ], root ),
  323. 2
  324. );
  325. let transOp = op.getTransformedBy( transformBy );
  326. expected.position.offset += 2;
  327. expectOperation( transOp[ 0 ], expected );
  328. } );
  329. it( 'should not increment offset if address is same as move destination and insert offset is before move-to offset', () => {
  330. let transformBy = new MoveOperation(
  331. new Position( [ 1, 1 ], root ),
  332. new Position( [ 0, 2, 4 ], root ),
  333. 2
  334. );
  335. let transOp = op.getTransformedBy( transformBy );
  336. expectOperation( transOp[ 0 ], expected );
  337. } );
  338. it( 'should increment offset if position is same as move operation and insert operation is weaker', () => {
  339. let transformBy = new MoveOperation(
  340. new Position( [ 1, 1 ], root ),
  341. new Position( [ 0, 2, 1 ], root ),
  342. 2
  343. );
  344. let transOp = op.getTransformedBy( transformBy );
  345. expected.position.offset += 2;
  346. expectOperation( transOp[ 0 ], expected );
  347. } );
  348. it( 'should not increment offset if position is same as move operation and insert operation is stronger', () => {
  349. let transformBy = new MoveOperation(
  350. new Position( [ 1, 1 ], root ),
  351. new Position( [ 0, 2, 1 ], root ),
  352. 2
  353. );
  354. let transOp = op.getTransformedBy( transformBy, true );
  355. expectOperation( transOp[ 0 ], expected );
  356. } );
  357. it( 'should update address if moved node is before a node from insert path', () => {
  358. let transformBy = new MoveOperation(
  359. new Position( [ 0, 0 ], root ),
  360. new Position( [ 1, 0 ], root ),
  361. 2
  362. );
  363. let transOp = op.getTransformedBy( transformBy );
  364. expected.position.path[ 1 ] -= 2;
  365. expectOperation( transOp[ 0 ], expected );
  366. } );
  367. it( 'should not update address if moved node is after a node from insert path', () => {
  368. let transformBy = new MoveOperation(
  369. new Position( [ 0, 4 ], root ),
  370. new Position( [ 1, 0 ], root ),
  371. 2
  372. );
  373. let transOp = op.getTransformedBy( transformBy );
  374. expectOperation( transOp[ 0 ], expected );
  375. } );
  376. it( 'should update address if move-in destination is before a node from insert path', () => {
  377. let transformBy = new MoveOperation(
  378. new Position( [ 1, 0 ], root ),
  379. new Position( [ 0, 0 ], root ),
  380. 2
  381. );
  382. let transOp = op.getTransformedBy( transformBy );
  383. expected.position.path[ 1 ] += 2;
  384. expectOperation( transOp[ 0 ], expected );
  385. } );
  386. it( 'should not update address if move-in destination after a node from insert path', () => {
  387. let transformBy = new MoveOperation(
  388. new Position( [ 1, 0 ], root ),
  389. new Position( [ 0, 4 ], root ),
  390. 2
  391. );
  392. let transOp = op.getTransformedBy( transformBy );
  393. expectOperation( transOp[ 0 ], expected );
  394. } );
  395. it( 'should decrement offset if address is same as move origin and insert offset is in the middle of moved range', () => {
  396. let transformBy = new MoveOperation(
  397. new Position( [ 0, 2, 0 ], root ),
  398. new Position( [ 1, 0 ], root ),
  399. 3
  400. );
  401. let transOp = op.getTransformedBy( transformBy );
  402. expected.position.offset = 0;
  403. expectOperation( transOp[ 0 ], expected );
  404. } );
  405. } );
  406. describe( 'NoOperation', () => {
  407. it( 'should not get updated', () => {
  408. let transformBy = new NoOperation( baseVersion );
  409. let transOp = op.getTransformedBy( transformBy );
  410. expectOperation( transOp[ 0 ], expected );
  411. } );
  412. } );
  413. } );
  414. } );