8
0

modelconversiondispatcher.js 19 KB

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