|
|
@@ -0,0 +1,416 @@
|
|
|
+/**
|
|
|
+ * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
|
|
|
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
|
|
|
+ */
|
|
|
+
|
|
|
+/* global document */
|
|
|
+
|
|
|
+import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
|
|
|
+import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
|
|
|
+
|
|
|
+import RestrictedEditingEditing from './../src/restrictededitingediting';
|
|
|
+import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
|
|
|
+import { getData as getViewData } from '@ckeditor/ckeditor5-engine/src/dev-utils/view';
|
|
|
+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';
|
|
|
+
|
|
|
+describe( 'RestrictedEditingEditing', () => {
|
|
|
+ let editor, element;
|
|
|
+
|
|
|
+ testUtils.createSinonSandbox();
|
|
|
+
|
|
|
+ describe( 'plugin', () => {
|
|
|
+ beforeEach( async () => {
|
|
|
+ element = document.createElement( 'div' );
|
|
|
+ document.body.appendChild( element );
|
|
|
+
|
|
|
+ editor = await ClassicTestEditor.create( element, { plugins: [ RestrictedEditingEditing ] } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ afterEach( () => {
|
|
|
+ element.remove();
|
|
|
+
|
|
|
+ return editor.destroy();
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should be named', () => {
|
|
|
+ expect( RestrictedEditingEditing.pluginName ).to.equal( 'RestrictedEditingEditing' );
|
|
|
+ } );
|
|
|
+
|
|
|
+ it( 'should be loaded', () => {
|
|
|
+ expect( editor.plugins.get( RestrictedEditingEditing ) ).to.be.instanceOf( RestrictedEditingEditing );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'conversion', () => {
|
|
|
+ let model;
|
|
|
+
|
|
|
+ beforeEach( async () => {
|
|
|
+ editor = await VirtualTestEditor.create( { plugins: [ Paragraph, RestrictedEditingEditing ] } );
|
|
|
+ model = editor.model;
|
|
|
+ } );
|
|
|
+
|
|
|
+ afterEach( () => {
|
|
|
+ return editor.destroy();
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'upcast', () => {
|
|
|
+ it( 'should convert <span class="ck-restricted-editing-exception"> to marker', () => {
|
|
|
+ editor.setData( '<p>foo <span class="ck-restricted-editing-exception">bar</span> baz</p>' );
|
|
|
+
|
|
|
+ expect( model.markers.has( 'restricted-editing-exception:1' ) ).to.be.true;
|
|
|
+
|
|
|
+ const marker = model.markers.get( 'restricted-editing-exception: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="ck-restricted-editing-exception">', () => {
|
|
|
+ editor.setData(
|
|
|
+ '<p>foo <span class="ck-restricted-editing-exception">bar</span> baz</p>' +
|
|
|
+ '<p>ABCDEF<span class="ck-restricted-editing-exception">GHIJK</span>LMNOPQRST</p>'
|
|
|
+ );
|
|
|
+
|
|
|
+ expect( model.markers.has( 'restricted-editing-exception:1' ) ).to.be.true;
|
|
|
+ expect( model.markers.has( 'restricted-editing-exception: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( 'restricted-editing-exception: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( 'restricted-editing-exception: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( 'restricted-editing-exception:1', {
|
|
|
+ range: writer.createRange( writer.createPositionAt( paragraph, 4 ), writer.createPositionAt( paragraph, 7 ) ),
|
|
|
+ usingOperation: true,
|
|
|
+ affectsData: true
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ const expectedView = '<p>foo <span class="ck-restricted-editing-exception">bar</span> baz</p>';
|
|
|
+ expect( editor.getData() ).to.equal( expectedView );
|
|
|
+ expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal( expectedView );
|
|
|
+ } );
|
|
|
+
|
|
|
+ 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( 'restricted-editing-exception:1', {
|
|
|
+ range: writer.createRange( writer.createPositionAt( paragraph, 0 ), writer.createPositionAt( paragraph, 'end' ) ),
|
|
|
+ usingOperation: true,
|
|
|
+ affectsData: true
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ const expectedView = '<p><span class="ck-restricted-editing-exception"><b>foo bar baz</b></span></p>';
|
|
|
+ expect( editor.getData() ).to.equal( expectedView );
|
|
|
+ expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal( expectedView );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'editing behavior', () => {
|
|
|
+ let model;
|
|
|
+
|
|
|
+ beforeEach( async () => {
|
|
|
+ editor = await VirtualTestEditor.create( { plugins: [ Paragraph, RestrictedEditingEditing ] } );
|
|
|
+ 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( 'restricted-editing-exception:1', {
|
|
|
+ range: writer.createRange( writer.createPositionAt( firstParagraph, 4 ), writer.createPositionAt( firstParagraph, 7 ) ),
|
|
|
+ usingOperation: true,
|
|
|
+ affectsData: true
|
|
|
+ } );
|
|
|
+ writer.addMarker( 'restricted-editing-exception: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="ck-restricted-editing-exception">bar</span> baz</p>' +
|
|
|
+ '<p>xxx <span class="ck-restricted-editing-exception">yRyy</span> zzz</p>' );
|
|
|
+
|
|
|
+ expect( getViewData( editor.editing.view, { withoutSelection: true } ) ).to.equal(
|
|
|
+ '<p>foo <span class="ck-restricted-editing-exception">bar</span> baz</p>' +
|
|
|
+ '<p>xxx <span class="ck-restricted-editing-exception ck-restricted-editing-exception_selected">yRyy</span> zzz</p>' );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+
|
|
|
+ describe( 'exception highlighting', () => {
|
|
|
+ let model, view;
|
|
|
+
|
|
|
+ beforeEach( async () => {
|
|
|
+ editor = await VirtualTestEditor.create( {
|
|
|
+ plugins: [ Paragraph, RestrictedEditingEditing, 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( 'restricted-editing-exception: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="ck-restricted-editing-exception ck-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( 'restricted-editing-exception: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="ck-restricted-editing-exception ck-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="ck-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( 'restricted-editing-exception: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="ck-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="ck-restricted-editing-exception ck-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( 'restricted-editing-exception: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="ck-restricted-editing-exception ck-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( 'restricted-editing-exception: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="ck-restricted-editing-exception ck-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( 'restricted-editing-exception: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="ck-restricted-editing-exception ck-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( 'restricted-editing-exception: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="ck-restricted-editing-exception">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( 'restricted-editing-exception: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="ck-restricted-editing-exception ck-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="ck-restricted-editing-exception ck-restricted-editing-exception_selected">b{a}r</span> baz</p>'
|
|
|
+ );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+ } );
|
|
|
+} );
|