converters.js 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import { viewToModelImage, modelToViewSelection, createImageAttributeConverter } from '../src/converters';
  6. import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
  7. import { createImageViewElement } from '../src/imageengine';
  8. import { toImageWidget } from '../src/utils';
  9. import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
  10. import ViewConversionDispatcher from '@ckeditor/ckeditor5-engine/src/conversion/viewconversiondispatcher';
  11. import Schema from '@ckeditor/ckeditor5-engine/src/model/schema';
  12. import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
  13. import { parse as parseView } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
  14. import { stringify as stringifyModel, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
  15. describe.only( 'Image converters', () => {
  16. describe( 'viewToModelImage', () => {
  17. let dispatcher, schema;
  18. beforeEach( () => {
  19. schema = new Schema();
  20. setImageSchema( schema );
  21. dispatcher = new ViewConversionDispatcher( { schema } );
  22. dispatcher.on( 'element:figure', viewToModelImage() );
  23. } );
  24. it( 'should convert view figure element', () => {
  25. test(
  26. '<figure class="image"><img src="foo.png" alt="bar baz"></img></figure>',
  27. '<image alt="bar baz" src="foo.png"></image>'
  28. );
  29. } );
  30. it( 'should convert without alt', () => {
  31. test(
  32. '<figure class="image"><img src="foo.png"></img></figure>',
  33. '<image src="foo.png"></image>'
  34. );
  35. } );
  36. it( 'should not convert if figure element is already consumed', () => {
  37. dispatcher.on( 'element:figure', ( evt, data, consumable ) => {
  38. consumable.consume( data.input, { name: true, class: 'image' } );
  39. data.output = new ModelElement( 'not-image' );
  40. }, { priority: 'high' } );
  41. test(
  42. '<figure class="image"><img src="foo.png" alt="bar baz"></img></figure>',
  43. '<not-image></not-image>'
  44. );
  45. } );
  46. it( 'should not convert image if schema disallows it', () => {
  47. schema.disallow( { name: 'image', attributes: [ 'alt', 'src' ], inside: '$root' } );
  48. const element = parseView( '<figure class="image"><img src="foo.png"></img></figure>' );
  49. const model = dispatcher.convert( element );
  50. expect( model ).to.be.null;
  51. } );
  52. it( 'should not convert image if there is no img element', () => {
  53. const element = parseView( '<figure class="image"></figure>' );
  54. const model = dispatcher.convert( element );
  55. expect( model ).to.be.null;
  56. } );
  57. function test( viewString, modelString ) {
  58. const element = parseView( viewString );
  59. const model = dispatcher.convert( element );
  60. expect( stringifyModel( model ) ).to.equal( modelString );
  61. }
  62. } );
  63. describe( 'modelToViewSelection', () => {
  64. let editor, document, viewDocument;
  65. beforeEach( () => {
  66. return VirtualTestEditor.create()
  67. .then( newEditor => {
  68. editor = newEditor;
  69. document = editor.document;
  70. viewDocument = editor.editing.view;
  71. setImageSchema( document.schema );
  72. buildModelConverter().for( )
  73. .fromElement( 'image' )
  74. .toElement( () => toImageWidget( createImageViewElement() ) );
  75. editor.editing.modelToView.on( 'selection', modelToViewSelection( editor.t ), { priority: 'lowest' } );
  76. buildModelConverter().for( editor.editing.modelToView )
  77. .fromElement( 'image' )
  78. .toElement( () => toImageWidget( createImageViewElement() ) );
  79. createImageAttributeConverter( [ editor.editing.modelToView ], 'src' );
  80. createImageAttributeConverter( [ editor.editing.modelToView ], 'alt' );
  81. } );
  82. } );
  83. it( 'should convert selection over image to fake selection', () => {
  84. setModelData( document, '[<image src=""></image>]' );
  85. expect( viewDocument.selection.isFake ).to.be.true;
  86. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'image widget' );
  87. } );
  88. it( 'should convert fake selection label with alt', () => {
  89. setModelData( document, '[<image src="" alt="foo bar"></image>]' );
  90. expect( viewDocument.selection.isFake ).to.be.true;
  91. expect( viewDocument.selection.fakeSelectionLabel ).to.equal( 'foo bar image widget' );
  92. } );
  93. it( 'should not convert fake selection if image is not selected', () => {
  94. setModelData( document, '[]<image src="" alt="foo bar"></image>' );
  95. expect( viewDocument.selection.isFake ).to.be.false;
  96. } );
  97. } );
  98. } );
  99. function setImageSchema( schema ) {
  100. schema.registerItem( 'image' );
  101. schema.requireAttributes( 'image', [ 'src' ] );
  102. schema.allow( { name: 'image', attributes: [ 'alt', 'src' ], inside: '$root' } );
  103. schema.objects.add( 'image' );
  104. }