@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/dev-utils/operationreplayer.js

@@ -2,139 +2,119 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/dev-utils/operationreplayer
  */
-
 /* global setTimeout */
-
 import OperationFactory from '../model/operation/operationfactory';
-
 /**
  * Operation replayer is a development tool created for easy replaying of operations on the document from stringified operations.
  */
 export default class OperationReplayer {
-	/**
-	 * @param {module:engine/model/model~Model} model Data model.
-	 * @param {String} logSeparator Separator between operations.
-	 * @param {String} stringifiedOperations Operations to replay.
-	 */
-	constructor( model, logSeparator, stringifiedOperations ) {
-		this._model = model;
-		this._logSeparator = logSeparator;
-		this.setStringifiedOperations( stringifiedOperations );
-	}
-
-	/**
-	 * Parses the given string containing stringified operations and sets parsed operations as operations to replay.
-	 *
-	 * @param {String} stringifiedOperations Stringified operations to replay.
-	 */
-	setStringifiedOperations( stringifiedOperations ) {
-		if ( stringifiedOperations === '' ) {
-			this._operationsToReplay = [];
-
-			return;
-		}
-
-		this._operationsToReplay = stringifiedOperations
-			.split( this._logSeparator )
-			.map( stringifiedOperation => JSON.parse( stringifiedOperation ) );
-	}
-
-	/**
-	 * Returns operations to replay.
-	 *
-	 * @returns {Array.<module:engine/model/operation/operation~Operation>}
-	 */
-	getOperationsToReplay() {
-		return this._operationsToReplay;
-	}
-
-	/**
-	 * Applies all operations with a delay between actions.
-	 *
-	 * @param {Number} timeInterval Time between applying operations.
-	 * @returns {Promise}
-	 */
-	play( timeInterval = 1000 ) {
-		const operationReplayer = this; // eslint-disable-line consistent-this
-
-		return new Promise( ( res, rej ) => {
-			play();
-
-			function play() {
-				operationReplayer.applyNextOperation().then( isFinished => {
-					if ( isFinished ) {
-						return res();
-					}
-
-					setTimeout( play, timeInterval );
-				} ).catch( err => {
-					rej( err );
-				} );
-			}
-		} );
-	}
-
-	/**
-	 * Applies `numberOfOperations` operations, beginning after the last applied operation (or first, if no operations were applied).
-	 *
-	 * @param {Number} numberOfOperations The number of operations to apply.
-	 * @returns {Promise}
-	 */
-	applyOperations( numberOfOperations ) {
-		if ( numberOfOperations <= 0 ) {
-			return;
-		}
-
-		return this.applyNextOperation()
-			.then( isFinished => {
-				if ( !isFinished ) {
-					return this.applyOperations( numberOfOperations - 1 );
-				}
-			} );
-	}
-
-	/**
-	 * Applies all operations to replay at once.
-	 *
-	 * @returns {Promise}
-	 */
-	applyAllOperations() {
-		return this.applyNextOperation()
-			.then( isFinished => {
-				if ( !isFinished ) {
-					return this.applyAllOperations();
-				}
-			} );
-	}
-
-	/**
-	 * Applies the next operation to replay. Returns a promise with the `isFinished` parameter that is `true` if the last
-	 * operation in the replayer has been applied, `false` otherwise.
-	 *
-	 * @returns {Promise.<Boolean>}
-	 */
-	applyNextOperation() {
-		const model = this._model;
-
-		return new Promise( res => {
-			model.enqueueChange( writer => {
-				const operationJson = this._operationsToReplay.shift();
-
-				if ( !operationJson ) {
-					return res( true );
-				}
-
-				const operation = OperationFactory.fromJSON( operationJson, model.document );
-
-				writer.batch.addOperation( operation );
-				model.applyOperation( operation );
-
-				res( false );
-			} );
-		} );
-	}
+    /**
+     * @param {module:engine/model/model~Model} model Data model.
+     * @param {String} logSeparator Separator between operations.
+     * @param {String} stringifiedOperations Operations to replay.
+     */
+    constructor(model, logSeparator, stringifiedOperations) {
+        this._model = model;
+        this._logSeparator = logSeparator;
+        this.setStringifiedOperations(stringifiedOperations);
+    }
+    /**
+     * Parses the given string containing stringified operations and sets parsed operations as operations to replay.
+     *
+     * @param {String} stringifiedOperations Stringified operations to replay.
+     */
+    setStringifiedOperations(stringifiedOperations) {
+        if (stringifiedOperations === '') {
+            this._operationsToReplay = [];
+            return;
+        }
+        this._operationsToReplay = stringifiedOperations
+            .split(this._logSeparator)
+            .map(stringifiedOperation => JSON.parse(stringifiedOperation));
+    }
+    /**
+     * Returns operations to replay.
+     *
+     * @returns {Array.<module:engine/model/operation/operation~Operation>}
+     */
+    getOperationsToReplay() {
+        return this._operationsToReplay;
+    }
+    /**
+     * Applies all operations with a delay between actions.
+     *
+     * @param {Number} timeInterval Time between applying operations.
+     * @returns {Promise}
+     */
+    play(timeInterval = 1000) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
+        const operationReplayer = this;
+        return new Promise((res, rej) => {
+            play();
+            function play() {
+                operationReplayer.applyNextOperation().then(isFinished => {
+                    if (isFinished) {
+                        return res();
+                    }
+                    setTimeout(play, timeInterval);
+                }).catch(err => {
+                    rej(err);
+                });
+            }
+        });
+    }
+    /**
+     * Applies `numberOfOperations` operations, beginning after the last applied operation (or first, if no operations were applied).
+     *
+     * @param {Number} numberOfOperations The number of operations to apply.
+     * @returns {Promise}
+     */
+    applyOperations(numberOfOperations) {
+        if (numberOfOperations <= 0) {
+            return;
+        }
+        return this.applyNextOperation()
+            .then(isFinished => {
+            if (!isFinished) {
+                return this.applyOperations(numberOfOperations - 1);
+            }
+        });
+    }
+    /**
+     * Applies all operations to replay at once.
+     *
+     * @returns {Promise}
+     */
+    applyAllOperations() {
+        return this.applyNextOperation()
+            .then(isFinished => {
+            if (!isFinished) {
+                return this.applyAllOperations();
+            }
+        });
+    }
+    /**
+     * Applies the next operation to replay. Returns a promise with the `isFinished` parameter that is `true` if the last
+     * operation in the replayer has been applied, `false` otherwise.
+     *
+     * @returns {Promise.<Boolean>}
+     */
+    applyNextOperation() {
+        const model = this._model;
+        return new Promise(res => {
+            model.enqueueChange(writer => {
+                const operationJson = this._operationsToReplay.shift();
+                if (!operationJson) {
+                    return res(true);
+                }
+                const operation = OperationFactory.fromJSON(operationJson, model.document);
+                writer.batch.addOperation(operation);
+                model.applyOperation(operation);
+                res(false);
+            });
+        });
+    }
 }

package/src/dev-utils/utils.js

@@ -2,7 +2,6 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * Note: This package is used only internally for debugging purposes and should not be used
  * in other environments. It uses a few special methods not existing in the default
@@ -10,9 +9,7 @@
  *
  * @module engine/dev-utils/utils
  */
-
 /* globals console */
-
 /**
  * Helper function, converts a map to the 'key1="value1" key2="value1"' format.
  *
@@ -20,16 +17,13 @@
  * @param {Map} map Map to convert.
  * @returns {String} Converted map.
  */
-export function convertMapToTags( map ) {
-	let string = '';
-
-	for ( const entry of map ) {
-		string += ` ${ entry[ 0 ] }=${ JSON.stringify( entry[ 1 ] ) }`;
-	}
-
-	return string;
+export function convertMapToTags(map) {
+    let string = '';
+    for (const entry of map) {
+        string += ` ${entry[0]}=${JSON.stringify(entry[1])}`;
+    }
+    return string;
 }
-
 /**
  * Helper function, converts a map to the '{"key1":"value1","key2":"value2"}' format.
  *
@@ -37,19 +31,15 @@ export function convertMapToTags( map ) {
  * @param {Map} map Map to convert.
  * @returns {String} Converted map.
  */
-export function convertMapToStringifiedObject( map ) {
-	const obj = {};
-
-	for ( const entry of map ) {
-		obj[ entry[ 0 ] ] = entry[ 1 ];
-	}
-
-	return JSON.stringify( obj );
+export function convertMapToStringifiedObject(map) {
+    const obj = {};
+    for (const entry of map) {
+        obj[entry[0]] = entry[1];
+    }
+    return JSON.stringify(obj);
 }
-
-const treeDump = Symbol( '_treeDump' );
+const treeDump = Symbol('_treeDump');
 const maxTreeDumpLength = 20;
-
 /**
  * Helper function that stores the `document` state for a given `version`.
  *
@@ -57,34 +47,27 @@ const maxTreeDumpLength = 20;
  * @param {*} document
  * @param {*} version
  */
-export function dumpTrees( document, version ) {
-	console.log( document, version );
-
-	let string = '';
-
-	for ( const root of document.roots ) {
-		string += root.printTree() + '\n';
-	}
-
-	document[ treeDump ][ version ] = string.substr( 0, string.length - 1 ); // Remove the last "\n".
-
-	const overflow = document[ treeDump ].length - maxTreeDumpLength;
-
-	if ( overflow > 0 ) {
-		document[ treeDump ][ overflow - 1 ] = null;
-	}
+export function dumpTrees(document, version) {
+    console.log(document, version);
+    let string = '';
+    for (const root of document.roots) {
+        string += root.printTree() + '\n';
+    }
+    document[treeDump][version] = string.substr(0, string.length - 1); // Remove the last "\n".
+    const overflow = document[treeDump].length - maxTreeDumpLength;
+    if (overflow > 0) {
+        document[treeDump][overflow - 1] = null;
+    }
 }
-
 /**
  * Helper function that initializes document dumping.
  *
  * @private
  * @param {*} document
  */
-export function initDocumentDumping( document ) {
-	document[ treeDump ] = [];
+export function initDocumentDumping(document) {
+    document[treeDump] = [];
 }
-
 /**
  * Helper function that logs document for the given version.
  *
@@ -92,12 +75,12 @@ export function initDocumentDumping( document ) {
  * @param {*} document
  * @param {*} version
  */
-export function logDocument( document, version ) {
-	console.log( '--------------------' );
-
-	if ( document[ treeDump ][ version ] ) {
-		console.log( document[ treeDump ][ version ] );
-	} else {
-		console.log( 'Tree log unavailable for given version: ' + version );
-	}
+export function logDocument(document, version) {
+    console.log('--------------------');
+    if (document[treeDump][version]) {
+        console.log(document[treeDump][version]);
+    }
+    else {
+        console.log('Tree log unavailable for given version: ' + version);
+    }
 }