/**
* @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 ModelTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/modeltesteditor';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import { getData, setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
import { assertEqualMarkup } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
import TableSelection from '../../src/tableselection';
import TableEditing from '../../src/tableediting';
import { assertSelectedCells, modelTable } from '../_utils/utils';
import SetHeaderColumnCommand from '../../src/commands/setheadercolumncommand';
describe( 'SetHeaderColumnCommand', () => {
let editor, model, command;
beforeEach( () => {
return ModelTestEditor
.create( {
plugins: [ Paragraph, TableEditing, TableSelection ]
} )
.then( newEditor => {
editor = newEditor;
model = editor.model;
command = new SetHeaderColumnCommand( editor );
} );
} );
afterEach( () => {
return editor.destroy();
} );
describe( 'isEnabled', () => {
it( 'should be false if selection is not in a table', () => {
setData( model, 'foo[]' );
expect( command.isEnabled ).to.be.false;
} );
it( 'should be true if selection is in table', () => {
setData( model, '
' );
expect( command.isEnabled ).to.be.true;
} );
it( 'should be true if multiple columns are selected', () => {
setData( model, modelTable( [
[ '01', '02', '03' ]
] ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 0 ] ),
modelRoot.getNodeByPath( [ 0, 0, 1 ] )
);
expect( command.isEnabled ).to.be.true;
} );
it( 'should be true if multiple header columns are selected', () => {
setData( model, modelTable( [
[ '01', '02', '03' ]
], { headingColumns: 2 } ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 0 ] ),
modelRoot.getNodeByPath( [ 0, 0, 1 ] )
);
expect( command.isEnabled ).to.be.true;
} );
} );
describe( 'value', () => {
it( 'should be false if selection is not in a heading column', () => {
setData( model, modelTable( [
[ '01', '02' ],
[ '11', '12[]' ]
], { headingColumns: 1 } ) );
expect( command.value ).to.be.false;
} );
it( 'should be true if selection is in a heading column', () => {
setData( model, modelTable( [
[ '01[]', '02' ],
[ '11', '12' ]
], { headingColumns: 1 } ) );
expect( command.value ).to.be.true;
} );
it( 'should be true if multiple header columns are selected', () => {
setData( model, modelTable( [
[ '01', '02', '03' ]
], { headingColumns: 2 } ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 0 ] ),
modelRoot.getNodeByPath( [ 0, 0, 1 ] )
);
expect( command.value ).to.be.true;
} );
it( 'should be true if multiple header columns are selected in reversed order', () => {
setData( model, modelTable( [
[ '01', '02', '03' ]
], { headingColumns: 2 } ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 0 ] )
);
expect( command.value ).to.be.true;
} );
it( 'should be false if selection is in a heading row', () => {
setData( model, modelTable( [
[ '01', '02[]' ],
[ '11', '12' ]
], { headingRows: 1, headingColumns: 1 } ) );
expect( command.value ).to.be.false;
} );
it( 'should be false if only part of selected columns are headers', () => {
setData( model, modelTable( [
[ '01', '02', '03', '04' ]
], { headingColumns: 2 } ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 2 ] )
);
expect( command.value ).to.be.false;
} );
} );
describe( 'execute()', () => {
it( 'should set heading columns attribute that cover column with collapsed selection', () => {
setData( model, modelTable( [
[ '00', '01[]', '02', '03' ]
] ) );
command.execute();
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 2 } ) );
} );
it( 'should set heading columns attribute that cover column with entire cell selected', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ]
] ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 1 ] )
);
command.execute();
assertEqualMarkup( getData( model, { withoutSelection: true } ), modelTable( [
[ '00', '01', '02', '03' ]
], { headingColumns: 2 } ) );
assertSelectedCells( model, [
[ 0, 1, 0, 0 ]
] );
} );
it( 'should set heading columns attribute below current selection column', () => {
setData( model, modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 3 } ) );
command.execute();
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 1 } ) );
} );
it( 'should remove "headingColumns" attribute from table if no value was given', () => {
setData( model, modelTable( [
[ '[]00', '01', '02', '03' ]
], { headingColumns: 3 } ) );
command.execute();
assertEqualMarkup( getData( model ), modelTable( [
[ '[]00', '01', '02', '03' ]
] ) );
} );
describe( 'multi-cell selection', () => {
describe( 'setting header', () => {
it( 'should set it correctly in a middle of single-row, multiple cell selection', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ]
] ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 2 ] )
);
command.execute();
assertEqualMarkup( getData( model, { withoutSelection: true } ), modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 3
} ) );
assertSelectedCells( model, [
[ 0, 1, 1, 0 ]
] );
} );
it( 'should set it correctly in a middle of multi-row, multiple cell selection', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ],
[ '10', '11', '12', '13' ]
] ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 1, 1 ] )
);
command.execute();
assertEqualMarkup( getData( model, { withoutSelection: true } ), modelTable( [
[ '00', '01', '02', '03' ],
[ '10', '11', '12', '13' ]
], {
headingColumns: 2
} ) );
assertSelectedCells( model, [
[ 0, 1, 0, 0 ],
[ 0, 1, 0, 0 ]
] );
} );
it( 'should remove header columns in case of multiple cell selection', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ]
], { headingColumns: 4 } ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 2 ] )
);
command.execute();
assertEqualMarkup( getData( model, { withoutSelection: true } ), modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 1
} ) );
assertSelectedCells( model, [
[ 0, 1, 1, 0 ]
] );
} );
it( 'should remove header columns in case of multiple cell selection - reversed order', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 4
} ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 2 ] ),
modelRoot.getNodeByPath( [ 0, 0, 1 ] )
);
command.execute();
assertEqualMarkup( getData( model, {
withoutSelection: true
} ), modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 1
} ) );
assertSelectedCells( model, [
[ 0, 1, 1, 0 ]
] );
} );
it( 'should respect forceValue=true in case of multiple cell selection', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 3
} ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 2 ] )
);
command.execute( { forceValue: true } );
assertEqualMarkup( getData( model, {
withoutSelection: true
} ), modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 3
} ) );
assertSelectedCells( model, [
[ 0, 1, 1, 0 ]
] );
} );
it( 'should respect forceValue=false in case of multiple cell selection', () => {
setData( model, modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 1
} ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 1 ] ),
modelRoot.getNodeByPath( [ 0, 0, 2 ] )
);
command.execute( { forceValue: false } );
assertEqualMarkup( getData( model, {
withoutSelection: true
} ), modelTable( [
[ '00', '01', '02', '03' ]
], {
headingColumns: 1
} ) );
assertSelectedCells( model, [
[ 0, 1, 1, 0 ]
] );
} );
it( 'should set it correctly in table with more than 10 columns (array sort bug)', () => {
setData( model, modelTable( [
[ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14' ]
] ) );
const tableSelection = editor.plugins.get( TableSelection );
const modelRoot = model.document.getRoot();
tableSelection.setCellSelection(
modelRoot.getNodeByPath( [ 0, 0, 2 ] ),
modelRoot.getNodeByPath( [ 0, 0, 13 ] )
);
command.execute();
assertEqualMarkup( getData( model, { withoutSelection: true } ), modelTable( [
[ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14' ]
], { headingColumns: 14 } ) );
} );
} );
} );
it( 'should toggle of selected column', () => {
setData( model, modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 2 } ) );
command.execute();
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 1 } ) );
command.execute();
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 2 } ) );
} );
it( 'should respect forceValue parameter (forceValue=true)', () => {
setData( model, modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 3 } ) );
command.execute( { forceValue: true } );
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 3 } ) );
} );
it( 'should respect forceValue parameter (forceValue=false)', () => {
setData( model, modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 1 } ) );
command.execute( { forceValue: false } );
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '01[]', '02', '03' ]
], { headingColumns: 1 } ) );
} );
it( 'should fix col-spanned cells on the edge of an table heading columns section', () => {
// +----+----+----+
// | 00 | 01 |
// +----+ +
// | 10 | |
// +----+----+----+
// | 20 | 21 | 22 |
// +----+----+----+
// ^-- heading columns
setData( model, modelTable( [
[ '00', { contents: '[]01', colspan: 2, rowspan: 2 } ],
[ '10' ],
[ '20', '21', '22' ]
], { headingColumns: 1 } ) );
command.execute();
// +----+----+----+
// | 00 | 01 | |
// +----+ + +
// | 10 | | |
// +----+----+----+
// | 20 | 21 | 22 |
// +----+----+----+
// ^-- heading columns
assertEqualMarkup( getData( model ), modelTable( [
[ '00', { contents: '[]01', rowspan: 2 }, { contents: '', rowspan: 2 } ],
[ '10' ],
[ '20', '21', '22' ]
], { headingColumns: 2 } ) );
} );
it( 'should split to at most 2 table cells when fixing col-spanned cells on the edge of an table heading columns section', () => {
// +----+----+----+----+----+----+
// | 00 | 01 |
// +----+ +
// | 10 | |
// +----+----+----+----+----+----+
// | 20 | 21 | 22 | 23 | 24 | 25 |
// +----+----+----+----+----+----+
// ^-- heading columns
setData( model, modelTable( [
[ '00', { contents: '01', colspan: 5, rowspan: 2 } ],
[ '10' ],
[ '20', '21', '22[]', '23', '24', '25' ]
], { headingColumns: 1 } ) );
command.execute();
// +----+----+----+----+----+----+
// | 00 | 01 | |
// +----+ + +
// | 10 | | |
// +----+----+----+----+----+----+
// | 20 | 21 | 22 | 23 | 24 | 25 |
// +----+----+----+----+----+----+
// ^-- heading columns
assertEqualMarkup( getData( model ), modelTable( [
[ '00', { contents: '01', colspan: 2, rowspan: 2 }, { contents: '', colspan: 3, rowspan: 2 } ],
[ '10' ],
[ '20', '21', '22[]', '23', '24', '25' ]
], { headingColumns: 3 } ) );
} );
it( 'should fix col-spanned cells on the edge of an table heading columns section when creating section', () => {
// +----+----+
// | 00 |
// +----+----+
// | 10 | 11 |
// +----+----+
// ^-- heading columns
setData( model, modelTable( [
[ { contents: '00', colspan: 2 } ],
[ '10', '[]11' ]
], { headingColumns: 2 } ) );
command.execute();
// +----+----+
// | 00 | |
// +----+----+
// | 10 | 11 |
// +----+----+
// ^-- heading columns
assertEqualMarkup( getData( model ), modelTable( [
[ '00', '' ],
[ '10', '[]11' ]
], { headingColumns: 1 } ) );
} );
} );
} );