modelconversiondispatcher.js 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
  6. import ModelDocument from '../../src/model/document';
  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 RemoveOperation from '../../src/model/operation/removeoperation';
  12. import { wrapInDelta } from '../../tests/model/_utils/utils';
  13. describe( 'ModelConversionDispatcher', () => {
  14. let dispatcher, doc, root, gyPos;
  15. beforeEach( () => {
  16. doc = new ModelDocument();
  17. dispatcher = new ModelConversionDispatcher( doc );
  18. root = doc.createRoot();
  19. gyPos = new ModelPosition( doc.graveyard, [ 0 ] );
  20. } );
  21. describe( 'constructor()', () => {
  22. it( 'should create ModelConversionDispatcher with given api', () => {
  23. const apiObj = {};
  24. const dispatcher = new ModelConversionDispatcher( doc, { apiObj } );
  25. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  26. } );
  27. } );
  28. describe( 'convertChange', () => {
  29. // We will do integration tests here. Unit tests will be done for methods that are used
  30. // by `convertChange` internally. This way we will have two kinds of tests.
  31. let image, imagePos;
  32. beforeEach( () => {
  33. image = new ModelElement( 'image' );
  34. root.appendChildren( [ image, new ModelText( 'foobar' ) ] );
  35. imagePos = ModelPosition.createBefore( image );
  36. dispatcher.listenTo( doc, 'change', ( evt, type, changes ) => {
  37. dispatcher.convertChange( type, changes );
  38. } );
  39. } );
  40. it( 'should fire insert and addAttribute callbacks for insertion changes', () => {
  41. const cbInsertText = sinon.spy();
  42. const cbInsertImage = sinon.spy();
  43. const cbAddAttribute = sinon.spy();
  44. dispatcher.on( 'insert:$text', cbInsertText );
  45. dispatcher.on( 'insert:image', cbInsertImage );
  46. dispatcher.on( 'addAttribute:key:$text', cbAddAttribute );
  47. const insertedText = new ModelText( 'foo', { key: 'value' } );
  48. doc.batch().insert( ModelPosition.createFromParentAndOffset( root, 0 ), insertedText );
  49. expect( cbInsertText.called ).to.be.true;
  50. expect( cbAddAttribute.called ).to.be.true;
  51. expect( cbInsertImage.called ).to.be.false;
  52. } );
  53. it( 'should fire insert and addAttribute callbacks for reinsertion changes', () => {
  54. image.setAttribute( 'key', 'value' );
  55. // We will just create reinsert operation by reverting remove operation
  56. // because creating reinsert change is tricky and not available through batch API.
  57. const removeOperation = new RemoveOperation( imagePos, 1, gyPos, 0 );
  58. // Let's apply remove operation so reinsert operation won't break.
  59. doc.applyOperation( wrapInDelta( removeOperation ) );
  60. const cbInsertText = sinon.spy();
  61. const cbInsertImage = sinon.spy();
  62. const cbAddAttribute = sinon.spy();
  63. dispatcher.on( 'insert:$text', cbInsertText );
  64. dispatcher.on( 'insert:image', cbInsertImage );
  65. dispatcher.on( 'addAttribute:key:image', cbAddAttribute );
  66. doc.applyOperation( wrapInDelta( removeOperation.getReversed() ) );
  67. expect( cbInsertImage.called ).to.be.true;
  68. expect( cbAddAttribute.called ).to.be.true;
  69. expect( cbInsertText.called ).to.be.false;
  70. } );
  71. it( 'should fire remove callback for remove changes', () => {
  72. const cbRemove = sinon.spy();
  73. dispatcher.on( 'remove', cbRemove );
  74. doc.batch().remove( image );
  75. expect( cbRemove.called ).to.be.true;
  76. } );
  77. it( 'should fire addAttribute callbacks for add attribute change', () => {
  78. const cbAddText = sinon.spy();
  79. const cbAddImage = sinon.spy();
  80. dispatcher.on( 'addAttribute:key:$text', cbAddText );
  81. dispatcher.on( 'addAttribute:key:image', cbAddImage );
  82. doc.batch().setAttribute( image, 'key', 'value' );
  83. // Callback for adding attribute on text not called.
  84. expect( cbAddText.called ).to.be.false;
  85. expect( cbAddImage.calledOnce ).to.be.true;
  86. doc.batch().setAttribute( ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ), 'key', 'value' );
  87. expect( cbAddText.calledOnce ).to.be.true;
  88. // Callback for adding attribute on image not called this time.
  89. expect( cbAddImage.calledOnce ).to.be.true;
  90. } );
  91. it( 'should fire changeAttribute callbacks for change attribute change', () => {
  92. const cbChangeText = sinon.spy();
  93. const cbChangeImage = sinon.spy();
  94. dispatcher.on( 'changeAttribute:key:$text', cbChangeText );
  95. dispatcher.on( 'changeAttribute:key:image', cbChangeImage );
  96. doc.batch().setAttribute( image, 'key', 'value' ).setAttribute( image, 'key', 'newValue' );
  97. // Callback for adding attribute on text not called.
  98. expect( cbChangeText.called ).to.be.false;
  99. expect( cbChangeImage.calledOnce ).to.be.true;
  100. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 );
  101. doc.batch().setAttribute( range, 'key', 'value' ).setAttribute( range, 'key', 'newValue' );
  102. expect( cbChangeText.calledOnce ).to.be.true;
  103. // Callback for adding attribute on image not called this time.
  104. expect( cbChangeImage.calledOnce ).to.be.true;
  105. } );
  106. it( 'should fire removeAttribute callbacks for remove attribute change', () => {
  107. const cbRemoveText = sinon.spy();
  108. const cbRemoveImage = sinon.spy();
  109. dispatcher.on( 'removeAttribute:key:$text', cbRemoveText );
  110. dispatcher.on( 'removeAttribute:key:image', cbRemoveImage );
  111. doc.batch().setAttribute( image, 'key', 'value' ).removeAttribute( image, 'key' );
  112. // Callback for adding attribute on text not called.
  113. expect( cbRemoveText.called ).to.be.false;
  114. expect( cbRemoveImage.calledOnce ).to.be.true;
  115. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 );
  116. doc.batch().setAttribute( range, 'key', 'value' ).removeAttribute( range, 'key' );
  117. expect( cbRemoveText.calledOnce ).to.be.true;
  118. // Callback for adding attribute on image not called this time.
  119. expect( cbRemoveImage.calledOnce ).to.be.true;
  120. } );
  121. it( 'should not fire any event if not recognized event type was passed', () => {
  122. sinon.spy( dispatcher, 'fire' );
  123. dispatcher.convertChange( 'unknown', { foo: 'bar' } );
  124. expect( dispatcher.fire.called ).to.be.false;
  125. } );
  126. it( 'should not fire any event if changed range in graveyard root and change type is different than remove', () => {
  127. sinon.spy( dispatcher, 'fire' );
  128. const gyNode = new ModelElement( 'image' );
  129. doc.graveyard.appendChildren( gyNode );
  130. doc.batch().setAttribute( gyNode, 'key', 'value' );
  131. expect( dispatcher.fire.called ).to.be.false;
  132. } );
  133. it( 'should not fire any event if remove operation moves nodes between graveyard holders', () => {
  134. // This may happen during OT.
  135. sinon.spy( dispatcher, 'fire' );
  136. const gyNode = new ModelElement( 'image' );
  137. doc.graveyard.appendChildren( gyNode );
  138. doc.batch().remove( gyNode );
  139. expect( dispatcher.fire.called ).to.be.false;
  140. } );
  141. it( 'should not fire any event if element in graveyard was removed', () => {
  142. // This may happen during OT.
  143. sinon.spy( dispatcher, 'fire' );
  144. const gyNode = new ModelElement( 'image' );
  145. doc.graveyard.appendChildren( gyNode );
  146. doc.batch().rename( gyNode, 'p' );
  147. expect( dispatcher.fire.called ).to.be.false;
  148. } );
  149. } );
  150. describe( 'convertInsert', () => {
  151. it( 'should fire event with correct parameters for every item in passed range', () => {
  152. root.appendChildren( [
  153. new ModelText( 'foo', { bold: true } ),
  154. new ModelElement( 'image' ),
  155. new ModelText( 'bar' ),
  156. new ModelElement( 'paragraph', { class: 'nice' }, new ModelText( 'xx', { italic: true } ) )
  157. ] );
  158. const range = ModelRange.createIn( root );
  159. const loggedEvents = [];
  160. // We will check everything connected with insert event:
  161. dispatcher.on( 'insert', ( evt, data, consumable ) => {
  162. // Check if the item is correct.
  163. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  164. // Check if the range is correct.
  165. const log = 'insert:' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  166. loggedEvents.push( log );
  167. // Check if the event name is correct.
  168. expect( evt.name ).to.equal( 'insert:' + ( data.item.name || '$text' ) );
  169. // Check if model consumable is correct.
  170. expect( consumable.consume( data.item, 'insert' ) ).to.be.true;
  171. } );
  172. // Same here.
  173. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  174. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  175. const key = data.attributeKey;
  176. const value = data.attributeNewValue;
  177. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  178. loggedEvents.push( log );
  179. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  180. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  181. } );
  182. dispatcher.convertInsertion( range );
  183. // Check the data passed to called events and the order of them.
  184. expect( loggedEvents ).to.deep.equal( [
  185. 'insert:$text:foo:0:3',
  186. 'addAttribute:bold:true:$text:foo:0:3',
  187. 'insert:image:3:4',
  188. 'insert:$text:bar:4:7',
  189. 'insert:paragraph:7:8',
  190. 'addAttribute:class:nice:paragraph:7:8',
  191. 'insert:$text:xx:7,0:7,2',
  192. 'addAttribute:italic:true:$text:xx:7,0:7,2'
  193. ] );
  194. } );
  195. it( 'should not fire events for already consumed parts of model', () => {
  196. root.appendChildren( [
  197. new ModelElement( 'image', { src: 'foo.jpg', title: 'bar', bold: true }, [
  198. new ModelElement( 'caption', {}, new ModelText( 'title' ) )
  199. ] )
  200. ] );
  201. sinon.spy( dispatcher, 'fire' );
  202. dispatcher.on( 'insert:image', ( evt, data, consumable ) => {
  203. consumable.consume( data.item.getChild( 0 ), 'insert' );
  204. consumable.consume( data.item, 'addAttribute:bold' );
  205. } );
  206. const range = ModelRange.createIn( root );
  207. dispatcher.convertInsertion( range );
  208. expect( dispatcher.fire.calledWith( 'insert:image' ) ).to.be.true;
  209. expect( dispatcher.fire.calledWith( 'addAttribute:src:image' ) ).to.be.true;
  210. expect( dispatcher.fire.calledWith( 'addAttribute:title:image' ) ).to.be.true;
  211. expect( dispatcher.fire.calledWith( 'insert:$text' ) ).to.be.true;
  212. expect( dispatcher.fire.calledWith( 'addAttribute:bold:image' ) ).to.be.false;
  213. expect( dispatcher.fire.calledWith( 'insert:caption' ) ).to.be.false;
  214. } );
  215. it( 'should fire marker converter if content is inserted into marker', () => {
  216. const convertMarkerSpy = sinon.spy( dispatcher, 'convertMarker' );
  217. const paragraph1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  218. const paragraph2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  219. root.appendChildren( [ paragraph1, paragraph2 ] );
  220. const markerRange = ModelRange.createFromParentsAndOffsets( root, 0, root, 2 );
  221. doc.markers.set( 'marker', markerRange );
  222. const insertionRange = ModelRange.createOn( paragraph2 );
  223. dispatcher.convertInsertion( insertionRange );
  224. sinon.assert.calledOnce( convertMarkerSpy );
  225. const callArgs = convertMarkerSpy.args[ 0 ];
  226. expect( callArgs[ 0 ] ).to.equal( 'addMarker' );
  227. expect( callArgs[ 1 ] ).to.equal( 'marker' );
  228. expect( callArgs[ 2 ].isEqual( markerRange.getIntersection( insertionRange ) ) ).to.be.true;
  229. } );
  230. it( 'should fire marker converter if content has marker', () => {
  231. const convertMarkerSpy = sinon.spy( dispatcher, 'convertMarker' );
  232. const paragraph1 = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) );
  233. const paragraph2 = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) );
  234. root.appendChildren( [ paragraph1, paragraph2 ] );
  235. const markerRange = ModelRange.createIn( paragraph2 );
  236. doc.markers.set( 'marker', markerRange );
  237. const insertionRange = ModelRange.createOn( paragraph2 );
  238. dispatcher.convertInsertion( insertionRange );
  239. sinon.assert.calledOnce( convertMarkerSpy );
  240. const callArgs = convertMarkerSpy.args[ 0 ];
  241. expect( callArgs[ 0 ] ).to.equal( 'addMarker' );
  242. expect( callArgs[ 1 ] ).to.equal( 'marker' );
  243. expect( callArgs[ 2 ].isEqual( markerRange ) ).to.be.true;
  244. } );
  245. } );
  246. describe( 'convertMove', () => {
  247. let loggedEvents;
  248. beforeEach( () => {
  249. loggedEvents = [];
  250. dispatcher.on( 'remove', ( evt, data ) => {
  251. const log = 'remove:' + data.sourcePosition.path + ':' + data.item.offsetSize;
  252. loggedEvents.push( log );
  253. } );
  254. dispatcher.on( 'insert', ( evt, data ) => {
  255. const log = 'insert:' + data.range.start.path + ':' + data.range.end.path;
  256. loggedEvents.push( log );
  257. } );
  258. } );
  259. it( 'should first fire remove and then insert if moving "right"', () => {
  260. // <root>[ab]cd^ef</root> -> <root>cdabef</root>
  261. root.appendChildren( new ModelText( 'cdabef' ) );
  262. const sourcePosition = ModelPosition.createFromParentAndOffset( root, 0 );
  263. const movedRange = ModelRange.createFromParentsAndOffsets( root, 2, root, 4 );
  264. dispatcher.convertMove( sourcePosition, movedRange );
  265. // after remove: cdef
  266. // after insert: cd[ab]ef
  267. expect( loggedEvents ).to.deep.equal( [ 'remove:0:2', 'insert:2:4' ] );
  268. } );
  269. it( 'should first fire insert and then remove if moving "left"', () => {
  270. // <root>ab^cd[ef]</root> -> <root>abefcd</root>
  271. root.appendChildren( new ModelText( 'abefcd' ) );
  272. const sourcePosition = ModelPosition.createFromParentAndOffset( root, 4 );
  273. const movedRange = ModelRange.createFromParentsAndOffsets( root, 2, root, 4 );
  274. dispatcher.convertMove( sourcePosition, movedRange );
  275. // after insert: ab[ef]cd[ef]
  276. // after remove: ab[ef]cd
  277. expect( loggedEvents ).to.deep.equal( [ 'insert:2:4', 'remove:6:2' ] );
  278. } );
  279. it( 'should first fire insert and then remove when moving like in unwrap', () => {
  280. // <root>a^<w>[xyz]</w>b</root> -> <root>axyz<w></w>b</root>
  281. root.appendChildren( [
  282. new ModelText( 'axyz' ),
  283. new ModelElement( 'w' ),
  284. new ModelText( 'b' )
  285. ] );
  286. const sourcePosition = new ModelPosition( root, [ 1, 0 ] );
  287. const movedRange = ModelRange.createFromParentsAndOffsets( root, 1, root, 4 );
  288. dispatcher.convertMove( sourcePosition, movedRange );
  289. // before: a<w>[xyz]</w>b
  290. // after insert: a[xyz]<w>[xyz]</w>b
  291. // after remove: a[xyz]<w></w>b
  292. expect( loggedEvents ).to.deep.equal( [ 'insert:1:4', 'remove:4,0:3' ] );
  293. } );
  294. it( 'should first fire remove and then insert when moving like in wrap', () => {
  295. // <root>a[xyz]<w>^</w>b</root> -> <root>a<w>xyz</w>b</root>
  296. root.appendChildren( [
  297. new ModelText( 'a' ),
  298. new ModelElement( 'w', null, [ new ModelText( 'xyz' ) ] ),
  299. new ModelText( 'b' )
  300. ] );
  301. const sourcePosition = ModelPosition.createFromParentAndOffset( root, 1 );
  302. const movedRange = ModelRange.createFromPositionAndShift( new ModelPosition( root, [ 1, 0 ] ), 3 );
  303. dispatcher.convertMove( sourcePosition, movedRange );
  304. // before: a[xyz]<w></w>b
  305. // after remove: a<w></w>b
  306. // after insert: a<w>[xyz]</w>b
  307. expect( loggedEvents ).to.deep.equal( [ 'remove:1:3', 'insert:1,0:1,3' ] );
  308. } );
  309. } );
  310. describe( 'convertRemove', () => {
  311. it( 'should fire event for removed range', () => {
  312. root.appendChildren( new ModelText( 'foo' ) );
  313. doc.graveyard.appendChildren( new ModelText( 'bar' ) );
  314. const range = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 3 );
  315. const loggedEvents = [];
  316. dispatcher.on( 'remove', ( evt, data ) => {
  317. const log = 'remove:' + data.sourcePosition.path + ':' + data.item.offsetSize;
  318. loggedEvents.push( log );
  319. } );
  320. dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( root, 3 ), range );
  321. expect( loggedEvents ).to.deep.equal( [ 'remove:3:3' ] );
  322. } );
  323. } );
  324. describe( 'convertAttribute', () => {
  325. it( 'should fire event for every item in passed range', () => {
  326. root.appendChildren( [
  327. new ModelText( 'foo', { bold: true } ),
  328. new ModelElement( 'image', { bold: true } ),
  329. new ModelElement( 'paragraph', { bold: true, class: 'nice' }, new ModelText( 'xx', { bold: true, italic: true } ) )
  330. ] );
  331. const range = ModelRange.createIn( root );
  332. const loggedEvents = [];
  333. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  334. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  335. const key = data.attributeKey;
  336. const value = data.attributeNewValue;
  337. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  338. loggedEvents.push( log );
  339. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  340. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  341. } );
  342. dispatcher.convertAttribute( 'addAttribute', range, 'bold', null, true );
  343. expect( loggedEvents ).to.deep.equal( [
  344. 'addAttribute:bold:true:$text:foo:0:3',
  345. 'addAttribute:bold:true:image:3:4',
  346. 'addAttribute:bold:true:paragraph:4:5',
  347. 'addAttribute:bold:true:$text:xx:4,0:4,2'
  348. ] );
  349. } );
  350. it( 'should not fire events for already consumed parts of model', () => {
  351. root.appendChildren( [
  352. new ModelElement( 'element', null, new ModelElement( 'inside' ) )
  353. ] );
  354. sinon.spy( dispatcher, 'fire' );
  355. dispatcher.on( 'removeAttribute:attr:element', ( evt, data, consumable ) => {
  356. consumable.consume( data.item.getChild( 0 ), 'removeAttribute:attr' );
  357. } );
  358. const range = ModelRange.createIn( root );
  359. dispatcher.convertAttribute( 'removeAttribute', range, 'attr', 'value', null );
  360. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:element' ) ).to.be.true;
  361. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:inside' ) ).to.be.false;
  362. } );
  363. } );
  364. describe( 'convertSelection', () => {
  365. beforeEach( () => {
  366. dispatcher.off( 'selection' );
  367. root.appendChildren( new ModelText( 'foobar' ) );
  368. doc.selection.setRanges( [
  369. new ModelRange( new ModelPosition( root, [ 1 ] ), new ModelPosition( root, [ 3 ] ) ),
  370. new ModelRange( new ModelPosition( root, [ 4 ] ), new ModelPosition( root, [ 5 ] ) )
  371. ] );
  372. } );
  373. it( 'should fire selection event', () => {
  374. sinon.spy( dispatcher, 'fire' );
  375. dispatcher.convertSelection( doc.selection, [] );
  376. expect( dispatcher.fire.calledWith(
  377. 'selection',
  378. { selection: sinon.match.instanceOf( doc.selection.constructor ) }
  379. ) ).to.be.true;
  380. } );
  381. it( 'should prepare correct list of consumable values', () => {
  382. doc.enqueueChanges( () => {
  383. doc.batch()
  384. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  385. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  386. } );
  387. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  388. expect( consumable.test( data.selection, 'selection' ) ).to.be.true;
  389. expect( consumable.test( data.selection, 'selectionAttribute:bold' ) ).to.be.true;
  390. expect( consumable.test( data.selection, 'selectionAttribute:italic' ) ).to.be.null;
  391. } );
  392. dispatcher.convertSelection( doc.selection, [] );
  393. } );
  394. it( 'should fire attributes events for selection', () => {
  395. sinon.spy( dispatcher, 'fire' );
  396. doc.enqueueChanges( () => {
  397. doc.batch()
  398. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  399. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  400. } );
  401. dispatcher.convertSelection( doc.selection, [] );
  402. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.true;
  403. expect( dispatcher.fire.calledWith( 'selectionAttribute:italic' ) ).to.be.false;
  404. } );
  405. it( 'should not fire attributes events if attribute has been consumed', () => {
  406. sinon.spy( dispatcher, 'fire' );
  407. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  408. consumable.consume( data.selection, 'selectionAttribute:bold' );
  409. } );
  410. doc.enqueueChanges( () => {
  411. doc.batch()
  412. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  413. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  414. } );
  415. dispatcher.convertSelection( doc.selection, [] );
  416. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.false;
  417. } );
  418. it( 'should fire events for each marker which contains selection', () => {
  419. doc.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) );
  420. sinon.spy( dispatcher, 'fire' );
  421. const markers = Array.from( doc.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) );
  422. dispatcher.convertSelection( doc.selection, markers );
  423. expect( dispatcher.fire.calledWith( 'selectionMarker:name' ) ).to.be.true;
  424. } );
  425. it( 'should not fire events if information about marker has been consumed', () => {
  426. doc.markers.set( 'foo', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) );
  427. doc.markers.set( 'bar', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) );
  428. sinon.spy( dispatcher, 'fire' );
  429. dispatcher.on( 'selectionMarker:foo', ( evt, data, consumable ) => {
  430. consumable.consume( data.selection, 'selectionMarker:bar' );
  431. } );
  432. const markers = Array.from( doc.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) );
  433. dispatcher.convertSelection( doc.selection, markers );
  434. expect( dispatcher.fire.calledWith( 'selectionMarker:foo' ) ).to.be.true;
  435. expect( dispatcher.fire.calledWith( 'selectionMarker:bar' ) ).to.be.false;
  436. } );
  437. } );
  438. describe( 'convertMarker', () => {
  439. let range;
  440. beforeEach( () => {
  441. const element = new ModelElement( 'paragraph', null, [ new ModelText( 'foo bar baz' ) ] );
  442. root.appendChildren( [ element ] );
  443. range = ModelRange.createFromParentsAndOffsets( element, 0, element, 4 );
  444. } );
  445. it( 'should fire event based on passed parameters', () => {
  446. sinon.spy( dispatcher, 'fire' );
  447. dispatcher.convertMarker( 'addMarker', 'name', range );
  448. expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.true;
  449. dispatcher.convertMarker( 'removeMarker', 'name', range );
  450. expect( dispatcher.fire.calledWith( 'removeMarker:name' ) ).to.be.true;
  451. } );
  452. it( 'should not convert marker if it is added in graveyard', () => {
  453. const gyRange = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 0 );
  454. sinon.spy( dispatcher, 'fire' );
  455. dispatcher.convertMarker( 'addMarker', 'name', gyRange );
  456. expect( dispatcher.fire.called ).to.be.false;
  457. dispatcher.convertMarker( 'removeMarker', 'name', gyRange );
  458. expect( dispatcher.fire.called ).to.be.false;
  459. } );
  460. it( 'should not convert marker if it is not in model root', () => {
  461. const element = new ModelElement( 'element', null, new ModelText( 'foo' ) );
  462. const eleRange = ModelRange.createFromParentsAndOffsets( element, 1, element, 2 );
  463. sinon.spy( dispatcher, 'fire' );
  464. dispatcher.convertMarker( 'addMarker', 'name', eleRange );
  465. expect( dispatcher.fire.called ).to.be.false;
  466. dispatcher.convertMarker( 'removeMarker', 'name', eleRange );
  467. expect( dispatcher.fire.called ).to.be.false;
  468. } );
  469. it( 'should prepare consumable values', () => {
  470. dispatcher.on( 'addMarker:name', ( evt, data, consumable ) => {
  471. expect( consumable.test( data.item, 'addMarker:name' ) ).to.be.true;
  472. } );
  473. dispatcher.on( 'removeMarker:name', ( evt, data, consumable ) => {
  474. expect( consumable.test( data.item, 'removeMarker:name' ) ).to.be.true;
  475. } );
  476. dispatcher.convertMarker( 'addMarker', 'name', range );
  477. dispatcher.convertMarker( 'removeMarker', 'name', range );
  478. } );
  479. it( 'should fire conversion for each item in the range', () => {
  480. const element = new ModelElement( 'paragraph', null, [ new ModelText( 'foo bar baz' ) ] );
  481. root.appendChildren( [ element ] );
  482. range = ModelRange.createIn( root );
  483. const addMarkerData = [];
  484. const removeMarkerData = [];
  485. dispatcher.on( 'addMarker:name', ( evt, data ) => addMarkerData.push( data ) );
  486. dispatcher.on( 'removeMarker:name', ( evt, data ) => removeMarkerData.push( data ) );
  487. dispatcher.convertMarker( 'addMarker', 'name', range );
  488. dispatcher.convertMarker( 'removeMarker', 'name', range );
  489. // Check if events for all elements were fired.
  490. let i = 0;
  491. for ( const val of range ) {
  492. const nodeInRange = val.item;
  493. const addData = addMarkerData[ i ];
  494. const removeData = removeMarkerData[ i ];
  495. expect( addData.markerName ).to.equal( 'name' );
  496. expect( addData.markerRange ).to.equal( range );
  497. expect( addData.range.isEqual( ModelRange.createOn( nodeInRange ) ) );
  498. expect( removeData.markerName ).to.equal( 'name' );
  499. expect( removeData.markerRange ).to.equal( range );
  500. expect( removeData.range.isEqual( ModelRange.createOn( nodeInRange ) ) );
  501. if ( nodeInRange.is( 'textProxy' ) ) {
  502. expect( nodeInRange.data ).to.equal( addData.item.data );
  503. expect( nodeInRange.data ).to.equal( removeData.item.data );
  504. } else {
  505. expect( nodeInRange ).to.equal( addData.item );
  506. expect( nodeInRange ).to.equal( removeData.item );
  507. }
  508. i++;
  509. }
  510. } );
  511. it( 'should not fire events for already consumed items', () => {
  512. const element = new ModelElement( 'paragraph', null, [ new ModelText( 'foo bar baz' ) ] );
  513. root.appendChildren( [ element ] );
  514. const range = ModelRange.createIn( root );
  515. const addMarkerSpy = sinon.spy( ( evt, data, consumable ) => {
  516. // Consume all items in marker range.
  517. for ( const value of data.markerRange ) {
  518. consumable.consume( value.item, 'addMarker:marker' );
  519. }
  520. } );
  521. const removeMarkerSpy = sinon.spy( ( evt, data, consumable ) => {
  522. // Consume all items in marker range.
  523. for ( const value of data.markerRange ) {
  524. consumable.consume( value.item, 'removeMarker:marker' );
  525. }
  526. } );
  527. dispatcher.on( 'addMarker:marker', addMarkerSpy );
  528. dispatcher.on( 'addMarker:marker', removeMarkerSpy );
  529. dispatcher.convertMarker( 'addMarker', 'marker', range );
  530. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  531. sinon.assert.calledOnce( addMarkerSpy );
  532. sinon.assert.calledOnce( removeMarkerSpy );
  533. } );
  534. it( 'should fire event for collapsed marker', () => {
  535. const range = ModelRange.createFromParentsAndOffsets( root, 1, root, 1 );
  536. const addMarkerSpy = sinon.spy( ( evt, data, consumable ) => {
  537. expect( data.markerRange ).to.equal( range );
  538. expect( data.markerName ).to.equal( 'marker' );
  539. expect( consumable.test( data.markerRange, evt.name ) ).to.be.true;
  540. } );
  541. const removeMarkerSpy = sinon.spy( ( evt, data, consumable ) => {
  542. expect( data.markerRange ).to.equal( range );
  543. expect( data.markerName ).to.equal( 'marker' );
  544. expect( consumable.test( data.markerRange, evt.name ) ).to.be.true;
  545. } );
  546. dispatcher.on( 'addMarker:marker', addMarkerSpy );
  547. dispatcher.on( 'addMarker:marker', removeMarkerSpy );
  548. dispatcher.convertMarker( 'addMarker', 'marker', range );
  549. dispatcher.convertMarker( 'removeMarker', 'marker', range );
  550. sinon.assert.calledOnce( addMarkerSpy );
  551. sinon.assert.calledOnce( removeMarkerSpy );
  552. } );
  553. } );
  554. } );