/**
* @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 ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
import Table from '../../src/table';
import TableCellProperties from '../../src/tablecellproperties';
import { findAncestor } from '../../src/commands/utils';
import { getTableCellsContainingSelection } from '../../src/utils/utils';
import global from '@ckeditor/ckeditor5-utils/src/dom/global';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import View from '@ckeditor/ckeditor5-ui/src/view';
import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
import BalloonPanelView from '@ckeditor/ckeditor5-ui/src/panel/balloon/balloonpanelview';
import ToolbarView from '@ckeditor/ckeditor5-ui/src/toolbar/toolbarview';
import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
import {
repositionContextualBalloon,
getBalloonCellPositionData,
getBorderStyleDefinitions,
getBorderStyleLabels,
getLocalizedColorErrorText,
getLocalizedLengthErrorText,
lengthFieldValidator,
lineWidthFieldValidator,
colorFieldValidator,
fillToolbar
} from '../../src/ui/utils';
import Collection from '@ckeditor/ckeditor5-utils/src/collection';
import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
import { centeredBalloonPositionForLongWidgets } from '@ckeditor/ckeditor5-widget/src/utils';
import { modelTable } from '../_utils/utils';
describe( 'UI Utils', () => {
let editor, editingView, balloon, editorElement;
testUtils.createSinonSandbox();
beforeEach( () => {
editorElement = global.document.createElement( 'div' );
global.document.body.appendChild( editorElement );
return ClassicEditor
.create( editorElement, {
plugins: [ Table, TableCellProperties, Paragraph ]
} )
.then( newEditor => {
editor = newEditor;
editingView = editor.editing.view;
balloon = editor.plugins.get( 'ContextualBalloon' );
} );
} );
afterEach( () => {
editorElement.remove();
return editor.destroy();
} );
describe( 'repositionContextualBalloon()', () => {
describe( 'with respect to the table cell', () => {
it( 'should re-position the ContextualBalloon when the table cell is selected', () => {
const spy = sinon.spy( balloon, 'updatePosition' );
const defaultPositions = BalloonPanelView.defaultPositions;
const view = new View();
view.element = global.document.createElement( 'div' );
balloon.add( {
view,
position: {
target: global.document.body
}
} );
setData( editor.model,
'
' );
repositionContextualBalloon( editor, 'cell' );
const modelCell = getTableCellsContainingSelection( editor.model.document.selection )[ 0 ];
const viewCell = editor.editing.mapper.toViewElement( modelCell );
sinon.assert.calledWithExactly( spy, {
target: editingView.domConverter.viewToDom( viewCell ),
positions: [
defaultPositions.northArrowSouth,
defaultPositions.northArrowSouthWest,
defaultPositions.northArrowSouthEast,
defaultPositions.southArrowNorth,
defaultPositions.southArrowNorthWest,
defaultPositions.southArrowNorthEast
]
} );
} );
it( 'should not engage with no table is selected', () => {
const spy = sinon.spy( balloon, 'updatePosition' );
setData( editor.model, 'foo' );
repositionContextualBalloon( editor, 'cell' );
sinon.assert.notCalled( spy );
} );
} );
describe( 'with respect to the entire table', () => {
it( 'should re-position the ContextualBalloon when the table is selected', () => {
const spy = sinon.spy( balloon, 'updatePosition' );
const defaultPositions = BalloonPanelView.defaultPositions;
const view = new View();
view.element = global.document.createElement( 'div' );
balloon.add( {
view,
position: {
target: global.document.body
}
} );
setData( editor.model,
'' );
repositionContextualBalloon( editor, 'table' );
const modelTable = findAncestor( 'table', editor.model.document.selection.getFirstPosition() );
const viewTable = editor.editing.mapper.toViewElement( modelTable );
sinon.assert.calledWithExactly( spy, {
target: editingView.domConverter.viewToDom( viewTable ),
positions: [
defaultPositions.northArrowSouth,
defaultPositions.northArrowSouthWest,
defaultPositions.northArrowSouthEast,
defaultPositions.southArrowNorth,
defaultPositions.southArrowNorthWest,
defaultPositions.southArrowNorthEast,
centeredBalloonPositionForLongWidgets
]
} );
} );
it( 'should not engage with no table is selected', () => {
const spy = sinon.spy( balloon, 'updatePosition' );
setData( editor.model, 'foo' );
repositionContextualBalloon( editor, 'table' );
sinon.assert.notCalled( spy );
} );
} );
} );
describe( 'getBalloonCellPositionData()', () => {
let modelRoot;
beforeEach( () => {
setData( editor.model, modelTable( [
[ '11[]', '12', '13' ],
[ '21', '22', '23' ],
[ '31', '32', '33' ]
] ) );
modelRoot = editor.model.document.getRoot();
for ( let row = 0; row < 3; row++ ) {
for ( let col = 0; col < 3; col++ ) {
const modelCell = modelRoot.getNodeByPath( [ 0, row, col ] );
const viewCell = editor.editing.mapper.toViewElement( modelCell );
const cellDomElement = editingView.domConverter.viewToDom( viewCell );
mockBoundingBox( cellDomElement, {
top: 100 + row * 10,
left: 100 + col * 10,
height: 10,
width: 10
} );
}
}
} );
it( 'returns the position data', () => {
const defaultPositions = BalloonPanelView.defaultPositions;
const data = getBalloonCellPositionData( editor );
const modelCell = getTableCellsContainingSelection( editor.model.document.selection )[ 0 ];
const viewCell = editor.editing.mapper.toViewElement( modelCell );
expect( data ).to.deep.equal( {
target: editingView.domConverter.viewToDom( viewCell ),
positions: [
defaultPositions.northArrowSouth,
defaultPositions.northArrowSouthWest,
defaultPositions.northArrowSouthEast,
defaultPositions.southArrowNorth,
defaultPositions.southArrowNorthWest,
defaultPositions.southArrowNorthEast
]
} );
} );
it( 'returns the position data for multiple cells selected horizontally', () => {
selectTableCells( [
[ 0, 0 ],
[ 0, 1 ]
] );
const data = getBalloonCellPositionData( editor );
const targetData = data.target();
expect( targetData ).to.deep.equal( {
top: 100,
left: 100,
right: 120,
bottom: 110,
width: 20,
height: 10
} );
} );
it( 'returns the position data for multiple cells selected vertically', () => {
selectTableCells( [
[ 0, 1 ],
[ 1, 1 ]
] );
const data = getBalloonCellPositionData( editor );
const targetData = data.target();
expect( targetData ).to.deep.equal( {
top: 100,
left: 110,
right: 120,
bottom: 120,
width: 10,
height: 20
} );
} );
it( 'returns the position data for multiple cells selected', () => {
selectTableCells( [
[ 0, 1 ],
[ 1, 0 ],
[ 1, 1 ]
] );
const data = getBalloonCellPositionData( editor );
const targetData = data.target();
expect( targetData ).to.deep.equal( {
top: 100,
left: 100,
right: 120,
bottom: 120,
width: 20,
height: 20
} );
} );
function selectTableCells( paths ) {
editor.model.change( writer => {
writer.setSelection( paths.map( path => writer.createRangeOn( modelRoot.getNodeByPath( [ 0, ...path ] ) ) ) );
} );
}
function mockBoundingBox( element, data ) {
testUtils.sinon.stub( element, 'getBoundingClientRect' ).returns( {
...data,
right: data.left + data.width,
bottom: data.top + data.height
} );
}
} );
describe( 'getBorderStyleLabels()', () => {
it( 'should return labels for different border styles', () => {
const t = string => string;
expect( getBorderStyleLabels( t ) ).to.deep.equal( {
none: 'None',
solid: 'Solid',
dotted: 'Dotted',
dashed: 'Dashed',
double: 'Double',
groove: 'Groove',
ridge: 'Ridge',
inset: 'Inset',
outset: 'Outset'
} );
} );
} );
describe( 'getLocalizedColorErrorText()', () => {
it( 'should return the error text', () => {
const t = string => string;
expect( getLocalizedColorErrorText( t ) ).to.match( /^The color is invalid/ );
} );
} );
describe( 'getLocalizedLengthErrorText()', () => {
it( 'should return the error text', () => {
const t = string => string;
expect( getLocalizedLengthErrorText( t ) ).to.match( /^The value is invalid/ );
} );
} );
describe( 'colorFieldValidator()', () => {
it( 'should pass for an empty value', () => {
expect( colorFieldValidator( '' ) ).to.be.true;
} );
it( 'should pass for white spaces', () => {
expect( colorFieldValidator( ' ' ) ).to.be.true;
} );
it( 'should pass for colors', () => {
expect( colorFieldValidator( '#FFF' ) ).to.be.true;
expect( colorFieldValidator( '#FFAA11' ) ).to.be.true;
expect( colorFieldValidator( 'rgb(255,123,100)' ) ).to.be.true;
expect( colorFieldValidator( 'red' ) ).to.be.true;
} );
it( 'should pass for colors surrounded by white spaces', () => {
expect( colorFieldValidator( ' #AAA ' ) ).to.be.true;
expect( colorFieldValidator( ' rgb(255,123,100) ' ) ).to.be.true;
} );
} );
describe( 'lengthFieldValidator()', () => {
it( 'should pass for an empty value', () => {
expect( lengthFieldValidator( '' ) ).to.be.true;
} );
it( 'should pass for white spaces', () => {
expect( lengthFieldValidator( ' ' ) ).to.be.true;
} );
it( 'should pass for lengths', () => {
expect( lengthFieldValidator( '1px' ) ).to.be.true;
expect( lengthFieldValidator( '12em' ) ).to.be.true;
expect( lengthFieldValidator( ' 12em ' ) ).to.be.true;
expect( lengthFieldValidator( '45%' ) ).to.be.true;
} );
it( 'should pass for number without unit', () => {
expect( lengthFieldValidator( '1' ) ).to.be.true;
expect( lengthFieldValidator( '12.1' ) ).to.be.true;
expect( lengthFieldValidator( '0.125 ' ) ).to.be.true;
} );
it( 'should not pass for invalid number values', () => {
expect( lengthFieldValidator( '.1 ' ) ).to.be.false;
expect( lengthFieldValidator( '45. ' ) ).to.be.false;
expect( lengthFieldValidator( '45.1.1 ' ) ).to.be.false;
} );
it( 'should pass for lengths surrounded by white spaces', () => {
expect( lengthFieldValidator( '3px ' ) ).to.be.true;
expect( lengthFieldValidator( ' 12em ' ) ).to.be.true;
} );
} );
describe( 'lineWidthFieldValidator()', () => {
it( 'should pass for an empty value', () => {
expect( lineWidthFieldValidator( '' ) ).to.be.true;
} );
it( 'should pass for white spaces', () => {
expect( lineWidthFieldValidator( ' ' ) ).to.be.true;
} );
it( 'should pass for lengths', () => {
expect( lineWidthFieldValidator( '1px' ) ).to.be.true;
expect( lineWidthFieldValidator( '12em' ) ).to.be.true;
expect( lineWidthFieldValidator( ' 12em ' ) ).to.be.true;
} );
it( 'should pass for number without unit', () => {
expect( lineWidthFieldValidator( '1' ) ).to.be.true;
expect( lineWidthFieldValidator( '12.1' ) ).to.be.true;
expect( lineWidthFieldValidator( '0.125 ' ) ).to.be.true;
} );
it( 'should not pass for invalid number values', () => {
expect( lineWidthFieldValidator( '.1 ' ) ).to.be.false;
expect( lineWidthFieldValidator( '45. ' ) ).to.be.false;
expect( lineWidthFieldValidator( '45.1.1 ' ) ).to.be.false;
expect( lineWidthFieldValidator( '45%' ) ).to.be.false;
} );
it( 'should pass for lengths surrounded by white spaces', () => {
expect( lineWidthFieldValidator( '3px ' ) ).to.be.true;
expect( lineWidthFieldValidator( ' 12em ' ) ).to.be.true;
} );
} );
describe( 'getBorderStyleDefinitions()', () => {
let view, locale, definitions;
beforeEach( () => {
locale = { t: val => val };
view = new View( locale );
view.set( 'borderStyle', 'none' );
definitions = getBorderStyleDefinitions( view );
} );
it( 'should return a collection', () => {
expect( definitions ).to.be.instanceOf( Collection );
} );
it( 'should create a button definition for each style', () => {
expect( definitions.map( ( { type } ) => type ).every( item => item === 'button' ) ).to.be.true;
} );
it( 'should set label of a button for each style', () => {
expect( definitions.map( ( { model: { label } } ) => label ) ).to.have.ordered.members( [
'None',
'Solid',
'Dotted',
'Dashed',
'Double',
'Groove',
'Ridge',
'Inset',
'Outset'
] );
} );
it( 'should set type of a button for each style', () => {
expect( definitions.map( ( { model: { withText } } ) => withText ).every( item => item === true ) ).to.be.true;
} );
it( 'should bind button\'s #isOn to the view #borderStyle property', () => {
view.borderStyle = 'dotted';
expect( definitions.map( ( { model: { isOn } } ) => isOn ) ).to.have.ordered.members( [
false,
false,
true,
false,
false,
false,
false,
false,
false
] );
view.borderStyle = 'inset';
expect( definitions.map( ( { model: { isOn } } ) => isOn ) ).to.have.ordered.members( [
false,
false,
false,
false,
false,
false,
false,
true,
false
] );
} );
} );
describe( 'fillToolbar()', () => {
let view, locale, toolbar;
const labels = {
first: 'Do something',
second: 'Do something else',
third: 'Be default'
};
const icons = {
first: '',
second: '',
third: ''
};
beforeEach( () => {
locale = { t: val => val };
view = new View( locale );
view.set( 'someProperty', 'foo' );
toolbar = new ToolbarView( locale );
fillToolbar( {
view, toolbar, icons, labels,
propertyName: 'someProperty',
nameToValue: name => name === 'third' ? '' : name
} );
} );
afterEach( () => {
view.destroy();
} );
it( 'should create buttons', () => {
expect( toolbar.items ).to.have.length( 3 );
expect( toolbar.items.first ).to.be.instanceOf( ButtonView );
expect( toolbar.items.get( 1 ) ).to.be.instanceOf( ButtonView );
expect( toolbar.items.last ).to.be.instanceOf( ButtonView );
} );
it( 'should set button labels', () => {
expect( toolbar.items.first.label ).to.equal( 'Do something' );
expect( toolbar.items.get( 1 ).label ).to.equal( 'Do something else' );
expect( toolbar.items.last.label ).to.equal( 'Be default' );
} );
it( 'should set button icons', () => {
expect( toolbar.items.first.icon ).to.equal( icons.first );
expect( toolbar.items.get( 1 ).icon ).to.equal( icons.second );
expect( toolbar.items.last.icon ).to.equal( icons.third );
} );
it( 'should set button tooltips', () => {
expect( toolbar.items.first.tooltip ).to.equal( labels.first );
expect( toolbar.items.get( 1 ).tooltip ).to.equal( labels.second );
expect( toolbar.items.last.tooltip ).to.equal( labels.third );
} );
it( 'should bind button #isOn to an observable property', () => {
expect( toolbar.items.first.isOn ).to.be.false;
expect( toolbar.items.get( 1 ).isOn ).to.be.false;
expect( toolbar.items.last.isOn ).to.be.false;
view.someProperty = 'first';
expect( toolbar.items.first.isOn ).to.be.true;
expect( toolbar.items.get( 1 ).isOn ).to.be.false;
expect( toolbar.items.last.isOn ).to.be.false;
view.someProperty = 'second';
expect( toolbar.items.first.isOn ).to.be.false;
expect( toolbar.items.get( 1 ).isOn ).to.be.true;
expect( toolbar.items.last.isOn ).to.be.false;
view.someProperty = '';
expect( toolbar.items.first.isOn ).to.be.false;
expect( toolbar.items.get( 1 ).isOn ).to.be.false;
expect( toolbar.items.last.isOn ).to.be.true;
} );
it( 'should make the buttons change the property value upon execution', () => {
toolbar.items.first.fire( 'execute' );
expect( view.someProperty ).to.equal( 'first' );
toolbar.items.get( 1 ).fire( 'execute' );
expect( view.someProperty ).to.equal( 'second' );
toolbar.items.last.fire( 'execute' );
expect( view.someProperty ).to.equal( '' );
} );
} );
} );