viewconversiondispatcher.js 12 KB

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