8
0

modelconversiondispatcher.js 28 KB

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