/** * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ import ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor'; import ParagraphCommand from '@ckeditor/ckeditor5-paragraph/src/paragraphcommand'; import HeadingCommand from '../src/headingcommand'; import Range from '@ckeditor/ckeditor5-engine/src/model/range'; import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; const options = [ { model: 'heading1', view: { name: 'h2' }, title: 'H2' }, { model: 'heading2', view: { name: 'h3' }, title: 'H3' }, { model: 'heading3', view: { name: 'h4' }, title: 'H4' } ]; describe( 'HeadingCommand', () => { let editor, model, document, command, root, schema; beforeEach( () => { return ModelTestEditor.create().then( newEditor => { editor = newEditor; model = editor.model; document = model.document; schema = model.schema; editor.commands.add( 'paragraph', new ParagraphCommand( editor ) ); schema.register( 'paragraph', { inheritAllFrom: '$block' } ); const modelElements = []; for ( const option of options ) { modelElements.push( option.model ); schema.register( option.model, { inheritAllFrom: '$block' } ); } command = new HeadingCommand( editor, modelElements ); editor.commands.add( 'heading', command ); schema.register( 'heading', { inheritAllFrom: '$block' } ); schema.register( 'notBlock' ); schema.extend( 'notBlock', { allowIn: '$root' } ); schema.extend( '$text', { allowIn: 'notBlock' } ); root = document.getRoot(); } ); } ); describe( 'modelElements', () => { it( 'is set', () => { expect( command.modelElements ).to.deep.equal( [ 'heading1', 'heading2', 'heading3' ] ); } ); } ); describe( 'value', () => { for ( const option of options ) { test( option ); } function test( { model: modelElement } ) { it( `equals ${ modelElement } when collapsed selection is placed inside ${ modelElement } element`, () => { setData( model, `<${ modelElement }>foobar` ); const element = root.getChild( 0 ); model.change( writer => { const ranges = [ ...model.document.selection.getRanges(), Range.createFromParentsAndOffsets( element, 3, element, 3 ) ]; writer.setSelection( ranges ); } ); expect( command.value ).to.equal( modelElement ); } ); it( 'equals false if inside to non-block element', () => { setData( model, '[foo]' ); expect( command.value ).to.be.false; } ); it( `equals false if moved from ${ modelElement } to non-block element`, () => { setData( model, `<${ modelElement }>[foo]foo` ); const element = document.getRoot().getChild( 1 ); model.change( writer => { writer.setSelection( Range.createIn( element ) ); } ); expect( command.value ).to.be.false; } ); it( 'should be refreshed after calling refresh()', () => { setData( model, `<${ modelElement }>[foo]foo` ); const element = document.getRoot().getChild( 1 ); model.change( writer => { writer.setSelection( Range.createIn( element ) ); expect( command.value ).to.equal( modelElement ); command.refresh(); expect( command.value ).to.be.false; } ); } ); } } ); describe( 'execute()', () => { it( 'should update value after execution', () => { setData( model, '[]' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( '[]' ); expect( command.value ).to.equal( 'heading1' ); } ); // https://github.com/ckeditor/ckeditor5-heading/issues/73 it( 'should not rename blocks which cannot become headings (heading is not allowed in their parent)', () => { schema.register( 'restricted' ); schema.extend( 'restricted', { allowIn: '$root' } ); schema.register( 'fooBlock', { inheritAllFrom: '$block' } ); schema.extend( 'fooBlock', { allowIn: [ 'restricted', '$root' ] } ); setData( model, 'a[bc' + '' + 'de]f' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( 'a[bc' + '' + 'de]f' ); } ); it( 'should not rename blocks which cannot become headings (block is an object)', () => { schema.register( 'image', { isBlock: true, isObject: true, allowIn: '$root' } ); setData( model, 'a[bc' + '' + 'de]f' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( 'a[bc' + '' + 'de]f' ); } ); it( 'should use parent batch', () => { setData( model, 'foo[]bar' ); model.change( writer => { expect( writer.batch.deltas.length ).to.equal( 0 ); command.execute( { value: 'heading1' } ); expect( writer.batch.deltas.length ).to.be.above( 0 ); } ); } ); it( 'should do nothing on non-registered model elements', () => { setData( model, '[]' ); command.execute( { value: 'paragraph' } ); expect( getData( model ) ).to.equal( '[]' ); expect( command.value ).to.equal( 'heading1' ); } ); it( 'should do nothing when empty value is passed', () => { setData( model, '[]' ); command.execute(); expect( getData( model ) ).to.equal( '[]' ); expect( command.value ).to.equal( 'heading1' ); } ); describe( 'collapsed selection', () => { let convertTo = options[ options.length - 1 ]; for ( const option of options ) { test( option, convertTo ); convertTo = option; } it( 'does nothing when executed with already applied option', () => { setData( model, 'foo[]bar' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( 'foo[]bar' ); } ); it( 'converts topmost blocks', () => { schema.register( 'inlineImage', { allowWhere: '$text' } ); schema.extend( '$text', { allowIn: 'inlineImage' } ); setData( model, 'foo[]bar' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( 'foo[]bar' ); } ); function test( from, to ) { it( `converts ${ from.model } to ${ to.model } on collapsed selection`, () => { setData( model, `<${ from.model }>foo[]bar` ); command.execute( { value: to.model } ); expect( getData( model ) ).to.equal( `<${ to.model }>foo[]bar` ); } ); } } ); describe( 'non-collapsed selection', () => { let convertTo = options[ options.length - 1 ]; for ( const option of options ) { test( option, convertTo ); convertTo = option; } it( 'converts all elements where selection is applied', () => { setData( model, 'foo[barbaz]' ); command.execute( { value: 'heading3' } ); expect( getData( model ) ).to.equal( 'foo[barbaz]' ); } ); it( 'does nothing to the elements with same option (#1)', () => { setData( model, '[foobar]' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( '[foobar]' ); } ); it( 'does nothing to the elements with same option (#2)', () => { setData( model, '[foobarbaz]' ); command.execute( { value: 'heading1' } ); expect( getData( model ) ).to.equal( '[foobarbaz]' ); } ); function test( { model: fromElement }, { model: toElement } ) { it( `converts ${ fromElement } to ${ toElement } on non-collapsed selection`, () => { setData( model, `<${ fromElement }>foo[bar<${ fromElement }>baz]qux` ); command.execute( { value: toElement } ); expect( getData( model ) ).to.equal( `<${ toElement }>foo[bar<${ toElement }>baz]qux` ); } ); } } ); } ); describe( 'isEnabled', () => { for ( const option of options ) { test( option.model ); } function test( modelElement ) { describe( `${ modelElement } command`, () => { it( 'should be enabled when inside another block', () => { setData( model, 'f{}oo' ); expect( command.isEnabled ).to.be.true; } ); it( 'should be disabled if inside non-block', () => { setData( model, 'f{}oo' ); expect( command.isEnabled ).to.be.false; } ); it( 'should be disabled if selection is placed on non-block', () => { setData( model, '[foo]' ); expect( command.isEnabled ).to.be.false; } ); } ); } } ); } );