| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257 |
- /**
- * @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, '<p>a[bc<$text bold="true">fo]obar</$text>xyz</p>' );
- expect( command.value ).to.be.false;
- command._doExecute();
- expect( command.value ).to.be.true;
- expect( getData( modelDoc ) ).to.equal( '<p>a[<$text bold="true">bcfo]obar</$text>xyz</p>' );
- } );
- it( 'should remove attribute from selected nodes if the command value was true', () => {
- setData( modelDoc, '<p>abc[<$text bold="true">foo]bar</$text>xyz</p>' );
- expect( command.value ).to.be.true;
- command._doExecute();
- expect( getData( modelDoc ) ).to.equal( '<p>abc[foo]<$text bold="true">bar</$text>xyz</p>' );
- expect( command.value ).to.be.false;
- } );
- it( 'should add attribute on selected nodes if execute parameter was set to true', () => {
- setData( modelDoc, '<p>abc<$text bold="true">foob[ar</$text>x]yz</p>' );
- expect( command.value ).to.be.true;
- command._doExecute( { forceValue: true } );
- expect( command.value ).to.be.true;
- expect( getData( modelDoc ) ).to.equal( '<p>abc<$text bold="true">foob[arx</$text>]yz</p>' );
- } );
- it( 'should remove attribute on selected nodes if execute parameter was set to false', () => {
- setData( modelDoc, '<p>a[bc<$text bold="true">fo]obar</$text>xyz</p>' );
- command._doExecute( { forceValue: false } );
- expect( command.value ).to.be.false;
- expect( getData( modelDoc ) ).to.equal( '<p>a[bcfo]<$text bold="true">obar</$text>xyz</p>' );
- } );
- it( 'should change selection attribute if selection is collapsed in non-empty parent', () => {
- setData( modelDoc, '<p>a[]bc<$text bold="true">foobar</$text>xyz</p><p></p>' );
- 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, '<p>a[]bc<$text bold="true">foobar</$text>xyz</p>' );
- 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, '<p>abc<$text bold="true">foobar</$text>xyz</p><p>[]</p>' );
- 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, '<p>ab[c<img></img><$text bold="true">foobar</$text>xy<img></img>]z</p>' );
- expect( command.isEnabled ).to.be.true;
- command._doExecute();
- expect( getData( modelDoc ) )
- .to.equal( '<p>ab[<$text bold="true">c</$text><img></img><$text bold="true">foobarxy</$text><img></img>]z</p>' );
- } );
- it( 'should use provided batch for storing undo steps', () => {
- const batch = new Batch( new Document() );
- setData( modelDoc, '<p>a[bc<$text bold="true">fo]obar</$text>xyz</p>' );
- expect( batch.deltas.length ).to.equal( 0 );
- command._doExecute( { batch } );
- expect( batch.deltas.length ).to.equal( 1 );
- expect( getData( modelDoc ) ).to.equal( '<p>a[<$text bold="true">bcfo]obar</$text>xyz</p>' );
- } );
- describe( 'should cause firing model document changesDone event', () => {
- let spy;
- beforeEach( () => {
- spy = sinon.spy();
- } );
- it( 'collapsed selection in non-empty parent', () => {
- setData( modelDoc, '<p>x[]y</p>' );
- modelDoc.on( 'changesDone', spy );
- command._doExecute();
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'non-collapsed selection', () => {
- setData( modelDoc, '<p>[xy]</p>' );
- modelDoc.on( 'changesDone', spy );
- command._doExecute();
- expect( spy.calledOnce ).to.be.true;
- } );
- it( 'in empty parent', () => {
- setData( modelDoc, '<p>[]</p>' );
- 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, '<p>f[]oo</p>' );
- expect( command._checkEnabled() ).to.be.true;
- } );
- it( 'should return false if characters with the attribute cannot be placed at caret position', () => {
- setData( modelDoc, '<x>fo[]o</x>' );
- expect( command._checkEnabled() ).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( modelDoc, '<p>[foo]</p>' );
- expect( command._checkEnabled() ).to.be.true;
- } );
- it( 'should return false if there are no nodes in selection that can have the attribute', () => {
- setData( modelDoc, '<x>[foo]</x>' );
- expect( command._checkEnabled() ).to.be.false;
- } );
- } );
- } );
- } );
- } );
|