| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488 |
- /**
- * @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,
- '<paragraph>foo</paragraph>' +
- '<listItem listType="bulleted" listIndent="0">bulleted</listItem>' +
- '<listItem listType="numbered" listIndent="0">numbered</listItem>' +
- '<paragraph>bar</paragraph>' +
- '<widget>' +
- '<paragraph>xyz</paragraph>' +
- '</widget>'
- );
- 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, '<listItem listType="bulleted" listIndent="0">[a]</listItem>' );
- 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, '<paragraph>[a]</paragraph>' );
- 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, '<paragraph>[a</paragraph><widget>b]</widget>' );
- 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, '<widget><paragraph>[a</paragraph></widget><paragraph>b]</paragraph>' );
- 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, '<paragraph>fo[]o</paragraph>' );
- command.execute();
- expect( getData( model ) ).to.equal( '<listItem listIndent="0" listType="bulleted">fo[]o</listItem>' );
- } );
- it( 'should rename closest listItem to paragraph', () => {
- setData( model, '<listItem listIndent="0" listType="bulleted">fo[]o</listItem>' );
- command.execute();
- // Attributes will be removed by post fixer.
- expect( getData( model ) ).to.equal( '<paragraph listIndent="0" listType="bulleted">fo[]o</paragraph>' );
- } );
- it( 'should change closest listItem\' type', () => {
- setData( model, '<listItem listIndent="0" listType="numbered">fo[]o</listItem>' );
- command.execute();
- expect( getData( model ) ).to.equal( '<listItem listIndent="0" listType="bulleted">fo[]o</listItem>' );
- } );
- 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,
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">[]---</listItem>' +
- '<listItem listIndent="3" listType="bulleted">---</listItem>' +
- '<listItem listIndent="4" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>' +
- '<listItem listIndent="3" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>' +
- '<listItem listIndent="3" listType="bulleted">---</listItem>' +
- '<listItem listIndent="3" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>'
- );
- command.execute();
- const expectedData =
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<paragraph listIndent="2" listType="bulleted">[]---</paragraph>' + // Attributes will be removed by post fixer.
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>';
- expect( getData( model ) ).to.equal( expectedData );
- } );
- } );
- describe( 'non-collapsed selection', () => {
- beforeEach( () => {
- setData(
- model,
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<paragraph>---</paragraph>' +
- '<paragraph>---</paragraph>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>'
- );
- } );
- // 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,
- '<paragraph>a[bc</paragraph>' +
- '<restricted><fooBlock></fooBlock></restricted>' +
- '<paragraph>de]f</paragraph>'
- );
- command.execute();
- expect( getData( model ) ).to.equal(
- '<listItem listIndent="0" listType="bulleted">a[bc</listItem>' +
- '<restricted><fooBlock></fooBlock></restricted>' +
- '<listItem listIndent="0" listType="bulleted">de]f</listItem>'
- );
- } );
- 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,
- '<paragraph>a[bc</paragraph>' +
- '<image></image>' +
- '<paragraph>de]f</paragraph>'
- );
- command.execute();
- expect( getData( model ) ).to.equal(
- '<listItem listIndent="0" listType="bulleted">a[bc</listItem>' +
- '<image></image>' +
- '<listItem listIndent="0" listType="bulleted">de]f</listItem>'
- );
- } );
- 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 =
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">[---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---]</listItem>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>';
- 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 =
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<paragraph listIndent="0" listType="bulleted">[---</paragraph>' + // Attributes will be removed by post fixer.
- '<paragraph>---</paragraph>' +
- '<paragraph>---</paragraph>' +
- '<paragraph listIndent="0" listType="numbered">---]</paragraph>' + // Attributes will be removed by post fixer.
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>';
- 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 =
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<paragraph>---</paragraph>' +
- '<paragraph>---</paragraph>' +
- '<listItem listIndent="0" listType="bulleted">[---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">]---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>';
- 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 =
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<paragraph listIndent="0" listType="bulleted">[---</paragraph>' + // Attributes will be removed by post fixer.
- '<paragraph>---</paragraph>' +
- '<paragraph>---</paragraph>' +
- '<paragraph listIndent="0" listType="numbered">---</paragraph>' + // Attributes will be removed by post fixer.
- '<paragraph listIndent="0" listType="numbered">---]</paragraph>' + // Attributes will be removed by post fixer.
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>';
- 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,
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="numbered">---</listItem>' +
- '<listItem listIndent="2" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="numbered">---</listItem>' +
- '<listItem listIndent="2" listType="numbered">---</listItem>' +
- '<listItem listIndent="2" listType="numbered">-[-</listItem>' +
- '<listItem listIndent="1" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="numbered">---</listItem>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="numbered">-]-</listItem>' +
- '<listItem listIndent="1" listType="numbered">---</listItem>' +
- '<listItem listIndent="2" listType="numbered">---</listItem>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>'
- );
- // * ------ <-- 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 =
- '<listItem listIndent="0" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="numbered">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="bulleted">-[-</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="0" listType="bulleted">---</listItem>' +
- '<listItem listIndent="1" listType="bulleted">-]-</listItem>' +
- '<listItem listIndent="1" listType="bulleted">---</listItem>' +
- '<listItem listIndent="2" listType="numbered">---</listItem>' +
- '<listItem listIndent="0" listType="numbered">---</listItem>';
- expect( getData( model ) ).to.equal( expectedData );
- } );
- } );
- it( 'should fire "_executeCleanup" event after finish all operations with all changed items', done => {
- setData( model,
- '<paragraph>Foo 1.</paragraph>' +
- '<paragraph>[Foo 2.</paragraph>' +
- '<paragraph>Foo 3.]</paragraph>' +
- '<paragraph>Foo 4.</paragraph>'
- );
- command.execute();
- expect( getData( model ) ).to.equal(
- '<paragraph>Foo 1.</paragraph>' +
- '<listItem listIndent="0" listType="bulleted">[Foo 2.</listItem>' +
- '<listItem listIndent="0" listType="bulleted">Foo 3.]</listItem>' +
- '<paragraph>Foo 4.</paragraph>'
- );
- command.on( '_executeCleanup', ( evt, data ) => {
- expect( data ).to.deep.equal( [
- root.getChild( 2 ),
- root.getChild( 1 )
- ] );
- done();
- } );
- command.execute();
- } );
- } );
- } );
- } );
|