| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /* global document */
- import Config from '../src/config';
- import areConnectedThroughProperties from '../src/areconnectedthroughproperties';
- describe( 'Config', () => {
- let config;
- beforeEach( () => {
- config = new Config( {
- creator: 'inline',
- language: 'pl',
- resize: {
- minHeight: 300,
- maxHeight: 800,
- icon: {
- path: 'xyz'
- }
- },
- toolbar: 'top',
- options: {
- foo: [
- { bar: 'b' },
- { bar: 'a' },
- { bar: 'z' }
- ]
- }
- } );
- } );
- describe( 'constructor()', () => {
- it( 'should set configurations', () => {
- expect( config.get( 'creator' ) ).to.equal( 'inline' );
- expect( config.get( 'language' ) ).to.equal( 'pl' );
- expect( config.get( 'resize' ) ).to.deep.equal( {
- minHeight: 300,
- maxHeight: 800,
- icon: {
- path: 'xyz'
- }
- } );
- expect( config.get( 'toolbar' ) ).to.equal( 'top' );
- } );
- it( 'should work with no parameters', () => {
- // No error should be thrown.
- config = new Config();
- } );
- it( 'should set default parameters', () => {
- const defaultConfig = {
- foo: 1,
- bar: 2
- };
- config = new Config( {}, defaultConfig );
- expect( config.get( 'foo' ) ).to.equal( 1 );
- expect( config.get( 'bar' ) ).to.equal( 2 );
- } );
- it( 'should copy default configuration to not share properties between config instances [watchdog]', () => {
- const defaultConfig = {
- foo: 1,
- bar: [
- /some regex/,
- {
- baz: {}
- }
- ]
- };
- const config1 = new Config( {}, defaultConfig );
- const config2 = new Config( {}, defaultConfig );
- const areStructuresConnected = areConnectedThroughProperties( config1, config2 );
- expect( areStructuresConnected ).to.be.false;
- } );
- it( 'passed parameters should override default parameters', () => {
- const defaultConfig = {
- foo: 1,
- bar: 2
- };
- config = new Config( {
- foo: 10
- }, defaultConfig );
- expect( config.get( 'foo' ) ).to.equal( 10 );
- expect( config.get( 'bar' ) ).to.equal( 2 );
- } );
- it( 'should work with deeper objects', () => {
- const defaultConfig = {
- a: {
- first: 1,
- second: 2
- },
- b: {
- foo: {
- first: 1,
- second: 2
- }
- }
- };
- const parameters = {
- a: {
- third: 3
- },
- b: {
- foo: {
- first: 3,
- third: 1
- }
- },
- custom: 'foo'
- };
- config = new Config( parameters, defaultConfig );
- expect( config.get( 'a' ) ).to.deep.equal( {
- first: 1,
- second: 2,
- third: 3
- } );
- expect( config.get( 'b' ) ).to.have.key( 'foo' );
- expect( config.get( 'b.foo' ) ).to.deep.equal( {
- first: 3,
- second: 2,
- third: 1
- } );
- expect( config.get( 'custom' ) ).to.equal( 'foo' );
- } );
- } );
- describe( 'set()', () => {
- it( 'should set configurations when passing objects', () => {
- config.set( {
- option1: 1,
- option2: {
- subOption21: 21
- }
- } );
- expect( config.get( 'option1' ) ).to.equal( 1 );
- expect( config.get( 'option2.subOption21' ) ).to.equal( 21 );
- } );
- it( 'should set configurations when passing name and value', () => {
- config.set( 'something', 'anything' );
- expect( config.get( 'something' ) ).to.equal( 'anything' );
- } );
- it( 'should set configurations when passing name.with.deep and value', () => {
- config.set( 'color.red', 'f00' );
- config.set( 'background.color.blue', '00f' );
- expect( config.get( 'color.red' ) ).to.equal( 'f00' );
- expect( config.get( 'background.color.blue' ) ).to.equal( '00f' );
- } );
- it( 'should replace a simple entry with an object', () => {
- config.set( 'test', 1 );
- config.set( 'test', {
- prop: 1
- } );
- expect( config.get( 'test' ) ).to.be.an( 'object' );
- expect( config.get( 'test.prop' ) ).to.equal( 1 );
- } );
- it( 'should replace a simple entry with an object when passing only object', () => {
- config.set( 'test', 1 );
- config.set( {
- test: {
- prop: 1
- }
- } );
- expect( config.get( 'test' ) ).to.be.an( 'object' );
- expect( config.get( 'test.prop' ) ).to.equal( 1 );
- } );
- it( 'should replace a simple entry with an object when passing a name.with.deep', () => {
- config.set( 'test.prop', 1 );
- config.set( 'test.prop.value', 1 );
- expect( config.get( 'test' ) ).to.be.an( 'object' );
- expect( config.get( 'test.prop' ) ).to.be.an( 'object' );
- expect( config.get( 'test.prop.value' ) ).to.equal( 1 );
- } );
- it( 'should override and expand deep configurations', () => {
- config.set( {
- resize: {
- minHeight: 400, // Override
- hidden: true, // Expand
- icon: {
- path: 'abc', // Override
- url: true // Expand
- }
- }
- } );
- expect( config.get( 'resize' ) ).to.be.deep.equal( {
- minHeight: 400, // Overridden
- maxHeight: 800, // The same
- hidden: true, // Expanded
- icon: {
- path: 'abc', // Overridden
- url: true // Expanded
- }
- } );
- } );
- it( 'should override and expand object when passing an object', () => {
- config.set( 'resize', {
- minHeight: 400, // Override
- hidden: true, // Expand
- icon: {
- path: 'abc', // Override
- url: true // Expand
- }
- } );
- expect( config.get( 'resize' ) ).to.deep.equal( {
- minHeight: 400, // Overridden
- maxHeight: 800, // The same
- hidden: true, // Expanded
- icon: {
- path: 'abc', // Overridden
- url: true // Expanded
- }
- } );
- } );
- it( 'should not create object for non-pure objects', () => {
- function SomeClass() {}
- config.set( 'date', new Date() );
- config.set( {
- instance: new SomeClass()
- } );
- expect( config.get( 'date' ) ).to.be.an.instanceof( Date );
- expect( config.get( 'instance' ) ).to.be.an.instanceof( SomeClass );
- } );
- } );
- describe( 'define()', () => {
- it( 'should set configurations when passing objects', () => {
- config.set( {
- option1: 1,
- option2: {
- subOption21: 21
- }
- } );
- expect( config.get( 'option1' ) ).to.equal( 1 );
- expect( config.get( 'option2.subOption21' ) ).to.equal( 21 );
- } );
- it( 'should set configurations when passing name and value', () => {
- config.set( 'something', 'anything' );
- expect( config.get( 'something' ) ).to.equal( 'anything' );
- } );
- it( 'should set configurations when passing name.with.deep and value', () => {
- config.set( 'color.red', 'f00' );
- config.set( 'background.color.blue', '00f' );
- expect( config.get( 'color.red' ) ).to.equal( 'f00' );
- expect( config.get( 'background.color.blue' ) ).to.equal( '00f' );
- } );
- it( 'should not replace already defined values', () => {
- config.define( 'language', 'en' );
- config.define( 'resize.minHeight', 400 );
- config.define( 'resize.icon', 'some value' );
- expect( config.get( 'language' ) ).to.equal( 'pl' );
- expect( config.get( 'resize.icon' ) ).to.be.an( 'object' );
- expect( config.get( 'resize.minHeight' ) ).to.equal( 300 );
- } );
- it( 'should expand but not override deep configurations', () => {
- config.define( {
- resize: {
- minHeight: 400, // No override
- hidden: true, // Expand
- icon: {
- path: 'abc', // No override
- url: true // Expand
- }
- }
- } );
- expect( config.get( 'resize' ) ).to.be.deep.equal( {
- minHeight: 300, // The same
- maxHeight: 800, // The same
- hidden: true, // Expanded
- icon: {
- path: 'xyz', // The same
- url: true // Expanded
- }
- } );
- } );
- it( 'should expand but not override when passing an object', () => {
- config.define( 'resize', {
- minHeight: 400, // No override
- hidden: true, // Expand
- icon: {
- path: 'abc', // No override
- url: true // Expand
- }
- } );
- expect( config.get( 'resize' ) ).to.be.deep.equal( {
- minHeight: 300, // The same
- maxHeight: 800, // The same
- hidden: true, // Expanded
- icon: {
- path: 'xyz', // The same
- url: true // Expanded
- }
- } );
- } );
- it( 'should not create an object for non-pure objects', () => {
- function SomeClass() {}
- config.define( 'date', new Date() );
- config.define( {
- instance: new SomeClass()
- } );
- expect( config.get( 'date' ) ).to.be.an.instanceof( Date );
- expect( config.get( 'instance' ) ).to.be.an.instanceof( SomeClass );
- } );
- } );
- describe( 'get()', () => {
- it( 'should retrieve a configuration', () => {
- expect( config.get( 'creator' ) ).to.equal( 'inline' );
- } );
- it( 'should retrieve a deep configuration', () => {
- expect( config.get( 'resize.minHeight' ) ).to.equal( 300 );
- expect( config.get( 'resize.icon.path' ) ).to.equal( 'xyz' );
- } );
- it( 'should retrieve an object of the configuration', () => {
- const resize = config.get( 'resize' );
- expect( resize ).to.be.an( 'object' );
- expect( resize.minHeight ).equal( 300 );
- expect( resize.maxHeight ).to.equal( 800 );
- expect( resize.icon ).to.be.an( 'object' );
- expect( resize.icon ).to.be.an( 'object' );
- } );
- it( 'should not retrieve values case-insensitively', () => {
- expect( config.get( 'Creator' ) ).to.be.undefined;
- expect( config.get( 'resize.MINHEIGHT' ) ).to.be.undefined;
- } );
- it( 'should return undefined for non existing configuration', () => {
- expect( config.get( 'invalid' ) ).to.be.undefined;
- } );
- it( 'should return undefined for empty configuration', () => {
- config = new Config();
- expect( config.get( 'invalid' ) ).to.be.undefined;
- expect( config.get( 'deep.invalid' ) ).to.be.undefined;
- } );
- it( 'should return undefined for non existing deep configuration', () => {
- expect( config.get( 'resize.invalid.value' ) ).to.be.undefined;
- } );
- it( 'should not be possible to retrieve value directly from config object', () => {
- expect( config.creator ).to.be.undefined;
- expect( () => {
- config.resize.maxHeight;
- } ).to.throw();
- } );
- it( 'should not be possible to alter config object by altering returned value', () => {
- expect( config.get( 'resize.icon.path' ) ).to.equal( 'xyz' );
- const icon = config.get( 'resize.icon' );
- icon.path = 'foo/bar';
- expect( config.get( 'resize.icon.path' ) ).to.equal( 'xyz' );
- const resize = config.get( 'resize' );
- resize.icon.path = 'foo/baz';
- expect( config.get( 'resize.icon.path' ) ).to.equal( 'xyz' );
- } );
- it( 'should not be possible to alter array in config by altering returned value', () => {
- expect( config.get( 'options.foo' ) ).to.deep.equal( [ { bar: 'b' }, { bar: 'a' }, { bar: 'z' } ] );
- const fooOptions = config.get( 'options.foo' );
- fooOptions.pop();
- expect( config.get( 'options.foo' ) ).to.deep.equal( [ { bar: 'b' }, { bar: 'a' }, { bar: 'z' } ] );
- const options = config.get( 'options' );
- options.foo.pop();
- expect( config.get( 'options.foo' ) ).to.deep.equal( [ { bar: 'b' }, { bar: 'a' }, { bar: 'z' } ] );
- } );
- it( 'should return class & functions references from config array', () => {
- class Foo {}
- function bar() {
- return 'bar';
- }
- const baz = () => 'baz';
- config.set( 'plugins', [ Foo, bar, baz ] );
- expect( config.get( 'plugins' ) ).to.deep.equal( [ Foo, bar, baz ] );
- const plugins = config.get( 'plugins' );
- expect( plugins[ 0 ] ).to.equal( Foo );
- expect( plugins[ 1 ] ).to.equal( bar );
- expect( plugins[ 2 ] ).to.equal( baz );
- const pluginsAgain = config.get( 'plugins' );
- // The returned array should be a new instance:
- expect( pluginsAgain ).to.not.equal( plugins );
- // But array members should remain the same contents should be equal:
- expect( pluginsAgain ).to.deep.equal( plugins );
- } );
- it( 'should return DOM nodes references from config array', () => {
- const foo = document.createElement( 'div' );
- config.set( 'node', foo );
- config.set( 'nodes', [ foo ] );
- expect( config.get( 'node' ) ).to.equal( foo );
- expect( config.get( 'nodes' ) ).to.deep.equal( [ foo ] );
- const nodes = config.get( 'nodes' );
- expect( nodes[ 0 ] ).to.equal( foo );
- const nodesAgain = config.get( 'nodes' );
- // The returned array should be a new instance:
- expect( nodesAgain ).to.not.equal( nodes );
- // But array members should remain the same contents should be equal:
- expect( nodesAgain ).to.deep.equal( nodes );
- } );
- } );
- describe( 'names()', () => {
- it( 'should return an iterator of top level names of the configuration', () => {
- expect( Array.from( config.names() ) ).to.be.deep.equal( [ 'creator', 'language', 'resize', 'toolbar', 'options' ] );
- } );
- } );
- } );
|