modelconversiondispatcher.js 32 KB

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