/** * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ import HighlightCommand from './../src/highlightcommand'; import Command from '@ckeditor/ckeditor5-core/src/command'; import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor'; import { getData, setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; describe( 'HighlightCommand', () => { let editor, model, doc, root, command; beforeEach( () => { return ModelTestEditor.create() .then( newEditor => { editor = newEditor; model = editor.model; doc = model.document; root = doc.getRoot(); command = new HighlightCommand( newEditor ); editor.commands.add( 'highlight', command ); model.schema.register( 'p', { inheritAllFrom: '$block' } ); model.schema.addAttributeCheck( ( ctx, attributeName ) => { // Allow 'highlight' on p>$text. if ( ctx.endsWith( 'p $text' ) && attributeName == 'highlight' ) { return true; } } ); } ); } ); afterEach( () => { editor.destroy(); } ); it( 'is a command', () => { expect( HighlightCommand.prototype ).to.be.instanceOf( Command ); expect( command ).to.be.instanceOf( Command ); } ); describe( 'value', () => { it( 'is set to highlight attribute value when selection is in text with highlight attribute', () => { setData( model, '
<$text highlight="yellowMarker">fo[o]$text>
' ); expect( command ).to.have.property( 'value', 'yellowMarker' ); } ); it( 'is undefined when selection is not in text with highlight attribute', () => { setData( model, 'fo[]o
' ); expect( command ).to.have.property( 'value', undefined ); } ); } ); describe( 'isEnabled', () => { beforeEach( () => { model.schema.register( 'x', { inheritAllFrom: '$block' } ); } ); it( 'is true when selection is on text which can have highlight added', () => { setData( model, 'fo[]o
' ); expect( command ).to.have.property( 'isEnabled', true ); } ); it( 'is false when selection is on text which can not have highlight added', () => { setData( model, 'abc<$text highlight="yellowMarker">foo[]bar$text>xyz
' ); expect( command.value ).to.equal( 'yellowMarker' ); command.execute( { value: 'greenMarker' } ); expect( getData( model ) ).to.equal( 'abc<$text highlight="greenMarker">foo[]bar$text>xyz
' ); expect( command.value ).to.equal( 'greenMarker' ); } ); it( 'should remove entire highlight when inside highlighted text of the same value', () => { setData( model, 'abc<$text highlight="yellowMarker">foo[]bar$text>xyz
' ); expect( command.value ).to.equal( 'yellowMarker' ); command.execute( { value: 'yellowMarker' } ); expect( getData( model ) ).to.equal( 'abcfoo[]barxyz
' ); expect( command.value ).to.be.undefined; } ); it( 'should change selection attribute in non-empty parent', () => { setData( model, 'a[]bc<$text highlight="yellowMarker">foobar$text>xyz
' ); expect( command.value ).to.be.undefined; command.execute( { value: 'foo' } ); expect( command.value ).to.equal( 'foo' ); expect( doc.selection.hasAttribute( 'highlight' ) ).to.be.true; command.execute(); expect( command.value ).to.be.undefined; expect( doc.selection.hasAttribute( 'highlight' ) ).to.be.false; // Execute remove highlight on selection without 'highlight' attribute should do nothing. command.execute(); expect( command.value ).to.be.undefined; expect( doc.selection.hasAttribute( 'highlight' ) ).to.be.false; } ); it( 'should not store attribute change on selection if selection is collapsed in non-empty parent', () => { setData( model, 'a[]bc<$text highlight="yellowMarker">foobar$text>xyz
' ); command.execute( { value: 'foo' } ); // It should not save that bold was executed at position ( root, [ 0, 1 ] ). model.change( writer => { // Simulate clicking right arrow key by changing selection ranges. writer.setSelection( root.getNodeByPath( [ 0 ] ), 2 ); // Get back to previous selection. writer.setSelection( root.getNodeByPath( [ 0 ] ), 1 ); } ); expect( command.value ).to.be.undefined; } ); it( 'should change selection attribute and store it if selection is collapsed in empty parent', () => { setData( model, 'abc<$text highlight="yellowMarker">foobar$text>xyz
[]
' ); expect( command.value ).to.be.undefined; command.execute( { value: 'foo' } ); expect( command.value ).to.equal( 'foo' ); expect( doc.selection.hasAttribute( 'highlight' ) ).to.be.true; // Attribute should be stored. // Simulate clicking somewhere else in the editor. model.change( writer => { writer.setSelection( root.getNodeByPath( [ 0 ] ), 2 ); } ); expect( command.value ).to.be.undefined; // Go back to where attribute was stored. model.change( writer => { writer.setSelection( root.getNodeByPath( [ 1 ] ), 0 ); } ); // Attribute should be restored. expect( command.value ).to.equal( 'foo' ); command.execute(); expect( command.value ).to.be.undefined; expect( doc.selection.hasAttribute( 'highlight' ) ).to.be.false; } ); // https://github.com/ckeditor/ckeditor5-highlight/issues/8 it( 'should change selection attribute on consecutive calls', () => { setData( model, 'abcfoobar[] foobar
' ); expect( command.value ).to.be.undefined; command.execute( { value: 'greenMarker' } ); expect( command.value ).to.equal( 'greenMarker' ); expect( doc.selection.getAttribute( 'highlight' ) ).to.equal( 'greenMarker' ); command.execute( { value: 'pinkMarker' } ); expect( command.value ).to.equal( 'pinkMarker' ); expect( doc.selection.getAttribute( 'highlight' ) ).to.equal( 'pinkMarker' ); } ); } ); describe( 'on not collapsed range', () => { it( 'should set highlight attribute on selected node when passed as parameter', () => { setData( model, 'a[bc<$text highlight="yellowMarker">fo]obar$text>xyz
' ); expect( command.value ).to.be.undefined; command.execute( { value: 'yellowMarker' } ); expect( command.value ).to.equal( 'yellowMarker' ); expect( getData( model ) ).to.equal( 'a[<$text highlight="yellowMarker">bcfo]obar$text>xyz
' ); } ); it( 'should set highlight attribute on selected node when passed as parameter (multiple nodes)', () => { setData( model, 'abcabc[abc
' + 'foofoofoo
' + 'barbar]bar
' ); command.execute( { value: 'yellowMarker' } ); expect( command.value ).to.equal( 'yellowMarker' ); expect( getData( model ) ).to.equal( 'abcabc[<$text highlight="yellowMarker">abc$text>
' + '<$text highlight="yellowMarker">foofoofoo$text>
' + '<$text highlight="yellowMarker">barbar$text>]bar
' ); } ); it( 'should set highlight attribute on selected nodes when passed as parameter only on selected characters', () => { setData( model, 'abc[<$text highlight="yellowMarker">foo]bar$text>xyz
' ); expect( command.value ).to.equal( 'yellowMarker' ); command.execute( { value: 'foo' } ); expect( getData( model ) ).to.equal( 'abc[<$text highlight="foo">foo$text>]<$text highlight="yellowMarker">bar$text>xyz
' ); expect( command.value ).to.equal( 'foo' ); } ); } ); } ); describe( 'with undefined option.value', () => { describe( 'on collapsed range', () => { it( 'should remove entire highlight when inside highlighted text', () => { setData( model, 'abc<$text highlight="yellowMarker">foo[]bar$text>xyz
' ); expect( command.value ).to.equal( 'yellowMarker' ); command.execute(); expect( getData( model ) ).to.equal( 'abcfoo[]barxyz
' ); expect( command.value ).to.be.undefined; } ); } ); describe( 'on not collapsed range', () => { it( 'should remove highlight attribute on selected node when undefined passed as parameter', () => { setData( model, 'abc[<$text highlight="yellowMarker">foo]bar$text>xyz
' ); expect( command.value ).to.equal( 'yellowMarker' ); command.execute(); expect( getData( model ) ).to.equal( 'abc[foo]<$text highlight="yellowMarker">bar$text>xyz
' ); expect( command.value ).to.be.undefined; } ); } ); } ); } ); } );