/** * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ /* globals document */ import ViewElement from '../../../src/view/element'; import ViewRange from '../../../src/view/range'; import ViewSelection from '../../../src/view/selection'; import DomConverter from '../../../src/view/domconverter'; import ViewDocumentFragment from '../../../src/view/documentfragment'; import { INLINE_FILLER, INLINE_FILLER_LENGTH, NBSP_FILLER } from '../../../src/view/filler'; import { parse, stringify } from '../../../src/dev-utils/view'; import count from '@ckeditor/ckeditor5-utils/src/count'; import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; describe( 'DomConverter', () => { let converter; before( () => { converter = new DomConverter(); } ); describe( 'domToView', () => { it( 'should create tree of view elements from DOM elements', () => { const domImg = createElement( document, 'img' ); const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] ); const viewImg = new ViewElement( 'img' ); converter.bindElements( domImg, viewImg ); const viewP = converter.domToView( domP ); expect( viewP ).to.be.an.instanceof( ViewElement ); expect( viewP.name ).to.equal( 'p' ); expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' ); expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 ); expect( viewP.childCount ).to.equal( 2 ); expect( viewP.getChild( 0 ).name ).to.equal( 'img' ); expect( viewP.getChild( 1 ).data ).to.equal( 'foo' ); expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP ); expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domImg ); } ); it( 'should create tree of view elements from DOM elements and bind elements', () => { const domImg = createElement( document, 'img' ); const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] ); const viewP = converter.domToView( domP, { bind: true } ); expect( viewP ).to.be.an.instanceof( ViewElement ); expect( viewP.name ).to.equal( 'p' ); expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' ); expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 ); expect( viewP.childCount ).to.equal( 2 ); expect( viewP.getChild( 0 ).name ).to.equal( 'img' ); expect( viewP.getChild( 1 ).data ).to.equal( 'foo' ); expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP ); expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] ); } ); it( 'should support unicode', () => { const domText = document.createTextNode( 'நிலைக்கு' ); const domP = createElement( document, 'p', { 'class': 'foo' }, [ domText ] ); const viewP = converter.domToView( domP, { bind: true } ); expect( viewP.childCount ).to.equal( 1 ); const viewText = viewP.getChild( 0 ); expect( viewText.data ).to.equal( 'நிலைக்கு' ); expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP ); expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] ); } ); it( 'should create tree of view elements from DOM element without children', () => { const domImg = createElement( document, 'img' ); const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] ); const viewImg = new ViewElement( 'img' ); converter.bindElements( domImg, viewImg ); const viewP = converter.domToView( domP, { withChildren: false } ); expect( viewP ).to.be.an.instanceof( ViewElement ); expect( viewP.name ).to.equal( 'p' ); expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' ); expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 ); expect( viewP.childCount ).to.equal( 0 ); expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP ); } ); it( 'should create view document fragment from DOM document fragment', () => { const domImg = createElement( document, 'img' ); const domText = document.createTextNode( 'foo' ); const domFragment = document.createDocumentFragment(); domFragment.appendChild( domImg ); domFragment.appendChild( domText ); const viewFragment = converter.domToView( domFragment, { bind: true } ); expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment ); expect( viewFragment.childCount ).to.equal( 2 ); expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' ); expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' ); expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment ); expect( converter.getCorrespondingDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] ); } ); it( 'should create view document fragment from DOM document fragment without children', () => { const domImg = createElement( document, 'img' ); const domText = document.createTextNode( 'foo' ); const domFragment = document.createDocumentFragment(); domFragment.appendChild( domImg ); domFragment.appendChild( domText ); const viewImg = new ViewElement( 'img' ); converter.bindElements( domImg, viewImg ); const viewFragment = converter.domToView( domFragment, { withChildren: false } ); expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment ); expect( viewFragment.childCount ).to.equal( 0 ); expect( converter.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment ); } ); it( 'should return already bind document fragment', () => { const domFragment = document.createDocumentFragment(); const viewFragment = new ViewDocumentFragment(); converter.bindDocumentFragments( domFragment, viewFragment ); const viewFragment2 = converter.domToView( domFragment ); expect( viewFragment2 ).to.equal( viewFragment ); } ); it( 'should return null for block filler', () => { const domFiller = converter.blockFiller( document ); expect( converter.domToView( domFiller ) ).to.be.null; } ); it( 'should return null for empty text node', () => { const textNode = document.createTextNode( '' ); expect( converter.domToView( textNode ) ).to.be.null; } ); describe( 'it should clear whitespaces', () => { it( 'at the beginning of block element', () => { const domDiv = createElement( document, 'div', {}, [ document.createTextNode( ' ' ), createElement( document, 'p', {}, [ document.createTextNode( ' foo' ) ] ), createElement( document, 'p', {}, [ document.createTextNode( ' foo' ) ] ) ] ); const viewDiv = converter.domToView( domDiv ); expect( viewDiv.childCount ).to.equal( 2 ); expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' ); expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' ); } ); it( 'at the end of block element', () => { const domDiv = createElement( document, 'div', {}, [ createElement( document, 'p', {}, [ document.createTextNode( 'foo ' ) ] ), createElement( document, 'p', {}, [ document.createTextNode( 'foo ' ) ] ), document.createTextNode( ' ' ) ] ); const viewDiv = converter.domToView( domDiv ); expect( viewDiv.childCount ).to.equal( 2 ); expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' ); expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'foo' ); } ); it( 'multiple consecutive whitespaces changed to one', () => { const domDiv = createElement( document, 'div', {}, [ createElement( document, 'p', {}, [ document.createTextNode( ' f o o' ) ] ), createElement( document, 'p', {}, [ document.createTextNode( 'fo o ' ) ] ) ] ); const viewDiv = converter.domToView( domDiv ); expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( 'f o o' ); expect( viewDiv.getChild( 1 ).getChild( 0 ).data ).to.equal( 'fo o' ); } ); function test( inputTexts, output ) { if ( typeof inputTexts == 'string' ) { inputTexts = [ inputTexts ]; } it( 'spaces in a text node: ' + inputTexts.join( '|' ) + ' -> ' + output, () => { const domElement = createElement( document, 'div', {}, [] ); for ( let text of inputTexts ) { domElement.appendChild( document.createTextNode( text.replace( /_/g, '\u00A0' ) ) ); } const viewElement = converter.domToView( domElement ); let data = ''; for ( let child of viewElement.getChildren() ) { data += child.data.replace( /\u00A0/g, '_' ); } expect( data ).to.equal( output ); } ); } // At the beginning. test( '_x', ' x' ); test( '_ x', ' x' ); test( '_ _x', ' x' ); test( '_ _ x', ' x' ); // At the end. test( 'x_', 'x ' ); test( 'x _', 'x ' ); test( 'x_ _', 'x ' ); test( 'x _ _', 'x ' ); // In the middle. test( 'x x', 'x x' ); test( 'x _x', 'x x' ); test( 'x _ x', 'x x' ); test( 'x _ _x', 'x x' ); // Complex. test( '_x_', ' x ' ); test( '_ x _x _', ' x x ' ); test( '_ _x x _', ' x x ' ); test( '_ _x x_ _', ' x x ' ); test( '_ _x _ _x_', ' x x ' ); test( '_', ' ' ); // With hard   test( '_x', ' x' ); test( '__x', ' _x' ); test( '___x', ' __x' ); test( '__ x', ' _ x' ); test( 'x_', 'x ' ); test( 'x__', 'x_ ' ); test( 'x___', 'x__ ' ); // This is an edge case, but it's impossible to write elegant and compact algorithm that is also // 100% correct. We might assume that expected result is `x _` but it will be converted to `x ` // by the algorithm. This is acceptable, though. test( 'x __', 'x ' ); test( 'x_x', 'x_x' ); test( 'x___x', 'x___x' ); test( 'x____x', 'x____x' ); test( 'x__ x', 'x__ x' ); test( 'x___ x', 'x___ x' ); test( 'x_ _x', 'x_ x' ); test( 'x __x', 'x _x' ); test( 'x _ x', 'x x' ); test( 'x __ _x', 'x _ x' ); // Two text nodes. test( [ 'x', 'y' ], 'xy' ); test( [ 'x ', 'y' ], 'x y' ); test( [ 'x _', 'y' ], 'x y' ); test( [ 'x _ ', 'y' ], 'x y' ); test( [ 'x _ _', 'y' ], 'x y' ); test( [ 'x', ' y' ], 'x y' ); test( [ 'x ', '_y' ], 'x y' ); test( [ 'x_ ', '_y' ], 'x y' ); test( [ 'x _ ', '_y' ], 'x y' ); test( [ 'x_ _ ', '_y' ], 'x y' ); test( [ 'x', ' _y' ], 'x y' ); test( [ 'x ', '_ y' ], 'x y' ); test( [ 'x_ ', '_ y' ], 'x y' ); test( [ 'x _ ', '_ y' ], 'x y' ); test( [ 'x_ _ ', '_ y' ], 'x y' ); // Some tests with hard   test( [ 'x', '_y' ], 'x_y' ); test( [ 'x_', 'y' ], 'x_y' ); test( [ 'x_', ' y' ], 'x_ y' ); test( [ 'x__', ' y' ], 'x__ y' ); test( [ 'x_ _', ' y' ], 'x_ y' ); it( 'not in preformatted blocks', () => { const domDiv = createElement( document, 'div', {}, [ createElement( document, 'pre', {}, [ document.createTextNode( ' foo\n foo ' ) ] ) ] ); const viewDiv = converter.domToView( domDiv ); expect( viewDiv.getChild( 0 ).getChild( 0 ).data ).to.equal( ' foo\n foo ' ); } ); } ); } ); describe( 'domChildrenToView', () => { it( 'should convert children', () => { const domImg = createElement( document, 'img' ); const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', null, [ domImg, domText ] ); const viewChildren = Array.from( converter.domChildrenToView( domP ) ); expect( viewChildren.length ).to.equal( 2 ); expect( stringify( viewChildren[ 0 ] ) ).to.equal( '' ); expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' ); } ); it( 'should skip filler', () => { const domFiller = converter.blockFiller( document ); const domP = createElement( document, 'p', null, domFiller ); const viewChildren = Array.from( converter.domChildrenToView( domP ) ); expect( viewChildren.length ).to.equal( 0 ); } ); it( 'should pass options', () => { const domText = document.createTextNode( 'foo' ); const domB = createElement( document, 'b', null, 'bar' ); const domP = createElement( document, 'p', null, [ domB, domText ] ); const viewChildren = Array.from( converter.domChildrenToView( domP, { withChildren: false } ) ); expect( viewChildren.length ).to.equal( 2 ); expect( stringify( viewChildren[ 0 ] ) ).to.equal( '' ); expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' ); } ); } ); describe( 'domPositionToView', () => { it( 'should converter position in text', () => { const domText = document.createTextNode( 'foo' ); const domB = createElement( document, 'b', null, 'bar' ); const domP = createElement( document, 'p', null, [ domText, domB ] ); const viewP = parse( '

foobar

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 0 ) ); const viewPosition = converter.domPositionToView( domText, 2 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

fo{}obar

' ); } ); it( 'should support unicode', () => { const domText = document.createTextNode( 'நிலைக்கு' ); const domP = createElement( document, 'p', null, [ domText ] ); const viewP = parse( '

நிலைக்கு

' ); converter.bindElements( domP, viewP ); const viewPosition = converter.domPositionToView( domText, 4 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

நிலை{}க்கு

' ); } ); it( 'should converter position in element', () => { const domText = document.createTextNode( 'foo' ); const domB = createElement( document, 'b', null, 'bar' ); const domP = createElement( document, 'p', null, [ domText, domB ] ); const viewP = parse( '

foobar

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 0 ) ); const viewPosition = converter.domPositionToView( domP, 1 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

foo[]bar

' ); } ); it( 'should converter position at the beginning', () => { const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', null, domText ); const viewP = parse( '

foo

' ); converter.bindElements( domP, viewP ); const viewPosition = converter.domPositionToView( domP, 0 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

[]foo

' ); } ); it( 'should converter position inside block filler', () => { const converter = new DomConverter( { blockFiller: NBSP_FILLER } ); const domFiller = NBSP_FILLER( document ); const domP = createElement( document, 'p', null, domFiller ); const viewP = parse( '

' ); converter.bindElements( domP, viewP ); const viewPosition = converter.domPositionToView( domFiller, 0 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

[]

' ); } ); it( 'should converter position inside inline filler', () => { const domFiller = document.createTextNode( INLINE_FILLER ); const domText = document.createTextNode( 'foo' ); const domB = createElement( document, 'b', null, domFiller ); const domP = createElement( document, 'p', null, [ domText, domB ] ); const viewP = parse( '

foo

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 1 ) ); const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH ); expect( stringify( viewP, viewPosition ) ).to.equal( '

foo[]

' ); } ); it( 'should converter position inside inline filler with text', () => { const domFiller = document.createTextNode( INLINE_FILLER + 'bar' ); const domText = document.createTextNode( 'foo' ); const domB = createElement( document, 'b', null, domFiller ); const domP = createElement( document, 'p', null, [ domText, domB ] ); const viewP = parse( '

foobar

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 1 ) ); const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH + 2 ); expect( viewPosition.offset ).to.equal( 2 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

fooba{}r

' ); } ); it( 'should converter position inside inline filler with text at the beginning', () => { const domFiller = document.createTextNode( INLINE_FILLER + 'bar' ); const domText = document.createTextNode( 'foo' ); const domB = createElement( document, 'b', null, domFiller ); const domP = createElement( document, 'p', null, [ domText, domB ] ); const viewP = parse( '

foobar

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 1 ) ); const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH - 1 ); expect( viewPosition.offset ).to.equal( 0 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

foo{}bar

' ); } ); it( 'should converter position at the end', () => { const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', null, domText ); const viewP = parse( '

foo

' ); converter.bindElements( domP, viewP ); const viewPosition = converter.domPositionToView( domP, 1 ); expect( stringify( viewP, viewPosition ) ).to.equal( '

foo[]

' ); } ); it( 'should return null if there is no corresponding parent node', () => { const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', null, domText ); const viewPosition = converter.domPositionToView( domP, 0 ); expect( viewPosition ).to.be.null; } ); it( 'should return null if there is no corresponding sibling node', () => { const domB = createElement( document, 'b', null, 'bar' ); const domText = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', null, [ domB, domText ] ); const viewPosition = converter.domPositionToView( domP, 1 ); expect( viewPosition ).to.be.null; } ); it( 'should return null if there is no corresponding text node', () => { const domText = document.createTextNode( 'foo' ); const viewPosition = converter.domPositionToView( domText, 1 ); expect( viewPosition ).to.be.null; } ); } ); describe( 'domRangeToView', () => { it( 'should converter DOM range', () => { const domFoo = document.createTextNode( 'foo' ); const domBar = document.createTextNode( 'bar' ); const domB = createElement( document, 'b', null, domBar ); const domP = createElement( document, 'p', null, [ domFoo, domB ] ); const viewP = parse( '

foobar

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 1 ) ); const domRange = document.createRange(); domRange.setStart( domFoo, 1 ); domRange.setEnd( domBar, 2 ); const viewRange = converter.domRangeToView( domRange ); expect( stringify( viewP, viewRange ) ).to.equal( '

f{ooba}r

' ); } ); it( 'should return null if start or end is null', () => { const domFoo = document.createTextNode( 'foo' ); const domBar = document.createTextNode( 'bar' ); const domB = createElement( document, 'b', null, domBar ); createElement( document, 'p', null, [ domFoo, domB ] ); const domRange = document.createRange(); domRange.setStart( domFoo, 1 ); domRange.setEnd( domBar, 2 ); const viewRange = converter.domRangeToView( domRange ); expect( viewRange ).to.be.null; } ); } ); describe( 'domSelectionToView', () => { it( 'should convert selection', () => { const domFoo = document.createTextNode( 'foo' ); const domBar = document.createTextNode( 'bar' ); const domB = createElement( document, 'b', null, domBar ); const domP = createElement( document, 'p', null, [ domFoo, domB ] ); const viewP = parse( '

foobar

' ); converter.bindElements( domP, viewP ); converter.bindElements( domB, viewP.getChild( 1 ) ); document.body.appendChild( domP ); const domRange = document.createRange(); domRange.setStart( domFoo, 1 ); domRange.setEnd( domBar, 2 ); const domSelection = document.getSelection(); domSelection.removeAllRanges(); domSelection.addRange( domRange ); const viewSelection = converter.domSelectionToView( domSelection ); expect( viewSelection.rangeCount ).to.equal( 1 ); expect( stringify( viewP, viewSelection.getFirstRange() ) ).to.equal( '

f{ooba}r

' ); } ); it( 'should convert empty selection to empty selection', () => { const domSelection = document.getSelection(); domSelection.removeAllRanges(); const viewSelection = converter.domSelectionToView( domSelection ); expect( viewSelection.rangeCount ).to.equal( 0 ); } ); it( 'should handle selection direction', () => { const domFoo = document.createTextNode( 'foo' ); const domP = createElement( document, 'p', null, [ domFoo ] ); const viewP = parse( '

foo

' ); converter.bindElements( domP, viewP ); document.body.appendChild( domP ); const domRange = document.createRange(); domRange.setStart( domFoo, 2 ); domRange.collapse( true ); const domSelection = document.getSelection(); domSelection.removeAllRanges(); domSelection.addRange( domRange ); domSelection.extend( domFoo, 1 ); const viewSelection = converter.domSelectionToView( domSelection ); expect( viewSelection.rangeCount ).to.equal( 1 ); expect( viewSelection.anchor.offset ).to.equal( 2 ); expect( viewSelection.focus.offset ).to.equal( 1 ); expect( viewSelection.isBackward ).to.be.true; } ); it( 'should not add null ranges', () => { const domFoo = document.createTextNode( 'foo' ); const domBar = document.createTextNode( 'bar' ); const domB = createElement( document, 'b', null, domBar ); const domP = createElement( document, 'p', null, [ domFoo, domB ] ); document.body.appendChild( domP ); const domRange = document.createRange(); domRange.setStart( domFoo, 1 ); domRange.setEnd( domBar, 2 ); const domSelection = document.getSelection(); domSelection.removeAllRanges(); domSelection.addRange( domRange ); const viewSelection = converter.domSelectionToView( domSelection ); expect( viewSelection.rangeCount ).to.equal( 0 ); } ); it( 'should return fake selection', () => { const domContainer = document.createElement( 'div' ); const domSelection = document.getSelection(); domContainer.innerHTML = 'fake selection container'; document.body.appendChild( domContainer ); const viewSelection = new ViewSelection(); viewSelection.addRange( ViewRange.createIn( new ViewElement() ) ); converter.bindFakeSelection( domContainer, viewSelection ); const domRange = document.createRange(); domRange.selectNodeContents( domContainer ); domSelection.removeAllRanges(); domSelection.addRange( domRange ); const bindViewSelection = converter.domSelectionToView( domSelection ); expect( bindViewSelection.isEqual( viewSelection ) ).to.be.true; } ); it( 'should return fake selection if selection is placed inside text node', () => { const domContainer = document.createElement( 'div' ); const domSelection = document.getSelection(); domContainer.innerHTML = 'fake selection container'; document.body.appendChild( domContainer ); const viewSelection = new ViewSelection(); viewSelection.addRange( ViewRange.createIn( new ViewElement() ) ); converter.bindFakeSelection( domContainer, viewSelection ); const domRange = document.createRange(); domRange.selectNodeContents( domContainer.firstChild ); domSelection.removeAllRanges(); domSelection.addRange( domRange ); const bindViewSelection = converter.domSelectionToView( domSelection ); expect( bindViewSelection.isEqual( viewSelection ) ).to.be.true; } ); } ); } );