/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
import ImageCaptionEngine from '../../src/imagecaption/imagecaptionengine';
import ImageEngine from '../../src/image/imageengine';
import UndoEngine from '@ckeditor/ckeditor5-undo/src/undoengine';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import ViewAttributeElement from '@ckeditor/ckeditor5-engine/src/view/attributeelement';
import ViewPosition from '@ckeditor/ckeditor5-engine/src/view/position';
import viewWriter from '@ckeditor/ckeditor5-engine/src/view/writer';
import ModelElement from '@ckeditor/ckeditor5-engine/src/model/element';
import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range';
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 buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter';
import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
describe( 'ImageCaptionEngine', () => {
let editor, doc, viewDocument;
beforeEach( () => {
return VirtualTestEditor
.create( {
plugins: [ ImageCaptionEngine, ImageEngine, UndoEngine, Paragraph ]
} )
.then( newEditor => {
editor = newEditor;
doc = editor.document;
viewDocument = editor.editing.view;
doc.schema.registerItem( 'widget' );
doc.schema.allow( { name: 'widget', inside: '$root' } );
doc.schema.allow( { name: 'caption', inside: 'widget' } );
doc.schema.allow( { name: '$inline', inside: 'widget' } );
buildViewConverter()
.for( editor.data.viewToModel )
.fromElement( 'widget' )
.toElement( 'widget' );
buildModelConverter()
.for( editor.data.modelToView, editor.editing.modelToView )
.fromElement( 'widget' )
.toElement( 'widget' );
} );
} );
it( 'should be loaded', () => {
expect( editor.plugins.get( ImageCaptionEngine ) ).to.be.instanceOf( ImageCaptionEngine );
} );
it( 'should set proper schema rules', () => {
expect( doc.schema.check( { name: 'caption', iniside: 'image' } ) ).to.be.true;
expect( doc.schema.check( { name: '$inline', inside: 'caption' } ) ).to.be.true;
expect( doc.schema.itemExtends( 'caption', '$block' ) ).to.be.true;
expect( doc.schema.limits.has( 'caption' ) );
} );
describe( 'data pipeline', () => {
describe( 'view to model', () => {
it( 'should convert figcaption inside image figure', () => {
editor.setData( 'foo bar ' );
expect( getModelData( doc, { withoutSelection: true } ) )
.to.equal( 'foo bar ' );
} );
it( 'should add empty caption if there is no figcaption', () => {
editor.setData( ' ' );
expect( getModelData( doc, { withoutSelection: true } ) )
.to.equal( ' ' );
} );
it( 'should not convert figcaption inside other elements than image', () => {
editor.setData( 'foobar ' );
expect( getModelData( doc, { withoutSelection: true } ) )
.to.equal( 'foobar ' );
} );
} );
describe( 'model to view', () => {
it( 'should convert caption element to figcaption', () => {
setModelData( doc, 'Foo bar baz. ' );
expect( editor.getData() ).to.equal(
'Foo bar baz. '
);
} );
it( 'should not convert caption to figcaption if it\'s empty', () => {
setModelData( doc, ' ' );
expect( editor.getData() ).to.equal( ' ' );
} );
it( 'should not convert caption from other elements', () => {
setModelData( doc, 'foo bar ' );
expect( editor.getData() ).to.equal( 'foo bar ' );
} );
} );
} );
describe( 'editing pipeline', () => {
describe( 'model to view', () => {
it( 'should convert caption element to figcaption contenteditable', () => {
setModelData( doc, 'Foo bar baz. ' );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
'' +
' ' +
'' +
'Foo bar baz.' +
' ' +
' '
);
} );
it( 'should convert caption to element with proper CSS class if it\'s empty', () => {
setModelData( doc, 'foo ' );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
'
foo
' +
'' +
' ' +
'' +
' ' +
' '
);
} );
it( 'should not convert caption from other elements', () => {
setModelData( doc, 'foo bar ' );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal( 'foo bar ' );
} );
it( 'should not convert when element is already consumed', () => {
editor.editing.modelToView.on(
'insert:caption',
( evt, data, consumable, conversionApi ) => {
consumable.consume( data.item, 'insert' );
const imageFigure = conversionApi.mapper.toViewElement( data.range.start.parent );
const viewElement = new ViewAttributeElement( 'span' );
const viewPosition = ViewPosition.createAt( imageFigure, 'end' );
conversionApi.mapper.bindElements( data.item, viewElement );
viewWriter.insert( viewPosition, viewElement );
},
{ priority: 'high' }
);
setModelData( doc, 'Foo bar baz. ' );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
' Foo bar baz. '
);
} );
it( 'should show caption when something is inserted inside', () => {
setModelData( doc, 'foo ' );
const image = doc.getRoot().getChild( 1 );
const caption = image.getChild( 0 );
doc.enqueueChanges( () => {
const batch = doc.batch();
batch.insertText( 'foo bar', caption );
} );
expect( getViewData( viewDocument ) ).to.equal(
'{}foo
' +
'' +
' ' +
'' +
'foo bar' +
' ' +
' '
);
} );
it( 'should hide when everything is removed from caption', () => {
setModelData( doc, 'foo foo bar baz ' );
const image = doc.getRoot().getChild( 1 );
const caption = image.getChild( 0 );
doc.enqueueChanges( () => {
const batch = doc.batch();
batch.remove( ModelRange.createIn( caption ) );
} );
expect( getViewData( viewDocument ) ).to.equal(
'{}foo
' +
'' +
' ' +
'' +
' ' +
' '
);
} );
it( 'should show when not everything is removed from caption', () => {
setModelData( doc, 'foo foo bar baz ' );
const image = doc.getRoot().getChild( 1 );
const caption = image.getChild( 0 );
doc.enqueueChanges( () => {
const batch = doc.batch();
batch.remove( ModelRange.createFromParentsAndOffsets( caption, 0, caption, 8 ) );
} );
expect( getViewData( viewDocument ) ).to.equal(
'{}foo
' +
'' +
' ' +
'baz ' +
' '
);
} );
} );
} );
describe( 'inserting image to the document', () => {
it( 'should add caption element if image does not have it', () => {
const batch = doc.batch();
doc.enqueueChanges( () => {
batch.insertElement( 'image', { src: '', alt: '' }, doc.getRoot() );
} );
expect( getModelData( doc ) ).to.equal(
'[ ] '
);
expect( getViewData( viewDocument ) ).to.equal(
'[' +
' ' +
'' +
' ' +
' ]' +
'
'
);
} );
it( 'should not add caption element if image already have it', () => {
const caption = new ModelElement( 'caption', null, 'foo bar' );
const image = new ModelElement( 'image', { src: '', alt: '' }, caption );
const batch = doc.batch();
doc.enqueueChanges( () => {
batch.insert( image, doc.getRoot() );
} );
expect( getModelData( doc ) ).to.equal(
'[foo bar ] '
);
expect( getViewData( viewDocument ) ).to.equal(
'[' +
' ' +
'' +
'foo bar' +
' ' +
' ]' +
'
'
);
} );
it( 'should not add caption element twice', () => {
const image = new ModelElement( 'image', { src: '', alt: '' } );
const caption = new ModelElement( 'caption' );
const batch = doc.batch();
doc.enqueueChanges( () => {
// Since we are adding an empty image, this should trigger caption fixer.
batch.insert( image, doc.getRoot() );
// Add caption just after the image is inserted, in same batch and enqueue changes block.
batch.insert( caption, image );
} );
// Check whether caption fixer added redundant caption.
expect( getModelData( doc ) ).to.equal(
'[ ] '
);
expect( getViewData( viewDocument ) ).to.equal(
'[' +
' ' +
' ' +
' ]' +
'
'
);
} );
it( 'should do nothing for other changes than insert', () => {
setModelData( doc, 'foo bar ' );
const image = doc.getRoot().getChild( 0 );
const batch = doc.batch();
doc.enqueueChanges( () => {
batch.setAttribute( 'alt', 'alt text', image );
} );
expect( getModelData( doc, { withoutSelection: true } ) ).to.equal(
'foo bar '
);
} );
} );
describe( 'editing view', () => {
it( 'image should have empty figcaption element when is selected', () => {
setModelData( doc, 'foo [ ]' );
expect( getViewData( viewDocument ) ).to.equal(
'foo
' +
'[' +
' ' +
'' +
' ' +
' ]'
);
} );
it( 'image should have empty figcaption element with hidden class when not selected', () => {
setModelData( doc, '[]foo ' );
expect( getViewData( viewDocument ) ).to.equal(
'{}foo
' +
'' +
' ' +
'' +
' ' +
' '
);
} );
it( 'should not add additional figcaption if one is already present', () => {
setModelData( doc, 'foo [foo bar ]' );
expect( getViewData( viewDocument ) ).to.equal(
'foo
' +
'[' +
' ' +
'foo bar ' +
' ]'
);
} );
it( 'should add hidden class to figcaption when caption is empty and image is no longer selected', () => {
setModelData( doc, 'foo [ ]' );
doc.enqueueChanges( () => {
doc.selection.removeAllRanges();
} );
expect( getViewData( viewDocument ) ).to.equal(
'{}foo
' +
'' +
' ' +
'' +
' ' +
' '
);
} );
it( 'should not remove figcaption when selection is inside it even when it is empty', () => {
setModelData( doc, '[foo bar] ' );
doc.enqueueChanges( () => {
doc.batch().remove( doc.selection.getFirstRange() );
} );
expect( getViewData( viewDocument ) ).to.equal(
'' +
' ' +
'' +
'[]' +
' ' +
' '
);
} );
it( 'should not remove figcaption when selection is moved from it to its image', () => {
setModelData( doc, '[foo bar] ' );
const image = doc.getRoot().getChild( 0 );
doc.enqueueChanges( () => {
doc.batch().remove( doc.selection.getFirstRange() );
doc.selection.setRanges( [ ModelRange.createOn( image ) ] );
} );
expect( getViewData( viewDocument ) ).to.equal(
'[' +
' ' +
' ' +
' ]'
);
} );
it( 'should not remove figcaption when selection is moved from it to other image', () => {
setModelData( doc, '[foo bar] ' );
const image = doc.getRoot().getChild( 1 );
doc.enqueueChanges( () => {
doc.selection.setRanges( [ ModelRange.createOn( image ) ] );
} );
expect( getViewData( viewDocument ) ).to.equal(
'' +
' ' +
'foo bar ' +
' ' +
'[' +
' ' +
' ' +
' ]'
);
} );
describe( 'undo/redo integration', () => {
it( 'should create view element after redo', () => {
setModelData( doc, 'foo [foo bar baz] ' );
const modelRoot = doc.getRoot();
const modelImage = modelRoot.getChild( 1 );
const modelCaption = modelImage.getChild( 0 );
// Remove text and selection from caption.
doc.enqueueChanges( () => {
const batch = doc.batch();
batch.remove( ModelRange.createIn( modelCaption ) );
doc.selection.removeAllRanges();
} );
// Check if there is no figcaption in the view.
expect( getViewData( viewDocument ) ).to.equal(
'{}foo
' +
'' +
' ' +
'' +
' ' +
' '
);
editor.execute( 'undo' );
// Check if figcaption is back with contents.
expect( getViewData( viewDocument ) ).to.equal(
'foo
' +
'' +
' ' +
'' +
'{foo bar baz}' +
' ' +
' '
);
} );
it( 'undo should work after inserting the image', () => {
const image = new ModelElement( 'image' );
image.setAttribute( 'src', '/foo.png' );
setModelData( doc, 'foo[] ' );
doc.enqueueChanges( () => {
const batch = doc.batch();
batch.insert( image, doc.getRoot() );
} );
expect( getModelData( doc ) ).to.equal( 'foo[] ' );
editor.execute( 'undo' );
expect( getModelData( doc ) ).to.equal( 'foo[] ' );
} );
} );
} );
} );