/** * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ 'use strict'; /* global console:false */ import amdUtils from '/tests/_utils/amd.js'; import EmitterMixin from '/ckeditor5/core/emittermixin.js'; const utils = { /** * Defines CKEditor plugin which is a mock of an editor creator. * * If `proto` is not set or it does not define `create()` and `destroy()` methods, * then they will be set to Sinon spies. Therefore the shortest usage is: * * testUtils.defineEditorCreatorMock( 'test1' ); * * The mocked creator is available under: * * editor.plugins.get( 'creator-thename' ); * * @param {String} creatorName Name of the creator. * @param {Object} [proto] Prototype of the creator. Properties from the proto param will * be copied to the prototype of the creator. */ defineEditorCreatorMock( creatorName, proto ) { amdUtils.define( 'creator-' + creatorName, [ 'core/creator' ], ( Creator ) => { class TestCreator extends Creator {} if ( proto ) { for ( let propName in proto ) { TestCreator.prototype[ propName ] = proto[ propName ]; } } if ( !TestCreator.prototype.create ) { TestCreator.prototype.create = sinon.spy().named( creatorName + '-create' ); } if ( !TestCreator.prototype.destroy ) { TestCreator.prototype.destroy = sinon.spy().named( creatorName + '-destroy' ); } return TestCreator; } ); }, /** * Returns the number of elements return by the iterator. * * testUtils.getIteratorCount( [ 1, 2, 3, 4, 5 ] ); // 5; * * @param {Iterable.<*>} iterator Any iterator. * @returns {Number} Number of elements returned by that iterator. */ getIteratorCount( iterator ) { let count = 0; for ( let _ of iterator ) { // jshint ignore:line count++; } return count; }, /** * Creates an instance inheriting from {@link core.EmitterMixin} with one additional method `observe()`. * It allows observing changes to attributes in objects being {@link core.Observable observable}. * * The `observe()` method accepts: * * * `{String} observableName` – Identifier for the observable object. E.g. `"Editable"` when * you observe one of editor's editables. This name will be displayed on the console. * * `{core.Observable observable} – The object to observe. * * Typical usage: * * const observer = utils.createObserver(); * observer.observe( 'Editable', editor.editables.current ); * * // Stop listening (method from the EmitterMixin): * observer.stopListening(); * * @returns {Emitter} The observer. */ createObserver() { const observer = Object.create( EmitterMixin, { observe: { value: function observe( observableName, observable ) { observer.listenTo( observable, 'change', ( evt, propertyName, value, oldValue ) => { console.log( `[Change in ${ observableName }] ${ propertyName } = '${ value }' (was '${ oldValue }')` ); } ); return observer; } } } ); return observer; } }; export default utils;