modelconversiondispatcher.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  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. beforeEach( () => {
  33. image = new ModelElement( 'image' );
  34. root.appendChildren( [ image, '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( 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( 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().setAttr( 'key', 'value', image );
  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().setAttr( 'key', 'value', ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ) );
  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().setAttr( 'key', 'value', image ).setAttr( 'key', 'newValue', image );
  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().setAttr( 'key', 'value', range ).setAttr( '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. dispatcher.on( 'removeAttribute:key:$text', cbRemoveText );
  116. dispatcher.on( 'removeAttribute:key:image', cbRemoveImage );
  117. doc.batch().setAttr( 'key', 'value', image ).removeAttr( 'key', image );
  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().setAttr( 'key', 'value', range ).removeAttr( 'key', range );
  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. } );
  133. describe( 'convertInsert', () => {
  134. it( 'should fire event with correct parameters for every item in passed range', () => {
  135. root.appendChildren( [
  136. new ModelText( 'foo', { bold: true } ),
  137. new ModelElement( 'image' ),
  138. 'bar',
  139. new ModelElement( 'paragraph', { class: 'nice' }, new ModelText( 'xx', { italic: true } ) )
  140. ] );
  141. const range = ModelRange.createFromElement( root );
  142. const loggedEvents = [];
  143. // We will check everything connected with insert event:
  144. dispatcher.on( 'insert', ( evt, data, consumable ) => {
  145. // Check if the item is correct.
  146. const itemId = data.item.name ? data.item.name : '$text:' + data.item.text;
  147. // Check if the range is correct.
  148. const log = 'insert:' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  149. loggedEvents.push( log );
  150. // Check if the event name is correct.
  151. expect( evt.name ).to.equal( 'insert:' + ( data.item.name || '$text' ) );
  152. // Check if model consumable is correct.
  153. expect( consumable.consume( data.item, 'insert' ) ).to.be.true;
  154. } );
  155. // Same here.
  156. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  157. const itemId = data.item.name ? data.item.name : '$text:' + data.item.text;
  158. const key = data.attributeKey;
  159. const value = data.attributeNewValue;
  160. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  161. loggedEvents.push( log );
  162. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  163. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  164. } );
  165. dispatcher.convertInsert( range );
  166. // Check the data passed to called events and the order of them.
  167. expect( loggedEvents ).to.deep.equal( [
  168. 'insert:$text:foo:0:3',
  169. 'addAttribute:bold:true:$text:foo:0:3',
  170. 'insert:image:3:4',
  171. 'insert:$text:bar:4:7',
  172. 'insert:paragraph:7:8',
  173. 'addAttribute:class:nice:paragraph:7:8',
  174. 'insert:$text:xx:7,0:7,2',
  175. 'addAttribute:italic:true:$text:xx:7,0:7,2'
  176. ] );
  177. } );
  178. it( 'should not fire events for already consumed parts of model', () => {
  179. root.appendChildren( [
  180. new ModelElement( 'image', { src: 'foo.jpg', title: 'bar', bold: true }, new ModelElement( 'caption', {}, 'title' ) )
  181. ] );
  182. sinon.spy( dispatcher, 'fire' );
  183. dispatcher.on( 'insert:image', ( evt, data, consumable ) => {
  184. consumable.consume( data.item.getChild( 0 ), 'insert' );
  185. consumable.consume( data.item, 'addAttribute:bold' );
  186. } );
  187. const range = ModelRange.createFromElement( root );
  188. dispatcher.convertInsert( range );
  189. expect( dispatcher.fire.calledWith( 'insert:image' ) ).to.be.true;
  190. expect( dispatcher.fire.calledWith( 'addAttribute:src:image' ) ).to.be.true;
  191. expect( dispatcher.fire.calledWith( 'addAttribute:title:image' ) ).to.be.true;
  192. expect( dispatcher.fire.calledWith( 'insert:$text' ) ).to.be.true;
  193. expect( dispatcher.fire.calledWith( 'addAttribute:bold:image' ) ).to.be.false;
  194. expect( dispatcher.fire.calledWith( 'insert:caption' ) ).to.be.false;
  195. } );
  196. } );
  197. describe( 'convertMove', () => {
  198. it( 'should fire single event for moved range', () => {
  199. root.appendChildren( 'barfoo' );
  200. const range = ModelRange.createFromParentsAndOffsets( root, 0, root, 3 );
  201. const loggedEvents = [];
  202. dispatcher.on( 'move', ( evt, data ) => {
  203. const log = 'move:' + data.sourcePosition.path + ':' + data.range.start.path + ':' + data.range.end.path;
  204. loggedEvents.push( log );
  205. } );
  206. dispatcher.convertMove( ModelPosition.createFromParentAndOffset( root , 3 ), range );
  207. expect( loggedEvents ).to.deep.equal( [ 'move:3:0:3' ] );
  208. } );
  209. } );
  210. describe( 'convertRemove', () => {
  211. it( 'should fire single event for removed range', () => {
  212. root.appendChildren( 'foo' );
  213. doc.graveyard.appendChildren( 'bar' );
  214. const range = ModelRange.createFromParentsAndOffsets( doc.graveyard, 0, doc.graveyard, 3 );
  215. const loggedEvents = [];
  216. dispatcher.on( 'remove', ( evt, data ) => {
  217. const log = 'remove:' + data.sourcePosition.path + ':' + data.range.start.path + ':' + data.range.end.path;
  218. loggedEvents.push( log );
  219. } );
  220. dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( root , 3 ), range );
  221. expect( loggedEvents ).to.deep.equal( [ 'remove:3:0:3' ] );
  222. } );
  223. } );
  224. describe( 'convertAttribute', () => {
  225. it( 'should fire event for every item in passed range', () => {
  226. root.appendChildren( [
  227. new ModelText( 'foo', { bold: true } ),
  228. new ModelElement( 'image', { bold: true } ),
  229. new ModelElement( 'paragraph', { bold: true, class: 'nice' }, new ModelText( 'xx', { bold: true, italic: true } ) )
  230. ] );
  231. const range = ModelRange.createFromElement( root );
  232. const loggedEvents = [];
  233. dispatcher.on( 'addAttribute', ( evt, data, consumable ) => {
  234. const itemId = data.item.name ? data.item.name : '$text:' + data.item.text;
  235. const key = data.attributeKey;
  236. const value = data.attributeNewValue;
  237. const log = 'addAttribute:' + key + ':' + value + ':' + itemId + ':' + data.range.start.path + ':' + data.range.end.path;
  238. loggedEvents.push( log );
  239. expect( evt.name ).to.equal( 'addAttribute:' + key + ':' + ( data.item.name || '$text' ) );
  240. expect( consumable.consume( data.item, 'addAttribute:' + key ) ).to.be.true;
  241. } );
  242. dispatcher.convertAttribute( 'addAttribute', range, 'bold', null, true );
  243. expect( loggedEvents ).to.deep.equal( [
  244. 'addAttribute:bold:true:$text:foo:0:3',
  245. 'addAttribute:bold:true:image:3:4',
  246. 'addAttribute:bold:true:paragraph:4:5',
  247. 'addAttribute:bold:true:$text:xx:4,0:4,2'
  248. ] );
  249. } );
  250. it( 'should not fire events for already consumed parts of model', () => {
  251. root.appendChildren( [
  252. new ModelElement( 'element', null, new ModelElement( 'inside' ) )
  253. ] );
  254. sinon.spy( dispatcher, 'fire' );
  255. dispatcher.on( 'removeAttribute:attr:element', ( evt, data, consumable ) => {
  256. consumable.consume( data.item.getChild( 0 ), 'removeAttribute:attr' );
  257. } );
  258. const range = ModelRange.createFromElement( root );
  259. dispatcher.convertAttribute( 'removeAttribute', range, 'attr', 'value', null );
  260. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:element' ) ).to.be.true;
  261. expect( dispatcher.fire.calledWith( 'removeAttribute:attr:inside' ) ).to.be.false;
  262. } );
  263. } );
  264. } );