viewconversiondispatcher.js 13 KB

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