/** * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import AttributeCommand from '../src/attributecommand'; import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor'; import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; describe( 'AttributeCommand', () => { const attrKey = 'bold'; let editor, command, model, doc, root; beforeEach( () => { return ModelTestEditor .create() .then( newEditor => { editor = newEditor; model = editor.model; doc = model.document; root = doc.getRoot(); command = new AttributeCommand( editor, attrKey ); model.schema.register( 'p', { inheritAllFrom: '$block' } ); model.schema.register( 'h1', { inheritAllFrom: '$block' } ); model.schema.register( 'img', { allowWhere: [ '$block', '$text' ], isObject: true } ); model.schema.addAttributeCheck( ( ctx, attributeName ) => { // Allow 'bold' on p>$text. if ( ctx.endsWith( 'p $text' ) && attributeName == 'bold' ) { return true; } } ); } ); } ); afterEach( () => { command.destroy(); return editor.destroy(); } ); describe( 'value', () => { it( 'is true when collapsed selection has the attribute', () => { model.change( writer => { writer.setSelectionAttribute( attrKey, true ); } ); expect( command.value ).to.be.true; } ); it( 'is false when collapsed selection does not have the attribute', () => { model.change( writer => { writer.setSelectionAttribute( attrKey, true ); } ); model.change( writer => { writer.removeSelectionAttribute( attrKey ); } ); expect( command.value ).to.be.false; } ); it( 'is true when the first item that allows attribute has the attribute set #1', () => { setData( model, '

<$text bold="true">fo[o

b]ar

' ); expect( command.value ).to.be.true; } ); it( 'is true when the first item that allows attribute has the attribute set #2', () => { setData( model, '

fo[o

<$text bold="true">fo]o

' ); expect( command.value ).to.be.true; } ); it( 'is false when the first item that allows attribute does not have the attribute set #1', () => { setData( model, '

b[a<$text bold="true">r

fo]o

' ); expect( command.value ).to.be.false; } ); it( 'is false when the first item that allows attribute does not have the attribute set #2', () => { setData( model, '

fo[o

b<$text bold="true">rr]

' ); expect( command.value ).to.be.false; } ); it( 'is true when the first item that allows attribute has the attribute set - object with nested editable', () => { model.schema.register( 'caption', { allowContentOf: '$block', allowIn: 'img', isLimit: true } ); model.schema.extend( '$text', { allowIn: 'caption', allowAttributes: 'bold' } ); setData( model, '

[Some caption inside the image.]

' ); expect( command.value ).to.be.false; command.execute(); expect( command.value ).to.be.true; expect( getData( model ) ).to.equal( '

[<$text bold="true">Some caption inside the image.]

' ); } ); } ); describe( 'isEnabled', () => { // This test doesn't tests every possible case. // Method `refresh()` uses `checkAttributeInSelection()` which is fully tested in its own test. beforeEach( () => { model.schema.register( 'x', { inheritAllFrom: '$block' } ); } ); describe( 'when selection is collapsed', () => { it( 'should return true if characters with the attribute can be placed at caret position', () => { setData( model, '

f[]oo

' ); expect( command.isEnabled ).to.be.true; } ); it( 'should return false if characters with the attribute cannot be placed at caret position', () => { setData( model, 'fo[]o' ); expect( command.isEnabled ).to.be.false; } ); } ); describe( 'when selection is not collapsed', () => { it( 'should return true if there is at least one node in selection that can have the attribute', () => { setData( model, '

[foo]

' ); expect( command.isEnabled ).to.be.true; } ); it( 'should return false if there are no nodes in selection that can have the attribute', () => { setData( model, '[foo]' ); expect( command.isEnabled ).to.be.false; } ); } ); } ); describe( 'execute()', () => { it( 'should do nothing if the command is disabled', () => { setData( model, '

fo[ob]ar

' ); command.isEnabled = false; command.execute(); expect( getData( model ) ).to.equal( '

fo[ob]ar

' ); } ); it( 'should add attribute on selected nodes if the command value was false', () => { setData( model, '

a[bc<$text bold="true">fo]obarxyz

' ); expect( command.value ).to.be.false; command.execute(); expect( command.value ).to.be.true; expect( getData( model ) ).to.equal( '

a[<$text bold="true">bcfo]obarxyz

' ); } ); it( 'should remove attribute from selected nodes if the command value was true', () => { setData( model, '

abc[<$text bold="true">foo]barxyz

' ); expect( command.value ).to.be.true; command.execute(); expect( getData( model ) ).to.equal( '

abc[foo]<$text bold="true">barxyz

' ); expect( command.value ).to.be.false; } ); it( 'should add attribute on selected nodes if execute parameter was set to true', () => { setData( model, '

abc<$text bold="true">foob[arx]yz

' ); expect( command.value ).to.be.true; command.execute( { forceValue: true } ); expect( command.value ).to.be.true; expect( getData( model ) ).to.equal( '

abc<$text bold="true">foob[arx]yz

' ); } ); it( 'should remove attribute on selected nodes if execute parameter was set to false', () => { setData( model, '

a[bc<$text bold="true">fo]obarxyz

' ); command.execute( { forceValue: false } ); expect( command.value ).to.be.false; expect( getData( model ) ).to.equal( '

a[bcfo]<$text bold="true">obarxyz

' ); } ); it( 'should change selection attribute if selection is collapsed in non-empty parent', () => { setData( model, '

a[]bc<$text bold="true">foobarxyz

' ); expect( command.value ).to.be.false; command.execute(); expect( command.value ).to.be.true; expect( doc.selection.hasAttribute( 'bold' ) ).to.be.true; command.execute(); expect( command.value ).to.be.false; expect( doc.selection.hasAttribute( 'bold' ) ).to.be.false; } ); it( 'should not store attribute change on selection if selection is collapsed in non-empty parent', () => { setData( model, '

a[]bc<$text bold="true">foobarxyz

' ); command.execute(); // 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( writer.createRange( writer.createPositionAt( root.getNodeByPath( [ 0 ] ), 2 ) ) ); // Get back to previous selection. writer.setSelection( writer.createRange( writer.createPositionAt( root.getNodeByPath( [ 0 ] ), 1 ) ) ); } ); expect( command.value ).to.be.false; } ); it( 'should change selection attribute and store it if selection is collapsed in empty parent', () => { setData( model, '

abc<$text bold="true">foobarxyz

[]

' ); expect( command.value ).to.be.false; command.execute(); expect( command.value ).to.be.true; expect( doc.selection.hasAttribute( 'bold' ) ).to.be.true; // Attribute should be stored. // Simulate clicking somewhere else in the editor. model.change( writer => { writer.setSelection( [ writer.createRange( writer.createPositionAt( root.getNodeByPath( [ 0 ] ), 2 ) ) ] ); } ); expect( command.value ).to.be.false; // Go back to where attribute was stored. model.change( writer => { writer.setSelection( writer.createRange( writer.createPositionAt( root.getNodeByPath( [ 1 ] ), 0 ) ) ); } ); // Attribute should be restored. expect( command.value ).to.be.true; command.execute(); expect( command.value ).to.be.false; expect( doc.selection.hasAttribute( 'bold' ) ).to.be.false; } ); it( 'should not apply attribute change where it would invalid schema', () => { model.schema.register( 'image', { inheritAllFrom: '$block' } ); setData( model, '

ab[c<$text bold="true">foobarxy]z

' ); expect( command.isEnabled ).to.be.true; command.execute(); expect( getData( model ) ) .to.equal( '

ab[<$text bold="true">c<$text bold="true">foobarxy]z

' ); } ); it( 'should use parent batch for storing undo steps', () => { setData( model, '

a[bc<$text bold="true">fo]obarxyz

' ); model.change( writer => { expect( writer.batch.operations.length ).to.equal( 0 ); command.execute(); expect( writer.batch.operations.length ).to.equal( 1 ); } ); expect( getData( model ) ).to.equal( '

a[<$text bold="true">bcfo]obarxyz

' ); } ); describe( 'should cause firing model change event', () => { let spy; beforeEach( () => { spy = sinon.spy(); } ); it( 'collapsed selection in non-empty parent', () => { setData( model, '

x[]y

' ); model.document.on( 'change', spy ); command.execute(); expect( spy.called ).to.be.true; } ); it( 'non-collapsed selection', () => { setData( model, '

[xy]

' ); model.document.on( 'change', spy ); command.execute(); expect( spy.called ).to.be.true; } ); it( 'in empty parent', () => { setData( model, '

[]

' ); model.document.on( 'change', spy ); command.execute(); expect( spy.called ).to.be.true; } ); } ); } ); } );