| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365 |
- /**
- * @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 Context from '../src/context';
- import ContextPlugin from '../src/contextplugin';
- import Plugin from '../src/plugin';
- import Config from '@ckeditor/ckeditor5-utils/src/config';
- import Locale from '@ckeditor/ckeditor5-utils/src/locale';
- import VirtualTestEditor from './_utils/virtualtesteditor';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- describe( 'Context', () => {
- describe( 'config', () => {
- it( 'should be created', () => {
- const context = new Context();
- expect( context.config ).to.instanceof( Config );
- } );
- it( 'should be with given configuration', () => {
- const context = new Context( { foo: 'bar' } );
- expect( context.config.get( 'foo' ) ).to.equal( 'bar' );
- } );
- } );
- describe( '_getEditorConfig()', () => {
- it( 'should return the configuration without plugin config', () => {
- class FooPlugin extends ContextPlugin {}
- class BarPlugin extends ContextPlugin {}
- class BomPlugin extends ContextPlugin {}
- const context = new Context( {
- language: { ui: 'pl', content: 'ar' },
- plugins: [ FooPlugin, BarPlugin ],
- extraPlugins: [ BomPlugin ],
- removePlugins: [ FooPlugin ],
- foo: 1,
- bar: 'bom'
- } );
- expect( context._getEditorConfig() ).to.be.deep.equal( {
- language: { ui: 'pl', content: 'ar' },
- foo: 1,
- bar: 'bom'
- } );
- } );
- } );
- describe( 'editors', () => {
- it( 'should keep all the editors created within the context and fire event:add whenever an editor is added', async () => {
- const spy = sinon.spy();
- const context = await Context.create();
- context.editors.on( 'add', spy );
- const editorA = await VirtualTestEditor.create( { context } );
- expect( spy.calledOnce );
- const editorB = await VirtualTestEditor.create( { context } );
- expect( spy.calledTwice );
- expect( context.editors.has( editorA ) );
- expect( context.editors.has( editorB ) );
- } );
- } );
- describe( 'locale', () => {
- it( 'is instantiated and t() is exposed', () => {
- const context = new Context();
- expect( context.locale ).to.be.instanceof( Locale );
- expect( context.t ).to.equal( context.locale.t );
- } );
- it( 'is configured with the config.language (UI and the content)', () => {
- const context = new Context( { language: 'pl' } );
- expect( context.locale.uiLanguage ).to.equal( 'pl' );
- expect( context.locale.contentLanguage ).to.equal( 'pl' );
- } );
- it( 'is configured with the config.language (different for UI and the content)', () => {
- const context = new Context( { language: { ui: 'pl', content: 'ar' } } );
- expect( context.locale.uiLanguage ).to.equal( 'pl' );
- expect( context.locale.contentLanguage ).to.equal( 'ar' );
- } );
- it( 'is configured with the config.language (just the content)', () => {
- const context = new Context( { language: { content: 'ar' } } );
- expect( context.locale.uiLanguage ).to.equal( 'en' );
- expect( context.locale.contentLanguage ).to.equal( 'ar' );
- } );
- } );
- describe( 'plugins', () => {
- it( 'should throw when plugin added to the context is not marked as a ContextPlugin (Plugin)', async () => {
- class EditorPlugin extends Plugin {}
- let caughtError;
- try {
- await Context.create( { plugins: [ EditorPlugin ] } );
- } catch ( error ) {
- caughtError = error;
- }
- expect( caughtError ).to.instanceof( CKEditorError );
- expect( caughtError.message )
- .match( /^context-initplugins-invalid-plugin:/ );
- } );
- it( 'should throw when plugin added to the context is not marked as a ContextPlugin (Function)', async () => {
- function EditorPlugin() {}
- let caughtError;
- try {
- await Context.create( { plugins: [ EditorPlugin ] } );
- } catch ( error ) {
- caughtError = error;
- }
- expect( caughtError ).to.instanceof( CKEditorError );
- expect( caughtError.message )
- .match( /^context-initplugins-invalid-plugin:/ );
- } );
- it( 'should throw when plugin is added to the context by name', async () => {
- let caughtError;
- try {
- await Context.create( { plugins: [ 'ContextPlugin' ] } );
- } catch ( error ) {
- caughtError = error;
- }
- expect( caughtError ).to.instanceof( CKEditorError );
- expect( caughtError.message )
- .match( /^context-initplugins-constructor-only:/ );
- } );
- it( 'should not throw when plugin as a function, marked as a ContextPlugin is added to the context', async () => {
- function EditorPlugin() {}
- EditorPlugin.isContextPlugin = true;
- let caughtError;
- try {
- await Context.create( { plugins: [ EditorPlugin ] } );
- } catch ( error ) {
- caughtError = error;
- }
- expect( caughtError ).to.equal( undefined );
- } );
- it( 'should share the same instance of plugin within editors using the same context', async () => {
- class ContextPluginA extends ContextPlugin {}
- class ContextPluginB extends ContextPlugin {}
- class EditorPluginA extends Plugin {}
- const context = await Context.create( { plugins: [ ContextPluginA, ContextPluginB ] } );
- const editorA = await VirtualTestEditor.create( { context, plugins: [ ContextPluginA, EditorPluginA ] } );
- const editorB = await VirtualTestEditor.create( { context, plugins: [ ContextPluginB, EditorPluginA ] } );
- expect( editorA.plugins.get( ContextPluginA ) ).to.equal( context.plugins.get( ContextPluginA ) );
- expect( editorA.plugins.has( ContextPluginB ) ).to.equal( false );
- expect( editorB.plugins.get( ContextPluginB ) ).to.equal( context.plugins.get( ContextPluginB ) );
- expect( editorB.plugins.has( ContextPluginA ) ).to.equal( false );
- expect( context.plugins.has( EditorPluginA ) ).to.equal( false );
- expect( editorA.plugins.get( EditorPluginA ) ).to.not.equal( editorB.plugins.get( EditorPluginA ) );
- await context.destroy();
- } );
- it( 'should share the same instance of plugin (dependencies) within editors using the same context', async () => {
- class ContextPluginA extends ContextPlugin {}
- class ContextPluginB extends ContextPlugin {}
- class EditorPluginA extends Plugin {
- static get requires() {
- return [ ContextPluginA ];
- }
- }
- class EditorPluginB extends Plugin {
- static get requires() {
- return [ ContextPluginB ];
- }
- }
- const context = await Context.create( { plugins: [ ContextPluginA, ContextPluginB ] } );
- const editorA = await VirtualTestEditor.create( { context, plugins: [ EditorPluginA ] } );
- const editorB = await VirtualTestEditor.create( { context, plugins: [ EditorPluginB ] } );
- expect( context.plugins.get( ContextPluginA ) ).to.equal( editorA.plugins.get( ContextPluginA ) );
- expect( context.plugins.get( ContextPluginB ) ).to.equal( editorB.plugins.get( ContextPluginB ) );
- await context.destroy();
- } );
- it( 'should not initialize twice plugin added to the context and the editor', async () => {
- const initSpy = sinon.spy();
- const afterInitSpy = sinon.spy();
- class ContextPluginA extends ContextPlugin {
- init() {
- initSpy();
- }
- afterInit() {
- afterInitSpy();
- }
- }
- const context = await Context.create( { plugins: [ ContextPluginA ] } );
- const editor = await VirtualTestEditor.create( { context, plugins: [ ContextPluginA ] } );
- expect( context.plugins.get( ContextPluginA ) ).to.equal( editor.plugins.get( ContextPluginA ) );
- sinon.assert.calledOnce( initSpy );
- sinon.assert.calledOnce( afterInitSpy );
- await context.destroy();
- } );
- it( 'should be able to add context plugin to the editor using pluginName property', async () => {
- class ContextPluginA extends ContextPlugin {
- static get pluginName() {
- return 'ContextPluginA';
- }
- }
- class ContextPluginB extends ContextPlugin {
- static get pluginName() {
- return 'ContextPluginB';
- }
- static get requires() {
- return [ ContextPluginA ];
- }
- }
- const context = await Context.create( { plugins: [ ContextPluginB ] } );
- const editor = await VirtualTestEditor.create( { context, plugins: [ 'ContextPluginA' ] } );
- expect( editor.plugins.has( ContextPluginA ) ).to.equal( true );
- expect( editor.plugins.has( ContextPluginB ) ).to.equal( false );
- } );
- } );
- describe( 'destroy()', () => {
- it( 'should destroy plugins', async () => {
- const context = await Context.create();
- const spy = sinon.spy( context.plugins, 'destroy' );
- await context.destroy();
- sinon.assert.calledOnce( spy );
- } );
- it( 'should destroy all editors with injected context', async () => {
- const context = await Context.create();
- const editorA = await VirtualTestEditor.create( { context } );
- const editorB = await VirtualTestEditor.create( { context } );
- const editorC = await VirtualTestEditor.create();
- sinon.spy( editorA, 'destroy' );
- sinon.spy( editorB, 'destroy' );
- sinon.spy( editorC, 'destroy' );
- await context.destroy();
- sinon.assert.calledOnce( editorA.destroy );
- sinon.assert.calledOnce( editorB.destroy );
- sinon.assert.notCalled( editorC.destroy );
- } );
- it( 'should not crash when destroyed for the second time', async () => {
- const context = await Context.create();
- await VirtualTestEditor.create( { context } );
- await context.destroy();
- await context.destroy();
- } );
- it( 'should not crash when destroyed for the second time - editor own managed context', async () => {
- const editor = await VirtualTestEditor.create();
- await editor.destroy();
- await editor.destroy();
- } );
- } );
- describe( 'builtinPlugins', () => {
- class PluginA extends ContextPlugin {}
- class PluginB extends ContextPlugin {}
- class PluginC extends ContextPlugin {}
- beforeEach( () => {
- Context.builtinPlugins = [ PluginA, PluginB, PluginC ];
- } );
- afterEach( () => {
- delete Context.builtinPlugins;
- } );
- it( 'should load plugins built in the Context even if the passed config is empty', () => {
- const context = new Context();
- return context.initPlugins()
- .then( () => {
- expect( getPlugins( context ).length ).to.equal( 3 );
- expect( context.plugins.get( PluginA ) ).to.be.an.instanceof( ContextPlugin );
- expect( context.plugins.get( PluginB ) ).to.be.an.instanceof( ContextPlugin );
- expect( context.plugins.get( PluginC ) ).to.be.an.instanceof( ContextPlugin );
- } );
- } );
- it( 'should load plugins provided in the config and should ignore plugins built in the Editor', () => {
- const context = new Context( {
- plugins: [
- PluginA
- ]
- } );
- return context.initPlugins()
- .then( () => {
- expect( getPlugins( context ).length ).to.equal( 1 );
- expect( context.plugins.get( PluginA ) ).to.be.an.instanceof( ContextPlugin );
- } );
- } );
- } );
- describe( 'defaultConfig', () => {
- beforeEach( () => {
- Context.defaultConfig = { foo: 1, bar: 2 };
- } );
- afterEach( () => {
- delete Context.defaultConfig;
- } );
- it( 'should extend an editor configuration using built in config', () => {
- const context = new Context( {
- foo: 4
- } );
- expect( context.config.get( 'foo' ) ).to.equal( 4 );
- expect( context.config.get( 'bar' ) ).to.equal( 2 );
- } );
- } );
- } );
- function getPlugins( editor ) {
- return Array.from( editor.plugins )
- .map( entry => entry[ 1 ] ); // Get instances.
- }
|