downcastdispatcher.js 24 KB

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