insertoperation.js 14 KB

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