| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Model from '../../src/model/model';
- import View from '../../src/view/view';
- import ViewUIElement from '../../src/view/uielement';
- import Mapper from '../../src/conversion/mapper';
- import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
- import {
- convertRangeSelection,
- convertCollapsedSelection,
- clearAttributes,
- } from '../../src/conversion/downcast-selection-converters';
- import DowncastHelpers, { insertText, wrap } from '../../src/conversion/downcasthelpers';
- import createViewRoot from '../view/_utils/createroot';
- import { stringify as stringifyView } from '../../src/dev-utils/view';
- import { setData as setModelData } from '../../src/dev-utils/model';
- describe( 'downcast-selection-converters', () => {
- let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, downcastHelpers;
- beforeEach( () => {
- model = new Model();
- modelDoc = model.document;
- modelRoot = modelDoc.createRoot();
- docSelection = modelDoc.selection;
- model.schema.extend( '$text', { allowIn: '$root' } );
- view = new View();
- viewDoc = view.document;
- viewRoot = createViewRoot( viewDoc );
- viewSelection = viewDoc.selection;
- mapper = new Mapper();
- mapper.bindElements( modelRoot, viewRoot );
- dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
- dispatcher.on( 'insert:$text', insertText() );
- const strongCreator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' );
- dispatcher.on( 'attribute:bold', wrap( strongCreator ) );
- downcastHelpers = new DowncastHelpers( dispatcher );
- downcastHelpers.markerToHighlight( { model: 'marker', view: { classes: 'marker' }, converterPriority: 1 } );
- // Default selection converters.
- dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
- dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
- dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
- } );
- afterEach( () => {
- view.destroy();
- } );
- describe( 'default converters', () => {
- describe( 'range selection', () => {
- it( 'in same container', () => {
- test(
- [ 1, 4 ],
- 'foobar',
- 'f{oob}ar'
- );
- } );
- it( 'in same container with unicode characters', () => {
- test(
- [ 2, 6 ],
- 'நிலைக்கு',
- 'நி{லைக்}கு'
- );
- } );
- it( 'in same container, over attribute', () => {
- test(
- [ 1, 5 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o<strong>ob</strong>a}r'
- );
- } );
- it( 'in same container, next to attribute', () => {
- test(
- [ 1, 2 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o}<strong>ob</strong>ar'
- );
- } );
- it( 'in same attribute', () => {
- test(
- [ 2, 4 ],
- 'f<$text bold="true">ooba</$text>r',
- 'f<strong>o{ob}a</strong>r'
- );
- } );
- it( 'in same attribute, selection same as attribute', () => {
- test(
- [ 2, 4 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'fo{<strong>ob</strong>}ar'
- );
- } );
- it( 'starts in text node, ends in attribute #1', () => {
- test(
- [ 1, 3 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o<strong>o}b</strong>ar'
- );
- } );
- it( 'starts in text node, ends in attribute #2', () => {
- test(
- [ 1, 4 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'f{o<strong>ob</strong>}ar'
- );
- } );
- it( 'starts in attribute, ends in text node', () => {
- test(
- [ 3, 5 ],
- 'fo<$text bold="true">ob</$text>ar',
- 'fo<strong>o{b</strong>a}r'
- );
- } );
- it( 'consumes consumable values properly', () => {
- // Add callback that will fire before default ones.
- // This should prevent default callback doing anything.
- dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
- expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
- }, { priority: 'high' } );
- // Similar test case as the first in this suite.
- test(
- [ 1, 4 ],
- 'foobar',
- 'foobar' // No selection in view.
- );
- } );
- it( 'should convert backward selection', () => {
- test(
- [ 1, 3, 'backward' ],
- 'foobar',
- 'f{oo}bar'
- );
- expect( viewSelection.focus.offset ).to.equal( 1 );
- } );
- } );
- describe( 'collapsed selection', () => {
- let marker;
- it( 'in container', () => {
- test(
- [ 1, 1 ],
- 'foobar',
- 'f{}oobar'
- );
- } );
- it( 'in attribute', () => {
- test(
- [ 3, 3 ],
- 'f<$text bold="true">ooba</$text>r',
- 'f<strong>oo{}ba</strong>r'
- );
- } );
- it( 'in attribute and marker', () => {
- setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
- '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
- );
- } );
- it( 'in attribute and marker - no attribute', () => {
- setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- writer.removeSelectionAttribute( 'bold' );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
- } );
- it( 'in marker - using highlight descriptor creator', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker2',
- view: data => ( { classes: data.markerName } )
- } );
- setModelData( model, 'foobar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker2', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
- } );
- it( 'should do nothing if creator return null', () => {
- downcastHelpers.markerToHighlight( {
- model: 'marker3',
- view: () => null
- } );
- setModelData( model, 'foobar' );
- model.change( writer => {
- const range = writer.createRange( writer.createPositionAt( modelRoot, 1 ), writer.createPositionAt( modelRoot, 5 ) );
- marker = writer.addMarker( 'marker3', { range, usingOperation: false } );
- writer.setSelection( modelRoot, 3 );
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>foo{}bar</div>' );
- } );
- // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
- it( 'selection with attribute before ui element - no non-ui children', () => {
- setModelData( model, '' );
- // Add two ui elements to view.
- viewRoot._appendChild( [
- new ViewUIElement( 'span' ),
- new ViewUIElement( 'span' )
- ] );
- model.change( writer => {
- writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 0 ] ) ) );
- writer.setSelectionAttribute( 'bold', true );
- } );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
- } );
- // #1072.
- it( 'selection with attribute before ui element - has non-ui children #1', () => {
- setModelData( model, 'x' );
- model.change( writer => {
- writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
- writer.setSelectionAttribute( 'bold', true );
- } );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- // Add ui element to view.
- const uiElement = new ViewUIElement( 'span' );
- viewRoot._insertChild( 1, uiElement );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
- } );
- // #1072.
- it( 'selection with attribute before ui element - has non-ui children #2', () => {
- setModelData( model, '<$text bold="true">x</$text>y' );
- model.change( writer => {
- writer.setSelection( writer.createRange( writer.createPositionFromPath( modelRoot, [ 1 ] ) ) );
- writer.setSelectionAttribute( 'bold', true );
- } );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- // Add ui element to view.
- const uiElement = new ViewUIElement( 'span' );
- viewRoot._insertChild( 1, uiElement, writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
- .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
- } );
- it( 'consumes consumable values properly', () => {
- // Add callbacks that will fire before default ones.
- // This should prevent default callbacks doing anything.
- dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
- expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
- }, { priority: 'high' } );
- dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
- expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
- }, { priority: 'high' } );
- // Similar test case as above.
- test(
- [ 3, 3 ],
- 'f<$text bold="true">ooba</$text>r',
- 'foobar' // No selection in view and no attribute.
- );
- } );
- } );
- } );
- describe( 'clean-up', () => {
- describe( 'convertRangeSelection', () => {
- it( 'should remove all ranges before adding new range', () => {
- test(
- [ 0, 2 ],
- 'foobar',
- '{fo}obar'
- );
- test(
- [ 3, 5 ],
- 'foobar',
- 'foo{ba}r'
- );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- } );
- } );
- describe( 'convertCollapsedSelection', () => {
- it( 'should remove all ranges before adding new range', () => {
- test(
- [ 2, 2 ],
- 'foobar',
- 'fo{}obar'
- );
- test(
- [ 3, 3 ],
- 'foobar',
- 'foo{}bar'
- );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- } );
- } );
- describe( 'clearAttributes', () => {
- it( 'should remove all ranges before adding new range', () => {
- test(
- [ 3, 3 ],
- 'foobar',
- 'foo<strong>[]</strong>bar',
- { bold: 'true' }
- );
- view.change( writer => {
- const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
- model.change( writer => {
- writer.setSelection( modelRange );
- } );
- dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
- } );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
- expect( viewString ).to.equal( '<div>f{}oobar</div>' );
- } );
- it( 'should do nothing if the attribute element had been already removed', () => {
- test(
- [ 3, 3 ],
- 'foobar',
- 'foo<strong>[]</strong>bar',
- { bold: 'true' }
- );
- view.change( writer => {
- // Remove <strong></strong> manually.
- writer.mergeAttributes( viewSelection.getFirstPosition() );
- const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
- model.change( writer => {
- writer.setSelection( modelRange );
- } );
- dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
- } );
- expect( viewSelection.rangeCount ).to.equal( 1 );
- const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
- expect( viewString ).to.equal( '<div>f{}oobar</div>' );
- } );
- it( 'should clear fake selection', () => {
- const modelRange = model.createRange( model.createPositionAt( modelRoot, 1 ), model.createPositionAt( modelRoot, 1 ) );
- view.change( writer => {
- writer.setSelection( modelRange, { fake: true } );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- expect( viewSelection.isFake ).to.be.false;
- } );
- } );
- } );
- describe( 'table cell selection converter', () => {
- beforeEach( () => {
- model.schema.register( 'table', { isLimit: true } );
- model.schema.register( 'tr', { isLimit: true } );
- model.schema.register( 'td', { isLimit: true } );
- model.schema.extend( 'table', { allowIn: '$root' } );
- model.schema.extend( 'tr', { allowIn: 'table' } );
- model.schema.extend( 'td', { allowIn: 'tr' } );
- model.schema.extend( '$text', { allowIn: 'td' } );
- const downcastHelpers = new DowncastHelpers( dispatcher );
- // "Universal" converter to convert table structure.
- downcastHelpers.elementToElement( { model: 'table', view: 'table' } );
- downcastHelpers.elementToElement( { model: 'tr', view: 'tr' } );
- downcastHelpers.elementToElement( { model: 'td', view: 'td' } );
- // Special converter for table cells.
- dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
- const selection = data.selection;
- if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
- return;
- }
- for ( const range of selection.getRanges() ) {
- const node = range.start.parent;
- if ( !!node && node.is( 'td' ) ) {
- conversionApi.consumable.consume( selection, 'selection' );
- const viewNode = conversionApi.mapper.toViewElement( node );
- conversionApi.writer.addClass( 'selected', viewNode );
- }
- }
- }, { priority: 'high' } );
- } );
- it( 'should not be used to convert selection that is not on table cell', () => {
- test(
- [ 1, 5 ],
- 'f{o<$text bold="true">ob</$text>a}r',
- 'f{o<strong>ob</strong>a}r'
- );
- } );
- it( 'should add a class to the selected table cell', () => {
- test(
- // table tr#0 td#0 [foo, table tr#0 td#0 bar]
- [ [ 0, 0, 0, 0 ], [ 0, 0, 0, 3 ] ],
- '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
- '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
- );
- } );
- it( 'should not be used if selection contains more than just a table cell', () => {
- test(
- // table tr td#1 f{oo bar, table tr#2 bar]
- [ [ 0, 0, 0, 1 ], [ 0, 0, 1, 3 ] ],
- '<table><tr><td>foo</td><td>bar</td></tr></table>',
- '[<table><tr><td>foo</td><td>bar</td></tr></table>]'
- );
- } );
- } );
- // Tests if the selection got correctly converted.
- // Because `setData` might use selection converters itself to set the selection, we can't use it
- // to set the selection (because then we would test converters using converters).
- // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
- // that are offsets or paths of selection positions in root element.
- function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
- // Parse passed `modelInput` string and set it as current model.
- setModelData( model, modelInput );
- // Manually set selection ranges using passed `selectionPaths`.
- const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
- const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
- const startPos = model.createPositionFromPath( modelRoot, startPath );
- const endPos = model.createPositionFromPath( modelRoot, endPath );
- const isBackward = selectionPaths[ 2 ] === 'backward';
- model.change( writer => {
- writer.setSelection( writer.createRange( startPos, endPos ), { backward: isBackward } );
- // And add or remove passed attributes.
- for ( const key in selectionAttributes ) {
- const value = selectionAttributes[ key ];
- if ( value ) {
- writer.setSelectionAttribute( key, value );
- } else {
- writer.removeSelectionAttribute( key );
- }
- }
- } );
- // Remove view children manually (without firing additional conversion).
- viewRoot._removeChildren( 0, viewRoot.childCount );
- // Convert model to view.
- view.change( writer => {
- dispatcher.convertInsert( model.createRangeIn( modelRoot ), writer );
- dispatcher.convertSelection( docSelection, model.markers, writer );
- } );
- // Stringify view and check if it is same as expected.
- expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
- }
- } );
|