viewconversiondispatcher.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher';
  6. import ViewContainerElement from '../../src/view/containerelement';
  7. import ViewDocumentFragment from '../../src/view/documentfragment';
  8. import ViewText from '../../src/view/text';
  9. import Model from '../../src/model/model';
  10. import ModelText from '../../src/model/text';
  11. import ModelElement from '../../src/model/element';
  12. import ModelDocumentFragment from '../../src/model/documentfragment';
  13. import { stringify } from '../../src/dev-utils/model';
  14. import log from '@ckeditor/ckeditor5-utils/src/log';
  15. // Stored in case it is silenced and has to be restored.
  16. const logWarn = log.warn;
  17. describe( 'ViewConversionDispatcher', () => {
  18. let model;
  19. afterEach( () => {
  20. model = new Model();
  21. log.warn = logWarn;
  22. } );
  23. describe( 'constructor()', () => {
  24. it( 'should create ViewConversionDispatcher with passed api', () => {
  25. const apiObj = {};
  26. const dispatcher = new ViewConversionDispatcher( model, { apiObj } );
  27. expect( dispatcher.model ).to.equal( model );
  28. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  29. expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
  30. expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
  31. } );
  32. } );
  33. describe( 'convert', () => {
  34. let dispatcher;
  35. beforeEach( () => {
  36. dispatcher = new ViewConversionDispatcher( model );
  37. } );
  38. it( 'should fire viewCleanup event on converted view part', () => {
  39. silenceWarnings();
  40. sinon.spy( dispatcher, 'fire' );
  41. const viewP = new ViewContainerElement( 'p' );
  42. dispatcher.convert( viewP );
  43. expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true;
  44. } );
  45. it( 'should fire proper events', () => {
  46. silenceWarnings();
  47. const viewText = new ViewText( 'foobar' );
  48. const viewElement = new ViewContainerElement( 'p', null, viewText );
  49. const viewFragment = new ViewDocumentFragment( viewElement );
  50. sinon.spy( dispatcher, 'fire' );
  51. dispatcher.convert( viewText );
  52. dispatcher.convert( viewElement );
  53. dispatcher.convert( viewFragment );
  54. expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true;
  55. expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true;
  56. expect( dispatcher.fire.calledWith( 'documentFragment' ) ).to.be.true;
  57. } );
  58. it( 'should convert ViewText', () => {
  59. const spy = sinon.spy();
  60. const viewText = new ViewText( 'foobar' );
  61. dispatcher.on( 'text', ( evt, data, consumable, conversionApi ) => {
  62. // Check if this method has been fired.
  63. spy();
  64. // Check correctness of passed parameters.
  65. expect( evt.name ).to.equal( 'text' );
  66. expect( data.input ).to.equal( viewText );
  67. expect( data.foo ).to.equal( 'bar' );
  68. // Check whether consumable has appropriate value to consume.
  69. expect( consumable.consume( data.input ) ).to.be.true;
  70. // Check whether conversionApi of `dispatcher` has been passed.
  71. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  72. // Set conversion result to `output` property of `data`.
  73. // Later we will check if it was returned by `convert` method.
  74. data.output = new ModelText( data.foo );
  75. } );
  76. // Use `additionalData` parameter to check if it was passed to the event.
  77. const conversionResult = dispatcher.convert( viewText, { foo: 'bar' } );
  78. // Check conversion result.
  79. // Result should be wrapped in document fragment.
  80. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  81. expect( conversionResult.getChild( 0 ).data ).to.equal( 'bar' );
  82. expect( spy.calledOnce ).to.be.true;
  83. } );
  84. it( 'should convert ViewContainerElement', () => {
  85. const spy = sinon.spy();
  86. const viewElement = new ViewContainerElement( 'p', { attrKey: 'attrValue' } );
  87. dispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  88. // Check if this method has been fired.
  89. spy();
  90. // Check correctness of passed parameters.
  91. expect( evt.name ).to.equal( 'element:p' );
  92. expect( data.input ).to.equal( viewElement );
  93. expect( data.foo ).to.equal( 'bar' );
  94. // Check whether consumable has appropriate value to consume.
  95. expect( consumable.consume( data.input, { name: true } ) ).to.be.true;
  96. expect( consumable.consume( data.input, { attribute: 'attrKey' } ) ).to.be.true;
  97. // Check whether conversionApi of `dispatcher` has been passed.
  98. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  99. // Set conversion result to `output` property of `data`.
  100. // Later we will check if it was returned by `convert` method.
  101. data.output = new ModelElement( 'paragraph' );
  102. } );
  103. // Use `additionalData` parameter to check if it was passed to the event.
  104. const conversionResult = dispatcher.convert( viewElement, { foo: 'bar' } );
  105. // Check conversion result.
  106. // Result should be wrapped in document fragment.
  107. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  108. expect( conversionResult.getChild( 0 ).name ).to.equal( 'paragraph' );
  109. expect( spy.calledOnce ).to.be.true;
  110. } );
  111. it( 'should convert ViewDocumentFragment', () => {
  112. const spy = sinon.spy();
  113. const viewFragment = new ViewDocumentFragment();
  114. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  115. // Check if this method has been fired.
  116. spy();
  117. // Check correctness of passed parameters.
  118. expect( evt.name ).to.equal( 'documentFragment' );
  119. expect( data.input ).to.equal( viewFragment );
  120. expect( data.foo ).to.equal( 'bar' );
  121. // Check whether consumable has appropriate value to consume.
  122. expect( consumable.consume( data.input ) ).to.be.true;
  123. // Check whether conversionApi of `dispatcher` has been passed.
  124. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  125. // Set conversion result to `output` property of `data`.
  126. // Later we will check if it was returned by `convert` method.
  127. data.output = new ModelDocumentFragment( [ new ModelText( 'foo' ) ] );
  128. } );
  129. // Use `additionalData` parameter to check if it was passed to the event.
  130. const conversionResult = dispatcher.convert( viewFragment, { foo: 'bar' } );
  131. // Check conversion result.
  132. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment );
  133. expect( conversionResult.getChild( 0 ).data ).to.equal( 'foo' );
  134. expect( spy.calledOnce ).to.be.true;
  135. } );
  136. it( 'should extract temporary markers elements from converter element and create static markers list', () => {
  137. const viewFragment = new ViewDocumentFragment();
  138. dispatcher.on( 'documentFragment', ( evt, data ) => {
  139. data.output = new ModelDocumentFragment( [
  140. new ModelText( 'fo' ),
  141. new ModelElement( '$marker', { 'data-name': 'marker1' } ),
  142. new ModelText( 'o' ),
  143. new ModelElement( '$marker', { 'data-name': 'marker2' } ),
  144. new ModelText( 'b' ),
  145. new ModelElement( '$marker', { 'data-name': 'marker1' } ),
  146. new ModelText( 'ar' ),
  147. ] );
  148. } );
  149. const conversionResult = dispatcher.convert( viewFragment );
  150. expect( conversionResult.markers.size ).to.equal( 2 );
  151. expect( stringify( conversionResult, conversionResult.markers.get( 'marker1' ) ) ).to.deep.equal( 'fo[ob]ar' );
  152. expect( stringify( conversionResult, conversionResult.markers.get( 'marker2' ) ) ).to.deep.equal( 'foo[]bar' );
  153. } );
  154. } );
  155. describe( 'conversionApi', () => {
  156. let spy, spyP, spyText, viewP, viewText, modelP, modelText, consumableMock, dispatcher,
  157. spyNull, spyArray, viewDiv, viewNull, viewArray;
  158. beforeEach( () => {
  159. spy = sinon.spy();
  160. spyP = sinon.spy();
  161. spyText = sinon.spy();
  162. viewP = new ViewContainerElement( 'p' );
  163. viewText = new ViewText( 'foobar' );
  164. modelP = new ModelElement( 'paragraph' );
  165. modelText = new ModelText( 'foobar' );
  166. consumableMock = {};
  167. dispatcher = new ViewConversionDispatcher( model );
  168. dispatcher.on( 'element:p', ( evt, data, consumable ) => {
  169. spyP();
  170. expect( data.foo ).to.equal( 'bar' );
  171. expect( consumable ).to.equal( consumableMock );
  172. data.output = modelP;
  173. } );
  174. dispatcher.on( 'text', ( evt, data, consumable ) => {
  175. spyText();
  176. expect( data.foo ).to.equal( 'bar' );
  177. expect( consumable ).to.equal( consumableMock );
  178. data.output = modelText;
  179. } );
  180. spyNull = sinon.spy();
  181. spyArray = sinon.spy();
  182. viewDiv = new ViewContainerElement( 'div' ); // Will not be recognized and not converted.
  183. viewNull = new ViewContainerElement( 'null' ); // Will return `null` in `data.output` upon conversion.
  184. viewArray = new ViewContainerElement( 'array' ); // Will return an array in `data.output` upon conversion.
  185. dispatcher.on( 'element:null', ( evt, data ) => {
  186. spyNull();
  187. data.output = null;
  188. } );
  189. dispatcher.on( 'element:array', ( evt, data ) => {
  190. spyArray();
  191. data.output = [ new ModelText( 'foo' ) ];
  192. } );
  193. } );
  194. describe( 'convertItem', () => {
  195. it( 'should pass consumable and additional data to proper converter and return data.output', () => {
  196. silenceWarnings();
  197. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  198. spy();
  199. expect( conversionApi.convertItem( viewP, consumableMock, data ) ).to.equal( modelP );
  200. expect( conversionApi.convertItem( viewText, consumableMock, data ) ).to.equal( modelText );
  201. } );
  202. dispatcher.convert( new ViewDocumentFragment(), { foo: 'bar' } );
  203. expect( spy.calledOnce ).to.be.true;
  204. expect( spyP.calledOnce ).to.be.true;
  205. expect( spyText.calledOnce ).to.be.true;
  206. } );
  207. it( 'should do nothing if element was not converted', () => {
  208. sinon.stub( log, 'warn' );
  209. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  210. spy();
  211. expect( conversionApi.convertItem( viewDiv ) ).to.equal( null );
  212. expect( conversionApi.convertItem( viewNull ) ).to.equal( null );
  213. } );
  214. dispatcher.convert( new ViewDocumentFragment() );
  215. expect( spy.calledOnce ).to.be.true;
  216. expect( spyNull.calledOnce ).to.be.true;
  217. expect( log.warn.called ).to.be.false;
  218. log.warn.restore();
  219. } );
  220. it( 'should return null if element was incorrectly converted and log a warning', () => {
  221. sinon.stub( log, 'warn' );
  222. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  223. spy();
  224. expect( conversionApi.convertItem( viewArray ) ).to.equal( null );
  225. } );
  226. dispatcher.convert( new ViewDocumentFragment() );
  227. expect( spy.calledOnce ).to.be.true;
  228. expect( spyArray.calledOnce ).to.be.true;
  229. expect( log.warn.calledOnce ).to.be.true;
  230. log.warn.restore();
  231. } );
  232. } );
  233. describe( 'convertChildren', () => {
  234. it( 'should fire conversion for all children of passed element and return conversion results ' +
  235. 'wrapped in document fragment', () => {
  236. silenceWarnings();
  237. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  238. spy();
  239. const result = conversionApi.convertChildren( data.input, consumableMock, data );
  240. expect( result ).to.be.instanceof( ModelDocumentFragment );
  241. expect( result.childCount ).to.equal( 2 );
  242. expect( result.getChild( 0 ) ).to.equal( modelP );
  243. expect( result.getChild( 1 ) ).to.equal( modelText );
  244. } );
  245. dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), { foo: 'bar' } );
  246. expect( spy.calledOnce ).to.be.true;
  247. expect( spyP.calledOnce ).to.be.true;
  248. expect( spyText.calledOnce ).to.be.true;
  249. } );
  250. it( 'should filter out incorrectly converted elements and log warnings', () => {
  251. sinon.stub( log, 'warn' );
  252. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  253. spy();
  254. const result = conversionApi.convertChildren( data.input, consumableMock, data );
  255. expect( result ).to.be.instanceof( ModelDocumentFragment );
  256. expect( result.childCount ).to.equal( 2 );
  257. expect( result.getChild( 0 ) ).to.equal( modelP );
  258. expect( result.getChild( 1 ) ).to.equal( modelText );
  259. } );
  260. dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), { foo: 'bar' } );
  261. expect( spy.calledOnce ).to.be.true;
  262. expect( spyNull.calledOnce ).to.be.true;
  263. expect( spyArray.calledOnce ).to.be.true;
  264. expect( log.warn.calledOnce ).to.be.true;
  265. log.warn.restore();
  266. } );
  267. } );
  268. } );
  269. // Silences warnings that pop up in tests. Use when the test checks a specific functionality and we are not interested in those logs.
  270. // No need to restore `log.warn` - it is done in `afterEach()`.
  271. function silenceWarnings() {
  272. log.warn = () => {};
  273. }
  274. } );