/**
* @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 Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
import { getData as getModelData, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
import ImageEditing from '@ckeditor/ckeditor5-image/src/image/imageediting';
import TableEditing from '../src/tableediting';
import { modelTable } from './_utils/utils';
import InsertRowCommand from '../src/commands/insertrowcommand';
import InsertTableCommand from '../src/commands/inserttablecommand';
import InsertColumnCommand from '../src/commands/insertcolumncommand';
import RemoveRowCommand from '../src/commands/removerowcommand';
import RemoveColumnCommand from '../src/commands/removecolumncommand';
import SelectRowCommand from '../src/commands/selectrowcommand';
import SelectColumnCommand from '../src/commands/selectcolumncommand';
import SplitCellCommand from '../src/commands/splitcellcommand';
import MergeCellCommand from '../src/commands/mergecellcommand';
import SetHeaderRowCommand from '../src/commands/setheaderrowcommand';
import SetHeaderColumnCommand from '../src/commands/setheadercolumncommand';
import MediaEmbedEditing from '@ckeditor/ckeditor5-media-embed/src/mediaembedediting';
import { assertEqualMarkup } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
describe( 'TableEditing', () => {
let editor, model;
beforeEach( () => {
return VirtualTestEditor
.create( {
plugins: [ TableEditing, Paragraph, ImageEditing, MediaEmbedEditing ]
} )
.then( newEditor => {
editor = newEditor;
model = editor.model;
} );
} );
afterEach( () => {
editor.destroy();
} );
it( 'should have pluginName', () => {
expect( TableEditing.pluginName ).to.equal( 'TableEditing' );
} );
it( 'should set proper schema rules', () => {
// Table:
expect( model.schema.isRegistered( 'table' ) ).to.be.true;
expect( model.schema.isObject( 'table' ) ).to.be.true;
expect( model.schema.isBlock( 'table' ) ).to.be.true;
expect( model.schema.checkChild( [ '$root' ], 'table' ) ).to.be.true;
expect( model.schema.checkAttribute( [ '$root', 'table' ], 'headingRows' ) ).to.be.true;
expect( model.schema.checkAttribute( [ '$root', 'table' ], 'headingColumns' ) ).to.be.true;
// Table row:
expect( model.schema.isRegistered( 'tableRow' ) ).to.be.true;
expect( model.schema.isLimit( 'tableRow' ) ).to.be.true;
expect( model.schema.checkChild( [ '$root' ], 'tableRow' ) ).to.be.false;
expect( model.schema.checkChild( [ 'table' ], 'tableRow' ) ).to.be.true;
// Table cell:
expect( model.schema.isRegistered( 'tableCell' ) ).to.be.true;
expect( model.schema.isLimit( 'tableCell' ) ).to.be.true;
expect( model.schema.isObject( 'tableCell' ) ).to.be.false;
expect( model.schema.isSelectable( 'tableCell' ) ).to.be.true;
expect( model.schema.checkChild( [ '$root' ], 'tableCell' ) ).to.be.false;
expect( model.schema.checkChild( [ 'table' ], 'tableCell' ) ).to.be.false;
expect( model.schema.checkChild( [ 'tableRow' ], 'tableCell' ) ).to.be.true;
expect( model.schema.checkChild( [ 'tableCell' ], 'tableCell' ) ).to.be.false;
expect( model.schema.checkAttribute( [ 'tableCell' ], 'colspan' ) ).to.be.true;
expect( model.schema.checkAttribute( [ 'tableCell' ], 'rowspan' ) ).to.be.true;
// Table cell contents:
expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], '$text' ) ).to.be.false;
expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], '$block' ) ).to.be.true;
expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], 'table' ) ).to.be.false;
expect( model.schema.checkChild( [ '$root', 'table', 'tableRow', 'tableCell' ], 'image' ) ).to.be.true;
} );
it( 'adds insertTable command', () => {
expect( editor.commands.get( 'insertTable' ) ).to.be.instanceOf( InsertTableCommand );
} );
it( 'adds insertRowAbove command', () => {
expect( editor.commands.get( 'insertTableRowAbove' ) ).to.be.instanceOf( InsertRowCommand );
} );
it( 'adds insertRowBelow command', () => {
expect( editor.commands.get( 'insertTableRowBelow' ) ).to.be.instanceOf( InsertRowCommand );
} );
it( 'adds insertColumnLeft command', () => {
expect( editor.commands.get( 'insertTableColumnLeft' ) ).to.be.instanceOf( InsertColumnCommand );
} );
it( 'adds insertColumnRight command', () => {
expect( editor.commands.get( 'insertTableColumnRight' ) ).to.be.instanceOf( InsertColumnCommand );
} );
it( 'adds removeRow command', () => {
expect( editor.commands.get( 'removeTableRow' ) ).to.be.instanceOf( RemoveRowCommand );
} );
it( 'adds removeColumn command', () => {
expect( editor.commands.get( 'removeTableColumn' ) ).to.be.instanceOf( RemoveColumnCommand );
} );
it( 'adds selectRow command', () => {
expect( editor.commands.get( 'selectTableRow' ) ).to.be.instanceOf( SelectRowCommand );
} );
it( 'adds selectColumn command', () => {
expect( editor.commands.get( 'selectTableColumn' ) ).to.be.instanceOf( SelectColumnCommand );
} );
it( 'adds splitCellVertically command', () => {
expect( editor.commands.get( 'splitTableCellVertically' ) ).to.be.instanceOf( SplitCellCommand );
} );
it( 'adds splitCellHorizontally command', () => {
expect( editor.commands.get( 'splitTableCellHorizontally' ) ).to.be.instanceOf( SplitCellCommand );
} );
it( 'adds mergeCellRight command', () => {
expect( editor.commands.get( 'mergeTableCellRight' ) ).to.be.instanceOf( MergeCellCommand );
} );
it( 'adds mergeCellLeft command', () => {
expect( editor.commands.get( 'mergeTableCellLeft' ) ).to.be.instanceOf( MergeCellCommand );
} );
it( 'adds mergeCellDown command', () => {
expect( editor.commands.get( 'mergeTableCellDown' ) ).to.be.instanceOf( MergeCellCommand );
} );
it( 'adds mergeCellUp command', () => {
expect( editor.commands.get( 'mergeTableCellUp' ) ).to.be.instanceOf( MergeCellCommand );
} );
it( 'adds setColumnHeader command', () => {
expect( editor.commands.get( 'setTableColumnHeader' ) ).to.be.instanceOf( SetHeaderColumnCommand );
} );
it( 'adds setRowHeader command', () => {
expect( editor.commands.get( 'setTableRowHeader' ) ).to.be.instanceOf( SetHeaderRowCommand );
} );
describe( 'conversion in data pipeline', () => {
describe( 'model to view', () => {
it( 'should create tbody section', () => {
setModelData( model, '
' );
expect( editor.getData() ).to.equal(
'' +
'' +
''
);
} );
it( 'should create thead section', () => {
setModelData(
model,
''
);
expect( editor.getData() ).to.equal(
'' +
'' +
''
);
} );
} );
describe( 'view to model', () => {
it( 'should convert table', () => {
editor.setData( '' );
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '' );
} );
it( 'should convert table with image', () => {
editor.setData( '' );
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '' );
} );
it( 'should insert a paragraph when the cell content is unsupported', () => {
editor.setData(
''
);
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '' );
} );
it( 'should convert a table with media', () => {
editor.setData(
''
);
expect( getModelData( model, { withoutSelection: true } ) )
.to.equal( '' );
} );
} );
} );
describe( 'enter key', () => {
let evtDataStub, viewDocument;
beforeEach( () => {
evtDataStub = {
preventDefault: sinon.spy(),
stopPropagation: sinon.spy(),
isSoft: false
};
return VirtualTestEditor
.create( {
plugins: [ TableEditing, Paragraph ]
} )
.then( newEditor => {
editor = newEditor;
sinon.stub( editor, 'execute' );
viewDocument = editor.editing.view.document;
model = editor.model;
} );
} );
it( 'should do nothing if not in table cell', () => {
setModelData( model, '[]foo' );
viewDocument.fire( 'enter', evtDataStub );
sinon.assert.notCalled( editor.execute );
assertEqualMarkup( getModelData( model ), '[]foo' );
} );
it( 'should do nothing if table cell has already a block content', () => {
setModelData( model, modelTable( [
[ '[]11' ]
] ) );
viewDocument.fire( 'enter', evtDataStub );
sinon.assert.notCalled( editor.execute );
assertEqualMarkup( getModelData( model ), modelTable( [
[ '[]11' ]
] ) );
} );
it( 'should do nothing if table cell with a block content is selected as a whole', () => {
setModelData( model, modelTable( [
[ '[11]' ]
] ) );
viewDocument.fire( 'enter', evtDataStub );
sinon.assert.notCalled( editor.execute );
setModelData( model, modelTable( [
[ '[11]' ]
] ) );
} );
it( 'should allow default behavior of Shift+Enter pressed', () => {
setModelData( model, modelTable( [
[ '[]11' ]
] ) );
evtDataStub.isSoft = true;
viewDocument.fire( 'enter', evtDataStub );
sinon.assert.notCalled( editor.execute );
assertEqualMarkup( getModelData( model ), modelTable( [
[ '[]11' ]
] ) );
} );
} );
} );