/** * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import Mapper from '../../src/conversion/mapper'; import ModelElement from '../../src/model/element'; import ModelRootElement from '../../src/model/rootelement'; import ModelText from '../../src/model/text'; import ModelPosition from '../../src/model/position'; import ModelRange from '../../src/model/range'; import ViewElement from '../../src/view/element'; import ViewUIElement from '../../src/view/uielement'; import ViewText from '../../src/view/text'; import ViewPosition from '../../src/view/position'; import ViewRange from '../../src/view/range'; describe( 'Mapper', () => { describe( 'clearBindings', () => { it( 'should remove all mapping', () => { const viewA = new ViewElement( 'a' ); const viewB = new ViewElement( 'b' ); const viewC = new ViewElement( 'c' ); const modelA = new ModelElement( 'a' ); const modelB = new ModelElement( 'b' ); const modelC = new ModelElement( 'c' ); const mapper = new Mapper(); mapper.bindElements( modelA, viewA ); mapper.bindElements( modelB, viewB ); mapper.bindElements( modelC, viewC ); expect( mapper.toModelElement( viewA ) ).to.equal( modelA ); expect( mapper.toModelElement( viewB ) ).to.equal( modelB ); expect( mapper.toModelElement( viewC ) ).to.equal( modelC ); expect( mapper.toViewElement( modelA ) ).to.equal( viewA ); expect( mapper.toViewElement( modelB ) ).to.equal( viewB ); expect( mapper.toViewElement( modelC ) ).to.equal( viewC ); mapper.clearBindings(); expect( mapper.toModelElement( viewA ) ).to.be.undefined; expect( mapper.toModelElement( viewB ) ).to.be.undefined; expect( mapper.toModelElement( viewC ) ).to.be.undefined; expect( mapper.toViewElement( modelA ) ).to.be.undefined; expect( mapper.toViewElement( modelB ) ).to.be.undefined; expect( mapper.toViewElement( modelC ) ).to.be.undefined; } ); } ); describe( 'unbindModelElement', () => { it( 'should remove binding between given model element and view element that it was bound to', () => { const viewA = new ViewElement( 'a' ); const modelA = new ModelElement( 'a' ); const mapper = new Mapper(); mapper.bindElements( modelA, viewA ); expect( mapper.toModelElement( viewA ) ).to.equal( modelA ); expect( mapper.toViewElement( modelA ) ).to.equal( viewA ); mapper.unbindModelElement( modelA ); expect( mapper.toModelElement( viewA ) ).to.be.undefined; expect( mapper.toViewElement( modelA ) ).to.be.undefined; } ); it( 'should not remove binding between view and model element if view element got rebound', () => { const viewA = new ViewElement( 'a' ); const modelA = new ModelElement( 'a' ); const modelB = new ModelElement( 'b' ); const mapper = new Mapper(); mapper.bindElements( modelA, viewA ); mapper.bindElements( modelB, viewA ); // `modelA` is still bound to `viewA` even though `viewA` got rebound. expect( mapper.toViewElement( modelA ) ).to.equal( viewA ); mapper.unbindModelElement( modelA ); expect( mapper.toViewElement( modelA ) ).to.be.undefined; expect( mapper.toModelElement( viewA ) ).to.equal( modelB ); } ); } ); describe( 'unbindViewElement', () => { it( 'should remove binding between given view element and model element that it was bound to', () => { const viewA = new ViewElement( 'a' ); const modelA = new ModelElement( 'a' ); const mapper = new Mapper(); mapper.bindElements( modelA, viewA ); expect( mapper.toModelElement( viewA ) ).to.equal( modelA ); expect( mapper.toViewElement( modelA ) ).to.equal( viewA ); mapper.unbindViewElement( viewA ); expect( mapper.toModelElement( viewA ) ).to.be.undefined; expect( mapper.toViewElement( modelA ) ).to.be.undefined; } ); it( 'should not remove binding between model and view element if model element got rebound', () => { const viewA = new ViewElement( 'a' ); const viewB = new ViewElement( 'b' ); const modelA = new ModelElement( 'a' ); const mapper = new Mapper(); mapper.bindElements( modelA, viewA ); mapper.bindElements( modelA, viewB ); // `viewA` is still bound to `modelA`, even though `modelA` got rebound. expect( mapper.toModelElement( viewA ) ).to.equal( modelA ); mapper.unbindViewElement( viewA ); expect( mapper.toModelElement( viewA ) ).to.be.undefined; expect( mapper.toViewElement( modelA ) ).to.equal( viewB ); } ); } ); describe( 'Standard mapping', () => { let modelDiv, modelP, modelImg, viewDiv, viewP, viewB, viewI, viewU, viewSup, viewImg, viewTextB, viewTextO, viewTextM, viewTextX, viewTextY, viewTextZZ, viewTextFOO, viewTextBAR, mapper; beforeEach( () => { // Tree Model: // //
---> modelP
// │ ├─ y
// │ ├─ f {b,i}
// │ ├─ o {b,i}
// │ ├─ o {b,i}
// │ ├─ b
// │ ├─ a
// │ ├─ r
// │ ├─ ---> modelImg
// │ ├─ b {u}
// │ ├─ o {u,sup}
// │ └─ m {u}
// ├─ z
// └─ z
//
// Tree View:
//
//
---> viewP
// │ ├─ y ---> viewTextY
// │ ├─ ---> viewB
// │ │ └─ ---> viewI
// │ │ └─ foo ---> viewTextFOO
// │ ├─ bar ---> viewTextBAR
// │ ├─ f{}oo ---> viewImg
// │ └─ ---> viewU
// │ ├─ b ---> viewTextB
// │ ├─ ---> viewSup
// │ │ └─ o ---> viewTextO
// │ └─ m ---> viewTextM
// └─ zz ---> viewTextZZ
modelImg = new ModelElement( 'img' );
modelP = new ModelElement( 'p', {}, [
new ModelText( 'y' ),
new ModelText( 'foo', { b: true, i: true } ),
new ModelText( 'bar' ),
modelImg,
new ModelText( 'b', { u: true } ),
new ModelText( 'o', { u: true, sup: true } ),
new ModelText( 'm', { u: true } )
] );
modelDiv = new ModelRootElement();
modelDiv._appendChild( [
new ModelText( 'x' ),
modelP,
new ModelText( 'zz' )
] );
viewTextB = new ViewText( 'b' );
viewTextO = new ViewText( 'o' );
viewTextM = new ViewText( 'm' );
viewTextX = new ViewText( 'x' );
viewTextY = new ViewText( 'y' );
viewTextZZ = new ViewText( 'zz' );
viewTextFOO = new ViewText( 'foo' );
viewTextBAR = new ViewText( 'bar' );
viewImg = new ViewElement( 'img' );
viewSup = new ViewElement( 'sup', {}, [ viewTextO ] );
viewU = new ViewElement( 'u', {}, [ viewTextB, viewSup, viewTextM ] );
viewI = new ViewElement( 'i', {}, [ viewTextFOO ] );
viewB = new ViewElement( 'b', {}, [ viewI ] );
viewP = new ViewElement( 'p', {}, [ viewTextY, viewB, viewTextBAR, viewImg, viewU ] );
viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewP, viewTextZZ ] );
mapper = new Mapper();
mapper.bindElements( modelP, viewP );
mapper.bindElements( modelDiv, viewDiv );
mapper.bindElements( modelImg, viewImg );
} );
describe( 'toModelElement', () => {
it( 'should return corresponding model element', () => {
expect( mapper.toModelElement( viewP ) ).to.equal( modelP );
expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
} );
} );
describe( 'toViewElement', () => {
it( 'should return corresponding view element', () => {
expect( mapper.toViewElement( modelP ) ).to.equal( viewP );
expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
} );
} );
describe( 'toModelPosition', () => {
it( 'should fire viewToModelPosition event and return value calculated in callback to that event', () => {
const viewPosition = new ViewPosition( viewDiv, 0 );
const stub = {};
mapper.on( 'viewToModelPosition', ( evt, data ) => {
expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
data.modelPosition = stub;
// Do not stop the event. Test whether default algorithm was not called if data.modelPosition is already set.
} );
const result = mapper.toModelPosition( viewPosition );
expect( result ).to.equal( stub );
} );
it( 'should be possible to add custom position mapping callback after default callback', () => {
const viewPosition = new ViewPosition( viewDiv, 0 );
// Model position to which default algorithm should map `viewPosition`.
// This mapping is tested in a test below.
const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
const stub = {};
mapper.on( 'viewToModelPosition', ( evt, data ) => {
expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
data.modelPosition = stub;
}, { priority: 'low' } );
const result = mapper.toModelPosition( viewPosition );
expect( result ).to.equal( stub );
} );
// Default algorithm tests.
it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
it( 'should transform viewP 0', () => createToModelTest( viewP, 0, modelP, 0 ) );
it( 'should transform viewP 1', () => createToModelTest( viewP, 1, modelP, 1 ) );
it( 'should transform viewP 2', () => createToModelTest( viewP, 2, modelP, 4 ) );
it( 'should transform viewP 3', () => createToModelTest( viewP, 3, modelP, 7 ) );
it( 'should transform viewP 4', () => createToModelTest( viewP, 4, modelP, 8 ) );
it( 'should transform viewP 5', () => createToModelTest( viewP, 5, modelP, 11 ) );
it( 'should transform viewTextY 0', () => createToModelTest( viewTextY, 0, modelP, 0 ) );
it( 'should transform viewTextY 1', () => createToModelTest( viewTextY, 1, modelP, 1 ) );
it( 'should transform viewB 0', () => createToModelTest( viewB, 0, modelP, 1 ) );
it( 'should transform viewB 1', () => createToModelTest( viewB, 1, modelP, 4 ) );
it( 'should transform viewI 0', () => createToModelTest( viewI, 0, modelP, 1 ) );
it( 'should transform viewI 1', () => createToModelTest( viewI, 1, modelP, 4 ) );
it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelP, 1 ) );
it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelP, 2 ) );
it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelP, 3 ) );
it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelP, 4 ) );
it( 'should transform viewTextBAR 0', () => createToModelTest( viewTextBAR, 0, modelP, 4 ) );
it( 'should transform viewTextBAR 1', () => createToModelTest( viewTextBAR, 1, modelP, 5 ) );
it( 'should transform viewTextBAR 2', () => createToModelTest( viewTextBAR, 2, modelP, 6 ) );
it( 'should transform viewTextBAR 3', () => createToModelTest( viewTextBAR, 3, modelP, 7 ) );
it( 'should transform viewU 0', () => createToModelTest( viewU, 0, modelP, 8 ) );
it( 'should transform viewU 1', () => createToModelTest( viewU, 1, modelP, 9 ) );
it( 'should transform viewU 2', () => createToModelTest( viewU, 2, modelP, 10 ) );
it( 'should transform viewU 3', () => createToModelTest( viewU, 3, modelP, 11 ) );
it( 'should transform viewTextB 0', () => createToModelTest( viewTextB, 0, modelP, 8 ) );
it( 'should transform viewTextB 1', () => createToModelTest( viewTextB, 1, modelP, 9 ) );
it( 'should transform viewSup 0', () => createToModelTest( viewSup, 0, modelP, 9 ) );
it( 'should transform viewSup 1', () => createToModelTest( viewSup, 1, modelP, 10 ) );
it( 'should transform viewTextO 0', () => createToModelTest( viewTextO, 0, modelP, 9 ) );
it( 'should transform viewTextO 1', () => createToModelTest( viewTextO, 1, modelP, 10 ) );
it( 'should transform viewTextM 0', () => createToModelTest( viewTextM, 0, modelP, 10 ) );
it( 'should transform viewTextM 1', () => createToModelTest( viewTextM, 1, modelP, 11 ) );
it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
} );
describe( 'toViewPosition', () => {
it( 'should fire modelToViewPosition event and return value calculated in callback to that event', () => {
const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
const stub = {};
mapper.on( 'modelToViewPosition', ( evt, data ) => {
expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
data.viewPosition = stub;
// Do not stop the event. Test whether default algorithm was not called if data.viewPosition is already set.
} );
const result = mapper.toViewPosition( modelPosition );
expect( result ).to.equal( stub );
} );
it( 'should be possible to add custom position mapping callback after default callback', () => {
const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
// View position to which default algorithm should map `viewPosition`.
// This mapping is tested in a test below.
const viewPosition = new ViewPosition( viewTextX, 0 );
const stub = {};
mapper.on( 'modelToViewPosition', ( evt, data ) => {
expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
data.viewPosition = stub;
}, { priority: 'low' } );
const result = mapper.toViewPosition( modelPosition );
expect( result ).to.equal( stub );
} );
// Default algorithm tests.
it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
it( 'should transform modelP 0', () => createToViewTest( modelP, 0, viewTextY, 0 ) );
it( 'should transform modelP 1', () => createToViewTest( modelP, 1, viewTextY, 1 ) );
it( 'should transform modelP 2', () => createToViewTest( modelP, 2, viewTextFOO, 1 ) );
it( 'should transform modelP 3', () => createToViewTest( modelP, 3, viewTextFOO, 2 ) );
it( 'should transform modelP 4', () => createToViewTest( modelP, 4, viewTextBAR, 0 ) );
it( 'should transform modelP 5', () => createToViewTest( modelP, 5, viewTextBAR, 1 ) );
it( 'should transform modelP 6', () => createToViewTest( modelP, 6, viewTextBAR, 2 ) );
it( 'should transform modelP 7', () => createToViewTest( modelP, 7, viewTextBAR, 3 ) );
it( 'should transform modelP 8', () => createToViewTest( modelP, 8, viewP, 4 ) );
it( 'should transform modelP 9', () => createToViewTest( modelP, 9, viewTextB, 1 ) );
it( 'should transform modelP 10', () => createToViewTest( modelP, 10, viewTextM, 0 ) );
it( 'should transform modelP 11', () => createToViewTest( modelP, 11, viewP, 5 ) );
} );
describe( 'toModelRange', () => {
it( 'should transform range', () => {
const viewRange = ViewRange._createFromParentsAndOffsets( viewDiv, 0, viewTextFOO, 2 );
const modelRange = mapper.toModelRange( viewRange );
expect( modelRange.start.parent ).to.equal( modelDiv );
expect( modelRange.start.offset ).to.equal( 0 );
expect( modelRange.end.parent ).to.equal( modelP );
expect( modelRange.end.offset ).to.equal( 3 );
} );
} );
describe( 'toViewRange', () => {
it( 'should transform range', () => {
const modelRange = new ModelRange( ModelPosition._createAt( modelDiv, 0 ), ModelPosition._createAt( modelP, 3 ) );
const viewRange = mapper.toViewRange( modelRange );
expect( viewRange.start.parent ).to.equal( viewTextX );
expect( viewRange.start.offset ).to.equal( 0 );
expect( viewRange.end.parent ).to.equal( viewTextFOO );
expect( viewRange.end.offset ).to.equal( 2 );
} );
} );
function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
const modelPosition = ModelPosition._createAt( modelElement, modelOffset );
const viewPosition = mapper.toViewPosition( modelPosition );
expect( viewPosition.parent ).to.equal( viewElement );
expect( viewPosition.offset ).to.equal( viewOffset );
}
function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
const viewPosition = new ViewPosition( viewElement, viewOffset );
const modelPosition = mapper.toModelPosition( viewPosition );
expect( modelPosition.parent ).to.equal( modelElement );
expect( modelPosition.offset ).to.equal( modelOffset );
}
} );
describe( 'Widget mapping', () => {
let modelDiv, modelWidget, modelImg, modelCaption,
viewDiv, viewWidget, viewMask, viewWrapper, viewImg, viewCaption,
viewTextX, viewTextFOO, viewTextZZ, viewTextLABEL,
mapper;
before( () => {
// Tree Model:
//
//
---> modelImg
// │ └─
---> viewImg
// │ └─