/** * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import buildModelConverter from '../../src/conversion/buildmodelconverter'; 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 ModelPosition from '../../src/model/position'; import modelWriter from '../../src/model/writer'; import ViewDocument from '../../src/view/document'; import ViewElement from '../../src/view/element'; import ViewContainerElement from '../../src/view/containerelement'; import ViewAttributeElement from '../../src/view/attributeelement'; import ViewUIElement from '../../src/view/uielement'; 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 { convertCollapsedSelection, clearAttributes } from '../../src/conversion/model-selection-to-view-converters'; import { createRangeOnElementOnly } from '../../tests/model/_utils/utils'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; function viewAttributesToString( item ) { let result = ''; for ( const key of item.getAttributeKeys() ) { const value = item.getAttribute( key ); if ( value ) { result += ' ' + key + '="' + value + '"'; } } 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 + ''; } } return result; } describe( 'Model converter builder', () => { let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection; beforeEach( () => { modelDoc = new ModelDocument(); modelRoot = modelDoc.createRoot( 'root', 'root' ); 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( 'model element to view element conversion', () => { it( 'using passed view element name', () => { buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' ); const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed view element', () => { buildModelConverter().for( dispatcher ).fromElement( 'image' ).toElement( new ViewContainerElement( 'img' ) ); const modelElement = new ModelElement( 'image' ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
' ); } ); it( 'using passed creator function', () => { buildModelConverter().for( dispatcher ) .fromElement( 'header' ) .toElement( data => new ViewContainerElement( 'h' + data.item.getAttribute( 'level' ) ) ); const modelElement = new ModelElement( 'header', { level: 2 }, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); } ); describe( 'model attribute to view element conversion', () => { beforeEach( () => { buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' ); } ); it( 'using passed view element name', () => { buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( 'strong' ); const modelElement = new ModelText( 'foo', { bold: true } ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); } ); it( 'using passed view element', () => { buildModelConverter().for( dispatcher ).fromAttribute( 'bold' ).toElement( new ViewAttributeElement( 'strong' ) ); const modelElement = new ModelText( 'foo', { bold: true } ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); } ); it( 'using passed creator function', () => { buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( value => new ViewAttributeElement( value ) ); const modelElement = new ModelText( 'foo', { italic: 'em' } ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); modelWriter.setAttribute( ModelRange.createIn( modelRoot ), 'italic', 'i' ); dispatcher.convertAttribute( 'changeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'em', 'i' ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'italic' ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'i', null ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); } ); it( 'selection conversion', () => { // This test requires collapsed range selection converter (breaking attributes) and clearing "artifacts". dispatcher.on( 'selection', clearAttributes() ); dispatcher.on( 'selection', convertCollapsedSelection() ); // Model converter builder should add selection converter. buildModelConverter().for( dispatcher ).fromAttribute( 'italic' ).toElement( value => new ViewAttributeElement( value ) ); modelRoot.appendChildren( new ModelText( 'foo', { italic: 'em' } ) ); // Set collapsed selection after "f". const position = new ModelPosition( modelRoot, [ 1 ] ); modelDoc.selection.setRanges( [ new ModelRange( position, position ) ] ); modelDoc.selection._updateAttributes(); // Convert stuff. dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); dispatcher.convertSelection( modelDoc.selection, [] ); // Check if view structure is ok. expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); // Check if view selection is collapsed after "f" letter. let ranges = Array.from( viewSelection.getRanges() ); expect( ranges.length ).to.equal( 1 ); expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true; expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo". expect( ranges[ 0 ].start.offset ).to.equal( 1 ); // Change selection attribute, convert it. modelDoc.selection.setAttribute( 'italic', 'i' ); dispatcher.convertSelection( modelDoc.selection, [] ); // Check if view structure has changed. expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); // Check if view selection is inside new element. ranges = Array.from( viewSelection.getRanges() ); expect( ranges.length ).to.equal( 1 ); expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true; expect( ranges[ 0 ].start.parent.name ).to.equal( 'i' ); expect( ranges[ 0 ].start.offset ).to.equal( 0 ); // Some more tests checking how selection attributes changes are converted: modelDoc.selection.removeAttribute( 'italic' ); dispatcher.convertSelection( modelDoc.selection, [] ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); ranges = Array.from( viewSelection.getRanges() ); expect( ranges[ 0 ].start.parent.name ).to.equal( 'div' ); expect( ranges[ 0 ].start.offset ).to.equal( 1 ); modelDoc.selection.setAttribute( 'italic', 'em' ); dispatcher.convertSelection( modelDoc.selection, [] ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); ranges = Array.from( viewSelection.getRanges() ); expect( ranges.length ).to.equal( 1 ); expect( ranges[ 0 ].start.isEqual( ranges[ 0 ].end ) ).to.be.true; expect( ranges[ 0 ].start.parent ).to.be.instanceof( ViewText ); // "foo". expect( ranges[ 0 ].start.offset ).to.equal( 1 ); } ); } ); describe( 'model attribute to view attribute conversion', () => { beforeEach( () => { buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toElement( 'p' ); } ); it( 'using default 1-to-1 conversion', () => { buildModelConverter().for( dispatcher ).fromAttribute( 'class' ).toAttribute(); const modelElement = new ModelElement( 'paragraph', { class: 'myClass' }, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.setAttribute( 'class', 'newClass' ); dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'myClass', 'newClass' ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.removeAttribute( 'class' ); dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'class', 'newClass', null ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed attribute key', () => { buildModelConverter().for( dispatcher ).fromAttribute( 'theme' ).toAttribute( 'class' ); const modelElement = new ModelElement( 'paragraph', { theme: 'abc' }, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.setAttribute( 'theme', 'xyz' ); dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'abc', 'xyz' ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.removeAttribute( 'theme' ); dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'xyz', null ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed attribute key and value', () => { buildModelConverter().for( dispatcher ).fromAttribute( 'highlighted' ).toAttribute( 'style', 'background:yellow' ); const modelElement = new ModelElement( 'paragraph', { 'highlighted': true }, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.removeAttribute( 'highlighted' ); dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'highlighted', true, null ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed attribute creator function', () => { buildModelConverter().for( dispatcher ) .fromAttribute( 'theme' ) .toAttribute( value => ( { key: 'class', value: value + '-theme' } ) ); const modelElement = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.setAttribute( 'theme', 'good' ); dispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'nice', 'good' ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); modelElement.removeAttribute( 'theme' ); dispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'theme', 'good', null ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); } ); describe( 'model marker to view element conversion', () => { let modelText, modelElement; beforeEach( () => { modelText = new ModelText( 'foobar' ); modelElement = new ModelElement( 'paragraph', null, [ modelText ] ); modelRoot.appendChildren( modelElement ); const viewText = new ViewText( 'foobar' ); const viewElement = new ViewContainerElement( 'p', null, [ viewText ] ); viewRoot.appendChildren( viewElement ); mapper.bindElements( modelElement, viewElement ); } ); it( 'using passed view element name', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'strong' ); dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed view element', () => { const viewElement = new ViewAttributeElement( 'span', { class: 'search' } ); buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( viewElement ); dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed creator function', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( data => { const className = 'search search-color-' + data.name.split( ':' )[ 1 ]; return new ViewAttributeElement( 'span', { class: className } ); } ); dispatcher.convertMarker( 'addMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search:blue', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); // Nothing should change as we remove a marker with different name, which should generate different view attribute element. expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search:red', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'should do nothing when marker range is collapsed', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toElement( 'strong' ); dispatcher.convertMarker( 'addMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 ) ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); } ); describe( 'model marker to view stamp conversion', () => { let modelText, modelElement, range; beforeEach( () => { modelText = new ModelText( 'foobar' ); modelElement = new ModelElement( 'paragraph', null, [ modelText ] ); modelRoot.appendChildren( modelElement ); const viewText = new ViewText( 'foobar' ); const viewElement = new ViewContainerElement( 'p', null, [ viewText ] ); viewRoot.appendChildren( viewElement ); mapper.bindElements( modelElement, viewElement ); } ); describe( 'collapsed range', () => { beforeEach( () => { range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 ); } ); it( 'using passed view element name', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( 'span' ); dispatcher.convertMarker( 'addMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed view element', () => { const viewElement = new ViewUIElement( 'span', { class: 'search' } ); buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( viewElement ); dispatcher.convertMarker( 'addMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed creator function', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( data => { const className = 'search search-color-' + data.name.split( ':' )[ 1 ]; return new ViewUIElement( 'span', { class: className } ); } ); dispatcher.convertMarker( 'addMarker', 'search:red', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search:red', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); } ); describe( 'non-collapsed range', () => { beforeEach( () => { range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 4 ); } ); it( 'using passed view element name', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( 'span' ); dispatcher.convertMarker( 'addMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed view element', () => { const viewElement = new ViewUIElement( 'span', { class: 'search' } ); buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( viewElement ); dispatcher.convertMarker( 'addMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'using passed creator function', () => { buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( data => { const className = 'search search-color-' + data.name.split( ':' )[ 1 ]; return new ViewUIElement( 'span', { class: className } ); } ); dispatcher.convertMarker( 'addMarker', 'search:red', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); dispatcher.convertMarker( 'removeMarker', 'search:red', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); } ); it( 'should overwrite default priority', () => { range = ModelRange.createFromParentsAndOffsets( modelElement, 2, modelElement, 2 ); buildModelConverter().for( dispatcher ).fromMarker( 'search' ).toStamp( 'normal' ); buildModelConverter().for( dispatcher ).fromMarker( 'search' ).withPriority( 'high' ).toStamp( 'high' ); dispatcher.convertMarker( 'addMarker', 'search', range ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); } ); describe( 'withPriority', () => { it( 'should change default converters priority', () => { buildModelConverter().for( dispatcher ).fromElement( 'custom' ).toElement( 'custom' ); buildModelConverter().for( dispatcher ).fromElement( 'custom' ).withPriority( 'high' ).toElement( 'other' ); const modelElement = new ModelElement( 'custom', null, new ModelText( 'foobar' ) ); modelRoot.appendChildren( modelElement ); dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
foobar
' ); } ); } ); it( 'should throw when trying to build model element to view attribute converter', () => { expect( () => { buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toAttribute( 'paragraph', true ); } ).to.throw( CKEditorError, /^build-model-converter-non-attribute-to-attribute/ ); } ); it( 'should throw when trying to build model element to view stamp converter', () => { expect( () => { buildModelConverter().for( dispatcher ).fromElement( 'paragraph' ).toStamp( 'span' ); } ).to.throw( CKEditorError, /^build-model-converter-non-marker-to-stamp/ ); } ); it( 'should throw when trying to build model attribute to view stamp converter', () => { expect( () => { buildModelConverter().for( dispatcher ).fromAttribute( 'class' ).toStamp( 'span' ); } ).to.throw( CKEditorError, /^build-model-converter-non-marker-to-stamp/ ); } ); } );