/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher';
import ViewContainerElement from '../../src/view/containerelement';
import ViewAttributeElement from '../../src/view/attributeelement';
import ViewDocumentFragment from '../../src/view/documentfragment';
import ViewText from '../../src/view/text';
import ModelRange from '../../src/model/range';
import ModelSchema from '../../src/model/schema';
import buildViewConverter from '../../src/conversion/buildviewconverter';
import { convertText } from '../../src/conversion/view-to-model-converters';
import { stringify } from '../../src/dev-utils/model';
describe( 'ViewConversionDispatcher', () => {
describe( 'constructor()', () => {
it( 'should create ViewConversionDispatcher with passed api', () => {
const apiObj = {};
const dispatcher = new ViewConversionDispatcher( { apiObj } );
expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj );
expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function );
expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function );
} );
} );
describe( 'convert', () => {
let dispatcher;
beforeEach( () => {
dispatcher = new ViewConversionDispatcher();
} );
it( 'should fire viewCleanup event on converted view part', () => {
sinon.spy( dispatcher, 'fire' );
const viewP = new ViewContainerElement( 'p' );
dispatcher.convert( viewP );
expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true;
} );
it( 'should fire proper events', () => {
const viewText = new ViewText( 'foobar' );
const viewElement = new ViewContainerElement( 'p', null, viewText );
const viewFragment = new ViewDocumentFragment( viewElement );
sinon.spy( dispatcher, 'fire' );
dispatcher.convert( viewText );
dispatcher.convert( viewElement );
dispatcher.convert( viewFragment );
expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true;
expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true;
expect( dispatcher.fire.calledWith( 'documentFragment' ) ).to.be.true;
} );
it( 'should convert ViewText', () => {
const viewText = new ViewText( 'foobar' );
dispatcher.on( 'text', ( evt, data, consumable, conversionApi ) => {
const result = {
eventName: evt.name,
input: data.input,
// Check whether additional data has been passed.
foo: data.foo
};
// Check whether consumable has appropriate value to consume.
expect( consumable.consume( data.input ) ).to.be.true;
// Check whether conversionApi of `dispatcher` has been passed.
expect( conversionApi ).to.equal( dispatcher.conversionApi );
// Set conversion result to `output` property of `data`.
// Later we will check if it was returned by `convert` method.
data.output = result;
} );
// Use `additionalData` parameter to check if it was passed to the event.
const { conversionResult } = dispatcher.convert( viewText, { foo: 'bar' } );
// Check conversion result.
expect( conversionResult ).to.deep.equal( {
eventName: 'text',
input: viewText,
foo: 'bar'
} );
} );
it( 'should convert ViewContainerElement', () => {
const viewElement = new ViewContainerElement( 'p', { attrKey: 'attrValue' } );
dispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
const result = {
eventName: evt.name,
input: data.input,
// Check whether additional data has been passed.
foo: data.foo
};
// Check whether consumable has appropriate value to consume.
expect( consumable.consume( data.input, { name: true } ) ).to.be.true;
expect( consumable.consume( data.input, { attribute: 'attrKey' } ) ).to.be.true;
// Check whether conversionApi of `dispatcher` has been passed.
expect( conversionApi ).to.equal( dispatcher.conversionApi );
// Set conversion result to `output` property of `data`.
// Later we will check if it was returned by `convert` method.
data.output = result;
} );
// Use `additionalData` parameter to check if it was passed to the event.
const { conversionResult } = dispatcher.convert( viewElement, { foo: 'bar' } );
// Check conversion result.
expect( conversionResult ).to.deep.equal( {
eventName: 'element:p',
input: viewElement,
foo: 'bar'
} );
} );
it( 'should convert ViewDocumentFragment', () => {
const viewFragment = new ViewDocumentFragment();
dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
const result = {
eventName: evt.name,
input: data.input,
// Check whether additional data has been passed.
foo: data.foo
};
// Check whether consumable has appropriate value to consume.
expect( consumable.consume( data.input ) ).to.be.true;
// Check whether conversionApi of `dispatcher` has been passed.
expect( conversionApi ).to.equal( dispatcher.conversionApi );
// Set conversion result to `output` property of `data`.
// Later we will check if it was returned by `convert` method.
data.output = result;
} );
// Use `additionalData` parameter to check if it was passed to the event.
const { conversionResult } = dispatcher.convert( viewFragment, { foo: 'bar' } );
// Check conversion result.
expect( conversionResult ).to.deep.equal( {
eventName: 'documentFragment',
input: viewFragment,
foo: 'bar'
} );
} );
it( 'should convert markers stamps', () => {
const schema = new ModelSchema();
schema.registerItem( 'paragraph', '$block' );
dispatcher = new ViewConversionDispatcher( { schema } );
dispatcher.on( 'text', convertText() );
buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' );
buildViewConverter().for( dispatcher ).fromElement( 'm' ).toMarker();
const viewElement = new ViewContainerElement( 'p', null, [
new ViewText( 'F' ),
new ViewAttributeElement( 'm', { 'data-name': 'comment' } ),
new ViewText( 'o' ),
new ViewAttributeElement( 'm', { 'data-name': 'search' } ),
new ViewText( 'o ba' ),
new ViewAttributeElement( 'm', { 'data-name': 'comment' } ),
new ViewText( 'r bi' ),
new ViewAttributeElement( 'm', { 'data-name': 'search' } ),
new ViewText( 'z' )
] );
const { conversionResult, markers } = dispatcher.convert( viewElement, { context: [ '$root' ] } );
const markerComment = markers.get( 'comment' );
const markerSearch = markers.get( 'search' );
expect( stringify( conversionResult ) ).to.equal( 'Foo bar biz' );
expect( markers.size ).to.equal( 2 );
expect( markerComment ).to.instanceof( ModelRange );
expect( markerComment.isEqual( ModelRange.createFromParentsAndOffsets( conversionResult, 1, conversionResult, 6 ) ) );
expect( markerSearch ).to.instanceof( ModelRange );
expect( markerSearch.isEqual( ModelRange.createFromParentsAndOffsets( conversionResult, 2, conversionResult, 10 ) ) );
} );
it( 'should convert markers stamps for collapsed ranges', () => {
const schema = new ModelSchema();
schema.registerItem( 'paragraph', '$block' );
dispatcher = new ViewConversionDispatcher( { schema } );
dispatcher.on( 'text', convertText() );
buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' );
buildViewConverter().for( dispatcher ).fromElement( 'm' ).toMarker();
const viewElement = new ViewContainerElement( 'p', null, [
new ViewText( 'F' ),
new ViewAttributeElement( 'm', { 'data-name': 'comment' } ),
new ViewText( 'o' ),
new ViewAttributeElement( 'm', { 'data-name': 'search' } ),
new ViewText( 'o' ),
] );
const { conversionResult, markers } = dispatcher.convert( viewElement, { context: [ '$root' ] } );
const markerComment = markers.get( 'comment' );
const markerSearch = markers.get( 'search' );
expect( stringify( conversionResult ) ).to.equal( 'Foo' );
expect( markers.size ).to.equal( 2 );
expect( markerComment ).to.instanceof( ModelRange );
expect( markerComment.isEqual( ModelRange.createFromParentsAndOffsets( conversionResult, 1, conversionResult, 1 ) ) );
expect( markerSearch ).to.instanceof( ModelRange );
expect( markerSearch.isEqual( ModelRange.createFromParentsAndOffsets( conversionResult, 2, conversionResult, 2 ) ) );
} );
} );
describe( 'conversionApi#convertItem', () => {
it( 'should convert view elements and view text', () => {
const dispatcher = new ViewConversionDispatcher();
const viewFragment = new ViewDocumentFragment( [
new ViewContainerElement( 'p' ), new ViewText( 'foobar' )
] );
dispatcher.on( 'text', ( evt, data ) => {
data.output = { text: data.input.data };
} );
dispatcher.on( 'element:p', ( evt, data ) => {
data.output = { name: 'p' };
} );
dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
data.output = [];
for ( let child of data.input.getChildren() ) {
data.output.push( conversionApi.convertItem( child ) );
}
} );
const { conversionResult } = dispatcher.convert( viewFragment );
expect( conversionResult ).to.deep.equal( [
{ name: 'p' },
{ text: 'foobar' }
] );
} );
} );
describe( 'conversionApi#convertChildren', () => {
it( 'should fire proper events for all children of passed view part', () => {
const dispatcher = new ViewConversionDispatcher();
const viewFragment = new ViewDocumentFragment( [
new ViewContainerElement( 'p' ), new ViewText( 'foobar' )
] );
dispatcher.on( 'text', ( evt, data ) => {
data.output = { text: data.input.data };
} );
dispatcher.on( 'element:p', ( evt, data ) => {
data.output = { name: 'p' };
} );
dispatcher.on( 'documentFragment', ( evt, data, consumable, conversionApi ) => {
data.output = conversionApi.convertChildren( data.input );
} );
const { conversionResult } = dispatcher.convert( viewFragment );
expect( conversionResult ).to.deep.equal( [
{ name: 'p' },
{ text: 'foobar' }
] );
} );
it( 'should flatten structure of non-converted elements', () => {
const dispatcher = new ViewConversionDispatcher();
dispatcher.on( 'text', ( evt, data ) => {
data.output = data.input.data;
} );
dispatcher.on( 'element', ( evt, data, consumable, conversionApi ) => {
data.output = conversionApi.convertChildren( data.input, consumable );
} );
const viewStructure = new ViewContainerElement( 'div', null, [
new ViewContainerElement( 'p', null, [
new ViewContainerElement( 'span', { class: 'nice' }, [
new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ),
new ViewText( ' bar ' ),
new ViewAttributeElement( 'i', null, new ViewText( 'xyz' ) )
] )
] ),
new ViewContainerElement( 'p', null, [
new ViewAttributeElement( 'strong', null, [
new ViewText( 'aaa ' ),
new ViewAttributeElement( 'span', null, new ViewText( 'bbb' ) ),
new ViewText( ' ' ),
new ViewAttributeElement( 'a', { href: 'bar.html' }, new ViewText( 'ccc' ) )
] )
] )
] );
expect( dispatcher.convert( viewStructure ).conversionResult ).to.deep.equal( [ 'foo', ' bar ', 'xyz', 'aaa ', 'bbb', ' ', 'ccc' ] );
} );
} );
} );