downcastdispatcher.js 22 KB

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