modelconversiondispatcher.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  6. import Model from '../../src/model/model';
  7. import ModelText from '../../src/model/text';
  8. import ModelElement from '../../src/model/element';
  9. import ModelRange from '../../src/model/range';
  10. import ModelPosition from '../../src/model/position';
  11. import View from '../../src/view/view';
  12. import ViewContainerElement from '../../src/view/containerelement';
  13. describe( 'ModelConversionDispatcher', () => {
  14. let dispatcher, doc, root, differStub, model, view;
  15. beforeEach( () => {
  16. model = new Model();
  17. view = new View();
  18. doc = model.document;
  19. dispatcher = new ModelConversionDispatcher( model );
  20. root = doc.createRoot();
  21. differStub = {
  22. getMarkersToRemove: () => [],
  23. getChanges: () => [],
  24. getMarkersToAdd: () => []
  25. };
  26. } );
  27. describe( 'constructor()', () => {
  28. it( 'should create ModelConversionDispatcher with given api', () => {
  29. const apiObj = {};
  30. const dispatcher = new ModelConversionDispatcher( model, { apiObj } );
  31. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  32. } );
  33. } );
  34. describe( 'convertChanges', () => {
  35. it( 'should call convertInsert for insert change', () => {
  36. sinon.stub( dispatcher, 'convertInsert' );
  37. const position = new ModelPosition( root, [ 0 ] );
  38. const range = ModelRange.createFromPositionAndShift( position, 1 );
  39. differStub.getChanges = () => [ { type: 'insert', position, length: 1 } ];
  40. view.change( writer => {
  41. dispatcher.convertChanges( differStub, writer );
  42. } );
  43. expect( dispatcher.convertInsert.calledOnce ).to.be.true;
  44. expect( dispatcher.convertInsert.firstCall.args[ 0 ].isEqual( range ) ).to.be.true;
  45. } );
  46. it( 'should call convertRemove for remove change', () => {
  47. sinon.stub( dispatcher, 'convertRemove' );
  48. const position = new ModelPosition( root, [ 0 ] );
  49. differStub.getChanges = () => [ { type: 'remove', position, length: 2, name: '$text' } ];
  50. view.change( writer => {
  51. dispatcher.convertChanges( differStub, writer );
  52. } );
  53. expect( dispatcher.convertRemove.calledWith( position, 2, '$text' ) ).to.be.true;
  54. } );
  55. it( 'should call convertAttribute for attribute change', () => {
  56. sinon.stub( dispatcher, 'convertAttribute' );
  57. const position = new ModelPosition( root, [ 0 ] );
  58. const range = ModelRange.createFromPositionAndShift( position, 1 );
  59. differStub.getChanges = () => [
  60. { type: 'attribute', position, range, attributeKey: 'key', attributeOldValue: null, attributeNewValue: 'foo' }
  61. ];
  62. view.change( writer => {
  63. dispatcher.convertChanges( differStub, writer );
  64. } );
  65. expect( dispatcher.convertAttribute.calledWith( range, 'key', null, 'foo' ) ).to.be.true;
  66. } );
  67. it( 'should handle multiple changes', () => {
  68. sinon.stub( dispatcher, 'convertInsert' );
  69. sinon.stub( dispatcher, 'convertRemove' );
  70. sinon.stub( dispatcher, 'convertAttribute' );
  71. const position = new ModelPosition( root, [ 0 ] );
  72. const range = ModelRange.createFromPositionAndShift( position, 1 );
  73. differStub.getChanges = () => [
  74. { type: 'insert', position, length: 1 },
  75. { type: 'attribute', position, range, attributeKey: 'key', attributeOldValue: null, attributeNewValue: 'foo' },
  76. { type: 'remove', position, length: 1, name: 'paragraph' },
  77. { type: 'insert', position, length: 3 },
  78. ];
  79. view.change( writer => {
  80. dispatcher.convertChanges( differStub, writer );
  81. } );
  82. expect( dispatcher.convertInsert.calledTwice ).to.be.true;
  83. expect( dispatcher.convertRemove.calledOnce ).to.be.true;
  84. expect( dispatcher.convertAttribute.calledOnce ).to.be.true;
  85. } );
  86. it( 'should call convertMarkerAdd when markers are added', () => {
  87. sinon.stub( dispatcher, 'convertMarkerAdd' );
  88. const fooRange = ModelRange.createFromParentsAndOffsets( root, 0, root, 1 );
  89. const barRange = ModelRange.createFromParentsAndOffsets( root, 3, root, 6 );
  90. differStub.getMarkersToAdd = () => [
  91. { name: 'foo', range: fooRange },
  92. { name: 'bar', range: barRange }
  93. ];
  94. view.change( writer => {
  95. dispatcher.convertChanges( differStub, writer );
  96. } );
  97. expect( dispatcher.convertMarkerAdd.calledWith( 'foo', fooRange ) );
  98. expect( dispatcher.convertMarkerAdd.calledWith( 'bar', barRange ) );
  99. } );
  100. it( 'should call convertMarkerRemove when markers are removed', () => {
  101. sinon.stub( dispatcher, 'convertMarkerRemove' );
  102. const fooRange = ModelRange.createFromParentsAndOffsets( root, 0, root, 1 );
  103. const barRange = ModelRange.createFromParentsAndOffsets( root, 3, root, 6 );
  104. differStub.getMarkersToRemove = () => [
  105. { name: 'foo', range: fooRange },
  106. { name: 'bar', range: barRange }
  107. ];
  108. view.change( writer => {
  109. dispatcher.convertChanges( differStub, writer );
  110. } );
  111. expect( dispatcher.convertMarkerRemove.calledWith( 'foo', fooRange ) );
  112. expect( dispatcher.convertMarkerRemove.calledWith( 'bar', barRange ) );
  113. } );
  114. } );
  115. describe( 'convertInsert', () => {
  116. it( 'should fire event with correct parameters for every item in passed range', () => {
  117. root.appendChildren( [
  118. new ModelText( 'foo', { bold: true } ),
  119. new ModelElement( 'image' ),
  120. new ModelText( 'bar' ),
  121. new ModelElement( 'paragraph', { class: 'nice' }, new ModelText( 'xx', { italic: true } ) )
  122. ] );
  123. const range = ModelRange.createIn( root );
  124. const loggedEvents = [];
  125. // We will check everything connected with insert event:
  126. dispatcher.on( 'insert', ( evt, data, consumable ) => {
  127. // Check if the item is correct.
  128. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  129. // Check if the range is correct.
  130. const log = 'insert:' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  131. loggedEvents.push( log );
  132. // Check if the event name is correct.
  133. expect( evt.name ).to.equal( 'insert:' + ( data.item.name || '$text' ) );
  134. // Check if model consumable is correct.
  135. expect( consumable.consume( data.item, 'insert' ) ).to.be.true;
  136. } );
  137. // Same here.
  138. dispatcher.on( 'attribute', ( evt, data, consumable ) => {
  139. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  140. const key = data.attributeKey;
  141. const value = data.attributeNewValue;
  142. const log = 'attribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  143. loggedEvents.push( log );
  144. expect( evt.name ).to.equal( 'attribute:' + key + ':' + ( data.item.name || '$text' ) );
  145. expect( consumable.consume( data.item, 'attribute:' + key ) ).to.be.true;
  146. } );
  147. dispatcher.convertInsert( range );
  148. // Check the data passed to called events and the order of them.
  149. expect( loggedEvents ).to.deep.equal( [
  150. 'insert:$text:foo:0:3',
  151. 'attribute:bold:true:$text:foo:0:3',
  152. 'insert:image:3:4',
  153. 'insert:$text:bar:4:7',
  154. 'insert:paragraph:7:8',
  155. 'attribute:class:nice:paragraph:7:8',
  156. 'insert:$text:xx:7,0:7,2',
  157. 'attribute:italic:true:$text:xx:7,0:7,2'
  158. ] );
  159. } );
  160. it( 'should not fire events for already consumed parts of model', () => {
  161. root.appendChildren( [
  162. new ModelElement( 'image', { src: 'foo.jpg', title: 'bar', bold: true }, [
  163. new ModelElement( 'caption', {}, new ModelText( 'title' ) )
  164. ] )
  165. ] );
  166. sinon.spy( dispatcher, 'fire' );
  167. dispatcher.on( 'insert:image', ( evt, data, consumable ) => {
  168. consumable.consume( data.item.getChild( 0 ), 'insert' );
  169. consumable.consume( data.item, 'attribute:bold' );
  170. } );
  171. const range = ModelRange.createIn( root );
  172. dispatcher.convertInsert( range );
  173. expect( dispatcher.fire.calledWith( 'insert:image' ) ).to.be.true;
  174. expect( dispatcher.fire.calledWith( 'attribute:src:image' ) ).to.be.true;
  175. expect( dispatcher.fire.calledWith( 'attribute:title:image' ) ).to.be.true;
  176. expect( dispatcher.fire.calledWith( 'insert:$text' ) ).to.be.true;
  177. expect( dispatcher.fire.calledWith( 'attribute:bold:image' ) ).to.be.false;
  178. expect( dispatcher.fire.calledWith( 'insert:caption' ) ).to.be.false;
  179. } );
  180. } );
  181. describe( 'convertRemove', () => {
  182. it( 'should fire event for removed range', () => {
  183. const loggedEvents = [];
  184. dispatcher.on( 'remove:$text', ( evt, data ) => {
  185. const log = 'remove:' + data.position.path + ':' + data.length;
  186. loggedEvents.push( log );
  187. } );
  188. dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( root, 3 ), 3, '$text' );
  189. expect( loggedEvents ).to.deep.equal( [ 'remove:3:3' ] );
  190. } );
  191. } );
  192. describe( 'convertSelection', () => {
  193. beforeEach( () => {
  194. dispatcher.off( 'selection' );
  195. root.appendChildren( new ModelText( 'foobar' ) );
  196. doc.selection.setRanges( [
  197. new ModelRange( new ModelPosition( root, [ 1 ] ), new ModelPosition( root, [ 3 ] ) ),
  198. new ModelRange( new ModelPosition( root, [ 4 ] ), new ModelPosition( root, [ 5 ] ) )
  199. ] );
  200. } );
  201. it( 'should fire selection event', () => {
  202. sinon.spy( dispatcher, 'fire' );
  203. dispatcher.convertSelection( doc.selection, [] );
  204. expect( dispatcher.fire.calledWith(
  205. 'selection',
  206. { selection: sinon.match.instanceOf( doc.selection.constructor ) }
  207. ) ).to.be.true;
  208. } );
  209. it( 'should prepare correct list of consumable values', () => {
  210. model.change( writer => {
  211. writer.setAttribute( 'bold', true, ModelRange.createIn( root ) );
  212. writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) );
  213. } );
  214. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  215. expect( consumable.test( data.selection, 'selection' ) ).to.be.true;
  216. expect( consumable.test( data.selection, 'selectionAttribute:bold' ) ).to.be.true;
  217. expect( consumable.test( data.selection, 'selectionAttribute:italic' ) ).to.be.null;
  218. } );
  219. dispatcher.convertSelection( doc.selection, [] );
  220. } );
  221. it( 'should fire attributes events for selection', () => {
  222. sinon.spy( dispatcher, 'fire' );
  223. model.change( writer => {
  224. writer.setAttribute( 'bold', true, ModelRange.createIn( root ) );
  225. writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) );
  226. } );
  227. dispatcher.convertSelection( doc.selection, [] );
  228. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.true;
  229. expect( dispatcher.fire.calledWith( 'selectionAttribute:italic' ) ).to.be.false;
  230. } );
  231. it( 'should not fire attributes events if attribute has been consumed', () => {
  232. sinon.spy( dispatcher, 'fire' );
  233. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  234. consumable.consume( data.selection, 'selectionAttribute:bold' );
  235. } );
  236. model.change( writer => {
  237. writer.setAttribute( 'bold', true, ModelRange.createIn( root ) );
  238. writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) );
  239. } );
  240. dispatcher.convertSelection( doc.selection, [] );
  241. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.false;
  242. } );
  243. it( 'should fire events for each marker which contains selection', () => {
  244. model.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) );
  245. sinon.spy( dispatcher, 'fire' );
  246. const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) );
  247. dispatcher.convertSelection( doc.selection, markers );
  248. expect( dispatcher.fire.calledWith( 'selectionMarker:name' ) ).to.be.true;
  249. } );
  250. it( 'should not fire event for marker if selection is in a element with custom highlight handling', () => {
  251. // Clear after `beforeEach`.
  252. root.removeChildren( 0, root.childCount );
  253. const text = new ModelText( 'abc' );
  254. const caption = new ModelElement( 'caption', null, text );
  255. const image = new ModelElement( 'image', null, caption );
  256. root.appendChildren( [ image ] );
  257. // Create view elements that will be "mapped" to model elements.
  258. const viewCaption = new ViewContainerElement( 'caption' );
  259. const viewFigure = new ViewContainerElement( 'figure', null, viewCaption );
  260. // Create custom highlight handler mock.
  261. viewFigure.setCustomProperty( 'addHighlight', () => {} );
  262. viewFigure.setCustomProperty( 'removeHighlight', () => {} );
  263. // Create mapper mock.
  264. dispatcher.conversionApi.mapper = {
  265. toViewElement( modelElement ) {
  266. if ( modelElement == image ) {
  267. return viewFigure;
  268. } else if ( modelElement == caption ) {
  269. return viewCaption;
  270. }
  271. }
  272. };
  273. model.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 1 ) );
  274. doc.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( caption, 1, caption, 1 ) ] );
  275. sinon.spy( dispatcher, 'fire' );
  276. const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) );
  277. dispatcher.convertSelection( doc.selection, markers );
  278. expect( dispatcher.fire.calledWith( 'selectionMarker:name' ) ).to.be.false;
  279. } );
  280. it( 'should not fire events if information about marker has been consumed', () => {
  281. model.markers.set( 'foo', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) );
  282. model.markers.set( 'bar', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) );
  283. sinon.spy( dispatcher, 'fire' );
  284. dispatcher.on( 'selectionMarker:foo', ( evt, data, consumable ) => {
  285. consumable.consume( data.selection, 'selectionMarker:bar' );
  286. } );
  287. const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) );
  288. dispatcher.convertSelection( doc.selection, markers );
  289. expect( dispatcher.fire.calledWith( 'selectionMarker:foo' ) ).to.be.true;
  290. expect( dispatcher.fire.calledWith( 'selectionMarker:bar' ) ).to.be.false;
  291. } );
  292. } );
  293. describe( 'convertMarkerAdd', () => {
  294. let range, element, text;
  295. beforeEach( () => {
  296. text = new ModelText( 'foo bar baz' );
  297. element = new ModelElement( 'paragraph', null, [ text ] );
  298. root.appendChildren( [ element ] );
  299. range = ModelRange.createFromParentsAndOffsets( element, 0, element, 4 );
  300. } );
  301. it( 'should fire addMarker event', () => {
  302. sinon.spy( dispatcher, 'fire' );
  303. dispatcher.convertMarkerAdd( 'name', range );
  304. expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.true;
  305. } );
  306. it( 'should not convert marker if it is in graveyard', () => {
  307. const gyRange = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 0 );
  308. sinon.spy( dispatcher, 'fire' );
  309. dispatcher.convertMarkerAdd( 'name', gyRange );
  310. expect( dispatcher.fire.called ).to.be.false;
  311. } );
  312. it( 'should not convert marker if it is not in model root', () => {
  313. const element = new ModelElement( 'element', null, new ModelText( 'foo' ) );
  314. const eleRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 2 );
  315. sinon.spy( dispatcher, 'fire' );
  316. dispatcher.convertMarkerAdd( 'name', eleRange );
  317. expect( dispatcher.fire.called ).to.be.false;
  318. } );
  319. it( 'should fire conversion for each item in the range', () => {
  320. range = ModelRange.createIn( root );
  321. const items = [];
  322. dispatcher.on( 'addMarker:name', ( evt, data, consumable ) => {
  323. expect( data.markerName ).to.equal( 'name' );
  324. expect( data.markerRange.isEqual( range ) ).to.be.true;
  325. expect( consumable.test( data.item, 'addMarker:name' ) );
  326. items.push( data.item );
  327. } );
  328. dispatcher.convertMarkerAdd( 'name', range );
  329. expect( items[ 0 ] ).to.equal( element );
  330. expect( items[ 1 ].data ).to.equal( text.data );
  331. } );
  332. it( 'should be possible to override', () => {
  333. range = ModelRange.createIn( root );
  334. const addMarkerSpy = sinon.spy();
  335. const highAddMarkerSpy = sinon.spy();
  336. dispatcher.on( 'addMarker:marker', addMarkerSpy );
  337. dispatcher.on( 'addMarker:marker', evt => {
  338. highAddMarkerSpy();
  339. evt.stop();
  340. }, { priority: 'high' } );
  341. dispatcher.convertMarkerAdd( 'marker', range );
  342. expect( addMarkerSpy.called ).to.be.false;
  343. // Called once for each item, twice total.
  344. expect( highAddMarkerSpy.calledTwice ).to.be.true;
  345. } );
  346. } );
  347. describe( 'convertMarkerRemove', () => {
  348. let range, element, text;
  349. beforeEach( () => {
  350. text = new ModelText( 'foo bar baz' );
  351. element = new ModelElement( 'paragraph', null, [ text ] );
  352. root.appendChildren( [ element ] );
  353. range = ModelRange.createFromParentsAndOffsets( element, 0, element, 4 );
  354. } );
  355. it( 'should fire removeMarker event', () => {
  356. sinon.spy( dispatcher, 'fire' );
  357. dispatcher.convertMarkerRemove( 'name', range );
  358. expect( dispatcher.fire.calledWith( 'removeMarker:name' ) ).to.be.true;
  359. } );
  360. it( 'should not convert marker if it is in graveyard', () => {
  361. const gyRange = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 0 );
  362. sinon.spy( dispatcher, 'fire' );
  363. dispatcher.convertMarkerRemove( 'name', gyRange );
  364. expect( dispatcher.fire.called ).to.be.false;
  365. } );
  366. it( 'should not convert marker if it is not in model root', () => {
  367. const element = new ModelElement( 'element', null, new ModelText( 'foo' ) );
  368. const eleRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 2 );
  369. sinon.spy( dispatcher, 'fire' );
  370. dispatcher.convertMarkerRemove( 'name', eleRange );
  371. expect( dispatcher.fire.called ).to.be.false;
  372. } );
  373. it( 'should fire conversion for the range', () => {
  374. range = ModelRange.createIn( root );
  375. dispatcher.on( 'addMarker:name', ( evt, data ) => {
  376. expect( data.markerName ).to.equal( 'name' );
  377. expect( data.markerRange.isEqual( range ) ).to.be.true;
  378. } );
  379. dispatcher.convertMarkerRemove( 'name', range );
  380. } );
  381. it( 'should be possible to override', () => {
  382. range = ModelRange.createIn( root );
  383. const removeMarkerSpy = sinon.spy();
  384. const highRemoveMarkerSpy = sinon.spy();
  385. dispatcher.on( 'removeMarker:marker', removeMarkerSpy );
  386. dispatcher.on( 'removeMarker:marker', evt => {
  387. highRemoveMarkerSpy();
  388. evt.stop();
  389. }, { priority: 'high' } );
  390. dispatcher.convertMarkerRemove( 'marker', range );
  391. expect( removeMarkerSpy.called ).to.be.false;
  392. expect( highRemoveMarkerSpy.calledOnce ).to.be.true;
  393. } );
  394. } );
  395. } );