| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145 |
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
- import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
- import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import BoldEditing from '@ckeditor/ckeditor5-basic-styles/src/bold/boldediting';
- import { assertEqualMarkup } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
- import Typing from '@ckeditor/ckeditor5-typing/src/typing';
- import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
- import RestrictedEditingModeEditing from './../src/restrictededitingmodeediting';
- import RestrictedEditingModeNavigationCommand from '../src/restrictededitingmodenavigationcommand';
- describe( 'RestrictedEditingModeEditing', () => {
- let editor, model;
- testUtils.createSinonSandbox();
- describe( 'plugin', () => {
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( { plugins: [ RestrictedEditingModeEditing ] } );
- } );
- afterEach( async () => {
- await editor.destroy();
- } );
- it( 'should be named', () => {
- expect( RestrictedEditingModeEditing.pluginName ).to.equal( 'RestrictedEditingModeEditing' );
- } );
- it( 'should be loaded', () => {
- expect( editor.plugins.get( RestrictedEditingModeEditing ) ).to.be.instanceOf( RestrictedEditingModeEditing );
- } );
- it( 'root should have "ck-restricted-editing_mode_restricted" class', () => {
- for ( const root of editor.editing.view.document.roots ) {
- expect( root.hasClass( 'ck-restricted-editing_mode_restricted' ) ).to.be.true;
- }
- } );
- it( 'adds a "goToPreviousRestrictedEditingException" command', () => {
- expect( editor.commands.get( 'goToPreviousRestrictedEditingException' ) )
- .to.be.instanceOf( RestrictedEditingModeNavigationCommand );
- } );
- it( 'adds a "goToNextRestrictedEditingException" command', () => {
- expect(
- editor.commands.get( 'goToNextRestrictedEditingException' )
- ).to.be.instanceOf( RestrictedEditingModeNavigationCommand );
- } );
- } );
- describe( 'conversion', () => {
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( { plugins: [ Paragraph, RestrictedEditingModeEditing ] } );
- model = editor.model;
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- describe( 'upcast', () => {
- it( 'should convert <span class="restricted-editing-exception"> to marker', () => {
- editor.setData( '<p>foo <span class="restricted-editing-exception">bar</span> baz</p>' );
- expect( model.markers.has( 'restrictedEditingException:1' ) ).to.be.true;
- const marker = model.markers.get( 'restrictedEditingException:1' );
- expect( marker.getStart().path ).to.deep.equal( [ 0, 4 ] );
- expect( marker.getEnd().path ).to.deep.equal( [ 0, 7 ] );
- } );
- it( 'should convert multiple <span class="restricted-editing-exception">', () => {
- editor.setData(
- '<p>foo <span class="restricted-editing-exception">bar</span> baz</p>' +
- '<p>ABCDEF<span class="restricted-editing-exception">GHIJK</span>LMNOPQRST</p>'
- );
- expect( model.markers.has( 'restrictedEditingException:1' ) ).to.be.true;
- expect( model.markers.has( 'restrictedEditingException:2' ) ).to.be.true;
- // Data for the first marker is the same as in previous tests so no need to test it again.
- const secondMarker = model.markers.get( 'restrictedEditingException:2' );
- expect( secondMarker.getStart().path ).to.deep.equal( [ 1, 6 ] );
- expect( secondMarker.getEnd().path ).to.deep.equal( [ 1, 11 ] );
- } );
- it( 'should not convert other <span> elements', () => {
- editor.setData( '<p>foo <span class="foo bar">bar</span> baz</p>' );
- expect( model.markers.has( 'restrictedEditingException:1' ) ).to.be.false;
- } );
- } );
- describe( 'downcast', () => {
- it( 'should convert model marker to <span>', () => {
- setModelData( model, '<paragraph>foo bar baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- const expectedView = '<p>foo <span class="restricted-editing-exception">bar</span> baz</p>';
- expect( editor.getData() ).to.equal( expectedView );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal( expectedView );
- } );
- it( 'should convert collapsed model marker to <span>', () => {
- setModelData( model, '<paragraph>foo bar baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 4 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- expect( editor.getData() ).to.equal( '<p>foo <span class="restricted-editing-exception"></span>bar baz</p>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_collapsed"></span>bar baz</p>'
- );
- } );
- it( 'converted <span> should be the outermost attribute element', () => {
- editor.conversion.for( 'downcast' ).attributeToElement( { model: 'bold', view: 'b' } );
- setModelData( model, '<paragraph><$text bold="true">foo bar baz</$text></paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 0 ), writer.createPositionAt( paragraph, 'end' ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- expect( editor.getData() ).to.equal(
- '<p><span class="restricted-editing-exception"><b>foo bar baz</b></span></p>'
- );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal(
- '<p>' +
- '<span class="restricted-editing-exception restricted-editing-exception_selected"><b>foo bar baz</b></span>' +
- '</p>'
- );
- } );
- } );
- } );
- describe( 'editing behavior', () => {
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, RestrictedEditingModeEditing ] } );
- model = editor.model;
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'should keep markers in the view when editable region is edited', () => {
- setModelData( model,
- '<paragraph>foo bar baz</paragraph>' +
- '<paragraph>xxx y[]yy zzz</paragraph>'
- );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- const secondParagraph = model.document.getRoot().getChild( 1 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- writer.addMarker( 'restrictedEditingException:2', {
- range: writer.createRange(
- writer.createPositionAt( secondParagraph, 4 ),
- writer.createPositionAt( secondParagraph, 7 )
- ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- model.insertContent( writer.createText( 'R', model.document.selection.getAttributes() ) );
- } );
- expect( editor.getData() ).to.equal(
- '<p>foo <span class="restricted-editing-exception">bar</span> baz</p>' +
- '<p>xxx <span class="restricted-editing-exception">yRyy</span> zzz</p>' );
- expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception">bar</span> baz</p>' +
- '<p>xxx <span class="restricted-editing-exception restricted-editing-exception_selected">yRyy</span> zzz</p>' );
- } );
- it( 'should block user typing outside exception markers', () => {
- setModelData( model, '<paragraph>foo []bar baz</paragraph>' );
- editor.execute( 'input', { text: 'X' } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo []bar baz</paragraph>' );
- } );
- it( 'should not block user typing inside exception marker', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.setSelection( firstParagraph, 5 );
- } );
- editor.execute( 'input', { text: 'X' } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo bX[]ar baz</paragraph>' );
- } );
- it( 'should extend maker when typing on the marker boundary (end)', () => {
- setModelData( model, '<paragraph>foo bar[] baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- editor.execute( 'input', { text: 'X' } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo barX[] baz</paragraph>' );
- const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
- const expectedRange = model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 8 )
- );
- expect( markerRange.isEqual( expectedRange ) ).to.be.true;
- } );
- it( 'should extend marker when typing on the marker boundary (start)', () => {
- setModelData( model, '<paragraph>foo []bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- editor.execute( 'input', { text: 'X' } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo X[]bar baz</paragraph>' );
- const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
- const expectedRange = model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 8 )
- );
- expect( markerRange.isEqual( expectedRange ) ).to.be.true;
- } );
- it( 'should extend marker when typing on the marker boundary (collapsed marker)', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.setSelection( writer.createPositionAt( firstParagraph, 4 ) );
- } );
- editor.execute( 'input', { text: 'X' } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo X[]bar baz</paragraph>' );
- const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
- const expectedRange = model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 5 )
- );
- expect( markerRange.isEqual( expectedRange ) ).to.be.true;
- } );
- it( 'should retain marker on non-typing change at the marker boundary (start)', () => {
- setModelData( model, '<paragraph>foo bar[] baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 4, 7, firstParagraph );
- model.change( writer => {
- editor.execute( 'delete', {
- selection: writer.createSelection( writer.createRange(
- writer.createPositionAt( firstParagraph, 4 ),
- writer.createPositionAt( firstParagraph, 6 )
- ) )
- } );
- editor.execute( 'input', {
- text: 'XX',
- range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ) )
- } );
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo XX[]r baz</paragraph>' );
- const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
- const expectedRange = model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 7 )
- );
- expect( markerRange.isEqual( expectedRange ) ).to.be.true;
- } );
- it( 'should retain marker on non-typing change at marker boundary (end)', () => {
- setModelData( model, '<paragraph>foo bar[] baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 4, 7, firstParagraph );
- model.change( writer => {
- editor.execute( 'delete', {
- selection: writer.createSelection( writer.createRange(
- writer.createPositionAt( firstParagraph, 5 ),
- writer.createPositionAt( firstParagraph, 7 )
- ) )
- } );
- editor.execute( 'input', {
- text: 'XX',
- range: writer.createRange( writer.createPositionAt( firstParagraph, 5 ) )
- } );
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo bXX[] baz</paragraph>' );
- const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
- const expectedRange = model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 7 )
- );
- expect( markerRange.isEqual( expectedRange ) ).to.be.true;
- } );
- it( 'should not move collapsed marker to $graveyard', () => {
- setModelData( model, '<paragraph>foo b[]ar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange(
- writer.createPositionAt( firstParagraph, 4 ),
- writer.createPositionAt( firstParagraph, 5 )
- ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- editor.execute( 'delete' );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo []ar baz</paragraph>' );
- const markerRange = editor.model.markers.get( 'restrictedEditingException:1' ).getRange();
- const expectedRange = model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 4 )
- );
- expect( markerRange.isEqual( expectedRange ) ).to.be.true;
- } );
- } );
- describe( 'enforcing restrictions on deleteContent', () => {
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, RestrictedEditingModeEditing ] } );
- model = editor.model;
- } );
- afterEach( async () => {
- await editor.destroy();
- } );
- it( 'should not allow to delete content outside restricted area', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 3, 9, firstParagraph );
- model.change( writer => {
- writer.setSelection( firstParagraph, 2 );
- } );
- model.deleteContent( model.document.selection );
- assertEqualMarkup( getModelData( model ), '<paragraph>fo[]o bar baz</paragraph>' );
- } );
- it( 'should trim deleted content to a exception marker (focus in marker)', () => {
- setModelData( model, '<paragraph>[]foofoo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 3, 9, firstParagraph );
- model.change( writer => {
- const selection = writer.createSelection( writer.createRange(
- writer.createPositionAt( firstParagraph, 0 ),
- writer.createPositionAt( firstParagraph, 6 )
- ) );
- model.deleteContent( selection );
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>[]foo bar baz</paragraph>' );
- } );
- it( 'should trim deleted content to a exception marker (anchor in marker)', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 4, 7, firstParagraph );
- model.change( writer => {
- const selection = writer.createSelection( writer.createRange(
- writer.createPositionAt( firstParagraph, 5 ),
- writer.createPositionAt( firstParagraph, 8 )
- ) );
- model.deleteContent( selection );
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>[]foo b baz</paragraph>' );
- } );
- it( 'should trim deleted content to a exception marker and alter the selection argument (delete command integration)', () => {
- setModelData( model, '<paragraph>[]foofoo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 3, 9, firstParagraph );
- model.change( writer => {
- writer.setSelection( firstParagraph, 6 );
- } );
- editor.execute( 'delete', { unit: 'word' } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo[] bar baz</paragraph>' );
- } );
- it( 'should work with document selection', () => {
- setModelData( model, '<paragraph>f[oo bar] baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 2, 'end', firstParagraph );
- model.change( () => {
- model.deleteContent( model.document.selection );
- } );
- assertEqualMarkup( getModelData( model, { withoutSelection: true } ), '<paragraph>fo baz</paragraph>' );
- } );
- } );
- describe( 'enforcing restrictions on input command', () => {
- let firstParagraph;
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, RestrictedEditingModeEditing ] } );
- model = editor.model;
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- firstParagraph = model.document.getRoot().getChild( 0 );
- } );
- afterEach( async () => {
- await editor.destroy();
- } );
- it( 'should prevent changing text before exception marker', () => {
- addExceptionMarker( 4, 7, firstParagraph );
- model.change( writer => {
- writer.setSelection( firstParagraph, 5 );
- } );
- // Simulate native spell-check action.
- editor.execute( 'input', {
- text: 'xxxxxxx',
- range: model.createRange(
- model.createPositionAt( firstParagraph, 0 ),
- model.createPositionAt( firstParagraph, 7 )
- )
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo b[]ar baz</paragraph>' );
- } );
- it( 'should prevent changing text before exception marker', () => {
- addExceptionMarker( 4, 7, firstParagraph );
- model.change( writer => {
- writer.setSelection( firstParagraph, 5 );
- } );
- // Simulate native spell-check action.
- editor.execute( 'input', {
- text: 'xxxxxxx',
- range: model.createRange(
- model.createPositionAt( firstParagraph, 4 ),
- model.createPositionAt( firstParagraph, 9 )
- )
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo b[]ar baz</paragraph>' );
- } );
- it( 'should prevent changing text before (change crossing different markers)', () => {
- addExceptionMarker( 0, 4, firstParagraph );
- addExceptionMarker( 7, 9, firstParagraph, 2 );
- model.change( writer => {
- writer.setSelection( firstParagraph, 2 );
- } );
- // Simulate native spell-check action.
- editor.execute( 'input', {
- text: 'xxxxxxx',
- range: model.createRange(
- model.createPositionAt( firstParagraph, 2 ),
- model.createPositionAt( firstParagraph, 8 )
- )
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>fo[]o bar baz</paragraph>' );
- } );
- it( 'should allow changing text inside single marker', () => {
- addExceptionMarker( 0, 9, firstParagraph );
- model.change( writer => {
- writer.setSelection( firstParagraph, 2 );
- } );
- // Simulate native spell-check action.
- editor.execute( 'input', {
- text: 'xxxxxxx',
- range: model.createRange(
- model.createPositionAt( firstParagraph, 2 ),
- model.createPositionAt( firstParagraph, 8 )
- )
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foxxxxxxx[]baz</paragraph>' );
- } );
- } );
- describe( 'clipboard', () => {
- let viewDoc;
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( { plugins: [ Paragraph, Typing, Clipboard, RestrictedEditingModeEditing ] } );
- model = editor.model;
- viewDoc = editor.editing.view.document;
- } );
- afterEach( async () => {
- await editor.destroy();
- } );
- describe( 'cut', () => {
- it( 'should be blocked outside exception markers', () => {
- setModelData( model, '<paragraph>foo []bar baz</paragraph>' );
- const spy = sinon.spy();
- viewDoc.on( 'clipboardOutput', spy, { priority: 'high' } );
- viewDoc.fire( 'clipboardOutput', {
- content: {
- isEmpty: true
- },
- method: 'cut'
- } );
- sinon.assert.notCalled( spy );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo []bar baz</paragraph>' );
- } );
- it( 'should cut selected content inside exception marker (selection inside marker)', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 4, 7, firstParagraph, 1 );
- viewDoc.fire( 'clipboardOutput', {
- content: {
- isEmpty: true
- },
- method: 'cut'
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo b[]r baz</paragraph>' );
- } );
- it( 'should cut selected content inside exception marker (selection touching marker start)', () => {
- setModelData( model, '<paragraph>foo [ba]r baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 4, 7, firstParagraph, 1 );
- viewDoc.fire( 'clipboardOutput', {
- content: {
- isEmpty: true
- },
- method: 'cut'
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo []r baz</paragraph>' );
- } );
- it( 'should cut selected content inside exception marker (selection touching marker end)', () => {
- setModelData( model, '<paragraph>foo b[ar] baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- addExceptionMarker( 4, 7, firstParagraph, 1 );
- viewDoc.fire( 'clipboardOutput', {
- content: {
- isEmpty: true
- },
- method: 'cut'
- } );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo b[] baz</paragraph>' );
- } );
- } );
- describe( 'copy', () => {
- it( 'should not be blocked outside exception markers', () => {
- setModelData( model, '<paragraph>foo []bar baz</paragraph>' );
- const spy = sinon.spy();
- viewDoc.on( 'clipboardOutput', spy, { priority: 'high' } );
- viewDoc.fire( 'clipboardOutput', {
- content: {
- isEmpty: true
- },
- method: 'copy'
- } );
- sinon.assert.calledOnce( spy );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo []bar baz</paragraph>' );
- } );
- it( 'should not be blocked inside exception marker', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- const spy = sinon.spy();
- viewDoc.on( 'clipboardOutput', spy, { priority: 'high' } );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange(
- writer.createPositionAt( firstParagraph, 4 ),
- writer.createPositionAt( firstParagraph, 7 )
- ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.setSelection( firstParagraph, 5 );
- } );
- viewDoc.fire( 'clipboardOutput', {
- content: {
- isEmpty: true
- },
- method: 'copy'
- } );
- sinon.assert.calledOnce( spy );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo b[]ar baz</paragraph>' );
- } );
- } );
- describe( 'paste', () => {
- it( 'should be blocked outside exception markers', () => {
- setModelData( model, '<paragraph>foo []bar baz</paragraph>' );
- const spy = sinon.spy();
- viewDoc.on( 'clipboardInput', spy, { priority: 'high' } );
- viewDoc.fire( 'clipboardInput', {
- dataTransfer: {
- getData: sinon.spy()
- }
- } );
- sinon.assert.notCalled( spy );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo []bar baz</paragraph>' );
- } );
- it( 'should be blocked inside exception marker', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const firstParagraph = model.document.getRoot().getChild( 0 );
- const spy = sinon.spy();
- viewDoc.on( 'clipboardInput', spy, { priority: 'high' } );
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange(
- writer.createPositionAt( firstParagraph, 4 ),
- writer.createPositionAt( firstParagraph, 7 )
- ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.setSelection( firstParagraph, 5 );
- } );
- viewDoc.fire( 'clipboardInput', {
- dataTransfer: {
- getData: sinon.spy()
- }
- } );
- sinon.assert.notCalled( spy );
- assertEqualMarkup( getModelData( model ), '<paragraph>foo b[]ar baz</paragraph>' );
- } );
- } );
- } );
- describe( 'exception highlighting', () => {
- let view;
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( {
- plugins: [ Paragraph, RestrictedEditingModeEditing, BoldEditing ]
- } );
- model = editor.model;
- view = editor.editing.view;
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'should convert the highlight to a proper view classes', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_selected">b{a}r</span> baz</p>'
- );
- } );
- it( 'should remove classes when selection is moved away from an exception', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_selected">b{a}r</span> baz</p>'
- );
- model.change( writer => writer.setSelection( model.document.getRoot().getChild( 0 ), 0 ) );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo <span class="restricted-editing-exception">bar</span> baz</p>'
- );
- } );
- it( 'should work correctly when selection is moved inside an exception', () => {
- setModelData( model, '<paragraph>[]foo bar baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>[]foo <$marker>bar</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>{}foo <span class="restricted-editing-exception">bar</span> baz</p>'
- );
- model.change( writer => writer.setSelection( model.document.getRoot().getChild( 0 ), 6 ) );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_selected">ba{}r</span> baz</p>'
- );
- } );
- describe( 'editing downcast conversion integration', () => {
- it( 'works for the #insert event', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.insertText( 'FOO', { linkHref: 'url' }, model.document.selection.getFirstPosition() );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_selected">bFOO{a}r</span> baz</p>'
- );
- } );
- it( 'works for the #remove event', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.remove( writer.createRange(
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 5 ),
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 6 )
- ) );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_selected">b{}r</span> baz</p>'
- );
- } );
- it( 'works for the #attribute event', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.setAttribute( 'bold', true, writer.createRange(
- model.document.selection.getFirstPosition().getShiftedBy( -1 ),
- model.document.selection.getFirstPosition().getShiftedBy( 1 ) )
- );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo ' +
- '<span class="restricted-editing-exception restricted-editing-exception_selected">' +
- '<strong>b{a</strong>' +
- '}r</span>' +
- ' baz</p>'
- );
- } );
- it( 'works for the #selection event', () => {
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- writer.setSelection( writer.createRange(
- model.document.selection.getFirstPosition().getShiftedBy( -1 ),
- model.document.selection.getFirstPosition().getShiftedBy( 1 ) )
- );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>foo {<span class="restricted-editing-exception restricted-editing-exception_selected">ba}r</span> baz</p>'
- );
- } );
- it( 'works for the addMarker and removeMarker events', () => {
- editor.conversion.for( 'editingDowncast' ).markerToHighlight( { model: 'fooMarker', view: {} } );
- setModelData( model, '<paragraph>foo b[a]r baz</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <$marker>b[a]r</$marker> baz</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- model.change( writer => {
- const range = writer.createRange(
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 0 ),
- writer.createPositionAt( model.document.getRoot().getChild( 0 ), 5 )
- );
- writer.addMarker( 'fooMarker', { range, usingOperation: true } );
- } );
- expect( getViewData( view ) ).to.equal(
- '<p>' +
- '<span>foo </span>' +
- '<span class="restricted-editing-exception restricted-editing-exception_selected">' +
- '<span>b</span>{a}r' +
- '</span>' +
- ' baz</p>'
- );
- model.change( writer => writer.removeMarker( 'fooMarker' ) );
- expect( getViewData( view ) ).to.equal(
- '<p>foo <span class="restricted-editing-exception restricted-editing-exception_selected">b{a}r</span> baz</p>'
- );
- } );
- } );
- } );
- describe( 'exception cycling with the keyboard', () => {
- let view, domEvtDataStub;
- beforeEach( async () => {
- editor = await VirtualTestEditor.create( {
- plugins: [ Paragraph, RestrictedEditingModeEditing, BoldEditing ]
- } );
- model = editor.model;
- view = editor.editing.view;
- domEvtDataStub = {
- keyCode: getCode( 'Tab' ),
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- sinon.spy( editor, 'execute' );
- } );
- afterEach( () => {
- return editor.destroy();
- } );
- it( 'should move to the closest next exception on tab key', () => {
- setModelData( model, '<paragraph>[]foo bar baz qux</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>[]foo <marker>bar</marker> baz qux</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- // <paragraph>[]foo <marker>bar</marker> <marker>baz</marker≥ qux</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:2', {
- range: writer.createRange( writer.createPositionAt( paragraph, 8 ), writer.createPositionAt( paragraph, 11 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( editor.execute );
- sinon.assert.calledWithExactly( editor.execute, 'goToNextRestrictedEditingException' );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- } );
- it( 'should not move to the closest next exception on tab key when there is none', () => {
- setModelData( model, '<paragraph>foo qux[]</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph><marker>foo</marker> qux[]</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 0 ), writer.createPositionAt( paragraph, 3 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( editor.execute );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- } );
- it( 'should move to the closest previous exception on shift+tab key', () => {
- setModelData( model, '<paragraph>foo bar baz qux[]</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>foo <marker>bar</marker> baz qux[]</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- // <paragraph>foo <marker>bar</marker> <marker>baz</marker≥ qux[]</paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:2', {
- range: writer.createRange( writer.createPositionAt( paragraph, 8 ), writer.createPositionAt( paragraph, 11 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- domEvtDataStub.keyCode += getCode( 'Shift' );
- view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( editor.execute );
- sinon.assert.calledWithExactly( editor.execute, 'goToPreviousRestrictedEditingException' );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- } );
- it( 'should not move to the closest previous exception on shift+tab key when there is none', () => {
- setModelData( model, '<paragraph>[]foo qux</paragraph>' );
- const paragraph = model.document.getRoot().getChild( 0 );
- // <paragraph>[]foo <marker>qux</marker></paragraph>
- model.change( writer => {
- writer.addMarker( 'restrictedEditingException:1', {
- range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- domEvtDataStub.keyCode += getCode( 'Shift' );
- view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( editor.execute );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- } );
- } );
- // Helper method that creates an exception marker inside given parent.
- // Marker range is set to given position offsets (start, end).
- function addExceptionMarker( startOffset, endOffset = startOffset, parent, id = 1 ) {
- model.change( writer => {
- writer.addMarker( `restrictedEditingException:${ id }`, {
- range: writer.createRange(
- writer.createPositionAt( parent, startOffset ),
- writer.createPositionAt( parent, endOffset )
- ),
- usingOperation: true,
- affectsData: true
- } );
- } );
- }
- } );
|