| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import ImageCaptionEditing from '../../src/imagecaption/imagecaptionediting';
- import ImageEditing from '../../src/image/imageediting';
- import UndoEditing from '@ckeditor/ckeditor5-undo/src/undoediting';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- describe( 'ImageCaptionEditing', () => {
- let editor, model, doc, view;
- testUtils.createSinonSandbox();
- beforeEach( () => {
- return VirtualTestEditor
- .create( {
- plugins: [ ImageCaptionEditing, ImageEditing, UndoEditing, Paragraph ]
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- doc = model.document;
- view = editor.editing.view;
- model.schema.register( 'widget' );
- model.schema.extend( 'widget', { allowIn: '$root' } );
- model.schema.extend( 'caption', { allowIn: 'widget' } );
- model.schema.extend( '$text', { allowIn: 'widget' } );
- editor.conversion.elementToElement( {
- model: 'widget',
- view: 'widget'
- } );
- } );
- } );
- it( 'should have pluginName', () => {
- expect( ImageCaptionEditing.pluginName ).to.equal( 'ImageCaptionEditing' );
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( ImageCaptionEditing ) ).to.be.instanceOf( ImageCaptionEditing );
- } );
- it( 'should set proper schema rules', () => {
- expect( model.schema.checkChild( [ '$root', 'image' ], 'caption' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root', 'image', 'caption' ], '$text' ) ).to.be.true;
- expect( model.schema.isLimit( 'caption' ) ).to.be.true;
- expect( model.schema.checkChild( [ '$root', 'image', 'caption' ], 'caption' ) ).to.be.false;
- model.schema.extend( '$block', { allowAttributes: 'aligmnent' } );
- expect( model.schema.checkAttribute( [ '$root', 'image', 'caption' ], 'alignment' ) ).to.be.false;
- } );
- describe( 'data pipeline', () => {
- describe( 'view to model', () => {
- it( 'should convert figcaption inside image figure', () => {
- editor.setData( '<figure class="image"><img src="/assets/sample.png" /><figcaption>foo bar</figcaption></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<image src="/assets/sample.png"><caption>foo bar</caption></image>' );
- } );
- it( 'should add empty caption if there is no figcaption', () => {
- editor.setData( '<figure class="image"><img src="/assets/sample.png" /></figure>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<image src="/assets/sample.png"><caption></caption></image>' );
- } );
- it( 'should not convert figcaption inside other elements than image', () => {
- editor.setData( '<widget><figcaption>foobar</figcaption></widget>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<widget>foobar</widget>' );
- } );
- } );
- describe( 'model to view', () => {
- it( 'should convert caption element to figcaption', () => {
- setModelData( model, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
- expect( editor.getData() ).to.equal(
- '<figure class="image"><img src="img.png"><figcaption>Foo bar baz.</figcaption></figure>'
- );
- } );
- it( 'should not convert caption to figcaption if it\'s empty', () => {
- setModelData( model, '<image src="img.png"><caption></caption></image>' );
- expect( editor.getData() ).to.equal( '<figure class="image"><img src="img.png"></figure>' );
- } );
- it( 'should not convert caption from other elements', () => {
- setModelData( model, '<widget>foo bar<caption></caption></widget>' );
- expect( editor.getData() ).to.equal( '<widget>foo bar</widget>' );
- } );
- } );
- } );
- describe( 'editing pipeline', () => {
- describe( 'model to view', () => {
- it( 'should convert caption element to figcaption contenteditable', () => {
- setModelData( model, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
- expect( getViewData( view, { withoutSelection: true } ) ).to.equal(
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src="img.png"></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- 'Foo bar baz.' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should convert caption to element with proper CSS class if it\'s empty', () => {
- setModelData( model, '<paragraph>foo</paragraph><image src="img.png"><caption></caption></image>' );
- expect( getViewData( view, { withoutSelection: true } ) ).to.equal(
- '<p>foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src="img.png"></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should not convert caption from other elements', () => {
- setModelData( model, '<widget>foo bar<caption></caption></widget>' );
- expect( getViewData( view, { withoutSelection: true } ) ).to.equal( '<widget>foo bar</widget>' );
- } );
- it( 'should not convert when element is already consumed', () => {
- editor.editing.downcastDispatcher.on(
- 'insert:caption',
- ( evt, data, conversionApi ) => {
- conversionApi.consumable.consume( data.item, 'insert' );
- const imageFigure = conversionApi.mapper.toViewElement( data.range.start.parent );
- const viewElement = conversionApi.writer.createAttributeElement( 'span' );
- const viewPosition = conversionApi.writer.createPositionAt( imageFigure, 'end' );
- conversionApi.mapper.bindElements( data.item, viewElement );
- conversionApi.writer.insert( viewPosition, viewElement );
- },
- { priority: 'high' }
- );
- setModelData( model, '<image src="img.png"><caption>Foo bar baz.</caption></image>' );
- expect( getViewData( view, { withoutSelection: true } ) ).to.equal(
- '<figure class="ck-widget image" contenteditable="false"><img src="img.png"></img><span></span>Foo bar baz.</figure>'
- );
- } );
- it( 'should show caption when something is inserted inside', () => {
- setModelData( model, '<paragraph>foo</paragraph><image src="img.png"><caption></caption></image>' );
- const image = doc.getRoot().getChild( 1 );
- const caption = image.getChild( 0 );
- model.change( writer => {
- writer.insertText( 'foo bar', caption );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src="img.png"></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- 'foo bar' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should hide when everything is removed from caption', () => {
- setModelData( model, '<paragraph>foo</paragraph><image src="img.png"><caption>foo bar baz</caption></image>' );
- const image = doc.getRoot().getChild( 1 );
- const caption = image.getChild( 0 );
- model.change( writer => {
- writer.remove( writer.createRangeIn( caption ) );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src="img.png"></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should show when not everything is removed from caption', () => {
- setModelData( model, '<paragraph>foo</paragraph><image src="img.png"><caption>foo bar baz</caption></image>' );
- const image = doc.getRoot().getChild( 1 );
- const caption = image.getChild( 0 );
- model.change( writer => {
- writer.remove( writer.createRange( writer.createPositionAt( caption, 0 ), writer.createPositionAt( caption, 8 ) ) );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src="img.png"></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">baz</figcaption>' +
- '</figure>'
- );
- } );
- } );
- } );
- describe( 'inserting image to the document', () => {
- it( 'should add caption element if image does not have it', () => {
- model.change( writer => {
- writer.insertElement( 'image', { src: '', alt: '' }, doc.getRoot() );
- } );
- expect( getModelData( model ) ).to.equal(
- '[<image alt="" src=""><caption></caption></image>]<paragraph></paragraph>'
- );
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img alt="" src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>]' +
- '<p></p>'
- );
- } );
- it( 'should add caption element if image does not have it (image is nested in inserted element)', () => {
- model.change( writer => {
- model.schema.register( 'table', { allowWhere: '$block', isLimit: true, isObject: true, isBlock: true } );
- model.schema.register( 'tableRow', { allowIn: 'table', isLimit: true } );
- model.schema.register( 'tableCell', { allowIn: 'tableRow', isLimit: true } );
- model.schema.extend( '$block', { allowIn: 'tableCell' } );
- editor.conversion.for( 'downcast' ).elementToElement( { model: 'table', view: 'table' } );
- editor.conversion.for( 'downcast' ).elementToElement( { model: 'tableRow', view: 'tr' } );
- editor.conversion.for( 'downcast' ).elementToElement( { model: 'tableCell', view: 'td' } );
- const table = writer.createElement( 'table' );
- const tableRow = writer.createElement( 'tableRow' );
- const tableCell1 = writer.createElement( 'tableCell' );
- const tableCell2 = writer.createElement( 'tableCell' );
- const image1 = writer.createElement( 'image', { src: '', alt: '' } );
- const image2 = writer.createElement( 'image', { src: '', alt: '' } );
- writer.insert( tableRow, table );
- writer.insert( tableCell1, tableRow );
- writer.insert( tableCell2, tableRow );
- writer.insert( image1, tableCell1 );
- writer.insert( image2, tableCell2 );
- writer.insert( table, doc.getRoot() );
- } );
- expect( getModelData( model ) ).to.equal(
- '[<table>' +
- '<tableRow>' +
- '<tableCell><image alt="" src=""><caption></caption></image></tableCell>' +
- '<tableCell><image alt="" src=""><caption></caption></image></tableCell>' +
- '</tableRow>' +
- '</table>]' +
- '<paragraph></paragraph>'
- );
- expect( getViewData( view ) ).to.equal(
- '[<table>' +
- '<tr>' +
- '<td>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img alt="" src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>' +
- '</td>' +
- '<td>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img alt="" src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>' +
- '</td>' +
- '</tr>' +
- '</table>]' +
- '<p></p>'
- );
- } );
- it( 'should not add caption element if image already have it', () => {
- model.change( writer => {
- const caption = writer.createElement( 'caption' );
- const image = writer.createElement( 'image', { src: '', alt: '' } );
- writer.insertText( 'foo bar', caption );
- writer.insert( caption, image );
- writer.insert( image, doc.getRoot() );
- } );
- expect( getModelData( model ) ).to.equal(
- '[<image alt="" src=""><caption>foo bar</caption></image>]<paragraph></paragraph>'
- );
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img alt="" src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- 'foo bar' +
- '</figcaption>' +
- '</figure>]' +
- '<p></p>'
- );
- } );
- it( 'should not add caption element twice', () => {
- model.change( writer => {
- const image = writer.createElement( 'image', { src: '', alt: '' } );
- const caption = writer.createElement( 'caption' );
- // Since we are adding an empty image, this should trigger caption fixer.
- writer.insert( image, doc.getRoot() );
- // Add caption just after the image is inserted, in same batch.
- writer.insert( caption, image );
- } );
- // Check whether caption fixer added redundant caption.
- expect( getModelData( model ) ).to.equal(
- '[<image alt="" src=""><caption></caption></image>]<paragraph></paragraph>'
- );
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img alt="" src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption"></figcaption>' +
- '</figure>]' +
- '<p></p>'
- );
- } );
- it( 'should do nothing for other changes than insert', () => {
- setModelData( model, '<image src=""><caption>foo bar</caption></image>' );
- const image = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.setAttribute( 'alt', 'alt text', image );
- } );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal(
- '<image alt="alt text" src=""><caption>foo bar</caption></image>'
- );
- } );
- it( 'should do nothing on $text insert', () => {
- setModelData( model, '<image src=""><caption>foo bar</caption></image><paragraph>[]</paragraph>' );
- const paragraph = doc.getRoot().getChild( 1 );
- // Simulate typing behavior - second input will generate input change without entry.item in change entry.
- const batch = model.createBatch();
- model.enqueueChange( batch, writer => {
- writer.insertText( 'f', paragraph, 0 );
- } );
- model.enqueueChange( batch, writer => {
- writer.insertText( 'oo', paragraph, 1 );
- } );
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal(
- '<image src=""><caption>foo bar</caption></image><paragraph>foo</paragraph>'
- );
- } );
- } );
- describe( 'editing view', () => {
- it( 'image should have empty figcaption element when is selected', () => {
- setModelData( model, '<paragraph>foo</paragraph>[<image src=""><caption></caption></image>]' );
- expect( getViewData( view ) ).to.equal(
- '<p>foo</p>' +
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>]'
- );
- } );
- it( 'image should have empty figcaption element with hidden class when not selected', () => {
- setModelData( model, '<paragraph>[]foo</paragraph><image src=""><caption></caption></image>' );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should not add additional figcaption if one is already present', () => {
- setModelData( model, '<paragraph>foo</paragraph>[<image src=""><caption>foo bar</caption></image>]' );
- expect( getViewData( view ) ).to.equal(
- '<p>foo</p>' +
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">foo bar</figcaption>' +
- '</figure>]'
- );
- } );
- it( 'should add hidden class to figcaption when caption is empty and image is no longer selected', () => {
- setModelData( model, '<paragraph>foo</paragraph>[<image src=""><caption></caption></image>]' );
- model.change( writer => {
- writer.setSelection( null );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should not remove figcaption when selection is inside it even when it is empty', () => {
- setModelData( model, '<image src=""><caption>[foo bar]</caption></image>' );
- model.change( writer => {
- writer.remove( doc.selection.getFirstRange() );
- } );
- expect( getViewData( view ) ).to.equal(
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '[]' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'should not remove figcaption when selection is moved from it to its image', () => {
- setModelData( model, '<image src=""><caption>[foo bar]</caption></image>' );
- const image = doc.getRoot().getChild( 0 );
- model.change( writer => {
- writer.remove( doc.selection.getFirstRange() );
- writer.setSelection( writer.createRangeOn( image ) );
- } );
- expect( getViewData( view ) ).to.equal(
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption"></figcaption>' +
- '</figure>]'
- );
- } );
- it( 'should not remove figcaption when selection is moved from it to other image', () => {
- setModelData( model, '<image src=""><caption>[foo bar]</caption></image><image src=""><caption></caption></image>' );
- const image = doc.getRoot().getChild( 1 );
- model.change( writer => {
- writer.setSelection( writer.createRangeOn( image ) );
- } );
- expect( getViewData( view ) ).to.equal(
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">foo bar</figcaption>' +
- '</figure>' +
- '[<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption"></figcaption>' +
- '</figure>]'
- );
- } );
- describe( 'undo/redo integration', () => {
- it( 'should create view element after redo', () => {
- setModelData( model, '<paragraph>foo</paragraph><image src=""><caption>[foo bar baz]</caption></image>' );
- const modelRoot = doc.getRoot();
- const modelImage = modelRoot.getChild( 1 );
- const modelCaption = modelImage.getChild( 0 );
- // Remove text and selection from caption.
- model.change( writer => {
- writer.remove( writer.createRangeIn( modelCaption ) );
- writer.setSelection( null );
- } );
- // Check if there is no figcaption in the view.
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable ck-hidden ck-placeholder" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '</figcaption>' +
- '</figure>'
- );
- editor.execute( 'undo' );
- // Check if figcaption is back with contents.
- expect( getViewData( view ) ).to.equal(
- '<p>foo</p>' +
- '<figure class="ck-widget image" contenteditable="false">' +
- '<img src=""></img>' +
- '<figcaption class="ck-editor__editable ck-editor__nested-editable" ' +
- 'contenteditable="true" data-placeholder="Enter image caption">' +
- '{foo bar baz}' +
- '</figcaption>' +
- '</figure>'
- );
- } );
- it( 'undo should work after inserting the image', () => {
- setModelData( model, '<paragraph>foo[]</paragraph>' );
- model.change( writer => {
- const image = writer.createElement( 'image', { src: '/assets/sample.png' } );
- writer.insert( image, doc.getRoot() );
- } );
- expect( getModelData( model ) ).to.equal(
- '<image src="/assets/sample.png"><caption></caption></image><paragraph>foo[]</paragraph>'
- );
- editor.execute( 'undo' );
- expect( getModelData( model ) ).to.equal( '<paragraph>foo[]</paragraph>' );
- } );
- } );
- } );
- } );
|