| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Range from '@ckeditor/ckeditor5-engine/src/model/range';
- import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
- import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor';
- import { getData as getModelData, parse, setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
- import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard';
- import TableEditing from '../src/tableediting';
- import { formatTable, formattedModelTable, 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 SplitCellCommand from '../src/commands/splitcellcommand';
- import MergeCellCommand from '../src/commands/mergecellcommand';
- import SetHeaderRowCommand from '../src/commands/setheaderrowcommand';
- import SetHeaderColumnCommand from '../src/commands/setheadercolumncommand';
- import UndoEditing from '@ckeditor/ckeditor5-undo/src/undoediting';
- describe( 'TableEditing', () => {
- let editor, model;
- beforeEach( () => {
- return VirtualTestEditor
- .create( {
- plugins: [ TableEditing, Paragraph, UndoEditing ]
- } )
- .then( newEditor => {
- editor = newEditor;
- model = editor.model;
- } );
- } );
- afterEach( () => {
- editor.destroy();
- } );
- it( 'should set proper schema rules', () => {
- } );
- 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 insertColumnBefore command', () => {
- expect( editor.commands.get( 'insertTableColumnBefore' ) ).to.be.instanceOf( InsertColumnCommand );
- } );
- it( 'adds insertColumnAfter command', () => {
- expect( editor.commands.get( 'insertTableColumnAfter' ) ).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 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, '<table><tableRow><tableCell>foo[]</tableCell></tableRow></table>' );
- expect( editor.getData() ).to.equal(
- '<figure class="table">' +
- '<table>' +
- '<tbody>' +
- '<tr><td>foo</td></tr>' +
- '</tbody>' +
- '</table>' +
- '</figure>'
- );
- } );
- it( 'should create thead section', () => {
- setModelData( model, '<table headingRows="1"><tableRow><tableCell>foo[]</tableCell></tableRow></table>' );
- expect( editor.getData() ).to.equal(
- '<figure class="table">' +
- '<table>' +
- '<thead>' +
- '<tr><th>foo</th></tr>' +
- '</thead>' +
- '</table>' +
- '</figure>'
- );
- } );
- } );
- describe( 'view to model', () => {
- it( 'should convert table', () => {
- editor.setData( '<table><tbody><tr><td>foo</td></tr></tbody></table>' );
- expect( getModelData( model, { withoutSelection: true } ) )
- .to.equal( '<table><tableRow><tableCell>foo</tableCell></tableRow></table>' );
- } );
- } );
- } );
- describe( 'caret movement', () => {
- let domEvtDataStub;
- beforeEach( () => {
- domEvtDataStub = {
- keyCode: getCode( 'Tab' ),
- preventDefault: sinon.spy(),
- stopPropagation: sinon.spy()
- };
- } );
- it( 'should do nothing if not tab pressed', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- domEvtDataStub.keyCode = getCode( 'a' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '11', '12[]' ]
- ] ) );
- } );
- it( 'should do nothing if Ctrl+Tab is pressed', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- domEvtDataStub.ctrlKey = true;
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '11', '12[]' ]
- ] ) );
- } );
- describe( 'on TAB', () => {
- it( 'should do nothing if selection is not in a table', () => {
- setModelData( model, '[]' + modelTable( [
- [ '11', '12' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( '[]' + formattedModelTable( [
- [ '11', '12' ]
- ] ) );
- } );
- it( 'should move to next cell', () => {
- setModelData( model, modelTable( [
- [ '11[]', '12' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '11', '[12]' ]
- ] ) );
- } );
- it( 'should create another row and move to first cell in new row', () => {
- setModelData( model, modelTable( [
- [ '11', '[12]' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '11', '12' ],
- [ '[]', '' ]
- ] ) );
- } );
- it( 'should move to the first cell of next row if on end of a row', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ],
- [ '21', '22' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '11', '12' ],
- [ '[21]', '22' ]
- ] ) );
- } );
- describe( 'on table widget selected', () => {
- beforeEach( () => {
- editor.model.schema.register( 'block', {
- allowWhere: '$block',
- allowContentOf: '$block',
- isObject: true
- } );
- editor.conversion.elementToElement( { model: 'block', view: 'block' } );
- } );
- it( 'should move caret to the first table cell on TAB', () => {
- const spy = sinon.spy();
- editor.editing.view.document.on( 'keydown', spy );
- setModelData( model, '[' + modelTable( [
- [ '11', '12' ]
- ] ) + ']' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '[11]', '12' ]
- ] ) );
- // Should cancel event - so no other tab handler is called.
- sinon.assert.notCalled( spy );
- } );
- it( 'shouldn\'t do anything on other blocks', () => {
- const spy = sinon.spy();
- editor.editing.view.document.on( 'keydown', spy );
- setModelData( model, '[<block>foo</block>]' );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( '[<block>foo</block>]' );
- // Should not cancel event.
- sinon.assert.calledOnce( spy );
- } );
- } );
- } );
- describe( 'on SHIFT+TAB', () => {
- beforeEach( () => {
- domEvtDataStub.shiftKey = true;
- } );
- it( 'should do nothing if selection is not in a table', () => {
- setModelData( model, '[]' + modelTable( [
- [ '11', '12' ]
- ] ) );
- domEvtDataStub.keyCode = getCode( 'Tab' );
- domEvtDataStub.shiftKey = true;
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.notCalled( domEvtDataStub.preventDefault );
- sinon.assert.notCalled( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( '[]' + formattedModelTable( [
- [ '11', '12' ]
- ] ) );
- } );
- it( 'should move to previous cell', () => {
- setModelData( model, modelTable( [
- [ '11', '12[]' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- sinon.assert.calledOnce( domEvtDataStub.preventDefault );
- sinon.assert.calledOnce( domEvtDataStub.stopPropagation );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '[11]', '12' ]
- ] ) );
- } );
- it( 'should not move if caret is in first table cell', () => {
- setModelData( model, '<paragraph>foo</paragraph>' + modelTable( [
- [ '[]11', '12' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- expect( formatTable( getModelData( model ) ) ).to.equal(
- '<paragraph>foo</paragraph>' + formattedModelTable( [ [ '[]11', '12' ] ] )
- );
- } );
- it( 'should move to the last cell of previous row if on beginning of a row', () => {
- setModelData( model, modelTable( [
- [ '11', '12' ],
- [ '[]21', '22' ]
- ] ) );
- editor.editing.view.document.fire( 'keydown', domEvtDataStub );
- expect( formatTable( getModelData( model ) ) ).to.equal( formattedModelTable( [
- [ '11', '[12]' ],
- [ '21', '22' ]
- ] ) );
- } );
- } );
- } );
- describe( 'post-fixer', () => {
- let root;
- beforeEach( () => {
- root = model.document.getRoot();
- } );
- it( 'should add missing columns to a tableRows that are shorter then longest table row', () => {
- const parsed = parse( modelTable( [
- [ '00' ],
- [ '10', '11', '12' ],
- [ '20', '21' ]
- ] ), model.schema );
- model.change( writer => {
- writer.remove( Range.createIn( root ) );
- writer.insert( parsed, root );
- } );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ) ).to.equal( formattedModelTable( [
- [ '00', '', '' ],
- [ '10', '11', '12' ],
- [ '20', '21', '' ]
- ] ) );
- } );
- it( 'should add missing columns to a tableRows that are shorter then longest table row (complex 1)', () => {
- const parsed = parse( modelTable( [
- [ '00', { rowspan: 2, contents: '10' } ],
- [ '10', { colspan: 2, contents: '12' } ],
- [ '20', '21' ]
- ] ), model.schema );
- model.change( writer => {
- writer.remove( Range.createIn( root ) );
- writer.insert( parsed, root );
- } );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ) ).to.equal( formattedModelTable( [
- [ '00', { rowspan: 2, contents: '10' }, '', '' ],
- [ '10', { colspan: 2, contents: '12' } ],
- [ '20', '21', '', '' ]
- ] ) );
- } );
- it( 'should add missing columns to a tableRows that are shorter then longest table row (complex 2)', () => {
- const parsed = parse( modelTable( [
- [ { colspan: 6, contents: '00' } ],
- [ { rowspan: 2, contents: '10' }, '11', { colspan: 3, contents: '12' } ],
- [ '21', '22' ]
- ] ), model.schema );
- model.change( writer => {
- writer.remove( Range.createIn( root ) );
- writer.insert( parsed, root );
- } );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ) ).to.equal( formattedModelTable( [
- [ { colspan: 6, contents: '00' } ],
- [ { rowspan: 2, contents: '10' }, '11', { colspan: 3, contents: '12' }, '' ],
- [ '21', '22', '', '', '' ]
- ] ) );
- } );
- it( 'should fix wrong rowspan attribute on table header', () => {
- const parsed = parse( modelTable( [
- [ { rowspan: 2, contents: '00' }, { rowspan: 3, contents: '01' }, '02' ],
- [ { rowspan: 8, contents: '12' } ],
- [ '20', '21', '22' ]
- ], { headingRows: 2 } ), model.schema );
- model.change( writer => {
- writer.remove( Range.createIn( root ) );
- writer.insert( parsed, root );
- } );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ) ).to.equal( formattedModelTable( [
- [ { rowspan: 2, contents: '00' }, { rowspan: 2, contents: '01' }, '02' ],
- [ '12' ],
- [ '20', '21', '22' ]
- ], { headingRows: 2 } ) );
- } );
- it( 'should fix wrong rowspan attribute on table body', () => {
- const parsed = parse( modelTable( [
- [ '00', '01', '02' ],
- [ { rowspan: 2, contents: '10' }, { rowspan: 3, contents: '11' }, '12' ],
- [ { rowspan: 8, contents: '22' } ]
- ], { headingRows: 1 } ), model.schema );
- model.change( writer => {
- writer.remove( Range.createIn( root ) );
- writer.insert( parsed, root );
- } );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ) ).to.equal( formattedModelTable( [
- [ '00', '01', '02' ],
- [ { rowspan: 2, contents: '10' }, { rowspan: 2, contents: '11' }, '12' ],
- [ '22' ]
- ], { headingRows: 1 } ) );
- } );
- it( 'collab remove column vs insert row', () => {
- _testExternal(
- modelTable( [
- [ '00[]', '01' ],
- [ '10', '11' ]
- ] ),
- writer => _removeColumn( writer, 1, [ 0, 1 ] ),
- writer => _insertRow( writer, 1, [ 'a', 'b' ] ),
- formattedModelTable( [
- [ '00', '' ],
- [ 'a', 'b' ],
- [ '10', '' ]
- ] ),
- formattedModelTable( [
- [ '00', '01', '' ],
- [ 'a', 'b', '' ],
- [ '10', '11', '' ]
- ] ) );
- } );
- it( 'collab insert row vs remove column', () => {
- _testExternal(
- modelTable( [
- [ '00[]', '01' ],
- [ '10', '11' ]
- ] ),
- writer => _insertRow( writer, 1, [ 'a', 'b' ] ),
- writer => _removeColumn( writer, 1, [ 0, 2 ] ),
- formattedModelTable( [
- [ '00', '' ],
- [ 'a', 'b' ],
- [ '10', '' ]
- ] ),
- formattedModelTable( [
- [ '00', '' ],
- [ '10', '' ]
- ] ) );
- } );
- it( 'collab insert row vs insert column', () => {
- _testExternal(
- modelTable( [
- [ '00[]', '01' ],
- [ '10', '11' ]
- ] ),
- writer => _insertRow( writer, 1, [ 'a', 'b' ] ),
- writer => _insertColumn( writer, 1, [ 0, 2 ] ),
- formattedModelTable( [
- [ '00', '', '01' ],
- [ 'a', 'b', '' ],
- [ '10', '', '11' ]
- ] ),
- formattedModelTable( [
- [ '00', '', '01' ],
- [ '10', '', '11' ]
- ] ) );
- } );
- it( 'collab insert column vs insert row', () => {
- _testExternal(
- modelTable( [
- [ '00[]', '01' ],
- [ '10', '11' ]
- ] ),
- writer => _insertColumn( writer, 1, [ 0, 1 ] ),
- writer => _insertRow( writer, 1, [ 'a', 'b' ] ),
- formattedModelTable( [
- [ '00', '', '01' ],
- [ 'a', 'b', '' ],
- [ '10', '', '11' ]
- ] ),
- formattedModelTable( [
- [ '00', '01', '' ],
- [ 'a', 'b', '' ],
- [ '10', '11', '' ]
- ] ) );
- } );
- it( 'collab insert column vs insert column - other row has spanned cell', () => {
- _testExternal(
- modelTable( [
- [ { colspan: 3, contents: '00' } ],
- [ '10', '11', '12' ]
- ] ),
- writer => {
- _setAttribute( writer, 'colspan', 4, [ 0, 0 ] );
- _insertColumn( writer, 2, [ 1 ] );
- },
- writer => {
- _setAttribute( writer, 'colspan', 4, [ 0, 0 ] );
- _insertColumn( writer, 1, [ 1 ] );
- },
- formattedModelTable( [
- [ { colspan: 4, contents: '00' }, '' ],
- [ '10', '', '11', '', '12' ]
- ] ),
- formattedModelTable( [
- [ { colspan: 3, contents: '00' }, '' ],
- [ '10', '', '11', '12' ]
- ] ) );
- } );
- it( 'collab insert column vs insert column - other row has spanned cell (inverted)', () => {
- _testExternal(
- modelTable( [
- [ { colspan: 3, contents: '00' } ],
- [ '10', '11', '12' ]
- ] ),
- writer => {
- _setAttribute( writer, 'colspan', 4, [ 0, 0 ] );
- _insertColumn( writer, 1, [ 1 ] );
- },
- writer => {
- _setAttribute( writer, 'colspan', 4, [ 0, 0 ] );
- _insertColumn( writer, 3, [ 1 ] );
- },
- formattedModelTable( [
- [ { colspan: 4, contents: '00' }, '' ],
- [ '10', '', '11', '', '12' ]
- ] ),
- formattedModelTable( [
- [ { colspan: 3, contents: '00' }, '' ],
- [ '10', '11', '', '12' ]
- ] ) );
- } );
- it( 'should not crash on table remove', () => {
- setModelData( model, modelTable( [
- [ '11', '12' ]
- ] ) );
- expect( () => {
- model.change( writer => {
- writer.remove( Range.createIn( root ) );
- } );
- } ).to.not.throw();
- expect( getModelData( model, { withoutSelection: true } ) ).to.equal( '<paragraph></paragraph>' );
- } );
- // Case: remove same column (undo does nothing on one client - NOOP in batch).
- // Case: remove same row (undo does nothing on one client - NOOP in batch).
- // Case: Typing over user selecting - typing in marker...
- function _testExternal( initialData, localCallback, externalCallback, modelAfter, modelAfterUndo ) {
- setModelData( model, initialData );
- model.change( localCallback );
- model.enqueueChange( 'transparent', externalCallback );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ), 'after operations' ).to.equal( modelAfter );
- editor.execute( 'undo' );
- expect( formatTable( getModelData( model, { withoutSelection: true } ) ), 'after undo' ).to.equal( modelAfterUndo );
- }
- function _removeColumn( writer, columnIndex, rows ) {
- const table = root.getChild( 0 );
- for ( const index of rows ) {
- const tableRow = table.getChild( index );
- writer.remove( tableRow.getChild( columnIndex ) );
- }
- }
- function _insertRow( writer, rowIndex, rowData ) {
- const table = root.getChild( 0 );
- const parsedTable = parse(
- modelTable( [ rowData ] ),
- model.schema
- );
- writer.insert( parsedTable.getChild( 0 ), table, rowIndex );
- }
- function _setAttribute( writer, attributeKey, attributeValue, path ) {
- const table = root.getChild( 0 );
- const node = table.getNodeByPath( path );
- writer.setAttribute( attributeKey, attributeValue, node );
- }
- function _insertColumn( writer, columnIndex, rows ) {
- const table = root.getChild( 0 );
- for ( const index of rows ) {
- const tableRow = table.getChild( index );
- const tableCell = writer.createElement( 'tableCell' );
- writer.insert( tableCell, tableRow, columnIndex );
- }
- }
- } );
- } );
|