/** * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import Editor from '../../src/editor/editor'; import Document from '@ckeditor/ckeditor5-engine/src/model/document'; import Batch from '@ckeditor/ckeditor5-engine/src/model/batch'; import ToggleAttributeCommand from '../../src/command/toggleattributecommand'; import Range from '@ckeditor/ckeditor5-engine/src/model/range'; import Position from '@ckeditor/ckeditor5-engine/src/model/position'; import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; describe( 'ToggleAttributeCommand', () => { const attrKey = 'bold'; let editor, command, modelDoc, root; beforeEach( () => { editor = new Editor(); editor.document = new Document(); modelDoc = editor.document; root = modelDoc.createRoot(); command = new ToggleAttributeCommand( editor, attrKey ); modelDoc.schema.registerItem( 'p', '$block' ); modelDoc.schema.registerItem( 'h1', '$block' ); modelDoc.schema.registerItem( 'img', '$inline' ); // Allow block in "root" (DIV) modelDoc.schema.allow( { name: '$block', inside: '$root' } ); // Bold text is allowed only in P. modelDoc.schema.allow( { name: '$text', attributes: 'bold', inside: 'p' } ); modelDoc.schema.allow( { name: 'p', attributes: 'bold', inside: '$root' } ); // Disallow bold on image. modelDoc.schema.disallow( { name: 'img', attributes: 'bold', inside: '$root' } ); } ); afterEach( () => { command.destroy(); } ); describe( 'value', () => { it( 'should be set to true or false basing on selection attribute', () => { modelDoc.selection.setAttribute( attrKey, true ); expect( command.value ).to.be.true; modelDoc.selection.removeAttribute( attrKey ); expect( command.value ).to.be.false; } ); } ); describe( '_doExecute', () => { it( 'should add attribute on selected nodes if the command value was false', () => { setData( modelDoc, '
a[bc<$text bold="true">fo]obar$text>xyz
' ); expect( command.value ).to.be.false; command._doExecute(); expect( command.value ).to.be.true; expect( getData( modelDoc ) ).to.equal( 'a[<$text bold="true">bcfo]obar$text>xyz
' ); } ); it( 'should remove attribute from selected nodes if the command value was true', () => { setData( modelDoc, 'abc[<$text bold="true">foo]bar$text>xyz
' ); expect( command.value ).to.be.true; command._doExecute(); expect( getData( modelDoc ) ).to.equal( 'abc[foo]<$text bold="true">bar$text>xyz
' ); expect( command.value ).to.be.false; } ); it( 'should add attribute on selected nodes if execute parameter was set to true', () => { setData( modelDoc, 'abc<$text bold="true">foob[ar$text>x]yz
' ); expect( command.value ).to.be.true; command._doExecute( { forceValue: true } ); expect( command.value ).to.be.true; expect( getData( modelDoc ) ).to.equal( 'abc<$text bold="true">foob[arx$text>]yz
' ); } ); it( 'should remove attribute on selected nodes if execute parameter was set to false', () => { setData( modelDoc, 'a[bc<$text bold="true">fo]obar$text>xyz
' ); command._doExecute( { forceValue: false } ); expect( command.value ).to.be.false; expect( getData( modelDoc ) ).to.equal( 'a[bcfo]<$text bold="true">obar$text>xyz
' ); } ); it( 'should change selection attribute if selection is collapsed in non-empty parent', () => { setData( modelDoc, 'a[]bc<$text bold="true">foobar$text>xyz
' ); expect( command.value ).to.be.false; command._doExecute(); expect( command.value ).to.be.true; expect( modelDoc.selection.hasAttribute( 'bold' ) ).to.be.true; command._doExecute(); expect( command.value ).to.be.false; expect( modelDoc.selection.hasAttribute( 'bold' ) ).to.be.false; } ); it( 'should not store attribute change on selection if selection is collapsed in non-empty parent', () => { setData( modelDoc, 'a[]bc<$text bold="true">foobar$text>xyz
' ); command._doExecute(); // It should not save that bold was executed at position ( root, [ 0, 1 ] ). // Simulate clicking right arrow key by changing selection ranges. modelDoc.selection.setRanges( [ new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 0, 2 ] ) ) ] ); // Get back to previous selection. modelDoc.selection.setRanges( [ new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 1 ] ) ) ] ); expect( command.value ).to.be.false; } ); it( 'should change selection attribute and store it if selection is collapsed in empty parent', () => { setData( modelDoc, 'abc<$text bold="true">foobar$text>xyz
[]
' ); expect( command.value ).to.be.false; command._doExecute(); expect( command.value ).to.be.true; expect( modelDoc.selection.hasAttribute( 'bold' ) ).to.be.true; // Attribute should be stored. // Simulate clicking somewhere else in the editor. modelDoc.selection.setRanges( [ new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 0, 2 ] ) ) ] ); expect( command.value ).to.be.false; // Go back to where attribute was stored. modelDoc.selection.setRanges( [ new Range( new Position( root, [ 1, 0 ] ), new Position( root, [ 1, 0 ] ) ) ] ); // Attribute should be restored. expect( command.value ).to.be.true; command._doExecute(); expect( command.value ).to.be.false; expect( modelDoc.selection.hasAttribute( 'bold' ) ).to.be.false; } ); it( 'should not apply attribute change where it would invalid schema', () => { modelDoc.schema.registerItem( 'image', '$block' ); setData( modelDoc, 'ab[c<$text bold="true">foobar$text>xy
]z
ab[<$text bold="true">c$text><$text bold="true">foobarxy$text>
]z
a[bc<$text bold="true">fo]obar$text>xyz
' ); expect( batch.deltas.length ).to.equal( 0 ); command._doExecute( { batch } ); expect( batch.deltas.length ).to.equal( 1 ); expect( getData( modelDoc ) ).to.equal( 'a[<$text bold="true">bcfo]obar$text>xyz
' ); } ); describe( 'should cause firing model document changesDone event', () => { let spy; beforeEach( () => { spy = sinon.spy(); } ); it( 'collapsed selection in non-empty parent', () => { setData( modelDoc, 'x[]y
' ); modelDoc.on( 'changesDone', spy ); command._doExecute(); expect( spy.calledOnce ).to.be.true; } ); it( 'non-collapsed selection', () => { setData( modelDoc, '[xy]
' ); modelDoc.on( 'changesDone', spy ); command._doExecute(); expect( spy.calledOnce ).to.be.true; } ); it( 'in empty parent', () => { setData( modelDoc, '[]
' ); modelDoc.on( 'changesDone', spy ); command._doExecute(); expect( spy.calledOnce ).to.be.true; } ); } ); } ); describe( '_checkEnabled', () => { describe( '_checkEnabled', () => { // This test doesn't tests every possible case. // Method `_checkEnabled` uses `isAttributeAllowedInSelection` helper which is fully tested in his own test. beforeEach( () => { modelDoc.schema.registerItem( 'x', '$block' ); modelDoc.schema.disallow( { name: '$text', inside: 'x', attributes: 'link' } ); } ); describe( 'when selection is collapsed', () => { it( 'should return true if characters with the attribute can be placed at caret position', () => { setData( modelDoc, 'f[]oo
' ); expect( command._checkEnabled() ).to.be.true; } ); it( 'should return false if characters with the attribute cannot be placed at caret position', () => { setData( modelDoc, '[foo]
' ); expect( command._checkEnabled() ).to.be.true; } ); it( 'should return false if there are no nodes in selection that can have the attribute', () => { setData( modelDoc, '