viewconversiondispatcher.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  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 ViewAttributeElement from '../../src/view/attributeelement';
  8. import ViewDocumentFragment from '../../src/view/documentfragment';
  9. import ViewText from '../../src/view/text';
  10. import ModelSchema from '../../src/model/schema';
  11. import buildViewConverter from '../../src/conversion/buildviewconverter';
  12. import { convertText } from '../../src/conversion/view-to-model-converters';
  13. import { stringify } from '../../src/dev-utils/model';
  14. describe( 'ViewConversionDispatcher', () => {
  15. describe( 'constructor()', () => {
  16. it( 'should create ViewConversionDispatcher with passed api', () => {
  17. const apiObj = {};
  18. const dispatcher = new ViewConversionDispatcher( { apiObj } );
  19. expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
  20. expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
  21. expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
  22. } );
  23. } );
  24. describe( 'convert', () => {
  25. let dispatcher;
  26. beforeEach( () => {
  27. dispatcher = new ViewConversionDispatcher();
  28. } );
  29. it( 'should fire viewCleanup event on converted view part', () => {
  30. sinon.spy( dispatcher, 'fire' );
  31. const viewP = new ViewContainerElement( 'p' );
  32. dispatcher.convert( viewP );
  33. expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true;
  34. } );
  35. it( 'should fire proper events', () => {
  36. const viewText = new ViewText( 'foobar' );
  37. const viewElement = new ViewContainerElement( 'p', null, viewText );
  38. const viewFragment = new ViewDocumentFragment( viewElement );
  39. sinon.spy( dispatcher, 'fire' );
  40. dispatcher.convert( viewText );
  41. dispatcher.convert( viewElement );
  42. dispatcher.convert( viewFragment );
  43. expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true;
  44. expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true;
  45. expect( dispatcher.fire.calledWith( 'documentFragment' ) ).to.be.true;
  46. } );
  47. it( 'should convert ViewText', () => {
  48. const viewText = new ViewText( 'foobar' );
  49. dispatcher.on( 'text', ( evt, data, consumable, conversionApi ) => {
  50. const result = {
  51. eventName: evt.name,
  52. input: data.input,
  53. // Check whether additional data has been passed.
  54. foo: data.foo
  55. };
  56. // Check whether consumable has appropriate value to consume.
  57. expect( consumable.consume( data.input ) ).to.be.true;
  58. // Check whether conversionApi of `dispatcher` has been passed.
  59. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  60. // Set conversion result to `output` property of `data`.
  61. // Later we will check if it was returned by `convert` method.
  62. data.output = result;
  63. } );
  64. // Use `additionalData` parameter to check if it was passed to the event.
  65. const conversionResult = dispatcher.convert( viewText, { foo: 'bar' } );
  66. // Check conversion result.
  67. expect( conversionResult ).to.deep.equal( {
  68. eventName: 'text',
  69. input: viewText,
  70. foo: 'bar'
  71. } );
  72. } );
  73. it( 'should convert ViewContainerElement', () => {
  74. const viewElement = new ViewContainerElement( 'p', { attrKey: 'attrValue' } );
  75. dispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  76. const result = {
  77. eventName: evt.name,
  78. input: data.input,
  79. // Check whether additional data has been passed.
  80. foo: data.foo
  81. };
  82. // Check whether consumable has appropriate value to consume.
  83. expect( consumable.consume( data.input, { name: true } ) ).to.be.true;
  84. expect( consumable.consume( data.input, { attribute: 'attrKey' } ) ).to.be.true;
  85. // Check whether conversionApi of `dispatcher` has been passed.
  86. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  87. // Set conversion result to `output` property of `data`.
  88. // Later we will check if it was returned by `convert` method.
  89. data.output = result;
  90. } );
  91. // Use `additionalData` parameter to check if it was passed to the event.
  92. const conversionResult = dispatcher.convert( viewElement, { foo: 'bar' } );
  93. // Check conversion result.
  94. expect( conversionResult ).to.deep.equal( {
  95. eventName: 'element:p',
  96. input: viewElement,
  97. foo: 'bar'
  98. } );
  99. } );
  100. it( 'should convert ViewDocumentFragment', () => {
  101. const viewFragment = new ViewDocumentFragment();
  102. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  103. const result = {
  104. eventName: evt.name,
  105. input: data.input,
  106. // Check whether additional data has been passed.
  107. foo: data.foo
  108. };
  109. // Check whether consumable has appropriate value to consume.
  110. expect( consumable.consume( data.input ) ).to.be.true;
  111. // Check whether conversionApi of `dispatcher` has been passed.
  112. expect( conversionApi ).to.equal( dispatcher.conversionApi );
  113. // Set conversion result to `output` property of `data`.
  114. // Later we will check if it was returned by `convert` method.
  115. data.output = result;
  116. } );
  117. // Use `additionalData` parameter to check if it was passed to the event.
  118. const conversionResult = dispatcher.convert( viewFragment, { foo: 'bar' } );
  119. // Check conversion result.
  120. expect( conversionResult ).to.deep.equal( {
  121. eventName: 'documentFragment',
  122. input: viewFragment,
  123. foo: 'bar'
  124. } );
  125. } );
  126. it( 'should convert markers stamps', () => {
  127. const schema = new ModelSchema();
  128. schema.registerItem( 'paragraph', '$block' );
  129. dispatcher = new ViewConversionDispatcher( { schema } );
  130. dispatcher.on( 'text', convertText() );
  131. buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' );
  132. buildViewConverter().for( dispatcher ).fromElement( 'm' ).toMarker();
  133. const viewElement = new ViewContainerElement( 'p', null, [
  134. new ViewText( 'F' ),
  135. new ViewAttributeElement( 'm', { 'data-name': 'comment' } ),
  136. new ViewText( 'o' ),
  137. new ViewAttributeElement( 'm', { 'data-name': 'search' } ),
  138. new ViewText( 'o ba' ),
  139. new ViewAttributeElement( 'm', { 'data-name': 'comment' } ),
  140. new ViewText( 'r bi' ),
  141. new ViewAttributeElement( 'm', { 'data-name': 'search' } ),
  142. new ViewText( 'z' )
  143. ] );
  144. const documentFragment = dispatcher.convert( viewElement, { context: [ '$root' ] } );
  145. const markerComment = documentFragment.markers.get( 'comment' );
  146. const markerSearch = documentFragment.markers.get( 'search' );
  147. expect( documentFragment.markers.size ).to.equal( 2 );
  148. expect( stringify( documentFragment, markerComment ) ).to.equal( '<paragraph>F[oo ba]r biz</paragraph>' );
  149. expect( stringify( documentFragment, markerSearch ) ).to.equal( '<paragraph>Fo[o bar bi]z</paragraph>' );
  150. } );
  151. it( 'should convert markers stamps for collapsed ranges', () => {
  152. const schema = new ModelSchema();
  153. schema.registerItem( 'paragraph', '$block' );
  154. dispatcher = new ViewConversionDispatcher( { schema } );
  155. dispatcher.on( 'text', convertText() );
  156. buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' );
  157. buildViewConverter().for( dispatcher ).fromElement( 'm' ).toMarker();
  158. const viewElement = new ViewContainerElement( 'p', null, [
  159. new ViewText( 'F' ),
  160. new ViewAttributeElement( 'm', { 'data-name': 'comment' } ),
  161. new ViewText( 'o' ),
  162. new ViewAttributeElement( 'm', { 'data-name': 'search' } ),
  163. new ViewText( 'o' ),
  164. ] );
  165. const documentFragment = dispatcher.convert( viewElement, { context: [ '$root' ] } );
  166. const markerComment = documentFragment.markers.get( 'comment' );
  167. const markerSearch = documentFragment.markers.get( 'search' );
  168. expect( documentFragment.markers.size ).to.equal( 2 );
  169. expect( stringify( documentFragment, markerComment ) ).to.equal( '<paragraph>F[]oo</paragraph>' );
  170. expect( stringify( documentFragment, markerSearch ) ).to.equal( '<paragraph>Fo[]o</paragraph>' );
  171. } );
  172. } );
  173. describe( 'conversionApi#convertItem', () => {
  174. it( 'should convert view elements and view text', () => {
  175. const dispatcher = new ViewConversionDispatcher();
  176. const viewFragment = new ViewDocumentFragment( [
  177. new ViewContainerElement( 'p' ), new ViewText( 'foobar' )
  178. ] );
  179. dispatcher.on( 'text', ( evt, data ) => {
  180. data.output = { text: data.input.data };
  181. } );
  182. dispatcher.on( 'element:p', ( evt, data ) => {
  183. data.output = { name: 'p' };
  184. } );
  185. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  186. data.output = [];
  187. for ( let child of data.input.getChildren() ) {
  188. data.output.push( conversionApi.convertItem( child ) );
  189. }
  190. } );
  191. expect( dispatcher.convert( viewFragment ) ).to.deep.equal( [
  192. { name: 'p' },
  193. { text: 'foobar' }
  194. ] );
  195. } );
  196. } );
  197. describe( 'conversionApi#convertChildren', () => {
  198. it( 'should fire proper events for all children of passed view part', () => {
  199. const dispatcher = new ViewConversionDispatcher();
  200. const viewFragment = new ViewDocumentFragment( [
  201. new ViewContainerElement( 'p' ), new ViewText( 'foobar' )
  202. ] );
  203. dispatcher.on( 'text', ( evt, data ) => {
  204. data.output = { text: data.input.data };
  205. } );
  206. dispatcher.on( 'element:p', ( evt, data ) => {
  207. data.output = { name: 'p' };
  208. } );
  209. dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
  210. data.output = conversionApi.convertChildren( data.input );
  211. } );
  212. expect( dispatcher.convert( viewFragment ) ).to.deep.equal( [
  213. { name: 'p' },
  214. { text: 'foobar' }
  215. ] );
  216. } );
  217. it( 'should flatten structure of non-converted elements', () => {
  218. const dispatcher = new ViewConversionDispatcher();
  219. dispatcher.on( 'text', ( evt, data ) => {
  220. data.output = data.input.data;
  221. } );
  222. dispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
  223. data.output = conversionApi.convertChildren( data.input, consumable );
  224. } );
  225. const viewStructure = new ViewContainerElement( 'div', null, [
  226. new ViewContainerElement( 'p', null, [
  227. new ViewContainerElement( 'span', { class: 'nice' }, [
  228. new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ),
  229. new ViewText( ' bar ' ),
  230. new ViewAttributeElement( 'i', null, new ViewText( 'xyz' ) )
  231. ] )
  232. ] ),
  233. new ViewContainerElement( 'p', null, [
  234. new ViewAttributeElement( 'strong', null, [
  235. new ViewText( 'aaa ' ),
  236. new ViewAttributeElement( 'span', null, new ViewText( 'bbb' ) ),
  237. new ViewText( ' ' ),
  238. new ViewAttributeElement( 'a', { href: 'bar.html' }, new ViewText( 'ccc' ) )
  239. ] )
  240. ] )
  241. ] );
  242. expect( dispatcher.convert( viewStructure ) ).to.deep.equal( [ 'foo', ' bar ', 'xyz', 'aaa ', 'bbb', ' ', 'ccc' ] );
  243. } );
  244. } );
  245. } );