downcastdispatcher.js 24 KB

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