8
0

converters.js 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import {
  6. viewFigureToModel,
  7. createImageAttributeConverter,
  8. } from '../../src/image/converters';
  9. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  10. import { createImageViewElement } from '../../src/image/imageengine';
  11. import { toImageWidget } from '../../src/image/utils';
  12. import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
  13. import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter';
  14. import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range';
  15. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  16. import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  17. import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  18. describe( 'Image converters', () => {
  19. let editor, model, document, viewDocument;
  20. beforeEach( () => {
  21. return VirtualTestEditor.create()
  22. .then( newEditor => {
  23. editor = newEditor;
  24. model = editor.model;
  25. document = model.document;
  26. viewDocument = editor.editing.view;
  27. const schema = model.schema;
  28. schema.register( 'image', {
  29. allowWhere: '$block',
  30. allowAttributes: [ 'alt', 'src' ],
  31. isObject: true,
  32. isBlock: true
  33. } );
  34. buildModelConverter().for( editor.editing.modelToView )
  35. .fromElement( 'image' )
  36. .toElement( () => toImageWidget( createImageViewElement() ) );
  37. createImageAttributeConverter( [ editor.editing.modelToView ], 'src' );
  38. createImageAttributeConverter( [ editor.editing.modelToView ], 'alt' );
  39. } );
  40. } );
  41. describe( 'viewFigureToModel', () => {
  42. function expectModel( data ) {
  43. expect( getModelData( model, { withoutSelection: true } ) ).to.equal( data );
  44. }
  45. let dispatcher, schema, imgConverterCalled;
  46. beforeEach( () => {
  47. // Since this part of test tests only view->model conversion editing pipeline is not necessary
  48. // so defining model->view converters won't be necessary.
  49. editor.editing.destroy();
  50. schema = model.schema;
  51. schema.extend( '$text', { allowIn: 'image' } );
  52. dispatcher = editor.data.viewToModel;
  53. dispatcher.on( 'element:figure', viewFigureToModel() );
  54. buildViewConverter().for( dispatcher )
  55. .from( { name: 'img', attribute: { src: true } } )
  56. .toElement( viewImage => {
  57. imgConverterCalled = true;
  58. return new ModelElement( 'image', { src: viewImage.getAttribute( 'src' ) } );
  59. } );
  60. } );
  61. it( 'should find img element among children and convert it using already defined converters', () => {
  62. editor.setData( '<figure class="image"><img src="foo.png" /></figure>' );
  63. expectModel( '<image src="foo.png"></image>' );
  64. expect( imgConverterCalled ).to.be.true;
  65. } );
  66. it( 'should convert children allowed by schema and omit disallowed', () => {
  67. buildViewConverter().for( editor.data.viewToModel ).fromElement( 'foo' ).toElement( 'foo' );
  68. buildViewConverter().for( editor.data.viewToModel ).fromElement( 'bar' ).toElement( 'bar' );
  69. schema.register( 'foo', { allowIn: 'image' } );
  70. // Is allowed in root, but should not try to split image element.
  71. schema.register( 'bar', { allowIn: '$root' } );
  72. editor.setData( '<figure class="image">x<img src="foo.png" />y<foo></foo><bar></bar></figure>' );
  73. // Element bar not converted because schema does not allow it.
  74. expectModel( '<image src="foo.png">xy<foo></foo></image>' );
  75. } );
  76. it( 'should split parent element when image is not allowed - in the middle', () => {
  77. buildViewConverter().for( editor.data.viewToModel ).fromElement( 'div' ).toElement( 'div' );
  78. schema.register( 'div', { inheritAllFrom: '$block' } );
  79. schema.extend( 'image', { disallowIn: 'div' } );
  80. editor.setData(
  81. '<div>' +
  82. 'abc' +
  83. '<figure class="image">' +
  84. '<img src="foo.jpg"/>' +
  85. '</figure>' +
  86. 'def' +
  87. '</div>'
  88. );
  89. expectModel( '<div>abc</div><image src="foo.jpg"></image><div>def</div>' );
  90. } );
  91. it( 'should split parent element when image is not allowed - at the end', () => {
  92. buildViewConverter().for( editor.data.viewToModel ).fromElement( 'div' ).toElement( 'div' );
  93. buildModelConverter().for( editor.editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  94. schema.register( 'div', { inheritAllFrom: '$block' } );
  95. schema.extend( 'image', { disallowIn: 'div' } );
  96. editor.setData(
  97. '<div>' +
  98. 'abc' +
  99. '<figure class="image">' +
  100. '<img src="foo.jpg"/>' +
  101. '</figure>' +
  102. '</div>'
  103. );
  104. expectModel( '<div>abc</div><image src="foo.jpg"></image>' );
  105. } );
  106. it( 'should split parent element when image is not allowed - at the beginning', () => {
  107. buildViewConverter().for( editor.data.viewToModel ).fromElement( 'div' ).toElement( 'div' );
  108. buildModelConverter().for( editor.editing.modelToView ).fromElement( 'div' ).toElement( 'div' );
  109. schema.register( 'div', { inheritAllFrom: '$block' } );
  110. schema.extend( 'image', { disallowIn: 'div' } );
  111. editor.setData(
  112. '<div>' +
  113. '<figure class="image">' +
  114. '<img src="foo.jpg"/>' +
  115. '</figure>' +
  116. 'def' +
  117. '</div>'
  118. );
  119. expectModel( '<image src="foo.jpg"></image><div>def</div>' );
  120. } );
  121. it( 'should be possible to overwrite', () => {
  122. dispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
  123. conversionApi.consumable.consume( data.viewItem, { name: true } );
  124. conversionApi.consumable.consume( data.viewItem.getChild( 0 ), { name: true } );
  125. const element = conversionApi.writer.createElement( 'myImage', {
  126. data: {
  127. src: data.viewItem.getChild( 0 ).getAttribute( 'src' )
  128. }
  129. } );
  130. conversionApi.writer.insert( element, data.modelCursor );
  131. data.modelRange = ModelRange.createOn( element );
  132. data.modelCursor = data.modelRange.end;
  133. }, { priority: 'high' } );
  134. editor.setData( '<figure class="image"><img src="foo.png" />xyz</figure>' );
  135. expectModel( '<myImage data="{"src":"foo.png"}"></myImage>' );
  136. } );
  137. // Test exactly what figure converter does, which is putting it's children element to image element.
  138. // If this has not been done, it means that figure converter was not used.
  139. it( 'should not convert if figure do not have class="image" attribute', () => {
  140. editor.setData( '<figure><img src="foo.png" />xyz</figure>' );
  141. // Default image converter will be fired.
  142. expectModel( '<image src="foo.png"></image>' );
  143. } );
  144. it( 'should not convert if there is no img element among children', () => {
  145. editor.setData( '<figure class="image">xyz</figure>' );
  146. // Figure converter outputs nothing and text is disallowed in root.
  147. expectModel( '' );
  148. } );
  149. it( 'should not convert if img element was not converted', () => {
  150. // Image element missing src attribute.
  151. editor.setData( '<figure class="image"><img alt="abc" />xyz</figure>' );
  152. // Figure converter outputs nothing and text is disallowed in root.
  153. expectModel( '' );
  154. } );
  155. } );
  156. describe( 'modelToViewAttributeConverter', () => {
  157. it( 'should convert adding attribute to image', () => {
  158. setModelData( model, '<image src=""></image>' );
  159. const image = document.getRoot().getChild( 0 );
  160. model.change( writer => {
  161. writer.setAttribute( 'alt', 'foo bar', image );
  162. } );
  163. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  164. '<figure class="ck-widget image" contenteditable="false"><img alt="foo bar" src=""></img></figure>'
  165. );
  166. } );
  167. it( 'should convert removing attribute from image', () => {
  168. setModelData( model, '<image src="" alt="foo bar"></image>' );
  169. const image = document.getRoot().getChild( 0 );
  170. model.change( writer => {
  171. writer.removeAttribute( 'alt', image );
  172. } );
  173. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  174. '<figure class="ck-widget image" contenteditable="false"><img src=""></img></figure>'
  175. );
  176. } );
  177. it( 'should convert change of attribute image', () => {
  178. setModelData( model, '<image src="" alt="foo bar"></image>' );
  179. const image = document.getRoot().getChild( 0 );
  180. model.change( writer => {
  181. writer.setAttribute( 'alt', 'baz quix', image );
  182. } );
  183. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  184. '<figure class="ck-widget image" contenteditable="false"><img alt="baz quix" src=""></img></figure>'
  185. );
  186. } );
  187. it( 'should not set attribute if change was already consumed', () => {
  188. editor.editing.modelToView.on( 'attribute:alt:image', ( evt, data, consumable ) => {
  189. consumable.consume( data.item, 'attribute:alt' );
  190. }, { priority: 'high' } );
  191. setModelData( model, '<image src="" alt="foo bar"></image>' );
  192. expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
  193. '<figure class="ck-widget image" contenteditable="false"><img src=""></img></figure>'
  194. );
  195. } );
  196. } );
  197. } );