/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import ModelDocument from '../../src/model/document';
import ModelElement from '../../src/model/element';
import ModelText from '../../src/model/text';
import ModelRange from '../../src/model/range';
import ViewDocument from '../../src/view/document';
import ViewElement from '../../src/view/element';
import ViewAttributeElement from '../../src/view/attributeelement';
import ViewText from '../../src/view/text';
import Mapper from '../../src/conversion/mapper';
import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher';
import { insertText, remove } from '../../src/conversion/model-to-view-converters';
import { convertText } from '../../src/conversion/view-to-model-converters';
import {
attributeElementToViewConverter,
viewToAttributeElementConverter,
containerElementToView,
viewToContainerElement
} from '../../src/conversion/configurationdefinedconverters';
import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher';
import ModelSchema from '../../src/model/schema';
import ModelWalker from '../../src/model/treewalker';
import ModelTextProxy from '../../src/model/textproxy';
function viewAttributesToString( item ) {
let result = '';
for ( const key of item.getAttributeKeys() ) {
const value = item.getAttribute( key );
if ( value ) {
result += ' ' + key + '="' + value + '"';
}
}
return result;
}
function modelToString( item ) {
let result = '';
if ( item instanceof ModelTextProxy ) {
const attributes = modelAttributesToString( item );
result = attributes ? '<$text' + attributes + '>' + item.data + '$text>' : item.data;
} else {
const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } );
for ( const value of walker ) {
result += modelToString( value.item );
}
if ( item instanceof ModelElement ) {
const attributes = modelAttributesToString( item );
result = '<' + item.name + attributes + '>' + result + '' + item.name + '>';
}
}
return result;
}
function modelAttributesToString( item ) {
let result = '';
for ( const attr of item.getAttributes() ) {
result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"';
}
return result;
}
function viewToString( item ) {
let result = '';
if ( item instanceof ViewText ) {
result = item.data;
} else {
// ViewElement or ViewDocumentFragment.
for ( const child of item.getChildren() ) {
result += viewToString( child );
}
if ( item instanceof ViewElement ) {
result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '' + item.name + '>';
}
}
return result;
}
describe( 'Configuration defined converters', () => {
let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, batch;
beforeEach( () => {
modelDoc = new ModelDocument();
modelRoot = modelDoc.createRoot( 'root', 'root' );
batch = modelDoc.batch();
viewDoc = new ViewDocument();
viewRoot = viewDoc.createRoot( 'div' );
viewSelection = viewDoc.selection;
mapper = new Mapper();
mapper.bindElements( modelRoot, viewRoot );
dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } );
dispatcher.on( 'insert:$text', insertText() );
dispatcher.on( 'remove', remove() );
} );
afterEach( () => {
viewDoc.destroy();
} );
describe( 'Attribute converter', () => {
function testConversion( definition, expectedConversion ) {
attributeElementToViewConverter( 'foo', definition, [ dispatcher ] );
const modelElement = new ModelText( 'foo', { foo: 'bar' } );
modelRoot.appendChildren( modelElement );
dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
expect( viewToString( viewRoot ) ).to.equal( expectedConversion );
batch.removeAttribute( 'bold', modelRoot );
dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'foo', 'bar', null );
expect( viewToString( viewRoot ) ).to.equal( '
foo
' );
}
describe( 'model to view conversion', () => {
it( 'using passed view element name', () => {
testConversion( { model: 'bar', view: 'strong' }, 'foo
' );
} );
it( 'using passed view element object', () => {
testConversion( { model: 'bar', view: { name: 'strong' } }, 'foo
' );
} );
it( 'using passed view element object with styles object', () => {
testConversion( {
model: 'bar',
view: { name: 'span', styles: { 'font-weight': 'bold' } }
}, 'foo
' );
} );
it( 'using passed view element object with class string', () => {
testConversion( { model: 'bar', view: { name: 'span', classes: 'foo' } }, 'foo
' );
} );
it( 'using passed view element object with class array', () => {
testConversion( {
model: 'bar',
view: { name: 'span', classes: [ 'foo', 'foo-bar' ] }
}, 'foo
' );
} );
it( 'using passed view element object with attributes', () => {
testConversion( {
model: 'bar',
view: { name: 'span', attributes: { 'data-foo': 'bar' } }
}, 'foo
' );
} );
it( 'should do nothing for undefined value', () => {
attributeElementToViewConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] );
const modelElement = new ModelText( 'foo', { foo: 'baz' } );
modelRoot.appendChildren( modelElement );
dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
expect( viewToString( viewRoot ) ).to.equal( 'foo
' );
} );
} );
describe( 'view to model conversion', () => {
let dispatcher, schema, additionalData, batch;
const modelDocument = new ModelDocument();
beforeEach( () => {
batch = modelDocument.batch();
// `additionalData` parameter for `.convert` calls.
additionalData = { context: [ '$root' ] };
schema = new ModelSchema();
schema.registerItem( 'div', '$block' );
schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } );
schema.allow( { name: '$text', inside: '$root' } );
dispatcher = new ViewConversionDispatcher( { schema } );
dispatcher.on( 'text', convertText() );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', {
model: 'bar',
view: { name: 'span', classes: [ 'foo', 'bar' ] }
}, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', {
model: 'bar',
view: { name: 'span', styles: { 'font-weight': 'bold' } }
}, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', {
model: 'bar',
view: { name: 'span', attributes: { 'data-foo': 'bar' } }
}, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', {
model: 'bar',
view: 'strong',
acceptsAlso: [
{ name: 'span', classes: [ 'foo', 'bar' ] },
{ name: 'span', attributes: { 'data-foo': 'bar' } }
]
}, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
it( 'should convert from view element to model attribute', () => {
viewToAttributeElementConverter( 'foo', { model: 'baz', view: 'strong' }, [ dispatcher ] );
viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo$text>' );
} );
} );
} );
describe( 'Element converter', () => {
function testModelConversion( definition, expectedResult ) {
containerElementToView( definition, [ dispatcher ] );
const modelElement = new ModelElement( 'foo', null, new ModelText( 'bar' ) );
modelRoot.appendChildren( modelElement );
dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) );
expect( viewToString( viewRoot ) ).to.equal( '' + expectedResult + '
' );
}
describe( 'model to view conversion', () => {
it( 'using passed view element name', () => {
testModelConversion( { model: 'foo', view: 'strong' }, 'bar' );
} );
it( 'using passed view element object', () => {
testModelConversion( { model: 'foo', view: { name: 'strong' } }, 'bar' );
} );
it( 'using passed view element object with styles object', () => {
testModelConversion( {
model: 'foo',
view: { name: 'span', styles: { 'font-weight': 'bold' } }
}, 'bar' );
} );
it( 'using passed view element object with class string', () => {
testModelConversion( { model: 'foo', view: { name: 'span', classes: 'foo' } }, 'bar' );
} );
it( 'using passed view element object with class array', () => {
testModelConversion( {
model: 'foo',
view: { name: 'span', classes: [ 'foo', 'foo-bar' ] }
}, 'bar' );
} );
it( 'using passed view element object with attributes', () => {
testModelConversion( {
model: 'foo',
view: { name: 'span', attributes: { 'data-foo': 'bar' } }
}, 'bar' );
} );
} );
describe( 'view to model conversion', () => {
let dispatcher, schema, additionalData, batch;
const modelDocument = new ModelDocument();
beforeEach( () => {
batch = modelDocument.batch();
// `additionalData` parameter for `.convert` calls.
additionalData = { context: [ '$root' ] };
schema = new ModelSchema();
schema.registerItem( 'div', '$block' );
schema.registerItem( 'bar', '$block' );
schema.registerItem( 'baz', '$block' );
schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } );
schema.allow( { name: '$text', inside: '$inline' } );
dispatcher = new ViewConversionDispatcher( { schema } );
dispatcher.on( 'text', convertText() );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'bar', view: 'strong' }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( {
model: 'bar',
view: 'strong',
acceptsAlso: [
{ name: 'span', classes: [ 'foo', 'bar' ] },
{ name: 'span', attributes: { 'data-foo': 'bar' } }
]
}, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
it( 'should convert from view element to model attribute', () => {
viewToContainerElement( { model: 'baz', view: 'strong' }, [ dispatcher ] );
viewToContainerElement( { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] );
const conversionResult = dispatcher.convert(
new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData
);
expect( modelToString( conversionResult ) ).to.equal( 'foo' );
} );
} );
} );
} );