modelconversiondispatcher.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  7. import ModelDocument from '/ckeditor5/engine/model/document.js';
  8. import ModelText from '/ckeditor5/engine/model/text.js';
  9. import ModelElement from '/ckeditor5/engine/model/element.js';
  10. import ModelRange from '/ckeditor5/engine/model/range.js';
  11. import ModelPosition from '/ckeditor5/engine/model/position.js';
  12. import RemoveOperation from '/ckeditor5/engine/model/operation/removeoperation.js';
  13. import { wrapInDelta } from '/tests/engine/model/_utils/utils.js';
  14. describe( 'ModelConversionDispatcher', () => {
  15. let dispatcher, doc, root;
  16. beforeEach( () => {
  17. dispatcher = new ModelConversionDispatcher();
  18. doc = new ModelDocument();
  19. root = doc.createRoot();
  20. } );
  21. describe( 'constructor', () => {
  22. it( 'should create ModelConversionDispatcher with given api', () => {
  23. const apiObj = {};
  24. const dispatcher = new ModelConversionDispatcher( { apiObj } );
  25. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  26. } );
  27. } );
  28. describe( 'convertChange', () => {
  29. // We will do integration tests here. Unit tests will be done for methods that are used
  30. // by `convertChange` internally. This way we will have two kinds of tests.
  31. let image, imagePos;
  32. beforeEach( () => {
  33. image = new ModelElement( 'image' );
  34. root.appendChildren( [ image, new ModelText( 'foobar' ) ] );
  35. imagePos = ModelPosition.createBefore( image );
  36. dispatcher.listenTo( doc, 'change', ( evt, type, changes ) => {
  37. dispatcher.convertChange( type, changes );
  38. } );
  39. } );
  40. it( 'should fire insert and addAttribute callbacks for insertion changes', () => {
  41. const cbInsertText = sinon.spy();
  42. const cbInsertImage = sinon.spy();
  43. const cbAddAttribute = sinon.spy();
  44. dispatcher.on( 'insert:$text', cbInsertText );
  45. dispatcher.on( 'insert:image', cbInsertImage );
  46. dispatcher.on( 'addAttribute:key:$text', cbAddAttribute );
  47. const insertedText = new ModelText( 'foo', { key: 'value' } );
  48. doc.batch().insert( ModelPosition.createFromParentAndOffset( root, 0 ), insertedText );
  49. expect( cbInsertText.called ).to.be.true;
  50. expect( cbAddAttribute.called ).to.be.true;
  51. expect( cbInsertImage.called ).to.be.false;
  52. } );
  53. it( 'should fire insert and addAttribute callbacks for reinsertion changes', () => {
  54. image.setAttribute( 'key', 'value' );
  55. // We will just create reinsert operation by reverting remove operation
  56. // because creating reinsert change is tricky and not available through batch API.
  57. const removeOperation = new RemoveOperation( imagePos, 1, 0 );
  58. // Let's apply remove operation so reinsert operation won't break.
  59. doc.applyOperation( wrapInDelta( removeOperation ) );
  60. const cbInsertText = sinon.spy();
  61. const cbInsertImage = sinon.spy();
  62. const cbAddAttribute = sinon.spy();
  63. dispatcher.on( 'insert:$text', cbInsertText );
  64. dispatcher.on( 'insert:image', cbInsertImage );
  65. dispatcher.on( 'addAttribute:key:image', cbAddAttribute );
  66. doc.applyOperation( wrapInDelta( removeOperation.getReversed() ) );
  67. expect( cbInsertImage.called ).to.be.true;
  68. expect( cbAddAttribute.called ).to.be.true;
  69. expect( cbInsertText.called ).to.be.false;
  70. } );
  71. it( 'should fire move callback for move changes', () => {
  72. const cbMove = sinon.spy();
  73. dispatcher.on( 'move', cbMove );
  74. doc.batch().move( image, imagePos.getShiftedBy( 3 ) );
  75. expect( cbMove.called );
  76. } );
  77. it( 'should fire remove callback for remove changes', () => {
  78. const cbRemove = sinon.spy();
  79. dispatcher.on( 'remove', cbRemove );
  80. doc.batch().remove( image );
  81. expect( cbRemove.called );
  82. } );
  83. it( 'should fire addAttribute callbacks for add attribute change', () => {
  84. const cbAddText = sinon.spy();
  85. const cbAddImage = sinon.spy();
  86. dispatcher.on( 'addAttribute:key:$text', cbAddText );
  87. dispatcher.on( 'addAttribute:key:image', cbAddImage );
  88. doc.batch().setAttribute( image, 'key', 'value' );
  89. // Callback for adding attribute on text not called.
  90. expect( cbAddText.called ).to.be.false;
  91. expect( cbAddImage.calledOnce ).to.be.true;
  92. doc.batch().setAttribute( ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ), 'key', 'value' );
  93. expect( cbAddText.calledOnce ).to.be.true;
  94. // Callback for adding attribute on image not called this time.
  95. expect( cbAddImage.calledOnce ).to.be.true;
  96. } );
  97. it( 'should fire changeAttribute callbacks for change attribute change', () => {
  98. const cbChangeText = sinon.spy();
  99. const cbChangeImage = sinon.spy();
  100. dispatcher.on( 'changeAttribute:key:$text', cbChangeText );
  101. dispatcher.on( 'changeAttribute:key:image', cbChangeImage );
  102. doc.batch().setAttribute( image, 'key', 'value' ).setAttribute( image, 'key', 'newValue' );
  103. // Callback for adding attribute on text not called.
  104. expect( cbChangeText.called ).to.be.false;
  105. expect( cbChangeImage.calledOnce ).to.be.true;
  106. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 );
  107. doc.batch().setAttribute( range, 'key', 'value' ).setAttribute( range, 'key', 'newValue' );
  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. dispatcher.on( 'removeAttribute:key:$text', cbRemoveText );
  116. dispatcher.on( 'removeAttribute:key:image', cbRemoveImage );
  117. doc.batch().setAttribute( image, 'key', 'value' ).removeAttribute( image, 'key' );
  118. // Callback for adding attribute on text not called.
  119. expect( cbRemoveText.called ).to.be.false;
  120. expect( cbRemoveImage.calledOnce ).to.be.true;
  121. const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 );
  122. doc.batch().setAttribute( range, 'key', 'value' ).removeAttribute( range, 'key' );
  123. expect( cbRemoveText.calledOnce ).to.be.true;
  124. // Callback for adding attribute on image not called this time.
  125. expect( cbRemoveImage.calledOnce ).to.be.true;
  126. } );
  127. it( 'should not fire any event if not recognized event type was passed', () => {
  128. sinon.spy( dispatcher, 'fire' );
  129. dispatcher.convertChange( 'unknown', { foo: 'bar' } );
  130. expect( dispatcher.fire.called ).to.be.false;
  131. } );
  132. it( 'should not fire any event if change was in graveyard root and change type is different than remove', () => {
  133. sinon.spy( dispatcher, 'fire' );
  134. let gyNode = new ModelElement( 'image' );
  135. doc.graveyard.appendChildren( gyNode );
  136. doc.batch().setAttribute( gyNode, 'key', 'value' );
  137. expect( dispatcher.fire.called ).to.be.false;
  138. } );
  139. } );
  140. describe( 'convertInsert', () => {
  141. it( 'should fire event with correct parameters for every item in passed range', () => {
  142. root.appendChildren( [
  143. new ModelText( 'foo', { bold: true } ),
  144. new ModelElement( 'image' ),
  145. new ModelText( 'bar' ),
  146. new ModelElement( 'paragraph', { class: 'nice' }, new ModelText( 'xx', { italic: true } ) )
  147. ] );
  148. const range = ModelRange.createIn( root );
  149. const loggedEvents = [];
  150. // We will check everything connected with insert event:
  151. dispatcher.on( 'insert', ( evt, data, consumable ) => {
  152. // Check if the item is correct.
  153. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  154. // Check if the range is correct.
  155. const log = 'insert:' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  156. loggedEvents.push( log );
  157. // Check if the event name is correct.
  158. expect( evt.name ).to.equal( 'insert:' + ( data.item.name || '$text' ) );
  159. // Check if model consumable is correct.
  160. expect( consumable.consume( data.item, 'insert' ) ).to.be.true;
  161. } );
  162. // Same here.
  163. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  164. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  165. const key = data.attributeKey;
  166. const value = data.attributeNewValue;
  167. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  168. loggedEvents.push( log );
  169. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  170. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  171. } );
  172. dispatcher.convertInsertion( range );
  173. // Check the data passed to called events and the order of them.
  174. expect( loggedEvents ).to.deep.equal( [
  175. 'insert:$text:foo:0:3',
  176. 'addAttribute:bold:true:$text:foo:0:3',
  177. 'insert:image:3:4',
  178. 'insert:$text:bar:4:7',
  179. 'insert:paragraph:7:8',
  180. 'addAttribute:class:nice:paragraph:7:8',
  181. 'insert:$text:xx:7,0:7,2',
  182. 'addAttribute:italic:true:$text:xx:7,0:7,2'
  183. ] );
  184. } );
  185. it( 'should not fire events for already consumed parts of model', () => {
  186. root.appendChildren( [
  187. new ModelElement( 'image', { src: 'foo.jpg', title: 'bar', bold: true }, [
  188. new ModelElement( 'caption', {}, new ModelText( 'title' ) )
  189. ] )
  190. ] );
  191. sinon.spy( dispatcher, 'fire' );
  192. dispatcher.on( 'insert:image', ( evt, data, consumable ) => {
  193. consumable.consume( data.item.getChild( 0 ), 'insert' );
  194. consumable.consume( data.item, 'addAttribute:bold' );
  195. } );
  196. const range = ModelRange.createIn( root );
  197. dispatcher.convertInsertion( range );
  198. expect( dispatcher.fire.calledWith( 'insert:image' ) ).to.be.true;
  199. expect( dispatcher.fire.calledWith( 'addAttribute:src:image' ) ).to.be.true;
  200. expect( dispatcher.fire.calledWith( 'addAttribute:title:image' ) ).to.be.true;
  201. expect( dispatcher.fire.calledWith( 'insert:$text' ) ).to.be.true;
  202. expect( dispatcher.fire.calledWith( 'addAttribute:bold:image' ) ).to.be.false;
  203. expect( dispatcher.fire.calledWith( 'insert:caption' ) ).to.be.false;
  204. } );
  205. } );
  206. describe( 'convertMove', () => {
  207. it( 'should fire single event for moved range', () => {
  208. root.appendChildren( new ModelText( 'barfoo' ) );
  209. const range = ModelRange.createFromParentsAndOffsets( root, 0, root, 3 );
  210. const loggedEvents = [];
  211. dispatcher.on( 'move', ( evt, data ) => {
  212. const log = 'move:' + data.sourcePosition.path + ':' + data.range.start.path + ':' + data.range.end.path;
  213. loggedEvents.push( log );
  214. } );
  215. dispatcher.convertMove( ModelPosition.createFromParentAndOffset( root , 3 ), range );
  216. expect( loggedEvents ).to.deep.equal( [ 'move:3:0:3' ] );
  217. } );
  218. } );
  219. describe( 'convertRemove', () => {
  220. it( 'should fire single event for removed range', () => {
  221. root.appendChildren( new ModelText( 'foo' ) );
  222. doc.graveyard.appendChildren( new ModelText( 'bar' ) );
  223. const range = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 3 );
  224. const loggedEvents = [];
  225. dispatcher.on( 'remove', ( evt, data ) => {
  226. const log = 'remove:' + data.sourcePosition.path + ':' + data.range.start.path + ':' + data.range.end.path;
  227. loggedEvents.push( log );
  228. } );
  229. dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( root , 3 ), range );
  230. expect( loggedEvents ).to.deep.equal( [ 'remove:3:0:3' ] );
  231. } );
  232. } );
  233. describe( 'convertAttribute', () => {
  234. it( 'should fire event for every item in passed range', () => {
  235. root.appendChildren( [
  236. new ModelText( 'foo', { bold: true } ),
  237. new ModelElement( 'image', { bold: true } ),
  238. new ModelElement( 'paragraph', { bold: true, class: 'nice' }, new ModelText( 'xx', { bold: true, italic: true } ) )
  239. ] );
  240. const range = ModelRange.createIn( root );
  241. const loggedEvents = [];
  242. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  243. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data;
  244. const key = data.attributeKey;
  245. const value = data.attributeNewValue;
  246. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  247. loggedEvents.push( log );
  248. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  249. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  250. } );
  251. dispatcher.convertAttribute( 'addAttribute', range, 'bold', null, true );
  252. expect( loggedEvents ).to.deep.equal( [
  253. 'addAttribute:bold:true:$text:foo:0:3',
  254. 'addAttribute:bold:true:image:3:4',
  255. 'addAttribute:bold:true:paragraph:4:5',
  256. 'addAttribute:bold:true:$text:xx:4,0:4,2'
  257. ] );
  258. } );
  259. it( 'should not fire events for already consumed parts of model', () => {
  260. root.appendChildren( [
  261. new ModelElement( 'element', null, new ModelElement( 'inside' ) )
  262. ] );
  263. sinon.spy( dispatcher, 'fire' );
  264. dispatcher.on( 'removeAttribute:attr:element', ( evt, data, consumable ) => {
  265. consumable.consume( data.item.getChild( 0 ), 'removeAttribute:attr' );
  266. } );
  267. const range = ModelRange.createIn( root );
  268. dispatcher.convertAttribute( 'removeAttribute', range, 'attr', 'value', null );
  269. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:element' ) ).to.be.true;
  270. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:inside' ) ).to.be.false;
  271. } );
  272. } );
  273. describe( 'convertSelection', () => {
  274. beforeEach( () => {
  275. dispatcher.off( 'selection' );
  276. root.appendChildren( new ModelText( 'foobar' ) );
  277. doc.selection.setRanges( [
  278. new ModelRange( new ModelPosition( root, [ 1 ] ), new ModelPosition( root, [ 3 ] ) ),
  279. new ModelRange( new ModelPosition( root, [ 4 ] ), new ModelPosition( root, [ 5 ] ) )
  280. ] );
  281. } );
  282. it( 'should fire selection event', () => {
  283. sinon.spy( dispatcher, 'fire' );
  284. dispatcher.convertSelection( doc.selection );
  285. expect( dispatcher.fire.calledWith(
  286. 'selection',
  287. { selection: sinon.match.instanceOf( doc.selection.constructor ) }
  288. ) ).to.be.true;
  289. } );
  290. it( 'should prepare correct list of consumable values', () => {
  291. doc.enqueueChanges( () => {
  292. doc.batch()
  293. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  294. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  295. } );
  296. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  297. expect( consumable.test( data.selection, 'selection' ) ).to.be.true;
  298. expect( consumable.test( data.selection, 'selectionAttribute:bold' ) ).to.be.true;
  299. expect( consumable.test( data.selection, 'selectionAttribute:italic' ) ).to.be.null;
  300. } );
  301. dispatcher.convertSelection( doc.selection );
  302. } );
  303. it( 'should fire attributes events for selection', () => {
  304. sinon.spy( dispatcher, 'fire' );
  305. doc.enqueueChanges( () => {
  306. doc.batch()
  307. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  308. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  309. } );
  310. dispatcher.convertSelection( doc.selection );
  311. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.true;
  312. expect( dispatcher.fire.calledWith( 'selectionAttribute:italic' ) ).to.be.false;
  313. } );
  314. it( 'should not fire attributes events if attribute has been consumed', () => {
  315. sinon.spy( dispatcher, 'fire' );
  316. dispatcher.on( 'selection', ( evt, data, consumable ) => {
  317. consumable.consume( data.selection, 'selectionAttribute:bold' );
  318. } );
  319. doc.enqueueChanges( () => {
  320. doc.batch()
  321. .setAttribute( ModelRange.createIn( root ), 'bold', true )
  322. .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true );
  323. } );
  324. dispatcher.convertSelection( doc.selection );
  325. expect( dispatcher.fire.calledWith( 'selectionAttribute:bold' ) ).to.be.false;
  326. } );
  327. } );
  328. } );