/**
* @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
import Selection from '../../src/view/selection';
import Range from '../../src/view/range';
import Document from '../../src/view/document';
import Element from '../../src/view/element';
import Text from '../../src/view/text';
import Position from '../../src/view/position';
import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
import count from '@ckeditor/ckeditor5-utils/src/count';
import { parse } from '../../src/dev-utils/view';
describe( 'Selection', () => {
let selection;
let el;
let range1, range2, range3;
beforeEach( () => {
selection = new Selection();
el = new Element( 'p' );
range1 = Range.createFromParentsAndOffsets( el, 5, el, 10 );
range2 = Range.createFromParentsAndOffsets( el, 1, el, 2 );
range3 = Range.createFromParentsAndOffsets( el, 12, el, 14 );
} );
describe( 'constructor()', () => {
it( 'should be able to create an empty selection', () => {
const selection = new Selection();
expect( Array.from( selection.getRanges() ) ).to.deep.equal( [] );
} );
it( 'should be able to create a selection from the given ranges', () => {
const ranges = [ range1, range2, range3 ];
const selection = new Selection( ranges );
expect( Array.from( selection.getRanges() ) ).to.deep.equal( ranges );
} );
it( 'should be able to create a selection from the given ranges and isLastBackward flag', () => {
const ranges = [ range1, range2, range3 ];
const selection = new Selection( ranges, true );
expect( selection.isBackward ).to.be.true;
} );
} );
describe( 'anchor', () => {
it( 'should return null if no ranges in selection', () => {
expect( selection.anchor ).to.be.null;
} );
it( 'should return start of single range in selection', () => {
selection.addRange( range1 );
const anchor = selection.anchor;
expect( anchor.isEqual( range1.start ) ).to.be.true;
expect( anchor ).to.not.equal( range1.start );
} );
it( 'should return end of single range in selection when added as backward', () => {
selection.addRange( range1, true );
const anchor = selection.anchor;
expect( anchor.isEqual( range1.end ) ).to.be.true;
expect( anchor ).to.not.equal( range1.end );
} );
it( 'should get anchor from last inserted range', () => {
selection.addRange( range1 );
selection.addRange( range2 );
expect( selection.anchor.isEqual( range2.start ) ).to.be.true;
} );
} );
describe( 'focus', () => {
it( 'should return null if no ranges in selection', () => {
expect( selection.focus ).to.be.null;
} );
it( 'should return end of single range in selection', () => {
selection.addRange( range1 );
const focus = selection.focus;
expect( focus.isEqual( range1.end ) ).to.be.true;
} );
it( 'should return start of single range in selection when added as backward', () => {
selection.addRange( range1, true );
const focus = selection.focus;
expect( focus.isEqual( range1.start ) ).to.be.true;
expect( focus ).to.not.equal( range1.start );
} );
it( 'should get focus from last inserted range', () => {
selection.addRange( range1 );
selection.addRange( range2 );
expect( selection.focus.isEqual( range2.end ) ).to.be.true;
} );
} );
describe( 'setFocus', () => {
it( 'keeps all existing ranges when no modifications needed', () => {
selection.addRange( range1 );
selection.setFocus( selection.focus );
expect( count( selection.getRanges() ) ).to.equal( 1 );
} );
it( 'throws if there are no ranges in selection', () => {
const endPos = Position.createAt( el, 'end' );
expect( () => {
selection.setFocus( endPos );
} ).to.throw( CKEditorError, /view-selection-setFocus-no-ranges/ );
} );
it( 'modifies existing collapsed selection', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
selection.collapse( startPos );
selection.setFocus( endPos );
expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
expect( selection.focus.compareWith( endPos ) ).to.equal( 'same' );
} );
it( 'makes existing collapsed selection a backward selection', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 0 );
selection.collapse( startPos );
selection.setFocus( endPos );
expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
expect( selection.focus.compareWith( endPos ) ).to.equal( 'same' );
expect( selection.isBackward ).to.be.true;
} );
it( 'modifies existing non-collapsed selection', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
const newEndPos = Position.createAt( el, 3 );
selection.addRange( new Range( startPos, endPos ) );
selection.setFocus( newEndPos );
expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
} );
it( 'makes existing non-collapsed selection a backward selection', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
const newEndPos = Position.createAt( el, 0 );
selection.addRange( new Range( startPos, endPos ) );
selection.setFocus( newEndPos );
expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
expect( selection.isBackward ).to.be.true;
} );
it( 'makes existing backward selection a forward selection', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
const newEndPos = Position.createAt( el, 3 );
selection.addRange( new Range( startPos, endPos ), true );
selection.setFocus( newEndPos );
expect( selection.anchor.compareWith( endPos ) ).to.equal( 'same' );
expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
expect( selection.isBackward ).to.be.false;
} );
it( 'modifies existing backward selection', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
const newEndPos = Position.createAt( el, 0 );
selection.addRange( new Range( startPos, endPos ), true );
selection.setFocus( newEndPos );
expect( selection.anchor.compareWith( endPos ) ).to.equal( 'same' );
expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
expect( selection.isBackward ).to.be.true;
} );
it( 'modifies only the last range', () => {
// Offsets are chosen in this way that the order of adding ranges must count, not their document order.
const startPos1 = Position.createAt( el, 4 );
const endPos1 = Position.createAt( el, 5 );
const startPos2 = Position.createAt( el, 1 );
const endPos2 = Position.createAt( el, 2 );
const newEndPos = Position.createAt( el, 0 );
selection.addRange( new Range( startPos1, endPos1 ) );
selection.addRange( new Range( startPos2, endPos2 ) );
selection.setFocus( newEndPos );
const ranges = Array.from( selection.getRanges() );
expect( ranges ).to.have.lengthOf( 2 );
expect( ranges[ 0 ].start.compareWith( startPos1 ) ).to.equal( 'same' );
expect( ranges[ 0 ].end.compareWith( endPos1 ) ).to.equal( 'same' );
expect( selection.anchor.compareWith( startPos2 ) ).to.equal( 'same' );
expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
expect( selection.isBackward ).to.be.true;
} );
it( 'collapses the selection when extending to the anchor', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
selection.addRange( new Range( startPos, endPos ) );
selection.setFocus( startPos );
expect( selection.focus.compareWith( startPos ) ).to.equal( 'same' );
expect( selection.isCollapsed ).to.be.true;
} );
it( 'uses Position.createAt', () => {
const startPos = Position.createAt( el, 1 );
const endPos = Position.createAt( el, 2 );
const newEndPos = Position.createAt( el, 4 );
const spy = sinon.stub( Position, 'createAt', () => newEndPos );
selection.addRange( new Range( startPos, endPos ) );
selection.setFocus( el, 'end' );
expect( spy.calledOnce ).to.be.true;
expect( selection.focus.compareWith( newEndPos ) ).to.equal( 'same' );
Position.createAt.restore();
} );
} );
describe( 'isCollapsed', () => {
it( 'should return true when there is single collapsed range', () => {
const range = Range.createFromParentsAndOffsets( el, 5, el, 5 );
selection.addRange( range );
expect( selection.isCollapsed ).to.be.true;
} );
it( 'should return false when there are multiple ranges', () => {
const range1 = Range.createFromParentsAndOffsets( el, 5, el, 5 );
const range2 = Range.createFromParentsAndOffsets( el, 15, el, 15 );
selection.addRange( range1 );
selection.addRange( range2 );
expect( selection.isCollapsed ).to.be.false;
} );
it( 'should return false when there is not collapsed range', () => {
const range = Range.createFromParentsAndOffsets( el, 15, el, 16 );
selection.addRange( range );
expect( selection.isCollapsed ).to.be.false;
} );
} );
describe( 'rangeCount', () => {
it( 'should return proper range count', () => {
expect( selection.rangeCount ).to.equal( 0 );
selection.addRange( range1 );
expect( selection.rangeCount ).to.equal( 1 );
selection.addRange( range2 );
expect( selection.rangeCount ).to.equal( 2 );
} );
} );
describe( 'isBackward', () => {
it( 'is defined by the last added range', () => {
const range1 = Range.createFromParentsAndOffsets( el, 5, el, 10 );
const range2 = Range.createFromParentsAndOffsets( el, 15, el, 16 );
selection.addRange( range1, true );
expect( selection ).to.have.property( 'isBackward', true );
selection.addRange( range2 );
expect( selection ).to.have.property( 'isBackward', false );
} );
it( 'is false when last range is collapsed', () => {
const range = Range.createFromParentsAndOffsets( el, 5, el, 5 );
selection.addRange( range, true );
expect( selection.isBackward ).to.be.false;
} );
} );
describe( 'addRange', () => {
it( 'should throw an error when range is invalid', () => {
expect( () => {
selection.addRange( { invalid: 'range' } );
} ).to.throw( CKEditorError, 'view-selection-invalid-range: Invalid Range.' );
} );
it( 'should add range to selection ranges', () => {
selection.addRange( range1 );
expect( selection._ranges[ 0 ].isEqual( range1 ) ).to.be.true;
} );
it( 'should fire change event', ( done ) => {
selection.once( 'change', () => {
expect( selection._ranges[ 0 ].isEqual( range1 ) ).to.be.true;
done();
} );
selection.addRange( range1 );
} );
it( 'should throw when range is intersecting with already added range', () => {
const range2 = Range.createFromParentsAndOffsets( el, 7, el, 15 );
selection.addRange( range1 );
expect( () => {
selection.addRange( range2 );
} ).to.throw( CKEditorError, 'view-selection-range-intersects' );
expect( () => {
selection.addRange( range1 );
} ).to.throw( CKEditorError, 'view-selection-range-intersects' );
} );
} );
describe( 'getRanges', () => {
it( 'should return iterator with copies of all ranges', () => {
selection.addRange( range1 );
selection.addRange( range2 );
const iterable = selection.getRanges();
const ranges = Array.from( iterable );
expect( ranges.length ).to.equal( 2 );
expect( ranges[ 0 ].isEqual( range1 ) ).to.be.true;
expect( ranges[ 0 ] ).to.not.equal( range1 );
expect( ranges[ 1 ].isEqual( range2 ) ).to.be.true;
expect( ranges[ 1 ] ).to.not.equal( range2 );
} );
} );
describe( 'getFirstRange', () => {
it( 'should return copy of range with first position', () => {
selection.addRange( range1 );
selection.addRange( range2 );
selection.addRange( range3 );
const range = selection.getFirstRange();
expect( range.isEqual( range2 ) ).to.be.true;
expect( range ).to.not.equal( range2 );
} );
it( 'should return null if no ranges are present', () => {
expect( selection.getFirstRange() ).to.be.null;
} );
} );
describe( 'getLastRange', () => {
it( 'should return copy of range with last position', () => {
selection.addRange( range1 );
selection.addRange( range2 );
selection.addRange( range3 );
const range = selection.getLastRange();
expect( range.isEqual( range3 ) ).to.be.true;
expect( range ).to.not.equal( range3 );
} );
it( 'should return null if no ranges are present', () => {
expect( selection.getLastRange() ).to.be.null;
} );
} );
describe( 'getFirstPosition', () => {
it( 'should return copy of first position', () => {
selection.addRange( range1 );
selection.addRange( range2 );
selection.addRange( range3 );
const position = selection.getFirstPosition();
expect( position.isEqual( range2.start ) ).to.be.true;
expect( position ).to.not.equal( range2.start );
} );
it( 'should return null if no ranges are present', () => {
expect( selection.getFirstPosition() ).to.be.null;
} );
} );
describe( 'getLastPosition', () => {
it( 'should return copy of range with last position', () => {
selection.addRange( range1 );
selection.addRange( range2 );
selection.addRange( range3 );
const position = selection.getLastPosition();
expect( position.isEqual( range3.end ) ).to.be.true;
expect( position ).to.not.equal( range3.end );
} );
it( 'should return null if no ranges are present', () => {
expect( selection.getLastPosition() ).to.be.null;
} );
} );
describe( 'isEqual', () => {
it( 'should return true if selections equal', () => {
selection.addRange( range1 );
selection.addRange( range2 );
const otherSelection = new Selection();
otherSelection.addRange( range1 );
otherSelection.addRange( range2 );
expect( selection.isEqual( otherSelection ) ).to.be.true;
} );
it( 'should return true if backward selections equal', () => {
selection.addRange( range1, true );
const otherSelection = new Selection();
otherSelection.addRange( range1, true );
expect( selection.isEqual( otherSelection ) ).to.be.true;
} );
it( 'should return false if ranges count does not equal', () => {
selection.addRange( range1 );
selection.addRange( range2 );
const otherSelection = new Selection();
otherSelection.addRange( range1 );
expect( selection.isEqual( otherSelection ) ).to.be.false;
} );
it( 'should return false if ranges (other than the last added one) do not equal', () => {
selection.addRange( range1 );
selection.addRange( range3 );
const otherSelection = new Selection();
otherSelection.addRange( range2 );
otherSelection.addRange( range3 );
expect( selection.isEqual( otherSelection ) ).to.be.false;
} );
it( 'should return false if directions do not equal', () => {
selection.addRange( range1 );
const otherSelection = new Selection();
otherSelection.addRange( range1, true );
expect( selection.isEqual( otherSelection ) ).to.be.false;
} );
it( 'should return false if one selection is fake', () => {
const otherSelection = new Selection();
otherSelection.setFake( true );
expect( selection.isEqual( otherSelection ) ).to.be.false;
} );
it( 'should return true if both selection are fake', () => {
const otherSelection = new Selection();
otherSelection.addRange( range1 );
otherSelection.setFake( true );
selection.setFake( true );
selection.addRange( range1 );
expect( selection.isEqual( otherSelection ) ).to.be.true;
} );
it( 'should return false if both selection are fake but have different label', () => {
const otherSelection = new Selection();
otherSelection.addRange( range1 );
otherSelection.setFake( true , { label: 'foo bar baz' } );
selection.setFake( true );
selection.addRange( range1 );
expect( selection.isEqual( otherSelection ) ).to.be.false;
} );
it( 'should return true if both selections are empty', () => {
const otherSelection = new Selection();
expect( selection.isEqual( otherSelection ) ).to.be.true;
} );
} );
describe( 'removeAllRanges', () => {
it( 'should remove all ranges and fire change event', ( done ) => {
selection.addRange( range1 );
selection.addRange( range2 );
selection.once( 'change', () => {
expect( selection.rangeCount ).to.equal( 0 );
done();
} );
selection.removeAllRanges();
} );
it( 'should do nothing when no ranges are present', () => {
const fireSpy = sinon.spy( selection, 'fire' );
selection.removeAllRanges();
fireSpy.restore();
expect( fireSpy.notCalled ).to.be.true;
} );
} );
describe( 'setRanges', () => {
it( 'should throw an error when range is invalid', () => {
expect( () => {
selection.setRanges( [ { invalid: 'range' } ] );
} ).to.throw( CKEditorError, 'view-selection-invalid-range: Invalid Range.' );
} );
it( 'should add ranges and fire change event', ( done ) => {
selection.addRange( range1 );
selection.once( 'change', () => {
expect( selection.rangeCount ).to.equal( 2 );
expect( selection._ranges[ 0 ].isEqual( range2 ) ).to.be.true;
expect( selection._ranges[ 0 ] ).is.not.equal( range2 );
expect( selection._ranges[ 1 ].isEqual( range3 ) ).to.be.true;
expect( selection._ranges[ 1 ] ).is.not.equal( range3 );
done();
} );
selection.setRanges( [ range2, range3 ] );
} );
} );
describe( 'setTo', () => {
it( 'should return true if selections equal', () => {
selection.addRange( range1 );
const otherSelection = new Selection();
otherSelection.addRange( range2 );
otherSelection.addRange( range3, true );
selection.setTo( otherSelection );
expect( selection.rangeCount ).to.equal( 2 );
expect( selection._ranges[ 0 ].isEqual( range2 ) ).to.be.true;
expect( selection._ranges[ 0 ] ).is.not.equal( range2 );
expect( selection._ranges[ 1 ].isEqual( range3 ) ).to.be.true;
expect( selection._ranges[ 1 ] ).is.not.equal( range3 );
expect( selection.anchor.isEqual( range3.end ) ).to.be.true;
} );
it( 'should fire change event', ( done ) => {
selection.on( 'change', () => {
expect( selection.rangeCount ).to.equal( 1 );
expect( selection.getFirstRange().isEqual( range1 ) ).to.be.true;
done();
} );
const otherSelection = new Selection();
otherSelection.addRange( range1 );
selection.setTo( otherSelection );
} );
it( 'should set fake state and label', () => {
const otherSelection = new Selection();
const label = 'foo bar baz';
otherSelection.setFake( true, { label } );
selection.setTo( otherSelection );
expect( selection.isFake ).to.be.true;
expect( selection.fakeSelectionLabel ).to.equal( label );
} );
} );
describe( 'collapse', () => {
beforeEach( () => {
selection.setRanges( [ range1, range2 ] );
} );
it( 'should collapse selection at position', () => {
const position = new Position( el, 4 );
selection.collapse( position );
const range = selection.getFirstRange();
expect( range.start.parent ).to.equal( el );
expect( range.start.offset ).to.equal( 4 );
expect( range.start.isEqual( range.end ) ).to.be.true;
} );
it( 'should collapse selection at node and offset', () => {
const foo = new Text( 'foo' );
const p = new Element( 'p', null, foo );
selection.collapse( foo );
let range = selection.getFirstRange();
expect( range.start.parent ).to.equal( foo );
expect( range.start.offset ).to.equal( 0 );
expect( range.start.isEqual( range.end ) ).to.be.true;
selection.collapse( p, 1 );
range = selection.getFirstRange();
expect( range.start.parent ).to.equal( p );
expect( range.start.offset ).to.equal( 1 );
expect( range.start.isEqual( range.end ) ).to.be.true;
} );
it( 'should collapse selection at node and flag', () => {
const foo = new Text( 'foo' );
const p = new Element( 'p', null, foo );
selection.collapse( foo, 'end' );
let range = selection.getFirstRange();
expect( range.start.parent ).to.equal( foo );
expect( range.start.offset ).to.equal( 3 );
expect( range.start.isEqual( range.end ) ).to.be.true;
selection.collapse( foo, 'before' );
range = selection.getFirstRange();
expect( range.start.parent ).to.equal( p );
expect( range.start.offset ).to.equal( 0 );
expect( range.start.isEqual( range.end ) ).to.be.true;
selection.collapse( foo, 'after' );
range = selection.getFirstRange();
expect( range.start.parent ).to.equal( p );
expect( range.start.offset ).to.equal( 1 );
expect( range.start.isEqual( range.end ) ).to.be.true;
} );
} );
describe( 'collapseToStart', () => {
it( 'should collapse to start position and fire change event', ( done ) => {
selection.setRanges( [ range1, range2, range3 ] );
selection.once( 'change', () => {
expect( selection.rangeCount ).to.equal( 1 );
expect( selection.isCollapsed ).to.be.true;
expect( selection._ranges[ 0 ].start.isEqual( range2.start ) ).to.be.true;
done();
} );
selection.collapseToStart();
} );
it( 'should do nothing if no ranges present', () => {
const fireSpy = sinon.spy( selection, 'fire' );
selection.collapseToStart();
fireSpy.restore();
expect( fireSpy.notCalled ).to.be.true;
} );
} );
describe( 'collapseToEnd', () => {
it( 'should collapse to end position and fire change event', ( done ) => {
selection.setRanges( [ range1, range2, range3 ] );
selection.once( 'change', () => {
expect( selection.rangeCount ).to.equal( 1 );
expect( selection.isCollapsed ).to.be.true;
expect( selection._ranges[ 0 ].end.isEqual( range3.end ) ).to.be.true;
done();
} );
selection.collapseToEnd();
} );
it( 'should do nothing if no ranges present', () => {
const fireSpy = sinon.spy( selection, 'fire' );
selection.collapseToEnd();
fireSpy.restore();
expect( fireSpy.notCalled ).to.be.true;
} );
} );
describe( 'getEditableElement', () => {
it( 'should return null if no ranges in selection', () => {
expect( selection.editableElement ).to.be.null;
} );
it( 'should return null if selection is placed in container that is not EditableElement', () => {
selection.addRange( range1 );
expect( selection.editableElement ).to.be.null;
} );
it( 'should return EditableElement when selection is placed inside', () => {
const viewDocument = new Document();
const selection = viewDocument.selection;
const root = viewDocument.createRoot( 'div' );
const element = new Element( 'p' );
root.appendChildren( element );
selection.addRange( Range.createFromParentsAndOffsets( element, 0, element, 0 ) );
expect( selection.editableElement ).to.equal( root );
viewDocument.destroy();
} );
} );
describe( 'createFromSelection', () => {
it( 'should return a Selection instance with same ranges and direction as given selection', () => {
selection.setRanges( [ range1, range2 ], true );
const snapshot = Selection.createFromSelection( selection );
expect( snapshot.isBackward ).to.equal( selection.isBackward );
const selectionRanges = Array.from( selection.getRanges() );
const snapshotRanges = Array.from( snapshot.getRanges() );
expect( selectionRanges.length ).to.equal( snapshotRanges.length );
for ( let i = 0; i < selectionRanges.length; i++ ) {
expect( selectionRanges[ i ].isEqual( snapshotRanges[ i ] ) ).to.be.true;
}
} );
} );
describe( 'isFake', () => {
it( 'should be false for newly created instance', () => {
expect( selection.isFake ).to.be.false;
} );
} );
describe( 'setFake', () => {
it( 'should allow to set selection to fake', () => {
selection.setFake( true );
expect( selection.isFake ).to.be.true;
} );
it( 'should allow to set fake selection label', () => {
const label = 'foo bar baz';
selection.setFake( true, { label } );
expect( selection.fakeSelectionLabel ).to.equal( label );
} );
it( 'should not set label when set to false', () => {
const label = 'foo bar baz';
selection.setFake( false, { label } );
expect( selection.fakeSelectionLabel ).to.equal( '' );
} );
it( 'should reset label when set to false', () => {
const label = 'foo bar baz';
selection.setFake( true, { label } );
selection.setFake( false );
expect( selection.fakeSelectionLabel ).to.equal( '' );
} );
it( 'should fire change event', ( done ) => {
selection.once( 'change', () => {
expect( selection.isFake ).to.be.true;
expect( selection.fakeSelectionLabel ).to.equal( 'foo bar baz' );
done();
} );
selection.setFake( true, { label: 'foo bar baz' } );
} );
} );
describe( 'getSelectedElement', () => {
it( 'should return selected element', () => {
const { selection, view } = parse( 'foo [bar] baz' );
const b = view.getChild( 1 );
expect( selection.getSelectedElement() ).to.equal( b );
} );
it( 'should return null if there is more than one range', () => {
const { selection } = parse( 'foo [bar] [baz]' );
expect( selection.getSelectedElement() ).to.be.null;
} );
it( 'should return null if there is no selection', () => {
expect( selection.getSelectedElement() ).to.be.null;
} );
it( 'should return null if selection is not over single element #1', () => {
const { selection } = parse( 'foo [bar ba}z' );
expect( selection.getSelectedElement() ).to.be.null;
} );
it( 'should return null if selection is not over single element #2', () => {
const { selection } = parse( 'foo {bar} baz' );
expect( selection.getSelectedElement() ).to.be.null;
} );
} );
} );