modelconversiondispatcher.js 32 KB

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