/** * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ import Conversion from '../../src/conversion/conversion'; import UpcastDispatcher from '../../src/conversion/upcastdispatcher'; import UpcastHelpers, { convertText, convertToModelFragment } from '../../src/conversion/upcasthelpers'; import DowncastHelpers from '../../src/conversion/downcasthelpers'; import EditingController from '../../src/controller/editingcontroller'; import Model from '../../src/model/model'; import { parse as viewParse, stringify as viewStringify } from '../../src/dev-utils/view'; import { stringify as modelStringify } from '../../src/dev-utils/model'; import ConversionHelpers from '../../src/conversion/conversionhelpers'; import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils'; import { StylesProcessor } from '../../src/view/stylesmap'; describe( 'Conversion', () => { let conversion, downcastDispA, upcastDispaA, downcastDispB; beforeEach( () => { // Placeholders. Will be used only to see if their were given as attribute for a spy function. downcastDispA = Symbol( 'downA' ); downcastDispB = Symbol( 'downB' ); upcastDispaA = Symbol( 'upA' ); conversion = new Conversion( [ downcastDispA, downcastDispB ], [ upcastDispaA ] ); } ); describe( 'addAlias()', () => { it( 'should throw when trying to use same group name twice', () => { expectToThrowCKEditorError( () => { conversion.addAlias( 'upcast', upcastDispaA ); }, /conversion-group-exists/ ); } ); it( 'should throw when trying to add not registered dispatcher', () => { expectToThrowCKEditorError( () => { conversion.addAlias( 'foo', {} ); }, /conversion-add-alias-dispatcher-not-registered/ ); } ); } ); describe( 'for()', () => { it( 'should return ConversionHelpers', () => { expect( conversion.for( 'upcast' ) ).to.be.instanceof( ConversionHelpers ); expect( conversion.for( 'downcast' ) ).to.be.instanceof( ConversionHelpers ); } ); it( 'should throw if non-existing group name has been used', () => { expectToThrowCKEditorError( () => { conversion.for( 'foo' ); }, /conversion-for-unknown-group/ ); } ); it( 'should return proper helpers for group', () => { expect( conversion.for( 'upcast' ) ).to.be.instanceof( UpcastHelpers ); conversion.addAlias( 'foo', upcastDispaA ); expect( conversion.for( 'foo' ) ).to.be.instanceof( UpcastHelpers ); expect( conversion.for( 'downcast' ) ).to.be.instanceof( DowncastHelpers ); conversion.addAlias( 'bar', downcastDispB ); expect( conversion.for( 'bar' ) ).to.be.instanceof( DowncastHelpers ); } ); } ); describe( 'add()', () => { let helperA, helperB; beforeEach( () => { helperA = sinon.stub(); helperB = sinon.stub(); } ); it( 'should be chainable', () => { const helpers = conversion.for( 'upcast' ); const addResult = helpers.add( () => {} ); expect( addResult ).to.equal( helpers ); } ); it( 'should fire given helper for every dispatcher in given group', () => { conversion.for( 'downcast' ).add( helperA ); expect( helperA.calledWithExactly( downcastDispA ) ).to.be.true; expect( helperA.calledWithExactly( downcastDispB ) ).to.be.true; expect( helperA.calledWithExactly( upcastDispaA ) ).to.be.false; conversion.for( 'upcast' ).add( helperB ); expect( helperB.calledWithExactly( downcastDispA ) ).to.be.false; expect( helperB.calledWithExactly( downcastDispB ) ).to.be.false; expect( helperB.calledWithExactly( upcastDispaA ) ).to.be.true; } ); } ); it( 'constructor() should be able to take singular objects instead of arrays', () => { const helperA = sinon.stub(); const helperB = sinon.stub(); conversion = new Conversion( downcastDispA, upcastDispaA ); conversion.for( 'downcast' ).add( helperA ); expect( helperA.calledWithExactly( downcastDispA ) ).to.be.true; conversion.for( 'upcast' ).add( helperB ); expect( helperB.calledWithExactly( upcastDispaA ) ).to.be.true; } ); describe( 'converters', () => { let viewDispatcher, model, schema, conversion, modelRoot, viewRoot; beforeEach( () => { model = new Model(); const controller = new EditingController( model, new StylesProcessor() ); const modelDoc = model.document; modelRoot = modelDoc.createRoot(); viewRoot = controller.view.document.getRoot(); // Set name of view root the same as dom root. // This is a mock of attaching view root to dom root. viewRoot._name = 'div'; schema = model.schema; schema.extend( '$text', { allowIn: '$root', allowAttributes: [ 'bold' ] } ); schema.register( 'paragraph', { inheritAllFrom: '$block' } ); viewDispatcher = new UpcastDispatcher( model, { schema } ); viewDispatcher.on( 'text', convertText() ); viewDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); viewDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); conversion = new Conversion( controller.downcastDispatcher, viewDispatcher ); } ); describe( 'elementToElement', () => { it( 'config.view is a string', () => { conversion.elementToElement( { model: 'paragraph', view: 'p' } ); testConversion( '
Foo
', 'Foo
', 'Foo
', 'Foo
' ); } ); it( 'config.view is an object', () => { schema.register( 'fancyParagraph', { inheritAllFrom: 'paragraph' } ); conversion.elementToElement( { model: 'fancyParagraph', view: { name: 'p', classes: 'fancy' } } ); testConversion( 'Foo
', 'Foo
', 'Foo
' ); testConversion( 'Foo', 'Foo
' ); } ); it( 'upcastAlso given as a function', () => { schema.register( 'heading', { inheritAllFrom: '$block' } ); conversion.elementToElement( { model: 'heading', view: 'h2', upcastAlso: viewElement => { const fontSize = viewElement.getStyle( 'font-size' ); if ( !fontSize ) { return null; } const match = fontSize.match( /(\d+)\s*px/ ); if ( !match ) { return null; } const size = Number( match[ 1 ] ); if ( size >= 26 ) { return { name: true, style: [ 'font-size' ] }; } return null; } } ); conversion.elementToElement( { model: 'paragraph', view: 'p' } ); testConversion( '', 'Foo bar
', 'Foo
', 'Foo
', 'Foo
' ); } ); it( 'config.converterPriority is defined (override upcast)', () => { schema.extend( '$text', { allowAttributes: [ 'foo' ] } ); conversion.attributeToElement( { model: 'bold', view: 'strong' } ); conversion.attributeToElement( { model: 'foo', view: 'strong', converterPriority: 'high' } ); testConversion( 'Foo
', 'Foo
' ); } ); it( 'config.view is an object', () => { conversion.attributeToElement( { model: 'bold', view: { name: 'span', classes: 'bold' } } ); testConversion( 'Foo bar
', 'Foo
', 'Foo
', 'Foo
' ); testConversion( 'Foo
', 'Foo
' ); testConversion( 'Foo
', 'Foo
' ); testConversion( 'Foo
', 'Foo
' ); testConversion( 'Foo
', 'Foo
' ); testConversion( 'Foo
', 'Foo
' ); testConversion( 'Foo bar
', 'Foo bar
', 'Foo bar
' ); testConversion( 'Foo bar
', 'Foo bar
', 'Foo bar
' ); testConversion( 'Foo bar
', 'Foo bar
' ); } ); it( 'config.model.name is given', () => { schema.extend( '$text', { allowAttributes: [ 'textDecoration' ] } ); conversion.attributeToElement( { model: { key: 'textDecoration', values: [ 'underline', 'lineThrough' ], name: '$text' }, view: { underline: { name: 'span', styles: { 'text-decoration': 'underline' } }, lineThrough: { name: 'span', styles: { 'text-decoration': 'line-through' } } } } ); testConversion( 'Foo
', 'Foo
', 'Foo
', '
', 'Foo
', 'Foo
', 'Foo
' ); testConversion( 'Foo
', 'Foo
', 'Foo
' ); } ); it( 'config.view and config.model have name and key set', () => { schema.extend( 'image', { allowAttributes: [ 'source' ] } ); conversion.attributeToAttribute( { model: { name: 'image', key: 'source' }, view: { name: 'img', key: 'src' } } ); testConversion( '
', '