/**
* @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import {
viewFigureToModel,
createImageAttributeConverter,
} from '../../src/image/converters';
import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
import { createImageViewElement } from '../../src/image/imageengine';
import { toImageWidget } from '../../src/image/utils';
import buildModelConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildmodelconverter';
import buildViewConverter from '@ckeditor/ckeditor5-engine/src/conversion/buildviewconverter';
import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range';
import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
import { setData as setModelData, getData as getModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
describe( 'Image converters', () => {
let editor, model, document, viewDocument;
beforeEach( () => {
return VirtualTestEditor.create()
.then( newEditor => {
editor = newEditor;
model = editor.model;
document = model.document;
viewDocument = editor.editing.view;
const schema = model.schema;
schema.register( 'image', {
allowWhere: '$block',
allowAttributes: [ 'alt', 'src' ],
isObject: true,
isBlock: true
} );
buildModelConverter().for( editor.editing.modelToView )
.fromElement( 'image' )
.toElement( () => toImageWidget( createImageViewElement() ) );
createImageAttributeConverter( [ editor.editing.modelToView ], 'src' );
createImageAttributeConverter( [ editor.editing.modelToView ], 'alt' );
} );
} );
describe( 'viewFigureToModel', () => {
function expectModel( data ) {
expect( getModelData( model, { withoutSelection: true } ) ).to.equal( data );
}
let dispatcher, schema, imgConverterCalled;
beforeEach( () => {
imgConverterCalled = false;
schema = model.schema;
schema.extend( '$text', { allowIn: 'image' } );
dispatcher = editor.data.viewToModel;
dispatcher.on( 'element:figure', viewFigureToModel() );
dispatcher.on( 'element:img', ( evt, data, conversionApi ) => {
if ( conversionApi.consumable.consume( data.viewItem, { name: true, attribute: 'src' } ) ) {
const image = conversionApi.writer.createElement( 'image', { src: data.viewItem.getAttribute( 'src' ) } );
conversionApi.writer.insert( image, data.modelCursor );
data.modelRange = ModelRange.createOn( image );
data.modelCursor = data.modelRange.end;
imgConverterCalled = true;
}
} );
} );
it( 'should find img element among children and convert it using already defined converters', () => {
editor.setData( '
' );
expectModel( '' );
expect( imgConverterCalled ).to.be.true;
} );
it( 'should convert non-img children in image context and append them to model image element', () => {
buildViewConverter().for( editor.data.viewToModel ).fromElement( 'foo' ).toElement( 'foo' );
buildViewConverter().for( editor.data.viewToModel ).fromElement( 'bar' ).toElement( 'bar' );
schema.register( 'foo' );
schema.register( 'bar' );
schema.extend( 'foo', { allowIn: 'image' } );
editor.setData( 'x
y' );
// Element bar not converted because schema does not allow it.
expectModel( 'xy' );
} );
it( 'should be possible to overwrite', () => {
dispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
conversionApi.consumable.consume( data.viewItem, { name: true } );
conversionApi.consumable.consume( data.viewItem.getChild( 0 ), { name: true } );
const element = conversionApi.writer.createElement( 'myImage', {
data: {
src: data.viewItem.getChild( 0 ).getAttribute( 'src' )
}
} );
conversionApi.writer.insert( element, data.modelCursor );
data.modelRange = ModelRange.createOn( element );
data.modelCursor = data.modelRange.end;
}, { priority: 'high' } );
editor.setData( '
xyz' );
expectModel( '' );
} );
// Test exactly what figure converter does, which is putting it's children element to image element.
// If this has not been done, it means that figure converter was not used.
it( 'should not convert if figure do not have class="image" attribute', () => {
editor.setData( '
xyz' );
// Default image converter will be fired.
expectModel( '' );
} );
it( 'should not convert if there is no img element among children', () => {
editor.setData( 'xyz' );
// Figure converter outputs nothing and text is disallowed in root.
expectModel( '' );
} );
it( 'should not convert if img element was not converted', () => {
// Image element missing src attribute.
editor.setData( '
xyz' );
// Figure converter outputs nothing and text is disallowed in root.
expectModel( '' );
} );
} );
describe( 'modelToViewAttributeConverter', () => {
it( 'should convert adding attribute to image', () => {
setModelData( model, '' );
const image = document.getRoot().getChild( 0 );
model.change( writer => {
writer.setAttribute( 'alt', 'foo bar', image );
} );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
'
'
);
} );
it( 'should convert removing attribute from image', () => {
setModelData( model, '' );
const image = document.getRoot().getChild( 0 );
model.change( writer => {
writer.removeAttribute( 'alt', image );
} );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
'
'
);
} );
it( 'should convert change of attribute image', () => {
setModelData( model, '' );
const image = document.getRoot().getChild( 0 );
model.change( writer => {
writer.setAttribute( 'alt', 'baz quix', image );
} );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
'
'
);
} );
it( 'should not set attribute if change was already consumed', () => {
editor.editing.modelToView.on( 'attribute:alt:image', ( evt, data, consumable ) => {
consumable.consume( data.item, 'attribute:alt' );
}, { priority: 'high' } );
setModelData( model, '' );
expect( getViewData( viewDocument, { withoutSelection: true } ) ).to.equal(
'
'
);
} );
} );
} );