viewconversiondispatcher.js 11 KB

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