modelconversiondispatcher.js 14 KB

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