mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-07-28 10:32:27 +08:00
527 lines
15 KiB
JavaScript
527 lines
15 KiB
JavaScript
/* globals document, Event */
|
|
|
|
import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor';
|
|
import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils';
|
|
import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
|
|
import { setData as setModelData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model';
|
|
|
|
import MathUI from '../src/mathui';
|
|
import MainFormView from '../src/ui/mainformview';
|
|
import ContextualBalloon from '@ckeditor/ckeditor5-ui/src/panel/balloon/contextualballoon';
|
|
import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
|
|
import View from '@ckeditor/ckeditor5-ui/src/view';
|
|
|
|
import ClickObserver from '@ckeditor/ckeditor5-engine/src/view/observer/clickobserver';
|
|
|
|
describe( 'MathUI', () => {
|
|
let editorElement, editor, mathUIFeature, mathButton, balloon, formView;
|
|
|
|
testUtils.createSinonSandbox();
|
|
|
|
beforeEach( () => {
|
|
editorElement = document.createElement( 'div' );
|
|
document.body.appendChild( editorElement );
|
|
|
|
return ClassicTestEditor
|
|
.create( editorElement, {
|
|
plugins: [ MathUI ],
|
|
math: {
|
|
|
|
}
|
|
} )
|
|
.then( newEditor => {
|
|
editor = newEditor;
|
|
mathUIFeature = editor.plugins.get( MathUI );
|
|
mathButton = editor.ui.componentFactory.create( 'math' );
|
|
balloon = editor.plugins.get( ContextualBalloon );
|
|
formView = mathUIFeature.formView;
|
|
} );
|
|
} );
|
|
|
|
afterEach( () => {
|
|
editorElement.remove();
|
|
|
|
return editor.destroy();
|
|
} );
|
|
|
|
describe( 'init', () => {
|
|
it( 'should register click observer', () => {
|
|
expect( editor.editing.view.getObserver( ClickObserver ) ).to.be.instanceOf( ClickObserver );
|
|
} );
|
|
|
|
it( 'should create #formView', () => {
|
|
expect( formView ).to.be.instanceOf( MainFormView );
|
|
} );
|
|
|
|
describe( 'math toolbar button', () => {
|
|
it( 'should be registered', () => {
|
|
expect( mathButton ).to.be.instanceOf( ButtonView );
|
|
} );
|
|
|
|
it( 'should be toggleable button', () => {
|
|
expect( mathButton.isToggleable ).to.be.true;
|
|
} );
|
|
|
|
it( 'should be bound to the math command', () => {
|
|
const command = editor.commands.get( 'math' );
|
|
|
|
command.isEnabled = true;
|
|
command.value = '\\sqrt{x^2}';
|
|
|
|
expect( mathButton.isOn ).to.be.true;
|
|
expect( mathButton.isEnabled ).to.be.true;
|
|
|
|
command.isEnabled = false;
|
|
command.value = undefined;
|
|
|
|
expect( mathButton.isOn ).to.be.false;
|
|
expect( mathButton.isEnabled ).to.be.false;
|
|
} );
|
|
|
|
it( 'should call #_showUI upon #execute', () => {
|
|
const spy = testUtils.sinon.stub( mathUIFeature, '_showUI' ).returns( {} );
|
|
|
|
mathButton.fire( 'execute' );
|
|
sinon.assert.calledWithExactly( spy, true );
|
|
} );
|
|
} );
|
|
} );
|
|
|
|
describe( '_showUI()', () => {
|
|
let balloonAddSpy;
|
|
|
|
beforeEach( () => {
|
|
balloonAddSpy = testUtils.sinon.spy( balloon, 'add' );
|
|
editor.editing.view.document.isFocused = true;
|
|
} );
|
|
|
|
it( 'should not work if the math command is disabled', () => {
|
|
setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
|
|
editor.commands.get( 'math' ).isEnabled = false;
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
expect( balloon.visibleView ).to.be.null;
|
|
} );
|
|
|
|
it( 'should not throw if the UI is already visible', () => {
|
|
setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
expect( () => {
|
|
mathUIFeature._showUI();
|
|
} ).to.not.throw();
|
|
} );
|
|
|
|
it( 'should add #mainFormView to the balloon and attach the balloon to the selection when text fragment is selected', () => {
|
|
setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
|
|
const selectedRange = editorElement.ownerDocument.getSelection().getRangeAt( 0 );
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
expect( balloon.visibleView ).to.equal( formView );
|
|
sinon.assert.calledWithExactly( balloonAddSpy, {
|
|
view: formView,
|
|
position: {
|
|
target: selectedRange
|
|
}
|
|
} );
|
|
} );
|
|
|
|
it( 'should add #mainFormView to the balloon and attach the balloon to the selection when selection is collapsed', () => {
|
|
setModelData( editor.model, '<paragraph>f[]oo</paragraph>' );
|
|
const selectedRange = editorElement.ownerDocument.getSelection().getRangeAt( 0 );
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
expect( balloon.visibleView ).to.equal( formView );
|
|
sinon.assert.calledWithExactly( balloonAddSpy, {
|
|
view: formView,
|
|
position: {
|
|
target: selectedRange
|
|
}
|
|
} );
|
|
} );
|
|
|
|
it( 'should disable #mainFormView element when math command is disabled', () => {
|
|
setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
editor.commands.get( 'math' ).isEnabled = true;
|
|
|
|
expect( formView.mathInputView.isReadOnly ).to.be.false;
|
|
expect( formView.saveButtonView.isEnabled ).to.be.true;
|
|
expect( formView.cancelButtonView.isEnabled ).to.be.true;
|
|
|
|
editor.commands.get( 'math' ).isEnabled = false;
|
|
|
|
expect( formView.mathInputView.isReadOnly ).to.be.true;
|
|
expect( formView.saveButtonView.isEnabled ).to.be.false;
|
|
expect( formView.cancelButtonView.isEnabled ).to.be.true;
|
|
} );
|
|
|
|
describe( 'response to ui#update', () => {
|
|
it( 'should not duplicate #update listeners', () => {
|
|
setModelData( editor.model, '<paragraph>f[]oo</paragraph>' );
|
|
|
|
const spy = testUtils.sinon.stub( balloon, 'updatePosition' ).returns( {} );
|
|
|
|
mathUIFeature._showUI();
|
|
editor.ui.fire( 'update' );
|
|
mathUIFeature._hideUI();
|
|
|
|
mathUIFeature._showUI();
|
|
editor.ui.fire( 'update' );
|
|
sinon.assert.calledTwice( spy );
|
|
} );
|
|
|
|
it( 'not update the position when is in not visible stack', () => {
|
|
setModelData( editor.model, '<paragraph><$text equation="x^2">f[]oo</$text></paragraph>' );
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
const customView = new View();
|
|
|
|
balloon.add( {
|
|
stackId: 'custom',
|
|
view: customView,
|
|
position: { target: {} }
|
|
} );
|
|
|
|
balloon.showStack( 'custom' );
|
|
|
|
expect( balloon.visibleView ).to.equal( customView );
|
|
|
|
const spy = testUtils.sinon.spy( balloon, 'updatePosition' );
|
|
|
|
editor.ui.fire( 'update' );
|
|
|
|
sinon.assert.notCalled( spy );
|
|
} );
|
|
} );
|
|
|
|
describe( '_hideUI()', () => {
|
|
beforeEach( () => {
|
|
mathUIFeature._showUI();
|
|
} );
|
|
|
|
it( 'should remove the UI from the balloon', () => {
|
|
expect( balloon.hasView( formView ) ).to.be.true;
|
|
|
|
mathUIFeature._hideUI();
|
|
|
|
expect( balloon.hasView( formView ) ).to.be.false;
|
|
} );
|
|
|
|
it( 'should focus the `editable` by default', () => {
|
|
const spy = testUtils.sinon.spy( editor.editing.view, 'focus' );
|
|
|
|
mathUIFeature._hideUI();
|
|
|
|
// First call is from _removeFormView.
|
|
sinon.assert.calledTwice( spy );
|
|
} );
|
|
|
|
it( 'should focus the `editable` before before removing elements from the balloon', () => {
|
|
const focusSpy = testUtils.sinon.spy( editor.editing.view, 'focus' );
|
|
const removeSpy = testUtils.sinon.spy( balloon, 'remove' );
|
|
|
|
mathUIFeature._hideUI();
|
|
|
|
expect( focusSpy.calledBefore( removeSpy ) ).to.equal( true );
|
|
} );
|
|
|
|
it( 'should not throw an error when views are not in the `balloon`', () => {
|
|
mathUIFeature._hideUI();
|
|
|
|
expect( () => {
|
|
mathUIFeature._hideUI();
|
|
} ).to.not.throw();
|
|
} );
|
|
|
|
it( 'should clear ui#update listener from the ViewDocument', () => {
|
|
const spy = sinon.spy();
|
|
|
|
mathUIFeature.listenTo( editor.ui, 'update', spy );
|
|
mathUIFeature._hideUI();
|
|
editor.ui.fire( 'update' );
|
|
|
|
sinon.assert.notCalled( spy );
|
|
} );
|
|
} );
|
|
|
|
describe( 'keyboard support', () => {
|
|
it( 'should show the UI on Ctrl+K keystroke', () => {
|
|
const spy = testUtils.sinon.stub( mathUIFeature, '_showUI' ).returns( {} );
|
|
const command = editor.commands.get( 'math' );
|
|
|
|
command.isEnabled = false;
|
|
|
|
editor.keystrokes.press( {
|
|
keyCode: keyCodes.m,
|
|
ctrlKey: true,
|
|
preventDefault: sinon.spy(),
|
|
stopPropagation: sinon.spy()
|
|
} );
|
|
sinon.assert.notCalled( spy );
|
|
|
|
command.isEnabled = true;
|
|
|
|
editor.keystrokes.press( {
|
|
keyCode: keyCodes.m,
|
|
ctrlKey: true,
|
|
preventDefault: sinon.spy(),
|
|
stopPropagation: sinon.spy()
|
|
} );
|
|
sinon.assert.calledWithExactly( spy, true );
|
|
} );
|
|
|
|
it( 'should prevent default action on Ctrl+M keystroke', () => {
|
|
const preventDefaultSpy = sinon.spy();
|
|
const stopPropagationSpy = sinon.spy();
|
|
|
|
editor.keystrokes.press( {
|
|
keyCode: keyCodes.m,
|
|
ctrlKey: true,
|
|
preventDefault: preventDefaultSpy,
|
|
stopPropagation: stopPropagationSpy
|
|
} );
|
|
|
|
sinon.assert.calledOnce( preventDefaultSpy );
|
|
sinon.assert.calledOnce( stopPropagationSpy );
|
|
} );
|
|
|
|
it( 'should make stack with math visible on Ctrl+M keystroke - no math', () => {
|
|
const command = editor.commands.get( 'math' );
|
|
|
|
command.isEnabled = true;
|
|
|
|
balloon.add( {
|
|
view: new View(),
|
|
stackId: 'custom'
|
|
} );
|
|
|
|
editor.keystrokes.press( {
|
|
keyCode: keyCodes.m,
|
|
ctrlKey: true,
|
|
preventDefault: sinon.spy(),
|
|
stopPropagation: sinon.spy()
|
|
} );
|
|
|
|
expect( balloon.visibleView ).to.equal( formView );
|
|
} );
|
|
|
|
it( 'should make stack with math visible on Ctrl+M keystroke - math', () => {
|
|
setModelData( editor.model, '<paragraph><$text equation="x^2">f[]oo</$text></paragraph>' );
|
|
|
|
const customView = new View();
|
|
|
|
balloon.add( {
|
|
view: customView,
|
|
stackId: 'custom'
|
|
} );
|
|
|
|
expect( balloon.visibleView ).to.equal( customView );
|
|
|
|
editor.keystrokes.press( {
|
|
keyCode: keyCodes.m,
|
|
ctrlKey: true,
|
|
preventDefault: sinon.spy(),
|
|
stopPropagation: sinon.spy()
|
|
} );
|
|
|
|
expect( balloon.visibleView ).to.equal( formView );
|
|
} );
|
|
|
|
it( 'should hide the UI after Esc key press (from editor) and not focus the editable', () => {
|
|
const spy = testUtils.sinon.spy( mathUIFeature, '_hideUI' );
|
|
const keyEvtData = {
|
|
keyCode: keyCodes.esc,
|
|
preventDefault: sinon.spy(),
|
|
stopPropagation: sinon.spy()
|
|
};
|
|
|
|
// Balloon is visible.
|
|
mathUIFeature._showUI();
|
|
editor.keystrokes.press( keyEvtData );
|
|
|
|
sinon.assert.calledWithExactly( spy );
|
|
} );
|
|
|
|
it( 'should not hide the UI after Esc key press (from editor) when UI is open but is not visible', () => {
|
|
const spy = testUtils.sinon.spy( mathUIFeature, '_hideUI' );
|
|
const keyEvtData = {
|
|
keyCode: keyCodes.esc,
|
|
preventDefault: () => {},
|
|
stopPropagation: () => {}
|
|
};
|
|
|
|
const viewMock = {
|
|
ready: true,
|
|
render: () => {},
|
|
destroy: () => {}
|
|
};
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
// Some view precedes the math UI in the balloon.
|
|
balloon.add( { view: viewMock } );
|
|
editor.keystrokes.press( keyEvtData );
|
|
|
|
sinon.assert.notCalled( spy );
|
|
} );
|
|
} );
|
|
|
|
describe( 'mouse support', () => {
|
|
it( 'should hide the UI and not focus editable upon clicking outside the UI', () => {
|
|
const spy = testUtils.sinon.spy( mathUIFeature, '_hideUI' );
|
|
|
|
mathUIFeature._showUI();
|
|
document.body.dispatchEvent( new Event( 'mousedown', { bubbles: true } ) );
|
|
|
|
sinon.assert.calledWithExactly( spy );
|
|
} );
|
|
|
|
it( 'should hide the UI when math is in not currently visible stack', () => {
|
|
const spy = testUtils.sinon.spy( mathUIFeature, '_hideUI' );
|
|
|
|
balloon.add( {
|
|
view: new View(),
|
|
stackId: 'secondary'
|
|
} );
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
// Be sure math view is not currently visible
|
|
expect( balloon.visibleView ).to.not.equal( formView );
|
|
|
|
document.body.dispatchEvent( new Event( 'mousedown', { bubbles: true } ) );
|
|
|
|
sinon.assert.calledWithExactly( spy );
|
|
} );
|
|
|
|
it( 'should not hide the UI upon clicking inside the the UI', () => {
|
|
const spy = testUtils.sinon.spy( mathUIFeature, '_hideUI' );
|
|
|
|
mathUIFeature._showUI();
|
|
balloon.view.element.dispatchEvent( new Event( 'mousedown', { bubbles: true } ) );
|
|
|
|
sinon.assert.notCalled( spy );
|
|
} );
|
|
|
|
describe( 'clicking on editable', () => {
|
|
let observer, spy;
|
|
|
|
beforeEach( () => {
|
|
observer = editor.editing.view.getObserver( ClickObserver );
|
|
editor.model.schema.extend( '$text', { allowIn: '$root' } );
|
|
|
|
spy = testUtils.sinon.stub( mathUIFeature, '_showUI' ).returns( {} );
|
|
} );
|
|
|
|
it( 'should show the UI when collapsed selection is inside math element', () => {
|
|
setModelData( editor.model, '<$text equation="x^2">fo[]o</$text>' );
|
|
|
|
observer.fire( 'click', { target: document.body } );
|
|
sinon.assert.calledWithExactly( spy );
|
|
} );
|
|
|
|
it( 'should show the UI when selection exclusively encloses a math element (#1)', () => {
|
|
setModelData( editor.model, '[<$text equation="x^2">foo</$text>]' );
|
|
|
|
observer.fire( 'click', { target: {} } );
|
|
sinon.assert.calledWithExactly( spy );
|
|
} );
|
|
|
|
it( 'should show the UI when selection exclusively encloses a math element (#2)', () => {
|
|
setModelData( editor.model, '<$text equation="x^2">[foo]</$text>' );
|
|
|
|
observer.fire( 'click', { target: {} } );
|
|
sinon.assert.calledWithExactly( spy );
|
|
} );
|
|
|
|
it( 'should do nothing when selection is not inside math element', () => {
|
|
setModelData( editor.model, '[]' );
|
|
|
|
observer.fire( 'click', { target: {} } );
|
|
sinon.assert.notCalled( spy );
|
|
} );
|
|
} );
|
|
} );
|
|
|
|
describe( 'math form view', () => {
|
|
it( 'should mark the editor UI as focused when the #formView is focused', () => {
|
|
mathUIFeature._showUI();
|
|
expect( balloon.visibleView ).to.equal( formView );
|
|
|
|
editor.ui.focusTracker.isFocused = false;
|
|
formView.element.dispatchEvent( new Event( 'focus' ) );
|
|
|
|
expect( editor.ui.focusTracker.isFocused ).to.be.true;
|
|
} );
|
|
|
|
describe( 'binding', () => {
|
|
beforeEach( () => {
|
|
setModelData( editor.model, '<paragraph>f[o]o</paragraph>' );
|
|
} );
|
|
|
|
it( 'should bind formView.mathInputView#value to math command value', () => {
|
|
const command = editor.commands.get( 'math' );
|
|
|
|
expect( formView.mathInputView.value ).to.undefined;
|
|
|
|
command.value = 'x^2';
|
|
expect( formView.mathInputView.value ).to.equal( 'x^2' );
|
|
} );
|
|
|
|
it( 'should execute math command on mainFormView#submit event', () => {
|
|
const executeSpy = testUtils.sinon.spy( editor, 'execute' );
|
|
|
|
formView.mathInputView.value = 'x^2';
|
|
expect( formView.mathInputView.inputView.element.value ).to.equal( 'x^2' );
|
|
|
|
formView.mathInputView.inputView.element.value = 'x^2';
|
|
formView.fire( 'submit' );
|
|
|
|
expect( executeSpy.calledOnce ).to.be.true;
|
|
expect( executeSpy.calledWithExactly( 'math', 'x^2', {} ) ).to.be.true;
|
|
} );
|
|
|
|
it( 'should hide the balloon on mainFormView#cancel if math command does not have a value', () => {
|
|
mathUIFeature._showUI();
|
|
formView.fire( 'cancel' );
|
|
|
|
expect( balloon.visibleView ).to.be.null;
|
|
} );
|
|
|
|
it( 'should hide the balloon after Esc key press if math command does not have a value', () => {
|
|
const keyEvtData = {
|
|
keyCode: keyCodes.esc,
|
|
preventDefault: sinon.spy(),
|
|
stopPropagation: sinon.spy()
|
|
};
|
|
|
|
mathUIFeature._showUI();
|
|
|
|
formView.keystrokes.press( keyEvtData );
|
|
|
|
expect( balloon.visibleView ).to.be.null;
|
|
} );
|
|
|
|
it( 'should blur math input element before hiding the view', () => {
|
|
mathUIFeature._showUI();
|
|
|
|
const focusSpy = testUtils.sinon.spy( formView.saveButtonView, 'focus' );
|
|
const removeSpy = testUtils.sinon.spy( balloon, 'remove' );
|
|
|
|
formView.fire( 'cancel' );
|
|
|
|
expect( focusSpy.calledBefore( removeSpy ) ).to.equal( true );
|
|
} );
|
|
} );
|
|
} );
|
|
} );
|
|
} );
|