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