| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* globals console */
- import Model from '../../src/model/model';
- import Batch from '../../src/model/batch';
- import Element from '../../src/model/element';
- import Text from '../../src/model/text';
- import Range from '../../src/model/range';
- import Position from '../../src/model/position';
- import LiveRange from '../../src/model/liverange';
- import DocumentSelection from '../../src/model/documentselection';
- import InsertOperation from '../../src/model/operation/insertoperation';
- import MoveOperation from '../../src/model/operation/moveoperation';
- import AttributeOperation from '../../src/model/operation/attributeoperation';
- import SplitOperation from '../../src/model/operation/splitoperation';
- import Collection from '@ckeditor/ckeditor5-utils/src/collection';
- import count from '@ckeditor/ckeditor5-utils/src/count';
- import { setData, getData } from '../../src/dev-utils/model';
- import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- describe( 'DocumentSelection', () => {
- let model, doc, root, selection, liveRange, range;
- const fooStoreAttrKey = DocumentSelection._getStoreAttributeKey( 'foo' );
- const abcStoreAttrKey = DocumentSelection._getStoreAttributeKey( 'abc' );
- beforeEach( () => {
- model = new Model();
- doc = model.document;
- root = doc.createRoot();
- root._appendChild( [
- new Element( 'p' ),
- new Element( 'p' ),
- new Element( 'p', [], new Text( 'foobar' ) ),
- new Element( 'p' ),
- new Element( 'p' ),
- new Element( 'p' ),
- new Element( 'p', [], new Text( 'foobar' ) )
- ] );
- selection = doc.selection;
- model.schema.register( 'p', { inheritAllFrom: '$block' } );
- model.schema.register( 'widget', {
- isObject: true
- } );
- liveRange = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) );
- range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 2, 2 ] ) );
- } );
- afterEach( () => {
- sinon.restore();
- model.destroy();
- liveRange.detach();
- } );
- describe( 'default range', () => {
- it( 'should go to the first editable element', () => {
- const ranges = Array.from( selection.getRanges() );
- expect( ranges.length ).to.equal( 1 );
- expect( selection.anchor.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
- expect( selection.focus.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
- expect( selection ).to.have.property( 'isBackward', false );
- } );
- it( 'should be set to the beginning of the doc if there is no editable element', () => {
- model = new Model();
- doc = model.document;
- root = doc.createRoot();
- root._insertChild( 0, new Text( 'foobar' ) );
- selection = doc.selection;
- const ranges = Array.from( selection.getRanges() );
- expect( ranges.length ).to.equal( 1 );
- expect( selection.anchor.isEqual( new Position( root, [ 0 ] ) ) ).to.be.true;
- expect( selection.focus.isEqual( new Position( root, [ 0 ] ) ) ).to.be.true;
- expect( selection ).to.have.property( 'isBackward', false );
- expect( count( selection.getAttributes() ) ).to.equal( 0 );
- } );
- it( 'should skip element when you can not put selection', () => {
- model = new Model();
- doc = model.document;
- root = doc.createRoot();
- root._insertChild( 0, [
- new Element( 'img' ),
- new Element( 'p', [], new Text( 'foobar' ) )
- ] );
- model.schema.register( 'img' );
- model.schema.register( 'p', { inheritAllFrom: '$block' } );
- selection = doc.selection;
- const ranges = Array.from( selection.getRanges() );
- expect( ranges.length ).to.equal( 1 );
- expect( selection.anchor.isEqual( new Position( root, [ 1, 0 ] ) ) ).to.be.true;
- expect( selection.focus.isEqual( new Position( root, [ 1, 0 ] ) ) ).to.be.true;
- expect( selection ).to.have.property( 'isBackward', false );
- expect( count( selection.getAttributes() ) ).to.equal( 0 );
- } );
- } );
- describe( 'isCollapsed', () => {
- it( 'should be true for the default range (in text position)', () => {
- expect( selection.isCollapsed ).to.be.true;
- } );
- it( 'should be false for the default range (object selection) ', () => {
- root._insertChild( 0, new Element( 'widget' ) );
- expect( selection.isCollapsed ).to.be.false;
- } );
- it( 'should back off to the default algorithm if selection has ranges', () => {
- selection._setTo( range );
- expect( selection.isCollapsed ).to.be.false;
- } );
- } );
- describe( 'anchor', () => {
- it( 'should equal the default range\'s start (in text position)', () => {
- const expectedPos = new Position( root, [ 0, 0 ] );
- expect( selection.anchor.isEqual( expectedPos ) ).to.be.true;
- } );
- it( 'should equal the default range\'s start (object selection)', () => {
- root._insertChild( 0, new Element( 'widget' ) );
- const expectedPos = new Position( root, [ 0 ] );
- expect( selection.anchor.isEqual( expectedPos ) ).to.be.true;
- } );
- it( 'should back off to the default algorithm if selection has ranges', () => {
- selection._setTo( range );
- expect( selection.anchor.isEqual( range.start ) ).to.be.true;
- } );
- } );
- describe( 'focus', () => {
- it( 'should equal the default range\'s end (in text position)', () => {
- const expectedPos = new Position( root, [ 0, 0 ] );
- expect( selection.focus.isEqual( expectedPos ) ).to.be.true;
- } );
- it( 'should equal the default range\'s end (object selection)', () => {
- root._insertChild( 0, new Element( 'widget' ) );
- const expectedPos = new Position( root, [ 1 ] );
- expect( selection.focus.isEqual( expectedPos ) ).to.be.true;
- expect( selection.focus.isEqual( selection.getFirstRange().end ) ).to.be.true;
- } );
- it( 'should back off to the default algorithm if selection has ranges', () => {
- selection._setTo( range );
- expect( selection.focus.isEqual( range.end ) ).to.be.true;
- } );
- } );
- describe( 'rangeCount', () => {
- it( 'should return proper range count', () => {
- expect( selection.rangeCount ).to.equal( 1 );
- selection._setTo( new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) );
- expect( selection.rangeCount ).to.equal( 1 );
- selection._setTo( [
- new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ),
- new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) )
- ] );
- expect( selection.rangeCount ).to.equal( 2 );
- } );
- } );
- describe( 'hasOwnRange', () => {
- it( 'should return true if selection has any ranges set', () => {
- selection._setTo( new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) );
- expect( selection.hasOwnRange ).to.be.true;
- } );
- it( 'should return false if selection has a default range', () => {
- expect( selection.hasOwnRange ).to.be.false;
- } );
- } );
- describe( 'markers', () => {
- it( 'should implement #markers collection', () => {
- expect( selection.markers ).to.instanceof( Collection );
- expect( selection.markers ).to.length( 0 );
- } );
- it( 'should add markers to the collection when selection is inside the marker range', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 2 ] ),
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ) );
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 0, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 2 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-2', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 2 ] ),
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-3', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 5 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-4', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 4 ] ),
- writer.createPositionFromPath( root, [ 3, 0 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ) ).to.have.members( [ 'marker-2', 'marker-3' ] );
- } );
- it( 'should update markers after selection change', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 2 ] )
- ) );
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 6 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-2', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 3 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-3', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 3 ] ),
- writer.createPositionFromPath( root, [ 2, 6 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ) ).to.have.members( [ 'marker-1', 'marker-2' ] );
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 4 ] ),
- writer.createPositionFromPath( root, [ 2, 5 ] )
- ) );
- } );
- expect( selection.markers.map( marker => marker.name ) ).to.have.members( [ 'marker-1', 'marker-3' ] );
- } );
- it( 'should update markers after markers change', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 2 ] )
- ) );
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 6 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-2', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 3 ] )
- ),
- usingOperation: false
- } );
- writer.addMarker( 'marker-3', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 3 ] ),
- writer.createPositionFromPath( root, [ 2, 6 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ), 1 ).to.have.members( [ 'marker-1', 'marker-2' ] );
- model.change( writer => {
- writer.removeMarker( 'marker-1' );
- writer.updateMarker( 'marker-2', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 3 ] ),
- writer.createPositionFromPath( root, [ 2, 6 ] )
- ),
- usingOperation: false
- } );
- writer.updateMarker( 'marker-3', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 3 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ), 2 ).to.have.members( [ 'marker-3' ] );
- } );
- it( 'should not add marker when collapsed selection is on the marker left bound', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 2 ] ),
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ) );
- writer.addMarker( 'marker', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 2 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers ).to.length( 0 );
- } );
- it( 'should not add marker when collapsed selection is on the marker right bound', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ) );
- writer.addMarker( 'marker', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 2 ] ),
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers ).to.length( 0 );
- } );
- it( 'should add marker when non-collapsed selection is inside a marker and touches the left bound', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 3 ] )
- ) );
- writer.addMarker( 'marker', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 5 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ) ).to.have.members( [ 'marker' ] );
- } );
- it( 'should add marker when non-collapsed selection is inside a marker and touches the right bound', () => {
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 2 ] ),
- writer.createPositionFromPath( root, [ 2, 5 ] )
- ) );
- writer.addMarker( 'marker', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 5 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ) ).to.have.members( [ 'marker' ] );
- } );
- it( 'should add marker of selected widget', () => {
- root._insertChild( 0, new Element( 'widget' ) );
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 0 ] ),
- writer.createPositionFromPath( root, [ 1 ] )
- ) );
- writer.addMarker( 'marker', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 0 ] ),
- writer.createPositionFromPath( root, [ 1 ] )
- ),
- usingOperation: false
- } );
- } );
- expect( selection.markers.map( marker => marker.name ) ).to.have.members( [ 'marker' ] );
- } );
- describe( 'should fire change:marker event when', () => {
- // Set marker to range 0-4.
- beforeEach( () => {
- model.change( writer => {
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ),
- usingOperation: false
- } );
- } );
- } );
- it( 'selection ranges change (marker added to the selection)', () => {
- const spy = sinon.spy();
- model.change( writer => {
- // The selection has no markers before the change.
- model.document.selection.on( 'change:marker', ( evt, data ) => {
- expect( data.oldMarkers ).to.deep.equal( [] );
- spy();
- } );
- // Move selection to 1-2, that is inside 0-4 marker.
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 2 ] )
- ) );
- } );
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'selection ranges change (marker removed from the selection)', () => {
- const spy = sinon.spy();
- model.change( writer => {
- writer.setSelection( writer.createRange(
- writer.createPositionFromPath( root, [ 2, 1 ] ),
- writer.createPositionFromPath( root, [ 2, 2 ] )
- ) );
- // The selection is in a marker before the change.
- model.document.selection.on( 'change:marker', ( evt, data ) => {
- expect( data.oldMarkers.map( marker => marker.name ) ).to.deep.equal( [ 'marker-1' ] );
- spy();
- } );
- // Move the selection out of the marker.
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 5 ] ) );
- } );
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'selection focus changes (marker removed from the selection)', () => {
- const spy = sinon.spy();
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 2 ] ) );
- // The selection is in a marker before the change.
- model.document.selection.on( 'change:marker', ( evt, data ) => {
- expect( data.oldMarkers.map( marker => marker.name ) ).to.deep.equal( [ 'marker-1' ] );
- spy();
- } );
- // Move the selection focus out of the marker.
- writer.setSelectionFocus( writer.createPositionFromPath( root, [ 2, 5 ] ) );
- } );
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'a new marker contains the selection', () => {
- const spy = sinon.spy();
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 5 ] ) );
- // The selection is not in a marker before the change.
- model.document.selection.on( 'change:marker', ( evt, data ) => {
- expect( data.oldMarkers ).to.deep.equal( [] );
- spy();
- } );
- writer.updateMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 6 ] )
- )
- } );
- } );
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'a marker stops contains the selection', () => {
- const spy = sinon.spy();
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 3 ] ) );
- // The selection is in a marker before the change.
- model.document.selection.on( 'change:marker', ( evt, data ) => {
- expect( data.oldMarkers.map( marker => marker.name ) ).to.deep.equal( [ 'marker-1' ] );
- spy();
- } );
- writer.updateMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 1 ] )
- )
- } );
- } );
- expect( spy.calledOnce ).to.be.true;
- } );
- } );
- describe( 'should not fire change:marker event when', () => {
- // Set marker to range 0-4.
- beforeEach( () => {
- model.change( writer => {
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 4 ] )
- ),
- usingOperation: false
- } );
- } );
- } );
- it( 'selection ranges change does not change selection markers (no markers)', () => {
- const spy = sinon.spy();
- model.document.selection.on( 'change:marker', spy );
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 5 ] ) );
- } );
- expect( spy.called ).to.be.false;
- } );
- it( 'selection ranges change does not change selection markers (same markers)', () => {
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 2 ] ) );
- } );
- const spy = sinon.spy();
- model.document.selection.on( 'change:marker', spy );
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 3 ] ) );
- } );
- expect( spy.called ).to.be.false;
- } );
- it( 'selection focus change does not change selection markers', () => {
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 2 ] ) );
- } );
- const spy = sinon.spy();
- model.document.selection.on( 'change:marker', spy );
- model.change( writer => {
- writer.setSelectionFocus( writer.createPositionFromPath( root, [ 2, 3 ] ) );
- } );
- expect( spy.called ).to.be.false;
- } );
- it( 'changed marker still contains the selection', () => {
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 2 ] ) );
- } );
- const spy = sinon.spy();
- model.document.selection.on( 'change:marker', spy );
- model.change( writer => {
- writer.updateMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( root, [ 2, 0 ] ),
- writer.createPositionFromPath( root, [ 2, 5 ] )
- )
- } );
- } );
- expect( spy.called ).to.be.false;
- } );
- it( 'removed marker did not contain the selection', () => {
- model.change( writer => {
- writer.setSelection( writer.createPositionFromPath( root, [ 2, 5 ] ) );
- } );
- const spy = sinon.spy();
- model.document.selection.on( 'change:marker', spy );
- model.change( writer => {
- writer.removeMarker( 'marker-1' );
- } );
- expect( spy.called ).to.be.false;
- } );
- } );
- } );
- describe( 'destroy()', () => {
- it( 'should unbind all events', () => {
- selection._setTo( [ range, liveRange ] );
- const ranges = Array.from( selection._selection._ranges );
- sinon.spy( ranges[ 0 ], 'detach' );
- sinon.spy( ranges[ 1 ], 'detach' );
- selection.destroy();
- expect( ranges[ 0 ].detach.called ).to.be.true;
- expect( ranges[ 1 ].detach.called ).to.be.true;
- } );
- } );
- describe( 'getFirstRange()', () => {
- it( 'should return default range if no ranges were added', () => {
- const firstRange = selection.getFirstRange();
- expect( firstRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) );
- expect( firstRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) );
- } );
- } );
- describe( 'getLastRange()', () => {
- it( 'should return default range if no ranges were added', () => {
- const lastRange = selection.getLastRange();
- expect( lastRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) );
- expect( lastRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) );
- } );
- } );
- describe( 'getSelectedElement()', () => {
- it( 'should return selected element', () => {
- selection._setTo( liveRange );
- const p = root.getChild( 0 );
- expect( selection.getSelectedElement() ).to.equal( p );
- } );
- } );
- describe( 'is()', () => {
- it( 'should return true for selection', () => {
- expect( selection.is( 'selection' ) ).to.be.true;
- expect( selection.is( 'model:selection' ) ).to.be.true;
- } );
- it( 'should return true for documentSelection', () => {
- expect( selection.is( 'documentSelection' ) ).to.be.true;
- expect( selection.is( 'model:documentSelection' ) ).to.be.true;
- } );
- it( 'should return false for other values', () => {
- expect( selection.is( 'node' ) ).to.be.false;
- expect( selection.is( 'model:node' ) ).to.be.false;
- expect( selection.is( '$text' ) ).to.be.false;
- expect( selection.is( '$textProxy' ) ).to.be.false;
- expect( selection.is( 'element' ) ).to.be.false;
- expect( selection.is( 'element', 'paragraph' ) ).to.be.false;
- expect( selection.is( 'rootElement' ) ).to.be.false;
- expect( selection.is( 'view:selection' ) ).to.be.false;
- expect( selection.is( 'view:documentSelection' ) ).to.be.false;
- } );
- } );
- describe( '_setTo() - set collapsed at', () => {
- it( 'detaches all existing ranges', () => {
- selection._setTo( [ range, liveRange ] );
- const spy = sinon.spy( LiveRange.prototype, 'detach' );
- selection._setTo( root, 0 );
- expect( spy.calledTwice ).to.be.true;
- } );
- } );
- describe( '_setFocus()', () => {
- it( 'modifies default range', () => {
- const startPos = selection.getFirstPosition();
- const endPos = Position._createAt( root, 'end' );
- selection._setFocus( endPos );
- expect( selection.anchor.compareWith( startPos ) ).to.equal( 'same' );
- expect( selection.focus.compareWith( endPos ) ).to.equal( 'same' );
- } );
- it( 'detaches the range it replaces', () => {
- const startPos = Position._createAt( root, 1 );
- const endPos = Position._createAt( root, 2 );
- const newEndPos = Position._createAt( root, 4 );
- const spy = sinon.spy( LiveRange.prototype, 'detach' );
- selection._setTo( new Range( startPos, endPos ) );
- selection._setFocus( newEndPos );
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'refreshes attributes', () => {
- const spy = sinon.spy( selection._selection, '_updateAttributes' );
- selection._setFocus( Position._createAt( root, 1 ) );
- expect( spy.called ).to.be.true;
- } );
- } );
- describe( '_setTo() - remove all ranges', () => {
- let spy, ranges;
- beforeEach( () => {
- selection._setTo( [ liveRange, range ] );
- spy = sinon.spy();
- selection.on( 'change:range', spy );
- ranges = Array.from( selection._selection._ranges );
- sinon.spy( ranges[ 0 ], 'detach' );
- sinon.spy( ranges[ 1 ], 'detach' );
- selection._setTo( null );
- } );
- it( 'should remove all stored ranges (and reset to default range)', () => {
- expect( Array.from( selection.getRanges() ).length ).to.equal( 1 );
- expect( selection.anchor.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
- expect( selection.focus.isEqual( new Position( root, [ 0, 0 ] ) ) ).to.be.true;
- } );
- it( 'should detach ranges', () => {
- expect( ranges[ 0 ].detach.called ).to.be.true;
- expect( ranges[ 1 ].detach.called ).to.be.true;
- } );
- it( 'should refresh attributes', () => {
- const spy = sinon.spy( selection._selection, '_updateAttributes' );
- selection._setTo( null );
- expect( spy.called ).to.be.true;
- } );
- } );
- describe( '_setTo()', () => {
- it( 'should throw an error when range is invalid', () => {
- expectToThrowCKEditorError( () => {
- selection._setTo( [ { invalid: 'range' } ] );
- }, /model-selection-set-ranges-not-range/, model );
- } );
- it( 'should do nothing when trying to set selection to the graveyard', () => {
- // Catches the 'Trying to add a Range that is in the graveyard root. Range rejected.' warning in the CK_DEBUG mode.
- sinon.stub( console, 'warn' );
- const range = new Range( new Position( model.document.graveyard, [ 0 ] ) );
- selection._setTo( range );
- expect( selection._ranges ).to.deep.equal( [] );
- } );
- it( 'should detach removed ranges', () => {
- selection._setTo( [ liveRange, range ] );
- const oldRanges = Array.from( selection._selection._ranges );
- sinon.spy( oldRanges[ 0 ], 'detach' );
- sinon.spy( oldRanges[ 1 ], 'detach' );
- selection._setTo( [] );
- expect( oldRanges[ 0 ].detach.called ).to.be.true;
- expect( oldRanges[ 1 ].detach.called ).to.be.true;
- } );
- it( 'should refresh attributes', () => {
- const spy = sinon.spy( selection._selection, '_updateAttributes' );
- selection._setTo( [ range ] );
- expect( spy.called ).to.be.true;
- } );
- // See #630.
- it( 'should refresh attributes – integration test for #630', () => {
- model.schema.extend( '$text', { allowIn: '$root' } );
- setData( model, 'f<$text italic="true">[o</$text><$text bold="true">ob]a</$text>r' );
- selection._setTo( [ Range._createFromPositionAndShift( selection.getLastRange().end, 0 ) ] );
- expect( selection.getAttribute( 'bold' ) ).to.equal( true );
- expect( selection.hasAttribute( 'italic' ) ).to.equal( false );
- expect( getData( model ) )
- .to.equal( 'f<$text italic="true">o</$text><$text bold="true">ob[]a</$text>r' );
- } );
- } );
- describe( '_isStoreAttributeKey', () => {
- it( 'should return true if given key is a key of an attribute stored in element by DocumentSelection', () => {
- expect( DocumentSelection._isStoreAttributeKey( fooStoreAttrKey ) ).to.be.true;
- } );
- it( 'should return false if given key is not a key of an attribute stored in element by DocumentSelection', () => {
- expect( DocumentSelection._isStoreAttributeKey( 'foo' ) ).to.be.false;
- } );
- } );
- describe( 'attributes', () => {
- let fullP, emptyP, rangeInFullP, rangeInEmptyP;
- beforeEach( () => {
- root._removeChildren( 0, root.childCount );
- root._appendChild( [
- new Element( 'p', [], new Text( 'foobar' ) ),
- new Element( 'p', [], [] )
- ] );
- fullP = root.getChild( 0 );
- emptyP = root.getChild( 1 );
- rangeInFullP = new Range( new Position( root, [ 0, 4 ] ), new Position( root, [ 0, 4 ] ) );
- rangeInEmptyP = new Range( new Position( root, [ 1, 0 ] ), new Position( root, [ 1, 0 ] ) );
- // I've lost 30 mins debugging why my tests fail and that was due to the above code reusing
- // a root which wasn't empty (so the ranges didn't actually make much sense).
- expect( root.childCount ).to.equal( 2 );
- } );
- describe( '_setAttribute()', () => {
- it( 'should set attribute', () => {
- selection._setTo( [ rangeInEmptyP ] );
- selection._setAttribute( 'foo', 'bar' );
- expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
- } );
- } );
- describe( '_removeAttribute()', () => {
- it( 'should remove attribute set on the text fragment', () => {
- selection._setTo( [ rangeInFullP ] );
- selection._setAttribute( 'foo', 'bar' );
- selection._removeAttribute( 'foo' );
- expect( selection.getAttribute( 'foo' ) ).to.be.undefined;
- } );
- it( 'should prevent auto update of the attribute even if attribute is not preset yet', () => {
- selection._setTo( new Position( root, [ 0, 1 ] ) );
- // Remove "foo" attribute that is not present in selection yet.
- expect( selection.hasAttribute( 'foo' ) ).to.be.false;
- selection._removeAttribute( 'foo' );
- // Trigger selecton auto update on document change. It should not get attribute from surrounding text;
- model.change( writer => {
- writer.setAttribute( 'foo', 'bar', Range._createIn( fullP ) );
- } );
- expect( selection.getAttribute( 'foo' ) ).to.be.undefined;
- } );
- } );
- describe( '_getStoredAttributes()', () => {
- it( 'should return no values if there are no ranges in selection', () => {
- const values = Array.from( selection._getStoredAttributes() );
- expect( values ).to.deep.equal( [] );
- } );
- } );
- describe( 'are updated on a direct range change', () => {
- beforeEach( () => {
- root._insertChild( 0, [
- new Element( 'p', { p: true } ),
- new Text( 'a', { a: true } ),
- new Element( 'p', { p: true } ),
- new Text( 'b', { b: true } ),
- new Text( 'c', { c: true } ),
- new Element( 'p', [], [
- new Text( 'd', { d: true } )
- ] ),
- new Element( 'p', { p: true } ),
- new Text( 'e', { e: true } )
- ] );
- } );
- it( 'if selection is a range, should find first character in it and copy it\'s attributes', () => {
- selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
- // Step into elements when looking for first character:
- selection._setTo( [ new Range( new Position( root, [ 5 ] ), new Position( root, [ 7 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
- } );
- it( 'if selection is collapsed it should seek a character to copy that character\'s attributes', () => {
- // Take styles from character before selection.
- selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
- // If there are none,
- // Take styles from character after selection.
- selection._setTo( [ new Range( new Position( root, [ 3 ] ), new Position( root, [ 3 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] );
- // If there are none,
- // Look from the selection position to the beginning of node looking for character to take attributes from.
- selection._setTo( [ new Range( new Position( root, [ 6 ] ), new Position( root, [ 6 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'c', true ] ] );
- // If there are none,
- // Look from the selection position to the end of node looking for character to take attributes from.
- selection._setTo( [ new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
- // If there are no characters to copy attributes from, use stored attributes.
- selection._setTo( [ new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 0 ] ) ) ] );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [] );
- } );
- it( 'should overwrite any previously set attributes', () => {
- selection._setTo( new Position( root, [ 5, 0 ] ) );
- selection._setAttribute( 'x', true );
- selection._setAttribute( 'y', true );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ], [ 'x', true ], [ 'y', true ] ] );
- selection._setTo( new Position( root, [ 1 ] ) );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] );
- } );
- it( 'should fire change:attribute event', () => {
- const spy = sinon.spy();
- selection.on( 'change:attribute', spy );
- selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] );
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'should not fire change:attribute event if attributes did not change', () => {
- selection._setTo( new Position( root, [ 5, 0 ] ) );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
- const spy = sinon.spy();
- selection.on( 'change:attribute', spy );
- selection._setTo( new Position( root, [ 5, 1 ] ) );
- expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] );
- expect( spy.called ).to.be.false;
- } );
- } );
- // #986
- describe( 'are not inherited from the inside of object elements', () => {
- beforeEach( () => {
- model.schema.register( 'image', {
- isObject: true
- } );
- model.schema.extend( 'image', { allowIn: '$root' } );
- model.schema.extend( 'image', { allowIn: '$block' } );
- model.schema.register( 'caption' );
- model.schema.extend( 'caption', { allowIn: 'image' } );
- model.schema.extend( '$text', {
- allowIn: [ 'image', 'caption' ],
- allowAttributes: 'bold'
- } );
- } );
- it( 'ignores attributes inside an object if selection contains that object', () => {
- setData( model, '<p>[<image><$text bold="true">Caption for the image.</$text></image>]</p>' );
- expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
- } );
- it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => {
- setData( model, '<p>[<image><caption><$text bold="true">Caption for the image.</$text></caption></image>]</p>' );
- expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
- } );
- it( 'ignores attributes inside an object if selection contains that object (block level)', () => {
- setData( model, '<p>foo</p>[<image><$text bold="true">Caption for the image.</$text></image>]<p>foo</p>' );
- expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
- } );
- it( 'reads attributes from text even if the selection contains an object', () => {
- setData( model, '<p>x<$text bold="true">[bar</$text><image></image>foo]</p>' );
- expect( selection.getAttribute( 'bold' ) ).to.equal( true );
- } );
- it( 'reads attributes when the entire selection inside an object', () => {
- setData( model, '<p><image><caption><$text bold="true">[bar]</$text></caption></image></p>' );
- expect( selection.getAttribute( 'bold' ) ).to.equal( true );
- } );
- it( 'stops reading attributes if selection starts with an object', () => {
- setData( model, '<p>[<image></image><$text bold="true">bar]</$text></p>' );
- expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
- } );
- } );
- describe( 'parent element\'s attributes', () => {
- it( 'are set using a normal batch', () => {
- const batchTypes = [];
- model.on( 'applyOperation', ( event, args ) => {
- const operation = args[ 0 ];
- const batch = operation.batch;
- batchTypes.push( batch.type );
- } );
- selection._setTo( [ rangeInEmptyP ] );
- model.change( writer => {
- writer.setSelectionAttribute( 'foo', 'bar' );
- } );
- expect( batchTypes ).to.deep.equal( [ 'default' ] );
- expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
- } );
- it( 'are removed when any content is inserted (reuses the same batch)', () => {
- // Dedupe batches by using a map (multiple change events will be fired).
- const batchTypes = new Map();
- selection._setTo( rangeInEmptyP );
- selection._setAttribute( 'foo', 'bar' );
- selection._setAttribute( 'abc', 'bar' );
- model.on( 'applyOperation', ( event, args ) => {
- const operation = args[ 0 ];
- const batch = operation.batch;
- batchTypes.set( batch, batch.type );
- } );
- model.change( writer => {
- writer.insertText( 'x', rangeInEmptyP.start );
- } );
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
- expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
- expect( Array.from( batchTypes.values() ) ).to.deep.equal( [ 'default' ] );
- } );
- it( 'are removed when any content is moved into', () => {
- selection._setTo( rangeInEmptyP );
- selection._setAttribute( 'foo', 'bar' );
- model.change( writer => {
- writer.move( writer.createRangeOn( fullP.getChild( 0 ) ), rangeInEmptyP.start );
- } );
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
- } );
- it( 'are removed when containing element is merged with a non-empty element', () => {
- const emptyP2 = new Element( 'p', null, 'x' );
- root._appendChild( emptyP2 );
- emptyP._setAttribute( fooStoreAttrKey, 'bar' );
- emptyP2._setAttribute( fooStoreAttrKey, 'bar' );
- model.change( writer => {
- // <emptyP>{}<emptyP2>
- writer.merge( writer.createPositionAfter( emptyP ) );
- } );
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
- expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
- } );
- it( 'are removed even when there is no selection in it', () => {
- emptyP._setAttribute( fooStoreAttrKey, 'bar' );
- selection._setTo( [ rangeInFullP ] );
- model.change( writer => {
- writer.insertText( 'x', rangeInEmptyP.start );
- } );
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
- } );
- it( 'uses model change to clear attributes', () => {
- selection._setTo( [ rangeInEmptyP ] );
- model.change( writer => {
- writer.setSelectionAttribute( 'foo', 'bar' );
- writer.insertText( 'x', rangeInEmptyP.start );
- // `emptyP` still has the attribute, because attribute clearing is in enqueued block.
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
- } );
- // When the dust settles, `emptyP` should not have the attribute.
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false;
- } );
- it( 'are not removed or merged when containing element is merged with another empty element', () => {
- const emptyP2 = new Element( 'p', null );
- root._appendChild( emptyP2 );
- emptyP._setAttribute( fooStoreAttrKey, 'bar' );
- emptyP2._setAttribute( abcStoreAttrKey, 'bar' );
- expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true;
- expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false;
- model.change( writer => {
- // <emptyP>{}<emptyP2>
- writer.merge( writer.createPositionAfter( emptyP ) );
- } );
- expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
- expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element.
- } );
- // Rename and some other operations don't specify range in doc#change event.
- // So let's see if there's no crash or something.
- it( 'are not removed on rename', () => {
- model.change( writer => {
- writer.setSelection( rangeInEmptyP );
- writer.setSelectionAttribute( 'foo', 'bar' );
- } );
- sinon.spy( model, 'enqueueChange' );
- model.change( writer => {
- writer.rename( emptyP, 'pnew' );
- } );
- expect( model.enqueueChange.called ).to.be.false;
- expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' );
- } );
- } );
- // #7459
- describe( 'ignores inline elements while reading surrounding attributes', () => {
- beforeEach( () => {
- model.schema.register( 'softBreak', {
- allowWhere: '$text',
- isInline: true
- } );
- } );
- it( 'should not inherit attributes from a node before an inline element', () => {
- setData( model, '<p><$text bold="true">Foo Bar.</$text><softBreak></softBreak>[]</p>' );
- expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
- } );
- it( 'should not inherit attributes from a node after an inline element (override gravity)', () => {
- setData( model, '<p>[]<softBreak></softBreak><$text bold="true">Foo Bar.</$text></p>' );
- const overrideGravityUid = selection._overrideGravity();
- expect( selection.hasAttribute( 'bold' ) ).to.equal( false );
- selection._restoreGravity( overrideGravityUid );
- } );
- } );
- } );
- describe( '_overrideGravity()', () => {
- beforeEach( () => {
- model.schema.extend( '$text', {
- allowIn: '$root'
- } );
- } );
- it( 'should return the UID', () => {
- const overrideUidA = selection._overrideGravity();
- const overrideUidB = selection._overrideGravity();
- expect( overrideUidA ).to.be.a( 'string' );
- expect( overrideUidB ).to.be.a( 'string' );
- expect( overrideUidA ).to.not.equal( overrideUidB );
- } );
- it( 'should mark gravity as overridden', () => {
- expect( selection.isGravityOverridden ).to.false;
- selection._overrideGravity();
- expect( selection.isGravityOverridden ).to.true;
- } );
- it( 'should not inherit attributes from node before the caret', () => {
- setData( model, '<$text bold="true" italic="true">foo[]</$text>' );
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] );
- selection._overrideGravity();
- expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 );
- } );
- it( 'should inherit attributes from node after the caret', () => {
- setData( model, '<$text>foo[]</$text><$text bold="true" italic="true">bar</$text>' );
- expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 );
- selection._overrideGravity();
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] );
- } );
- it( 'should not retain attributes that are set explicitly', () => {
- setData( model, '<$text italic="true">foo[]</$text>' );
- selection._setAttribute( 'bold', true );
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] );
- selection._overrideGravity();
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [] );
- } );
- it( 'should retain overridden until selection will not change range by a direct change', () => {
- setData( model, '<$text bold="true" italic="true">foo[]</$text><$text italic="true">bar</$text>' );
- selection._overrideGravity();
- // Changed range but not directly.
- model.change( writer => writer.insertText( 'abc', new Position( root, [ 0 ] ) ) );
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'italic' ] );
- // Changed range directly.
- model.change( writer => writer.setSelection( new Position( root, [ 5 ] ) ) );
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] );
- } );
- } );
- describe( '_restoreGravity()', () => {
- beforeEach( () => {
- model.schema.extend( '$text', {
- allowIn: '$root'
- } );
- } );
- it( 'should throw when a wrong, already restored, or no UID provided', () => {
- const overrideUid = selection._overrideGravity();
- selection._restoreGravity( overrideUid );
- // Wrong UID
- expectToThrowCKEditorError( () => {
- selection._restoreGravity( 'foo' );
- }, /^document-selection-gravity-wrong-restore/, model );
- // Already restored
- expectToThrowCKEditorError( () => {
- selection._restoreGravity( overrideUid );
- }, /^document-selection-gravity-wrong-restore/, model );
- // No UID
- expectToThrowCKEditorError( () => {
- selection._restoreGravity();
- }, /^document-selection-gravity-wrong-restore/, model );
- } );
- it( 'should revert default gravity when is overridden', () => {
- setData( model, '<$text bold="true" italic="true">foo[]</$text>' );
- const overrideUid = selection._overrideGravity();
- expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 );
- expect( selection.isGravityOverridden ).to.true;
- selection._restoreGravity( overrideUid );
- expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] );
- expect( selection.isGravityOverridden ).to.false;
- } );
- it( 'should be called the same number of times as gravity is overridden to restore it', () => {
- setData( model, '<$text bold="true" italic="true">foo[]</$text>' );
- const overrideUidA = selection._overrideGravity();
- const overrideUidB = selection._overrideGravity();
- expect( selection.isGravityOverridden ).to.true;
- selection._restoreGravity( overrideUidA );
- expect( selection.isGravityOverridden ).to.true;
- selection._restoreGravity( overrideUidB );
- expect( selection.isGravityOverridden ).to.false;
- } );
- } );
- // https://github.com/ckeditor/ckeditor5-engine/issues/1673
- describe( 'refreshing selection data', () => {
- it( 'should be up to date before post fixers', () => {
- model.schema.extend( '$text', { allowAttributes: 'foo' } );
- const p = doc.getRoot().getChild( 0 );
- doc.registerPostFixer( () => {
- expect( model.document.selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
- expect( Array.from( model.document.selection.markers, m => m.name ) ).to.deep.equal( [ 'marker' ] );
- } );
- model.change( writer => {
- writer.insertText( 'abcdef', { foo: 'bar' }, p );
- writer.addMarker( 'marker', {
- range: writer.createRange(
- writer.createPositionFromPath( p, [ 1 ] ),
- writer.createPositionFromPath( p, [ 5 ] )
- ),
- usingOperation: false
- } );
- writer.setSelection( writer.createPositionFromPath( p, [ 3 ] ) );
- } );
- } );
- it( 'should be up to date between post fixers', () => {
- model.schema.extend( '$text', { allowAttributes: 'foo' } );
- const p = doc.getRoot().getChild( 0 );
- doc.registerPostFixer( writer => {
- writer.setAttribute( 'foo', 'biz', p.getChild( 0 ) );
- writer.removeMarker( 'marker-1' );
- writer.addMarker( 'marker-2', {
- range: writer.createRange(
- writer.createPositionFromPath( p, [ 1 ] ),
- writer.createPositionFromPath( p, [ 5 ] )
- ),
- usingOperation: false
- } );
- } );
- doc.registerPostFixer( () => {
- expect( model.document.selection.getAttribute( 'foo' ) ).to.equal( 'biz' );
- expect( Array.from( model.document.selection.markers, m => m.name ) ).to.deep.equal( [ 'marker-2' ] );
- } );
- model.change( writer => {
- writer.insertText( 'abcdef', { foo: 'bar' }, p );
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( p, [ 1 ] ),
- writer.createPositionFromPath( p, [ 5 ] )
- ),
- usingOperation: false
- } );
- writer.setSelection( writer.createPositionFromPath( p, [ 3 ] ) );
- } );
- } );
- it( 'should be up to date after post fixers (on `change` event)', done => {
- model.schema.extend( '$text', { allowAttributes: 'foo' } );
- const p = doc.getRoot().getChild( 0 );
- doc.on( 'change', () => {
- expect( model.document.selection.getAttribute( 'foo' ) ).to.equal( 'biz' );
- expect( Array.from( model.document.selection.markers, m => m.name ) ).to.deep.equal( [ 'marker-2' ] );
- done();
- } );
- doc.registerPostFixer( writer => {
- writer.setAttribute( 'foo', 'biz', p.getChild( 0 ) );
- writer.removeMarker( 'marker-1' );
- writer.addMarker( 'marker-2', {
- range: writer.createRange(
- writer.createPositionFromPath( p, [ 1 ] ),
- writer.createPositionFromPath( p, [ 5 ] )
- ),
- usingOperation: false
- } );
- } );
- model.change( writer => {
- writer.insertText( 'abcdef', { foo: 'bar' }, p );
- writer.addMarker( 'marker-1', {
- range: writer.createRange(
- writer.createPositionFromPath( p, [ 1 ] ),
- writer.createPositionFromPath( p, [ 5 ] )
- ),
- usingOperation: false
- } );
- writer.setSelection( writer.createPositionFromPath( p, [ 3 ] ) );
- } );
- } );
- } );
- // DocumentSelection uses LiveRanges so here are only simple test to see if integration is
- // working well, without getting into complicated corner cases.
- describe( 'after applying an operation should get updated and fire events', () => {
- let spyRange;
- beforeEach( () => {
- root._removeChildren( 0, root.childCount );
- root._insertChild( 0, [
- new Element( 'p', [], new Text( 'abcdef' ) ),
- new Element( 'p', [], new Text( 'foobar' ) ),
- new Text( 'xyz' )
- ] );
- selection._setTo( new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 1, 4 ] ) ) );
- spyRange = sinon.spy();
- selection.on( 'change:range', spyRange );
- } );
- describe( 'InsertOperation', () => {
- it( 'before selection', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- model.applyOperation(
- new InsertOperation(
- new Position( root, [ 0, 1 ] ),
- 'xyz',
- doc.version
- )
- );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 5 ] );
- expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- it( 'inside selection', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- model.applyOperation(
- new InsertOperation(
- new Position( root, [ 1, 0 ] ),
- 'xyz',
- doc.version
- )
- );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
- expect( range.end.path ).to.deep.equal( [ 1, 7 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- } );
- describe( 'MoveOperation', () => {
- it( 'move range from before a selection', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 0, 0 ] ),
- 2,
- new Position( root, [ 2 ] ),
- doc.version
- )
- );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 0 ] );
- expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- it( 'moved into before a selection', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 2 ] ),
- 2,
- new Position( root, [ 0, 0 ] ),
- doc.version
- )
- );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 4 ] );
- expect( range.end.path ).to.deep.equal( [ 1, 4 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- it( 'move range from inside of selection', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1, 0 ] ),
- 2,
- new Position( root, [ 2 ] ),
- doc.version
- )
- );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
- expect( range.end.path ).to.deep.equal( [ 1, 2 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- it( 'moved range intersects with selection', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1, 3 ] ),
- 2,
- new Position( root, [ 4 ] ),
- doc.version
- )
- );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
- expect( range.end.path ).to.deep.equal( [ 1, 3 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- it( 'split inside selection (do not break selection)', () => {
- selection.on( 'change:range', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- } );
- const batch = new Batch();
- const splitOperation = new SplitOperation( new Position( root, [ 1, 2 ] ), 4, null, 0 );
- batch.addOperation( splitOperation );
- model.applyOperation( splitOperation );
- const range = selection.getFirstRange();
- expect( range.start.path ).to.deep.equal( [ 0, 2 ] );
- expect( range.end.path ).to.deep.equal( [ 2, 2 ] );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- } );
- describe( 'AttributeOperation', () => {
- it( 'changed range includes selection anchor', () => {
- const spyAttribute = sinon.spy();
- selection.on( 'change:attribute', spyAttribute );
- selection.on( 'change:attribute', ( evt, data ) => {
- expect( data.directChange ).to.be.false;
- expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] );
- } );
- model.applyOperation(
- new AttributeOperation(
- new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
- 'foo',
- null,
- 'bar',
- doc.version
- )
- );
- // Attributes are auto updated on document change.
- model.change( () => {} );
- expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' );
- expect( spyAttribute.calledOnce ).to.be.true;
- } );
- it( 'should not overwrite previously set attributes', () => {
- selection._setAttribute( 'foo', 'xyz' );
- const spyAttribute = sinon.spy();
- selection.on( 'change:attribute', spyAttribute );
- model.applyOperation(
- new AttributeOperation(
- new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
- 'foo',
- null,
- 'bar',
- doc.version
- )
- );
- expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' );
- expect( spyAttribute.called ).to.be.false;
- } );
- it( 'should not overwrite previously set attributes with same values', () => {
- selection._setAttribute( 'foo', 'xyz' );
- const spyAttribute = sinon.spy();
- selection.on( 'change:attribute', spyAttribute );
- model.applyOperation(
- new AttributeOperation(
- new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
- 'foo',
- null,
- 'xyz',
- doc.version
- )
- );
- expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' );
- expect( spyAttribute.called ).to.be.false;
- } );
- it( 'should not overwrite previously removed attributes', () => {
- selection._setAttribute( 'foo', 'xyz' );
- selection._removeAttribute( 'foo' );
- const spyAttribute = sinon.spy();
- selection.on( 'change:attribute', spyAttribute );
- model.applyOperation(
- new AttributeOperation(
- new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ),
- 'foo',
- null,
- 'bar',
- doc.version
- )
- );
- expect( selection.hasAttribute( 'foo' ) ).to.be.false;
- expect( spyAttribute.called ).to.be.false;
- } );
- } );
- describe( 'MoveOperation to graveyard', () => {
- it( 'fix selection range if it ends up in graveyard - collapsed selection', () => {
- selection._setTo( new Position( root, [ 1, 3 ] ) );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1, 2 ] ),
- 2,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
- } );
- it( 'fix selection range if it ends up in graveyard - text from non-collapsed selection is moved', () => {
- selection._setTo( [ new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 4 ] ) ) ] );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1, 2 ] ),
- 2,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
- } );
- it( 'fix selection range if it ends up in graveyard - parent of non-collapsed selection is moved', () => {
- selection._setTo( [ new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ) ] );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1 ] ),
- 2,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 6 ] );
- } );
- it( 'fix selection range if it ends up in graveyard - whole content removed', () => {
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 0 ] ),
- 3,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 0 ] );
- model.applyOperation(
- new InsertOperation(
- new Position( root, [ 0 ] ),
- new Element( 'p' ),
- doc.version
- )
- );
- // Now it's clear that it's the default range.
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] );
- } );
- it( 'handles multi-range selection in a text node by merging it into one range (resulting in a collapsed range)', () => {
- const ranges = [
- new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ),
- new Range( new Position( root, [ 1, 3 ] ), new Position( root, [ 1, 4 ] ) )
- ];
- selection._setTo( ranges );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1, 0 ] ),
- 5,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.rangeCount ).to.equal( 1 );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 0 ] );
- expect( selection.getLastPosition().path ).to.deep.equal( [ 1, 0 ] );
- } );
- it( 'handles multi-range selection on object nodes by merging it into one range (resulting in a non-collapsed range)', () => {
- model.schema.register( 'outer', {
- isObject: true
- } );
- model.schema.register( 'inner', {
- isObject: true,
- allowIn: 'outer'
- } );
- root._removeChildren( 0, root.childCount );
- root._insertChild( 0, [
- new Element( 'outer', [], [ new Element( 'inner' ), new Element( 'inner' ), new Element( 'inner' ) ] )
- ] );
- const ranges = [
- new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 1 ] ) ),
- new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 2 ] ) )
- ];
- selection._setTo( ranges );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 0, 0 ] ),
- 2,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.rangeCount ).to.equal( 1 );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] );
- expect( selection.getLastPosition().path ).to.deep.equal( [ 0, 1 ] );
- } );
- it( 'should not fix the selection if not all ranges were removed', () => {
- const ranges = [
- new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ),
- new Range( new Position( root, [ 1, 3 ] ), new Position( root, [ 1, 4 ] ) )
- ];
- selection._setTo( ranges );
- model.applyOperation(
- new MoveOperation(
- new Position( root, [ 1, 1 ] ),
- 1,
- new Position( doc.graveyard, [ 0 ] ),
- doc.version
- )
- );
- expect( selection.rangeCount ).to.equal( 1 );
- expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] );
- expect( selection.getLastPosition().path ).to.deep.equal( [ 1, 3 ] );
- } );
- } );
- it( '`DocumentSelection#change:range` event should be fire once even if selection contains multi-ranges', () => {
- root._removeChildren( 0, root.childCount );
- root._insertChild( 0, [
- new Element( 'p', [], new Text( 'abcdef' ) ),
- new Element( 'p', [], new Text( 'foobar' ) ),
- new Text( 'xyz #2' )
- ] );
- selection._setTo( [
- Range._createIn( root.getNodeByPath( [ 0 ] ) ),
- Range._createIn( root.getNodeByPath( [ 1 ] ) )
- ] );
- spyRange = sinon.spy();
- selection.on( 'change:range', spyRange );
- model.applyOperation(
- new InsertOperation(
- new Position( root, [ 0 ] ),
- 'xyz #1',
- doc.version
- )
- );
- expect( spyRange.calledOnce ).to.be.true;
- } );
- } );
- it( 'should throw if one of ranges starts or ends inside surrogate pair', () => {
- root._removeChildren( 0, root.childCount );
- root._appendChild( '\uD83D\uDCA9' );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 0 ), Position._createAt( root, 1 ) ) );
- }, /document-selection-wrong-position/, model );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 1 ), Position._createAt( root, 2 ) ) );
- }, /document-selection-wrong-position/, model );
- } );
- it( 'should throw if one of ranges starts or ends between base character and combining mark', () => {
- root._removeChildren( 0, root.childCount );
- root._appendChild( 'foo̻̐ͩbar' );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 3 ), Position._createAt( root, 9 ) ) );
- }, /document-selection-wrong-position/, model );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 4 ), Position._createAt( root, 9 ) ) );
- }, /document-selection-wrong-position/, model );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 5 ), Position._createAt( root, 9 ) ) );
- }, /document-selection-wrong-position/, model );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 1 ), Position._createAt( root, 3 ) ) );
- }, /document-selection-wrong-position/, model );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 1 ), Position._createAt( root, 4 ) ) );
- }, /document-selection-wrong-position/, model );
- expectToThrowCKEditorError( () => {
- doc.selection._setTo( new Range( Position._createAt( root, 1 ), Position._createAt( root, 5 ) ) );
- }, /document-selection-wrong-position/, model );
- } );
- } );
|