modelconversiondispatcher.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. import ModelConversionDispatcher from 'ckeditor5/engine/conversion/modelconversiondispatcher.js';
  7. import ModelDocument from 'ckeditor5/engine/model/document.js';
  8. import ModelText from 'ckeditor5/engine/model/text.js';
  9. import ModelElement from 'ckeditor5/engine/model/element.js';
  10. import ModelRange from 'ckeditor5/engine/model/range.js';
  11. import ModelPosition from 'ckeditor5/engine/model/position.js';
  12. import RemoveOperation from 'ckeditor5/engine/model/operation/removeoperation.js';
  13. import { wrapInDelta } from 'tests/engine/model/_utils/utils.js';
  14. describe( 'ModelConversionDispatcher', () => {
  15. let dispatcher, doc, root;
  16. beforeEach( () => {
  17. dispatcher = new ModelConversionDispatcher();
  18. doc = new ModelDocument();
  19. root = doc.createRoot();
  20. } );
  21. describe( 'constructor()', () => {
  22. it( 'should create ModelConversionDispatcher with given api', () => {
  23. const apiObj = {};
  24. const dispatcher = new ModelConversionDispatcher( { apiObj } );
  25. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  26. } );
  27. } );
  28. describe( 'convertChange', () => {
  29. // We will do integration tests here. Unit tests will be done for methods that are used
  30. // by `convertChange` internally. This way we will have two kinds of tests.
  31. let image, imagePos;
  32. beforeEach( () => {
  33. image = new ModelElement( 'image' );
  34. root.appendChildren( [ image, new ModelText( 'foobar' ) ] );
  35. imagePos = ModelPosition.createBefore( image );
  36. dispatcher.listenTo( doc, 'change', ( evt, type, changes ) => {
  37. dispatcher.convertChange( type, changes );
  38. } );
  39. } );
  40. it( 'should fire insert and addAttribute callbacks for insertion changes', () => {
  41. const cbInsertText = sinon.spy();
  42. const cbInsertImage = sinon.spy();
  43. const cbAddAttribute = sinon.spy();
  44. dispatcher.on( 'insert:$text', cbInsertText );
  45. dispatcher.on( 'insert:image', cbInsertImage );
  46. dispatcher.on( 'addAttribute:key:$text', cbAddAttribute );
  47. const insertedText = new ModelText( 'foo', { key: 'value' } );
  48. doc.batch().insert( ModelPosition.createFromParentAndOffset( root, 0 ), insertedText );
  49. expect( cbInsertText.called ).to.be.true;
  50. expect( cbAddAttribute.called ).to.be.true;
  51. expect( cbInsertImage.called ).to.be.false;
  52. } );
  53. it( 'should fire insert and addAttribute callbacks for reinsertion changes', () => {
  54. image.setAttribute( 'key', 'value' );
  55. // We will just create reinsert operation by reverting remove operation
  56. // because creating reinsert change is tricky and not available through batch API.
  57. const removeOperation = new RemoveOperation( imagePos, 1, 0 );
  58. // Let's apply remove operation so reinsert operation won't break.
  59. doc.applyOperation( wrapInDelta( removeOperation ) );
  60. const cbInsertText = sinon.spy();
  61. const cbInsertImage = sinon.spy();
  62. const cbAddAttribute = sinon.spy();
  63. dispatcher.on( 'insert:$text', cbInsertText );
  64. dispatcher.on( 'insert:image', cbInsertImage );
  65. dispatcher.on( 'addAttribute:key:image', cbAddAttribute );
  66. doc.applyOperation( wrapInDelta( removeOperation.getReversed() ) );
  67. expect( cbInsertImage.called ).to.be.true;
  68. expect( cbAddAttribute.called ).to.be.true;
  69. expect( cbInsertText.called ).to.be.false;
  70. } );
  71. it( 'should fire move callback for move changes', () => {
  72. const cbMove = sinon.spy();
  73. dispatcher.on( 'move', cbMove );
  74. doc.batch().move( image, imagePos.getShiftedBy( 3 ) );
  75. expect( cbMove.called );
  76. } );
  77. it( 'should fire remove callback for remove changes', () => {
  78. const cbRemove = sinon.spy();
  79. dispatcher.on( 'remove', cbRemove );
  80. doc.batch().remove( image );
  81. expect( cbRemove.called );
  82. } );
  83. it( 'should fire rename callback for rename changes', () => {
  84. const cbRename = sinon.spy();
  85. dispatcher.on( 'rename', cbRename );
  86. doc.batch().rename( image, 'figure' );
  87. expect( cbRename.called );
  88. } );
  89. it( 'should fire addAttribute callbacks for add attribute change', () => {
  90. const cbAddText = sinon.spy();
  91. const cbAddImage = sinon.spy();
  92. dispatcher.on( 'addAttribute:key:$text', cbAddText );
  93. dispatcher.on( 'addAttribute:key:image', cbAddImage );
  94. doc.batch().setAttribute( image, 'key', 'value' );
  95. // Callback for adding attribute on text not called.
  96. expect( cbAddText.called ).to.be.false;
  97. expect( cbAddImage.calledOnce ).to.be.true;
  98. doc.batch().setAttribute( ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ), 'key', 'value' );
  99. expect( cbAddText.calledOnce ).to.be.true;
  100. // Callback for adding attribute on image not called this time.
  101. expect( cbAddImage.calledOnce ).to.be.true;
  102. } );
  103. it( 'should fire changeAttribute callbacks for change attribute change', () => {
  104. const cbChangeText = sinon.spy();
  105. const cbChangeImage = sinon.spy();
  106. dispatcher.on( 'changeAttribute:key:$text', cbChangeText );
  107. dispatcher.on( 'changeAttribute:key:image', cbChangeImage );
  108. doc.batch().setAttribute( image, 'key', 'value' ).setAttribute( image, 'key', 'newValue' );
  109. // Callback for adding attribute on text not called.
  110. expect( cbChangeText.called ).to.be.false;
  111. expect( cbChangeImage.calledOnce ).to.be.true;
  112. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 );
  113. doc.batch().setAttribute( range, 'key', 'value' ).setAttribute( range, 'key', 'newValue' );
  114. expect( cbChangeText.calledOnce ).to.be.true;
  115. // Callback for adding attribute on image not called this time.
  116. expect( cbChangeImage.calledOnce ).to.be.true;
  117. } );
  118. it( 'should fire removeAttribute callbacks for remove attribute change', () => {
  119. const cbRemoveText = sinon.spy();
  120. const cbRemoveImage = sinon.spy();
  121. dispatcher.on( 'removeAttribute:key:$text', cbRemoveText );
  122. dispatcher.on( 'removeAttribute:key:image', cbRemoveImage );
  123. doc.batch().setAttribute( image, 'key', 'value' ).removeAttribute( image, 'key' );
  124. // Callback for adding attribute on text not called.
  125. expect( cbRemoveText.called ).to.be.false;
  126. expect( cbRemoveImage.calledOnce ).to.be.true;
  127. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 );
  128. doc.batch().setAttribute( range, 'key', 'value' ).removeAttribute( range, 'key' );
  129. expect( cbRemoveText.calledOnce ).to.be.true;
  130. // Callback for adding attribute on image not called this time.
  131. expect( cbRemoveImage.calledOnce ).to.be.true;
  132. } );
  133. it( 'should not fire any event if not recognized event type was passed', () => {
  134. sinon.spy( dispatcher, 'fire' );
  135. dispatcher.convertChange( 'unknown', { foo: 'bar' } );
  136. expect( dispatcher.fire.called ).to.be.false;
  137. } );
  138. it( 'should not fire any event if changed range in graveyard root and change type is different than remove', () => {
  139. sinon.spy( dispatcher, 'fire' );
  140. let gyNode = new ModelElement( 'image' );
  141. doc.graveyard.appendChildren( gyNode );
  142. doc.batch().setAttribute( gyNode, 'key', 'value' );
  143. expect( dispatcher.fire.called ).to.be.false;
  144. } );
  145. it( 'should not fire any event if remove operation moves nodes between graveyard holders', () => {
  146. // This may happen during OT.
  147. sinon.spy( dispatcher, 'fire' );
  148. let gyNode = new ModelElement( 'image' );
  149. doc.graveyard.appendChildren( gyNode );
  150. doc.batch().remove( gyNode );
  151. expect( dispatcher.fire.called ).to.be.false;
  152. } );
  153. it( 'should not fire any event if element in graveyard was removed', () => {
  154. // This may happen during OT.
  155. sinon.spy( dispatcher, 'fire' );
  156. let gyNode = new ModelElement( 'image' );
  157. doc.graveyard.appendChildren( gyNode );
  158. doc.batch().rename( gyNode, 'p' );
  159. expect( dispatcher.fire.called ).to.be.false;
  160. } );
  161. } );
  162. describe( 'convertInsert', () => {
  163. it( 'should fire event with correct parameters for every item in passed range', () => {
  164. root.appendChildren( [
  165. new ModelText( 'foo', { bold: true } ),
  166. new ModelElement( 'image' ),
  167. new ModelText( 'bar' ),
  168. new ModelElement( 'paragraph', { class: 'nice' }, new ModelText( 'xx', { italic: true } ) )
  169. ] );
  170. const range = ModelRange.createIn( root );
  171. const loggedEvents = [];
  172. // We will check everything connected with insert event:
  173. dispatcher.on( 'insert', ( evt, data, consumable ) => {
  174. // Check if the item is correct.
  175. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  176. // Check if the range is correct.
  177. const log = 'insert:' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  178. loggedEvents.push( log );
  179. // Check if the event name is correct.
  180. expect( evt.name ).to.equal( 'insert:' + ( data.item.name || '$text' ) );
  181. // Check if model consumable is correct.
  182. expect( consumable.consume( data.item, 'insert' ) ).to.be.true;
  183. } );
  184. // Same here.
  185. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  186. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  187. const key = data.attributeKey;
  188. const value = data.attributeNewValue;
  189. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  190. loggedEvents.push( log );
  191. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  192. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  193. } );
  194. dispatcher.convertInsertion( range );
  195. // Check the data passed to called events and the order of them.
  196. expect( loggedEvents ).to.deep.equal( [
  197. 'insert:$text:foo:0:3',
  198. 'addAttribute:bold:true:$text:foo:0:3',
  199. 'insert:image:3:4',
  200. 'insert:$text:bar:4:7',
  201. 'insert:paragraph:7:8',
  202. 'addAttribute:class:nice:paragraph:7:8',
  203. 'insert:$text:xx:7,0:7,2',
  204. 'addAttribute:italic:true:$text:xx:7,0:7,2'
  205. ] );
  206. } );
  207. it( 'should not fire events for already consumed parts of model', () => {
  208. root.appendChildren( [
  209. new ModelElement( 'image', { src: 'foo.jpg', title: 'bar', bold: true }, [
  210. new ModelElement( 'caption', {}, new ModelText( 'title' ) )
  211. ] )
  212. ] );
  213. sinon.spy( dispatcher, 'fire' );
  214. dispatcher.on( 'insert:image', ( evt, data, consumable ) => {
  215. consumable.consume( data.item.getChild( 0 ), 'insert' );
  216. consumable.consume( data.item, 'addAttribute:bold' );
  217. } );
  218. const range = ModelRange.createIn( root );
  219. dispatcher.convertInsertion( range );
  220. expect( dispatcher.fire.calledWith( 'insert:image' ) ).to.be.true;
  221. expect( dispatcher.fire.calledWith( 'addAttribute:src:image' ) ).to.be.true;
  222. expect( dispatcher.fire.calledWith( 'addAttribute:title:image' ) ).to.be.true;
  223. expect( dispatcher.fire.calledWith( 'insert:$text' ) ).to.be.true;
  224. expect( dispatcher.fire.calledWith( 'addAttribute:bold:image' ) ).to.be.false;
  225. expect( dispatcher.fire.calledWith( 'insert:caption' ) ).to.be.false;
  226. } );
  227. } );
  228. describe( 'convertMove', () => {
  229. it( 'should fire event for moved range - move before source position', () => {
  230. root.appendChildren( new ModelText( 'barfoo' ) );
  231. const range = ModelRange.createFromParentsAndOffsets( root, 0, root, 3 );
  232. const loggedEvents = [];
  233. dispatcher.on( 'move', ( evt, data ) => {
  234. const log = 'move:' + data.sourcePosition.path + ':' + data.targetPosition.path + ':' + data.item.offsetSize;
  235. loggedEvents.push( log );
  236. } );
  237. dispatcher.convertMove( ModelPosition.createFromParentAndOffset( root , 3 ), range );
  238. expect( loggedEvents ).to.deep.equal( [ 'move:3:0:3' ] );
  239. } );
  240. it( 'should fire event for moved range - move after source position', () => {
  241. root.appendChildren( new ModelText( 'barfoo' ) );
  242. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 6 );
  243. const loggedEvents = [];
  244. dispatcher.on( 'move', ( evt, data ) => {
  245. const log = 'move:' + data.sourcePosition.path + ':' + data.targetPosition.path + ':' + data.item.offsetSize;
  246. loggedEvents.push( log );
  247. } );
  248. dispatcher.convertMove( ModelPosition.createFromParentAndOffset( root , 0 ), range );
  249. expect( loggedEvents ).to.deep.equal( [ 'move:0:6:3' ] );
  250. } );
  251. } );
  252. describe( 'convertRemove', () => {
  253. it( 'should fire event for removed range', () => {
  254. root.appendChildren( new ModelText( 'foo' ) );
  255. doc.graveyard.appendChildren( new ModelText( 'bar' ) );
  256. const range = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 3 );
  257. const loggedEvents = [];
  258. dispatcher.on( 'remove', ( evt, data ) => {
  259. const log = 'remove:' + data.sourcePosition.path + ':' + data.item.offsetSize;
  260. loggedEvents.push( log );
  261. } );
  262. dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( root , 3 ), range );
  263. expect( loggedEvents ).to.deep.equal( [ 'remove:3:3' ] );
  264. } );
  265. } );
  266. describe( 'convertRename', () => {
  267. it( 'should fire rename event with correct name, consumable, and renamed element and it\'s old name in data', ( done ) => {
  268. const oldName = 'oldName';
  269. const element = new ModelElement( oldName );
  270. element.name = 'newName';
  271. dispatcher.on( 'rename', ( evt, data, consumable ) => {
  272. expect( evt.name ).to.equal( 'rename:newName:oldName' );
  273. expect( data.element ).to.equal( element );
  274. expect( data.oldName ).to.equal( oldName );
  275. expect( consumable.test( data.element, 'rename' ) ).to.be.true;
  276. done();
  277. } );
  278. dispatcher.convertRename( element, oldName );
  279. } );
  280. } );
  281. describe( 'convertAttribute', () => {
  282. it( 'should fire event for every item in passed range', () => {
  283. root.appendChildren( [
  284. new ModelText( 'foo', { bold: true } ),
  285. new ModelElement( 'image', { bold: true } ),
  286. new ModelElement( 'paragraph', { bold: true, class: 'nice' }, new ModelText( 'xx', { bold: true, italic: true } ) )
  287. ] );
  288. const range = ModelRange.createIn( root );
  289. const loggedEvents = [];
  290. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  291. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  292. const key = data.attributeKey;
  293. const value = data.attributeNewValue;
  294. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  295. loggedEvents.push( log );
  296. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  297. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  298. } );
  299. dispatcher.convertAttribute( 'addAttribute', range, 'bold', null, true );
  300. expect( loggedEvents ).to.deep.equal( [
  301. 'addAttribute:bold:true:$text:foo:0:3',
  302. 'addAttribute:bold:true:image:3:4',
  303. 'addAttribute:bold:true:paragraph:4:5',
  304. 'addAttribute:bold:true:$text:xx:4,0:4,2'
  305. ] );
  306. } );
  307. it( 'should not fire events for already consumed parts of model', () => {
  308. root.appendChildren( [
  309. new ModelElement( 'element', null, new ModelElement( 'inside' ) )
  310. ] );
  311. sinon.spy( dispatcher, 'fire' );
  312. dispatcher.on( 'removeAttribute:attr:element', ( evt, data, consumable ) => {
  313. consumable.consume( data.item.getChild( 0 ), 'removeAttribute:attr' );
  314. } );
  315. const range = ModelRange.createIn( root );
  316. dispatcher.convertAttribute( 'removeAttribute', range, 'attr', 'value', null );
  317. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:element' ) ).to.be.true;
  318. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:inside' ) ).to.be.false;
  319. } );
  320. } );
  321. describe( 'convertSelection', () => {
  322. beforeEach( () => {
  323. dispatcher.off( 'selection' );
  324. root.appendChildren( new ModelText( 'foobar' ) );
  325. doc.selection.setRanges( [
  326. new ModelRange( new ModelPosition( root, [ 1 ] ), new ModelPosition( root, [ 3 ] ) ),
  327. new ModelRange( new ModelPosition( root, [ 4 ] ), new ModelPosition( root, [ 5 ] ) )
  328. ] );
  329. } );
  330. it( 'should fire selection event', () => {
  331. sinon.spy( dispatcher, 'fire' );
  332. dispatcher.convertSelection( doc.selection );
  333. expect( dispatcher.fire.calledWith(
  334. 'selection',
  335. { selection: sinon.match.instanceOf( doc.selection.constructor ) }
  336. ) ).to.be.true;
  337. } );
  338. it( 'should prepare correct list of consumable values', () => {
  339. doc.enqueueChanges( () => {
  340. doc.batch()
  341. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  342. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  343. } );
  344. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  345. expect( consumable.test( data.selection, 'selection' ) ).to.be.true;
  346. expect( consumable.test( data.selection, 'selectionAttribute:bold' ) ).to.be.true;
  347. expect( consumable.test( data.selection, 'selectionAttribute:italic' ) ).to.be.null;
  348. } );
  349. dispatcher.convertSelection( doc.selection );
  350. } );
  351. it( 'should fire attributes events for selection', () => {
  352. sinon.spy( dispatcher, 'fire' );
  353. doc.enqueueChanges( () => {
  354. doc.batch()
  355. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  356. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  357. } );
  358. dispatcher.convertSelection( doc.selection );
  359. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.true;
  360. expect( dispatcher.fire.calledWith( 'selectionAttribute:italic' ) ).to.be.false;
  361. } );
  362. it( 'should not fire attributes events if attribute has been consumed', () => {
  363. sinon.spy( dispatcher, 'fire' );
  364. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  365. consumable.consume( data.selection, 'selectionAttribute:bold' );
  366. } );
  367. doc.enqueueChanges( () => {
  368. doc.batch()
  369. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  370. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  371. } );
  372. dispatcher.convertSelection( doc.selection );
  373. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.false;
  374. } );
  375. } );
  376. describe( 'convertMarker', () => {
  377. let range;
  378. beforeEach( () => {
  379. range = ModelRange.createFromParentsAndOffsets( root, 0, root, 4 );
  380. } );
  381. it( 'should fire event based on passed parameters', () => {
  382. sinon.spy( dispatcher, 'fire' );
  383. const data = {
  384. name: 'name',
  385. range: range
  386. };
  387. dispatcher.convertMarker( 'addMarker', data );
  388. expect( dispatcher.fire.calledWith( 'addMarker:name', data ) );
  389. dispatcher.convertMarker( 'removeMarker', data );
  390. expect( dispatcher.fire.calledWith( 'removeMarker:name', data ) );
  391. } );
  392. it( 'should prepare consumable values', () => {
  393. const data = {
  394. name: 'name',
  395. range: range
  396. };
  397. dispatcher.on( 'addMarker:name', ( evt, data, consumable ) => {
  398. expect( consumable.test( data.range, 'range' ) ).to.be.true;
  399. } );
  400. dispatcher.on( 'removeMarker:name', ( evt, data, consumable ) => {
  401. expect( consumable.test( data.range, 'range' ) ).to.be.true;
  402. } );
  403. dispatcher.convertMarker( 'addMarker', data );
  404. dispatcher.convertMarker( 'removeMarker', data );
  405. } );
  406. } );
  407. } );