/** * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ 'use strict'; import { stringify, parse, getData, setData } from '/tests/engine/_utils/model.js'; import Document from '/ckeditor5/engine/model/document.js'; import DocumentFragment from '/ckeditor5/engine/model/documentfragment.js'; import Element from '/ckeditor5/engine/model/element.js'; import Text from '/ckeditor5/engine/model/text.js'; import Range from '/ckeditor5/engine/model/range.js'; import Position from '/ckeditor5/engine/model/position.js'; describe( 'model test utils', () => { let document, root, selection, sandbox; beforeEach( () => { document = new Document(); root = document.createRoot( 'main', '$root' ); selection = document.selection; sandbox = sinon.sandbox.create(); selection.removeAllRanges(); } ); afterEach( () => { sandbox.restore(); } ); describe( 'getData', () => { it( 'should use stringify method', () => { const stringifySpy = sandbox.spy( getData, '_stringify' ); root.appendChildren( new Element( 'b', null, [ 'btext' ] ) ); expect( getData( document, { withoutSelection: true } ) ).to.equal( 'btext' ); sinon.assert.calledOnce( stringifySpy ); sinon.assert.calledWithExactly( stringifySpy, root ); } ); it( 'should use stringify method with selection', () => { const stringifySpy = sandbox.spy( getData, '_stringify' ); root.appendChildren( new Element( 'b', null, [ 'btext' ] ) ); document.selection.addRange( Range.createFromParentsAndOffsets( root, 0, root, 1 ) ); expect( getData( document ) ).to.equal( 'btext' ); sinon.assert.calledOnce( stringifySpy ); sinon.assert.calledWithExactly( stringifySpy, root, document.selection ); } ); } ); describe( 'setData', () => { it( 'should use parse method', () => { const parseSpy = sandbox.spy( setData, '_parse' ); const options = {}; const data = 'btexttext'; setData( document, data, options ); expect( getData( document, { withoutSelection: true } ) ).to.equal( data ); sinon.assert.calledOnce( parseSpy ); const args = parseSpy.firstCall.args; expect( args[ 0 ] ).to.equal( data ); } ); it( 'should use parse method with selection', () => { const parseSpy = sandbox.spy( setData, '_parse' ); const options = {}; const data = 'btext'; setData( document, data, options ); expect( getData( document ) ).to.equal( data ); sinon.assert.calledOnce( parseSpy ); const args = parseSpy.firstCall.args; expect( args[ 0 ] ).to.equal( data ); } ); } ); describe( 'stringify', () => { it( 'should stringify text', () => { const text = new Text( 'text', { underline: true, bold: true } ); expect( stringify( text ) ).to.equal( '<$text bold=true underline=true>text' ); } ); it( 'should stringify element', () => { const element = new Element( 'a', null, [ new Element( 'b', null, 'btext' ), 'atext' ] ); expect( stringify( element ) ).to.equal( 'btextatext' ); } ); it( 'should stringify document fragment', () => { const fragment = new DocumentFragment( [ new Element( 'b', null, 'btext' ), 'atext' ] ); expect( stringify( fragment ) ).to.equal( 'btextatext' ); } ); it( 'writes elements and texts', () => { root.appendChildren( [ new Element( 'a', null, 'atext' ), new Element( 'b', null, [ new Element( 'c1' ), 'ctext', new Element( 'c2' ) ] ), new Element( 'd' ) ] ); expect( stringify( root ) ).to.equal( 'atextctext' ); } ); it( 'writes element attributes', () => { root.appendChildren( new Element( 'a', { foo: true, bar: 1, car: false }, [ new Element( 'b', { fooBar: 'x y', barFoo: { x: 1, y: 2 } } ) ] ) ); // Note: attributes are written in a very simplistic way, because they are not to be parsed. They are just // to be compared in the tests with some patterns. expect( stringify( root ) ).to.equal( '' ); } ); it( 'writes text attributes', () => { root.appendChildren( [ new Text( 'foo', { bold: true } ), 'bar', new Text( 'bom', { bold: true, italic: true } ), new Element( 'a', null, [ new Text( 'pom', { underline: true, bold: true } ) ] ) ] ); expect( stringify( root ) ).to.equal( '<$text bold=true>foo' + 'bar' + '<$text bold=true italic=true>bom' + '<$text bold=true underline=true>pom' ); } ); describe( 'selection', () => { let elA, elB; beforeEach( () => { elA = new Element( 'a' ); elB = new Element( 'b' ); root.appendChildren( [ elA, 'foo', new Text( 'bar', { bold: true } ), elB ] ); } ); it( 'writes selection in an empty root', () => { const root = document.createRoot( 'empty', '$root' ); selection.collapse( root ); expect( stringify( root, selection ) ).to.equal( '' ); } ); it( 'writes selection collapsed in an element', () => { selection.collapse( root ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes selection collapsed in a text', () => { selection.collapse( root, 3 ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes selection collapsed at the text left boundary', () => { selection.collapse( elA, 'AFTER' ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes selection collapsed at the text right boundary', () => { selection.collapse( elB, 'BEFORE' ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes selection collapsed at the end of the root', () => { selection.collapse( root, 'END' ); // Needed due to https://github.com/ckeditor/ckeditor5-engine/issues/320. selection.clearAttributes(); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes selection attributes', () => { selection.collapse( root ); selection.setAttributesTo( { italic: true, bold: true } ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes selection collapsed selection in a text with attributes', () => { selection.collapse( root, 5 ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes flat selection containing couple of nodes', () => { selection.addRange( Range.createFromParentsAndOffsets( root, 0, root, 4 ) ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes flat selection within text', () => { selection.addRange( Range.createFromParentsAndOffsets( root, 2, root, 3 ) ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes multi-level selection', () => { selection.addRange( Range.createFromParentsAndOffsets( elA, 0, elB, 0 ) ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'writes backward selection', () => { selection.addRange( Range.createFromParentsAndOffsets( elA, 0, elB, 0 ), true ); expect( stringify( root, selection ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'uses range and coverts it to selection', () => { const range = Range.createFromParentsAndOffsets( elA, 0, elB, 0 ); expect( stringify( root, range ) ).to.equal( 'foo<$text bold=true>bar' ); } ); it( 'uses position and converts it to collapsed selection', () => { const position = new Position( root, [ 0 ] ); expect( stringify( root, position ) ).to.equal( 'foo<$text bold=true>bar' ); } ); } ); } ); describe( 'parse', () => { test( 'creates elements', { data: '' } ); test( 'creates text nodes', { data: 'foobarbom' } ); test( 'sets elements attributes', { data: '', output: '', check( root ) { expect( root.getChild( 0 ).getAttribute( 'car' ) ).to.equal( 'x y' ); } } ); test( 'sets complex attributes', { data: '', check( root ) { expect( root.getChild( 0 ).getAttribute( 'foo' ) ).to.have.property( 'a', 1 ); } } ); test( 'sets text attributes', { data: '<$text bold=true italic=true>foo<$text bold=true>barbom', check( root ) { expect( root.getChildCount() ).to.equal( 9 ); expect( root.getChild( 0 ) ).to.have.property( 'character', 'f' ); expect( root.getChild( 0 ).getAttribute( 'italic' ) ).to.equal( true ); } } ); it( 'throws when unexpected closing tag', () => { expect( () => { parse( '' ); } ).to.throw( Error, 'Parse error - unexpected closing tag.' ); } ); it( 'throws when unexpected attribute', () => { expect( () => { parse( '' ); } ).to.throw( Error, 'Parse error - unexpected token: ?.' ); } ); it( 'throws when incorrect tag', () => { expect( () => { parse( ' { expect( () => { parse( '' ); } ).to.throw( Error, 'Parse error - missing closing tags: a.' ); } ); it( 'throws when missing opening tag for text', () => { expect( () => { parse( '' ); } ).to.throw( Error, 'Parse error - unexpected closing tag.' ); } ); it( 'throws when missing closing tag for text', () => { expect( () => { parse( '<$text>' ); } ).to.throw( Error, 'Parse error - missing closing tags: $text.' ); } ); describe( 'selection', () => { test( 'sets collapsed selection in an element', { data: '', check( root, selection ) { expect( selection.getFirstPosition().parent ).to.have.property( 'name', 'a' ); } } ); test( 'sets collapsed selection between elements', { data: '' } ); test( 'sets collapsed selection before a text', { data: 'foo' } ); test( 'sets collapsed selection after a text', { data: 'foo' } ); test( 'sets collapsed selection within a text', { data: 'foobar', check( root ) { expect( root.getChildCount() ).to.equal( 6 ); } } ); test( 'sets selection attributes', { data: 'foobar', check( root, selection ) { expect( selection.getAttribute( 'italic' ) ).to.be.true; } } ); test( 'sets collapsed selection between text and text with attributes', { data: 'foo<$text bold=true>bar', check( root, selection ) { expect( root.getChildCount() ).to.equal( 6 ); expect( selection.getAttribute( 'bold' ) ).to.be.undefined; } } ); test( 'sets selection containing an element', { data: 'x' } ); test( 'sets selection with attribute containing an element', { data: 'x' } ); test( 'sets a backward selection containing an element', { data: 'x' } ); test( 'sets selection within a text', { data: 'xyz' } ); test( 'sets selection within a text with different attributes', { data: '<$text bold=true>foobar' } ); it( 'throws when missing selection start', () => { expect( () => { parse( 'foo' ); } ).to.throw( Error, 'Parse error - missing selection start.' ); } ); it( 'throws when missing selection end', () => { expect( () => { parse( 'foo' ); } ).to.throw( Error, 'Parse error - missing selection end.' ); } ); } ); function test( title, options ) { it( title, () => { const output = options.output || options.data; const data = parse( options.data ); let model, selection; if ( data.selection && data.model ) { model = data.model; selection = data.selection; } else { model = data; } expect( stringify( model, selection ) ).to.equal( output ); if ( options.check ) { options.check( model, selection ); } } ); } } ); } );