viewconversiondispatcher.js 13 KB

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