/**
* @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 Editor from '@ckeditor/ckeditor5-core/src/editor/editor';
import Model from '@ckeditor/ckeditor5-engine/src/model/model';
import ListCommand from '../src/listcommand';
import { setData, getData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
describe( 'ListCommand', () => {
let editor, command, model, doc, root;
beforeEach( () => {
editor = new Editor();
editor.model = new Model();
model = editor.model;
doc = model.document;
root = doc.createRoot();
command = new ListCommand( editor, 'bulleted' );
model.schema.register( 'listItem', {
inheritAllFrom: '$block',
allowAttributes: [ 'listType', 'listIndent' ]
} );
model.schema.register( 'paragraph', {
inheritAllFrom: '$block',
allowIn: 'widget'
} );
model.schema.register( 'widget', { inheritAllFrom: '$block' } );
model.schema.addChildCheck( ( ctx, childDef ) => {
if ( ctx.endsWith( 'widget' ) && childDef.name == 'listItem' ) {
return false;
}
} );
setData(
model,
'foo' +
'bulleted' +
'numbered' +
'bar' +
'' +
'xyz' +
''
);
model.change( writer => {
writer.setSelection( doc.getRoot().getChild( 0 ), 0 );
} );
} );
afterEach( () => {
command.destroy();
} );
describe( 'ListCommand', () => {
describe( 'constructor()', () => {
it( 'should create list command with given type and value set to false', () => {
expect( command.type ).to.equal( 'bulleted' );
expect( command.value ).to.be.false;
const numberedList = new ListCommand( editor, 'numbered' );
expect( numberedList.type ).to.equal( 'numbered' );
} );
} );
describe( 'value', () => {
it( 'should be false if first position in selection is not in a list item', () => {
model.change( writer => {
writer.setSelection( doc.getRoot().getChild( 3 ), 0 );
} );
expect( command.value ).to.be.false;
} );
it( 'should be false if first position in selection is in a list item of different type', () => {
model.change( writer => {
writer.setSelection( doc.getRoot().getChild( 2 ), 0 );
} );
expect( command.value ).to.be.false;
} );
it( 'should be true if first position in selection is in a list item of same type', () => {
model.change( writer => {
writer.setSelection( doc.getRoot().getChild( 1 ), 0 );
} );
expect( command.value ).to.be.true;
} );
} );
describe( 'isEnabled', () => {
it( 'should be true if entire selection is in a list', () => {
setData( model, '[a]' );
expect( command.isEnabled ).to.be.true;
} );
it( 'should be true if entire selection is in a block which can be turned into a list', () => {
setData( model, '[a]' );
expect( command.isEnabled ).to.be.true;
} );
it( 'should be true if selection first position is in a block which can be turned into a list', () => {
setData( model, '[ab]' );
expect( command.isEnabled ).to.be.true;
} );
it( 'should be false if selection first position is in an element which cannot be converted to a list item', () => {
setData( model, '[ab]' );
expect( command.isEnabled ).to.be.false;
} );
it( 'should be false in a root which does not allow blocks at all', () => {
doc.createRoot( 'paragraph', 'inlineOnlyRoot' );
setData( model, 'a[]b', { rootName: 'inlineOnlyRoot' } );
expect( command.isEnabled ).to.be.false;
} );
} );
describe( 'execute()', () => {
it( 'should use parent batch', () => {
model.change( writer => {
expect( writer.batch.operations.length ).to.equal( 0 );
command.execute();
expect( writer.batch.operations.length ).to.be.above( 0 );
} );
} );
describe( 'collapsed selection', () => {
it( 'should rename closest block to listItem and set correct attributes', () => {
setData( model, 'fo[]o' );
command.execute();
expect( getData( model ) ).to.equal( 'fo[]o' );
} );
it( 'should rename closest listItem to paragraph', () => {
setData( model, 'fo[]o' );
command.execute();
// Attributes will be removed by post fixer.
expect( getData( model ) ).to.equal( 'fo[]o' );
} );
it( 'should change closest listItem\' type', () => {
setData( model, 'fo[]o' );
command.execute();
expect( getData( model ) ).to.equal( 'fo[]o' );
} );
it( 'should handle outdenting sub-items when list item is turned off', () => {
/* eslint-disable max-len */
// Taken from docs.
//
// 1 * --------
// 2 * --------
// 3 * -------- <- this is turned off.
// 4 * -------- <- this has to become indent = 0, because it will be first item on a new list.
// 5 * -------- <- this should be still be a child of item above, so indent = 1.
// 6 * -------- <- this also has to become indent = 0, because it shouldn't end up as a child of any of items above.
// 7 * -------- <- this should be still be a child of item above, so indent = 1.
// 8 * -------- <- this has to become indent = 0.
// 9 * -------- <- this should still be a child of item above, so indent = 1.
// 10 * -------- <- this should still be a child of item above, so indent = 2.
// 11 * -------- <- this should still be at the same level as item above, so indent = 2.
// 12 * -------- <- this and all below are left unchanged.
// 13 * --------
// 14 * --------
//
// After turning off "3", the list becomes:
//
// 1 * --------
// 2 * --------
//
// 3 --------
//
// 4 * --------
// 5 * --------
// 6 * --------
// 7 * --------
// 8 * --------
// 9 * --------
// 10 * --------
// 11 * --------
// 12 * --------
// 13 * --------
// 14 * --------
/* eslint-enable max-len */
setData(
model,
'---' +
'---' +
'[]---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---'
);
command.execute();
const expectedData =
'---' +
'---' +
'[]---' + // Attributes will be removed by post fixer.
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---';
expect( getData( model ) ).to.equal( expectedData );
} );
} );
describe( 'non-collapsed selection', () => {
beforeEach( () => {
setData(
model,
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---' +
'---'
);
} );
// https://github.com/ckeditor/ckeditor5-list/issues/62
it( 'should not rename blocks which cannot become listItems (list item is not allowed in their parent)', () => {
model.schema.register( 'restricted' );
model.schema.extend( 'restricted', { allowIn: '$root' } );
model.schema.register( 'fooBlock', { inheritAllFrom: '$block' } );
model.schema.extend( 'fooBlock', { allowIn: 'restricted' } );
setData(
model,
'a[bc' +
'' +
'de]f'
);
command.execute();
expect( getData( model ) ).to.equal(
'a[bc' +
'' +
'de]f'
);
} );
it( 'should not rename blocks which cannot become listItems (block is an object)', () => {
model.schema.register( 'image', {
isBlock: true,
isObject: true,
allowIn: '$root'
} );
setData(
model,
'a[bc' +
'' +
'de]f'
);
command.execute();
expect( getData( model ) ).to.equal(
'a[bc' +
'' +
'de]f'
);
} );
it( 'should rename closest block to listItem and set correct attributes', () => {
// From first paragraph to second paragraph.
// Command value=false, we are turning on list items.
model.change( writer => {
writer.setSelection( writer.createRange(
writer.createPositionAt( root.getChild( 2 ), 0 ),
writer.createPositionAt( root.getChild( 3 ), 'end' )
) );
} );
command.execute();
const expectedData =
'---' +
'---' +
'[---' +
'---]' +
'---' +
'---' +
'---' +
'---';
expect( getData( model ) ).to.equal( expectedData );
} );
it( 'should rename closest listItem to paragraph', () => {
// From second bullet list item to first numbered list item.
// Command value=true, we are turning off list items.
model.change( writer => {
writer.setSelection( writer.createRange(
writer.createPositionAt( root.getChild( 1 ), 0 ),
writer.createPositionAt( root.getChild( 4 ), 'end' )
) );
} );
// Convert paragraphs, leave numbered list items.
command.execute();
const expectedData =
'---' +
'[---' + // Attributes will be removed by post fixer.
'---' +
'---' +
'---]' + // Attributes will be removed by post fixer.
'---' +
'---' +
'---';
expect( getData( model ) ).to.equal( expectedData );
} );
it( 'should change closest listItem\'s type', () => {
// From first numbered lsit item to third bulleted list item.
model.change( writer => {
writer.setSelection( writer.createRange(
writer.createPositionAt( root.getChild( 4 ), 0 ),
writer.createPositionAt( root.getChild( 6 ), 0 )
) );
} );
// Convert paragraphs, leave numbered list items.
command.execute();
const expectedData =
'---' +
'---' +
'---' +
'---' +
'[---' +
'---' +
']---' +
'---';
expect( getData( model ) ).to.equal( expectedData );
} );
it( 'should handle outdenting sub-items when list item is turned off', () => {
// From first numbered list item to third bulleted list item.
model.change( writer => {
writer.setSelection( writer.createRange(
writer.createPositionAt( root.getChild( 1 ), 0 ),
writer.createPositionAt( root.getChild( 5 ), 'end' )
) );
} );
// Convert paragraphs, leave numbered list items.
command.execute();
const expectedData =
'---' +
'[---' + // Attributes will be removed by post fixer.
'---' +
'---' +
'---' + // Attributes will be removed by post fixer.
'---]' + // Attributes will be removed by post fixer.
'---' +
'---';
expect( getData( model ) ).to.equal( expectedData );
} );
// Example from docs.
it( 'should change type of all items in nested list if one of items changed', () => {
setData(
model,
'---' +
'---' +
'---' +
'---' +
'---' +
'-[-' +
'---' +
'---' +
'---' +
'-]-' +
'---' +
'---' +
'---'
);
// * ------ <-- do not fix, top level item
// * ------ <-- fix, because latter list item of this item's list is changed
// * ------ <-- do not fix, item is not affected (different list)
// * ------ <-- fix, because latter list item of this item's list is changed
// * ------ <-- fix, because latter list item of this item's list is changed
// * ---[-- <-- already in selection
// * ------ <-- already in selection
// * ------ <-- already in selection
// * ------ <-- already in selection, but does not cause other list items to change because is top-level
// * ---]-- <-- already in selection
// * ------ <-- fix, because preceding list item of this item's list is changed
// * ------ <-- do not fix, item is not affected (different list)
// * ------ <-- do not fix, top level item
command.execute();
const expectedData =
'---' +
'---' +
'---' +
'---' +
'---' +
'-[-' +
'---' +
'---' +
'---' +
'-]-' +
'---' +
'---' +
'---';
expect( getData( model ) ).to.equal( expectedData );
} );
} );
it( 'should fire "_executeCleanup" event after finish all operations with all changed items', done => {
setData( model,
'Foo 1.' +
'[Foo 2.' +
'Foo 3.]' +
'Foo 4.'
);
command.execute();
expect( getData( model ) ).to.equal(
'Foo 1.' +
'[Foo 2.' +
'Foo 3.]' +
'Foo 4.'
);
command.on( '_executeCleanup', ( evt, data ) => {
expect( data ).to.deep.equal( [
root.getChild( 2 ),
root.getChild( 1 )
] );
done();
} );
command.execute();
} );
} );
} );
} );