Преглед на файлове

Tests: tests for basic model <=> view converters.

Szymon Cofalik преди 9 години
родител
ревизия
f2075e5aba

+ 298 - 0
packages/ckeditor5-engine/tests/treecontroller/model-to-view-converters.js

@@ -0,0 +1,298 @@
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* bender-tags: treecontroller */
+
+'use strict';
+
+import ModelDocument from '/ckeditor5/engine/treemodel/document.js';
+import ModelElement from '/ckeditor5/engine/treemodel/element.js';
+import ModelText from '/ckeditor5/engine/treemodel/text.js';
+import ModelRange from '/ckeditor5/engine/treemodel/range.js';
+import ModelPosition from '/ckeditor5/engine/treemodel/position.js';
+
+import ViewElement from '/ckeditor5/engine/treeview/element.js';
+import ViewContainerElement from '/ckeditor5/engine/treeview/containerelement.js';
+import ViewAttributeElement from '/ckeditor5/engine/treeview/attributeelement.js';
+import ViewText from '/ckeditor5/engine/treeview/text.js';
+import ViewWriter from  '/ckeditor5/engine/treeview/writer.js';
+
+import Mapper from '/ckeditor5/engine/treecontroller/mapper.js';
+import ModelConversionDispatcher from '/ckeditor5/engine/treecontroller/modelconversiondispatcher.js';
+import {
+	insertElement,
+	insertText,
+	setAttribute,
+	removeAttribute,
+	wrap,
+	unwrap,
+	move,
+	remove
+} from '/ckeditor5/engine/treecontroller/model-to-view-converters.js';
+
+let dispatcher, modelDoc, modelRoot, mapper, viewRoot, writer;
+
+beforeEach( () => {
+	modelDoc = new ModelDocument();
+	modelRoot = modelDoc.createRoot( 'root' );
+	viewRoot = new ViewContainerElement( 'div' );
+
+	mapper = new Mapper();
+	mapper.bindElements( modelRoot, viewRoot );
+
+	writer = new ViewWriter();
+
+	dispatcher = new ModelConversionDispatcher( { mapper, writer } );
+} );
+
+function viewAttributesToString( item ) {
+	let result = '';
+
+	for ( let key of item.getAttributeKeys() ) {
+		let 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 ( let child of item.getChildren() ) {
+			result += viewToString( child );
+		}
+
+		if ( item instanceof ViewElement ) {
+			result = '<' + item.name + viewAttributesToString( item ) + '>' + result + '</' + item.name + '>';
+		}
+	}
+
+	return result;
+}
+
+describe( 'insertText', () => {
+	it( 'should convert text insertion in model to view text', () => {
+		modelRoot.appendChildren( 'foobar' );
+		dispatcher.on( 'insert:$text', insertText() );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div>foobar</div>' );
+	} );
+} );
+
+describe( 'insertElement', () => {
+	it( 'should convert element insertion in model to and map positions for future converting', () => {
+		const modelElement = new ModelElement( 'paragraph', null, 'foobar' );
+		const viewElement = new ViewContainerElement( 'p' );
+
+		modelRoot.appendChildren( modelElement );
+		dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
+		dispatcher.on( 'insert:$text', insertText() );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
+	} );
+
+	it( 'should take view element function generator as a parameter', () => {
+		const elementGenerator = ( data, consumable ) => {
+			if ( consumable.consume( data.item, 'addAttribute:nice' ) ) {
+				return new ViewContainerElement( 'div' );
+			} else {
+				return new ViewContainerElement( 'p' );
+			}
+		};
+		const niceP = new ModelElement( 'myParagraph', { nice: true }, 'foo' );
+		const badP = new ModelElement( 'myParagraph', null, 'bar' );
+
+		modelRoot.appendChildren( [ niceP, badP ] );
+
+		dispatcher.on( 'insert:myParagraph', insertElement( elementGenerator ) );
+		dispatcher.on( 'insert:$text', insertText() );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><div>foo</div><p>bar</p></div>' );
+	} );
+} );
+
+describe( 'setAttribute/removeAttribute', () => {
+	it( 'should convert attribute insert/change/remove on a model node', () => {
+		const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, 'foobar' );
+		const viewElement = new ViewContainerElement( 'p' );
+
+		modelRoot.appendChildren( modelElement );
+		dispatcher.on( 'insert:paragraph', insertElement( viewElement ) );
+		dispatcher.on( 'insert:$text', insertText() );
+		dispatcher.on( 'addAttribute:class', setAttribute() );
+		dispatcher.on( 'changeAttribute:class', setAttribute() );
+		dispatcher.on( 'removeAttribute:class', removeAttribute() );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p class="foo">foobar</p></div>' );
+
+		modelElement.setAttribute( 'class', 'bar' );
+		dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'foo', 'bar' );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p class="bar">foobar</p></div>' );
+
+		modelElement.removeAttribute( 'class' );
+		dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelElement ), 'class', 'bar', null );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
+	} );
+
+	it( 'should convert insert/change/remove with attribute generating function as a parameter', () => {
+		const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, 'foobar' );
+		const modelDiv = new ModelElement( 'div', { theme: 'nice' } );
+
+		const themeConverter = ( data ) => {
+			const key = 'class';
+			let value = data.attributeNewValue;
+
+			if ( value && data.item instanceof ModelElement && data.item.getChildCount() > 0 ) {
+				value += ' ' + 'fix-content';
+			}
+
+			return { key, value };
+		};
+
+		modelRoot.appendChildren( [ modelParagraph, modelDiv ] );
+		dispatcher.on( 'insert:paragraph', insertElement( new ViewContainerElement( 'p' ) ) );
+		dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
+		dispatcher.on( 'insert:$text', insertText() );
+		dispatcher.on( 'addAttribute:theme', setAttribute( themeConverter ) );
+		dispatcher.on( 'changeAttribute:theme', setAttribute( themeConverter ) );
+		dispatcher.on( 'removeAttribute:theme', removeAttribute( themeConverter ) );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p class="nice fix-content">foobar</p><div class="nice"></div></div>' );
+
+		modelParagraph.setAttribute( 'theme', 'awesome' );
+		dispatcher.convertAttribute( 'changeAttribute', ModelRange.createOnElement( modelParagraph ), 'theme', 'nice', 'awesome' );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p class="awesome fix-content">foobar</p><div class="nice"></div></div>' );
+
+		modelParagraph.removeAttribute( 'theme' );
+		dispatcher.convertAttribute( 'removeAttribute', ModelRange.createOnElement( modelParagraph ), 'theme', 'awesome', null );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p><div class="nice"></div></div>' );
+	} );
+} );
+
+describe( 'wrap/unwrap', () => {
+	it( 'should convert insert/remove of attribute in model into wrapping element in a view', () => {
+		const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) );
+		const viewP = new ViewContainerElement( 'p' );
+		const viewB = new ViewAttributeElement( 'b' );
+
+		modelRoot.appendChildren( modelElement );
+		dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
+		dispatcher.on( 'insert:$text', insertText() );
+		dispatcher.on( 'addAttribute:bold', wrap( viewB ) );
+		dispatcher.on( 'removeAttribute:bold', unwrap( viewB ) );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
+
+		for ( let value of ModelRange.createFromElement( modelElement ) ) {
+			value.item.removeAttribute( 'bold' );
+		}
+
+		dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelElement ), 'bold', true, null );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
+	} );
+
+	it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => {
+		const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) );
+		const viewP = new ViewContainerElement( 'p' );
+
+		const elementGenerator = ( value ) => {
+			if ( value == 'bold' ) {
+				return new ViewAttributeElement( 'b' );
+			}
+		};
+
+		modelRoot.appendChildren( modelElement );
+		dispatcher.on( 'insert:paragraph', insertElement( viewP ) );
+		dispatcher.on( 'insert:$text', insertText() );
+		dispatcher.on( 'addAttribute:style', wrap( elementGenerator ) );
+		dispatcher.on( 'removeAttribute:style', unwrap( elementGenerator ) );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p><b>foobar</b></p></div>' );
+
+		for ( let value of ModelRange.createFromElement( modelElement ) ) {
+			value.item.removeAttribute( 'style' );
+		}
+
+		dispatcher.convertAttribute( 'removeAttribute', ModelRange.createFromElement( modelElement ), 'style', 'bold', null );
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><p>foobar</p></div>' );
+	} );
+} );
+
+describe( 'move', () => {
+	it( 'should move items in view accordingly to changes in model', () => {
+		const modelDivA = new ModelElement( 'div', null, [ 'foo', new ModelElement( 'image' ) ] );
+		const modelDivB = new ModelElement( 'div', null, [ 'xxyy' ] );
+
+		modelRoot.appendChildren( [ modelDivA, modelDivB ] );
+		dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
+		dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
+		dispatcher.on( 'insert:$text', insertText() );
+		dispatcher.on( 'move', move() );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		const removedNodes = modelDivA.removeChildren( 2, 2 );
+		modelDivB.insertChildren( 2, removedNodes );
+
+		dispatcher.convertMove(
+			ModelPosition.createFromParentAndOffset( modelDivA, 2 ),
+			ModelRange.createFromParentsAndOffsets( modelDivB, 2, modelDivB, 4 )
+		);
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><div>fo</div><div>xxo<img></img>yy</div></div>' );
+	} );
+} );
+
+describe( 'remove', () => {
+	it( 'should remove items from view accordingly to changes in model', () => {
+		const modelDiv = new ModelElement( 'div', null, [ 'foo', new ModelElement( 'image' ) ] );
+
+		modelRoot.appendChildren( modelDiv );
+		dispatcher.on( 'insert:div', insertElement( new ViewContainerElement( 'div' ) ) );
+		dispatcher.on( 'insert:image', insertElement( new ViewContainerElement( 'img' ) ) );
+		dispatcher.on( 'insert:$text', insertText() );
+		dispatcher.on( 'remove', remove() );
+
+		dispatcher.convertInsert( ModelRange.createFromElement( modelRoot ) );
+
+		const removedNodes = modelDiv.removeChildren( 2, 2 );
+		modelDoc.graveyard.insertChildren( 2, removedNodes );
+
+		dispatcher.convertRemove(
+			ModelPosition.createFromParentAndOffset( modelDiv, 2 ),
+			ModelRange.createFromParentsAndOffsets( modelDoc.graveyard, 0, modelDoc.graveyard, 2 )
+		);
+
+		expect( viewToString( viewRoot ) ).to.equal( '<div><div>fo</div></div>' );
+	} );
+} );

+ 107 - 0
packages/ckeditor5-engine/tests/treecontroller/view-to-model-converters.js

@@ -0,0 +1,107 @@
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* bender-tags: treecontroller */
+
+'use strict';
+
+import ViewConversionDispatcher from '/ckeditor5/engine/treecontroller/viewconversiondispatcher.js';
+import ViewContainerElement from '/ckeditor5/engine/treeview/containerelement.js';
+import ViewDocumentFragment from '/ckeditor5/engine/treeview/documentfragment.js';
+import ViewText from '/ckeditor5/engine/treeview/text.js';
+
+import ModelDocumentFragment from '/ckeditor5/engine/treemodel/documentfragment.js';
+import ModelElement from '/ckeditor5/engine/treemodel/element.js';
+import ModelText from '/ckeditor5/engine/treemodel/text.js';
+
+import { convertToModelFragment, convertText } from '/ckeditor5/engine/treecontroller/view-to-model-converters.js';
+
+let dispatcher;
+
+beforeEach( () => {
+	dispatcher = new ViewConversionDispatcher();
+} );
+
+describe( 'convertText', () => {
+	it( 'should return converter converting ViewText to ModelText', () => {
+		const viewText = new ViewText( 'foobar' );
+
+		dispatcher.on( 'text', convertText() );
+
+		const result = dispatcher.convert( viewText );
+
+		expect( result ).to.be.instanceof( ModelText );
+		expect( result.text ).to.equal( 'foobar' );
+	} );
+
+	it( 'should not convert already consumed texts', () => {
+		const viewText = new ViewText( 'foofuckbafuckr' );
+
+		// Default converter for elements. Returns just converted children. Added with late priority.
+		dispatcher.on( 'text', convertText(), dispatcher, 9999 );
+		// Added with sooner priority. Should make the above converter not fire.
+		dispatcher.on( 'text', ( evt, data, consumable ) => {
+			if ( consumable.consume( data.input ) ) {
+				data.output = new ModelText( data.input.data.replace( /fuck/gi, '****' ) );
+			}
+		} );
+
+		const result = dispatcher.convert( viewText );
+
+		expect( result ).to.be.instanceof( ModelText );
+		expect( result.text ).to.equal( 'foo****ba****r' );
+	} );
+} );
+
+describe( 'convertToModelFragment', () => {
+	it( 'should return converter converting whole ViewDocumentFragment to ModelDocumentFragment', () => {
+		const viewFragment = new ViewDocumentFragment( [
+			new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ),
+			new ViewText( 'bar' )
+		] );
+
+		// To get any meaningful results we have to actually convert something.
+		dispatcher.on( 'text', convertText() );
+		// This way P element won't be converted per-se but will fire converting it's children.
+		dispatcher.on( 'element', convertToModelFragment() );
+		dispatcher.on( 'documentFragment', convertToModelFragment() );
+
+		const result = dispatcher.convert( viewFragment );
+
+		expect( result ).to.be.instanceof( ModelDocumentFragment );
+		expect( result.getChildCount() ).to.equal( 6 );
+		expect( result.getChild( 0 ).character ).to.equal( 'f' );
+		expect( result.getChild( 1 ).character ).to.equal( 'o' );
+		expect( result.getChild( 2 ).character ).to.equal( 'o' );
+		expect( result.getChild( 3 ).character ).to.equal( 'b' );
+		expect( result.getChild( 4 ).character ).to.equal( 'a' );
+		expect( result.getChild( 5 ).character ).to.equal( 'r' );
+	} );
+
+	it( 'should not convert already consumed (converted) changes', () => {
+		const viewP = new ViewContainerElement( 'p', null, new ViewText( 'foo' ) );
+
+		// To get any meaningful results we have to actually convert something.
+		dispatcher.on( 'text', convertText() );
+		// Default converter for elements. Returns just converted children. Added with late priority.
+		dispatcher.on( 'element', convertToModelFragment(), dispatcher, 9999 );
+		// Added with sooner priority. Should make the above converter not fire.
+		dispatcher.on( 'element:p', ( evt, data, consumable, conversionApi ) => {
+			if ( consumable.consume( data.input, { name: true } ) ) {
+				data.output = new ModelElement( 'paragraph' );
+				data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) );
+			}
+		} );
+
+		const result = dispatcher.convert( viewP );
+
+		expect( result ).to.be.instanceof( ModelElement );
+		expect( result.name ).to.equal( 'paragraph' );
+		expect( result.getChildCount() ).to.equal( 3 );
+		expect( result.getChild( 0 ).character ).to.equal( 'f' );
+		expect( result.getChild( 1 ).character ).to.equal( 'o' );
+		expect( result.getChild( 2 ).character ).to.equal( 'o' );
+	} );
+} );