From 9548f455988f92266d61b68c321827482fe1d0f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 20 Oct 2017 13:40:29 +0200 Subject: [PATCH 001/724] Other: Make Position immutable. --- src/model/delta/basic-transformations.js | 28 +- src/model/liveposition.js | 6 +- src/model/position.js | 254 ++++++++++----- src/model/range.js | 20 +- src/model/treewalker.js | 44 +-- tests/model/delta/transform/_utils/utils.js | 24 +- tests/model/delta/transform/movedelta.js | 4 +- tests/model/delta/transform/splitdelta.js | 13 +- tests/model/liverange.js | 10 +- tests/model/operation/transform.js | 326 ++++++++++---------- tests/model/position.js | 24 -- tests/model/range.js | 3 +- 12 files changed, 413 insertions(+), 343 deletions(-) diff --git a/src/model/delta/basic-transformations.js b/src/model/delta/basic-transformations.js index 5d25305a7..ecf49b165 100644 --- a/src/model/delta/basic-transformations.js +++ b/src/model/delta/basic-transformations.js @@ -73,8 +73,7 @@ addTransformationCase( AttributeDelta, SplitDelta, ( a, b, context ) => { const additionalAttributeDelta = new AttributeDelta(); const rangeStart = splitPosition.getShiftedBy( 1 ); - const rangeEnd = Position.createFromPosition( rangeStart ); - rangeEnd.path.push( 0 ); + const rangeEnd = rangeStart.getMovedToChild(); const oldValue = b._cloneOperation.nodes.getNode( 0 ).getAttribute( operation.key ); @@ -236,7 +235,7 @@ addTransformationCase( SplitDelta, SplitDelta, ( a, b, context ) => { a._cloneOperation instanceof ReinsertOperation && b._cloneOperation instanceof ReinsertOperation && a._cloneOperation.sourcePosition.offset > b._cloneOperation.sourcePosition.offset ) { - a._cloneOperation.sourcePosition.offset--; + a._cloneOperation.sourcePosition = a._cloneOperation.sourcePosition.getShiftedBy( -1 ); } // `a` splits closer or at same offset. @@ -317,29 +316,24 @@ addTransformationCase( SplitDelta, WrapDelta, ( a, b, context ) => { // Wrapping element is the element inserted by WrapDelta (re)insert operation. // It is inserted after the wrapped range, but the wrapped range will be moved inside it. // Having this in mind, it is correct to use wrapped range start position as the position before wrapping element. - const splitNodePos = Position.createFromPosition( b.range.start ); + // Now, `splitNodePos` points before wrapping element. // To get a position before last children of that element, we expand position's `path` member by proper offset. - splitNodePos.path.push( b.howMany - 1 ); + const splitNodePos = b.range.start.getMovedToChild( b.howMany - 1 ); // SplitDelta insert operation position should be right after the node we split. - const insertPos = splitNodePos.getShiftedBy( 1 ); - delta._cloneOperation.position = insertPos; + delta._cloneOperation.position = splitNodePos.getShiftedBy( 1 ); // 2. Fix move operation source position. // Nodes moved by SplitDelta will be moved from new position, modified by WrapDelta. // To obtain that new position, `splitNodePos` will be used, as this is the node we are extracting children from. - const sourcePos = Position.createFromPosition( splitNodePos ); // Nothing changed inside split node so it is correct to use the original split position offset. - sourcePos.path.push( a.position.offset ); - delta._moveOperation.sourcePosition = sourcePos; + delta._moveOperation.sourcePosition = splitNodePos.getMovedToChild( a.position.offset ); // 3. Fix move operation target position. // SplitDelta move operation target position should be inside the node inserted by operation above. // Since the node is empty, we will insert at offset 0. - const targetPos = Position.createFromPosition( insertPos ); - targetPos.path.push( 0 ); - delta._moveOperation.targetPosition = targetPos; + delta._moveOperation.targetPosition = splitNodePos.getShiftedBy( 1 ).getMovedToChild(); return [ delta ]; } @@ -434,13 +428,17 @@ addTransformationCase( WrapDelta, SplitDelta, ( a, b, context ) => { const delta = a.clone(); // Move wrapping element insert position one node further so it is after the split node insertion. - delta._insertOperation.position.offset++; + delta._insertOperation.position = delta._insertOperation.position.getShiftedBy( 1 ); // Include the split node copy. delta._moveOperation.howMany++; // Change the path to wrapping element in move operation. - delta._moveOperation.targetPosition.path[ delta._moveOperation.targetPosition.path.length - 2 ]++; + const index = delta._moveOperation.targetPosition.path.length - 2; + + const path = delta._moveOperation.targetPosition.path.slice(); + path[ index ] += 1; + delta._moveOperation.targetPosition = delta._moveOperation.targetPosition.getMovedToPath( path ); return [ delta ]; } diff --git a/src/model/liveposition.js b/src/model/liveposition.js index 9a19412d1..f9f2213d0 100644 --- a/src/model/liveposition.js +++ b/src/model/liveposition.js @@ -7,7 +7,7 @@ * @module engine/model/liveposition */ -import Position from './position'; +import Position, { setPath, setRoot } from './position'; import Range from './range'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; @@ -194,8 +194,8 @@ function transform( type, range, position ) { if ( !this.isEqual( transformed ) ) { const oldPosition = Position.createFromPosition( this ); - this.path = transformed.path; - this.root = transformed.root; + setPath( this, transformed.path ); + setRoot( this, transformed.root ); this.fire( 'change', oldPosition ); } diff --git a/src/model/position.js b/src/model/position.js index 7d199b617..d3037b96c 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -13,6 +13,9 @@ import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import Text from './text'; +const _path = Symbol( 'path' ); +const _root = Symbol( 'root' ); + /** * Represents a position in the model tree. * @@ -66,64 +69,66 @@ export default class Position { // Normalize the root and path (if element was passed). path = root.getPath().concat( path ); - root = root.root; - - /** - * Root of the position path. - * - * @readonly - * @member {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} - * module:engine/model/position~Position#root - */ - this.root = root; - - /** - * Position of the node in the tree. **Path contains offsets, not indexes.** - * - * Position can be placed before, after or in a {@link module:engine/model/node~Node node} if that node has - * {@link module:engine/model/node~Node#offsetSize} greater than `1`. Items in position path are - * {@link module:engine/model/node~Node#startOffset starting offsets} of position ancestors, starting from direct root children, - * down to the position offset in it's parent. - * - * ROOT - * |- P before: [ 0 ] after: [ 1 ] - * |- UL before: [ 1 ] after: [ 2 ] - * |- LI before: [ 1, 0 ] after: [ 1, 1 ] - * | |- foo before: [ 1, 0, 0 ] after: [ 1, 0, 3 ] - * |- LI before: [ 1, 1 ] after: [ 1, 2 ] - * |- bar before: [ 1, 1, 0 ] after: [ 1, 1, 3 ] - * - * `foo` and `bar` are representing {@link module:engine/model/text~Text text nodes}. Since text nodes has offset size - * greater than `1` you can place position offset between their start and end: - * - * ROOT - * |- P - * |- UL - * |- LI - * | |- f^o|o ^ has path: [ 1, 0, 1 ] | has path: [ 1, 0, 2 ] - * |- LI - * |- b^a|r ^ has path: [ 1, 1, 1 ] | has path: [ 1, 1, 2 ] - * - * @member {Array.} module:engine/model/position~Position#path - */ - this.path = path; + + // Make path immutable + Object.freeze( path ); + + setRoot( this, root.root ); + setPath( this, path ); } /** - * Offset at which this position is located in its {@link module:engine/model/position~Position#parent parent}. It is equal - * to the last item in position {@link module:engine/model/position~Position#path path}. + * Position of the node in the tree. **Path contains offsets, not indexes.** + * + * Position can be placed before, after or in a {@link module:engine/model/node~Node node} if that node has + * {@link module:engine/model/node~Node#offsetSize} greater than `1`. Items in position path are + * {@link module:engine/model/node~Node#startOffset starting offsets} of position ancestors, starting from direct root children, + * down to the position offset in it's parent. + * + * ROOT + * |- P before: [ 0 ] after: [ 1 ] + * |- UL before: [ 1 ] after: [ 2 ] + * |- LI before: [ 1, 0 ] after: [ 1, 1 ] + * | |- foo before: [ 1, 0, 0 ] after: [ 1, 0, 3 ] + * |- LI before: [ 1, 1 ] after: [ 1, 2 ] + * |- bar before: [ 1, 1, 0 ] after: [ 1, 1, 3 ] + * + * `foo` and `bar` are representing {@link module:engine/model/text~Text text nodes}. Since text nodes has offset size + * greater than `1` you can place position offset between their start and end: + * + * ROOT + * |- P + * |- UL + * |- LI + * | |- f^o|o ^ has path: [ 1, 0, 1 ] | has path: [ 1, 0, 2 ] + * |- LI + * |- b^a|r ^ has path: [ 1, 1, 1 ] | has path: [ 1, 1, 2 ] + * + * @member {Array.} module:engine/model/position~Position#path + */ + get path() { + return this[ _path ]; + } + + /** + * Root of the position path. * - * @type {Number} + * @readonly + * @member {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} + * module:engine/model/position~Position#root */ - get offset() { - return last( this.path ); + get root() { + return this[ _root ]; } /** - * @param {Number} newOffset + * Offset at which this position is located in its {@link module:engine/model/position~Position#parent parent}. It is equal + * to the last item in position {@link module:engine/model/position~Position#path path}. + * + * @type {Number} */ - set offset( newOffset ) { - this.path[ this.path.length - 1 ] = newOffset; + get offset() { + return getOffset( this.path ); } /** @@ -340,6 +345,31 @@ export default class Position { return i === 0 ? null : ancestorsA[ i - 1 ]; } + /** + * Returns a new instance of `Position`, that has same {@link #root root} but it's path is set to `path` value. + * + * @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. + * @returns {module:engine/model/position~Position} Moved position. + */ + getMovedToPath( path ) { + return new Position( this.root, path ); + } + + /** + * Returns a new instance of `Position`, that has same {@link #parent parent} but it's offset + * is set to `offset` value. + * + * @param {Number} offset Position offset. See {@link module:engine/model/position~Position#offset}. + * @returns {module:engine/model/position~Position} Moved position. + */ + getShiftedTo( offset ) { + const path = this.path.slice(); + + setOffset( path, offset ); + + return this.getMovedToPath( path ); + } + /** * Returns a new instance of `Position`, that has same {@link #parent parent} but it's offset * is shifted by `shift` value (can be a negative value). @@ -348,12 +378,31 @@ export default class Position { * @returns {module:engine/model/position~Position} Shifted position. */ getShiftedBy( shift ) { - const shifted = Position.createFromPosition( this ); + const newOffset = this.offset + shift; + + return this.getShiftedTo( newOffset < 0 ? 0 : newOffset ); + } + + /** + * Returns a new instance of `Position`, that has same {@link #root root} but it's moved in path by one level up. + * + * @returns {module:engine/model/position~Position} Moved position. + */ + getMovedToParent() { + return this.getMovedToPath( this.getParentPath() ); + } + + /** + * Returns a new instance of `Position`, that has same {@link #root root} but it's moved in path by one level down. + * + * @returns {module:engine/model/position~Position} Moved position. + */ + getMovedToChild( offsetInChild = 0 ) { + const path = this.path.slice(); - const offset = shifted.offset + shift; - shifted.offset = offset < 0 ? 0 : offset; + path.push( offsetInChild ); - return shifted; + return this.getMovedToPath( path ); } /** @@ -433,13 +482,13 @@ export default class Position { return true; case 'before': - left = Position.createFromPosition( this ); - right = Position.createFromPosition( otherPosition ); + left = this; // eslint-disable-line consistent-this + right = otherPosition; break; case 'after': - left = Position.createFromPosition( otherPosition ); - right = Position.createFromPosition( this ); + left = otherPosition; + right = this; // eslint-disable-line consistent-this break; default: @@ -459,19 +508,30 @@ export default class Position { return false; } - left.path = left.path.slice( 0, -1 ); + left = left.getMovedToParent().getShiftedBy( 1 ); leftParent = leftParent.parent; - left.offset++; } else { if ( right.offset !== 0 ) { return false; } - right.path = right.path.slice( 0, -1 ); + right = right.getMovedToParent(); } } } + /** + * Converts `Position` to plain object and returns it. + * + * @returns {Object} `Position` converted to plain object. + */ + toJSON() { + return { + root: this.root.toJSON(), + path: this.path + }; + } + /** * Returns a copy of this position that is updated by removing `howMany` nodes starting from `deletePosition`. * It may happen that this position is in a removed node. If that is the case, `null` is returned instead. @@ -482,14 +542,14 @@ export default class Position { * @returns {module:engine/model/position~Position|null} Transformed position or `null`. */ _getTransformedByDeletion( deletePosition, howMany ) { - const transformed = Position.createFromPosition( this ); - // This position can't be affected if deletion was in a different root. if ( this.root != deletePosition.root ) { - return transformed; + return this; } - if ( compareArrays( deletePosition.getParentPath(), this.getParentPath() ) == 'same' ) { + const comparisonResult = compareArrays( deletePosition.getParentPath(), this.getParentPath() ); + + if ( comparisonResult == 'same' ) { // If nodes are removed from the node that is pointed by this position... if ( deletePosition.offset < this.offset ) { // And are removed from before an offset of that position... @@ -497,11 +557,10 @@ export default class Position { // Position is in removed range, it's no longer in the tree. return null; } else { - // Decrement the offset accordingly. - transformed.offset -= howMany; + return this.getShiftedBy( -howMany ); } } - } else if ( compareArrays( deletePosition.getParentPath(), this.getParentPath() ) == 'prefix' ) { + } else if ( comparisonResult == 'prefix' ) { // If nodes are removed from a node that is on a path to this position... const i = deletePosition.path.length - 1; @@ -513,12 +572,14 @@ export default class Position { return null; } else { // Otherwise, decrement index on that path. - transformed.path[ i ] -= howMany; + const path = this.path.slice(); + path[ i ] -= howMany; + return this.getMovedToPath( path ); } } } - return transformed; + return this; } /** @@ -533,11 +594,9 @@ export default class Position { * @returns {module:engine/model/position~Position} Transformed position. */ _getTransformedByInsertion( insertPosition, howMany, insertBefore ) { - const transformed = Position.createFromPosition( this ); - // This position can't be affected if insertion was in a different root. if ( this.root != insertPosition.root ) { - return transformed; + return this; } if ( compareArrays( insertPosition.getParentPath(), this.getParentPath() ) == 'same' ) { @@ -545,7 +604,7 @@ export default class Position { if ( insertPosition.offset < this.offset || ( insertPosition.offset == this.offset && insertBefore ) ) { // And are inserted before an offset of that position... // "Push" this positions offset. - transformed.offset += howMany; + return this.getShiftedBy( howMany ); } } else if ( compareArrays( insertPosition.getParentPath(), this.getParentPath() ) == 'prefix' ) { // If nodes are inserted in a node that is on a path to this position... @@ -554,11 +613,13 @@ export default class Position { if ( insertPosition.offset <= this.path[ i ] ) { // And are inserted before next node of that path... // "Push" the index on that path. - transformed.path[ i ] += howMany; + const path = this.path.slice(); + path[ i ] += howMany; + return this.getMovedToPath( path ); } } - return transformed; + return this; } /** @@ -626,18 +687,18 @@ export default class Position { const i = source.path.length - 1; // The first part of a path to combined position is a path to the place where nodes were moved. - const combined = Position.createFromPosition( target ); + let combinedPath = target.path.slice(); // Then we have to update the rest of the path. // Fix the offset because this position might be after `from` position and we have to reflect that. - combined.offset = combined.offset + this.path[ i ] - source.offset; + setOffset( combinedPath, getOffset( combinedPath ) + this.path[ i ] - source.offset ); // Then, add the rest of the path. // If this position is at the same level as `from` position nothing will get added. - combined.path = combined.path.concat( this.path.slice( i + 1 ) ); + combinedPath = combinedPath.concat( this.path.slice( i + 1 ) ); - return combined; + return new Position( target.root, combinedPath ); } /** @@ -781,6 +842,41 @@ export default class Position { } } +/** + * Method used to expose root setter to child classes. + * @protected + * @param {module:engine/model/position~Position} position Position of which root should be modified. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} root Root of the position. + */ +export function setRoot( position, root ) { + position[ _root ] = root; +} + +/** + * Method used to expose path setter to child classes. + * @protected + * @param {module:engine/model/position~Position} position Position of which path should be modified. + * @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. + */ +export function setPath( position, path ) { + position[ _path ] = path; +} + +// Helper for setting offset on give path array. +// @private +// @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. +function getOffset( path ) { + return last( path ) || 0; +} + +// Helper for setting offset on give path array. +// @private +// @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. +// @param {Number} newOffset Offset to set. +function setOffset( path, newOffset ) { + path[ path.length - 1 ] = newOffset; +} + /** * A flag indicating whether this position is `'before'` or `'after'` or `'same'` as given position. * If positions are in different roots `'different'` flag is returned. diff --git a/src/model/range.js b/src/model/range.js index e8fcd56bf..353309c28 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -30,7 +30,7 @@ export default class Range { * @readonly * @member {module:engine/model/position~Position} */ - this.start = Position.createFromPosition( start ); + this.start = start; /** * End position. @@ -38,7 +38,7 @@ export default class Range { * @readonly * @member {module:engine/model/position~Position} */ - this.end = end ? Position.createFromPosition( end ) : Position.createFromPosition( start ); + this.end = end ? end : start; } /** @@ -280,7 +280,7 @@ export default class Range { const ranges = []; const diffAt = this.start.getCommonPath( this.end ).length; - const pos = Position.createFromPosition( this.start ); + let pos = this.start; let posParent = pos.parent; // Go up. @@ -291,8 +291,8 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - pos.path = pos.path.slice( 0, -1 ); - pos.offset++; + pos = pos.getMovedToParent().getShiftedBy( 1 ); + posParent = posParent.parent; } @@ -305,8 +305,7 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - pos.offset = offset; - pos.path.push( 0 ); + pos = pos.getShiftedTo( offset ).getMovedToChild(); } return ranges; @@ -755,9 +754,8 @@ export default class Range { */ static createCollapsedAt( itemOrPosition, offset ) { const start = Position.createAt( itemOrPosition, offset ); - const end = Position.createFromPosition( start ); - return new Range( start, end ); + return new Range( start, start ); } /** @@ -810,7 +808,7 @@ export default class Range { // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex - 1; i >= 0; i++ ) { if ( ranges[ i ].end.isEqual( result.start ) ) { - result.start = Position.createFromPosition( ranges[ i ].start ); + result.start = ranges[ i ].start; } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; @@ -821,7 +819,7 @@ export default class Range { // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex + 1; i < ranges.length; i++ ) { if ( ranges[ i ].start.isEqual( result.end ) ) { - result.end = Position.createFromPosition( ranges[ i ].end ); + result.end = ranges[ i ].end; } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; diff --git a/src/model/treewalker.js b/src/model/treewalker.js index 8a9ff919b..d5096d3dc 100644 --- a/src/model/treewalker.js +++ b/src/model/treewalker.js @@ -204,33 +204,35 @@ export default class TreeWalker { */ _next() { const previousPosition = this.position; - const position = Position.createFromPosition( this.position ); + + let position = this.position; const parent = this._visitedParent; // We are at the end of the root. - if ( parent.parent === null && position.offset === parent.maxOffset ) { + if ( parent.parent === null && this.position.offset === parent.maxOffset ) { return { done: true }; } // We reached the walker boundary. - if ( parent === this._boundaryEndParent && position.offset == this.boundaries.end.offset ) { + if ( parent === this._boundaryEndParent && this.position.offset == this.boundaries.end.offset ) { return { done: true }; } - const node = position.textNode ? position.textNode : position.nodeAfter; + const node = this.position.textNode ? this.position.textNode : this.position.nodeAfter; if ( node instanceof Element ) { if ( !this.shallow ) { // Manual operations on path internals for optimization purposes. Here and in the rest of the method. - position.path.push( 0 ); + position = position.getMovedToChild(); + this._visitedParent = node; } else { - position.offset++; + position = position.getShiftedBy( 1 ); } this.position = position; - return formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); + return formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); } else if ( node instanceof Text ) { let charactersCount; @@ -249,14 +251,15 @@ export default class TreeWalker { const offsetInTextNode = position.offset - node.startOffset; const item = new TextProxy( node, offsetInTextNode, charactersCount ); - position.offset += charactersCount; + position = position.getShiftedBy( charactersCount ); + this.position = position; - return formatReturnValue( 'text', item, previousPosition, position, charactersCount ); + return formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); } else { // `node` is not set, we reached the end of current `parent`. - position.path.pop(); - position.offset++; + position = position.getMovedToParent().getShiftedBy( 1 ); + this.position = position; this._visitedParent = parent.parent; @@ -278,27 +281,28 @@ export default class TreeWalker { */ _previous() { const previousPosition = this.position; - const position = Position.createFromPosition( this.position ); + let position = this.position; const parent = this._visitedParent; // We are at the beginning of the root. - if ( parent.parent === null && position.offset === 0 ) { + if ( parent.parent === null && this.position.offset === 0 ) { return { done: true }; } // We reached the walker boundary. - if ( parent == this._boundaryStartParent && position.offset == this.boundaries.start.offset ) { + if ( parent == this._boundaryStartParent && this.position.offset == this.boundaries.start.offset ) { return { done: true }; } // Get node just before current position - const node = position.textNode ? position.textNode : position.nodeBefore; + const node = this.position.textNode ? this.position.textNode : this.position.nodeBefore; if ( node instanceof Element ) { - position.offset--; + position = position.getShiftedBy( -1 ); if ( !this.shallow ) { - position.path.push( node.maxOffset ); + position = position.getMovedToChild( node.maxOffset ); + this.position = position; this._visitedParent = node; @@ -330,13 +334,15 @@ export default class TreeWalker { const offsetInTextNode = position.offset - node.startOffset; const item = new TextProxy( node, offsetInTextNode - charactersCount, charactersCount ); - position.offset -= charactersCount; + position = position.getShiftedBy( -charactersCount ); + this.position = position; return formatReturnValue( 'text', item, previousPosition, position, charactersCount ); } else { // `node` is not set, we reached the beginning of current `parent`. - position.path.pop(); + position = position.getMovedToParent(); + this.position = position; this._visitedParent = parent.parent; diff --git a/tests/model/delta/transform/_utils/utils.js b/tests/model/delta/transform/_utils/utils.js index aa7a56316..5ee8dcc49 100644 --- a/tests/model/delta/transform/_utils/utils.js +++ b/tests/model/delta/transform/_utils/utils.js @@ -68,12 +68,9 @@ export function getMarkerDelta( name, oldRange, newRange, version ) { export function getMergeDelta( position, howManyInPrev, howManyInNext, version ) { const delta = new MergeDelta(); - const sourcePosition = Position.createFromPosition( position ); - sourcePosition.path.push( 0 ); + const sourcePosition = position.getMovedToChild(); - const targetPosition = Position.createFromPosition( position ); - targetPosition.offset--; - targetPosition.path.push( howManyInPrev ); + const targetPosition = position.getShiftedBy( -1 ).getMovedToChild( howManyInPrev ); const move = new MoveOperation( sourcePosition, howManyInNext, targetPosition, version ); move.isSticky = true; @@ -129,12 +126,9 @@ export function getRenameDelta( position, oldName, newName, baseVersion ) { export function getSplitDelta( position, nodeCopy, howManyMove, version ) { const delta = new SplitDelta(); - const insertPosition = Position.createFromPosition( position ); - insertPosition.path = insertPosition.getParentPath(); - insertPosition.offset++; + const insertPosition = position.getMovedToParent().getShiftedBy( 1 ); - const targetPosition = Position.createFromPosition( insertPosition ); - targetPosition.path.push( 0 ); + const targetPosition = insertPosition.getMovedToChild(); delta.addOperation( new InsertOperation( insertPosition, [ nodeCopy ], version ) ); @@ -153,8 +147,8 @@ export function getWrapDelta( range, element, version ) { const insert = new InsertOperation( range.end, element, version ); - const targetPosition = Position.createFromPosition( range.end ); - targetPosition.path.push( 0 ); + const targetPosition = range.end.getMovedToChild(); + const move = new MoveOperation( range.start, range.end.offset - range.start.offset, targetPosition, version + 1 ); delta.addOperation( insert ); @@ -168,14 +162,12 @@ export function getWrapDelta( range, element, version ) { export function getUnwrapDelta( positionBefore, howManyChildren, version ) { const delta = new UnwrapDelta(); - const sourcePosition = Position.createFromPosition( positionBefore ); - sourcePosition.path.push( 0 ); + const sourcePosition = positionBefore.getMovedToChild(); const move = new MoveOperation( sourcePosition, howManyChildren, positionBefore, version ); move.isSticky = true; - const removePosition = Position.createFromPosition( positionBefore ); - removePosition.offset += howManyChildren; + const removePosition = positionBefore.getShiftedBy( howManyChildren ); const gy = sourcePosition.root.document.graveyard; const gyPos = Position.createAt( gy, 0 ); diff --git a/tests/model/delta/transform/movedelta.js b/tests/model/delta/transform/movedelta.js index b5134f77e..bdfa82edc 100644 --- a/tests/model/delta/transform/movedelta.js +++ b/tests/model/delta/transform/movedelta.js @@ -135,8 +135,8 @@ describe( 'transform', () => { } ); it( 'move range in merged node #2', () => { - moveDelta._moveOperation.sourcePosition.path = [ 3, 3, 1 ]; - moveDelta._moveOperation.targetPosition.path = [ 3, 3, 4 ]; + moveDelta._moveOperation.sourcePosition = new Position( root, [ 3, 3, 1 ] ); + moveDelta._moveOperation.targetPosition = new Position( root, [ 3, 3, 4 ] ); const mergePosition = new Position( root, [ 3, 3 ] ); const mergeDelta = getMergeDelta( mergePosition, 1, 4, baseVersion ); diff --git a/tests/model/delta/transform/splitdelta.js b/tests/model/delta/transform/splitdelta.js index 0b3cfc0fd..6c0ddfc3c 100644 --- a/tests/model/delta/transform/splitdelta.js +++ b/tests/model/delta/transform/splitdelta.js @@ -6,6 +6,7 @@ import transformations from '../../../../src/model/delta/basic-transformations'; // eslint-disable-line no-unused-vars import deltaTransform from '../../../../src/model/delta/transform'; + const transform = deltaTransform.transform; import Element from '../../../../src/model/element'; @@ -967,10 +968,8 @@ describe( 'transform', () => { baseVersion = removeDelta.operations.length; const newInsertPosition = removeOperation.targetPosition.getShiftedBy( 2 ); - const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ); - newMoveSourcePosition.path.push( 2 ); - const newMoveTargetPosition = Position.createAt( newInsertPosition ); - newMoveTargetPosition.path.push( 0 ); + const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ).getMovedToChild( 2 ); + const newMoveTargetPosition = newInsertPosition.getMovedToChild( ); expectDelta( transformed[ 0 ], { type: SplitDelta, @@ -1003,10 +1002,8 @@ describe( 'transform', () => { baseVersion = removeDelta.operations.length; const newInsertPosition = removeOperation.targetPosition.getShiftedBy( 2 ); - const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ); - newMoveSourcePosition.path.push( 3 ); - const newMoveTargetPosition = Position.createAt( newInsertPosition ); - newMoveTargetPosition.path.push( 0 ); + const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ).getMovedToChild( 3 ); + const newMoveTargetPosition = newInsertPosition.getMovedToChild( ); expectDelta( transformed[ 0 ], { type: SplitDelta, diff --git a/tests/model/liverange.js b/tests/model/liverange.js index 15fac530b..6a57795e7 100644 --- a/tests/model/liverange.js +++ b/tests/model/liverange.js @@ -208,7 +208,7 @@ describe( 'LiveRange', () => { } ); it( 'is at the live range start position and live range is collapsed', () => { - live.end.path = [ 0, 1, 4 ]; + live.end = new Position( live.end.root, [ 0, 1, 4 ] ); const insertRange = new Range( new Position( root, [ 0, 1, 4 ] ), new Position( root, [ 0, 1, 8 ] ) ); @@ -372,7 +372,7 @@ describe( 'LiveRange', () => { } ); it( 'is equal to live range', () => { - live.end.path = [ 0, 1, 7 ]; + live.end = new Position( live.end.root, [ 0, 1, 7 ] ); const moveSource = new Position( root, [ 0, 1, 4 ] ); const moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 3 ] ) ); @@ -389,7 +389,7 @@ describe( 'LiveRange', () => { } ); it( 'contains live range', () => { - live.end.path = [ 0, 1, 7 ]; + live.end = new Position( live.end.root, [ 0, 1, 7 ] ); const moveSource = new Position( root, [ 0, 1, 3 ] ); const moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 9 ] ) ); @@ -406,7 +406,7 @@ describe( 'LiveRange', () => { } ); it( 'is intersecting with live range and points to live range', () => { - live.end.path = [ 0, 1, 12 ]; + live.end = new Position( live.end.root, [ 0, 1, 12 ] ); const moveSource = new Position( root, [ 0, 1, 2 ] ); const moveRange = new Range( new Position( root, [ 0, 1, 7 ] ), new Position( root, [ 0, 1, 10 ] ) ); @@ -656,7 +656,7 @@ describe( 'LiveRange', () => { } ); it( 'from the range to the range', () => { - live.end.path = [ 0, 1, 12 ]; + live.end = new Position( live.end.root, [ 0, 1, 12 ] ); const moveSource = new Position( root, [ 0, 1, 6 ] ); const moveRange = new Range( new Position( root, [ 0, 1, 8 ] ), new Position( root, [ 0, 1, 10 ] ) ); diff --git a/tests/model/operation/transform.js b/tests/model/operation/transform.js index a53a1671e..955894582 100644 --- a/tests/model/operation/transform.js +++ b/tests/model/operation/transform.js @@ -38,8 +38,7 @@ describe( 'transform', () => { if ( params.hasOwnProperty( i ) ) { if ( i == 'type' ) { expect( op, 'type' ).to.be.instanceof( params[ i ] ); - } - else if ( params[ i ] instanceof Array ) { + } else if ( params[ i ] instanceof Array ) { expect( op[ i ].length, i ).to.equal( params[ i ].length ); for ( let j = 0; j < params[ i ].length; j++ ) { @@ -54,6 +53,14 @@ describe( 'transform', () => { } } + function getPositionMovedInPath( position, index, howMany ) { + const path = position.path.slice(); + + path[ index ] += howMany; + + return position.getMovedToPath( path ); + } + describe( 'InsertOperation', () => { let nodeC, nodeD, position; @@ -94,7 +101,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.offset += 2; + expected.position = expected.position.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -108,7 +115,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.offset += 2; + expected.position = expected.position.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -148,7 +155,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.offset += 2; + expected.position = expected.position.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -175,7 +182,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.path[ 1 ] += 2; + expected.position = getPositionMovedInPath( expected.position, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -253,7 +260,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.offset--; + expected.position = expected.position.getShiftedBy( -1 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -282,7 +289,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.offset += 2; + expected.position = expected.position.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -311,7 +318,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.offset += 2; + expected.position = expected.position.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -340,7 +347,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy, { isStrong: true, insertBefore: true } ); - expected.position.offset += 2; + expected.position = expected.position.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -369,7 +376,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.path[ 1 ] -= 1; + expected.position = getPositionMovedInPath( expected.position, 1, -1 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -398,7 +405,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.path[ 1 ] += 2; + expected.position = getPositionMovedInPath( expected.position, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -427,7 +434,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.path = [ 1, 2, 2 ]; + expected.position = new Position( expected.position.root, [ 1, 2, 2 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -442,7 +449,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position.path = [ 1, 2 ]; + expected.position = new Position( expected.position.root, [ 1, 2 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -532,7 +539,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset += 2; + expected.range.start = expected.range.start.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -547,7 +554,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset += 2; + expected.range.start = expected.range.start.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -575,8 +582,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path[ 0 ] += 2; - expected.range.end.path[ 0 ] += 2; + expected.range.start = getPositionMovedInPath( expected.range.start, 0, 2 ); + expected.range.end = getPositionMovedInPath( expected.range.end, 0, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -606,12 +613,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start.path = [ 1, 3, 3 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 3, 3 ] ); expectOperation( transOp[ 0 ], expected ); expected.range.start = op.range.start; - expected.range.end.path = [ 1, 3, 1 ]; + expected.range.end = new Position( expected.range.end.root, [ 1, 3, 1 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -723,11 +730,11 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end.path = [ 1, 4, 2 ]; + expected.range.end = new Position( expected.range.end.root, [ 1, 4, 2 ] ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 1, 4, 2 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 4, 2 ] ); expected.range.end = op.range.end; expected.oldValue = 'another'; expected.baseVersion++; @@ -749,12 +756,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start.path = [ 2, 1 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); expectOperation( transOp[ 0 ], expected ); expected.range.start = op.range.start; - expected.range.end.path = [ 2, 1 ]; + expected.range.end = new Position( expected.range.end.root, [ 2, 1 ] ); expected.oldValue = null; expected.baseVersion++; @@ -774,18 +781,18 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range.end.path = [ 1, 4, 1 ]; + expected.range.end = new Position( expected.range.end.root, [ 1, 4, 1 ] ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 2, 1 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); expected.range.end = op.range.end; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range.start.path = [ 1, 4, 1 ]; - expected.range.end.path = [ 2, 1 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 4, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2, 1 ] ); expected.oldValue = null; expected.baseVersion++; @@ -860,7 +867,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.end.path = [ 1, 4, 2 ]; + expected.range.end = new Position( expected.range.end.root, [ 1, 4, 2 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -878,7 +885,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path = [ 2, 1 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -897,11 +904,11 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end.path = [ 1, 4, 1 ]; + expected.range.end = new Position( expected.range.end.root, [ 1, 4, 1 ] ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 2, 1 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); expected.range.end = op.range.end; expected.baseVersion++; @@ -952,7 +959,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset -= 2; + expected.range.start = expected.range.start.getShiftedBy( -2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -968,7 +975,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset += 2; + expected.range.start = expected.range.start.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -984,8 +991,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path[ 0 ]--; - expected.range.end.path[ 0 ]--; + expected.range.start = getPositionMovedInPath( expected.range.start, 0, -1 ); + expected.range.end = getPositionMovedInPath( expected.range.end, 0, -1 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1015,7 +1022,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path[ 1 ] += 2; + expected.range.start = getPositionMovedInPath( expected.range.start, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1047,12 +1054,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end.path = [ 2, 1 ]; + expected.range.end = new Position( expected.range.end.root, [ 2, 1 ] ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 4 ]; - expected.range.end.path = [ 5, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 4 ] ); + expected.range.end = new Position( expected.range.end.root, [ 5, 4 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1070,12 +1077,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start.path = [ 1, 1 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 1 ] ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 0, 1 ]; - expected.range.end.path = [ 0, 3 ]; + expected.range.start = new Position( expected.range.start.root, [ 0, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 0, 3 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1091,8 +1098,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path = [ 1, 4, 1, 2 ]; - expected.range.end.path = [ 1, 4, 2, 2, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 4, 1, 2 ] ); + expected.range.end = new Position( expected.range.end.root, [ 1, 4, 2, 2, 4 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1112,8 +1119,8 @@ describe( 'transform', () => { expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 3, 2 ]; - expected.range.end.path = [ 3, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 3, 2 ] ); + expected.range.end = new Position( expected.range.end.root, [ 3, 4 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1131,12 +1138,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start.path = [ 1, 6 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 6 ] ); expectOperation( transOp[ 0 ], expected ); expected.range.start = op.range.start; - expected.range.end.path = [ 1, 4 ]; + expected.range.end = new Position( expected.range.end.root, [ 1, 4 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1154,19 +1161,19 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range.start.path = [ 5 ]; - expected.range.end.path = [ 5, 2, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 5 ] ); + expected.range.end = new Position( expected.range.end.root, [ 5, 2, 4 ] ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 1, 1 ]; - expected.range.end.path = [ 2 ]; + expected.range.start = new Position( expected.range.start.root, [ 1, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range.start.path = [ 3 ]; - expected.range.end.path = [ 5 ]; + expected.range.start = new Position( expected.range.start.root, [ 3 ] ); + expected.range.end = new Position( expected.range.end.root, [ 5 ] ); expected.baseVersion++; expectOperation( transOp[ 2 ], expected ); @@ -1234,8 +1241,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset += 2; - expected.range.end.offset += 2; + expected.range.start = expected.range.start.getShiftedBy( 2 ); + expected.range.end = expected.range.end.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1250,8 +1257,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset += 2; - expected.range.end.offset += 2; + expected.range.start = expected.range.start.getShiftedBy( 2 ); + expected.range.end = expected.range.end.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1269,8 +1276,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset--; - expected.range.end.offset--; + expected.range.start = expected.range.start.getShiftedBy( -1 ); + expected.range.end = expected.range.end.getShiftedBy( -1 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1286,8 +1293,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.offset += 2; - expected.range.end.offset += 2; + expected.range.start = expected.range.start.getShiftedBy( 2 ); + expected.range.end = expected.range.end.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1305,12 +1312,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end.offset -= 2; + expected.range.end = expected.range.end.getShiftedBy( -2 ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 2, 4, 1 ]; - expected.range.end.path = [ 2, 4, 3 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 4, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2, 4, 3 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1328,13 +1335,13 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start.offset -= 1; - expected.range.end.offset -= 2; + expected.range.start = expected.range.start.getShiftedBy( -1 ); + expected.range.end = expected.range.end.getShiftedBy( -2 ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 2, 4, 2 ]; - expected.range.end.path = [ 2, 4, 3 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 4, 2 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2, 4, 3 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1350,8 +1357,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path = [ 2, 4, 2, 1 ]; - expected.range.end.path = [ 2, 4, 2, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 4, 2, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2, 4, 2, 4 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1369,12 +1376,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end.offset--; + expected.range.end = expected.range.end.getShiftedBy( -1 ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.path = [ 2, 4, 1 ]; - expected.range.end.path = [ 2, 4, 2 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 4, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2, 4, 2 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1390,8 +1397,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start.path = [ 2, 4, 1 ]; - expected.range.end.path = [ 2, 4, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 2, 4, 1 ] ); + expected.range.end = new Position( expected.range.end.root, [ 2, 4, 4 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1409,13 +1416,13 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start.offset = 4; - expected.range.end.offset = 6; + expected.range.start = expected.range.start.getShiftedTo( 4 ); + expected.range.end = expected.range.end.getShiftedTo( 6 ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.offset = op.range.start.offset; - expected.range.end.offset = 2; + expected.range.start = expected.range.start.getShiftedTo( op.range.start.offset ); + expected.range.end = expected.range.end.getShiftedTo( 2 ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1433,19 +1440,19 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range.start.offset = 3; - expected.range.end.offset = 4; + expected.range.start = expected.range.start.getShiftedTo( 3 ); + expected.range.end = expected.range.end.getShiftedTo( 4 ); expectOperation( transOp[ 0 ], expected ); - expected.range.start.offset = 0; - expected.range.end.offset = 1; + expected.range.start = expected.range.start.getShiftedTo( 0 ); + expected.range.end = expected.range.end.getShiftedTo( 1 ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range.start.offset = 2; - expected.range.end.offset = 3; + expected.range.start = expected.range.start.getShiftedTo( 2 ); + expected.range.end = expected.range.end.getShiftedTo( 3 ); expected.baseVersion++; expectOperation( transOp[ 2 ], expected ); @@ -1473,14 +1480,14 @@ describe( 'transform', () => { baseVersion ); - transformBy.targetPosition.path = [ 0 ]; + transformBy.targetPosition = new Position( transformBy.targetPosition.root, [ 0 ] ); const transOp = transform( op, transformBy ); expect( transOp.length ).to.equal( 1 ); - expected.range.start.path = [ 4, 0 ]; - expected.range.end.path = [ 4, 4 ]; + expected.range.start = new Position( expected.range.start.root, [ 4, 0 ] ); + expected.range.end = new Position( expected.range.end.root, [ 4, 4 ] ); expectOperation( transOp[ 0 ], expected ); } ); @@ -1493,7 +1500,7 @@ describe( 'transform', () => { baseVersion ); - transformBy.targetPosition.path = [ 4 ]; + transformBy.targetPosition = new Position( transformBy.targetPosition.root, [ 4 ] ); const transOp = transform( op, transformBy ); @@ -1696,8 +1703,7 @@ describe( 'transform', () => { targetPosition = new Position( root, [ 3, 3, 3 ] ); howMany = 2; - rangeEnd = Position.createFromPosition( sourcePosition ); - rangeEnd.offset += howMany; + rangeEnd = sourcePosition.getShiftedBy( howMany ); op = new MoveOperation( sourcePosition, howMany, targetPosition, baseVersion ); @@ -1746,7 +1752,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.offset += 2; + expected.sourcePosition = expected.sourcePosition.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1774,7 +1780,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.path[ 1 ] += 2; + expected.sourcePosition = getPositionMovedInPath( expected.sourcePosition, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1802,7 +1808,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.offset += 2; + expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1830,7 +1836,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.path[ 1 ] += 2; + expected.targetPosition = getPositionMovedInPath( expected.targetPosition, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1858,7 +1864,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.offset += 2; + expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1886,7 +1892,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy, { isStrong: true, insertBefore: true } ); - expected.targetPosition.offset += 2; + expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2011,7 +2017,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.offset += 2; + expected.sourcePosition = expected.sourcePosition.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2041,7 +2047,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.offset -= 2; + expected.sourcePosition = expected.sourcePosition.getShiftedBy( -2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2071,7 +2077,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.path[ 1 ] += 2; + expected.sourcePosition = getPositionMovedInPath( expected.sourcePosition, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2101,7 +2107,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.path[ 1 ] -= 1; + expected.sourcePosition = getPositionMovedInPath( expected.sourcePosition, 1, -1 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2131,7 +2137,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.offset += 2; + expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2161,7 +2167,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.offset -= 2; + expected.targetPosition = expected.targetPosition.getShiftedBy( -2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2191,7 +2197,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.path[ 1 ] += 2; + expected.targetPosition = getPositionMovedInPath( expected.targetPosition, 1, 2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2221,7 +2227,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.path[ 1 ] -= 2; + expected.targetPosition = getPositionMovedInPath( expected.targetPosition, 1, -2 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2256,7 +2262,7 @@ describe( 'transform', () => { expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition.path = [ 2, 2, 6 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 6 ] ); expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -2274,7 +2280,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition.offset = 6; + expected.sourcePosition = expected.sourcePosition.getShiftedTo( 6 ); expectOperation( transOp[ 0 ], expected ); } ); @@ -2355,7 +2361,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.path = [ 4, 3, 4 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 3, 4 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2371,7 +2377,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition.path = [ 0, 2, 3 ]; + expected.targetPosition = new Position( expected.targetPosition.root, [ 0, 2, 3 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2423,7 +2429,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy, { isStrong: true } ); - expected.sourcePosition.path = [ 4, 1, 0 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 0 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2456,14 +2462,14 @@ describe( 'transform', () => { const transOp = transform( op, transformBy, { isStrong: true } ); - expected.sourcePosition.path = [ 4, 1, 1 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 1 ] ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); } ); it( 'range contains transforming range and target and is important: update range path and target', () => { - op.targetPosition.path = [ 2, 2, 7 ]; + op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); const transformBy = new MoveOperation( new Position( root, [ 2, 2, 3 ] ), @@ -2476,14 +2482,14 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition.path = [ 4, 1, 1 ]; - expected.targetPosition.path = [ 4, 1, 4 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 1 ] ); + expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 4 ] ); expectOperation( transOp[ 0 ], expected ); } ); it( 'range contains transforming range and target and is less important: update range path and target', () => { - op.targetPosition.path = [ 2, 2, 7 ]; + op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); const transformBy = new MoveOperation( new Position( root, [ 2, 2, 3 ] ), @@ -2496,8 +2502,8 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition.path = [ 4, 1, 1 ]; - expected.targetPosition.path = [ 4, 1, 4 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 1 ] ); + expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 4 ] ); expectOperation( transOp[ 0 ], expected ); } ); @@ -2512,7 +2518,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition.path = [ 2, 2, 3 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 3 ] ); expected.howMany = 1; expect( transOp.length ).to.equal( 1 ); @@ -2600,12 +2606,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition.path = [ 2, 2, 3 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 3 ] ); expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition.path = [ 2, 2, 5 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 5 ] ); expected.howMany = 2; expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.baseVersion++; @@ -2627,12 +2633,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition.path = [ 2, 2, 3 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 3 ] ); expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition.path = [ 2, 2, 5 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 5 ] ); expected.howMany = 2; expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.baseVersion++; @@ -2681,7 +2687,7 @@ describe( 'transform', () => { } ); it( 'range intersects, target inside transforming range and is important: split into two operations', () => { - op.targetPosition.path = [ 2, 2, 7 ]; + op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); const transformBy = new MoveOperation( new Position( root, [ 2, 2, 5 ] ), @@ -2694,21 +2700,21 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition.path = [ 2, 2, 4 ]; - expected.targetPosition.path = [ 4, 1, 2 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); + expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 2 ] ); expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition.path = [ 4, 1, 0 ]; - expected.targetPosition.path = [ 4, 1, 3 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 0 ] ); + expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 3 ] ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); } ); it( 'range intersects, target inside transforming range and is less important: shrink range', () => { - op.targetPosition.path = [ 2, 2, 7 ]; + op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); const transformBy = new MoveOperation( new Position( root, [ 2, 2, 5 ] ), @@ -2721,8 +2727,8 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition.path = [ 2, 2, 4 ]; - expected.targetPosition.path = [ 4, 1, 2 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); + expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 2 ] ); expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); @@ -2742,7 +2748,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition.path = [ 2, 2, 4 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); @@ -2767,19 +2773,19 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.sourcePosition.path = [ 2, 2, 4 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition.path = [ 4, 1, 0 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 0 ] ); expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.howMany = 2; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.sourcePosition.path = [ 2, 2, 4 ]; + expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); expected.targetPosition = targetPosition.getShiftedBy( 3 ); expected.howMany = 1; expected.baseVersion++; @@ -3060,7 +3066,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.offset = 4; + expected.position = expected.position.getShiftedTo( 4 ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3089,7 +3095,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.path = [ 0, 4, 2 ]; + expected.position = new Position( expected.position.root, [ 0, 4, 2 ] ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3219,7 +3225,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.offset = 0; + expected.position = expected.position.getShiftedTo( 0 ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3236,7 +3242,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.path = [ 0, 0, 2 ]; + expected.position = new Position( expected.position.root, [ 0, 0, 2 ] ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3253,7 +3259,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.path = [ 2, 6 ]; + expected.position = new Position( expected.position.root, [ 2, 6 ] ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3270,7 +3276,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.path = [ 2, 6, 2 ]; + expected.position = new Position( expected.position.root, [ 2, 6, 2 ] ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3287,7 +3293,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.offset = 4; + expected.position = expected.position.getShiftedTo( 4 ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3304,7 +3310,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position.offset = 0; + expected.position = expected.position.getShiftedTo( 0 ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3336,8 +3342,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.newRange = null; - expected.oldRange.start.offset = 3; - expected.oldRange.end.offset = 6; + expected.oldRange.start = expected.oldRange.start.getShiftedTo( 3 ); + expected.oldRange.end = expected.oldRange.end.getShiftedTo( 6 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3351,8 +3357,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.oldRange = null; - expected.newRange.start.offset = 12; - expected.newRange.end.offset = 14; + expected.newRange.start = expected.newRange.start.getShiftedTo( 12 ); + expected.newRange.end = expected.newRange.end.getShiftedTo( 14 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3388,8 +3394,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.newRange = null; - expected.oldRange.start.offset = 0; - expected.oldRange.end.offset = 3; + expected.oldRange.start = expected.oldRange.start.getShiftedTo( 0 ); + expected.oldRange.end = expected.oldRange.end.getShiftedTo( 3 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3399,10 +3405,10 @@ describe( 'transform', () => { const transformBy = new MoveOperation( Position.createAt( root, 2 ), 2, Position.createAt( root, 20 ), baseVersion ); const transOp = transform( op, transformBy ); - expected.oldRange.start.offset = 1; - expected.oldRange.end.offset = 2; - expected.newRange.start.offset = 8; - expected.newRange.end.offset = 10; + expected.oldRange.start = expected.oldRange.start.getShiftedTo( 1 ); + expected.oldRange.end = expected.oldRange.end.getShiftedTo( 2 ); + expected.newRange.start = expected.newRange.start.getShiftedTo( 8 ); + expected.newRange.end = expected.newRange.end.getShiftedTo( 10 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3416,8 +3422,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.oldRange = null; - expected.newRange.start.offset = 10; - expected.newRange.end.offset = 14; + expected.newRange.start = expected.newRange.start.getShiftedTo( 10 ); + expected.newRange.end = expected.newRange.end.getShiftedTo( 14 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3427,10 +3433,10 @@ describe( 'transform', () => { const transformBy = new MoveOperation( Position.createAt( root, 20 ), 4, Position.createAt( root, 2 ), baseVersion ); const transOp = transform( op, transformBy ); - expected.oldRange.start.offset = 1; - expected.oldRange.end.offset = 8; - expected.newRange.start.offset = 14; - expected.newRange.end.offset = 16; + expected.oldRange.start = expected.oldRange.start.getShiftedTo( 1 ); + expected.oldRange.end = expected.oldRange.end.getShiftedTo( 8 ); + expected.newRange.start = expected.newRange.start.getShiftedTo( 14 ); + expected.newRange.end = expected.newRange.end.getShiftedTo( 16 ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); diff --git a/tests/model/position.js b/tests/model/position.js index 1b5a23eb5..0424b3e8f 100644 --- a/tests/model/position.js +++ b/tests/model/position.js @@ -291,14 +291,6 @@ describe( 'Position', () => { expect( new Position( root, [ 1, 0, 3 ] ) ).to.have.property( 'index' ).that.equals( 1 ); } ); - it( 'should be able to set offset', () => { - const position = new Position( root, [ 1, 0, 2 ] ); - position.offset = 4; - - expect( position.offset ).to.equal( 4 ); - expect( position.path ).to.deep.equal( [ 1, 0, 4 ] ); - } ); - it( 'should have nodeBefore if it is not inside a text node', () => { expect( new Position( root, [ 0 ] ).nodeBefore ).to.be.null; expect( new Position( root, [ 1 ] ).nodeBefore ).to.equal( p ); @@ -605,14 +597,6 @@ describe( 'Position', () => { } ); describe( '_getTransformedByInsertion()', () => { - it( 'should return a new Position instance', () => { - const position = new Position( root, [ 0 ] ); - const transformed = position._getTransformedByInsertion( new Position( root, [ 2 ] ), 4, false ); - - expect( transformed ).not.to.equal( position ); - expect( transformed ).to.be.instanceof( Position ); - } ); - it( 'should increment offset if insertion is in the same parent and closer offset', () => { const position = new Position( root, [ 1, 2, 3 ] ); const transformed = position._getTransformedByInsertion( new Position( root, [ 1, 2, 2 ] ), 2, false ); @@ -665,14 +649,6 @@ describe( 'Position', () => { } ); describe( '_getTransformedByDeletion()', () => { - it( 'should return a new Position instance', () => { - const position = new Position( root, [ 0 ] ); - const transformed = position._getTransformedByDeletion( new Position( root, [ 2 ] ), 4 ); - - expect( transformed ).not.to.equal( position ); - expect( transformed ).to.be.instanceof( Position ); - } ); - it( 'should return null if original position is inside one of removed nodes', () => { const position = new Position( root, [ 1, 2 ] ); const transformed = position._getTransformedByDeletion( new Position( root, [ 0 ] ), 2 ); diff --git a/tests/model/range.js b/tests/model/range.js index adf1bb9c2..44b5dd741 100644 --- a/tests/model/range.js +++ b/tests/model/range.js @@ -855,7 +855,8 @@ describe( 'Range', () => { } ); it( 'move inside the range', () => { - range.end.offset = 6; + range.end = range.end.getShiftedTo( 6 ); + const start = new Position( root, [ 3 ] ); const target = new Position( root, [ 5 ] ); const delta = getMoveDelta( start, 1, target, 1 ); From b67f106ea42912353e29f886ffc574183f9b0e45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Mon, 23 Oct 2017 18:34:11 +0200 Subject: [PATCH 002/724] Other: Make Range immutable. --- src/conversion/viewconversiondispatcher.js | 5 +- src/dev-utils/view.js | 2 +- src/model/liverange.js | 6 +- src/model/operation/transform.js | 61 ++-- src/model/range.js | 89 ++++-- tests/model/liverange.js | 20 +- tests/model/operation/transform.js | 327 +++++++++++++++------ tests/model/range.js | 74 +++-- 8 files changed, 404 insertions(+), 180 deletions(-) diff --git a/src/conversion/viewconversiondispatcher.js b/src/conversion/viewconversiondispatcher.js index 4a9100cac..0e6fc576f 100644 --- a/src/conversion/viewconversiondispatcher.js +++ b/src/conversion/viewconversiondispatcher.js @@ -303,10 +303,11 @@ function extractMarkersFromModelFragment( modelItem ) { // When marker of given name is not stored it means that we have found the beginning of the range. if ( !markers.has( markerName ) ) { - markers.set( markerName, new ModelRange( ModelPosition.createFromPosition( currentPosition ) ) ); + markers.set( markerName, new ModelRange( currentPosition ) ); // Otherwise is means that we have found end of the marker range. } else { - markers.get( markerName ).end = ModelPosition.createFromPosition( currentPosition ); + const oldMarker = markers.get( markerName ); + markers.set( markerName, new ModelRange( oldMarker.start, currentPosition ) ); } // Remove marker element from DocumentFragment. diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index fc6cacc3f..18603c371 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -550,7 +550,7 @@ class RangeParser { if ( item.bracket == ELEMENT_RANGE_START_TOKEN || item.bracket == TEXT_RANGE_START_TOKEN ) { range = new Range( item.position, item.position ); } else { - range.end = item.position; + range = new Range( range.start, item.position ); ranges.push( range ); range = null; } diff --git a/src/model/liverange.js b/src/model/liverange.js index 32b7ad8de..b2c714072 100644 --- a/src/model/liverange.js +++ b/src/model/liverange.js @@ -7,7 +7,7 @@ * @module engine/model/liverange */ -import Range from './range'; +import Range, { setStart, setEnd } from './range'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; @@ -178,8 +178,8 @@ function transform( changeType, deltaType, batch, targetRange, sourcePosition ) // If range boundaries have changed, fire `change:range` event. const oldRange = Range.createFromRange( this ); - this.start = updated.start; - this.end = updated.end; + setStart( this, updated.start ); + setEnd( this, updated.end ); this.fire( 'change:range', oldRange, { type: changeType, diff --git a/src/model/operation/transform.js b/src/model/operation/transform.js index 13cc541ef..1cbe1c7ee 100644 --- a/src/model/operation/transform.js +++ b/src/model/operation/transform.js @@ -179,25 +179,29 @@ const ot = { // Take the start and the end of the range and transform them by deletion of moved nodes. // Note that if rangeB was inside AttributeOperation range, only difference.end will be transformed. // This nicely covers the joining simplification we did in the previous step. - difference.start = difference.start._getTransformedByDeletion( b.sourcePosition, b.howMany ); - difference.end = difference.end._getTransformedByDeletion( b.sourcePosition, b.howMany ); + const range = new Range( + difference.start._getTransformedByDeletion( b.sourcePosition, b.howMany ), + difference.end._getTransformedByDeletion( b.sourcePosition, b.howMany ) + ); // MoveOperation pastes nodes into target position. We acknowledge this by proper transformation. // Note that since we operate on transformed difference range, we should transform by // previously transformed target position. // Note that we do not use Position._getTransformedByMove on range boundaries because we need to // transform by insertion a range as a whole, since newTargetPosition might be inside that range. - ranges = difference._getTransformedByInsertion( b.getMovedRangeStart(), b.howMany, true, false ).reverse(); + ranges = range._getTransformedByInsertion( b.getMovedRangeStart(), b.howMany, true, false ).reverse(); } if ( common !== null ) { // Here we do not need to worry that newTargetPosition is inside moved range, because that // would mean that the MoveOperation targets into itself, and that is incorrect operation. // Instead, we calculate the new position of that part of original range. - common.start = common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ); - common.end = common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ); + const range = new Range( + common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), + common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) + ); - ranges.push( common ); + ranges.push( range ); } // Map transformed range(s) to operations and return them. @@ -376,7 +380,7 @@ const ot = { // Setting and evaluating some variables that will be used in special cases and default algorithm. // // Create ranges from `MoveOperations` properties. - const rangeA = Range.createFromPositionAndShift( a.sourcePosition, a.howMany ); + let rangeA = Range.createFromPositionAndShift( a.sourcePosition, a.howMany ); const rangeB = Range.createFromPositionAndShift( b.sourcePosition, b.howMany ); // Assign `context.isStrong` to a different variable, because the value may change during execution of @@ -428,8 +432,10 @@ const ot = { if ( bTargetsToA && rangeA.containsRange( rangeB, true ) ) { // There is a mini-special case here, where `rangeB` is on other level than `rangeA`. That's why // we need to transform `a` operation anyway. - rangeA.start = rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ); - rangeA.end = rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ); + rangeA = new Range( + rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ), + rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ) + ); return makeMoveOperationsFromRanges( [ rangeA ], newTargetPosition, a ); } @@ -444,8 +450,10 @@ const ot = { if ( aTargetsToB && rangeB.containsRange( rangeA, true ) ) { // `a` operation is "moved together" with `b` operation. // Here, just move `rangeA` "inside" `rangeB`. - rangeA.start = rangeA.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ); - rangeA.end = rangeA.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ); + rangeA = new Range( + rangeA.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), + rangeA.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) + ); return makeMoveOperationsFromRanges( [ rangeA ], newTargetPosition, a ); } @@ -466,8 +474,10 @@ const ot = { // Transform `rangeA` by `b` operation and make operation out of it, and that's all. // Note that this is a simplified version of default case, but here we treat the common part (whole `rangeA`) // like a one difference part. - rangeA.start = rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ); - rangeA.end = rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ); + rangeA = new Range( + rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ), + rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ) + ); return makeMoveOperationsFromRanges( [ rangeA ], newTargetPosition, a ); } @@ -500,10 +510,12 @@ const ot = { // This is an array with one or two ranges. Two ranges if `rangeB` is inside `rangeA`. const difference = rangeA.getDifference( rangeB ); - for ( const range of difference ) { + for ( const rangeInDiff of difference ) { // Transform those ranges by `b` operation. For example if `b` moved range from before those ranges, fix those ranges. - range.start = range.start._getTransformedByDeletion( b.sourcePosition, b.howMany ); - range.end = range.end._getTransformedByDeletion( b.sourcePosition, b.howMany ); + const range = new Range( + rangeInDiff.start._getTransformedByDeletion( b.sourcePosition, b.howMany ), + rangeInDiff.end._getTransformedByDeletion( b.sourcePosition, b.howMany ) + ); // If `b` operation targets into `rangeA` on the same level, spread `rangeA` into two ranges. const shouldSpread = compareArrays( range.start.getParentPath(), b.getMovedRangeStart().getParentPath() ) == 'same'; @@ -513,12 +525,14 @@ const ot = { } // Then, we have to manage the "common part" of both move ranges. - const common = rangeA.getIntersection( rangeB ); + const intersectionRange = rangeA.getIntersection( rangeB ); - if ( common !== null && isStrong && !bTargetsToA ) { + if ( intersectionRange !== null && isStrong && !bTargetsToA ) { // Calculate the new position of that part of original range. - common.start = common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ); - common.end = common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ); + const common = new Range( + intersectionRange.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), + intersectionRange.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) + ); // Take care of proper range order. // @@ -627,9 +641,10 @@ function joinRanges( ranges ) { } else if ( ranges.length == 1 ) { return ranges[ 0 ]; } else { - ranges[ 0 ].end = ranges[ ranges.length - 1 ].end; - - return ranges[ 0 ]; + return new Range( + ranges[ 0 ].start, + ranges[ ranges.length - 1 ].end + ); } } diff --git a/src/model/range.js b/src/model/range.js index 353309c28..b16056094 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -11,6 +11,9 @@ import Position from './position'; import TreeWalker from './treewalker'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; +const _start = Symbol( 'start' ); +const _end = Symbol( 'end' ); + /** * Range class. Range is iterable. */ @@ -24,21 +27,8 @@ export default class Range { * @param {module:engine/model/position~Position} [end] End position. If not set, range will be collapsed at `start` position. */ constructor( start, end = null ) { - /** - * Start position. - * - * @readonly - * @member {module:engine/model/position~Position} - */ - this.start = start; - - /** - * End position. - * - * @readonly - * @member {module:engine/model/position~Position} - */ - this.end = end ? end : start; + setStart( this, start ); + setEnd( this, end ? end : start ); } /** @@ -57,6 +47,26 @@ export default class Range { yield* new TreeWalker( { boundaries: this, ignoreElementEnd: true } ); } + /** + * Start position. + * + * @readonly + * @member {module:engine/model/position~Position} + */ + get start() { + return this[ _start ]; + } + + /** + * End position. + * + * @readonly + * @member {module:engine/model/position~Position} + */ + get end() { + return this[ _end ]; + } + /** * Returns whether the range is collapsed, that is if {@link #start} and * {@link #end} positions are equal. @@ -465,6 +475,18 @@ export default class Range { return this.start.getCommonAncestor( this.end ); } + /** + * Converts `Range` to plain object and returns it. + * + * @returns {Object} `Range` converted to plain object. + */ + toJSON() { + return { + start: this.start.toJSON(), + end: this.end.toJSON() + }; + } + /** * Returns a range that is a result of transforming this range by a change in the model document. * @@ -612,15 +634,13 @@ export default class Range { ) ]; } else { - const range = Range.createFromRange( this ); - const insertBeforeStart = !isSticky; - const insertBeforeEnd = range.isCollapsed ? true : isSticky; + const insertBeforeEnd = this.isCollapsed ? true : isSticky; - range.start = range.start._getTransformedByInsertion( insertPosition, howMany, insertBeforeStart ); - range.end = range.end._getTransformedByInsertion( insertPosition, howMany, insertBeforeEnd ); + const start = this.start._getTransformedByInsertion( insertPosition, howMany, insertBeforeStart ); + const end = this.end._getTransformedByInsertion( insertPosition, howMany, insertBeforeEnd ); - return [ range ]; + return [ new Range( start, end ) ]; } } @@ -802,13 +822,13 @@ export default class Range { // 4. At this moment we don't need the original range. // We are going to modify the result and we need to return a new instance of Range. // We have to create a copy of the reference range. - const result = new this( ref.start, ref.end ); + let result = new this( ref.start, ref.end ); // 5. Ranges should be checked and glued starting from the range that is closest to the reference range. // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex - 1; i >= 0; i++ ) { if ( ranges[ i ].end.isEqual( result.start ) ) { - result.start = ranges[ i ].start; + result = new this( ranges[ i ].start, result.end ); } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; @@ -819,7 +839,7 @@ export default class Range { // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex + 1; i < ranges.length; i++ ) { if ( ranges[ i ].start.isEqual( result.end ) ) { - result.end = ranges[ i ].end; + result = new this( result.start, ranges[ i ].end ); } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; @@ -840,3 +860,24 @@ export default class Range { return new this( Position.fromJSON( json.start, doc ), Position.fromJSON( json.end, doc ) ); } } + +/** + * Method used to expose start setter to child classes. + * @protected + * @param {module:engine/model/range~Range} range Range of which start position should be sent. + * @param {module:engine/model/position~Position} position Position to set as range start. + * See {@link module:engine/model/range~Range#start}. + */ +export function setStart( range, position ) { + range[ _start ] = position; +} + +/** + * Method used to expose end setter to child classes. + * @protected + * @param {module:engine/model/range~Range} range Range of which end position should be sent. + * @param {module:engine/model/position~Position} position Position to set as range end. See {@link module:engine/model/range~Range#end}. + */ +export function setEnd( range, position ) { + range[ _end ] = position; +} diff --git a/tests/model/liverange.js b/tests/model/liverange.js index 6a57795e7..1780c368d 100644 --- a/tests/model/liverange.js +++ b/tests/model/liverange.js @@ -208,7 +208,9 @@ describe( 'LiveRange', () => { } ); it( 'is at the live range start position and live range is collapsed', () => { - live.end = new Position( live.end.root, [ 0, 1, 4 ] ); + live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 4 ] ) ); + spy = sinon.spy(); + live.on( 'change:range', spy ); const insertRange = new Range( new Position( root, [ 0, 1, 4 ] ), new Position( root, [ 0, 1, 8 ] ) ); @@ -372,7 +374,9 @@ describe( 'LiveRange', () => { } ); it( 'is equal to live range', () => { - live.end = new Position( live.end.root, [ 0, 1, 7 ] ); + live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 7 ] ) ); + spy = sinon.spy(); + live.on( 'change:range', spy ); const moveSource = new Position( root, [ 0, 1, 4 ] ); const moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 3 ] ) ); @@ -389,7 +393,9 @@ describe( 'LiveRange', () => { } ); it( 'contains live range', () => { - live.end = new Position( live.end.root, [ 0, 1, 7 ] ); + live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 7 ] ) ); + spy = sinon.spy(); + live.on( 'change:range', spy ); const moveSource = new Position( root, [ 0, 1, 3 ] ); const moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 9 ] ) ); @@ -406,7 +412,9 @@ describe( 'LiveRange', () => { } ); it( 'is intersecting with live range and points to live range', () => { - live.end = new Position( live.end.root, [ 0, 1, 12 ] ); + live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 12 ] ) ); + spy = sinon.spy(); + live.on( 'change:range', spy ); const moveSource = new Position( root, [ 0, 1, 2 ] ); const moveRange = new Range( new Position( root, [ 0, 1, 7 ] ), new Position( root, [ 0, 1, 10 ] ) ); @@ -656,7 +664,9 @@ describe( 'LiveRange', () => { } ); it( 'from the range to the range', () => { - live.end = new Position( live.end.root, [ 0, 1, 12 ] ); + live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 12 ] ) ); + spy = sinon.spy(); + live.on( 'change:content', spy ); const moveSource = new Position( root, [ 0, 1, 6 ] ); const moveRange = new Range( new Position( root, [ 0, 1, 8 ] ), new Position( root, [ 0, 1, 10 ] ) ); diff --git a/tests/model/operation/transform.js b/tests/model/operation/transform.js index 955894582..644d66e86 100644 --- a/tests/model/operation/transform.js +++ b/tests/model/operation/transform.js @@ -539,7 +539,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( 2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( 2 ), + expected.range.end + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -554,7 +557,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( 2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( 2 ), + expected.range.end + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -582,8 +588,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = getPositionMovedInPath( expected.range.start, 0, 2 ); - expected.range.end = getPositionMovedInPath( expected.range.end, 0, 2 ); + expected.range = new Range( + getPositionMovedInPath( expected.range.start, 0, 2 ), + getPositionMovedInPath( expected.range.end, 0, 2 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -613,12 +621,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start = new Position( expected.range.start.root, [ 1, 3, 3 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 3, 3 ] ), + expected.range.end + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = op.range.start; - expected.range.end = new Position( expected.range.end.root, [ 1, 3, 1 ] ); + expected.range = new Range( + op.range.start, + new Position( expected.range.end.root, [ 1, 3, 1 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -730,12 +743,18 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end = new Position( expected.range.end.root, [ 1, 4, 2 ] ); + expected.range = new Range( + expected.range.start, + new Position( expected.range.end.root, [ 1, 4, 2 ] ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 1, 4, 2 ] ); - expected.range.end = op.range.end; + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 4, 2 ] ), + op.range.end + ); + expected.oldValue = 'another'; expected.baseVersion++; @@ -756,12 +775,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 1 ] ), + expected.range.end + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = op.range.start; - expected.range.end = new Position( expected.range.end.root, [ 2, 1 ] ); + expected.range = new Range( + op.range.start, + new Position( expected.range.end.root, [ 2, 1 ] ) + ); expected.oldValue = null; expected.baseVersion++; @@ -781,18 +805,26 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range.end = new Position( expected.range.end.root, [ 1, 4, 1 ] ); + expected.range = new Range( + expected.range.start, + new Position( expected.range.end.root, [ 1, 4, 1 ] ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); - expected.range.end = op.range.end; + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 1 ] ), + op.range.end + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 1, 4, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2, 1 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 4, 1 ] ), + new Position( expected.range.end.root, [ 2, 1 ] ) + ); + expected.oldValue = null; expected.baseVersion++; @@ -867,7 +899,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.end = new Position( expected.range.end.root, [ 1, 4, 2 ] ); + expected.range = new Range( + expected.range.start, + new Position( expected.range.end.root, [ 1, 4, 2 ] ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -885,7 +920,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 1 ] ), + expected.range.end + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -904,12 +942,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end = new Position( expected.range.end.root, [ 1, 4, 1 ] ); + expected.range = new Range( + expected.range.start, + new Position( expected.range.end.root, [ 1, 4, 1 ] ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 2, 1 ] ); - expected.range.end = op.range.end; + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 1 ] ), + op.range.end + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -959,7 +1002,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( -2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( -2 ), + expected.range.end + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -975,7 +1021,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( 2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( 2 ), + expected.range.end + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -991,8 +1040,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = getPositionMovedInPath( expected.range.start, 0, -1 ); - expected.range.end = getPositionMovedInPath( expected.range.end, 0, -1 ); + expected.range = new Range( + getPositionMovedInPath( expected.range.start, 0, -1 ), + getPositionMovedInPath( expected.range.end, 0, -1 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1022,7 +1073,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = getPositionMovedInPath( expected.range.start, 1, 2 ); + expected.range = new Range( + getPositionMovedInPath( expected.range.start, 1, 2 ), + expected.range.end + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1054,12 +1108,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end = new Position( expected.range.end.root, [ 2, 1 ] ); + expected.range = new Range( + expected.range.start, + new Position( expected.range.end.root, [ 2, 1 ] ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 4 ] ); - expected.range.end = new Position( expected.range.end.root, [ 5, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 4 ] ), + new Position( expected.range.end.root, [ 5, 4 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1077,12 +1136,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start = new Position( expected.range.start.root, [ 1, 1 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 1 ] ), + expected.range.end + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 0, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 0, 3 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 0, 1 ] ), + new Position( expected.range.end.root, [ 0, 3 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1098,8 +1162,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = new Position( expected.range.start.root, [ 1, 4, 1, 2 ] ); - expected.range.end = new Position( expected.range.end.root, [ 1, 4, 2, 2, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 4, 1, 2 ] ), + new Position( expected.range.end.root, [ 1, 4, 2, 2, 4 ] ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1119,8 +1185,10 @@ describe( 'transform', () => { expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 3, 2 ] ); - expected.range.end = new Position( expected.range.end.root, [ 3, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 3, 2 ] ), + new Position( expected.range.end.root, [ 3, 4 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1138,12 +1206,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start = new Position( expected.range.start.root, [ 1, 6 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 6 ] ), + expected.range.end + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = op.range.start; - expected.range.end = new Position( expected.range.end.root, [ 1, 4 ] ); + expected.range = new Range( + op.range.start, + new Position( expected.range.end.root, [ 1, 4 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1161,19 +1234,25 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range.start = new Position( expected.range.start.root, [ 5 ] ); - expected.range.end = new Position( expected.range.end.root, [ 5, 2, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 5 ] ), + new Position( expected.range.end.root, [ 5, 2, 4 ] ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 1, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 1, 1 ] ), + new Position( expected.range.end.root, [ 2 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 3 ] ); - expected.range.end = new Position( expected.range.end.root, [ 5 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 3 ] ), + new Position( expected.range.end.root, [ 5 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 2 ], expected ); @@ -1241,8 +1320,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( 2 ); - expected.range.end = expected.range.end.getShiftedBy( 2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( 2 ), + expected.range.end.getShiftedBy( 2 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1257,8 +1338,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( 2 ); - expected.range.end = expected.range.end.getShiftedBy( 2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( 2 ), + expected.range.end.getShiftedBy( 2 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1276,8 +1359,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( -1 ); - expected.range.end = expected.range.end.getShiftedBy( -1 ); + expected.range = new Range( + expected.range.start.getShiftedBy( -1 ), + expected.range.end.getShiftedBy( -1 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1293,8 +1378,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = expected.range.start.getShiftedBy( 2 ); - expected.range.end = expected.range.end.getShiftedBy( 2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( 2 ), + expected.range.end.getShiftedBy( 2 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1312,12 +1399,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end = expected.range.end.getShiftedBy( -2 ); + expected.range = new Range( + expected.range.start, + expected.range.end.getShiftedBy( -2 ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 2, 4, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2, 4, 3 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 4, 1 ] ), + new Position( expected.range.end.root, [ 2, 4, 3 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1335,13 +1427,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start = expected.range.start.getShiftedBy( -1 ); - expected.range.end = expected.range.end.getShiftedBy( -2 ); + expected.range = new Range( + expected.range.start.getShiftedBy( -1 ), + expected.range.end.getShiftedBy( -2 ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 2, 4, 2 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2, 4, 3 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 4, 2 ] ), + new Position( expected.range.end.root, [ 2, 4, 3 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1357,8 +1453,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = new Position( expected.range.start.root, [ 2, 4, 2, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2, 4, 2, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 4, 2, 1 ] ), + new Position( expected.range.end.root, [ 2, 4, 2, 4 ] ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1376,12 +1474,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.end = expected.range.end.getShiftedBy( -1 ); + expected.range = new Range( + expected.range.start, + expected.range.end.getShiftedBy( -1 ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = new Position( expected.range.start.root, [ 2, 4, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2, 4, 2 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 4, 1 ] ), + new Position( expected.range.end.root, [ 2, 4, 2 ] ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1397,8 +1500,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range.start = new Position( expected.range.start.root, [ 2, 4, 1 ] ); - expected.range.end = new Position( expected.range.end.root, [ 2, 4, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 2, 4, 1 ] ), + new Position( expected.range.end.root, [ 2, 4, 4 ] ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1416,13 +1521,17 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range.start = expected.range.start.getShiftedTo( 4 ); - expected.range.end = expected.range.end.getShiftedTo( 6 ); + expected.range = new Range( + expected.range.start.getShiftedTo( 4 ), + expected.range.end.getShiftedTo( 6 ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = expected.range.start.getShiftedTo( op.range.start.offset ); - expected.range.end = expected.range.end.getShiftedTo( 2 ); + expected.range = new Range( + expected.range.start.getShiftedTo( op.range.start.offset ), + expected.range.end.getShiftedTo( 2 ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1440,19 +1549,25 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range.start = expected.range.start.getShiftedTo( 3 ); - expected.range.end = expected.range.end.getShiftedTo( 4 ); + expected.range = new Range( + expected.range.start.getShiftedTo( 3 ), + expected.range.end.getShiftedTo( 4 ) + ); expectOperation( transOp[ 0 ], expected ); - expected.range.start = expected.range.start.getShiftedTo( 0 ); - expected.range.end = expected.range.end.getShiftedTo( 1 ); + expected.range = new Range( + expected.range.start.getShiftedTo( 0 ), + expected.range.end.getShiftedTo( 1 ) + ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range.start = expected.range.start.getShiftedTo( 2 ); - expected.range.end = expected.range.end.getShiftedTo( 3 ); + expected.range = new Range( + expected.range.start.getShiftedTo( 2 ), + expected.range.end.getShiftedTo( 3 ) + ); expected.baseVersion++; expectOperation( transOp[ 2 ], expected ); @@ -1486,8 +1601,10 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.range.start = new Position( expected.range.start.root, [ 4, 0 ] ); - expected.range.end = new Position( expected.range.end.root, [ 4, 4 ] ); + expected.range = new Range( + new Position( expected.range.start.root, [ 4, 0 ] ), + new Position( expected.range.end.root, [ 4, 4 ] ) + ); expectOperation( transOp[ 0 ], expected ); } ); @@ -3342,8 +3459,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.newRange = null; - expected.oldRange.start = expected.oldRange.start.getShiftedTo( 3 ); - expected.oldRange.end = expected.oldRange.end.getShiftedTo( 6 ); + expected.oldRange = new Range( + expected.oldRange.start.getShiftedTo( 3 ), + expected.oldRange.end.getShiftedTo( 6 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3357,8 +3476,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.oldRange = null; - expected.newRange.start = expected.newRange.start.getShiftedTo( 12 ); - expected.newRange.end = expected.newRange.end.getShiftedTo( 14 ); + expected.newRange = new Range( + expected.newRange.start.getShiftedTo( 12 ), + expected.newRange.end.getShiftedTo( 14 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3394,8 +3515,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.newRange = null; - expected.oldRange.start = expected.oldRange.start.getShiftedTo( 0 ); - expected.oldRange.end = expected.oldRange.end.getShiftedTo( 3 ); + expected.oldRange = new Range( + expected.oldRange.start.getShiftedTo( 0 ), + expected.oldRange.end.getShiftedTo( 3 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3405,10 +3528,14 @@ describe( 'transform', () => { const transformBy = new MoveOperation( Position.createAt( root, 2 ), 2, Position.createAt( root, 20 ), baseVersion ); const transOp = transform( op, transformBy ); - expected.oldRange.start = expected.oldRange.start.getShiftedTo( 1 ); - expected.oldRange.end = expected.oldRange.end.getShiftedTo( 2 ); - expected.newRange.start = expected.newRange.start.getShiftedTo( 8 ); - expected.newRange.end = expected.newRange.end.getShiftedTo( 10 ); + expected.oldRange = new Range( + expected.oldRange.start.getShiftedTo( 1 ), + expected.oldRange.end.getShiftedTo( 2 ) + ); + expected.newRange = new Range( + expected.newRange.start.getShiftedTo( 8 ), + expected.newRange.end.getShiftedTo( 10 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3422,8 +3549,10 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.oldRange = null; - expected.newRange.start = expected.newRange.start.getShiftedTo( 10 ); - expected.newRange.end = expected.newRange.end.getShiftedTo( 14 ); + expected.newRange = new Range( + expected.newRange.start.getShiftedTo( 10 ), + expected.newRange.end.getShiftedTo( 14 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3433,10 +3562,14 @@ describe( 'transform', () => { const transformBy = new MoveOperation( Position.createAt( root, 20 ), 4, Position.createAt( root, 2 ), baseVersion ); const transOp = transform( op, transformBy ); - expected.oldRange.start = expected.oldRange.start.getShiftedTo( 1 ); - expected.oldRange.end = expected.oldRange.end.getShiftedTo( 8 ); - expected.newRange.start = expected.newRange.start.getShiftedTo( 14 ); - expected.newRange.end = expected.newRange.end.getShiftedTo( 16 ); + expected.oldRange = new Range( + expected.oldRange.start.getShiftedTo( 1 ), + expected.oldRange.end.getShiftedTo( 8 ) + ); + expected.newRange = new Range( + expected.newRange.start.getShiftedTo( 14 ), + expected.newRange.end.getShiftedTo( 16 ) + ); expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); diff --git a/tests/model/range.js b/tests/model/range.js index 44b5dd741..d32d86aca 100644 --- a/tests/model/range.js +++ b/tests/model/range.js @@ -855,7 +855,7 @@ describe( 'Range', () => { } ); it( 'move inside the range', () => { - range.end = range.end.getShiftedTo( 6 ); + range = new Range( range.start, range.end.getShiftedTo( 6 ) ); const start = new Position( root, [ 3 ] ); const target = new Position( root, [ 5 ] ); @@ -978,8 +978,10 @@ describe( 'Range', () => { describe( 'by SplitDelta', () => { it( 'split inside range', () => { - range.start = new Position( root, [ 0, 2 ] ); - range.end = new Position( root, [ 0, 4 ] ); + range = new Range( + new Position( root, [ 0, 2 ] ), + new Position( root, [ 0, 4 ] ) + ); const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 ); @@ -991,8 +993,10 @@ describe( 'Range', () => { } ); it( 'split at the beginning of multi-element range', () => { - range.start = new Position( root, [ 0, 4 ] ); - range.end = new Position( root, [ 1, 2 ] ); + range = new Range( + new Position( root, [ 0, 4 ] ), + new Position( root, [ 1, 2 ] ) + ); const delta = getSplitDelta( new Position( root, [ 0, 4 ] ), new Element( 'p' ), 3, 1 ); @@ -1004,8 +1008,10 @@ describe( 'Range', () => { } ); it( 'split inside range which starts at the beginning of split element', () => { - range.start = new Position( root, [ 0, 0 ] ); - range.end = new Position( root, [ 0, 4 ] ); + range = new Range( + new Position( root, [ 0, 0 ] ), + new Position( root, [ 0, 4 ] ) + ); const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 ); @@ -1017,8 +1023,10 @@ describe( 'Range', () => { } ); it( 'split inside range which end is at the end of split element', () => { - range.start = new Position( root, [ 0, 3 ] ); - range.end = new Position( root, [ 0, 6 ] ); + range = new Range( + new Position( root, [ 0, 3 ] ), + new Position( root, [ 0, 6 ] ) + ); const delta = getSplitDelta( new Position( root, [ 0, 4 ] ), new Element( 'p' ), 2, 1 ); @@ -1030,8 +1038,10 @@ describe( 'Range', () => { } ); it( 'split element which has collapsed range at the end', () => { - range.start = new Position( root, [ 0, 6 ] ); - range.end = new Position( root, [ 0, 6 ] ); + range = new Range( + new Position( root, [ 0, 6 ] ), + new Position( root, [ 0, 6 ] ) + ); const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 ); @@ -1045,8 +1055,10 @@ describe( 'Range', () => { describe( 'by MergeDelta', () => { it( 'merge element with collapsed range', () => { - range.start = new Position( root, [ 1, 0 ] ); - range.end = new Position( root, [ 1, 0 ] ); + range = new Range( + new Position( root, [ 1, 0 ] ), + new Position( root, [ 1, 0 ] ) + ); const delta = getMergeDelta( new Position( root, [ 1 ] ), 3, 3, 1 ); @@ -1107,8 +1119,10 @@ describe( 'Range', () => { describe( 'by WrapDelta', () => { it( 'maintans start position when wrapping element in which the range starts and ends', () => { //

f[o]o

bar

- range.start = new Position( root, [ 0, 1 ] ); - range.end = new Position( root, [ 0, 2 ] ); + range = new Range( + new Position( root, [ 0, 1 ] ), + new Position( root, [ 0, 2 ] ) + ); const wrapRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ); const wrapElement = new Element( 'w' ); @@ -1124,8 +1138,10 @@ describe( 'Range', () => { it( 'maintans start position when wrapping element in which the range starts but not ends', () => { //

f[oo

b]ar

- range.start = new Position( root, [ 0, 1 ] ); - range.end = new Position( root, [ 1, 1 ] ); + range = new Range( + new Position( root, [ 0, 1 ] ), + new Position( root, [ 1, 1 ] ) + ); const wrapRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ); const wrapElement = new Element( 'w' ); @@ -1141,8 +1157,10 @@ describe( 'Range', () => { it( 'maintans end position when wrapping element in which the range ends but not starts', () => { //

f[oo

b]ar

- range.start = new Position( root, [ 0, 1 ] ); - range.end = new Position( root, [ 1, 1 ] ); + range = new Range( + new Position( root, [ 0, 1 ] ), + new Position( root, [ 1, 1 ] ) + ); const wrapRange = new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) ); const wrapElement = new Element( 'w' ); @@ -1160,8 +1178,10 @@ describe( 'Range', () => { describe( 'by UnwrapDelta', () => { it( 'maintans start position when wrapping element in which the range starts and ends', () => { //

f[o]o

bar

- range.start = new Position( root, [ 0, 0, 1 ] ); - range.end = new Position( root, [ 0, 0, 2 ] ); + range = new Range( + new Position( root, [ 0, 0, 1 ] ), + new Position( root, [ 0, 0, 2 ] ) + ); const unwrapPosition = new Position( root, [ 0 ] ); const delta = getUnwrapDelta( unwrapPosition, 1, 1 ); @@ -1176,8 +1196,10 @@ describe( 'Range', () => { it( 'maintans start position when wrapping element in which the range starts but not ends', () => { //

f[oo

b]ar

- range.start = new Position( root, [ 0, 0, 1 ] ); - range.end = new Position( root, [ 1, 1 ] ); + range = new Range( + new Position( root, [ 0, 0, 1 ] ), + new Position( root, [ 1, 1 ] ) + ); const unwrapPosition = new Position( root, [ 0 ] ); const delta = getUnwrapDelta( unwrapPosition, 1, 1 ); @@ -1195,8 +1217,10 @@ describe( 'Range', () => { it( 'maintans end position when wrapping element in which the range ends but not starts', () => { //

f[oo

b]ar

 - range.start = new Position( root, [ 0, 1 ] ); - range.end = new Position( root, [ 1, 0, 1 ] ); + range = new Range( + new Position( root, [ 0, 1 ] ), + new Position( root, [ 1, 0, 1 ] ) + ); const unwrapPosition = new Position( root, [ 1 ] ); const delta = getUnwrapDelta( unwrapPosition, 1, 1 ); From 6d3611923256bba85332cc826dd8b6e64ce978d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 24 Oct 2017 13:02:56 +0200 Subject: [PATCH 003/724] Other: Remove non semantic methods from Position. --- src/model/delta/basic-transformations.js | 22 ++++++--- src/model/position.js | 49 +++++---------------- src/model/range.js | 11 ++++- src/model/treewalker.js | 15 +++++-- tests/model/delta/transform/_utils/utils.js | 27 +++++++++--- tests/model/delta/transform/splitdelta.js | 20 +++++++-- tests/model/operation/transform.js | 2 +- 7 files changed, 87 insertions(+), 59 deletions(-) diff --git a/src/model/delta/basic-transformations.js b/src/model/delta/basic-transformations.js index ecf49b165..e2cb2ed46 100644 --- a/src/model/delta/basic-transformations.js +++ b/src/model/delta/basic-transformations.js @@ -73,7 +73,10 @@ addTransformationCase( AttributeDelta, SplitDelta, ( a, b, context ) => { const additionalAttributeDelta = new AttributeDelta(); const rangeStart = splitPosition.getShiftedBy( 1 ); - const rangeEnd = rangeStart.getMovedToChild(); + + const rangeEndPath = rangeStart.path.slice(); + rangeEndPath.push( 0 ); + const rangeEnd = new Position( rangeStart.root, rangeEndPath ); const oldValue = b._cloneOperation.nodes.getNode( 0 ).getAttribute( operation.key ); @@ -319,7 +322,10 @@ addTransformationCase( SplitDelta, WrapDelta, ( a, b, context ) => { // Now, `splitNodePos` points before wrapping element. // To get a position before last children of that element, we expand position's `path` member by proper offset. - const splitNodePos = b.range.start.getMovedToChild( b.howMany - 1 ); + const splitPath = b.range.start.path.slice(); + splitPath.push( b.howMany - 1 ); + + const splitNodePos = new Position( b.range.start.root, splitPath ); // SplitDelta insert operation position should be right after the node we split. delta._cloneOperation.position = splitNodePos.getShiftedBy( 1 ); @@ -328,12 +334,18 @@ addTransformationCase( SplitDelta, WrapDelta, ( a, b, context ) => { // Nodes moved by SplitDelta will be moved from new position, modified by WrapDelta. // To obtain that new position, `splitNodePos` will be used, as this is the node we are extracting children from. // Nothing changed inside split node so it is correct to use the original split position offset. - delta._moveOperation.sourcePosition = splitNodePos.getMovedToChild( a.position.offset ); + const sourcePath = splitNodePos.path.slice(); + sourcePath.push( a.position.offset ); + + delta._moveOperation.sourcePosition = new Position( splitNodePos.root, sourcePath ); // 3. Fix move operation target position. // SplitDelta move operation target position should be inside the node inserted by operation above. // Since the node is empty, we will insert at offset 0. - delta._moveOperation.targetPosition = splitNodePos.getShiftedBy( 1 ).getMovedToChild(); + const targetPath = splitNodePos.getShiftedBy( 1 ).path.slice(); + targetPath.push( 0 ); + + delta._moveOperation.targetPosition = new Position( splitNodePos.root, targetPath ); return [ delta ]; } @@ -438,7 +450,7 @@ addTransformationCase( WrapDelta, SplitDelta, ( a, b, context ) => { const path = delta._moveOperation.targetPosition.path.slice(); path[ index ] += 1; - delta._moveOperation.targetPosition = delta._moveOperation.targetPosition.getMovedToPath( path ); + delta._moveOperation.targetPosition = new Position( delta._moveOperation.targetPosition.root, path ); return [ delta ]; } diff --git a/src/model/position.js b/src/model/position.js index d3037b96c..f7e8214bf 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -345,16 +345,6 @@ export default class Position { return i === 0 ? null : ancestorsA[ i - 1 ]; } - /** - * Returns a new instance of `Position`, that has same {@link #root root} but it's path is set to `path` value. - * - * @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. - * @returns {module:engine/model/position~Position} Moved position. - */ - getMovedToPath( path ) { - return new Position( this.root, path ); - } - /** * Returns a new instance of `Position`, that has same {@link #parent parent} but it's offset * is set to `offset` value. @@ -367,7 +357,7 @@ export default class Position { setOffset( path, offset ); - return this.getMovedToPath( path ); + return new Position( this.root, path ); } /** @@ -383,28 +373,6 @@ export default class Position { return this.getShiftedTo( newOffset < 0 ? 0 : newOffset ); } - /** - * Returns a new instance of `Position`, that has same {@link #root root} but it's moved in path by one level up. - * - * @returns {module:engine/model/position~Position} Moved position. - */ - getMovedToParent() { - return this.getMovedToPath( this.getParentPath() ); - } - - /** - * Returns a new instance of `Position`, that has same {@link #root root} but it's moved in path by one level down. - * - * @returns {module:engine/model/position~Position} Moved position. - */ - getMovedToChild( offsetInChild = 0 ) { - const path = this.path.slice(); - - path.push( offsetInChild ); - - return this.getMovedToPath( path ); - } - /** * Checks whether this position is after given position. * @@ -508,14 +476,17 @@ export default class Position { return false; } - left = left.getMovedToParent().getShiftedBy( 1 ); + const path = left.getParentPath(); + path[ path.length - 1 ]++; + left = new Position( left.root, path ); + leftParent = leftParent.parent; } else { if ( right.offset !== 0 ) { return false; } - right = right.getMovedToParent(); + right = new Position( right.root, right.getParentPath() ); } } } @@ -573,8 +544,10 @@ export default class Position { } else { // Otherwise, decrement index on that path. const path = this.path.slice(); + path[ i ] -= howMany; - return this.getMovedToPath( path ); + + return new Position( this.root, path ); } } } @@ -614,8 +587,10 @@ export default class Position { // And are inserted before next node of that path... // "Push" the index on that path. const path = this.path.slice(); + path[ i ] += howMany; - return this.getMovedToPath( path ); + + return new Position( this.root, path ); } } diff --git a/src/model/range.js b/src/model/range.js index b16056094..8d97af7d4 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -301,7 +301,10 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - pos = pos.getMovedToParent().getShiftedBy( 1 ); + const path = pos.getParentPath(); + path[ path.length - 1 ]++; + + pos = new Position( pos.root, path ); posParent = posParent.parent; } @@ -315,7 +318,11 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - pos = pos.getShiftedTo( offset ).getMovedToChild(); + const path = pos.getParentPath(); + path.push( offset ); + path.push( 0 ); + + pos = new Position( pos.root, path ); } return ranges; diff --git a/src/model/treewalker.js b/src/model/treewalker.js index d5096d3dc..9d9634ae1 100644 --- a/src/model/treewalker.js +++ b/src/model/treewalker.js @@ -223,7 +223,9 @@ export default class TreeWalker { if ( node instanceof Element ) { if ( !this.shallow ) { // Manual operations on path internals for optimization purposes. Here and in the rest of the method. - position = position.getMovedToChild(); + const path = position.path.slice(); + path.push( 0 ); + position = new Position( position.root, path ); this._visitedParent = node; } else { @@ -258,7 +260,9 @@ export default class TreeWalker { return formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); } else { // `node` is not set, we reached the end of current `parent`. - position = position.getMovedToParent().getShiftedBy( 1 ); + const path = position.getParentPath(); + path[ path.length - 1 ]++; + position = new Position( position.root, path ); this.position = position; this._visitedParent = parent.parent; @@ -301,7 +305,10 @@ export default class TreeWalker { position = position.getShiftedBy( -1 ); if ( !this.shallow ) { - position = position.getMovedToChild( node.maxOffset ); + const path = position.path.slice(); + path.push( node.maxOffset ); + + position = new Position( position.root, path ); this.position = position; this._visitedParent = node; @@ -341,7 +348,7 @@ export default class TreeWalker { return formatReturnValue( 'text', item, previousPosition, position, charactersCount ); } else { // `node` is not set, we reached the beginning of current `parent`. - position = position.getMovedToParent(); + position = new Position( position.root, position.getParentPath() ); this.position = position; this._visitedParent = parent.parent; diff --git a/tests/model/delta/transform/_utils/utils.js b/tests/model/delta/transform/_utils/utils.js index 5ee8dcc49..ff23e9c00 100644 --- a/tests/model/delta/transform/_utils/utils.js +++ b/tests/model/delta/transform/_utils/utils.js @@ -68,9 +68,14 @@ export function getMarkerDelta( name, oldRange, newRange, version ) { export function getMergeDelta( position, howManyInPrev, howManyInNext, version ) { const delta = new MergeDelta(); - const sourcePosition = position.getMovedToChild(); + const sourcePath = position.path.slice(); + sourcePath.push( 0 ); + const sourcePosition = new Position( position.root, sourcePath ); - const targetPosition = position.getShiftedBy( -1 ).getMovedToChild( howManyInPrev ); + const targetPath = position.getShiftedBy( -1 ).path.slice(); + targetPath.push( howManyInPrev ); + + const targetPosition = new Position( position.root, targetPath ); const move = new MoveOperation( sourcePosition, howManyInNext, targetPosition, version ); move.isSticky = true; @@ -126,9 +131,15 @@ export function getRenameDelta( position, oldName, newName, baseVersion ) { export function getSplitDelta( position, nodeCopy, howManyMove, version ) { const delta = new SplitDelta(); - const insertPosition = position.getMovedToParent().getShiftedBy( 1 ); + const insertPath = position.getParentPath(); + insertPath[ insertPath.length - 1 ]++; + + const insertPosition = new Position( position.root, insertPath ); + + const targetPath = insertPosition.path.slice(); + targetPath.push( 0 ); - const targetPosition = insertPosition.getMovedToChild(); + const targetPosition = new Position( insertPosition.root, targetPath ); delta.addOperation( new InsertOperation( insertPosition, [ nodeCopy ], version ) ); @@ -147,7 +158,9 @@ export function getWrapDelta( range, element, version ) { const insert = new InsertOperation( range.end, element, version ); - const targetPosition = range.end.getMovedToChild(); + const targetPath = range.end.path.slice(); + targetPath.push( 0 ); + const targetPosition = new Position( range.end.root, targetPath ); const move = new MoveOperation( range.start, range.end.offset - range.start.offset, targetPosition, version + 1 ); @@ -162,7 +175,9 @@ export function getWrapDelta( range, element, version ) { export function getUnwrapDelta( positionBefore, howManyChildren, version ) { const delta = new UnwrapDelta(); - const sourcePosition = positionBefore.getMovedToChild(); + const sourcePath = positionBefore.path.slice(); + sourcePath.push( 0 ); + const sourcePosition = new Position( positionBefore.root, sourcePath ); const move = new MoveOperation( sourcePosition, howManyChildren, positionBefore, version ); move.isSticky = true; diff --git a/tests/model/delta/transform/splitdelta.js b/tests/model/delta/transform/splitdelta.js index 6c0ddfc3c..7d16555f2 100644 --- a/tests/model/delta/transform/splitdelta.js +++ b/tests/model/delta/transform/splitdelta.js @@ -968,8 +968,15 @@ describe( 'transform', () => { baseVersion = removeDelta.operations.length; const newInsertPosition = removeOperation.targetPosition.getShiftedBy( 2 ); - const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ).getMovedToChild( 2 ); - const newMoveTargetPosition = newInsertPosition.getMovedToChild( ); + + const newSourcePath = removeOperation.targetPosition.getShiftedBy( 1 ).path.slice(); + newSourcePath.push( 2 ); + const newMoveSourcePosition = new Position( removeOperation.targetPosition.root, newSourcePath ); + + const newMoveTargetPath = newInsertPosition.path.slice(); + newMoveTargetPath.push( 0 ); + + const newMoveTargetPosition = new Position( newInsertPosition.root, newMoveTargetPath ); expectDelta( transformed[ 0 ], { type: SplitDelta, @@ -1002,8 +1009,13 @@ describe( 'transform', () => { baseVersion = removeDelta.operations.length; const newInsertPosition = removeOperation.targetPosition.getShiftedBy( 2 ); - const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ).getMovedToChild( 3 ); - const newMoveTargetPosition = newInsertPosition.getMovedToChild( ); + const newMoveSourcePath = removeOperation.targetPosition.getShiftedBy( 1 ).path.slice(); + newMoveSourcePath.push( 3 ); + const newMoveSourcePosition = new Position( removeOperation.targetPosition.root, newMoveSourcePath ); + + const newMoveTargetPath = newInsertPosition.path.slice(); + newMoveTargetPath.push( 0 ); + const newMoveTargetPosition = new Position( newInsertPosition.root, newMoveTargetPath ); expectDelta( transformed[ 0 ], { type: SplitDelta, diff --git a/tests/model/operation/transform.js b/tests/model/operation/transform.js index 644d66e86..ebf3bc455 100644 --- a/tests/model/operation/transform.js +++ b/tests/model/operation/transform.js @@ -58,7 +58,7 @@ describe( 'transform', () => { path[ index ] += howMany; - return position.getMovedToPath( path ); + return new Position( position.root, path ); } describe( 'InsertOperation', () => { From d3a36451e6f457906c3fef35b49572fb4449b02c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 24 Oct 2017 14:30:42 +0200 Subject: [PATCH 004/724] Other: Remove redundant Position.createFromPosition calls. --- src/model/documentselection.js | 4 +--- src/model/operation/insertoperation.js | 2 +- src/model/operation/renameoperation.js | 4 ++-- src/model/selection.js | 4 ++-- src/model/treewalker.js | 4 ++-- 5 files changed, 8 insertions(+), 10 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 7db3fb86b..765123d97 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -7,7 +7,6 @@ * @module engine/model/documentselection */ -import Position from './position'; import Range from './range'; import LiveRange from './liverange'; import Text from './text'; @@ -666,10 +665,9 @@ export default class DocumentSelection extends Selection { _fixGraveyardSelection( liveRange, removedRangeStart ) { // The start of the removed range is the closest position to the `liveRange` - the original selection range. // This is a good candidate for a fixed selection range. - const positionCandidate = Position.createFromPosition( removedRangeStart ); // Find a range that is a correct selection range and is closest to the start of removed range. - const selectionRange = this._document.getNearestSelectionRange( positionCandidate ); + const selectionRange = this._document.getNearestSelectionRange( removedRangeStart ); // Remove the old selection range before preparing and adding new selection range. This order is important, // because new range, in some cases, may intersect with old range (it depends on `getNearestSelectionRange()` result). diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 26ff844e2..43718dc0d 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -37,7 +37,7 @@ export default class InsertOperation extends Operation { * @readonly * @member {module:engine/model/position~Position} module:engine/model/operation/insertoperation~InsertOperation#position */ - this.position = Position.createFromPosition( position ); + this.position = position; /** * List of nodes to insert. diff --git a/src/model/operation/renameoperation.js b/src/model/operation/renameoperation.js index 502cd6828..ed7aeac47 100644 --- a/src/model/operation/renameoperation.js +++ b/src/model/operation/renameoperation.js @@ -66,7 +66,7 @@ export default class RenameOperation extends Operation { * @returns {module:engine/model/operation/renameoperation~RenameOperation} Clone of this operation. */ clone() { - return new RenameOperation( Position.createFromPosition( this.position ), this.oldName, this.newName, this.baseVersion ); + return new RenameOperation( this.position, this.oldName, this.newName, this.baseVersion ); } /** @@ -75,7 +75,7 @@ export default class RenameOperation extends Operation { * @returns {module:engine/model/operation/renameoperation~RenameOperation} */ getReversed() { - return new RenameOperation( Position.createFromPosition( this.position ), this.newName, this.oldName, this.baseVersion + 1 ); + return new RenameOperation( this.position, this.newName, this.oldName, this.baseVersion + 1 ); } /** diff --git a/src/model/selection.js b/src/model/selection.js index 27569afe8..d3fd43e84 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -240,7 +240,7 @@ export default class Selection { getFirstPosition() { const first = this.getFirstRange(); - return first ? Position.createFromPosition( first.start ) : null; + return first ? first.start : null; } /** @@ -255,7 +255,7 @@ export default class Selection { getLastPosition() { const lastRange = this.getLastRange(); - return lastRange ? Position.createFromPosition( lastRange.end ) : null; + return lastRange ? lastRange.end : null; } /** diff --git a/src/model/treewalker.js b/src/model/treewalker.js index 9d9634ae1..e1bb83d52 100644 --- a/src/model/treewalker.js +++ b/src/model/treewalker.js @@ -85,9 +85,9 @@ export default class TreeWalker { * @member {module:engine/model/position~Position} module:engine/model/treewalker~TreeWalker#position */ if ( options.startPosition ) { - this.position = Position.createFromPosition( options.startPosition ); + this.position = options.startPosition; } else { - this.position = Position.createFromPosition( this.boundaries[ this.direction == 'backward' ? 'end' : 'start' ] ); + this.position = this.boundaries[ this.direction == 'backward' ? 'end' : 'start' ]; } /** From 2fc0f814600688433fdb1eb051a65b890fbacba7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 24 Oct 2017 16:24:27 +0200 Subject: [PATCH 005/724] Other: Make view Position immutable. --- src/view/position.js | 46 +++++++++++++++++++++++++----------------- src/view/treewalker.js | 17 ++++++++-------- src/view/writer.js | 22 ++++++++++---------- 3 files changed, 47 insertions(+), 38 deletions(-) diff --git a/src/view/position.js b/src/view/position.js index b06bdf184..e72004016 100644 --- a/src/view/position.js +++ b/src/view/position.js @@ -13,6 +13,9 @@ import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import EditableElement from './editableelement'; +const _parent = Symbol( 'parent' ); +const _offset = Symbol( 'offset' ); + /** * Position in the tree. Position is always located before or after a node. */ @@ -24,20 +27,28 @@ export default class Position { * @param {Number} offset Position offset. */ constructor( parent, offset ) { - /** - * Position parent. - * - * @member {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment} - * module:engine/view/position~Position#parent - */ - this.parent = parent; - - /** - * Position offset. - * - * @member {Number} module:engine/view/position~Position#offset - */ - this.offset = offset; + this[ _parent ] = parent; + this[ _offset ] = offset; + } + + /** + * Position parent. + * + * @readonly + * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment} + */ + get parent() { + return this[ _parent ]; + } + + /** + * Position offset. + * + * @readonly + * @type {Number} + */ + get offset() { + return this[ _offset ]; } /** @@ -129,12 +140,9 @@ export default class Position { * @returns {module:engine/view/position~Position} Shifted position. */ getShiftedBy( shift ) { - const shifted = Position.createFromPosition( this ); - - const offset = shifted.offset + shift; - shifted.offset = offset < 0 ? 0 : offset; + const offset = this.offset + shift; - return shifted; + return new Position( this.parent, offset < 0 ? 0 : offset ); } /** diff --git a/src/view/treewalker.js b/src/view/treewalker.js index 838f09280..479e79f15 100644 --- a/src/view/treewalker.js +++ b/src/view/treewalker.js @@ -73,9 +73,9 @@ export default class TreeWalker { * @member {module:engine/view/position~Position} module:engine/view/treewalker~TreeWalker#position */ if ( options.startPosition ) { - this.position = Position.createFromPosition( options.startPosition ); + this.position = options.startPosition; } else { - this.position = Position.createFromPosition( options.boundaries[ options.direction == 'backward' ? 'end' : 'start' ] ); + this.position = options.boundaries[ options.direction == 'backward' ? 'end' : 'start' ]; } /** @@ -222,7 +222,7 @@ export default class TreeWalker { if ( !this.shallow ) { position = new Position( node, 0 ); } else { - position.offset++; + position = position.getShiftedBy( 1 ); } this.position = position; @@ -245,7 +245,7 @@ export default class TreeWalker { position = Position.createAfter( item ); } else { // If not just keep moving forward. - position.offset++; + position = position.getShiftedBy( 1 ); } this.position = position; @@ -266,7 +266,8 @@ export default class TreeWalker { const textProxy = new TextProxy( parent, position.offset, textLength ); - position.offset += textLength; + position = position.getShiftedBy( textLength ); + this.position = position; return this._formatReturnValue( 'text', textProxy, previousPosition, position, textLength ); @@ -334,7 +335,7 @@ export default class TreeWalker { return this._formatReturnValue( 'elementEnd', node, previousPosition, position ); } } else { - position.offset--; + position = position.getShiftedBy( -1 ); this.position = position; return this._formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); @@ -358,7 +359,7 @@ export default class TreeWalker { position = Position.createBefore( item ); } else { // If not just keep moving backward. - position.offset--; + position = position.getShiftedBy( -1 ); } this.position = position; @@ -377,7 +378,7 @@ export default class TreeWalker { textLength = 1; } - position.offset -= textLength; + position = position.getShiftedBy( -textLength ); const textProxy = new TextProxy( parent, position.offset, textLength ); diff --git a/src/view/writer.js b/src/view/writer.js index ffbd49b07..0b9a060a2 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -305,7 +305,7 @@ export function insert( position, nodes ) { const insertionPosition = _breakAttributes( position, true ); const length = container.insertChildren( insertionPosition.offset, nodes ); - const endPosition = insertionPosition.getShiftedBy( length ); + let endPosition = insertionPosition.getShiftedBy( length ); const start = mergeAttributes( insertionPosition ); // When no nodes were inserted - return collapsed range. @@ -314,7 +314,7 @@ export function insert( position, nodes ) { } else { // If start position was merged - move end position. if ( !start.isEqual( insertionPosition ) ) { - endPosition.offset--; + endPosition = endPosition.getShiftedBy( -1 ); } const end = mergeAttributes( endPosition ); @@ -447,7 +447,7 @@ export function move( sourceRange, targetPosition ) { nodes = remove( sourceRange ); - targetPosition.offset += ( parent.childCount - countBefore ); + targetPosition = targetPosition.getShiftedBy( parent.childCount - countBefore ); } else { nodes = remove( sourceRange ); } @@ -512,7 +512,7 @@ export function wrap( range, attribute ) { // If start position was merged - move end position back. if ( !start.isEqual( newRange.start ) ) { - newRange.end.offset--; + newRange.end = newRange.end.getShiftedBy( -1 ); } const end = mergeAttributes( newRange.end ); @@ -626,7 +626,7 @@ export function unwrap( range, attribute ) { // If start position was merged - move end position back. if ( !start.isEqual( newRange.start ) ) { - newRange.end.offset--; + newRange.end = newRange.end.getShiftedBy( -1 ); } const end = mergeAttributes( newRange.end ); @@ -702,12 +702,12 @@ function _breakAttributesRange( range, forceSplitText = false ) { return new Range( position, position ); } - const breakEnd = _breakAttributes( rangeEnd, forceSplitText ); + let breakEnd = _breakAttributes( rangeEnd, forceSplitText ); const count = breakEnd.parent.childCount; const breakStart = _breakAttributes( rangeStart, forceSplitText ); // Calculate new break end offset. - breakEnd.offset += breakEnd.parent.childCount - count; + breakEnd = breakEnd.getShiftedBy( breakEnd.parent.childCount - count ); return new Range( breakStart, breakEnd ); } @@ -857,8 +857,8 @@ function unwrapChildren( parent, startOffset, endOffset, attribute ) { // Merge at each unwrap. let offsetChange = 0; - for ( const position of unwrapPositions ) { - position.offset -= offsetChange; + for ( let position of unwrapPositions ) { + position = position.getShiftedBy( -offsetChange ); // Do not merge with elements outside selected children. if ( position.offset == startOffset || position.offset == endOffset ) { @@ -918,8 +918,8 @@ function wrapChildren( parent, startOffset, endOffset, attribute ) { // Merge at each wrap. let offsetChange = 0; - for ( const position of wrapPositions ) { - position.offset -= offsetChange; + for ( let position of wrapPositions ) { + position = position.getShiftedBy( -offsetChange ); // Do not merge with elements outside selected children. if ( position.offset == startOffset ) { From 9f3a6aa6841e3a4810ecebf5fb6ada6e9746bbdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 24 Oct 2017 16:36:38 +0200 Subject: [PATCH 006/724] Other: Remove excessive view Position.createFromPosition calls. --- src/view/range.js | 7 +++---- src/view/selection.js | 10 ++++------ src/view/treewalker.js | 4 ++-- src/view/writer.js | 8 ++++---- tests/view/range.js | 4 ++-- tests/view/selection.js | 10 +++++----- 6 files changed, 20 insertions(+), 23 deletions(-) diff --git a/src/view/range.js b/src/view/range.js index 991b69340..9f5cd0b60 100644 --- a/src/view/range.js +++ b/src/view/range.js @@ -28,14 +28,14 @@ export default class Range { * * @member {module:engine/view/position~Position} */ - this.start = Position.createFromPosition( start ); + this.start = start; /** * End position. * * @member {module:engine/view/position~Position} */ - this.end = end ? Position.createFromPosition( end ) : Position.createFromPosition( start ); + this.end = end ? end : start; } /** @@ -451,9 +451,8 @@ export default class Range { */ static createCollapsedAt( itemOrPosition, offset ) { const start = Position.createAt( itemOrPosition, offset ); - const end = Position.createFromPosition( start ); - return new Range( start, end ); + return new Range( start, start ); } } diff --git a/src/view/selection.js b/src/view/selection.js index 3d96afb40..d48551259 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -132,9 +132,8 @@ export default class Selection { return null; } const range = this._ranges[ this._ranges.length - 1 ]; - const anchor = this._lastRangeBackward ? range.end : range.start; - return Position.createFromPosition( anchor ); + return this._lastRangeBackward ? range.end : range.start; } /** @@ -148,9 +147,8 @@ export default class Selection { return null; } const range = this._ranges[ this._ranges.length - 1 ]; - const focus = this._lastRangeBackward ? range.start : range.end; - return Position.createFromPosition( focus ); + return this._lastRangeBackward ? range.start : range.end; } /** @@ -281,7 +279,7 @@ export default class Selection { getFirstPosition() { const firstRange = this.getFirstRange(); - return firstRange ? Position.createFromPosition( firstRange.start ) : null; + return firstRange ? firstRange.start : null; } /** @@ -294,7 +292,7 @@ export default class Selection { getLastPosition() { const lastRange = this.getLastRange(); - return lastRange ? Position.createFromPosition( lastRange.end ) : null; + return lastRange ? lastRange.end : null; } /** diff --git a/src/view/treewalker.js b/src/view/treewalker.js index 479e79f15..7979da760 100644 --- a/src/view/treewalker.js +++ b/src/view/treewalker.js @@ -187,7 +187,7 @@ export default class TreeWalker { * @returns {module:engine/view/treewalker~TreeWalkerValue} return.value Information about taken step. */ _next() { - let position = Position.createFromPosition( this.position ); + let position = this.position; const previousPosition = this.position; const parent = position.parent; @@ -293,7 +293,7 @@ export default class TreeWalker { * @returns {module:engine/view/treewalker~TreeWalkerValue} return.value Information about taken step. */ _previous() { - let position = Position.createFromPosition( this.position ); + let position = this.position; const previousPosition = this.position; const parent = position.parent; diff --git a/src/view/writer.js b/src/view/writer.js index 0b9a060a2..7a1017db4 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -355,7 +355,7 @@ export function remove( range ) { // Merge after removing. const mergePosition = mergeAttributes( breakStart ); range.start = mergePosition; - range.end = Position.createFromPosition( mergePosition ); + range.end = mergePosition; // Return removed nodes. return new DocumentFragment( removed ); @@ -537,7 +537,7 @@ export function wrapPosition( position, attribute ) { // Return same position when trying to wrap with attribute similar to position parent. if ( attribute.isSimilar( position.parent ) ) { - return movePositionToTextNode( Position.createFromPosition( position ) ); + return movePositionToTextNode( position ); } // When position is inside text node - break it and place new position between two text nodes. @@ -752,12 +752,12 @@ function _breakAttributes( position, forceSplitText = false ) { // There are no attributes to break and text nodes breaking is not forced. if ( !forceSplitText && positionParent.is( 'text' ) && isContainerOrFragment( positionParent.parent ) ) { - return Position.createFromPosition( position ); + return position; } // Position's parent is container, so no attributes to break. if ( isContainerOrFragment( positionParent ) ) { - return Position.createFromPosition( position ); + return position; } // Break text and start again in new position. diff --git a/tests/view/range.js b/tests/view/range.js index b33596bdb..1fba91170 100644 --- a/tests/view/range.js +++ b/tests/view/range.js @@ -25,8 +25,8 @@ describe( 'Range', () => { const range = new Range( start, end ); expect( range ).to.be.an.instanceof( Range ); - expect( range ).to.have.property( 'start' ).that.not.equals( start ); - expect( range ).to.have.property( 'end' ).that.not.equals( end ); + expect( range ).to.have.property( 'start' ).that.equals( start ); + expect( range ).to.have.property( 'end' ).that.equals( end ); expect( range.start.parent ).to.equal( start.parent ); expect( range.end.parent ).to.equal( end.parent ); expect( range.start.offset ).to.equal( start.offset ); diff --git a/tests/view/selection.js b/tests/view/selection.js index e0660bbc0..5e1b8bf50 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -59,7 +59,7 @@ describe( 'Selection', () => { const anchor = selection.anchor; expect( anchor.isEqual( range1.start ) ).to.be.true; - expect( anchor ).to.not.equal( range1.start ); + expect( anchor ).to.equal( range1.start ); } ); it( 'should return end of single range in selection when added as backward', () => { @@ -67,7 +67,7 @@ describe( 'Selection', () => { const anchor = selection.anchor; expect( anchor.isEqual( range1.end ) ).to.be.true; - expect( anchor ).to.not.equal( range1.end ); + expect( anchor ).to.equal( range1.end ); } ); it( 'should get anchor from last inserted range', () => { @@ -95,7 +95,7 @@ describe( 'Selection', () => { const focus = selection.focus; expect( focus.isEqual( range1.start ) ).to.be.true; - expect( focus ).to.not.equal( range1.start ); + expect( focus ).to.equal( range1.start ); } ); it( 'should get focus from last inserted range', () => { @@ -410,7 +410,7 @@ describe( 'Selection', () => { const position = selection.getFirstPosition(); expect( position.isEqual( range2.start ) ).to.be.true; - expect( position ).to.not.equal( range2.start ); + expect( position ).to.equal( range2.start ); } ); it( 'should return null if no ranges are present', () => { @@ -427,7 +427,7 @@ describe( 'Selection', () => { const position = selection.getLastPosition(); expect( position.isEqual( range3.end ) ).to.be.true; - expect( position ).to.not.equal( range3.end ); + expect( position ).to.equal( range3.end ); } ); it( 'should return null if no ranges are present', () => { From 8eae307521621a246c12d37fbcc5a6038edd482e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Wed, 25 Oct 2017 12:33:10 +0200 Subject: [PATCH 007/724] Other: Make view Range immutable. --- src/view/range.js | 41 +++++++++++++++++++++++++------------ src/view/writer.js | 26 ++++++++++++++--------- tests/view/writer/remove.js | 25 +++++++++++----------- 3 files changed, 56 insertions(+), 36 deletions(-) diff --git a/src/view/range.js b/src/view/range.js index 9f5cd0b60..4098a9589 100644 --- a/src/view/range.js +++ b/src/view/range.js @@ -10,6 +10,9 @@ import Position from './position'; import TreeWalker from './treewalker'; +const _start = Symbol( 'start' ); +const _end = Symbol( 'end' ); + /** * Tree view range. */ @@ -23,19 +26,8 @@ export default class Range { * @param {module:engine/view/position~Position} [end] End position. If not set, range will be collapsed at `start` position. */ constructor( start, end = null ) { - /** - * Start position. - * - * @member {module:engine/view/position~Position} - */ - this.start = start; - - /** - * End position. - * - * @member {module:engine/view/position~Position} - */ - this.end = end ? end : start; + this[ _start ] = start; + this[ _end ] = end ? end : start; } /** @@ -53,9 +45,30 @@ export default class Range { yield* new TreeWalker( { boundaries: this, ignoreElementEnd: true } ); } + /** + * Start position. + * + * @readonly + * @type {module:engine/view/position~Position} + */ + get start() { + return this[ _start ]; + } + + /** + * End position. + * + * @readonly + * @type {module:engine/view/position~Position} + */ + get end() { + return this[ _end ]; + } + /** * Returns whether the range is collapsed, that is it start and end positions are equal. * + * @readonly * @type {Boolean} */ get isCollapsed() { @@ -66,6 +79,7 @@ export default class Range { * Returns whether this range is flat, that is if {@link module:engine/view/range~Range#start start} position and * {@link module:engine/view/range~Range#end end} position are in the same {@link module:engine/view/position~Position#parent parent}. * + * @readonly * @type {Boolean} */ get isFlat() { @@ -75,6 +89,7 @@ export default class Range { /** * Range root element. * + * @readonly * @type {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} */ get root() { diff --git a/src/view/writer.js b/src/view/writer.js index 7a1017db4..06ba7daaf 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -353,9 +353,7 @@ export function remove( range ) { const removed = parentContainer.removeChildren( breakStart.offset, count ); // Merge after removing. - const mergePosition = mergeAttributes( breakStart ); - range.start = mergePosition; - range.end = mergePosition; + mergeAttributes( breakStart ); // Return removed nodes. return new DocumentFragment( removed ); @@ -406,17 +404,20 @@ export function clear( range, element ) { // If we have found element to remove. if ( rangeToRemove ) { + let rangeEnd = rangeToRemove.end; + let rangeStart = rangeToRemove.start; + // We need to check if element range stick out of the given range and truncate if it is. if ( rangeToRemove.end.isAfter( range.end ) ) { - rangeToRemove.end = range.end; + rangeEnd = range.end; } if ( rangeToRemove.start.isBefore( range.start ) ) { - rangeToRemove.start = range.start; + rangeStart = range.start; } // At the end we remove range with found element. - remove( rangeToRemove ); + remove( new Range( rangeStart, rangeEnd ) ); } } } @@ -511,10 +512,13 @@ export function wrap( range, attribute ) { const start = mergeAttributes( newRange.start ); // If start position was merged - move end position back. + let rangeEnd = newRange.end; + if ( !start.isEqual( newRange.start ) ) { - newRange.end = newRange.end.getShiftedBy( -1 ); + rangeEnd = rangeEnd.getShiftedBy( -1 ); } - const end = mergeAttributes( newRange.end ); + + const end = mergeAttributes( rangeEnd ); return new Range( start, end ); } @@ -625,10 +629,12 @@ export function unwrap( range, attribute ) { const start = mergeAttributes( newRange.start ); // If start position was merged - move end position back. + let rangeEnd = newRange.end; + if ( !start.isEqual( newRange.start ) ) { - newRange.end = newRange.end.getShiftedBy( -1 ); + rangeEnd = rangeEnd.getShiftedBy( -1 ); } - const end = mergeAttributes( newRange.end ); + const end = mergeAttributes( rangeEnd ); return new Range( start, end ); } diff --git a/tests/view/writer/remove.js b/tests/view/writer/remove.js index ecced8a9e..db3edca6d 100644 --- a/tests/view/writer/remove.js +++ b/tests/view/writer/remove.js @@ -15,8 +15,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'writer', () => { /** - * Executes test using `parse` and `stringify` utils functions. Uses range delimiters `[]{}` to create and - * test ranges. + * Executes test using `parse` and `stringify` utils functions. Uses range delimiters `[]{}` to create ranges. * * @param {String} input * @param {String} expectedResult @@ -27,7 +26,7 @@ describe( 'writer', () => { const range = selection.getFirstRange(); const removed = remove( range ); - expect( stringify( view, range, { showType: true, showPriority: true } ) ).to.equal( expectedResult ); + expect( stringify( view, null, { showType: true, showPriority: true } ) ).to.equal( expectedResult ); expect( stringify( removed, null, { showType: true, showPriority: true } ) ).to.equal( expectedRemoved ); } @@ -60,21 +59,21 @@ describe( 'writer', () => { } ); it( 'should remove single text node', () => { - test( '[foobar]', '[]', 'foobar' ); + test( '[foobar]', '', 'foobar' ); } ); it( 'should not leave empty text nodes', () => { - test( '{foobar}', '[]', 'foobar' ); + test( '{foobar}', '', 'foobar' ); } ); it( 'should remove part of the text node', () => { - test( 'f{oob}ar', 'f{}ar', 'oob' ); + test( 'f{oob}ar', 'far', 'oob' ); } ); it( 'should remove parts of nodes #1', () => { test( 'f{ooba}r', - 'f[]r', + 'fr', 'ooba' ); } ); @@ -82,7 +81,7 @@ describe( 'writer', () => { it( 'should support unicode', () => { test( 'நி{லைக்}கு', - 'நி[]கு', + 'நிகு', 'லைக்' ); } ); @@ -92,7 +91,7 @@ describe( 'writer', () => { '' + 'foo[bar]bazqux' + '', - 'foo{}bazqux', + 'foobazqux', 'bar' ); } ); @@ -102,19 +101,19 @@ describe( 'writer', () => { '' + 'fo{obarba}zqux' + '', - 'fo{}zqux', + 'fozqux', 'obarba' ); } ); it( 'should remove part of the text node in document fragment', () => { - test( 'fo{ob}ar', 'fo{}ar', 'ob' ); + test( 'fo{ob}ar', 'foar', 'ob' ); } ); it( 'should remove EmptyElement', () => { test( 'foo[]bar', - 'foo{}bar', + 'foobar', '' ); } ); @@ -133,7 +132,7 @@ describe( 'writer', () => { it( 'should remove UIElement', () => { test( 'foo[]bar', - 'foo{}bar', + 'foobar', '' ); } ); From 74eca6af34db7f53cb4e381d2f04d607d3d33f31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Wed, 25 Oct 2017 13:19:03 +0200 Subject: [PATCH 008/724] Docs: Update `writer.remove()` method docs. --- src/view/writer.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/view/writer.js b/src/view/writer.js index 06ba7daaf..1c9fe58d1 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -331,8 +331,7 @@ export function insert( position, nodes ) { * same parent container. * * @function module:engine/view/writer~writer.remove - * @param {module:engine/view/range~Range} range Range to remove from container. After removing, it will be updated - * to a collapsed range showing the new position. + * @param {module:engine/view/range~Range} range Range to remove from container. * @returns {module:engine/view/documentfragment~DocumentFragment} Document fragment containing removed nodes. */ export function remove( range ) { From 8f29d4b153b5e3027ebc71450c41ef5a0a2584c6 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 3 Nov 2017 13:56:38 +0100 Subject: [PATCH 009/724] Fixed failed test on Edge. DOM element must be focusable. --- tests/controller/editingcontroller.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tests/controller/editingcontroller.js b/tests/controller/editingcontroller.js index a0ae8b850..aafae4641 100644 --- a/tests/controller/editingcontroller.js +++ b/tests/controller/editingcontroller.js @@ -137,6 +137,8 @@ describe( 'EditingController', () => { editing = new EditingController( model ); domRoot = document.createElement( 'div' ); + domRoot.contentEditable = true; + document.body.appendChild( domRoot ); viewRoot = editing.createRoot( domRoot ); @@ -217,12 +219,15 @@ describe( 'EditingController', () => { expect( getModelData( model ) ).to.equal( 'foo' + '' + - 'b[a]r' ); + 'b[a]r' + ); + done(); } ); } ); editing.view.isFocused = true; + editing.view.render(); const domSelection = document.getSelection(); domSelection.removeAllRanges(); From 40c7d0b13f9a38a16429b9c34b00a450607e73ec Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 3 Nov 2017 15:38:37 +0100 Subject: [PATCH 010/724] Tests: DOM Root will be removed after each test execution. --- tests/view/renderer.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/view/renderer.js b/tests/view/renderer.js index 64fb05969..75e87b57a 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -137,6 +137,10 @@ describe( 'Renderer', () => { } ); } ); + afterEach( () => { + domRoot.remove(); + } ); + it( 'should update attributes', () => { viewRoot.setAttribute( 'class', 'foo' ); From 86a7724cd31020319b65395401c3f1502f260748 Mon Sep 17 00:00:00 2001 From: Aleksander Nowodzinski Date: Tue, 7 Nov 2017 17:18:27 +0100 Subject: [PATCH 011/724] Migrated UI components from SASS to PostCSS. Added theme support. --- src/view/placeholder.js | 2 +- tests/manual/nestededitable.css | 27 +++++++++++++++++++++++++++ tests/manual/nestededitable.js | 2 +- tests/manual/nestededitable.scss | 25 ------------------------- theme/placeholder.css | 11 +++++++++++ theme/placeholder.scss | 9 --------- 6 files changed, 40 insertions(+), 36 deletions(-) create mode 100644 tests/manual/nestededitable.css delete mode 100644 tests/manual/nestededitable.scss create mode 100644 theme/placeholder.css delete mode 100644 theme/placeholder.scss diff --git a/src/view/placeholder.js b/src/view/placeholder.js index 8b3b77363..5b123f27e 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -10,7 +10,7 @@ import extend from '@ckeditor/ckeditor5-utils/src/lib/lodash/extend'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -import '../../theme/placeholder.scss'; +import '../../theme/placeholder.css'; const listener = {}; extend( listener, EmitterMixin ); diff --git a/tests/manual/nestededitable.css b/tests/manual/nestededitable.css new file mode 100644 index 000000000..cccb279f1 --- /dev/null +++ b/tests/manual/nestededitable.css @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +@import "@ckeditor/ckeditor5-theme-lark/theme/helpers/colors.css"; +@import "@ckeditor/ckeditor5-theme-lark/theme/helpers/states.css"; +@import "@ckeditor/ckeditor5-theme-lark/theme/helpers/shadow.css"; + +figure { + background-color: #f3f3f3; + padding: 10px; + + & figcaption { + background: white; + outline: none; + + &.focused { + @mixin ck-focus-ring; + @mixin ck-box-shadow var(--ck-inner-shadow); + } + } +} + + + + diff --git a/tests/manual/nestededitable.js b/tests/manual/nestededitable.js index 511cfd7f9..e31910e65 100644 --- a/tests/manual/nestededitable.js +++ b/tests/manual/nestededitable.js @@ -18,7 +18,7 @@ import ViewEditableElement from '../../src/view/editableelement'; import { getData } from '../../src/dev-utils/model'; import global from '@ckeditor/ckeditor5-utils/src/dom/global'; -import './nestededitable.scss'; +import './nestededitable.css'; class NestedEditable extends Plugin { init() { diff --git a/tests/manual/nestededitable.scss b/tests/manual/nestededitable.scss deleted file mode 100644 index d74bae085..000000000 --- a/tests/manual/nestededitable.scss +++ /dev/null @@ -1,25 +0,0 @@ -// Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. -// For licensing, see LICENSE.md or http://ckeditor.com/license - -@import '~@ckeditor/ckeditor5-theme-lark/theme/helpers/_colors.scss'; -@import '~@ckeditor/ckeditor5-theme-lark/theme/helpers/_shadow.scss'; -@import '~@ckeditor/ckeditor5-theme-lark/theme/helpers/_states.scss'; - -figure { - background-color: #f3f3f3; - padding: 10px; - - figcaption { - background: white; - outline: none; - - &.focused { - @include ck-focus-ring(); - @include ck-box-shadow( $ck-inner-shadow ); - } - } -} - - - - diff --git a/theme/placeholder.css b/theme/placeholder.css new file mode 100644 index 000000000..3e2ced547 --- /dev/null +++ b/theme/placeholder.css @@ -0,0 +1,11 @@ +/* + * Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +.ck-placeholder::before { + content: attr( data-placeholder ); + + /* See ckeditor/ckeditor5#469. */ + pointer-events: none; +} diff --git a/theme/placeholder.scss b/theme/placeholder.scss deleted file mode 100644 index c358080ad..000000000 --- a/theme/placeholder.scss +++ /dev/null @@ -1,9 +0,0 @@ -// Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. -// For licensing, see LICENSE.md or http://ckeditor.com/license - -.ck-placeholder::before { - content: attr( data-placeholder ); - cursor: text; - color: #c2c2c2; - pointer-events: none; // See ckeditor/ckeditor5#469. -} From e4704866d712fc831ceb9c06c3601339f6dd1ac8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 9 Nov 2017 11:39:33 +0100 Subject: [PATCH 012/724] Fixed failing SelectionObserver tests on Edge. --- tests/view/observer/selectionobserver.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/view/observer/selectionobserver.js b/tests/view/observer/selectionobserver.js index e4e393ced..9a4b78be6 100644 --- a/tests/view/observer/selectionobserver.js +++ b/tests/view/observer/selectionobserver.js @@ -43,6 +43,7 @@ describe( 'SelectionObserver', () => { domDocument.getSelection().removeAllRanges(); viewDocument.isFocused = true; + domMain.focus(); selectionObserver.enable(); @@ -147,7 +148,7 @@ describe( 'SelectionObserver', () => { viewDocument.on( 'selectionChange', spy ); setTimeout( () => { - sinon.assert.calledOnce( spy ); + sinon.assert.called( spy ); done(); }, 70 ); @@ -156,7 +157,7 @@ describe( 'SelectionObserver', () => { it( 'should warn and not enter infinite loop', () => { // Selectionchange event is called twice per `changeDomSelection()` execution. - let counter = 35; + let counter = 70; const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 ); viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewFoo, 0, viewFoo, 0 ) ); @@ -347,7 +348,6 @@ describe( 'SelectionObserver', () => { const domFoo = domMain.childNodes[ 1 ].childNodes[ 0 ]; const offset = domSelection.anchorOffset; - domSelection.removeAllRanges(); domSelection.collapse( domFoo, offset == 2 ? 3 : 2 ); } } ); From 2c79e643b91ac78ce3acdc8bf45b9f02b20c4ea8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 9 Nov 2017 11:46:48 +0100 Subject: [PATCH 013/724] Fixed failing FocusObserver tests on Edge. --- tests/view/observer/focusobserver.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/view/observer/focusobserver.js b/tests/view/observer/focusobserver.js index 9627c3778..f02b4a810 100644 --- a/tests/view/observer/focusobserver.js +++ b/tests/view/observer/focusobserver.js @@ -171,7 +171,7 @@ describe( 'FocusObserver', () => { done(); }, { priority: 'low' } ); - observer.onDomEvent( { type: 'focus', target: domEditable } ); + domEditable.focus(); domSelection.collapse( domEditable, 0 ); } ); From c98514166e28db57c23a8c8b4adea28cc6137cd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 9 Nov 2017 16:20:51 +0100 Subject: [PATCH 014/724] Fixed part of DomConverter tests on Edge. --- tests/view/domconverter/domconverter.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/view/domconverter/domconverter.js b/tests/view/domconverter/domconverter.js index 6fd5b4c75..32ca20a9d 100644 --- a/tests/view/domconverter/domconverter.js +++ b/tests/view/domconverter/domconverter.js @@ -48,6 +48,8 @@ describe( 'DomConverter', () => { domEditable.setAttribute( 'contenteditable', 'true' ); domEditableParent.appendChild( domEditable ); document.body.appendChild( domEditableParent ); + // Make sure we are starting with focus on document body each time. + document.body.focus(); } ); afterEach( () => { From d52cf3b1bedcd64ba3d6abcca4076b9d19b6a299 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 9 Nov 2017 17:46:49 +0100 Subject: [PATCH 015/724] Fix: Don't register LiveRange as listeningTo in `DocumentSelection._prepareRange()`. --- src/model/documentselection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 7db3fb86b..b377f3f12 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -325,7 +325,7 @@ export default class DocumentSelection extends Selection { const liveRange = LiveRange.createFromRange( range ); - this.listenTo( liveRange, 'change:range', ( evt, oldRange, data ) => { + liveRange.on( 'change:range', ( evt, oldRange, data ) => { // If `LiveRange` is in whole moved to the graveyard, fix that range. if ( liveRange.root == this._document.graveyard ) { this._fixGraveyardSelection( liveRange, data.sourcePosition ); From dd9743bdb870ce73ed09b0ae1a3b7786683c0498 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 10 Nov 2017 15:44:55 +0100 Subject: [PATCH 016/724] Fixed some DomConverter tests failing on Edge. --- tests/view/domconverter/domconverter.js | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/tests/view/domconverter/domconverter.js b/tests/view/domconverter/domconverter.js index 32ca20a9d..09b716f71 100644 --- a/tests/view/domconverter/domconverter.js +++ b/tests/view/domconverter/domconverter.js @@ -48,13 +48,14 @@ describe( 'DomConverter', () => { domEditable.setAttribute( 'contenteditable', 'true' ); domEditableParent.appendChild( domEditable ); document.body.appendChild( domEditableParent ); - // Make sure we are starting with focus on document body each time. - document.body.focus(); } ); afterEach( () => { + converter.unbindDomElement( domEditable ); document.body.removeChild( domEditableParent ); viewDocument.destroy(); + + document.body.focus(); } ); it( 'should call focus on corresponding DOM editable', () => { @@ -228,6 +229,10 @@ describe( 'DomConverter', () => { document.body.appendChild( domP ); } ); + afterEach( () => { + domP.remove(); + } ); + it( 'should return true for correct dom selection', () => { //

INLINE_FILLER{foo}

. const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domFillerTextNode, INLINE_FILLER_LENGTH + 3 ); @@ -276,20 +281,20 @@ describe( 'DomConverter', () => { it( 'if anchor or focus is directly inside dom element that represents view ui element', () => { // Tests forward and backward selection. //

INLINE_FILLER{foo]

. - const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH + 3, domUiSpan, 0 ); + const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domUiSpan, 0 ); expect( converter.isDomSelectionCorrect( sel1 ) ).to.be.false; - const sel2 = domSelection( domUiSpan, 0, domFillerTextNode, INLINE_FILLER_LENGTH + 3 ); + const sel2 = domSelection( domUiSpan, 0, domFillerTextNode, INLINE_FILLER_LENGTH ); expect( converter.isDomSelectionCorrect( sel2 ) ).to.be.false; } ); it( 'if anchor or focus is inside deep ui element structure (not directly in ui element)', () => { // Tests forward and backward selection. //

INLINE_FILLER{foo]

. - const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH + 3, domUiDeepSpan, 0 ); + const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domUiDeepSpan, 0 ); expect( converter.isDomSelectionCorrect( sel1 ) ).to.be.false; - const sel2 = domSelection( domUiDeepSpan, 0, domFillerTextNode, INLINE_FILLER_LENGTH + 3 ); + const sel2 = domSelection( domUiDeepSpan, 0, domFillerTextNode, INLINE_FILLER_LENGTH ); expect( converter.isDomSelectionCorrect( sel2 ) ).to.be.false; } ); } ); From 190f0042381e2680ef80e81288dedfc901571f92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Mon, 13 Nov 2017 09:57:17 +0100 Subject: [PATCH 017/724] Changed selectionchange test checking if infinite loop warning is not displayed. --- tests/view/observer/selectionobserver.js | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/tests/view/observer/selectionobserver.js b/tests/view/observer/selectionobserver.js index 9a4b78be6..0ca38c8fb 100644 --- a/tests/view/observer/selectionobserver.js +++ b/tests/view/observer/selectionobserver.js @@ -156,7 +156,6 @@ describe( 'SelectionObserver', () => { } ); it( 'should warn and not enter infinite loop', () => { - // Selectionchange event is called twice per `changeDomSelection()` execution. let counter = 70; const viewFoo = viewDocument.getRoot().getChild( 0 ).getChild( 0 ); @@ -216,8 +215,6 @@ describe( 'SelectionObserver', () => { clock.restore(); } ); - // Selectionchange event is called twice per `changeDomSelection()` execution. We call it 25 times to get - // 50 events. Infinite loop counter is reset, so calling this method twice should not show any warning. function doChanges() { return new Promise( resolve => { viewDocument.once( 'selectionChangeDone', () => { @@ -225,7 +222,7 @@ describe( 'SelectionObserver', () => { resolve(); } ); - for ( let i = 0; i < 30; i++ ) { + for ( let i = 0; i < 50; i++ ) { changeDomSelection(); } } ); From eb0e9967fb9aa16cf227d0656315f16be20dfb5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Mon, 13 Nov 2017 14:36:20 +0100 Subject: [PATCH 018/724] Fixed how native tree walker is created in DomConverter. Topmost ancestor of text node is used instead of whole document which crashes on Edge. --- src/view/domconverter.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/view/domconverter.js b/src/view/domconverter.js index d292057a0..82ca210ce 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -1061,7 +1061,9 @@ export default class DomConverter { const direction = getNext ? 'nextNode' : 'previousNode'; const document = node.ownerDocument; - const treeWalker = document.createTreeWalker( document.childNodes[ 0 ], NodeFilter.SHOW_TEXT ); + const topmostParent = getAncestors( node )[ 0 ]; + + const treeWalker = document.createTreeWalker( topmostParent, NodeFilter.SHOW_TEXT ); treeWalker.currentNode = node; From 4860eead43afd4d94d6b205eacf6ac19d1686aad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Mon, 13 Nov 2017 16:13:33 +0100 Subject: [PATCH 019/724] Fixed renderer test failing on Edge browser. --- tests/view/renderer.js | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/tests/view/renderer.js b/tests/view/renderer.js index 3e9c31313..92a174789 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -1049,7 +1049,6 @@ describe( 'Renderer', () => { renderer.render(); // 2. Check the DOM. - const domP = domRoot.childNodes[ 0 ]; expect( domP.childNodes.length ).to.equal( 2 ); @@ -1067,6 +1066,7 @@ describe( 'Renderer', () => { expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH ); expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true; + domSelection.removeAllRanges(); // 3. Add text node only to the view:

x{}foo

. const viewText = new ViewText( 'x' ); @@ -1081,9 +1081,19 @@ describe( 'Renderer', () => { expect( domB.childNodes[ 0 ].data ).to.equal( INLINE_FILLER + 'x' ); expect( domSelection.rangeCount ).to.equal( 1 ); - expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domB.childNodes[ 0 ] ); - expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 ); - expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true; + + // Depending on the browser selection may end up at the end of the text node or after the text node. + // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. + const firstRange = domSelection.getRangeAt( 0 ); + + if ( firstRange.startContainer === domB.childNodes[ 0 ] ) { + expect( firstRange.startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 ); + } else { + expect( firstRange.startContainer ).to.equal( domB ); + expect( firstRange.startOffset ).to.equal( 1 ); + } + + expect( firstRange.collapsed ).to.be.true; } ); it( 'should handle typing in empty attribute as a text change, render if needed', () => { From 50944ef5d9c7d8b6b564c2316f3cff2328d6ce41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 14 Nov 2017 14:27:59 +0100 Subject: [PATCH 020/724] Fixing focusobserver test to not use DOM events. --- tests/view/observer/focusobserver.js | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/tests/view/observer/focusobserver.js b/tests/view/observer/focusobserver.js index f02b4a810..f452a7533 100644 --- a/tests/view/observer/focusobserver.js +++ b/tests/view/observer/focusobserver.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -/* globals document, window */ +/* globals document */ import FocusObserver from '../../../src/view/observer/focusobserver'; import ViewDocument from '../../../src/view/document'; import ViewRange from '../../../src/view/range'; @@ -142,7 +142,7 @@ describe( 'FocusObserver', () => { } ); describe( 'integration test', () => { - let viewDocument, domRoot, observer, domSelection; + let viewDocument, domRoot, observer; beforeEach( () => { domRoot = document.createElement( 'div' ); @@ -152,16 +152,14 @@ describe( 'FocusObserver', () => { viewDocument.createRoot( domRoot ); observer = viewDocument.getObserver( FocusObserver ); - domSelection = window.getSelection(); } ); - it( 'should render document after selectionChange event', done => { + it( 'should always render document after selectionChange event', done => { const selectionChangeSpy = sinon.spy(); const renderSpy = sinon.spy(); setData( viewDocument, '
foo bar
' ); viewDocument.render(); - const domEditable = domRoot.childNodes[ 0 ]; viewDocument.on( 'selectionChange', selectionChangeSpy ); viewDocument.on( 'render', renderSpy, { priority: 'low' } ); @@ -171,8 +169,10 @@ describe( 'FocusObserver', () => { done(); }, { priority: 'low' } ); - domEditable.focus(); - domSelection.collapse( domEditable, 0 ); + // Mock selectionchange event after focus event. Render called by focus observer should be fired after + // async selection change. + viewDocument.fire( 'focus' ); + viewDocument.fire( 'selectionChange' ); } ); it( 'should render without selectionChange event', done => { From 0500b4868af31c60468bbeb9cf4ae2890e60ebda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 14 Nov 2017 16:20:16 +0100 Subject: [PATCH 021/724] Fixed tests failing on Safari browser. --- tests/view/observer/selectionobserver.js | 17 ++++++- tests/view/renderer.js | 61 ++++++++++++++++++------ 2 files changed, 61 insertions(+), 17 deletions(-) diff --git a/tests/view/observer/selectionobserver.js b/tests/view/observer/selectionobserver.js index 0ca38c8fb..2fba632de 100644 --- a/tests/view/observer/selectionobserver.js +++ b/tests/view/observer/selectionobserver.js @@ -303,6 +303,9 @@ describe( 'SelectionObserver', () => { it( 'should re-render view if selections are similar if DOM selection is in incorrect place', done => { const sel = domDocument.getSelection(); + const domParagraph = domMain.childNodes[ 0 ]; + const domText = domParagraph.childNodes[ 0 ]; + const domUI = domParagraph.childNodes[ 1 ]; // Add rendering on selectionChange event to check this feature. viewDocument.on( 'selectionChange', () => { @@ -332,12 +335,22 @@ describe( 'SelectionObserver', () => { // 3. Now, collapse selection in similar position, but in UI element. // Current and new selection position are similar in view (but not equal!). // Also add a spy to `viewDocument#render` to see if view will be re-rendered. - sel.collapse( domMain.childNodes[ 0 ].childNodes[ 1 ], 0 ); + sel.collapse( domUI, 0 ); sinon.spy( viewDocument, 'render' ); + + // Some browsers like Safari won't allow to put selection inside empty ui element. + // In that situation selection should stay in correct place. + if ( sel.anchorNode !== domUI ) { + expect( sel.anchorNode ).to.equal( domText ); + expect( sel.anchorOffset ).to.equal( 3 ); + expect( sel.isCollapsed ).to.be.true; + + done(); + } }, { priority: 'lowest' } ); // 1. Collapse in a text node, before ui element, and wait for async selectionchange to fire selection change handling. - sel.collapse( domMain.childNodes[ 0 ].childNodes[ 0 ], 3 ); + sel.collapse( domText, 3 ); } ); function changeDomSelection() { diff --git a/tests/view/renderer.js b/tests/view/renderer.js index 92a174789..3745d0d9b 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -1181,16 +1181,14 @@ describe( 'Renderer', () => { } ); it( 'should not change selection if there is no editable with selection', () => { - const domDiv = createElement( document, 'div', null, 'not editable' ); + const domDiv = createElement( document, 'div', { contenteditable: true }, 'not editable' ); document.body.appendChild( domDiv ); + domDiv.focus(); const domSelection = document.getSelection(); domSelection.removeAllRanges(); - const domRange = document.createRange(); - domRange.setStart( domDiv, 0 ); - domRange.collapse( true ); - domSelection.addRange( domRange ); + domSelection.collapse( domDiv, 0 ); selectionEditable = null; @@ -1202,9 +1200,21 @@ describe( 'Renderer', () => { renderer.render(); expect( domSelection.rangeCount ).to.equal( 1 ); - expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv ); - expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 ); - expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true ); + + // Depending on the browser selection may end up before the text node or at the beginning of it. + // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. + const domRange = domSelection.getRangeAt( 0 ); + + if ( domRange.startContainer == domDiv ) { + expect( domRange.startContainer ).to.equal( domDiv ); + } else { + expect( domRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] ); + } + + expect( domRange.startOffset ).to.equal( 0 ); + expect( domRange.collapsed ).to.be.true; + + domDiv.remove(); } ); it( 'should not change selection if there is no focus', () => { @@ -1229,9 +1239,21 @@ describe( 'Renderer', () => { renderer.render(); expect( domSelection.rangeCount ).to.equal( 1 ); - expect( domSelection.getRangeAt( 0 ).startContainer ).to.equal( domDiv ); - expect( domSelection.getRangeAt( 0 ).startOffset ).to.equal( 0 ); - expect( domSelection.getRangeAt( 0 ).collapsed ).to.equal( true ); + + // Depending on the browser selection may end up before the text node or at the beginning of it. + // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. + const domSelectionRange = domSelection.getRangeAt( 0 ); + + if ( domSelectionRange.startContainer == domDiv ) { + expect( domSelectionRange.startContainer ).to.equal( domDiv ); + } else { + expect( domSelectionRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] ); + } + + expect( domSelectionRange.startOffset ).to.equal( 0 ); + expect( domSelectionRange.collapsed ).to.be.true; + + domDiv.remove(); } ); it( 'should not add inline filler after text node', () => { @@ -1672,10 +1694,19 @@ describe( 'Renderer', () => { renderer.render(); // Expect that after calling `renderer.render()` the DOM selection was re-rendered (and set at correct position). - expect( domSelection.anchorNode ).to.equal( domP ); - expect( domSelection.anchorOffset ).to.equal( 1 ); - expect( domSelection.focusNode ).to.equal( domP ); - expect( domSelection.focusOffset ).to.equal( 1 ); + + // Depending on the browser selection may end up at the end of the text node or after the text node. + // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. + if ( domSelection.anchorNode == domP ) { + expect( domSelection.anchorNode ).to.equal( domP ); + expect( domSelection.anchorOffset ).to.equal( 1 ); + } else { + const textNode = domP.childNodes[ 0 ]; + expect( domSelection.anchorNode ).to.equal( textNode ); + expect( domSelection.anchorOffset ).to.equal( 3 ); + } + + expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true; } ); it( 'should not render non-collapsed selection it is similar (element start)', () => { From df3f8a712eaca91341fc853126e0166ae2c45d34 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Tue, 7 Nov 2017 11:38:39 +0100 Subject: [PATCH 022/724] "devUtils#stringify" - classes and styles will be sorted. --- src/dev-utils/view.js | 17 ++++++++++- .../model-selection-to-view-converters.js | 28 +++++++++---------- tests/dev-utils/view.js | 18 ++++++++++++ tests/view/writer/unwrap.js | 12 ++++---- tests/view/writer/wrap.js | 24 ++++++++-------- 5 files changed, 66 insertions(+), 33 deletions(-) diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index fc6cacc3f..052526d6e 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -827,7 +827,22 @@ class ViewStringify { const keys = [ ...element.getAttributeKeys() ].sort(); for ( const attribute of keys ) { - attributes.push( `${ attribute }="${ element.getAttribute( attribute ) }"` ); + let attributeValue; + + if ( attribute === 'class' ) { + attributeValue = [ ...element.getClassNames() ] + .sort() + .join( ' ' ); + } else if ( attribute === 'style' ) { + attributeValue = [ ...element.getStyleNames() ] + .sort() + .map( style => `${ style.trim() }:${ element.getStyle( style.trim() ) }` ) + .join( ';' ); + } else { + attributeValue = element.getAttribute( attribute ); + } + + attributes.push( `${ attribute }="${ attributeValue }"` ); } return attributes.join( ' ' ); diff --git a/tests/conversion/model-selection-to-view-converters.js b/tests/conversion/model-selection-to-view-converters.js index 1cda35120..87033c9f4 100644 --- a/tests/conversion/model-selection-to-view-converters.js +++ b/tests/conversion/model-selection-to-view-converters.js @@ -528,9 +528,9 @@ describe( 'model-selection-to-view-converters', () => { beforeEach( () => { function themeElementCreator( themeValue ) { if ( themeValue == 'important' ) { - return new ViewAttributeElement( 'strong', { style: 'text-transform:uppercase;' } ); + return new ViewAttributeElement( 'strong', { style: 'text-transform:uppercase' } ); } else if ( themeValue == 'gold' ) { - return new ViewAttributeElement( 'span', { style: 'color:yellow;' } ); + return new ViewAttributeElement( 'span', { style: 'color:yellow' } ); } } @@ -545,7 +545,7 @@ describe( 'model-selection-to-view-converters', () => { test( [ 1, 5 ], 'fo<$text theme="gold">obar', - 'f{ooba}r' + 'f{ooba}r' ); } ); @@ -553,7 +553,7 @@ describe( 'model-selection-to-view-converters', () => { test( [ 2, 4 ], 'f<$text theme="gold">oobar', - 'fo{ob}ar' + 'fo{ob}ar' ); } ); @@ -561,7 +561,7 @@ describe( 'model-selection-to-view-converters', () => { test( [ 2, 4 ], 'fo<$text theme="important">obar', - 'fo{ob}ar' + 'fo{ob}ar' ); } ); @@ -569,7 +569,7 @@ describe( 'model-selection-to-view-converters', () => { test( [ 3, 5 ], 'fo<$text theme="important">obar', - 'foo{ba}r' + 'foo{ba}r' ); } ); } ); @@ -579,7 +579,7 @@ describe( 'model-selection-to-view-converters', () => { test( [ 3, 3 ], 'f<$text theme="gold">oobar', - 'foo{}bar' + 'foo{}bar' ); } ); @@ -587,7 +587,7 @@ describe( 'model-selection-to-view-converters', () => { test( [ 1, 1 ], 'foobar', - 'f[]oobar', + 'f[]oobar', { theme: 'important' } ); } ); @@ -596,9 +596,9 @@ describe( 'model-selection-to-view-converters', () => { test( [ 3, 3 ], 'f<$text theme="gold">oobar', - 'foo' + - '[]' + - 'bar', + 'foo' + + '[]' + + 'bar', { italic: true } ); } ); @@ -611,9 +611,9 @@ describe( 'model-selection-to-view-converters', () => { test( [ 3, 3 ], 'f<$text theme="gold">oobar', - 'foo' + - '[]' + - 'bar', + 'foo' + + '[]' + + 'bar', { theme: 'important' } ); } ); diff --git a/tests/dev-utils/view.js b/tests/dev-utils/view.js index 645b1d370..28bdaa0df 100644 --- a/tests/dev-utils/view.js +++ b/tests/dev-utils/view.js @@ -355,6 +355,24 @@ describe( 'view test utils', () => { expect( stringify( p, null, { showType: true } ) ) .to.equal( '' ); } ); + + it( 'should sort classes in specified element', () => { + const text = new Text( 'foobar' ); + const b = new Element( 'b', { + class: 'zz xx aa' + }, text ); + + expect( stringify( b ) ).to.equal( 'foobar' ); + } ); + + it( 'should sort styles in specified element', () => { + const text = new Text( 'foobar' ); + const i = new Element( 'i', { + style: 'text-decoration: underline; font-weight: bold' + }, text ); + + expect( stringify( i ) ).to.equal( 'foobar' ); + } ); } ); describe( 'parse', () => { diff --git a/tests/view/writer/unwrap.js b/tests/view/writer/unwrap.js index 217c526a5..07a2257e0 100644 --- a/tests/view/writer/unwrap.js +++ b/tests/view/writer/unwrap.js @@ -259,7 +259,7 @@ describe( 'writer', () => { it( 'should unwrap single element by removing matching classes', () => { test( - '[test]', + '[test]', '', '[test]' ); @@ -267,9 +267,9 @@ describe( 'writer', () => { it( 'should not unwrap single element when classes are different', () => { test( - '[test]', + '[test]', '', - '[test]' + '[test]' ); } ); @@ -279,18 +279,18 @@ describe( 'writer', () => { '[test]' + '', '', - '[test]' + '[test]' ); } ); it( 'should not unwrap single element when styles are different', () => { test( '' + - '[test]' + + '[test]' + '', '', '' + - '[test]' + + '[test]' + '' ); } ); diff --git a/tests/view/writer/wrap.js b/tests/view/writer/wrap.js index 656e7fede..39f92916d 100644 --- a/tests/view/writer/wrap.js +++ b/tests/view/writer/wrap.js @@ -227,26 +227,26 @@ describe( 'writer', () => { test( '[]', '', - '[]' + '[]' ); } ); it( 'should wrap single element by merging styles', () => { test( - '[]', - '', - '[]' + '[]', + '', + '[]' ); } ); it( 'should not merge styles when they differ', () => { test( - '[]', - '', + '[]', + '', '' + '[' + - '' + - '' + + '' + + '' + '' + ']' + '' @@ -255,12 +255,12 @@ describe( 'writer', () => { it( 'should not merge single elements when they have different priority', () => { test( - '[]', - '', + '[]', + '', '' + '[' + - '' + - '' + + '' + + '' + '' + ']' ); From 40b66c53620419809ed9af3a6e98af5f4409a8f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 16 Nov 2017 07:10:02 +0100 Subject: [PATCH 023/724] Docs: Fixed invalid error name. --- src/model/operation/attributeoperation.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index f08f46b94..88ab99ad3 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -116,7 +116,7 @@ export default class AttributeOperation extends Operation { /** * Changed node has different attribute value than operation's old attribute value. * - * @error operation-attribute-wrong-old-value + * @error attribute-operation-wrong-old-value * @param {module:engine/model/item~Item} item * @param {String} key * @param {*} value From 2924d529657241d926804aff9306f8a01e4ef0af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 16 Nov 2017 07:30:46 +0100 Subject: [PATCH 024/724] Docs: Fixed invalid link to TextProxy docs. --- src/model/item.jsdoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/item.jsdoc b/src/model/item.jsdoc index 63d058116..ce800ca30 100644 --- a/src/model/item.jsdoc +++ b/src/model/item.jsdoc @@ -8,7 +8,7 @@ */ /** - * Item is a {@link module:engine/model/node~Node Node} or {module:engine/model/textproxy~TextProxy TextProxy}. + * Item is a {@link module:engine/model/node~Node Node} or {@link module:engine/model/textproxy~TextProxy TextProxy}. * * @typedef {module:engine/model/node~Node|module:engine/model/textproxy~TextProxy} module:engine/model/item~Item */ From bd4f496ad48c631e8c49dbe4f1490f2738f41e26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 16 Nov 2017 16:52:53 +0100 Subject: [PATCH 025/724] Fixed tests failing on Safari connected to jumping over UIElements. --- tests/view/document/jumpoveruielement.js | 334 +++++++++++++++++++---- 1 file changed, 280 insertions(+), 54 deletions(-) diff --git a/tests/view/document/jumpoveruielement.js b/tests/view/document/jumpoveruielement.js index 527d790ea..870b36452 100644 --- a/tests/view/document/jumpoveruielement.js +++ b/tests/view/document/jumpoveruielement.js @@ -6,12 +6,27 @@ /* globals document */ import ViewDocument from '../../../src/view/document'; +import UIElement from '../../../src/view/uielement'; +import ViewContainerElement from '../../../src/view/containerelement'; +import ViewAttribtueElement from '../../../src/view/attributeelement'; +import ViewText from '../../../src/view/text'; +import ViewRange from '../../../src/view/range'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; import { setData as setViewData } from '../../../src/dev-utils/view'; +import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; describe( 'Document', () => { - let viewDocument, domRoot, domSelection; + let viewDocument, domRoot, domSelection, viewRoot, foo, bar, ui, ui2; + + class MyUIElement extends UIElement { + render( domDocument ) { + const element = super.render( domDocument ); + element.innerText = this.contents; + + return element; + } + } beforeEach( () => { domRoot = createElement( document, 'div', { @@ -20,12 +35,20 @@ describe( 'Document', () => { document.body.appendChild( domRoot ); viewDocument = new ViewDocument(); - viewDocument.createRoot( domRoot ); + viewRoot = viewDocument.createRoot( domRoot ); domSelection = document.getSelection(); domSelection.removeAllRanges(); viewDocument.isFocused = true; + + foo = new ViewText( 'foo' ); + bar = new ViewText( 'bar' ); + ui = new MyUIElement( 'span' ); + ui.contents = 'xxx'; + + ui2 = new MyUIElement( 'span' ); + ui2.contents = 'yyy'; } ); afterEach( () => { @@ -34,8 +57,7 @@ describe( 'Document', () => { domRoot.parentElement.removeChild( domRoot ); } ); - function prepare( view, options ) { - setViewData( viewDocument, view ); + function renderAndFireKeydownEvent( options ) { viewDocument.render(); const eventData = Object.assign( { keyCode: keyCodes.arrowright, domTarget: viewDocument.domRoots.get( 'main' ) }, options ); @@ -61,130 +83,334 @@ describe( 'Document', () => { describe( 'jump over ui element handler', () => { describe( 'collapsed selection', () => { it( 'do nothing when another key is pressed', () => { - prepare( 'foo{}bar', { keyCode: keyCodes.arrowleft } ); - check( 'bar', 0 ); + // fooxxx{}bar + const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( bar, 0, bar, 0 ) ] ); + + renderAndFireKeydownEvent( { keyCode: keyCodes.arrowleft } ); + + testUtils.checkAssertions( + () => check( 'bar', 0 ), + // Safari renders selection at the end of the text node. + () => check( 'xxx', 3 ) + ); } ); it( 'jump over ui element when right arrow is pressed before ui element - directly before ui element', () => { - prepare( 'foo[]bar' ); - check( 'P', 2 ); + // foo[]xxxbar + const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( p, 1, p, 1 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxx[]bar

+ () => check( 'P', 2 ), + // Safari renders selection at the end of the text node. + //

fooxxx{}bar

+ () => check( 'xxx', 3 ) + ); } ); it( 'jump over ui element when right arrow is pressed before ui element - not directly before ui element', () => { - prepare( 'foo{}bar' ); - check( 'P', 2 ); + // foo{}xxxbar + const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxx[]bar

+ () => check( 'P', 2 ), + // Safari renders selection at the end of the text node. + //

fooxxx{}bar

+ () => check( 'xxx', 3 ) + ); } ); it( 'jump over multiple ui elements when right arrow is pressed before ui element', () => { - prepare( 'foo{}bar' ); - check( 'P', 3 ); + // foo{}xxxyyybar' + const p = new ViewContainerElement( 'p', null, [ foo, ui, ui2, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxxyyy[]bar

+ () => check( 'P', 3 ), + // Safari renders selection at the end of the text node. + //

fooxxxyyy{}bar

+ () => check( 'yyy', 3 ) + ); } ); it( 'jump over ui elements at the end of container element', () => { - prepare( 'foo{}' ); - check( 'P', 3 ); + // foo{}xxxyyy + const p = new ViewContainerElement( 'p', null, [ foo, ui, ui2 ] ); + const div = new ViewContainerElement( 'div' ); + viewRoot.appendChildren( p ); + viewRoot.appendChildren( div ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxxyyy[]

+ () => check( 'P', 3 ), + // Safari renders selection at the end of the text node. + //

fooxxxyyy{}

+ () => check( 'yyy', 3 ) + ); } ); it( 'jump over ui element if selection is in attribute element - case 1', () => { - prepare( 'foo{}bar' ); - check( 'P', 2 ); + // foo{}xxxbar + const b = new ViewAttribtueElement( 'b', null, foo ); + const p = new ViewContainerElement( 'p', null, [ b, ui, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxx[]bar

+ () => check( 'P', 2 ), + // Safari renders selection at the end of the text node. + //

fooxxx{}bar

+ () => check( 'xxx', 3 ) + ); } ); it( 'jump over ui element if selection is in attribute element - case 2', () => { - prepare( 'foo{}bar' ); - check( 'P', 2 ); + // foo[]xxxbar + const b = new ViewAttribtueElement( 'b', null, foo ); + const p = new ViewContainerElement( 'p', null, [ b, ui, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( b, 1, b, 1 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxx[]bar

+ () => check( 'P', 2 ), + // Safari renders selection at the end of the text node. + //

fooxxx{}bar

+ () => check( 'xxx', 3 ) + ); } ); it( 'jump over ui element if selection is in multiple attribute elements', () => { - prepare( 'foo{}bar' ); - check( 'P', 2 ); + // + // + // foo{} + // + // + // xxx + // + // bar + // + const b = new ViewAttribtueElement( 'b', null, foo ); + const i = new ViewAttribtueElement( 'i', null, b ); + const p = new ViewContainerElement( 'p', null, [ i, ui, bar ] ); + + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxx[]bar

+ () => check( 'P', 2 ), + // Safari renders selection at the end of the text node. + //

fooxxx{}bar

+ () => check( 'xxx', 3 ) + ); } ); it( 'jump over empty attribute elements and ui elements', () => { - prepare( - '' + - 'foo{}bar' + - '' + // ' + + // foo{} + // + // xxx + // yyy + // + // bar + // + const b1 = new ViewAttribtueElement( 'b' ); + const b2 = new ViewAttribtueElement( 'b' ); + const p = new ViewContainerElement( 'p', null, [ foo, b1, ui, ui2, b2, bar ] ); + + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent(); + + testUtils.checkAssertions( + //

fooxxxyyy[]bar

+ () => check( 'P', 5 ), + // Safari renders selection at the end of the text node. + //

fooxxxyyy{}bar

+ () => check( 'yyy', 3 ) ); - - check( 'P', 5 ); } ); it( 'jump over empty attribute elements and ui elements if shift key is pressed', () => { - prepare( - '' + - 'foo{}bar' + - '', - { shiftKey: true } + // + // foo{} + // + // xxx + // yyy + // + // bar + // + + const b1 = new ViewAttribtueElement( 'b' ); + const b2 = new ViewAttribtueElement( 'b' ); + const p = new ViewContainerElement( 'p', null, [ foo, b1, ui, ui2, b2, bar ] ); + + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); + + renderAndFireKeydownEvent( { shiftKey: true } ); + + testUtils.checkAssertions( + //

fooxxxyyy[]bar

+ () => check( 'P', 5 ), + // Safari renders selection at the end of the text node. + //

fooxxxyyy{}bar

+ () => check( 'yyy', 3 ) ); - - check( 'P', 5 ); } ); it( 'do nothing if selection is not directly before ui element', () => { - prepare( 'fo{}obar' ); + setViewData( viewDocument, 'fo{}obar' ); + renderAndFireKeydownEvent(); + check( 'foo', 2 ); } ); it( 'do nothing if selection is in attribute element but not before ui element', () => { - prepare( 'foo{}bar' ); + setViewData( viewDocument, 'foo{}bar' ); + renderAndFireKeydownEvent(); + check( 'foo', 3 ); } ); it( 'do nothing if selection is before non-empty attribute element', () => { - prepare( 'fo{}obar' ); + setViewData( viewDocument, 'fo{}obar' ); + renderAndFireKeydownEvent(); + check( 'fo', 2 ); } ); it( 'do nothing if selection is before container element - case 1', () => { - prepare( 'foo{}bar' ); + setViewData( viewDocument, 'foo{}bar' ); + renderAndFireKeydownEvent(); + check( 'foo', 3 ); } ); it( 'do nothing if selection is before container element - case 2', () => { - prepare( 'foo{}' ); + setViewData( viewDocument, 'foo{}' ); + renderAndFireKeydownEvent(); + check( 'foo', 3 ); } ); it( 'do nothing if selection is at the end of last container element', () => { - prepare( 'foo{}' ); + setViewData( viewDocument, 'foo{}' ); + renderAndFireKeydownEvent(); + check( 'foo', 3 ); } ); } ); describe( 'non-collapsed selection', () => { it( 'should do nothing', () => { - prepare( 'f{oo}bar' ); + setViewData( viewDocument, 'f{oo}bar' ); + renderAndFireKeydownEvent(); + check( 'foo', 1, 'foo', 3 ); } ); it( 'should do nothing if selection is not before ui element - shift key pressed', () => { - prepare( 'f{o}obar', { shiftKey: true } ); + setViewData( viewDocument, 'f{o}obar' ); + renderAndFireKeydownEvent( { shiftKey: true } ); + check( 'foo', 1, 'foo', 2 ); } ); it( 'jump over ui element if shift key is pressed', () => { - prepare( 'fo{o}bar', { shiftKey: true } ); - check( 'foo', 2, 'P', 2 ); + // fo{o}xxxbar + const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); + + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 2, foo, 3 ) ] ); + + renderAndFireKeydownEvent( { shiftKey: true } ); + + testUtils.checkAssertions( + //

fo{oxxx]bar

+ () => check( 'foo', 2, 'P', 2 ), + // Safari renders selection at the end of the previous text node. + //

fo{oxxx}bar

+ () => check( 'foo', 2, 'xxx', 3 ) + ); } ); it( 'jump over ui element if selection is in multiple attribute elements', () => { - prepare( - 'fo{o}bar', - { shiftKey: true } + // + // + // fo{o} + // + // xxx + // bar + // + const b = new ViewAttribtueElement( 'b', null, foo ); + const i = new ViewAttribtueElement( 'i', null, b ); + const p = new ViewContainerElement( 'p', null, [ i, ui, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 2, foo, 3 ) ] ); + + renderAndFireKeydownEvent( { shiftKey: true } ); + + testUtils.checkAssertions( + //

fo{oxxx]bar

+ () => check( 'foo', 2, 'P', 2 ), + // Safari renders selection at the end of the previous text node. + //

fo{oxxx}bar

+ () => check( 'foo', 2, 'xxx', 3 ) ); - check( 'foo', 2, 'P', 2 ); } ); it( 'jump over empty attribute elements and ui elements if shift key is pressed', () => { - prepare( - '' + - 'fo{o}bar' + - '', - { shiftKey: true } + // + // fo{o} + // + // xxx + // yyy + // + // bar + // + const b1 = new ViewAttribtueElement( 'b' ); + const b2 = new ViewAttribtueElement( 'b' ); + const p = new ViewContainerElement( 'p', null, [ foo, b1, ui, ui2, b2, bar ] ); + viewRoot.appendChildren( p ); + viewDocument.selection.setRanges( [ ViewRange.createFromParentsAndOffsets( foo, 2, foo, 3 ) ] ); + + renderAndFireKeydownEvent( { shiftKey: true } ); + + testUtils.checkAssertions( + //

fo{oxxxyyy]bar

+ () => check( 'foo', 2, 'P', 5 ), + // Safari renders selection at the end of the previous text node. + //

fo{oxxxyyy}bar

+ () => check( 'foo', 2, 'yyy', 3 ) ); - - check( 'foo', 2, 'P', 5 ); } ); } ); From 17ce3c3a87432e16910b9f58e9db011342aaeaf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 16 Nov 2017 17:05:32 +0100 Subject: [PATCH 026/724] Fixed tests failing on safari in DomConverter. --- tests/view/domconverter/domconverter.js | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/tests/view/domconverter/domconverter.js b/tests/view/domconverter/domconverter.js index 09b716f71..d4dfed213 100644 --- a/tests/view/domconverter/domconverter.js +++ b/tests/view/domconverter/domconverter.js @@ -279,22 +279,27 @@ describe( 'DomConverter', () => { } ); it( 'if anchor or focus is directly inside dom element that represents view ui element', () => { + // Set text indside ui element to put selection there. + domUiSpan.innerText = 'xxx'; // Tests forward and backward selection. - //

INLINE_FILLER{foo]

. - const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domUiSpan, 0 ); + //

INLINE_FILLER{fooxxx]

. + const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domUiSpan, 1 ); + expect( converter.isDomSelectionCorrect( sel1 ) ).to.be.false; - const sel2 = domSelection( domUiSpan, 0, domFillerTextNode, INLINE_FILLER_LENGTH ); + const sel2 = domSelection( domUiSpan, 1, domFillerTextNode, INLINE_FILLER_LENGTH ); expect( converter.isDomSelectionCorrect( sel2 ) ).to.be.false; } ); it( 'if anchor or focus is inside deep ui element structure (not directly in ui element)', () => { + // Set text indside ui element to put selection there. + domUiDeepSpan.innerText = 'xxx'; // Tests forward and backward selection. - //

INLINE_FILLER{foo]

. - const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domUiDeepSpan, 0 ); + //

INLINE_FILLER{fooxxx]

. + const sel1 = domSelection( domFillerTextNode, INLINE_FILLER_LENGTH, domUiDeepSpan, 1 ); expect( converter.isDomSelectionCorrect( sel1 ) ).to.be.false; - const sel2 = domSelection( domUiDeepSpan, 0, domFillerTextNode, INLINE_FILLER_LENGTH ); + const sel2 = domSelection( domUiDeepSpan, 1, domFillerTextNode, INLINE_FILLER_LENGTH ); expect( converter.isDomSelectionCorrect( sel2 ) ).to.be.false; } ); } ); From 1aaa955f0d1c5724e91ea6094c29c6e7c404cd5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 17 Nov 2017 08:33:27 +0100 Subject: [PATCH 027/724] Code style: Name variables accordingly in operation/transform.js. --- src/model/operation/transform.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/model/operation/transform.js b/src/model/operation/transform.js index 1cbe1c7ee..3f602a417 100644 --- a/src/model/operation/transform.js +++ b/src/model/operation/transform.js @@ -179,7 +179,7 @@ const ot = { // Take the start and the end of the range and transform them by deletion of moved nodes. // Note that if rangeB was inside AttributeOperation range, only difference.end will be transformed. // This nicely covers the joining simplification we did in the previous step. - const range = new Range( + const differenceTransformed = new Range( difference.start._getTransformedByDeletion( b.sourcePosition, b.howMany ), difference.end._getTransformedByDeletion( b.sourcePosition, b.howMany ) ); @@ -189,19 +189,19 @@ const ot = { // previously transformed target position. // Note that we do not use Position._getTransformedByMove on range boundaries because we need to // transform by insertion a range as a whole, since newTargetPosition might be inside that range. - ranges = range._getTransformedByInsertion( b.getMovedRangeStart(), b.howMany, true, false ).reverse(); + ranges = differenceTransformed._getTransformedByInsertion( b.getMovedRangeStart(), b.howMany, true, false ).reverse(); } if ( common !== null ) { // Here we do not need to worry that newTargetPosition is inside moved range, because that // would mean that the MoveOperation targets into itself, and that is incorrect operation. // Instead, we calculate the new position of that part of original range. - const range = new Range( + const commonTransformed = new Range( common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) ); - ranges.push( range ); + ranges.push( commonTransformed ); } // Map transformed range(s) to operations and return them. From 2ad039bc1228c90cd7f5f2206247df668ba9eb03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 17 Nov 2017 08:40:50 +0100 Subject: [PATCH 028/724] Other: Make transformation helper method always return copy of Position. --- src/model/position.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/model/position.js b/src/model/position.js index f7e8214bf..51e1b4116 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -515,7 +515,7 @@ export default class Position { _getTransformedByDeletion( deletePosition, howMany ) { // This position can't be affected if deletion was in a different root. if ( this.root != deletePosition.root ) { - return this; + return Position.createFromPosition( this ); } const comparisonResult = compareArrays( deletePosition.getParentPath(), this.getParentPath() ); @@ -552,7 +552,7 @@ export default class Position { } } - return this; + return Position.createFromPosition( this ); } /** @@ -569,7 +569,7 @@ export default class Position { _getTransformedByInsertion( insertPosition, howMany, insertBefore ) { // This position can't be affected if insertion was in a different root. if ( this.root != insertPosition.root ) { - return this; + return Position.createFromPosition( this ); } if ( compareArrays( insertPosition.getParentPath(), this.getParentPath() ) == 'same' ) { @@ -594,7 +594,7 @@ export default class Position { } } - return this; + return Position.createFromPosition( this ); } /** From ed738389f91dcdec2f7f37b9cdddd4fb82eac34c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 17 Nov 2017 09:02:23 +0100 Subject: [PATCH 029/724] Code style: Don't use Symbols for protected properties in model's Position and Range. --- src/model/liveposition.js | 6 +++--- src/model/liverange.js | 6 +++--- src/model/position.js | 45 ++++++++++++++++----------------------- src/model/range.js | 45 +++++++++++++++------------------------ 4 files changed, 41 insertions(+), 61 deletions(-) diff --git a/src/model/liveposition.js b/src/model/liveposition.js index f9f2213d0..ab6cdb7c9 100644 --- a/src/model/liveposition.js +++ b/src/model/liveposition.js @@ -7,7 +7,7 @@ * @module engine/model/liveposition */ -import Position, { setPath, setRoot } from './position'; +import Position from './position'; import Range from './range'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; @@ -194,8 +194,8 @@ function transform( type, range, position ) { if ( !this.isEqual( transformed ) ) { const oldPosition = Position.createFromPosition( this ); - setPath( this, transformed.path ); - setRoot( this, transformed.root ); + this._path = transformed.path; + this._root = transformed.root; this.fire( 'change', oldPosition ); } diff --git a/src/model/liverange.js b/src/model/liverange.js index b2c714072..a9785c9b6 100644 --- a/src/model/liverange.js +++ b/src/model/liverange.js @@ -7,7 +7,7 @@ * @module engine/model/liverange */ -import Range, { setStart, setEnd } from './range'; +import Range from './range'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; @@ -178,8 +178,8 @@ function transform( changeType, deltaType, batch, targetRange, sourcePosition ) // If range boundaries have changed, fire `change:range` event. const oldRange = Range.createFromRange( this ); - setStart( this, updated.start ); - setEnd( this, updated.end ); + this._start = updated.start; + this._end = updated.end; this.fire( 'change:range', oldRange, { type: changeType, diff --git a/src/model/position.js b/src/model/position.js index 51e1b4116..ae2f83e2f 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -13,9 +13,6 @@ import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import Text from './text'; -const _path = Symbol( 'path' ); -const _root = Symbol( 'root' ); - /** * Represents a position in the model tree. * @@ -73,8 +70,22 @@ export default class Position { // Make path immutable Object.freeze( path ); - setRoot( this, root.root ); - setPath( this, path ); + /** + * Root of the position path. + * + * @protected + * @member {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} + * module:engine/model/position~Position#_root + */ + this._root = root.root; + + /** + * Position of the node in the tree. + * + * @protected + * @member {Array.} module:engine/model/position~Position#_path + */ + this._path = path; } /** @@ -107,7 +118,7 @@ export default class Position { * @member {Array.} module:engine/model/position~Position#path */ get path() { - return this[ _path ]; + return this._path; } /** @@ -118,7 +129,7 @@ export default class Position { * module:engine/model/position~Position#root */ get root() { - return this[ _root ]; + return this._root; } /** @@ -817,26 +828,6 @@ export default class Position { } } -/** - * Method used to expose root setter to child classes. - * @protected - * @param {module:engine/model/position~Position} position Position of which root should be modified. - * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} root Root of the position. - */ -export function setRoot( position, root ) { - position[ _root ] = root; -} - -/** - * Method used to expose path setter to child classes. - * @protected - * @param {module:engine/model/position~Position} position Position of which path should be modified. - * @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. - */ -export function setPath( position, path ) { - position[ _path ] = path; -} - // Helper for setting offset on give path array. // @private // @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. diff --git a/src/model/range.js b/src/model/range.js index 8d97af7d4..317c09c21 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -11,9 +11,6 @@ import Position from './position'; import TreeWalker from './treewalker'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -const _start = Symbol( 'start' ); -const _end = Symbol( 'end' ); - /** * Range class. Range is iterable. */ @@ -27,8 +24,21 @@ export default class Range { * @param {module:engine/model/position~Position} [end] End position. If not set, range will be collapsed at `start` position. */ constructor( start, end = null ) { - setStart( this, start ); - setEnd( this, end ? end : start ); + /** + * Start position. + * + * @protected + * @member {module:engine/model/position~Position} + */ + this._start = start; + + /** + * End position. + * + * @protected + * @member {module:engine/model/position~Position} + */ + this._end = end ? end : start; } /** @@ -54,7 +64,7 @@ export default class Range { * @member {module:engine/model/position~Position} */ get start() { - return this[ _start ]; + return this._start; } /** @@ -64,7 +74,7 @@ export default class Range { * @member {module:engine/model/position~Position} */ get end() { - return this[ _end ]; + return this._end; } /** @@ -867,24 +877,3 @@ export default class Range { return new this( Position.fromJSON( json.start, doc ), Position.fromJSON( json.end, doc ) ); } } - -/** - * Method used to expose start setter to child classes. - * @protected - * @param {module:engine/model/range~Range} range Range of which start position should be sent. - * @param {module:engine/model/position~Position} position Position to set as range start. - * See {@link module:engine/model/range~Range#start}. - */ -export function setStart( range, position ) { - range[ _start ] = position; -} - -/** - * Method used to expose end setter to child classes. - * @protected - * @param {module:engine/model/range~Range} range Range of which end position should be sent. - * @param {module:engine/model/position~Position} position Position to set as range end. See {@link module:engine/model/range~Range#end}. - */ -export function setEnd( range, position ) { - range[ _end ] = position; -} From 010cfc6cd45c86dbe3fbbba357d1886743ac9f0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 17 Nov 2017 09:15:23 +0100 Subject: [PATCH 030/724] Other: User positions rather then creating new range in loops in Range.createFromRanges(). --- src/model/range.js | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/model/range.js b/src/model/range.js index 317c09c21..8936706bb 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -839,13 +839,14 @@ export default class Range { // 4. At this moment we don't need the original range. // We are going to modify the result and we need to return a new instance of Range. // We have to create a copy of the reference range. - let result = new this( ref.start, ref.end ); + let start = ref.start; + let end = ref.end; // 5. Ranges should be checked and glued starting from the range that is closest to the reference range. // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex - 1; i >= 0; i++ ) { - if ( ranges[ i ].end.isEqual( result.start ) ) { - result = new this( ranges[ i ].start, result.end ); + if ( ranges[ i ].end.isEqual( start ) ) { + start = ranges[ i ].start; } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; @@ -855,15 +856,15 @@ export default class Range { // 6. Ranges should be checked and glued starting from the range that is closest to the reference range. // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex + 1; i < ranges.length; i++ ) { - if ( ranges[ i ].start.isEqual( result.end ) ) { - result = new this( result.start, ranges[ i ].end ); + if ( ranges[ i ].start.isEqual( end ) ) { + end = ranges[ i ].end; } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; } } - return result; + return new this( start, end ); } /** From f0760962d7ef5430153c7b7e416adf5c440d539d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 17 Nov 2017 09:20:24 +0100 Subject: [PATCH 031/724] Code style: Remove confusing position variable from TreeWalker methods. --- src/view/treewalker.js | 96 +++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 57 deletions(-) diff --git a/src/view/treewalker.js b/src/view/treewalker.js index 7979da760..a9e3dfcf8 100644 --- a/src/view/treewalker.js +++ b/src/view/treewalker.js @@ -187,17 +187,16 @@ export default class TreeWalker { * @returns {module:engine/view/treewalker~TreeWalkerValue} return.value Information about taken step. */ _next() { - let position = this.position; const previousPosition = this.position; - const parent = position.parent; + const parent = this.position.parent; // We are at the end of the root. - if ( parent.parent === null && position.offset === parent.childCount ) { + if ( parent.parent === null && this.position.offset === parent.childCount ) { return { done: true }; } // We reached the walker boundary. - if ( parent === this._boundaryEndParent && position.offset == this.boundaries.end.offset ) { + if ( parent === this._boundaryEndParent && this.position.offset == this.boundaries.end.offset ) { return { done: true }; } @@ -206,32 +205,29 @@ export default class TreeWalker { // Text is a specific parent because it contains string instead of child nodes. if ( parent instanceof Text ) { - if ( position.isAtEnd ) { + if ( this.position.isAtEnd ) { // Prevent returning "elementEnd" for Text node. Skip that value and return the next walker step. this.position = Position.createAfter( parent ); return this._next(); } - node = parent.data[ position.offset ]; + node = parent.data[ this.position.offset ]; } else { - node = parent.getChild( position.offset ); + node = parent.getChild( this.position.offset ); } if ( node instanceof Element ) { if ( !this.shallow ) { - position = new Position( node, 0 ); + this.position = new Position( node, 0 ); } else { - position = position.getShiftedBy( 1 ); + this.position = this.position.getShiftedBy( 1 ); } - this.position = position; - - return this._formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); + return this._formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); } else if ( node instanceof Text ) { if ( this.singleCharacters ) { - position = new Position( node, 0 ); - this.position = position; + this.position = new Position( node, 0 ); return this._next(); } else { @@ -242,15 +238,13 @@ export default class TreeWalker { if ( node == this._boundaryEndParent ) { charactersCount = this.boundaries.end.offset; item = new TextProxy( node, 0, charactersCount ); - position = Position.createAfter( item ); + this.position = Position.createAfter( item ); } else { // If not just keep moving forward. - position = position.getShiftedBy( 1 ); + this.position = this.position.getShiftedBy( 1 ); } - this.position = position; - - return this._formatReturnValue( 'text', item, previousPosition, position, charactersCount ); + return this._formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); } } else if ( typeof node == 'string' ) { let textLength; @@ -261,25 +255,22 @@ export default class TreeWalker { // Check if text stick out of walker range. const endOffset = parent === this._boundaryEndParent ? this.boundaries.end.offset : parent.data.length; - textLength = endOffset - position.offset; + textLength = endOffset - this.position.offset; } - const textProxy = new TextProxy( parent, position.offset, textLength ); - - position = position.getShiftedBy( textLength ); + const textProxy = new TextProxy( parent, this.position.offset, textLength ); - this.position = position; + this.position = this.position.getShiftedBy( textLength ); - return this._formatReturnValue( 'text', textProxy, previousPosition, position, textLength ); + return this._formatReturnValue( 'text', textProxy, previousPosition, this.position, textLength ); } else { // `node` is not set, we reached the end of current `parent`. - position = Position.createAfter( parent ); - this.position = position; + this.position = Position.createAfter( parent ); if ( this.ignoreElementEnd ) { return this._next(); } else { - return this._formatReturnValue( 'elementEnd', parent, previousPosition, position ); + return this._formatReturnValue( 'elementEnd', parent, previousPosition, this.position ); } } } @@ -293,17 +284,16 @@ export default class TreeWalker { * @returns {module:engine/view/treewalker~TreeWalkerValue} return.value Information about taken step. */ _previous() { - let position = this.position; const previousPosition = this.position; - const parent = position.parent; + const parent = this.position.parent; // We are at the beginning of the root. - if ( parent.parent === null && position.offset === 0 ) { + if ( parent.parent === null && this.position.offset === 0 ) { return { done: true }; } // We reached the walker boundary. - if ( parent == this._boundaryStartParent && position.offset == this.boundaries.start.offset ) { + if ( parent == this._boundaryStartParent && this.position.offset == this.boundaries.start.offset ) { return { done: true }; } @@ -312,38 +302,35 @@ export default class TreeWalker { // Text {@link module:engine/view/text~Text} element is a specific parent because contains string instead of child nodes. if ( parent instanceof Text ) { - if ( position.isAtStart ) { + if ( this.position.isAtStart ) { // Prevent returning "elementStart" for Text node. Skip that value and return the next walker step. this.position = Position.createBefore( parent ); return this._previous(); } - node = parent.data[ position.offset - 1 ]; + node = parent.data[ this.position.offset - 1 ]; } else { - node = parent.getChild( position.offset - 1 ); + node = parent.getChild( this.position.offset - 1 ); } if ( node instanceof Element ) { if ( !this.shallow ) { - position = new Position( node, node.childCount ); - this.position = position; + this.position = new Position( node, node.childCount ); if ( this.ignoreElementEnd ) { return this._previous(); } else { - return this._formatReturnValue( 'elementEnd', node, previousPosition, position ); + return this._formatReturnValue( 'elementEnd', node, previousPosition, this.position ); } } else { - position = position.getShiftedBy( -1 ); - this.position = position; + this.position = this.position.getShiftedBy( -1 ); - return this._formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); + return this._formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); } } else if ( node instanceof Text ) { if ( this.singleCharacters ) { - position = new Position( node, node.data.length ); - this.position = position; + this.position = new Position( node, node.data.length ); return this._previous(); } else { @@ -356,15 +343,13 @@ export default class TreeWalker { item = new TextProxy( node, offset, node.data.length - offset ); charactersCount = item.data.length; - position = Position.createBefore( item ); + this.position = Position.createBefore( item ); } else { // If not just keep moving backward. - position = position.getShiftedBy( -1 ); + this.position = this.position.getShiftedBy( -1 ); } - this.position = position; - - return this._formatReturnValue( 'text', item, previousPosition, position, charactersCount ); + return this._formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); } } else if ( typeof node == 'string' ) { let textLength; @@ -373,24 +358,21 @@ export default class TreeWalker { // Check if text stick out of walker range. const startOffset = parent === this._boundaryStartParent ? this.boundaries.start.offset : 0; - textLength = position.offset - startOffset; + textLength = this.position.offset - startOffset; } else { textLength = 1; } - position = position.getShiftedBy( -textLength ); - - const textProxy = new TextProxy( parent, position.offset, textLength ); + this.position = this.position.getShiftedBy( -textLength ); - this.position = position; + const textProxy = new TextProxy( parent, this.position.offset, textLength ); - return this._formatReturnValue( 'text', textProxy, previousPosition, position, textLength ); + return this._formatReturnValue( 'text', textProxy, previousPosition, this.position, textLength ); } else { // `node` is not set, we reached the beginning of current `parent`. - position = Position.createBefore( parent ); - this.position = position; + this.position = Position.createBefore( parent ); - return this._formatReturnValue( 'elementStart', parent, previousPosition, position, 1 ); + return this._formatReturnValue( 'elementStart', parent, previousPosition, this.position, 1 ); } } From ec08c189bc0ef1235d13abd349a924f7a8b9380c Mon Sep 17 00:00:00 2001 From: Aleksander Nowodzinski Date: Fri, 17 Nov 2017 11:23:42 +0100 Subject: [PATCH 032/724] Tests: Simplified CSS imports in nestededitable MT. --- tests/manual/nestededitable.css | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/tests/manual/nestededitable.css b/tests/manual/nestededitable.css index cccb279f1..a82fa555b 100644 --- a/tests/manual/nestededitable.css +++ b/tests/manual/nestededitable.css @@ -3,9 +3,8 @@ * For licensing, see LICENSE.md. */ -@import "@ckeditor/ckeditor5-theme-lark/theme/helpers/colors.css"; -@import "@ckeditor/ckeditor5-theme-lark/theme/helpers/states.css"; -@import "@ckeditor/ckeditor5-theme-lark/theme/helpers/shadow.css"; +@import "@ckeditor/ckeditor5-theme-lark/theme/mixins/_focus.css"; +@import "@ckeditor/ckeditor5-theme-lark/theme/mixins/_shadow.css"; figure { background-color: #f3f3f3; @@ -21,7 +20,3 @@ figure { } } } - - - - From 545b81be7e9a7f1ac9869cdc2b3c8320325c160e Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 17 Nov 2017 11:37:28 +0100 Subject: [PATCH 033/724] Resolved "TODO" in tests. Changed ifs to our new test util. --- tests/view/renderer.js | 45 ++++++++++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 17 deletions(-) diff --git a/tests/view/renderer.js b/tests/view/renderer.js index 3745d0d9b..fad7f2e28 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -1083,16 +1083,18 @@ describe( 'Renderer', () => { expect( domSelection.rangeCount ).to.equal( 1 ); // Depending on the browser selection may end up at the end of the text node or after the text node. - // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. const firstRange = domSelection.getRangeAt( 0 ); - if ( firstRange.startContainer === domB.childNodes[ 0 ] ) { + const assertSelectionAtEndOfTextNode = () => { expect( firstRange.startOffset ).to.equal( INLINE_FILLER_LENGTH + 1 ); - } else { + }; + + const assertSelectionInsideTextNode = () => { expect( firstRange.startContainer ).to.equal( domB ); expect( firstRange.startOffset ).to.equal( 1 ); - } + }; + testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode ); expect( firstRange.collapsed ).to.be.true; } ); @@ -1202,14 +1204,17 @@ describe( 'Renderer', () => { expect( domSelection.rangeCount ).to.equal( 1 ); // Depending on the browser selection may end up before the text node or at the beginning of it. - // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. const domRange = domSelection.getRangeAt( 0 ); - if ( domRange.startContainer == domDiv ) { + const assertSelectionAtEndOfTextNode = () => { expect( domRange.startContainer ).to.equal( domDiv ); - } else { + }; + + const assertSelectionInsideTextNode = () => { expect( domRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] ); - } + }; + + testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode ); expect( domRange.startOffset ).to.equal( 0 ); expect( domRange.collapsed ).to.be.true; @@ -1241,14 +1246,17 @@ describe( 'Renderer', () => { expect( domSelection.rangeCount ).to.equal( 1 ); // Depending on the browser selection may end up before the text node or at the beginning of it. - // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. const domSelectionRange = domSelection.getRangeAt( 0 ); - if ( domSelectionRange.startContainer == domDiv ) { + const assertSelectionAtEndOfTextNode = () => { expect( domSelectionRange.startContainer ).to.equal( domDiv ); - } else { + }; + + const assertSelectionInsideTextNode = () => { expect( domSelectionRange.startContainer ).to.equal( domDiv.childNodes[ 0 ] ); - } + }; + + testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode ); expect( domSelectionRange.startOffset ).to.equal( 0 ); expect( domSelectionRange.collapsed ).to.be.true; @@ -1694,17 +1702,20 @@ describe( 'Renderer', () => { renderer.render(); // Expect that after calling `renderer.render()` the DOM selection was re-rendered (and set at correct position). - // Depending on the browser selection may end up at the end of the text node or after the text node. - // TODO: Switch this code to the upcoming tool: https://github.com/ckeditor/ckeditor5-core/issues/107. - if ( domSelection.anchorNode == domP ) { + + const assertSelectionAtEndOfTextNode = () => { expect( domSelection.anchorNode ).to.equal( domP ); expect( domSelection.anchorOffset ).to.equal( 1 ); - } else { + }; + + const assertSelectionInsideTextNode = () => { const textNode = domP.childNodes[ 0 ]; expect( domSelection.anchorNode ).to.equal( textNode ); expect( domSelection.anchorOffset ).to.equal( 3 ); - } + }; + + testUtils.checkAssertions( assertSelectionAtEndOfTextNode, assertSelectionInsideTextNode ); expect( domSelection.getRangeAt( 0 ).collapsed ).to.be.true; } ); From 3c496a5cf778639302a713422dce36b2b4999f56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Fri, 17 Nov 2017 11:50:16 +0100 Subject: [PATCH 034/724] Other: Remove redundant check from getOffset in Position. --- src/model/position.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/position.js b/src/model/position.js index ae2f83e2f..9aa9f1672 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -832,7 +832,7 @@ export default class Position { // @private // @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. function getOffset( path ) { - return last( path ) || 0; + return last( path ); } // Helper for setting offset on give path array. From 7730795befd940bfe7d62942b8479d1dd45538bb Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Mon, 20 Nov 2017 11:13:19 +0100 Subject: [PATCH 035/724] Removed `String.trim()` called on `style`. --- src/dev-utils/view.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index 052526d6e..56b014c7d 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -836,7 +836,7 @@ class ViewStringify { } else if ( attribute === 'style' ) { attributeValue = [ ...element.getStyleNames() ] .sort() - .map( style => `${ style.trim() }:${ element.getStyle( style.trim() ) }` ) + .map( style => `${ style }:${ element.getStyle( style ) }` ) .join( ';' ); } else { attributeValue = element.getAttribute( attribute ); From 44553fe61e8f22f0eb76ecf55e585d7c04395cfc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Mon, 20 Nov 2017 15:39:20 +0100 Subject: [PATCH 036/724] Other: Remove range copying from selection getRanges(), getFirstRange() and getLastRange() methods. --- src/model/selection.js | 16 +++++++--------- src/view/selection.js | 16 +++++++--------- 2 files changed, 14 insertions(+), 18 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index d3fd43e84..07b30854e 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -174,18 +174,16 @@ export default class Selection { } /** - * Returns an iterator that iterates over copies of selection ranges. + * Returns an iterator that iterates over selection ranges. * * @returns {Iterator.} */ - * getRanges() { - for ( const range of this._ranges ) { - yield Range.createFromRange( range ); - } + getRanges() { + return this._ranges[ Symbol.iterator ](); } /** - * Returns a copy of the first range in the selection. + * Returns first range in the selection. * First range is the one which {@link module:engine/model/range~Range#start start} position * {@link module:engine/model/position~Position#isBefore is before} start position of all other ranges * (not to confuse with the first range added to the selection). @@ -203,11 +201,11 @@ export default class Selection { } } - return first ? Range.createFromRange( first ) : null; + return first; } /** - * Returns a copy of the last range in the selection. + * Returns last range in the selection. * Last range is the one which {@link module:engine/model/range~Range#end end} position * {@link module:engine/model/position~Position#isAfter is after} end position of all other ranges (not to confuse with the range most * recently added to the selection). @@ -225,7 +223,7 @@ export default class Selection { } } - return last ? Range.createFromRange( last ) : null; + return last; } /** diff --git a/src/view/selection.js b/src/view/selection.js index d48551259..41157f1db 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -220,18 +220,16 @@ export default class Selection { } /** - * Returns an iterator that contains copies of all ranges added to the selection. + * Returns an iterator that contains all ranges added to the selection. * * @returns {Iterator.} */ - * getRanges() { - for ( const range of this._ranges ) { - yield Range.createFromRange( range ); - } + getRanges() { + return this._ranges[ Symbol.iterator ](); } /** - * Returns copy of the first range in the selection. First range is the one which + * Returns first range in the selection. First range is the one which * {@link module:engine/view/range~Range#start start} position {@link module:engine/view/position~Position#isBefore is before} start * position of all other ranges (not to confuse with the first range added to the selection). * Returns `null` if no ranges are added to selection. @@ -247,11 +245,11 @@ export default class Selection { } } - return first ? Range.createFromRange( first ) : null; + return first; } /** - * Returns copy of the last range in the selection. Last range is the one which {@link module:engine/view/range~Range#end end} + * Returns last range in the selection. Last range is the one which {@link module:engine/view/range~Range#end end} * position {@link module:engine/view/position~Position#isAfter is after} end position of all other ranges (not to confuse * with the last range added to the selection). Returns `null` if no ranges are added to selection. * @@ -266,7 +264,7 @@ export default class Selection { } } - return last ? Range.createFromRange( last ) : null; + return last; } /** From a2db1b060c7ed4e59da4a5e61d9837f5e3c4fa86 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Fri, 24 Nov 2017 14:12:54 +0100 Subject: [PATCH 037/724] Changed: Minor fixes. --- src/dev-utils/view.js | 3 +-- src/model/position.js | 24 ++++------------- src/model/range.js | 8 ++---- src/model/selection.js | 4 +-- src/model/treewalker.js | 57 ++++++++++++++--------------------------- src/view/position.js | 11 +++----- src/view/range.js | 11 +++----- 7 files changed, 37 insertions(+), 81 deletions(-) diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index a0e160186..5694203b2 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -541,8 +541,7 @@ class RangeParser { throw new Error( `Parse error - end of range was found '${ item.bracket }' but range was not started before.` ); } - // When second start of range is found when one is already opened - selection does not allow intersecting - // ranges. + // When second start of range is found when one is already opened - selection does not allow intersecting ranges. if ( range && ( item.bracket == ELEMENT_RANGE_START_TOKEN || item.bracket == TEXT_RANGE_START_TOKEN ) ) { throw new Error( `Parse error - start of range was found '${ item.bracket }' but one range is already started.` ); } diff --git a/src/model/position.js b/src/model/position.js index 9aa9f1672..ede7c577b 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -139,7 +139,7 @@ export default class Position { * @type {Number} */ get offset() { - return getOffset( this.path ); + return last( this.path ); } /** @@ -365,8 +365,7 @@ export default class Position { */ getShiftedTo( offset ) { const path = this.path.slice(); - - setOffset( path, offset ); + path[ path.length - 1 ] = offset; return new Position( this.root, path ); } @@ -678,7 +677,9 @@ export default class Position { // Then we have to update the rest of the path. // Fix the offset because this position might be after `from` position and we have to reflect that. - setOffset( combinedPath, getOffset( combinedPath ) + this.path[ i ] - source.offset ); + const oldOffset = last( combinedPath ); + const newOffset = oldOffset + this.path[ i ] - source.offset; + combinedPath[ combinedPath.length - 1 ] = newOffset; // Then, add the rest of the path. // If this position is at the same level as `from` position nothing will get added. @@ -828,21 +829,6 @@ export default class Position { } } -// Helper for setting offset on give path array. -// @private -// @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. -function getOffset( path ) { - return last( path ); -} - -// Helper for setting offset on give path array. -// @private -// @param {Array.} path Position path. See {@link module:engine/model/position~Position#path}. -// @param {Number} newOffset Offset to set. -function setOffset( path, newOffset ) { - path[ path.length - 1 ] = newOffset; -} - /** * A flag indicating whether this position is `'before'` or `'after'` or `'same'` as given position. * If positions are in different roots `'different'` flag is returned. diff --git a/src/model/range.js b/src/model/range.js index 8936706bb..d5b376cfe 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -311,11 +311,7 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - const path = pos.getParentPath(); - path[ path.length - 1 ]++; - - pos = new Position( pos.root, path ); - + pos = Position.createAfter( posParent ); posParent = posParent.parent; } @@ -844,7 +840,7 @@ export default class Range { // 5. Ranges should be checked and glued starting from the range that is closest to the reference range. // Since ranges are sorted, start with the range with index that is closest to reference range index. - for ( let i = refIndex - 1; i >= 0; i++ ) { + for ( let i = refIndex - 1; i >= 0; i-- ) { if ( ranges[ i ].end.isEqual( start ) ) { start = ranges[ i ].start; } else { diff --git a/src/model/selection.js b/src/model/selection.js index 07b30854e..6060a3af0 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -236,9 +236,9 @@ export default class Selection { * @returns {module:engine/model/position~Position|null} */ getFirstPosition() { - const first = this.getFirstRange(); + const firstRange = this.getFirstRange(); - return first ? first.start : null; + return firstRange ? firstRange.start : null; } /** diff --git a/src/model/treewalker.js b/src/model/treewalker.js index e1bb83d52..fe9415251 100644 --- a/src/model/treewalker.js +++ b/src/model/treewalker.js @@ -204,8 +204,6 @@ export default class TreeWalker { */ _next() { const previousPosition = this.position; - - let position = this.position; const parent = this._visitedParent; // We are at the end of the root. @@ -223,17 +221,15 @@ export default class TreeWalker { if ( node instanceof Element ) { if ( !this.shallow ) { // Manual operations on path internals for optimization purposes. Here and in the rest of the method. - const path = position.path.slice(); + const path = this.position.path.slice(); path.push( 0 ); - position = new Position( position.root, path ); + this.position = new Position( this.position.root, path ); this._visitedParent = node; } else { - position = position.getShiftedBy( 1 ); + this.position = this.position.getShiftedBy( 1 ); } - this.position = position; - return formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); } else if ( node instanceof Text ) { let charactersCount; @@ -247,30 +243,24 @@ export default class TreeWalker { offset = this.boundaries.end.offset; } - charactersCount = offset - position.offset; + charactersCount = offset - this.position.offset; } - const offsetInTextNode = position.offset - node.startOffset; + const offsetInTextNode = this.position.offset - node.startOffset; const item = new TextProxy( node, offsetInTextNode, charactersCount ); - position = position.getShiftedBy( charactersCount ); - - this.position = position; + this.position = this.position.getShiftedBy( charactersCount ); return formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); } else { // `node` is not set, we reached the end of current `parent`. - const path = position.getParentPath(); - path[ path.length - 1 ]++; - position = new Position( position.root, path ); - - this.position = position; + this.position = Position.createAfter( parent ); this._visitedParent = parent.parent; if ( this.ignoreElementEnd ) { return this._next(); } else { - return formatReturnValue( 'elementEnd', parent, previousPosition, position ); + return formatReturnValue( 'elementEnd', parent, previousPosition, this.position ); } } } @@ -285,7 +275,6 @@ export default class TreeWalker { */ _previous() { const previousPosition = this.position; - let position = this.position; const parent = this._visitedParent; // We are at the beginning of the root. @@ -302,26 +291,22 @@ export default class TreeWalker { const node = this.position.textNode ? this.position.textNode : this.position.nodeBefore; if ( node instanceof Element ) { - position = position.getShiftedBy( -1 ); + this.position = this.position.getShiftedBy( -1 ); if ( !this.shallow ) { - const path = position.path.slice(); + const path = this.position.path.slice(); path.push( node.maxOffset ); - position = new Position( position.root, path ); - - this.position = position; + this.position = new Position( this.position.root, path ); this._visitedParent = node; if ( this.ignoreElementEnd ) { return this._previous(); } else { - return formatReturnValue( 'elementEnd', node, previousPosition, position ); + return formatReturnValue( 'elementEnd', node, previousPosition, this.position ); } } else { - this.position = position; - - return formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); + return formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); } } else if ( node instanceof Text ) { let charactersCount; @@ -335,25 +320,21 @@ export default class TreeWalker { offset = this.boundaries.start.offset; } - charactersCount = position.offset - offset; + charactersCount = this.position.offset - offset; } - const offsetInTextNode = position.offset - node.startOffset; + const offsetInTextNode = this.position.offset - node.startOffset; const item = new TextProxy( node, offsetInTextNode - charactersCount, charactersCount ); - position = position.getShiftedBy( -charactersCount ); - - this.position = position; + this.position = this.position.getShiftedBy( -charactersCount ); - return formatReturnValue( 'text', item, previousPosition, position, charactersCount ); + return formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); } else { // `node` is not set, we reached the beginning of current `parent`. - position = new Position( position.root, position.getParentPath() ); - - this.position = position; + this.position = Position.createBefore( parent ); this._visitedParent = parent.parent; - return formatReturnValue( 'elementStart', parent, previousPosition, position, 1 ); + return formatReturnValue( 'elementStart', parent, previousPosition, this.position, 1 ); } } } diff --git a/src/view/position.js b/src/view/position.js index e72004016..67d8bf91b 100644 --- a/src/view/position.js +++ b/src/view/position.js @@ -13,9 +13,6 @@ import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import EditableElement from './editableelement'; -const _parent = Symbol( 'parent' ); -const _offset = Symbol( 'offset' ); - /** * Position in the tree. Position is always located before or after a node. */ @@ -27,8 +24,8 @@ export default class Position { * @param {Number} offset Position offset. */ constructor( parent, offset ) { - this[ _parent ] = parent; - this[ _offset ] = offset; + this._parent = parent; + this._offset = offset; } /** @@ -38,7 +35,7 @@ export default class Position { * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment} */ get parent() { - return this[ _parent ]; + return this._parent; } /** @@ -48,7 +45,7 @@ export default class Position { * @type {Number} */ get offset() { - return this[ _offset ]; + return this._offset; } /** diff --git a/src/view/range.js b/src/view/range.js index 4098a9589..32e573e1c 100644 --- a/src/view/range.js +++ b/src/view/range.js @@ -10,9 +10,6 @@ import Position from './position'; import TreeWalker from './treewalker'; -const _start = Symbol( 'start' ); -const _end = Symbol( 'end' ); - /** * Tree view range. */ @@ -26,8 +23,8 @@ export default class Range { * @param {module:engine/view/position~Position} [end] End position. If not set, range will be collapsed at `start` position. */ constructor( start, end = null ) { - this[ _start ] = start; - this[ _end ] = end ? end : start; + this._start = start; + this._end = end ? end : start; } /** @@ -52,7 +49,7 @@ export default class Range { * @type {module:engine/view/position~Position} */ get start() { - return this[ _start ]; + return this._start; } /** @@ -62,7 +59,7 @@ export default class Range { * @type {module:engine/view/position~Position} */ get end() { - return this[ _end ]; + return this._end; } /** From bad0d0fce8e9477876f89ed7279c287cc13a47c2 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 24 Nov 2017 16:30:49 +0100 Subject: [PATCH 038/724] Used stubs in tests to mock instead of overrides. --- tests/dev-utils/enableenginedebug.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index dc4a3323d..47ab15443 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -42,6 +42,10 @@ import ViewText from '../../src/view/text'; import ViewTextProxy from '../../src/view/textproxy'; import ViewDocumentFragment from '../../src/view/documentfragment'; +import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; + +testUtils.createSinonSandbox(); + /* global document */ describe( 'enableEngineDebug', () => { @@ -1056,9 +1060,7 @@ describe( 'debug tools', () => { const opB = new InsertOperation( ModelPosition.createAt( root, 0 ), new ModelText( 'a' ), 0 ); deltaB.addOperation( opB ); - deltaTransform.defaultTransform = () => { - throw new Error(); - }; + testUtils.sinon.stub( deltaTransform, 'defaultTransform' ).throws( new Error() ); expect( () => deltaTransform.transform( deltaA, deltaB, { isStrong: true } ) ).to.throw( Error ); expect( error.calledWith( deltaA.toString() + ' (important)' ) ).to.be.true; @@ -1074,9 +1076,7 @@ describe( 'debug tools', () => { const opB = new InsertOperation( ModelPosition.createAt( root, 0 ), new ModelText( 'a' ), 0 ); deltaB.addOperation( opB ); - deltaTransform.defaultTransform = () => { - throw new Error(); - }; + testUtils.sinon.stub( deltaTransform, 'defaultTransform' ).throws( new Error() ); expect( () => deltaTransform.transform( deltaA, deltaB, { isStrong: false } ) ).to.throw( Error ); expect( error.calledWith( deltaA.toString() ) ).to.be.true; From a504fbd1f77ac3c17b1bae72657fce87a2650f27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Fri, 24 Nov 2017 17:15:43 +0100 Subject: [PATCH 039/724] Revert "Merge pull request #1175 from ckeditor/t/897" This reverts commit 836dfd89a3b142fc212760f4fa5a80afbc7bb78d, reversing changes made to fc7da8035cdc9533f66ad5de66711e25cd2b385e. --- src/conversion/viewconversiondispatcher.js | 5 +- src/dev-utils/view.js | 5 +- src/model/delta/basic-transformations.js | 40 +- src/model/documentselection.js | 4 +- src/model/liveposition.js | 4 +- src/model/liverange.js | 4 +- src/model/operation/insertoperation.js | 2 +- src/model/operation/renameoperation.js | 4 +- src/model/operation/transform.js | 61 +-- src/model/position.js | 186 +++----- src/model/range.js | 80 +--- src/model/selection.js | 22 +- src/model/treewalker.js | 72 +-- src/view/position.js | 43 +- src/view/range.js | 41 +- src/view/selection.js | 26 +- src/view/treewalker.js | 99 ++-- src/view/writer.js | 53 +-- tests/model/delta/transform/_utils/utils.js | 39 +- tests/model/delta/transform/movedelta.js | 4 +- tests/model/delta/transform/splitdelta.js | 25 +- tests/model/liverange.js | 20 +- tests/model/operation/transform.js | 471 +++++++------------- tests/model/position.js | 24 + tests/model/range.js | 75 ++-- tests/view/range.js | 4 +- tests/view/selection.js | 10 +- tests/view/writer/remove.js | 25 +- 28 files changed, 594 insertions(+), 854 deletions(-) diff --git a/src/conversion/viewconversiondispatcher.js b/src/conversion/viewconversiondispatcher.js index 0e6fc576f..4a9100cac 100644 --- a/src/conversion/viewconversiondispatcher.js +++ b/src/conversion/viewconversiondispatcher.js @@ -303,11 +303,10 @@ function extractMarkersFromModelFragment( modelItem ) { // When marker of given name is not stored it means that we have found the beginning of the range. if ( !markers.has( markerName ) ) { - markers.set( markerName, new ModelRange( currentPosition ) ); + markers.set( markerName, new ModelRange( ModelPosition.createFromPosition( currentPosition ) ) ); // Otherwise is means that we have found end of the marker range. } else { - const oldMarker = markers.get( markerName ); - markers.set( markerName, new ModelRange( oldMarker.start, currentPosition ) ); + markers.get( markerName ).end = ModelPosition.createFromPosition( currentPosition ); } // Remove marker element from DocumentFragment. diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index 5694203b2..56b014c7d 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -541,7 +541,8 @@ class RangeParser { throw new Error( `Parse error - end of range was found '${ item.bracket }' but range was not started before.` ); } - // When second start of range is found when one is already opened - selection does not allow intersecting ranges. + // When second start of range is found when one is already opened - selection does not allow intersecting + // ranges. if ( range && ( item.bracket == ELEMENT_RANGE_START_TOKEN || item.bracket == TEXT_RANGE_START_TOKEN ) ) { throw new Error( `Parse error - start of range was found '${ item.bracket }' but one range is already started.` ); } @@ -549,7 +550,7 @@ class RangeParser { if ( item.bracket == ELEMENT_RANGE_START_TOKEN || item.bracket == TEXT_RANGE_START_TOKEN ) { range = new Range( item.position, item.position ); } else { - range = new Range( range.start, item.position ); + range.end = item.position; ranges.push( range ); range = null; } diff --git a/src/model/delta/basic-transformations.js b/src/model/delta/basic-transformations.js index e2cb2ed46..5d25305a7 100644 --- a/src/model/delta/basic-transformations.js +++ b/src/model/delta/basic-transformations.js @@ -73,10 +73,8 @@ addTransformationCase( AttributeDelta, SplitDelta, ( a, b, context ) => { const additionalAttributeDelta = new AttributeDelta(); const rangeStart = splitPosition.getShiftedBy( 1 ); - - const rangeEndPath = rangeStart.path.slice(); - rangeEndPath.push( 0 ); - const rangeEnd = new Position( rangeStart.root, rangeEndPath ); + const rangeEnd = Position.createFromPosition( rangeStart ); + rangeEnd.path.push( 0 ); const oldValue = b._cloneOperation.nodes.getNode( 0 ).getAttribute( operation.key ); @@ -238,7 +236,7 @@ addTransformationCase( SplitDelta, SplitDelta, ( a, b, context ) => { a._cloneOperation instanceof ReinsertOperation && b._cloneOperation instanceof ReinsertOperation && a._cloneOperation.sourcePosition.offset > b._cloneOperation.sourcePosition.offset ) { - a._cloneOperation.sourcePosition = a._cloneOperation.sourcePosition.getShiftedBy( -1 ); + a._cloneOperation.sourcePosition.offset--; } // `a` splits closer or at same offset. @@ -319,33 +317,29 @@ addTransformationCase( SplitDelta, WrapDelta, ( a, b, context ) => { // Wrapping element is the element inserted by WrapDelta (re)insert operation. // It is inserted after the wrapped range, but the wrapped range will be moved inside it. // Having this in mind, it is correct to use wrapped range start position as the position before wrapping element. - + const splitNodePos = Position.createFromPosition( b.range.start ); // Now, `splitNodePos` points before wrapping element. // To get a position before last children of that element, we expand position's `path` member by proper offset. - const splitPath = b.range.start.path.slice(); - splitPath.push( b.howMany - 1 ); - - const splitNodePos = new Position( b.range.start.root, splitPath ); + splitNodePos.path.push( b.howMany - 1 ); // SplitDelta insert operation position should be right after the node we split. - delta._cloneOperation.position = splitNodePos.getShiftedBy( 1 ); + const insertPos = splitNodePos.getShiftedBy( 1 ); + delta._cloneOperation.position = insertPos; // 2. Fix move operation source position. // Nodes moved by SplitDelta will be moved from new position, modified by WrapDelta. // To obtain that new position, `splitNodePos` will be used, as this is the node we are extracting children from. + const sourcePos = Position.createFromPosition( splitNodePos ); // Nothing changed inside split node so it is correct to use the original split position offset. - const sourcePath = splitNodePos.path.slice(); - sourcePath.push( a.position.offset ); - - delta._moveOperation.sourcePosition = new Position( splitNodePos.root, sourcePath ); + sourcePos.path.push( a.position.offset ); + delta._moveOperation.sourcePosition = sourcePos; // 3. Fix move operation target position. // SplitDelta move operation target position should be inside the node inserted by operation above. // Since the node is empty, we will insert at offset 0. - const targetPath = splitNodePos.getShiftedBy( 1 ).path.slice(); - targetPath.push( 0 ); - - delta._moveOperation.targetPosition = new Position( splitNodePos.root, targetPath ); + const targetPos = Position.createFromPosition( insertPos ); + targetPos.path.push( 0 ); + delta._moveOperation.targetPosition = targetPos; return [ delta ]; } @@ -440,17 +434,13 @@ addTransformationCase( WrapDelta, SplitDelta, ( a, b, context ) => { const delta = a.clone(); // Move wrapping element insert position one node further so it is after the split node insertion. - delta._insertOperation.position = delta._insertOperation.position.getShiftedBy( 1 ); + delta._insertOperation.position.offset++; // Include the split node copy. delta._moveOperation.howMany++; // Change the path to wrapping element in move operation. - const index = delta._moveOperation.targetPosition.path.length - 2; - - const path = delta._moveOperation.targetPosition.path.slice(); - path[ index ] += 1; - delta._moveOperation.targetPosition = new Position( delta._moveOperation.targetPosition.root, path ); + delta._moveOperation.targetPosition.path[ delta._moveOperation.targetPosition.path.length - 2 ]++; return [ delta ]; } diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 765123d97..7db3fb86b 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -7,6 +7,7 @@ * @module engine/model/documentselection */ +import Position from './position'; import Range from './range'; import LiveRange from './liverange'; import Text from './text'; @@ -665,9 +666,10 @@ export default class DocumentSelection extends Selection { _fixGraveyardSelection( liveRange, removedRangeStart ) { // The start of the removed range is the closest position to the `liveRange` - the original selection range. // This is a good candidate for a fixed selection range. + const positionCandidate = Position.createFromPosition( removedRangeStart ); // Find a range that is a correct selection range and is closest to the start of removed range. - const selectionRange = this._document.getNearestSelectionRange( removedRangeStart ); + const selectionRange = this._document.getNearestSelectionRange( positionCandidate ); // Remove the old selection range before preparing and adding new selection range. This order is important, // because new range, in some cases, may intersect with old range (it depends on `getNearestSelectionRange()` result). diff --git a/src/model/liveposition.js b/src/model/liveposition.js index ab6cdb7c9..9a19412d1 100644 --- a/src/model/liveposition.js +++ b/src/model/liveposition.js @@ -194,8 +194,8 @@ function transform( type, range, position ) { if ( !this.isEqual( transformed ) ) { const oldPosition = Position.createFromPosition( this ); - this._path = transformed.path; - this._root = transformed.root; + this.path = transformed.path; + this.root = transformed.root; this.fire( 'change', oldPosition ); } diff --git a/src/model/liverange.js b/src/model/liverange.js index a9785c9b6..32b7ad8de 100644 --- a/src/model/liverange.js +++ b/src/model/liverange.js @@ -178,8 +178,8 @@ function transform( changeType, deltaType, batch, targetRange, sourcePosition ) // If range boundaries have changed, fire `change:range` event. const oldRange = Range.createFromRange( this ); - this._start = updated.start; - this._end = updated.end; + this.start = updated.start; + this.end = updated.end; this.fire( 'change:range', oldRange, { type: changeType, diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 43718dc0d..26ff844e2 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -37,7 +37,7 @@ export default class InsertOperation extends Operation { * @readonly * @member {module:engine/model/position~Position} module:engine/model/operation/insertoperation~InsertOperation#position */ - this.position = position; + this.position = Position.createFromPosition( position ); /** * List of nodes to insert. diff --git a/src/model/operation/renameoperation.js b/src/model/operation/renameoperation.js index ed7aeac47..502cd6828 100644 --- a/src/model/operation/renameoperation.js +++ b/src/model/operation/renameoperation.js @@ -66,7 +66,7 @@ export default class RenameOperation extends Operation { * @returns {module:engine/model/operation/renameoperation~RenameOperation} Clone of this operation. */ clone() { - return new RenameOperation( this.position, this.oldName, this.newName, this.baseVersion ); + return new RenameOperation( Position.createFromPosition( this.position ), this.oldName, this.newName, this.baseVersion ); } /** @@ -75,7 +75,7 @@ export default class RenameOperation extends Operation { * @returns {module:engine/model/operation/renameoperation~RenameOperation} */ getReversed() { - return new RenameOperation( this.position, this.newName, this.oldName, this.baseVersion + 1 ); + return new RenameOperation( Position.createFromPosition( this.position ), this.newName, this.oldName, this.baseVersion + 1 ); } /** diff --git a/src/model/operation/transform.js b/src/model/operation/transform.js index 3f602a417..13cc541ef 100644 --- a/src/model/operation/transform.js +++ b/src/model/operation/transform.js @@ -179,29 +179,25 @@ const ot = { // Take the start and the end of the range and transform them by deletion of moved nodes. // Note that if rangeB was inside AttributeOperation range, only difference.end will be transformed. // This nicely covers the joining simplification we did in the previous step. - const differenceTransformed = new Range( - difference.start._getTransformedByDeletion( b.sourcePosition, b.howMany ), - difference.end._getTransformedByDeletion( b.sourcePosition, b.howMany ) - ); + difference.start = difference.start._getTransformedByDeletion( b.sourcePosition, b.howMany ); + difference.end = difference.end._getTransformedByDeletion( b.sourcePosition, b.howMany ); // MoveOperation pastes nodes into target position. We acknowledge this by proper transformation. // Note that since we operate on transformed difference range, we should transform by // previously transformed target position. // Note that we do not use Position._getTransformedByMove on range boundaries because we need to // transform by insertion a range as a whole, since newTargetPosition might be inside that range. - ranges = differenceTransformed._getTransformedByInsertion( b.getMovedRangeStart(), b.howMany, true, false ).reverse(); + ranges = difference._getTransformedByInsertion( b.getMovedRangeStart(), b.howMany, true, false ).reverse(); } if ( common !== null ) { // Here we do not need to worry that newTargetPosition is inside moved range, because that // would mean that the MoveOperation targets into itself, and that is incorrect operation. // Instead, we calculate the new position of that part of original range. - const commonTransformed = new Range( - common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), - common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) - ); + common.start = common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ); + common.end = common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ); - ranges.push( commonTransformed ); + ranges.push( common ); } // Map transformed range(s) to operations and return them. @@ -380,7 +376,7 @@ const ot = { // Setting and evaluating some variables that will be used in special cases and default algorithm. // // Create ranges from `MoveOperations` properties. - let rangeA = Range.createFromPositionAndShift( a.sourcePosition, a.howMany ); + const rangeA = Range.createFromPositionAndShift( a.sourcePosition, a.howMany ); const rangeB = Range.createFromPositionAndShift( b.sourcePosition, b.howMany ); // Assign `context.isStrong` to a different variable, because the value may change during execution of @@ -432,10 +428,8 @@ const ot = { if ( bTargetsToA && rangeA.containsRange( rangeB, true ) ) { // There is a mini-special case here, where `rangeB` is on other level than `rangeA`. That's why // we need to transform `a` operation anyway. - rangeA = new Range( - rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ), - rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ) - ); + rangeA.start = rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ); + rangeA.end = rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ); return makeMoveOperationsFromRanges( [ rangeA ], newTargetPosition, a ); } @@ -450,10 +444,8 @@ const ot = { if ( aTargetsToB && rangeB.containsRange( rangeA, true ) ) { // `a` operation is "moved together" with `b` operation. // Here, just move `rangeA` "inside" `rangeB`. - rangeA = new Range( - rangeA.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), - rangeA.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) - ); + rangeA.start = rangeA.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ); + rangeA.end = rangeA.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ); return makeMoveOperationsFromRanges( [ rangeA ], newTargetPosition, a ); } @@ -474,10 +466,8 @@ const ot = { // Transform `rangeA` by `b` operation and make operation out of it, and that's all. // Note that this is a simplified version of default case, but here we treat the common part (whole `rangeA`) // like a one difference part. - rangeA = new Range( - rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ), - rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ) - ); + rangeA.start = rangeA.start._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, !includeB ); + rangeA.end = rangeA.end._getTransformedByMove( b.sourcePosition, b.targetPosition, b.howMany, includeB ); return makeMoveOperationsFromRanges( [ rangeA ], newTargetPosition, a ); } @@ -510,12 +500,10 @@ const ot = { // This is an array with one or two ranges. Two ranges if `rangeB` is inside `rangeA`. const difference = rangeA.getDifference( rangeB ); - for ( const rangeInDiff of difference ) { + for ( const range of difference ) { // Transform those ranges by `b` operation. For example if `b` moved range from before those ranges, fix those ranges. - const range = new Range( - rangeInDiff.start._getTransformedByDeletion( b.sourcePosition, b.howMany ), - rangeInDiff.end._getTransformedByDeletion( b.sourcePosition, b.howMany ) - ); + range.start = range.start._getTransformedByDeletion( b.sourcePosition, b.howMany ); + range.end = range.end._getTransformedByDeletion( b.sourcePosition, b.howMany ); // If `b` operation targets into `rangeA` on the same level, spread `rangeA` into two ranges. const shouldSpread = compareArrays( range.start.getParentPath(), b.getMovedRangeStart().getParentPath() ) == 'same'; @@ -525,14 +513,12 @@ const ot = { } // Then, we have to manage the "common part" of both move ranges. - const intersectionRange = rangeA.getIntersection( rangeB ); + const common = rangeA.getIntersection( rangeB ); - if ( intersectionRange !== null && isStrong && !bTargetsToA ) { + if ( common !== null && isStrong && !bTargetsToA ) { // Calculate the new position of that part of original range. - const common = new Range( - intersectionRange.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ), - intersectionRange.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ) - ); + common.start = common.start._getCombined( b.sourcePosition, b.getMovedRangeStart() ); + common.end = common.end._getCombined( b.sourcePosition, b.getMovedRangeStart() ); // Take care of proper range order. // @@ -641,10 +627,9 @@ function joinRanges( ranges ) { } else if ( ranges.length == 1 ) { return ranges[ 0 ]; } else { - return new Range( - ranges[ 0 ].start, - ranges[ ranges.length - 1 ].end - ); + ranges[ 0 ].end = ranges[ ranges.length - 1 ].end; + + return ranges[ 0 ]; } } diff --git a/src/model/position.js b/src/model/position.js index ede7c577b..7d199b617 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -66,70 +66,47 @@ export default class Position { // Normalize the root and path (if element was passed). path = root.getPath().concat( path ); - - // Make path immutable - Object.freeze( path ); + root = root.root; /** * Root of the position path. * - * @protected + * @readonly * @member {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} - * module:engine/model/position~Position#_root + * module:engine/model/position~Position#root */ - this._root = root.root; + this.root = root; /** - * Position of the node in the tree. + * Position of the node in the tree. **Path contains offsets, not indexes.** + * + * Position can be placed before, after or in a {@link module:engine/model/node~Node node} if that node has + * {@link module:engine/model/node~Node#offsetSize} greater than `1`. Items in position path are + * {@link module:engine/model/node~Node#startOffset starting offsets} of position ancestors, starting from direct root children, + * down to the position offset in it's parent. + * + * ROOT + * |- P before: [ 0 ] after: [ 1 ] + * |- UL before: [ 1 ] after: [ 2 ] + * |- LI before: [ 1, 0 ] after: [ 1, 1 ] + * | |- foo before: [ 1, 0, 0 ] after: [ 1, 0, 3 ] + * |- LI before: [ 1, 1 ] after: [ 1, 2 ] + * |- bar before: [ 1, 1, 0 ] after: [ 1, 1, 3 ] * - * @protected - * @member {Array.} module:engine/model/position~Position#_path + * `foo` and `bar` are representing {@link module:engine/model/text~Text text nodes}. Since text nodes has offset size + * greater than `1` you can place position offset between their start and end: + * + * ROOT + * |- P + * |- UL + * |- LI + * | |- f^o|o ^ has path: [ 1, 0, 1 ] | has path: [ 1, 0, 2 ] + * |- LI + * |- b^a|r ^ has path: [ 1, 1, 1 ] | has path: [ 1, 1, 2 ] + * + * @member {Array.} module:engine/model/position~Position#path */ - this._path = path; - } - - /** - * Position of the node in the tree. **Path contains offsets, not indexes.** - * - * Position can be placed before, after or in a {@link module:engine/model/node~Node node} if that node has - * {@link module:engine/model/node~Node#offsetSize} greater than `1`. Items in position path are - * {@link module:engine/model/node~Node#startOffset starting offsets} of position ancestors, starting from direct root children, - * down to the position offset in it's parent. - * - * ROOT - * |- P before: [ 0 ] after: [ 1 ] - * |- UL before: [ 1 ] after: [ 2 ] - * |- LI before: [ 1, 0 ] after: [ 1, 1 ] - * | |- foo before: [ 1, 0, 0 ] after: [ 1, 0, 3 ] - * |- LI before: [ 1, 1 ] after: [ 1, 2 ] - * |- bar before: [ 1, 1, 0 ] after: [ 1, 1, 3 ] - * - * `foo` and `bar` are representing {@link module:engine/model/text~Text text nodes}. Since text nodes has offset size - * greater than `1` you can place position offset between their start and end: - * - * ROOT - * |- P - * |- UL - * |- LI - * | |- f^o|o ^ has path: [ 1, 0, 1 ] | has path: [ 1, 0, 2 ] - * |- LI - * |- b^a|r ^ has path: [ 1, 1, 1 ] | has path: [ 1, 1, 2 ] - * - * @member {Array.} module:engine/model/position~Position#path - */ - get path() { - return this._path; - } - - /** - * Root of the position path. - * - * @readonly - * @member {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} - * module:engine/model/position~Position#root - */ - get root() { - return this._root; + this.path = path; } /** @@ -142,6 +119,13 @@ export default class Position { return last( this.path ); } + /** + * @param {Number} newOffset + */ + set offset( newOffset ) { + this.path[ this.path.length - 1 ] = newOffset; + } + /** * Parent element of this position. * @@ -356,20 +340,6 @@ export default class Position { return i === 0 ? null : ancestorsA[ i - 1 ]; } - /** - * Returns a new instance of `Position`, that has same {@link #parent parent} but it's offset - * is set to `offset` value. - * - * @param {Number} offset Position offset. See {@link module:engine/model/position~Position#offset}. - * @returns {module:engine/model/position~Position} Moved position. - */ - getShiftedTo( offset ) { - const path = this.path.slice(); - path[ path.length - 1 ] = offset; - - return new Position( this.root, path ); - } - /** * Returns a new instance of `Position`, that has same {@link #parent parent} but it's offset * is shifted by `shift` value (can be a negative value). @@ -378,9 +348,12 @@ export default class Position { * @returns {module:engine/model/position~Position} Shifted position. */ getShiftedBy( shift ) { - const newOffset = this.offset + shift; + const shifted = Position.createFromPosition( this ); + + const offset = shifted.offset + shift; + shifted.offset = offset < 0 ? 0 : offset; - return this.getShiftedTo( newOffset < 0 ? 0 : newOffset ); + return shifted; } /** @@ -460,13 +433,13 @@ export default class Position { return true; case 'before': - left = this; // eslint-disable-line consistent-this - right = otherPosition; + left = Position.createFromPosition( this ); + right = Position.createFromPosition( otherPosition ); break; case 'after': - left = otherPosition; - right = this; // eslint-disable-line consistent-this + left = Position.createFromPosition( otherPosition ); + right = Position.createFromPosition( this ); break; default: @@ -486,33 +459,19 @@ export default class Position { return false; } - const path = left.getParentPath(); - path[ path.length - 1 ]++; - left = new Position( left.root, path ); - + left.path = left.path.slice( 0, -1 ); leftParent = leftParent.parent; + left.offset++; } else { if ( right.offset !== 0 ) { return false; } - right = new Position( right.root, right.getParentPath() ); + right.path = right.path.slice( 0, -1 ); } } } - /** - * Converts `Position` to plain object and returns it. - * - * @returns {Object} `Position` converted to plain object. - */ - toJSON() { - return { - root: this.root.toJSON(), - path: this.path - }; - } - /** * Returns a copy of this position that is updated by removing `howMany` nodes starting from `deletePosition`. * It may happen that this position is in a removed node. If that is the case, `null` is returned instead. @@ -523,14 +482,14 @@ export default class Position { * @returns {module:engine/model/position~Position|null} Transformed position or `null`. */ _getTransformedByDeletion( deletePosition, howMany ) { + const transformed = Position.createFromPosition( this ); + // This position can't be affected if deletion was in a different root. if ( this.root != deletePosition.root ) { - return Position.createFromPosition( this ); + return transformed; } - const comparisonResult = compareArrays( deletePosition.getParentPath(), this.getParentPath() ); - - if ( comparisonResult == 'same' ) { + if ( compareArrays( deletePosition.getParentPath(), this.getParentPath() ) == 'same' ) { // If nodes are removed from the node that is pointed by this position... if ( deletePosition.offset < this.offset ) { // And are removed from before an offset of that position... @@ -538,10 +497,11 @@ export default class Position { // Position is in removed range, it's no longer in the tree. return null; } else { - return this.getShiftedBy( -howMany ); + // Decrement the offset accordingly. + transformed.offset -= howMany; } } - } else if ( comparisonResult == 'prefix' ) { + } else if ( compareArrays( deletePosition.getParentPath(), this.getParentPath() ) == 'prefix' ) { // If nodes are removed from a node that is on a path to this position... const i = deletePosition.path.length - 1; @@ -553,16 +513,12 @@ export default class Position { return null; } else { // Otherwise, decrement index on that path. - const path = this.path.slice(); - - path[ i ] -= howMany; - - return new Position( this.root, path ); + transformed.path[ i ] -= howMany; } } } - return Position.createFromPosition( this ); + return transformed; } /** @@ -577,9 +533,11 @@ export default class Position { * @returns {module:engine/model/position~Position} Transformed position. */ _getTransformedByInsertion( insertPosition, howMany, insertBefore ) { + const transformed = Position.createFromPosition( this ); + // This position can't be affected if insertion was in a different root. if ( this.root != insertPosition.root ) { - return Position.createFromPosition( this ); + return transformed; } if ( compareArrays( insertPosition.getParentPath(), this.getParentPath() ) == 'same' ) { @@ -587,7 +545,7 @@ export default class Position { if ( insertPosition.offset < this.offset || ( insertPosition.offset == this.offset && insertBefore ) ) { // And are inserted before an offset of that position... // "Push" this positions offset. - return this.getShiftedBy( howMany ); + transformed.offset += howMany; } } else if ( compareArrays( insertPosition.getParentPath(), this.getParentPath() ) == 'prefix' ) { // If nodes are inserted in a node that is on a path to this position... @@ -596,15 +554,11 @@ export default class Position { if ( insertPosition.offset <= this.path[ i ] ) { // And are inserted before next node of that path... // "Push" the index on that path. - const path = this.path.slice(); - - path[ i ] += howMany; - - return new Position( this.root, path ); + transformed.path[ i ] += howMany; } } - return Position.createFromPosition( this ); + return transformed; } /** @@ -672,20 +626,18 @@ export default class Position { const i = source.path.length - 1; // The first part of a path to combined position is a path to the place where nodes were moved. - let combinedPath = target.path.slice(); + const combined = Position.createFromPosition( target ); // Then we have to update the rest of the path. // Fix the offset because this position might be after `from` position and we have to reflect that. - const oldOffset = last( combinedPath ); - const newOffset = oldOffset + this.path[ i ] - source.offset; - combinedPath[ combinedPath.length - 1 ] = newOffset; + combined.offset = combined.offset + this.path[ i ] - source.offset; // Then, add the rest of the path. // If this position is at the same level as `from` position nothing will get added. - combinedPath = combinedPath.concat( this.path.slice( i + 1 ) ); + combined.path = combined.path.concat( this.path.slice( i + 1 ) ); - return new Position( target.root, combinedPath ); + return combined; } /** diff --git a/src/model/range.js b/src/model/range.js index d5b376cfe..e8fcd56bf 100644 --- a/src/model/range.js +++ b/src/model/range.js @@ -27,18 +27,18 @@ export default class Range { /** * Start position. * - * @protected + * @readonly * @member {module:engine/model/position~Position} */ - this._start = start; + this.start = Position.createFromPosition( start ); /** * End position. * - * @protected + * @readonly * @member {module:engine/model/position~Position} */ - this._end = end ? end : start; + this.end = end ? Position.createFromPosition( end ) : Position.createFromPosition( start ); } /** @@ -57,26 +57,6 @@ export default class Range { yield* new TreeWalker( { boundaries: this, ignoreElementEnd: true } ); } - /** - * Start position. - * - * @readonly - * @member {module:engine/model/position~Position} - */ - get start() { - return this._start; - } - - /** - * End position. - * - * @readonly - * @member {module:engine/model/position~Position} - */ - get end() { - return this._end; - } - /** * Returns whether the range is collapsed, that is if {@link #start} and * {@link #end} positions are equal. @@ -300,7 +280,7 @@ export default class Range { const ranges = []; const diffAt = this.start.getCommonPath( this.end ).length; - let pos = this.start; + const pos = Position.createFromPosition( this.start ); let posParent = pos.parent; // Go up. @@ -311,7 +291,8 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - pos = Position.createAfter( posParent ); + pos.path = pos.path.slice( 0, -1 ); + pos.offset++; posParent = posParent.parent; } @@ -324,11 +305,8 @@ export default class Range { ranges.push( new Range( pos, pos.getShiftedBy( howMany ) ) ); } - const path = pos.getParentPath(); - path.push( offset ); - path.push( 0 ); - - pos = new Position( pos.root, path ); + pos.offset = offset; + pos.path.push( 0 ); } return ranges; @@ -488,18 +466,6 @@ export default class Range { return this.start.getCommonAncestor( this.end ); } - /** - * Converts `Range` to plain object and returns it. - * - * @returns {Object} `Range` converted to plain object. - */ - toJSON() { - return { - start: this.start.toJSON(), - end: this.end.toJSON() - }; - } - /** * Returns a range that is a result of transforming this range by a change in the model document. * @@ -647,13 +613,15 @@ export default class Range { ) ]; } else { + const range = Range.createFromRange( this ); + const insertBeforeStart = !isSticky; - const insertBeforeEnd = this.isCollapsed ? true : isSticky; + const insertBeforeEnd = range.isCollapsed ? true : isSticky; - const start = this.start._getTransformedByInsertion( insertPosition, howMany, insertBeforeStart ); - const end = this.end._getTransformedByInsertion( insertPosition, howMany, insertBeforeEnd ); + range.start = range.start._getTransformedByInsertion( insertPosition, howMany, insertBeforeStart ); + range.end = range.end._getTransformedByInsertion( insertPosition, howMany, insertBeforeEnd ); - return [ new Range( start, end ) ]; + return [ range ]; } } @@ -787,8 +755,9 @@ export default class Range { */ static createCollapsedAt( itemOrPosition, offset ) { const start = Position.createAt( itemOrPosition, offset ); + const end = Position.createFromPosition( start ); - return new Range( start, start ); + return new Range( start, end ); } /** @@ -835,14 +804,13 @@ export default class Range { // 4. At this moment we don't need the original range. // We are going to modify the result and we need to return a new instance of Range. // We have to create a copy of the reference range. - let start = ref.start; - let end = ref.end; + const result = new this( ref.start, ref.end ); // 5. Ranges should be checked and glued starting from the range that is closest to the reference range. // Since ranges are sorted, start with the range with index that is closest to reference range index. - for ( let i = refIndex - 1; i >= 0; i-- ) { - if ( ranges[ i ].end.isEqual( start ) ) { - start = ranges[ i ].start; + for ( let i = refIndex - 1; i >= 0; i++ ) { + if ( ranges[ i ].end.isEqual( result.start ) ) { + result.start = Position.createFromPosition( ranges[ i ].start ); } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; @@ -852,15 +820,15 @@ export default class Range { // 6. Ranges should be checked and glued starting from the range that is closest to the reference range. // Since ranges are sorted, start with the range with index that is closest to reference range index. for ( let i = refIndex + 1; i < ranges.length; i++ ) { - if ( ranges[ i ].start.isEqual( end ) ) { - end = ranges[ i ].end; + if ( ranges[ i ].start.isEqual( result.end ) ) { + result.end = Position.createFromPosition( ranges[ i ].end ); } else { // If ranges are not starting/ending at the same position there is no point in looking further. break; } } - return new this( start, end ); + return result; } /** diff --git a/src/model/selection.js b/src/model/selection.js index 6060a3af0..27569afe8 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -174,16 +174,18 @@ export default class Selection { } /** - * Returns an iterator that iterates over selection ranges. + * Returns an iterator that iterates over copies of selection ranges. * * @returns {Iterator.} */ - getRanges() { - return this._ranges[ Symbol.iterator ](); + * getRanges() { + for ( const range of this._ranges ) { + yield Range.createFromRange( range ); + } } /** - * Returns first range in the selection. + * Returns a copy of the first range in the selection. * First range is the one which {@link module:engine/model/range~Range#start start} position * {@link module:engine/model/position~Position#isBefore is before} start position of all other ranges * (not to confuse with the first range added to the selection). @@ -201,11 +203,11 @@ export default class Selection { } } - return first; + return first ? Range.createFromRange( first ) : null; } /** - * Returns last range in the selection. + * Returns a copy of the last range in the selection. * Last range is the one which {@link module:engine/model/range~Range#end end} position * {@link module:engine/model/position~Position#isAfter is after} end position of all other ranges (not to confuse with the range most * recently added to the selection). @@ -223,7 +225,7 @@ export default class Selection { } } - return last; + return last ? Range.createFromRange( last ) : null; } /** @@ -236,9 +238,9 @@ export default class Selection { * @returns {module:engine/model/position~Position|null} */ getFirstPosition() { - const firstRange = this.getFirstRange(); + const first = this.getFirstRange(); - return firstRange ? firstRange.start : null; + return first ? Position.createFromPosition( first.start ) : null; } /** @@ -253,7 +255,7 @@ export default class Selection { getLastPosition() { const lastRange = this.getLastRange(); - return lastRange ? lastRange.end : null; + return lastRange ? Position.createFromPosition( lastRange.end ) : null; } /** diff --git a/src/model/treewalker.js b/src/model/treewalker.js index fe9415251..8a9ff919b 100644 --- a/src/model/treewalker.js +++ b/src/model/treewalker.js @@ -85,9 +85,9 @@ export default class TreeWalker { * @member {module:engine/model/position~Position} module:engine/model/treewalker~TreeWalker#position */ if ( options.startPosition ) { - this.position = options.startPosition; + this.position = Position.createFromPosition( options.startPosition ); } else { - this.position = this.boundaries[ this.direction == 'backward' ? 'end' : 'start' ]; + this.position = Position.createFromPosition( this.boundaries[ this.direction == 'backward' ? 'end' : 'start' ] ); } /** @@ -204,33 +204,33 @@ export default class TreeWalker { */ _next() { const previousPosition = this.position; + const position = Position.createFromPosition( this.position ); const parent = this._visitedParent; // We are at the end of the root. - if ( parent.parent === null && this.position.offset === parent.maxOffset ) { + if ( parent.parent === null && position.offset === parent.maxOffset ) { return { done: true }; } // We reached the walker boundary. - if ( parent === this._boundaryEndParent && this.position.offset == this.boundaries.end.offset ) { + if ( parent === this._boundaryEndParent && position.offset == this.boundaries.end.offset ) { return { done: true }; } - const node = this.position.textNode ? this.position.textNode : this.position.nodeAfter; + const node = position.textNode ? position.textNode : position.nodeAfter; if ( node instanceof Element ) { if ( !this.shallow ) { // Manual operations on path internals for optimization purposes. Here and in the rest of the method. - const path = this.position.path.slice(); - path.push( 0 ); - this.position = new Position( this.position.root, path ); - + position.path.push( 0 ); this._visitedParent = node; } else { - this.position = this.position.getShiftedBy( 1 ); + position.offset++; } - return formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); + this.position = position; + + return formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); } else if ( node instanceof Text ) { let charactersCount; @@ -243,24 +243,27 @@ export default class TreeWalker { offset = this.boundaries.end.offset; } - charactersCount = offset - this.position.offset; + charactersCount = offset - position.offset; } - const offsetInTextNode = this.position.offset - node.startOffset; + const offsetInTextNode = position.offset - node.startOffset; const item = new TextProxy( node, offsetInTextNode, charactersCount ); - this.position = this.position.getShiftedBy( charactersCount ); + position.offset += charactersCount; + this.position = position; - return formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); + return formatReturnValue( 'text', item, previousPosition, position, charactersCount ); } else { // `node` is not set, we reached the end of current `parent`. - this.position = Position.createAfter( parent ); + position.path.pop(); + position.offset++; + this.position = position; this._visitedParent = parent.parent; if ( this.ignoreElementEnd ) { return this._next(); } else { - return formatReturnValue( 'elementEnd', parent, previousPosition, this.position ); + return formatReturnValue( 'elementEnd', parent, previousPosition, position ); } } } @@ -275,38 +278,39 @@ export default class TreeWalker { */ _previous() { const previousPosition = this.position; + const position = Position.createFromPosition( this.position ); const parent = this._visitedParent; // We are at the beginning of the root. - if ( parent.parent === null && this.position.offset === 0 ) { + if ( parent.parent === null && position.offset === 0 ) { return { done: true }; } // We reached the walker boundary. - if ( parent == this._boundaryStartParent && this.position.offset == this.boundaries.start.offset ) { + if ( parent == this._boundaryStartParent && position.offset == this.boundaries.start.offset ) { return { done: true }; } // Get node just before current position - const node = this.position.textNode ? this.position.textNode : this.position.nodeBefore; + const node = position.textNode ? position.textNode : position.nodeBefore; if ( node instanceof Element ) { - this.position = this.position.getShiftedBy( -1 ); + position.offset--; if ( !this.shallow ) { - const path = this.position.path.slice(); - path.push( node.maxOffset ); - - this.position = new Position( this.position.root, path ); + position.path.push( node.maxOffset ); + this.position = position; this._visitedParent = node; if ( this.ignoreElementEnd ) { return this._previous(); } else { - return formatReturnValue( 'elementEnd', node, previousPosition, this.position ); + return formatReturnValue( 'elementEnd', node, previousPosition, position ); } } else { - return formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); + this.position = position; + + return formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); } } else if ( node instanceof Text ) { let charactersCount; @@ -320,21 +324,23 @@ export default class TreeWalker { offset = this.boundaries.start.offset; } - charactersCount = this.position.offset - offset; + charactersCount = position.offset - offset; } - const offsetInTextNode = this.position.offset - node.startOffset; + const offsetInTextNode = position.offset - node.startOffset; const item = new TextProxy( node, offsetInTextNode - charactersCount, charactersCount ); - this.position = this.position.getShiftedBy( -charactersCount ); + position.offset -= charactersCount; + this.position = position; - return formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); + return formatReturnValue( 'text', item, previousPosition, position, charactersCount ); } else { // `node` is not set, we reached the beginning of current `parent`. - this.position = Position.createBefore( parent ); + position.path.pop(); + this.position = position; this._visitedParent = parent.parent; - return formatReturnValue( 'elementStart', parent, previousPosition, this.position, 1 ); + return formatReturnValue( 'elementStart', parent, previousPosition, position, 1 ); } } } diff --git a/src/view/position.js b/src/view/position.js index 67d8bf91b..b06bdf184 100644 --- a/src/view/position.js +++ b/src/view/position.js @@ -24,28 +24,20 @@ export default class Position { * @param {Number} offset Position offset. */ constructor( parent, offset ) { - this._parent = parent; - this._offset = offset; - } - - /** - * Position parent. - * - * @readonly - * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment} - */ - get parent() { - return this._parent; - } - - /** - * Position offset. - * - * @readonly - * @type {Number} - */ - get offset() { - return this._offset; + /** + * Position parent. + * + * @member {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment} + * module:engine/view/position~Position#parent + */ + this.parent = parent; + + /** + * Position offset. + * + * @member {Number} module:engine/view/position~Position#offset + */ + this.offset = offset; } /** @@ -137,9 +129,12 @@ export default class Position { * @returns {module:engine/view/position~Position} Shifted position. */ getShiftedBy( shift ) { - const offset = this.offset + shift; + const shifted = Position.createFromPosition( this ); + + const offset = shifted.offset + shift; + shifted.offset = offset < 0 ? 0 : offset; - return new Position( this.parent, offset < 0 ? 0 : offset ); + return shifted; } /** diff --git a/src/view/range.js b/src/view/range.js index 32e573e1c..991b69340 100644 --- a/src/view/range.js +++ b/src/view/range.js @@ -23,8 +23,19 @@ export default class Range { * @param {module:engine/view/position~Position} [end] End position. If not set, range will be collapsed at `start` position. */ constructor( start, end = null ) { - this._start = start; - this._end = end ? end : start; + /** + * Start position. + * + * @member {module:engine/view/position~Position} + */ + this.start = Position.createFromPosition( start ); + + /** + * End position. + * + * @member {module:engine/view/position~Position} + */ + this.end = end ? Position.createFromPosition( end ) : Position.createFromPosition( start ); } /** @@ -42,30 +53,9 @@ export default class Range { yield* new TreeWalker( { boundaries: this, ignoreElementEnd: true } ); } - /** - * Start position. - * - * @readonly - * @type {module:engine/view/position~Position} - */ - get start() { - return this._start; - } - - /** - * End position. - * - * @readonly - * @type {module:engine/view/position~Position} - */ - get end() { - return this._end; - } - /** * Returns whether the range is collapsed, that is it start and end positions are equal. * - * @readonly * @type {Boolean} */ get isCollapsed() { @@ -76,7 +66,6 @@ export default class Range { * Returns whether this range is flat, that is if {@link module:engine/view/range~Range#start start} position and * {@link module:engine/view/range~Range#end end} position are in the same {@link module:engine/view/position~Position#parent parent}. * - * @readonly * @type {Boolean} */ get isFlat() { @@ -86,7 +75,6 @@ export default class Range { /** * Range root element. * - * @readonly * @type {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} */ get root() { @@ -463,8 +451,9 @@ export default class Range { */ static createCollapsedAt( itemOrPosition, offset ) { const start = Position.createAt( itemOrPosition, offset ); + const end = Position.createFromPosition( start ); - return new Range( start, start ); + return new Range( start, end ); } } diff --git a/src/view/selection.js b/src/view/selection.js index 41157f1db..3d96afb40 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -132,8 +132,9 @@ export default class Selection { return null; } const range = this._ranges[ this._ranges.length - 1 ]; + const anchor = this._lastRangeBackward ? range.end : range.start; - return this._lastRangeBackward ? range.end : range.start; + return Position.createFromPosition( anchor ); } /** @@ -147,8 +148,9 @@ export default class Selection { return null; } const range = this._ranges[ this._ranges.length - 1 ]; + const focus = this._lastRangeBackward ? range.start : range.end; - return this._lastRangeBackward ? range.start : range.end; + return Position.createFromPosition( focus ); } /** @@ -220,16 +222,18 @@ export default class Selection { } /** - * Returns an iterator that contains all ranges added to the selection. + * Returns an iterator that contains copies of all ranges added to the selection. * * @returns {Iterator.} */ - getRanges() { - return this._ranges[ Symbol.iterator ](); + * getRanges() { + for ( const range of this._ranges ) { + yield Range.createFromRange( range ); + } } /** - * Returns first range in the selection. First range is the one which + * Returns copy of the first range in the selection. First range is the one which * {@link module:engine/view/range~Range#start start} position {@link module:engine/view/position~Position#isBefore is before} start * position of all other ranges (not to confuse with the first range added to the selection). * Returns `null` if no ranges are added to selection. @@ -245,11 +249,11 @@ export default class Selection { } } - return first; + return first ? Range.createFromRange( first ) : null; } /** - * Returns last range in the selection. Last range is the one which {@link module:engine/view/range~Range#end end} + * Returns copy of the last range in the selection. Last range is the one which {@link module:engine/view/range~Range#end end} * position {@link module:engine/view/position~Position#isAfter is after} end position of all other ranges (not to confuse * with the last range added to the selection). Returns `null` if no ranges are added to selection. * @@ -264,7 +268,7 @@ export default class Selection { } } - return last; + return last ? Range.createFromRange( last ) : null; } /** @@ -277,7 +281,7 @@ export default class Selection { getFirstPosition() { const firstRange = this.getFirstRange(); - return firstRange ? firstRange.start : null; + return firstRange ? Position.createFromPosition( firstRange.start ) : null; } /** @@ -290,7 +294,7 @@ export default class Selection { getLastPosition() { const lastRange = this.getLastRange(); - return lastRange ? lastRange.end : null; + return lastRange ? Position.createFromPosition( lastRange.end ) : null; } /** diff --git a/src/view/treewalker.js b/src/view/treewalker.js index a9e3dfcf8..838f09280 100644 --- a/src/view/treewalker.js +++ b/src/view/treewalker.js @@ -73,9 +73,9 @@ export default class TreeWalker { * @member {module:engine/view/position~Position} module:engine/view/treewalker~TreeWalker#position */ if ( options.startPosition ) { - this.position = options.startPosition; + this.position = Position.createFromPosition( options.startPosition ); } else { - this.position = options.boundaries[ options.direction == 'backward' ? 'end' : 'start' ]; + this.position = Position.createFromPosition( options.boundaries[ options.direction == 'backward' ? 'end' : 'start' ] ); } /** @@ -187,16 +187,17 @@ export default class TreeWalker { * @returns {module:engine/view/treewalker~TreeWalkerValue} return.value Information about taken step. */ _next() { + let position = Position.createFromPosition( this.position ); const previousPosition = this.position; - const parent = this.position.parent; + const parent = position.parent; // We are at the end of the root. - if ( parent.parent === null && this.position.offset === parent.childCount ) { + if ( parent.parent === null && position.offset === parent.childCount ) { return { done: true }; } // We reached the walker boundary. - if ( parent === this._boundaryEndParent && this.position.offset == this.boundaries.end.offset ) { + if ( parent === this._boundaryEndParent && position.offset == this.boundaries.end.offset ) { return { done: true }; } @@ -205,29 +206,32 @@ export default class TreeWalker { // Text is a specific parent because it contains string instead of child nodes. if ( parent instanceof Text ) { - if ( this.position.isAtEnd ) { + if ( position.isAtEnd ) { // Prevent returning "elementEnd" for Text node. Skip that value and return the next walker step. this.position = Position.createAfter( parent ); return this._next(); } - node = parent.data[ this.position.offset ]; + node = parent.data[ position.offset ]; } else { - node = parent.getChild( this.position.offset ); + node = parent.getChild( position.offset ); } if ( node instanceof Element ) { if ( !this.shallow ) { - this.position = new Position( node, 0 ); + position = new Position( node, 0 ); } else { - this.position = this.position.getShiftedBy( 1 ); + position.offset++; } - return this._formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); + this.position = position; + + return this._formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); } else if ( node instanceof Text ) { if ( this.singleCharacters ) { - this.position = new Position( node, 0 ); + position = new Position( node, 0 ); + this.position = position; return this._next(); } else { @@ -238,13 +242,15 @@ export default class TreeWalker { if ( node == this._boundaryEndParent ) { charactersCount = this.boundaries.end.offset; item = new TextProxy( node, 0, charactersCount ); - this.position = Position.createAfter( item ); + position = Position.createAfter( item ); } else { // If not just keep moving forward. - this.position = this.position.getShiftedBy( 1 ); + position.offset++; } - return this._formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); + this.position = position; + + return this._formatReturnValue( 'text', item, previousPosition, position, charactersCount ); } } else if ( typeof node == 'string' ) { let textLength; @@ -255,22 +261,24 @@ export default class TreeWalker { // Check if text stick out of walker range. const endOffset = parent === this._boundaryEndParent ? this.boundaries.end.offset : parent.data.length; - textLength = endOffset - this.position.offset; + textLength = endOffset - position.offset; } - const textProxy = new TextProxy( parent, this.position.offset, textLength ); + const textProxy = new TextProxy( parent, position.offset, textLength ); - this.position = this.position.getShiftedBy( textLength ); + position.offset += textLength; + this.position = position; - return this._formatReturnValue( 'text', textProxy, previousPosition, this.position, textLength ); + return this._formatReturnValue( 'text', textProxy, previousPosition, position, textLength ); } else { // `node` is not set, we reached the end of current `parent`. - this.position = Position.createAfter( parent ); + position = Position.createAfter( parent ); + this.position = position; if ( this.ignoreElementEnd ) { return this._next(); } else { - return this._formatReturnValue( 'elementEnd', parent, previousPosition, this.position ); + return this._formatReturnValue( 'elementEnd', parent, previousPosition, position ); } } } @@ -284,16 +292,17 @@ export default class TreeWalker { * @returns {module:engine/view/treewalker~TreeWalkerValue} return.value Information about taken step. */ _previous() { + let position = Position.createFromPosition( this.position ); const previousPosition = this.position; - const parent = this.position.parent; + const parent = position.parent; // We are at the beginning of the root. - if ( parent.parent === null && this.position.offset === 0 ) { + if ( parent.parent === null && position.offset === 0 ) { return { done: true }; } // We reached the walker boundary. - if ( parent == this._boundaryStartParent && this.position.offset == this.boundaries.start.offset ) { + if ( parent == this._boundaryStartParent && position.offset == this.boundaries.start.offset ) { return { done: true }; } @@ -302,35 +311,38 @@ export default class TreeWalker { // Text {@link module:engine/view/text~Text} element is a specific parent because contains string instead of child nodes. if ( parent instanceof Text ) { - if ( this.position.isAtStart ) { + if ( position.isAtStart ) { // Prevent returning "elementStart" for Text node. Skip that value and return the next walker step. this.position = Position.createBefore( parent ); return this._previous(); } - node = parent.data[ this.position.offset - 1 ]; + node = parent.data[ position.offset - 1 ]; } else { - node = parent.getChild( this.position.offset - 1 ); + node = parent.getChild( position.offset - 1 ); } if ( node instanceof Element ) { if ( !this.shallow ) { - this.position = new Position( node, node.childCount ); + position = new Position( node, node.childCount ); + this.position = position; if ( this.ignoreElementEnd ) { return this._previous(); } else { - return this._formatReturnValue( 'elementEnd', node, previousPosition, this.position ); + return this._formatReturnValue( 'elementEnd', node, previousPosition, position ); } } else { - this.position = this.position.getShiftedBy( -1 ); + position.offset--; + this.position = position; - return this._formatReturnValue( 'elementStart', node, previousPosition, this.position, 1 ); + return this._formatReturnValue( 'elementStart', node, previousPosition, position, 1 ); } } else if ( node instanceof Text ) { if ( this.singleCharacters ) { - this.position = new Position( node, node.data.length ); + position = new Position( node, node.data.length ); + this.position = position; return this._previous(); } else { @@ -343,13 +355,15 @@ export default class TreeWalker { item = new TextProxy( node, offset, node.data.length - offset ); charactersCount = item.data.length; - this.position = Position.createBefore( item ); + position = Position.createBefore( item ); } else { // If not just keep moving backward. - this.position = this.position.getShiftedBy( -1 ); + position.offset--; } - return this._formatReturnValue( 'text', item, previousPosition, this.position, charactersCount ); + this.position = position; + + return this._formatReturnValue( 'text', item, previousPosition, position, charactersCount ); } } else if ( typeof node == 'string' ) { let textLength; @@ -358,21 +372,24 @@ export default class TreeWalker { // Check if text stick out of walker range. const startOffset = parent === this._boundaryStartParent ? this.boundaries.start.offset : 0; - textLength = this.position.offset - startOffset; + textLength = position.offset - startOffset; } else { textLength = 1; } - this.position = this.position.getShiftedBy( -textLength ); + position.offset -= textLength; + + const textProxy = new TextProxy( parent, position.offset, textLength ); - const textProxy = new TextProxy( parent, this.position.offset, textLength ); + this.position = position; - return this._formatReturnValue( 'text', textProxy, previousPosition, this.position, textLength ); + return this._formatReturnValue( 'text', textProxy, previousPosition, position, textLength ); } else { // `node` is not set, we reached the beginning of current `parent`. - this.position = Position.createBefore( parent ); + position = Position.createBefore( parent ); + this.position = position; - return this._formatReturnValue( 'elementStart', parent, previousPosition, this.position, 1 ); + return this._formatReturnValue( 'elementStart', parent, previousPosition, position, 1 ); } } diff --git a/src/view/writer.js b/src/view/writer.js index 1c9fe58d1..ffbd49b07 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -305,7 +305,7 @@ export function insert( position, nodes ) { const insertionPosition = _breakAttributes( position, true ); const length = container.insertChildren( insertionPosition.offset, nodes ); - let endPosition = insertionPosition.getShiftedBy( length ); + const endPosition = insertionPosition.getShiftedBy( length ); const start = mergeAttributes( insertionPosition ); // When no nodes were inserted - return collapsed range. @@ -314,7 +314,7 @@ export function insert( position, nodes ) { } else { // If start position was merged - move end position. if ( !start.isEqual( insertionPosition ) ) { - endPosition = endPosition.getShiftedBy( -1 ); + endPosition.offset--; } const end = mergeAttributes( endPosition ); @@ -331,7 +331,8 @@ export function insert( position, nodes ) { * same parent container. * * @function module:engine/view/writer~writer.remove - * @param {module:engine/view/range~Range} range Range to remove from container. + * @param {module:engine/view/range~Range} range Range to remove from container. After removing, it will be updated + * to a collapsed range showing the new position. * @returns {module:engine/view/documentfragment~DocumentFragment} Document fragment containing removed nodes. */ export function remove( range ) { @@ -352,7 +353,9 @@ export function remove( range ) { const removed = parentContainer.removeChildren( breakStart.offset, count ); // Merge after removing. - mergeAttributes( breakStart ); + const mergePosition = mergeAttributes( breakStart ); + range.start = mergePosition; + range.end = Position.createFromPosition( mergePosition ); // Return removed nodes. return new DocumentFragment( removed ); @@ -403,20 +406,17 @@ export function clear( range, element ) { // If we have found element to remove. if ( rangeToRemove ) { - let rangeEnd = rangeToRemove.end; - let rangeStart = rangeToRemove.start; - // We need to check if element range stick out of the given range and truncate if it is. if ( rangeToRemove.end.isAfter( range.end ) ) { - rangeEnd = range.end; + rangeToRemove.end = range.end; } if ( rangeToRemove.start.isBefore( range.start ) ) { - rangeStart = range.start; + rangeToRemove.start = range.start; } // At the end we remove range with found element. - remove( new Range( rangeStart, rangeEnd ) ); + remove( rangeToRemove ); } } } @@ -447,7 +447,7 @@ export function move( sourceRange, targetPosition ) { nodes = remove( sourceRange ); - targetPosition = targetPosition.getShiftedBy( parent.childCount - countBefore ); + targetPosition.offset += ( parent.childCount - countBefore ); } else { nodes = remove( sourceRange ); } @@ -511,13 +511,10 @@ export function wrap( range, attribute ) { const start = mergeAttributes( newRange.start ); // If start position was merged - move end position back. - let rangeEnd = newRange.end; - if ( !start.isEqual( newRange.start ) ) { - rangeEnd = rangeEnd.getShiftedBy( -1 ); + newRange.end.offset--; } - - const end = mergeAttributes( rangeEnd ); + const end = mergeAttributes( newRange.end ); return new Range( start, end ); } @@ -540,7 +537,7 @@ export function wrapPosition( position, attribute ) { // Return same position when trying to wrap with attribute similar to position parent. if ( attribute.isSimilar( position.parent ) ) { - return movePositionToTextNode( position ); + return movePositionToTextNode( Position.createFromPosition( position ) ); } // When position is inside text node - break it and place new position between two text nodes. @@ -628,12 +625,10 @@ export function unwrap( range, attribute ) { const start = mergeAttributes( newRange.start ); // If start position was merged - move end position back. - let rangeEnd = newRange.end; - if ( !start.isEqual( newRange.start ) ) { - rangeEnd = rangeEnd.getShiftedBy( -1 ); + newRange.end.offset--; } - const end = mergeAttributes( rangeEnd ); + const end = mergeAttributes( newRange.end ); return new Range( start, end ); } @@ -707,12 +702,12 @@ function _breakAttributesRange( range, forceSplitText = false ) { return new Range( position, position ); } - let breakEnd = _breakAttributes( rangeEnd, forceSplitText ); + const breakEnd = _breakAttributes( rangeEnd, forceSplitText ); const count = breakEnd.parent.childCount; const breakStart = _breakAttributes( rangeStart, forceSplitText ); // Calculate new break end offset. - breakEnd = breakEnd.getShiftedBy( breakEnd.parent.childCount - count ); + breakEnd.offset += breakEnd.parent.childCount - count; return new Range( breakStart, breakEnd ); } @@ -757,12 +752,12 @@ function _breakAttributes( position, forceSplitText = false ) { // There are no attributes to break and text nodes breaking is not forced. if ( !forceSplitText && positionParent.is( 'text' ) && isContainerOrFragment( positionParent.parent ) ) { - return position; + return Position.createFromPosition( position ); } // Position's parent is container, so no attributes to break. if ( isContainerOrFragment( positionParent ) ) { - return position; + return Position.createFromPosition( position ); } // Break text and start again in new position. @@ -862,8 +857,8 @@ function unwrapChildren( parent, startOffset, endOffset, attribute ) { // Merge at each unwrap. let offsetChange = 0; - for ( let position of unwrapPositions ) { - position = position.getShiftedBy( -offsetChange ); + for ( const position of unwrapPositions ) { + position.offset -= offsetChange; // Do not merge with elements outside selected children. if ( position.offset == startOffset || position.offset == endOffset ) { @@ -923,8 +918,8 @@ function wrapChildren( parent, startOffset, endOffset, attribute ) { // Merge at each wrap. let offsetChange = 0; - for ( let position of wrapPositions ) { - position = position.getShiftedBy( -offsetChange ); + for ( const position of wrapPositions ) { + position.offset -= offsetChange; // Do not merge with elements outside selected children. if ( position.offset == startOffset ) { diff --git a/tests/model/delta/transform/_utils/utils.js b/tests/model/delta/transform/_utils/utils.js index ff23e9c00..aa7a56316 100644 --- a/tests/model/delta/transform/_utils/utils.js +++ b/tests/model/delta/transform/_utils/utils.js @@ -68,14 +68,12 @@ export function getMarkerDelta( name, oldRange, newRange, version ) { export function getMergeDelta( position, howManyInPrev, howManyInNext, version ) { const delta = new MergeDelta(); - const sourcePath = position.path.slice(); - sourcePath.push( 0 ); - const sourcePosition = new Position( position.root, sourcePath ); + const sourcePosition = Position.createFromPosition( position ); + sourcePosition.path.push( 0 ); - const targetPath = position.getShiftedBy( -1 ).path.slice(); - targetPath.push( howManyInPrev ); - - const targetPosition = new Position( position.root, targetPath ); + const targetPosition = Position.createFromPosition( position ); + targetPosition.offset--; + targetPosition.path.push( howManyInPrev ); const move = new MoveOperation( sourcePosition, howManyInNext, targetPosition, version ); move.isSticky = true; @@ -131,15 +129,12 @@ export function getRenameDelta( position, oldName, newName, baseVersion ) { export function getSplitDelta( position, nodeCopy, howManyMove, version ) { const delta = new SplitDelta(); - const insertPath = position.getParentPath(); - insertPath[ insertPath.length - 1 ]++; - - const insertPosition = new Position( position.root, insertPath ); + const insertPosition = Position.createFromPosition( position ); + insertPosition.path = insertPosition.getParentPath(); + insertPosition.offset++; - const targetPath = insertPosition.path.slice(); - targetPath.push( 0 ); - - const targetPosition = new Position( insertPosition.root, targetPath ); + const targetPosition = Position.createFromPosition( insertPosition ); + targetPosition.path.push( 0 ); delta.addOperation( new InsertOperation( insertPosition, [ nodeCopy ], version ) ); @@ -158,10 +153,8 @@ export function getWrapDelta( range, element, version ) { const insert = new InsertOperation( range.end, element, version ); - const targetPath = range.end.path.slice(); - targetPath.push( 0 ); - const targetPosition = new Position( range.end.root, targetPath ); - + const targetPosition = Position.createFromPosition( range.end ); + targetPosition.path.push( 0 ); const move = new MoveOperation( range.start, range.end.offset - range.start.offset, targetPosition, version + 1 ); delta.addOperation( insert ); @@ -175,14 +168,14 @@ export function getWrapDelta( range, element, version ) { export function getUnwrapDelta( positionBefore, howManyChildren, version ) { const delta = new UnwrapDelta(); - const sourcePath = positionBefore.path.slice(); - sourcePath.push( 0 ); - const sourcePosition = new Position( positionBefore.root, sourcePath ); + const sourcePosition = Position.createFromPosition( positionBefore ); + sourcePosition.path.push( 0 ); const move = new MoveOperation( sourcePosition, howManyChildren, positionBefore, version ); move.isSticky = true; - const removePosition = positionBefore.getShiftedBy( howManyChildren ); + const removePosition = Position.createFromPosition( positionBefore ); + removePosition.offset += howManyChildren; const gy = sourcePosition.root.document.graveyard; const gyPos = Position.createAt( gy, 0 ); diff --git a/tests/model/delta/transform/movedelta.js b/tests/model/delta/transform/movedelta.js index bdfa82edc..b5134f77e 100644 --- a/tests/model/delta/transform/movedelta.js +++ b/tests/model/delta/transform/movedelta.js @@ -135,8 +135,8 @@ describe( 'transform', () => { } ); it( 'move range in merged node #2', () => { - moveDelta._moveOperation.sourcePosition = new Position( root, [ 3, 3, 1 ] ); - moveDelta._moveOperation.targetPosition = new Position( root, [ 3, 3, 4 ] ); + moveDelta._moveOperation.sourcePosition.path = [ 3, 3, 1 ]; + moveDelta._moveOperation.targetPosition.path = [ 3, 3, 4 ]; const mergePosition = new Position( root, [ 3, 3 ] ); const mergeDelta = getMergeDelta( mergePosition, 1, 4, baseVersion ); diff --git a/tests/model/delta/transform/splitdelta.js b/tests/model/delta/transform/splitdelta.js index 7d16555f2..0b3cfc0fd 100644 --- a/tests/model/delta/transform/splitdelta.js +++ b/tests/model/delta/transform/splitdelta.js @@ -6,7 +6,6 @@ import transformations from '../../../../src/model/delta/basic-transformations'; // eslint-disable-line no-unused-vars import deltaTransform from '../../../../src/model/delta/transform'; - const transform = deltaTransform.transform; import Element from '../../../../src/model/element'; @@ -968,15 +967,10 @@ describe( 'transform', () => { baseVersion = removeDelta.operations.length; const newInsertPosition = removeOperation.targetPosition.getShiftedBy( 2 ); - - const newSourcePath = removeOperation.targetPosition.getShiftedBy( 1 ).path.slice(); - newSourcePath.push( 2 ); - const newMoveSourcePosition = new Position( removeOperation.targetPosition.root, newSourcePath ); - - const newMoveTargetPath = newInsertPosition.path.slice(); - newMoveTargetPath.push( 0 ); - - const newMoveTargetPosition = new Position( newInsertPosition.root, newMoveTargetPath ); + const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ); + newMoveSourcePosition.path.push( 2 ); + const newMoveTargetPosition = Position.createAt( newInsertPosition ); + newMoveTargetPosition.path.push( 0 ); expectDelta( transformed[ 0 ], { type: SplitDelta, @@ -1009,13 +1003,10 @@ describe( 'transform', () => { baseVersion = removeDelta.operations.length; const newInsertPosition = removeOperation.targetPosition.getShiftedBy( 2 ); - const newMoveSourcePath = removeOperation.targetPosition.getShiftedBy( 1 ).path.slice(); - newMoveSourcePath.push( 3 ); - const newMoveSourcePosition = new Position( removeOperation.targetPosition.root, newMoveSourcePath ); - - const newMoveTargetPath = newInsertPosition.path.slice(); - newMoveTargetPath.push( 0 ); - const newMoveTargetPosition = new Position( newInsertPosition.root, newMoveTargetPath ); + const newMoveSourcePosition = removeOperation.targetPosition.getShiftedBy( 1 ); + newMoveSourcePosition.path.push( 3 ); + const newMoveTargetPosition = Position.createAt( newInsertPosition ); + newMoveTargetPosition.path.push( 0 ); expectDelta( transformed[ 0 ], { type: SplitDelta, diff --git a/tests/model/liverange.js b/tests/model/liverange.js index 1780c368d..15fac530b 100644 --- a/tests/model/liverange.js +++ b/tests/model/liverange.js @@ -208,9 +208,7 @@ describe( 'LiveRange', () => { } ); it( 'is at the live range start position and live range is collapsed', () => { - live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 4 ] ) ); - spy = sinon.spy(); - live.on( 'change:range', spy ); + live.end.path = [ 0, 1, 4 ]; const insertRange = new Range( new Position( root, [ 0, 1, 4 ] ), new Position( root, [ 0, 1, 8 ] ) ); @@ -374,9 +372,7 @@ describe( 'LiveRange', () => { } ); it( 'is equal to live range', () => { - live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 7 ] ) ); - spy = sinon.spy(); - live.on( 'change:range', spy ); + live.end.path = [ 0, 1, 7 ]; const moveSource = new Position( root, [ 0, 1, 4 ] ); const moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 3 ] ) ); @@ -393,9 +389,7 @@ describe( 'LiveRange', () => { } ); it( 'contains live range', () => { - live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 7 ] ) ); - spy = sinon.spy(); - live.on( 'change:range', spy ); + live.end.path = [ 0, 1, 7 ]; const moveSource = new Position( root, [ 0, 1, 3 ] ); const moveRange = new Range( new Position( root, [ 0, 3, 0 ] ), new Position( root, [ 0, 3, 9 ] ) ); @@ -412,9 +406,7 @@ describe( 'LiveRange', () => { } ); it( 'is intersecting with live range and points to live range', () => { - live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 12 ] ) ); - spy = sinon.spy(); - live.on( 'change:range', spy ); + live.end.path = [ 0, 1, 12 ]; const moveSource = new Position( root, [ 0, 1, 2 ] ); const moveRange = new Range( new Position( root, [ 0, 1, 7 ] ), new Position( root, [ 0, 1, 10 ] ) ); @@ -664,9 +656,7 @@ describe( 'LiveRange', () => { } ); it( 'from the range to the range', () => { - live = new LiveRange( live.start, new Position( live.end.root, [ 0, 1, 12 ] ) ); - spy = sinon.spy(); - live.on( 'change:content', spy ); + live.end.path = [ 0, 1, 12 ]; const moveSource = new Position( root, [ 0, 1, 6 ] ); const moveRange = new Range( new Position( root, [ 0, 1, 8 ] ), new Position( root, [ 0, 1, 10 ] ) ); diff --git a/tests/model/operation/transform.js b/tests/model/operation/transform.js index ebf3bc455..a53a1671e 100644 --- a/tests/model/operation/transform.js +++ b/tests/model/operation/transform.js @@ -38,7 +38,8 @@ describe( 'transform', () => { if ( params.hasOwnProperty( i ) ) { if ( i == 'type' ) { expect( op, 'type' ).to.be.instanceof( params[ i ] ); - } else if ( params[ i ] instanceof Array ) { + } + else if ( params[ i ] instanceof Array ) { expect( op[ i ].length, i ).to.equal( params[ i ].length ); for ( let j = 0; j < params[ i ].length; j++ ) { @@ -53,14 +54,6 @@ describe( 'transform', () => { } } - function getPositionMovedInPath( position, index, howMany ) { - const path = position.path.slice(); - - path[ index ] += howMany; - - return new Position( position.root, path ); - } - describe( 'InsertOperation', () => { let nodeC, nodeD, position; @@ -101,7 +94,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = expected.position.getShiftedBy( 2 ); + expected.position.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -115,7 +108,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = expected.position.getShiftedBy( 2 ); + expected.position.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -155,7 +148,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = expected.position.getShiftedBy( 2 ); + expected.position.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -182,7 +175,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = getPositionMovedInPath( expected.position, 1, 2 ); + expected.position.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -260,7 +253,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = expected.position.getShiftedBy( -1 ); + expected.position.offset--; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -289,7 +282,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = expected.position.getShiftedBy( 2 ); + expected.position.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -318,7 +311,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = expected.position.getShiftedBy( 2 ); + expected.position.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -347,7 +340,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy, { isStrong: true, insertBefore: true } ); - expected.position = expected.position.getShiftedBy( 2 ); + expected.position.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -376,7 +369,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = getPositionMovedInPath( expected.position, 1, -1 ); + expected.position.path[ 1 ] -= 1; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -405,7 +398,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = getPositionMovedInPath( expected.position, 1, 2 ); + expected.position.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -434,7 +427,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = new Position( expected.position.root, [ 1, 2, 2 ] ); + expected.position.path = [ 1, 2, 2 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -449,7 +442,7 @@ describe( 'transform', () => { ); const transOp = transform( op, transformBy ); - expected.position = new Position( expected.position.root, [ 1, 2 ] ); + expected.position.path = [ 1, 2 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -539,10 +532,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( 2 ), - expected.range.end - ); + expected.range.start.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -557,10 +547,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( 2 ), - expected.range.end - ); + expected.range.start.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -588,10 +575,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - getPositionMovedInPath( expected.range.start, 0, 2 ), - getPositionMovedInPath( expected.range.end, 0, 2 ) - ); + expected.range.start.path[ 0 ] += 2; + expected.range.end.path[ 0 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -621,17 +606,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 3, 3 ] ), - expected.range.end - ); + expected.range.start.path = [ 1, 3, 3 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - op.range.start, - new Position( expected.range.end.root, [ 1, 3, 1 ] ) - ); + expected.range.start = op.range.start; + expected.range.end.path = [ 1, 3, 1 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -743,18 +723,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start, - new Position( expected.range.end.root, [ 1, 4, 2 ] ) - ); + expected.range.end.path = [ 1, 4, 2 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 4, 2 ] ), - op.range.end - ); - + expected.range.start.path = [ 1, 4, 2 ]; + expected.range.end = op.range.end; expected.oldValue = 'another'; expected.baseVersion++; @@ -775,17 +749,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 1 ] ), - expected.range.end - ); + expected.range.start.path = [ 2, 1 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - op.range.start, - new Position( expected.range.end.root, [ 2, 1 ] ) - ); + expected.range.start = op.range.start; + expected.range.end.path = [ 2, 1 ]; expected.oldValue = null; expected.baseVersion++; @@ -805,26 +774,18 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range = new Range( - expected.range.start, - new Position( expected.range.end.root, [ 1, 4, 1 ] ) - ); + expected.range.end.path = [ 1, 4, 1 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 1 ] ), - op.range.end - ); + expected.range.start.path = [ 2, 1 ]; + expected.range.end = op.range.end; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 4, 1 ] ), - new Position( expected.range.end.root, [ 2, 1 ] ) - ); - + expected.range.start.path = [ 1, 4, 1 ]; + expected.range.end.path = [ 2, 1 ]; expected.oldValue = null; expected.baseVersion++; @@ -899,10 +860,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start, - new Position( expected.range.end.root, [ 1, 4, 2 ] ) - ); + expected.range.end.path = [ 1, 4, 2 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -920,10 +878,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 1 ] ), - expected.range.end - ); + expected.range.start.path = [ 2, 1 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -942,17 +897,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start, - new Position( expected.range.end.root, [ 1, 4, 1 ] ) - ); + expected.range.end.path = [ 1, 4, 1 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 1 ] ), - op.range.end - ); + expected.range.start.path = [ 2, 1 ]; + expected.range.end = op.range.end; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1002,10 +952,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( -2 ), - expected.range.end - ); + expected.range.start.offset -= 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1021,10 +968,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( 2 ), - expected.range.end - ); + expected.range.start.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1040,10 +984,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - getPositionMovedInPath( expected.range.start, 0, -1 ), - getPositionMovedInPath( expected.range.end, 0, -1 ) - ); + expected.range.start.path[ 0 ]--; + expected.range.end.path[ 0 ]--; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1073,10 +1015,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - getPositionMovedInPath( expected.range.start, 1, 2 ), - expected.range.end - ); + expected.range.start.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1108,17 +1047,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start, - new Position( expected.range.end.root, [ 2, 1 ] ) - ); + expected.range.end.path = [ 2, 1 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 4 ] ), - new Position( expected.range.end.root, [ 5, 4 ] ) - ); + expected.range.start.path = [ 4 ]; + expected.range.end.path = [ 5, 4 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1136,17 +1070,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 1 ] ), - expected.range.end - ); + expected.range.start.path = [ 1, 1 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 0, 1 ] ), - new Position( expected.range.end.root, [ 0, 3 ] ) - ); + expected.range.start.path = [ 0, 1 ]; + expected.range.end.path = [ 0, 3 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1162,10 +1091,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 4, 1, 2 ] ), - new Position( expected.range.end.root, [ 1, 4, 2, 2, 4 ] ) - ); + expected.range.start.path = [ 1, 4, 1, 2 ]; + expected.range.end.path = [ 1, 4, 2, 2, 4 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1185,10 +1112,8 @@ describe( 'transform', () => { expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 3, 2 ] ), - new Position( expected.range.end.root, [ 3, 4 ] ) - ); + expected.range.start.path = [ 3, 2 ]; + expected.range.end.path = [ 3, 4 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1206,17 +1131,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 6 ] ), - expected.range.end - ); + expected.range.start.path = [ 1, 6 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - op.range.start, - new Position( expected.range.end.root, [ 1, 4 ] ) - ); + expected.range.start = op.range.start; + expected.range.end.path = [ 1, 4 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1234,25 +1154,19 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range = new Range( - new Position( expected.range.start.root, [ 5 ] ), - new Position( expected.range.end.root, [ 5, 2, 4 ] ) - ); + expected.range.start.path = [ 5 ]; + expected.range.end.path = [ 5, 2, 4 ]; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 1, 1 ] ), - new Position( expected.range.end.root, [ 2 ] ) - ); + expected.range.start.path = [ 1, 1 ]; + expected.range.end.path = [ 2 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 3 ] ), - new Position( expected.range.end.root, [ 5 ] ) - ); + expected.range.start.path = [ 3 ]; + expected.range.end.path = [ 5 ]; expected.baseVersion++; expectOperation( transOp[ 2 ], expected ); @@ -1320,10 +1234,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( 2 ), - expected.range.end.getShiftedBy( 2 ) - ); + expected.range.start.offset += 2; + expected.range.end.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1338,10 +1250,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( 2 ), - expected.range.end.getShiftedBy( 2 ) - ); + expected.range.start.offset += 2; + expected.range.end.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1359,10 +1269,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( -1 ), - expected.range.end.getShiftedBy( -1 ) - ); + expected.range.start.offset--; + expected.range.end.offset--; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1378,10 +1286,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - expected.range.start.getShiftedBy( 2 ), - expected.range.end.getShiftedBy( 2 ) - ); + expected.range.start.offset += 2; + expected.range.end.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1399,17 +1305,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start, - expected.range.end.getShiftedBy( -2 ) - ); + expected.range.end.offset -= 2; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 4, 1 ] ), - new Position( expected.range.end.root, [ 2, 4, 3 ] ) - ); + expected.range.start.path = [ 2, 4, 1 ]; + expected.range.end.path = [ 2, 4, 3 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1427,17 +1328,13 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start.getShiftedBy( -1 ), - expected.range.end.getShiftedBy( -2 ) - ); + expected.range.start.offset -= 1; + expected.range.end.offset -= 2; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 4, 2 ] ), - new Position( expected.range.end.root, [ 2, 4, 3 ] ) - ); + expected.range.start.path = [ 2, 4, 2 ]; + expected.range.end.path = [ 2, 4, 3 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1453,10 +1350,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 4, 2, 1 ] ), - new Position( expected.range.end.root, [ 2, 4, 2, 4 ] ) - ); + expected.range.start.path = [ 2, 4, 2, 1 ]; + expected.range.end.path = [ 2, 4, 2, 4 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1474,17 +1369,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start, - expected.range.end.getShiftedBy( -1 ) - ); + expected.range.end.offset--; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 4, 1 ] ), - new Position( expected.range.end.root, [ 2, 4, 2 ] ) - ); + expected.range.start.path = [ 2, 4, 1 ]; + expected.range.end.path = [ 2, 4, 2 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1500,10 +1390,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.range = new Range( - new Position( expected.range.start.root, [ 2, 4, 1 ] ), - new Position( expected.range.end.root, [ 2, 4, 4 ] ) - ); + expected.range.start.path = [ 2, 4, 1 ]; + expected.range.end.path = [ 2, 4, 4 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1521,17 +1409,13 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.range = new Range( - expected.range.start.getShiftedTo( 4 ), - expected.range.end.getShiftedTo( 6 ) - ); + expected.range.start.offset = 4; + expected.range.end.offset = 6; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - expected.range.start.getShiftedTo( op.range.start.offset ), - expected.range.end.getShiftedTo( 2 ) - ); + expected.range.start.offset = op.range.start.offset; + expected.range.end.offset = 2; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -1549,25 +1433,19 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.range = new Range( - expected.range.start.getShiftedTo( 3 ), - expected.range.end.getShiftedTo( 4 ) - ); + expected.range.start.offset = 3; + expected.range.end.offset = 4; expectOperation( transOp[ 0 ], expected ); - expected.range = new Range( - expected.range.start.getShiftedTo( 0 ), - expected.range.end.getShiftedTo( 1 ) - ); + expected.range.start.offset = 0; + expected.range.end.offset = 1; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.range = new Range( - expected.range.start.getShiftedTo( 2 ), - expected.range.end.getShiftedTo( 3 ) - ); + expected.range.start.offset = 2; + expected.range.end.offset = 3; expected.baseVersion++; expectOperation( transOp[ 2 ], expected ); @@ -1595,16 +1473,14 @@ describe( 'transform', () => { baseVersion ); - transformBy.targetPosition = new Position( transformBy.targetPosition.root, [ 0 ] ); + transformBy.targetPosition.path = [ 0 ]; const transOp = transform( op, transformBy ); expect( transOp.length ).to.equal( 1 ); - expected.range = new Range( - new Position( expected.range.start.root, [ 4, 0 ] ), - new Position( expected.range.end.root, [ 4, 4 ] ) - ); + expected.range.start.path = [ 4, 0 ]; + expected.range.end.path = [ 4, 4 ]; expectOperation( transOp[ 0 ], expected ); } ); @@ -1617,7 +1493,7 @@ describe( 'transform', () => { baseVersion ); - transformBy.targetPosition = new Position( transformBy.targetPosition.root, [ 4 ] ); + transformBy.targetPosition.path = [ 4 ]; const transOp = transform( op, transformBy ); @@ -1820,7 +1696,8 @@ describe( 'transform', () => { targetPosition = new Position( root, [ 3, 3, 3 ] ); howMany = 2; - rangeEnd = sourcePosition.getShiftedBy( howMany ); + rangeEnd = Position.createFromPosition( sourcePosition ); + rangeEnd.offset += howMany; op = new MoveOperation( sourcePosition, howMany, targetPosition, baseVersion ); @@ -1869,7 +1746,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = expected.sourcePosition.getShiftedBy( 2 ); + expected.sourcePosition.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1897,7 +1774,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = getPositionMovedInPath( expected.sourcePosition, 1, 2 ); + expected.sourcePosition.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1925,7 +1802,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); + expected.targetPosition.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1953,7 +1830,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = getPositionMovedInPath( expected.targetPosition, 1, 2 ); + expected.targetPosition.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -1981,7 +1858,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); + expected.targetPosition.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2009,7 +1886,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy, { isStrong: true, insertBefore: true } ); - expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); + expected.targetPosition.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2134,7 +2011,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = expected.sourcePosition.getShiftedBy( 2 ); + expected.sourcePosition.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2164,7 +2041,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = expected.sourcePosition.getShiftedBy( -2 ); + expected.sourcePosition.offset -= 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2194,7 +2071,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = getPositionMovedInPath( expected.sourcePosition, 1, 2 ); + expected.sourcePosition.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2224,7 +2101,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = getPositionMovedInPath( expected.sourcePosition, 1, -1 ); + expected.sourcePosition.path[ 1 ] -= 1; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2254,7 +2131,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = expected.targetPosition.getShiftedBy( 2 ); + expected.targetPosition.offset += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2284,7 +2161,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = expected.targetPosition.getShiftedBy( -2 ); + expected.targetPosition.offset -= 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2314,7 +2191,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = getPositionMovedInPath( expected.targetPosition, 1, 2 ); + expected.targetPosition.path[ 1 ] += 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2344,7 +2221,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = getPositionMovedInPath( expected.targetPosition, 1, -2 ); + expected.targetPosition.path[ 1 ] -= 2; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2379,7 +2256,7 @@ describe( 'transform', () => { expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 6 ] ); + expected.sourcePosition.path = [ 2, 2, 6 ]; expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); @@ -2397,7 +2274,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition = expected.sourcePosition.getShiftedTo( 6 ); + expected.sourcePosition.offset = 6; expectOperation( transOp[ 0 ], expected ); } ); @@ -2478,7 +2355,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 3, 4 ] ); + expected.sourcePosition.path = [ 4, 3, 4 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2494,7 +2371,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.targetPosition = new Position( expected.targetPosition.root, [ 0, 2, 3 ] ); + expected.targetPosition.path = [ 0, 2, 3 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2546,7 +2423,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy, { isStrong: true } ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 0 ] ); + expected.sourcePosition.path = [ 4, 1, 0 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -2579,14 +2456,14 @@ describe( 'transform', () => { const transOp = transform( op, transformBy, { isStrong: true } ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 1 ] ); + expected.sourcePosition.path = [ 4, 1, 1 ]; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); } ); it( 'range contains transforming range and target and is important: update range path and target', () => { - op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); + op.targetPosition.path = [ 2, 2, 7 ]; const transformBy = new MoveOperation( new Position( root, [ 2, 2, 3 ] ), @@ -2599,14 +2476,14 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 1 ] ); - expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 4 ] ); + expected.sourcePosition.path = [ 4, 1, 1 ]; + expected.targetPosition.path = [ 4, 1, 4 ]; expectOperation( transOp[ 0 ], expected ); } ); it( 'range contains transforming range and target and is less important: update range path and target', () => { - op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); + op.targetPosition.path = [ 2, 2, 7 ]; const transformBy = new MoveOperation( new Position( root, [ 2, 2, 3 ] ), @@ -2619,8 +2496,8 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 1 ] ); - expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 4 ] ); + expected.sourcePosition.path = [ 4, 1, 1 ]; + expected.targetPosition.path = [ 4, 1, 4 ]; expectOperation( transOp[ 0 ], expected ); } ); @@ -2635,7 +2512,7 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 3 ] ); + expected.sourcePosition.path = [ 2, 2, 3 ]; expected.howMany = 1; expect( transOp.length ).to.equal( 1 ); @@ -2723,12 +2600,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 3 ] ); + expected.sourcePosition.path = [ 2, 2, 3 ]; expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 5 ] ); + expected.sourcePosition.path = [ 2, 2, 5 ]; expected.howMany = 2; expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.baseVersion++; @@ -2750,12 +2627,12 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 3 ] ); + expected.sourcePosition.path = [ 2, 2, 3 ]; expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 5 ] ); + expected.sourcePosition.path = [ 2, 2, 5 ]; expected.howMany = 2; expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.baseVersion++; @@ -2804,7 +2681,7 @@ describe( 'transform', () => { } ); it( 'range intersects, target inside transforming range and is important: split into two operations', () => { - op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); + op.targetPosition.path = [ 2, 2, 7 ]; const transformBy = new MoveOperation( new Position( root, [ 2, 2, 5 ] ), @@ -2817,21 +2694,21 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); - expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 2 ] ); + expected.sourcePosition.path = [ 2, 2, 4 ]; + expected.targetPosition.path = [ 4, 1, 2 ]; expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 0 ] ); - expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 3 ] ); + expected.sourcePosition.path = [ 4, 1, 0 ]; + expected.targetPosition.path = [ 4, 1, 3 ]; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); } ); it( 'range intersects, target inside transforming range and is less important: shrink range', () => { - op.targetPosition = new Position( op.targetPosition.root, [ 2, 2, 7 ] ); + op.targetPosition.path = [ 2, 2, 7 ]; const transformBy = new MoveOperation( new Position( root, [ 2, 2, 5 ] ), @@ -2844,8 +2721,8 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); - expected.targetPosition = new Position( expected.targetPosition.root, [ 4, 1, 2 ] ); + expected.sourcePosition.path = [ 2, 2, 4 ]; + expected.targetPosition.path = [ 4, 1, 2 ]; expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); @@ -2865,7 +2742,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 2 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); + expected.sourcePosition.path = [ 2, 2, 4 ]; expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); @@ -2890,19 +2767,19 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 3 ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); + expected.sourcePosition.path = [ 2, 2, 4 ]; expected.howMany = 1; expectOperation( transOp[ 0 ], expected ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 4, 1, 0 ] ); + expected.sourcePosition.path = [ 4, 1, 0 ]; expected.targetPosition = targetPosition.getShiftedBy( 1 ); expected.howMany = 2; expected.baseVersion++; expectOperation( transOp[ 1 ], expected ); - expected.sourcePosition = new Position( expected.sourcePosition.root, [ 2, 2, 4 ] ); + expected.sourcePosition.path = [ 2, 2, 4 ]; expected.targetPosition = targetPosition.getShiftedBy( 3 ); expected.howMany = 1; expected.baseVersion++; @@ -3183,7 +3060,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = expected.position.getShiftedTo( 4 ); + expected.position.offset = 4; expectOperation( transOp[ 0 ], expected ); } ); @@ -3212,7 +3089,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = new Position( expected.position.root, [ 0, 4, 2 ] ); + expected.position.path = [ 0, 4, 2 ]; expectOperation( transOp[ 0 ], expected ); } ); @@ -3342,7 +3219,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = expected.position.getShiftedTo( 0 ); + expected.position.offset = 0; expectOperation( transOp[ 0 ], expected ); } ); @@ -3359,7 +3236,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = new Position( expected.position.root, [ 0, 0, 2 ] ); + expected.position.path = [ 0, 0, 2 ]; expectOperation( transOp[ 0 ], expected ); } ); @@ -3376,7 +3253,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = new Position( expected.position.root, [ 2, 6 ] ); + expected.position.path = [ 2, 6 ]; expectOperation( transOp[ 0 ], expected ); } ); @@ -3393,7 +3270,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = new Position( expected.position.root, [ 2, 6, 2 ] ); + expected.position.path = [ 2, 6, 2 ]; expectOperation( transOp[ 0 ], expected ); } ); @@ -3410,7 +3287,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = expected.position.getShiftedTo( 4 ); + expected.position.offset = 4; expectOperation( transOp[ 0 ], expected ); } ); @@ -3427,7 +3304,7 @@ describe( 'transform', () => { expect( transOp.length ).to.equal( 1 ); - expected.position = expected.position.getShiftedTo( 0 ); + expected.position.offset = 0; expectOperation( transOp[ 0 ], expected ); } ); @@ -3459,10 +3336,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.newRange = null; - expected.oldRange = new Range( - expected.oldRange.start.getShiftedTo( 3 ), - expected.oldRange.end.getShiftedTo( 6 ) - ); + expected.oldRange.start.offset = 3; + expected.oldRange.end.offset = 6; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3476,10 +3351,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.oldRange = null; - expected.newRange = new Range( - expected.newRange.start.getShiftedTo( 12 ), - expected.newRange.end.getShiftedTo( 14 ) - ); + expected.newRange.start.offset = 12; + expected.newRange.end.offset = 14; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3515,10 +3388,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.newRange = null; - expected.oldRange = new Range( - expected.oldRange.start.getShiftedTo( 0 ), - expected.oldRange.end.getShiftedTo( 3 ) - ); + expected.oldRange.start.offset = 0; + expected.oldRange.end.offset = 3; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3528,14 +3399,10 @@ describe( 'transform', () => { const transformBy = new MoveOperation( Position.createAt( root, 2 ), 2, Position.createAt( root, 20 ), baseVersion ); const transOp = transform( op, transformBy ); - expected.oldRange = new Range( - expected.oldRange.start.getShiftedTo( 1 ), - expected.oldRange.end.getShiftedTo( 2 ) - ); - expected.newRange = new Range( - expected.newRange.start.getShiftedTo( 8 ), - expected.newRange.end.getShiftedTo( 10 ) - ); + expected.oldRange.start.offset = 1; + expected.oldRange.end.offset = 2; + expected.newRange.start.offset = 8; + expected.newRange.end.offset = 10; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3549,10 +3416,8 @@ describe( 'transform', () => { const transOp = transform( op, transformBy ); expected.oldRange = null; - expected.newRange = new Range( - expected.newRange.start.getShiftedTo( 10 ), - expected.newRange.end.getShiftedTo( 14 ) - ); + expected.newRange.start.offset = 10; + expected.newRange.end.offset = 14; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); @@ -3562,14 +3427,10 @@ describe( 'transform', () => { const transformBy = new MoveOperation( Position.createAt( root, 20 ), 4, Position.createAt( root, 2 ), baseVersion ); const transOp = transform( op, transformBy ); - expected.oldRange = new Range( - expected.oldRange.start.getShiftedTo( 1 ), - expected.oldRange.end.getShiftedTo( 8 ) - ); - expected.newRange = new Range( - expected.newRange.start.getShiftedTo( 14 ), - expected.newRange.end.getShiftedTo( 16 ) - ); + expected.oldRange.start.offset = 1; + expected.oldRange.end.offset = 8; + expected.newRange.start.offset = 14; + expected.newRange.end.offset = 16; expect( transOp.length ).to.equal( 1 ); expectOperation( transOp[ 0 ], expected ); diff --git a/tests/model/position.js b/tests/model/position.js index 0424b3e8f..1b5a23eb5 100644 --- a/tests/model/position.js +++ b/tests/model/position.js @@ -291,6 +291,14 @@ describe( 'Position', () => { expect( new Position( root, [ 1, 0, 3 ] ) ).to.have.property( 'index' ).that.equals( 1 ); } ); + it( 'should be able to set offset', () => { + const position = new Position( root, [ 1, 0, 2 ] ); + position.offset = 4; + + expect( position.offset ).to.equal( 4 ); + expect( position.path ).to.deep.equal( [ 1, 0, 4 ] ); + } ); + it( 'should have nodeBefore if it is not inside a text node', () => { expect( new Position( root, [ 0 ] ).nodeBefore ).to.be.null; expect( new Position( root, [ 1 ] ).nodeBefore ).to.equal( p ); @@ -597,6 +605,14 @@ describe( 'Position', () => { } ); describe( '_getTransformedByInsertion()', () => { + it( 'should return a new Position instance', () => { + const position = new Position( root, [ 0 ] ); + const transformed = position._getTransformedByInsertion( new Position( root, [ 2 ] ), 4, false ); + + expect( transformed ).not.to.equal( position ); + expect( transformed ).to.be.instanceof( Position ); + } ); + it( 'should increment offset if insertion is in the same parent and closer offset', () => { const position = new Position( root, [ 1, 2, 3 ] ); const transformed = position._getTransformedByInsertion( new Position( root, [ 1, 2, 2 ] ), 2, false ); @@ -649,6 +665,14 @@ describe( 'Position', () => { } ); describe( '_getTransformedByDeletion()', () => { + it( 'should return a new Position instance', () => { + const position = new Position( root, [ 0 ] ); + const transformed = position._getTransformedByDeletion( new Position( root, [ 2 ] ), 4 ); + + expect( transformed ).not.to.equal( position ); + expect( transformed ).to.be.instanceof( Position ); + } ); + it( 'should return null if original position is inside one of removed nodes', () => { const position = new Position( root, [ 1, 2 ] ); const transformed = position._getTransformedByDeletion( new Position( root, [ 0 ] ), 2 ); diff --git a/tests/model/range.js b/tests/model/range.js index d32d86aca..adf1bb9c2 100644 --- a/tests/model/range.js +++ b/tests/model/range.js @@ -855,8 +855,7 @@ describe( 'Range', () => { } ); it( 'move inside the range', () => { - range = new Range( range.start, range.end.getShiftedTo( 6 ) ); - + range.end.offset = 6; const start = new Position( root, [ 3 ] ); const target = new Position( root, [ 5 ] ); const delta = getMoveDelta( start, 1, target, 1 ); @@ -978,10 +977,8 @@ describe( 'Range', () => { describe( 'by SplitDelta', () => { it( 'split inside range', () => { - range = new Range( - new Position( root, [ 0, 2 ] ), - new Position( root, [ 0, 4 ] ) - ); + range.start = new Position( root, [ 0, 2 ] ); + range.end = new Position( root, [ 0, 4 ] ); const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 ); @@ -993,10 +990,8 @@ describe( 'Range', () => { } ); it( 'split at the beginning of multi-element range', () => { - range = new Range( - new Position( root, [ 0, 4 ] ), - new Position( root, [ 1, 2 ] ) - ); + range.start = new Position( root, [ 0, 4 ] ); + range.end = new Position( root, [ 1, 2 ] ); const delta = getSplitDelta( new Position( root, [ 0, 4 ] ), new Element( 'p' ), 3, 1 ); @@ -1008,10 +1003,8 @@ describe( 'Range', () => { } ); it( 'split inside range which starts at the beginning of split element', () => { - range = new Range( - new Position( root, [ 0, 0 ] ), - new Position( root, [ 0, 4 ] ) - ); + range.start = new Position( root, [ 0, 0 ] ); + range.end = new Position( root, [ 0, 4 ] ); const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 ); @@ -1023,10 +1016,8 @@ describe( 'Range', () => { } ); it( 'split inside range which end is at the end of split element', () => { - range = new Range( - new Position( root, [ 0, 3 ] ), - new Position( root, [ 0, 6 ] ) - ); + range.start = new Position( root, [ 0, 3 ] ); + range.end = new Position( root, [ 0, 6 ] ); const delta = getSplitDelta( new Position( root, [ 0, 4 ] ), new Element( 'p' ), 2, 1 ); @@ -1038,10 +1029,8 @@ describe( 'Range', () => { } ); it( 'split element which has collapsed range at the end', () => { - range = new Range( - new Position( root, [ 0, 6 ] ), - new Position( root, [ 0, 6 ] ) - ); + range.start = new Position( root, [ 0, 6 ] ); + range.end = new Position( root, [ 0, 6 ] ); const delta = getSplitDelta( new Position( root, [ 0, 3 ] ), new Element( 'p' ), 3, 1 ); @@ -1055,10 +1044,8 @@ describe( 'Range', () => { describe( 'by MergeDelta', () => { it( 'merge element with collapsed range', () => { - range = new Range( - new Position( root, [ 1, 0 ] ), - new Position( root, [ 1, 0 ] ) - ); + range.start = new Position( root, [ 1, 0 ] ); + range.end = new Position( root, [ 1, 0 ] ); const delta = getMergeDelta( new Position( root, [ 1 ] ), 3, 3, 1 ); @@ -1119,10 +1106,8 @@ describe( 'Range', () => { describe( 'by WrapDelta', () => { it( 'maintans start position when wrapping element in which the range starts and ends', () => { //

f[o]o

bar

- range = new Range( - new Position( root, [ 0, 1 ] ), - new Position( root, [ 0, 2 ] ) - ); + range.start = new Position( root, [ 0, 1 ] ); + range.end = new Position( root, [ 0, 2 ] ); const wrapRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ); const wrapElement = new Element( 'w' ); @@ -1138,10 +1123,8 @@ describe( 'Range', () => { it( 'maintans start position when wrapping element in which the range starts but not ends', () => { //

f[oo

b]ar

- range = new Range( - new Position( root, [ 0, 1 ] ), - new Position( root, [ 1, 1 ] ) - ); + range.start = new Position( root, [ 0, 1 ] ); + range.end = new Position( root, [ 1, 1 ] ); const wrapRange = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ); const wrapElement = new Element( 'w' ); @@ -1157,10 +1140,8 @@ describe( 'Range', () => { it( 'maintans end position when wrapping element in which the range ends but not starts', () => { //

f[oo

b]ar

- range = new Range( - new Position( root, [ 0, 1 ] ), - new Position( root, [ 1, 1 ] ) - ); + range.start = new Position( root, [ 0, 1 ] ); + range.end = new Position( root, [ 1, 1 ] ); const wrapRange = new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) ); const wrapElement = new Element( 'w' ); @@ -1178,10 +1159,8 @@ describe( 'Range', () => { describe( 'by UnwrapDelta', () => { it( 'maintans start position when wrapping element in which the range starts and ends', () => { //

f[o]o

bar

- range = new Range( - new Position( root, [ 0, 0, 1 ] ), - new Position( root, [ 0, 0, 2 ] ) - ); + range.start = new Position( root, [ 0, 0, 1 ] ); + range.end = new Position( root, [ 0, 0, 2 ] ); const unwrapPosition = new Position( root, [ 0 ] ); const delta = getUnwrapDelta( unwrapPosition, 1, 1 ); @@ -1196,10 +1175,8 @@ describe( 'Range', () => { it( 'maintans start position when wrapping element in which the range starts but not ends', () => { //

f[oo

b]ar

- range = new Range( - new Position( root, [ 0, 0, 1 ] ), - new Position( root, [ 1, 1 ] ) - ); + range.start = new Position( root, [ 0, 0, 1 ] ); + range.end = new Position( root, [ 1, 1 ] ); const unwrapPosition = new Position( root, [ 0 ] ); const delta = getUnwrapDelta( unwrapPosition, 1, 1 ); @@ -1217,10 +1194,8 @@ describe( 'Range', () => { it( 'maintans end position when wrapping element in which the range ends but not starts', () => { //

f[oo

b]ar

 - range = new Range( - new Position( root, [ 0, 1 ] ), - new Position( root, [ 1, 0, 1 ] ) - ); + range.start = new Position( root, [ 0, 1 ] ); + range.end = new Position( root, [ 1, 0, 1 ] ); const unwrapPosition = new Position( root, [ 1 ] ); const delta = getUnwrapDelta( unwrapPosition, 1, 1 ); diff --git a/tests/view/range.js b/tests/view/range.js index 1fba91170..b33596bdb 100644 --- a/tests/view/range.js +++ b/tests/view/range.js @@ -25,8 +25,8 @@ describe( 'Range', () => { const range = new Range( start, end ); expect( range ).to.be.an.instanceof( Range ); - expect( range ).to.have.property( 'start' ).that.equals( start ); - expect( range ).to.have.property( 'end' ).that.equals( end ); + expect( range ).to.have.property( 'start' ).that.not.equals( start ); + expect( range ).to.have.property( 'end' ).that.not.equals( end ); expect( range.start.parent ).to.equal( start.parent ); expect( range.end.parent ).to.equal( end.parent ); expect( range.start.offset ).to.equal( start.offset ); diff --git a/tests/view/selection.js b/tests/view/selection.js index 5e1b8bf50..e0660bbc0 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -59,7 +59,7 @@ describe( 'Selection', () => { const anchor = selection.anchor; expect( anchor.isEqual( range1.start ) ).to.be.true; - expect( anchor ).to.equal( range1.start ); + expect( anchor ).to.not.equal( range1.start ); } ); it( 'should return end of single range in selection when added as backward', () => { @@ -67,7 +67,7 @@ describe( 'Selection', () => { const anchor = selection.anchor; expect( anchor.isEqual( range1.end ) ).to.be.true; - expect( anchor ).to.equal( range1.end ); + expect( anchor ).to.not.equal( range1.end ); } ); it( 'should get anchor from last inserted range', () => { @@ -95,7 +95,7 @@ describe( 'Selection', () => { const focus = selection.focus; expect( focus.isEqual( range1.start ) ).to.be.true; - expect( focus ).to.equal( range1.start ); + expect( focus ).to.not.equal( range1.start ); } ); it( 'should get focus from last inserted range', () => { @@ -410,7 +410,7 @@ describe( 'Selection', () => { const position = selection.getFirstPosition(); expect( position.isEqual( range2.start ) ).to.be.true; - expect( position ).to.equal( range2.start ); + expect( position ).to.not.equal( range2.start ); } ); it( 'should return null if no ranges are present', () => { @@ -427,7 +427,7 @@ describe( 'Selection', () => { const position = selection.getLastPosition(); expect( position.isEqual( range3.end ) ).to.be.true; - expect( position ).to.equal( range3.end ); + expect( position ).to.not.equal( range3.end ); } ); it( 'should return null if no ranges are present', () => { diff --git a/tests/view/writer/remove.js b/tests/view/writer/remove.js index db3edca6d..ecced8a9e 100644 --- a/tests/view/writer/remove.js +++ b/tests/view/writer/remove.js @@ -15,7 +15,8 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'writer', () => { /** - * Executes test using `parse` and `stringify` utils functions. Uses range delimiters `[]{}` to create ranges. + * Executes test using `parse` and `stringify` utils functions. Uses range delimiters `[]{}` to create and + * test ranges. * * @param {String} input * @param {String} expectedResult @@ -26,7 +27,7 @@ describe( 'writer', () => { const range = selection.getFirstRange(); const removed = remove( range ); - expect( stringify( view, null, { showType: true, showPriority: true } ) ).to.equal( expectedResult ); + expect( stringify( view, range, { showType: true, showPriority: true } ) ).to.equal( expectedResult ); expect( stringify( removed, null, { showType: true, showPriority: true } ) ).to.equal( expectedRemoved ); } @@ -59,21 +60,21 @@ describe( 'writer', () => { } ); it( 'should remove single text node', () => { - test( '[foobar]', '', 'foobar' ); + test( '[foobar]', '[]', 'foobar' ); } ); it( 'should not leave empty text nodes', () => { - test( '{foobar}', '', 'foobar' ); + test( '{foobar}', '[]', 'foobar' ); } ); it( 'should remove part of the text node', () => { - test( 'f{oob}ar', 'far', 'oob' ); + test( 'f{oob}ar', 'f{}ar', 'oob' ); } ); it( 'should remove parts of nodes #1', () => { test( 'f{ooba}r', - 'fr', + 'f[]r', 'ooba' ); } ); @@ -81,7 +82,7 @@ describe( 'writer', () => { it( 'should support unicode', () => { test( 'நி{லைக்}கு', - 'நிகு', + 'நி[]கு', 'லைக்' ); } ); @@ -91,7 +92,7 @@ describe( 'writer', () => { '' + 'foo[bar]bazqux' + '', - 'foobazqux', + 'foo{}bazqux', 'bar' ); } ); @@ -101,19 +102,19 @@ describe( 'writer', () => { '' + 'fo{obarba}zqux' + '', - 'fozqux', + 'fo{}zqux', 'obarba' ); } ); it( 'should remove part of the text node in document fragment', () => { - test( 'fo{ob}ar', 'foar', 'ob' ); + test( 'fo{ob}ar', 'fo{}ar', 'ob' ); } ); it( 'should remove EmptyElement', () => { test( 'foo[]bar', - 'foobar', + 'foo{}bar', '' ); } ); @@ -132,7 +133,7 @@ describe( 'writer', () => { it( 'should remove UIElement', () => { test( 'foo[]bar', - 'foobar', + 'foo{}bar', '' ); } ); From f74369f4b595932dc652d591230675180fb8a51c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 17 Nov 2017 11:12:59 +0100 Subject: [PATCH 040/724] Removed Batch#register moethod and moved all batch methods to the Batch class. --- src/model/batch.js | 682 +++++++++++++++- src/model/delta/attributedelta.js | 131 --- src/model/delta/basic-deltas.js | 1 - src/model/delta/insertdelta.js | 50 -- src/model/delta/markerdelta.js | 85 -- src/model/delta/mergedelta.js | 65 -- src/model/delta/movedelta.js | 41 - src/model/delta/removedelta.js | 38 - src/model/delta/renamedelta.js | 37 - src/model/delta/splitdelta.js | 55 -- src/model/delta/unwrapdelta.js | 51 -- src/model/delta/weakinsertdelta.js | 40 - src/model/delta/wrapdelta.js | 65 -- tests/model/batch.js | 1115 +++++++++++++++++++++++++- tests/model/delta/attributedelta.js | 398 --------- tests/model/delta/insertdelta.js | 88 -- tests/model/delta/markerdelta.js | 111 --- tests/model/delta/mergedelta.js | 62 -- tests/model/delta/movedelta.js | 67 -- tests/model/delta/removedelta.js | 71 -- tests/model/delta/renamedelta.js | 46 -- tests/model/delta/splitdelta.js | 78 -- tests/model/delta/unwrapdelta.js | 50 -- tests/model/delta/weakinsertdelta.js | 50 -- tests/model/delta/wrapdelta.js | 83 -- 25 files changed, 1713 insertions(+), 1847 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 70a04b1c4..a871c5c2c 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -7,6 +7,33 @@ * @module engine/model/batch */ +import { default as AttributeDelta, RootAttributeDelta } from './delta/attributedelta'; +import InsertDelta from './delta/insertdelta'; +import MarkerDelta from './delta/markerdelta'; +import MergeDelta from './delta/mergedelta'; +import MoveDelta from './delta/movedelta'; +import RemoveDelta from './delta/removedelta'; +import RenameDelta from './delta/renamedelta'; +import SplitDelta from './delta/splitdelta'; +import UnwrapDelta from './delta/unwrapdelta'; +import WeakInsertDelta from './delta/weakinsertdelta'; +import WrapDelta from './delta/wrapdelta'; + +import AttributeOperation from './operation/attributeoperation'; +import InsertOperation from './operation/insertoperation'; +import MarkerOperation from './operation/markeroperation'; +import MoveOperation from './operation/moveoperation'; +import RemoveOperation from './operation/removeoperation'; +import RenameOperation from './operation/renameoperation'; +import RootAttributeOperation from './operation/rootattributeoperation'; + +import DocumentFragment from './documentfragment'; +import Element from './element'; +import Position from './position'; +import Range from './range.js'; + +import { normalizeNodes } from './writer'; + import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** @@ -101,55 +128,626 @@ export default class Batch { yield* delta.operations; } } + + /** + * Inserts a node or nodes at the given position. + * + * When inserted element is a {@link module:engine/model/documentfragment~DocumentFragment} and has markers its markers will + * be set to {@link module:engine/model/document~Document#markers}. + * + * @chainable + * @param {module:engine/model/position~Position} position Position of insertion. + * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted. + */ + insert( position, nodes ) { + const normalizedNodes = normalizeNodes( nodes ); + + // If nothing is inserted do not create delta and operation. + if ( normalizedNodes.length === 0 ) { + return this; + } + + const delta = new InsertDelta(); + const insert = new InsertOperation( position, normalizedNodes, this.document.version ); + + this.addDelta( delta ); + delta.addOperation( insert ); + this.document.applyOperation( insert ); + + // When element is a DocumentFragment we need to move its markers to Document#markers. + if ( nodes instanceof DocumentFragment ) { + for ( const [ markerName, markerRange ] of nodes.markers ) { + // We need to migrate marker range from DocumentFragment to Document. + const rangeRootPosition = Position.createAt( markerRange.root ); + const range = new Range( + markerRange.start._getCombined( rangeRootPosition, position ), + markerRange.end._getCombined( rangeRootPosition, position ) + ); + + this.setMarker( markerName, range ); + } + } + + return this; + } + + /** + * Inserts a node or nodes at given position. {@link module:engine/model/batch~Batch#weakInsert weakInsert} is commonly used for actions + * like typing or plain-text paste (without formatting). There are two differences between + * {@link module:engine/model/batch~Batch#insert insert} and {@link module:engine/model/batch~Batch#weakInsert weakInsert}: + * + * * When using `weakInsert`, inserted nodes will have same attributes as the current attributes of + * {@link module:engine/model/document~Document#selection document selection}. + * * If {@link module:engine/model/operation/insertoperation~InsertOperation insert operation} position is inside a range changed by + * {@link module:engine/model/operation/attributeoperation~AttributeOperation attribute operation}, + * the attribute operation is split into two operations. + * Thanks to this, attribute change "omits" the inserted nodes. The correct behavior for `WeakInsertDelta` is that + * {@link module:engine/model/operation/attributeoperation~AttributeOperation AttributeOperation} does not "break" and also + * applies attributes for inserted nodes. This behavior has to be reflected during + * {@link module:engine/model/delta/transform~transform delta transformation}. + * + * @chainable + * @param {module:engine/model/position~Position} position Position of insertion. + * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted. + */ + weakInsert( position, nodes ) { + const delta = new WeakInsertDelta(); + this.addDelta( delta ); + + nodes = normalizeNodes( nodes ); + + for ( const node of nodes ) { + node.setAttributesTo( this.document.selection.getAttributes() ); + } + + const operation = new InsertOperation( position, nodes, this.document.version ); + delta.addOperation( operation ); + this.document.applyOperation( operation ); + + return this; + } + + /** + * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} + * or on a {@link module:engine/model/range~Range range}. + * + * @chainable + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range on which the attribute will be set. + * @param {String} key Attribute key. + * @param {*} value Attribute new value. + */ + setAttribute( itemOrRange, key, value ) { + if ( itemOrRange instanceof Range ) { + setAttributeToRange( this, key, value, itemOrRange ); + } else { + setAttributeToItem( this, key, value, itemOrRange ); + } + + return this; + } + + /** + * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} + * or from a {@link module:engine/model/range~Range range}. + * + * @chainable + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range from which the attribute will be removed. + * @method module:engine/model/batch~Batch#removeAttribute + * @param {String} key Attribute key. + */ + removeAttribute( itemOrRange, key ) { + if ( itemOrRange instanceof Range ) { + setAttributeToRange( this, key, null, itemOrRange ); + } else { + setAttributeToItem( this, key, null, itemOrRange ); + } + + return this; + } + + /** + * Merges two siblings at the given position. + * + * Node before and after the position have to be an element. Otherwise `batch-merge-no-element-before` or + * `batch-merge-no-element-after` error will be thrown. + * + * @chainable + * @param {module:engine/model/position~Position} position Position of merge. + */ + merge( position ) { + const delta = new MergeDelta(); + this.addDelta( delta ); + + const nodeBefore = position.nodeBefore; + const nodeAfter = position.nodeAfter; + + if ( !( nodeBefore instanceof Element ) ) { + /** + * Node before merge position must be an element. + * + * @error batch-merge-no-element-before + */ + throw new CKEditorError( 'batch-merge-no-element-before: Node before merge position must be an element.' ); + } + + if ( !( nodeAfter instanceof Element ) ) { + /** + * Node after merge position must be an element. + * + * @error batch-merge-no-element-after + */ + throw new CKEditorError( 'batch-merge-no-element-after: Node after merge position must be an element.' ); + } + + const positionAfter = Position.createFromParentAndOffset( nodeAfter, 0 ); + const positionBefore = Position.createFromParentAndOffset( nodeBefore, nodeBefore.maxOffset ); + + const move = new MoveOperation( + positionAfter, + nodeAfter.maxOffset, + positionBefore, + this.document.version + ); + + move.isSticky = true; + delta.addOperation( move ); + this.document.applyOperation( move ); + + const graveyard = this.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + const remove = new RemoveOperation( position, 1, gyPosition, this.document.version ); + delta.addOperation( remove ); + this.document.applyOperation( remove ); + + return this; + } + + /** + * Moves given {@link module:engine/model/item~Item model item} or given range to target position. + * + * @chainable + * @method module:engine/model/batch~Batch#move + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range of nodes to move. + * @param {module:engine/model/position~Position} targetPosition Position where moved nodes will be inserted. + */ + move( itemOrRange, targetPosition ) { + const delta = new MoveDelta(); + this.addDelta( delta ); + + const addOperation = ( sourcePosition, howMany, targetPosition ) => { + const operation = new MoveOperation( sourcePosition, howMany, targetPosition, this.document.version ); + delta.addOperation( operation ); + this.document.applyOperation( operation ); + }; + + if ( itemOrRange instanceof Range ) { + if ( !itemOrRange.isFlat ) { + /** + * Range to move is not flat. + * + * @error batch-move-range-not-flat + */ + throw new CKEditorError( 'batch-move-range-not-flat: Range to move is not flat.' ); + } + + addOperation( itemOrRange.start, itemOrRange.end.offset - itemOrRange.start.offset, targetPosition ); + } else { + addOperation( Position.createBefore( itemOrRange ), 1, targetPosition ); + } + + return this; + } + + /** + * Removes given {@link module:engine/model/item~Item model item} or given range. + * + * @chainable + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range to remove. + */ + remove( itemOrRange ) { + const addRemoveDelta = ( position, howMany ) => { + const delta = new RemoveDelta(); + this.addDelta( delta ); + + const graveyard = this.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + const operation = new RemoveOperation( position, howMany, gyPosition, this.document.version ); + delta.addOperation( operation ); + this.document.applyOperation( operation ); + }; + + if ( itemOrRange instanceof Range ) { + // The array is reversed, so the ranges to remove are in correct order and do not have to be updated. + const ranges = itemOrRange.getMinimalFlatRanges().reverse(); + + for ( const flat of ranges ) { + addRemoveDelta( flat.start, flat.end.offset - flat.start.offset ); + } + } else { + addRemoveDelta( Position.createBefore( itemOrRange ), 1 ); + } + + return this; + } + + /** + * Renames given element. + * + * @chainable + * @param {module:engine/model/element~Element} element The element to rename. + * @param {String} newName New element name. + */ + rename( element, newName ) { + if ( !( element instanceof Element ) ) { + /** + * Trying to rename an object which is not an instance of Element. + * + * @error batch-rename-not-element-instance + */ + throw new CKEditorError( 'batch-rename-not-element-instance: Trying to rename an object which is not an instance of Element.' ); + } + + const delta = new RenameDelta(); + this.addDelta( delta ); + + const renameOperation = new RenameOperation( Position.createBefore( element ), element.name, newName, this.document.version ); + delta.addOperation( renameOperation ); + this.document.applyOperation( renameOperation ); + + return this; + } + + /** + * Splits an element at the given position. + * + * The element cannot be a root element, as root element cannot be split. The `batch-split-root` error will be thrown if + * you try to split the root element. + * + * @chainable + * @param {module:engine/model/position~Position} position Position of split. + */ + split( position ) { + const delta = new SplitDelta(); + this.addDelta( delta ); + + const splitElement = position.parent; + + if ( !splitElement.parent ) { + /** + * Root element can not be split. + * + * @error batch-split-root + */ + throw new CKEditorError( 'batch-split-root: Root element can not be split.' ); + } + + const copy = new Element( splitElement.name, splitElement.getAttributes() ); + + const insert = new InsertOperation( + Position.createAfter( splitElement ), + copy, + this.document.version + ); + + delta.addOperation( insert ); + this.document.applyOperation( insert ); + + const move = new MoveOperation( + position, + splitElement.maxOffset - position.offset, + Position.createFromParentAndOffset( copy, 0 ), + this.document.version + ); + move.isSticky = true; + + delta.addOperation( move ); + this.document.applyOperation( move ); + + return this; + } + + /** + * Wraps given range with given element or with a new element with specified name, if string has been passed. + * **Note:** range to wrap should be a "flat range" (see {@link module:engine/model/range~Range#isFlat}). If not, error will be thrown. + * + * @chainable + * @param {module:engine/model/range~Range} range Range to wrap. + * @param {module:engine/model/element~Element|String} elementOrString Element or name of element to wrap the range with. + */ + wrap( range, elementOrString ) { + if ( !range.isFlat ) { + /** + * Range to wrap is not flat. + * + * @error batch-wrap-range-not-flat + */ + throw new CKEditorError( 'batch-wrap-range-not-flat: Range to wrap is not flat.' ); + } + + const element = elementOrString instanceof Element ? elementOrString : new Element( elementOrString ); + + if ( element.childCount > 0 ) { + /** + * Element to wrap with is not empty. + * + * @error batch-wrap-element-not-empty + */ + throw new CKEditorError( 'batch-wrap-element-not-empty: Element to wrap with is not empty.' ); + } + + if ( element.parent !== null ) { + /** + * Element to wrap with is already attached to a tree model. + * + * @error batch-wrap-element-attached + */ + throw new CKEditorError( 'batch-wrap-element-attached: Element to wrap with is already attached to tree model.' ); + } + + const delta = new WrapDelta(); + this.addDelta( delta ); + + const insert = new InsertOperation( range.end, element, this.document.version ); + delta.addOperation( insert ); + this.document.applyOperation( insert ); + + const targetPosition = Position.createFromParentAndOffset( element, 0 ); + const move = new MoveOperation( + range.start, + range.end.offset - range.start.offset, + targetPosition, + this.document.version + ); + delta.addOperation( move ); + this.document.applyOperation( move ); + + return this; + } + + /** + * Unwraps children of the given element – all its children are moved before it and then the element is removed. + * Throws error if you try to unwrap an element which does not have a parent. + * + * @chainable + * @param {module:engine/model/element~Element} element Element to unwrap. + */ + unwrap( element ) { + if ( element.parent === null ) { + /** + * Trying to unwrap an element which has no parent. + * + * @error batch-unwrap-element-no-parent + */ + throw new CKEditorError( 'batch-unwrap-element-no-parent: Trying to unwrap an element which has no parent.' ); + } + + const delta = new UnwrapDelta(); + this.addDelta( delta ); + + const sourcePosition = Position.createFromParentAndOffset( element, 0 ); + + const move = new MoveOperation( + sourcePosition, + element.maxOffset, + Position.createBefore( element ), + this.document.version + ); + + move.isSticky = true; + delta.addOperation( move ); + this.document.applyOperation( move ); + + // Computing new position because we moved some nodes before `element`. + // If we would cache `Position.createBefore( element )` we remove wrong node. + const graveyard = this.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + const remove = new RemoveOperation( Position.createBefore( element ), 1, gyPosition, this.document.version ); + delta.addOperation( remove ); + this.document.applyOperation( remove ); + + return this; + } + + /** + * Adds or updates {@link module:engine/model/markercollection~Marker marker} with given name to given `range`. + * + * If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance + * is passed), `range` parameter may be omitted. In this case marker will not be updated in + * {@link module:engine/model/document~Document#markers document marker collection}. However the marker will be added to + * the document history. This may be important for other features, like undo. From document history point of view, it will + * look like the marker was created and added to the document at the moment when it is set using this method. + * + * This is useful if the marker is created before it can be added to document history (e.g. a feature creating the marker + * is waiting for additional data, etc.). In this case, the marker may be first created directly through + * {@link module:engine/model/markercollection~MarkerCollection MarkerCollection API} and only later added using `Batch` API. + * + * @chainable + * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to add or update. + * @param {module:engine/model/range~Range} [newRange] Marker range. + */ + setMarker( markerOrName, newRange ) { + const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; + const currentMarker = this.document.markers.get( name ); + + if ( !newRange && !currentMarker ) { + /** + * Range parameter is required when adding a new marker. + * + * @error batch-setMarker-no-range + */ + throw new CKEditorError( 'batch-setMarker-no-range: Range parameter is required when adding a new marker.' ); + } + + const currentRange = currentMarker ? currentMarker.getRange() : null; + + if ( !newRange ) { + // If `newRange` is not given, treat this as synchronizing existing marker. + // Create `MarkerOperation` with `oldRange` set to `null`, so reverse operation will remove the marker. + addMarkerOperation( this, name, null, currentRange ); + } else { + // Just change marker range. + addMarkerOperation( this, name, currentRange, newRange ); + } + + return this; + } + + /** + * Removes given {@link module:engine/model/markercollection~Marker marker} or marker with given name. + * + * @chainable + * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to remove. + */ + removeMarker( markerOrName ) { + const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; + + if ( !this.document.markers.has( name ) ) { + /** + * Trying to remove marker which does not exist. + * + * @error batch-removeMarker-no-marker + */ + throw new CKEditorError( 'batch-removeMarker-no-marker: Trying to remove marker which does not exist.' ); + } + + const oldRange = this.document.markers.get( name ).getRange(); + + addMarkerOperation( this, name, oldRange, null ); + + return this; + } } /** - * Function to register batch methods. To make code scalable `Batch` do not have modification - * methods built in. They can be registered using this method. - * - * This method checks if there is no naming collision and throws `batch-register-taken` if the method name - * is already taken. - * - * Besides that no magic happens here, the method is added to the `Batch` class prototype. - * - * For example: - * - * Batch.register( 'insert', function( position, nodes ) { - * // You can use a class inheriting from `Delta` if that class should handle OT in a special way. - * const delta = new Delta(); - * - * // Add delta to the Batch instance. It is important to add a delta to the batch before applying any operation. - * this.addDelta( delta ); - * - * // Create operations which should be components of this delta. - * const operation = new InsertOperation( position, nodes, this.document.version ); - * - * // Add operation to the delta. It is important to add operation before applying it. - * delta.addOperation( operation ); + * Sets given attribute to each node in given range. When attribute value is null then attribute will be removed. * - * // Remember to apply every operation, no magic, you need to do it manually. - * this.document.applyOperation( operation ); + * Because attribute operation needs to have the same attribute value on the whole range, this function splits + * the range into smaller parts. * - * // Make this method chainable. - * return this; - * } ); + * @private + * @param {module:engine/model/batch~Batch} batch + * @param {String} key Attribute key. + * @param {*} value Attribute new value. + * @param {module:engine/model/range~Range} range Model range on which the attribute will be set. + */ +function setAttributeToRange( batch, key, value, range ) { + const delta = new AttributeDelta(); + const doc = batch.document; + + // Position of the last split, the beginning of the new range. + let lastSplitPosition = range.start; + + // Currently position in the scanning range. Because we need value after the position, it is not a current + // position of the iterator but the previous one (we need to iterate one more time to get the value after). + let position; + + // Value before the currently position. + let valueBefore; + + // Value after the currently position. + let valueAfter; + + for ( const val of range ) { + valueAfter = val.item.getAttribute( key ); + + // At the first run of the iterator the position in undefined. We also do not have a valueBefore, but + // because valueAfter may be null, valueBefore may be equal valueAfter ( undefined == null ). + if ( position && valueBefore != valueAfter ) { + // if valueBefore == value there is nothing to change, so we add operation only if these values are different. + if ( valueBefore != value ) { + addOperation(); + } + + lastSplitPosition = position; + } + + position = val.nextPosition; + valueBefore = valueAfter; + } + + // Because position in the loop is not the iterator position (see let position comment), the last position in + // the while loop will be last but one position in the range. We need to check the last position manually. + if ( position instanceof Position && position != lastSplitPosition && valueBefore != value ) { + addOperation(); + } + + function addOperation() { + // Add delta to the batch only if there is at least operation in the delta. Add delta only once. + if ( delta.operations.length === 0 ) { + batch.addDelta( delta ); + } + + const range = new Range( lastSplitPosition, position ); + const operation = new AttributeOperation( range, key, valueBefore, value, doc.version ); + + delta.addOperation( operation ); + doc.applyOperation( operation ); + } +} + +/** + * Sets given attribute to the given node. When attribute value is null then attribute will be removed. * - * @method module:engine/model/batch~Batch.register - * @param {String} name Method name. - * @param {Function} creator Method body. + * @private + * @param {module:engine/model/batch~Batch} batch + * @param {String} key Attribute key. + * @param {*} value Attribute new value. + * @param {module:engine/model/item~Item} item Model item on which the attribute will be set. */ -export function register( name, creator ) { - if ( Batch.prototype[ name ] ) { - /** - * This batch method name is already taken. - * - * @error batch-register-taken - * @param {String} name - */ - throw new CKEditorError( - 'model-batch-register-taken: This batch method name is already taken.', - { name } ); +function setAttributeToItem( batch, key, value, item ) { + const doc = batch.document; + const previousValue = item.getAttribute( key ); + let range, operation; + + const delta = item.is( 'rootElement' ) ? new RootAttributeDelta() : new AttributeDelta(); + + if ( previousValue != value ) { + batch.addDelta( delta ); + + if ( item.is( 'rootElement' ) ) { + // If we change attributes of root element, we have to use `RootAttributeOperation`. + operation = new RootAttributeOperation( item, key, previousValue, value, doc.version ); + } else { + if ( item.is( 'element' ) ) { + // If we change the attribute of the element, we do not want to change attributes of its children, so + // the end of the range cannot be after the closing tag, it should be inside that element, before any of + // it's children, so the range will contain only the opening tag. + range = new Range( Position.createBefore( item ), Position.createFromParentAndOffset( item, 0 ) ); + } else { + // If `item` is text proxy, we create a range from the beginning to the end of that text proxy, to change + // all characters represented by it. + range = new Range( Position.createBefore( item ), Position.createAfter( item ) ); + } + + operation = new AttributeOperation( range, key, previousValue, value, doc.version ); + } + + delta.addOperation( operation ); + doc.applyOperation( operation ); } +} + +/** + * Creates and adds marker operation to {@link module:engine/model/delta/delta~Delta delta}. + * + * @private + * @param {module:engine/model/batch~Batch} batch + * @param {String} name Marker name. + * @param {module:engine/model/range~Range} oldRange Marker range before the change. + * @param {module:engine/model/range~Range} newRange Marker range after the change. + */ +function addMarkerOperation( batch, name, oldRange, newRange ) { + const doc = batch.document; + const delta = new MarkerDelta(); + + const operation = new MarkerOperation( name, oldRange, newRange, doc.markers, doc.version ); - Batch.prototype[ name ] = creator; + batch.addDelta( delta ); + delta.addOperation( operation ); + doc.applyOperation( operation ); } diff --git a/src/model/delta/attributedelta.js b/src/model/delta/attributedelta.js index cba9b12c2..fa27e2256 100644 --- a/src/model/delta/attributedelta.js +++ b/src/model/delta/attributedelta.js @@ -9,11 +9,7 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; -import { register } from '../batch'; -import AttributeOperation from '../operation/attributeoperation'; -import RootAttributeOperation from '../operation/rootattributeoperation'; import NoOperation from '../operation/nooperation'; -import Position from '../position'; import Range from '../range'; /** @@ -129,132 +125,5 @@ export class RootAttributeDelta extends Delta { } } -/** - * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} - * or on a {@link module:engine/model/range~Range range}. - * - * @chainable - * @method module:engine/model/batch~Batch#setAttribute - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range on which the attribute will be set. - * @param {String} key Attribute key. - * @param {*} value Attribute new value. - */ -register( 'setAttribute', function( itemOrRange, key, value ) { - attribute( this, key, value, itemOrRange ); - - return this; -} ); - -/** - * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} - * or from a {@link module:engine/model/range~Range range}. - * - * @chainable - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range from which the attribute will be removed. - * @method module:engine/model/batch~Batch#removeAttribute - * @param {String} key Attribute key. - */ -register( 'removeAttribute', function( itemOrRange, key ) { - attribute( this, key, null, itemOrRange ); - - return this; -} ); - -function attribute( batch, key, value, itemOrRange ) { - if ( itemOrRange instanceof Range ) { - changeRange( batch, batch.document, key, value, itemOrRange ); - } else { - changeItem( batch, batch.document, key, value, itemOrRange ); - } -} - -function changeItem( batch, doc, key, value, item ) { - const previousValue = item.getAttribute( key ); - let range, operation; - - const delta = item.is( 'rootElement' ) ? new RootAttributeDelta() : new AttributeDelta(); - - if ( previousValue != value ) { - batch.addDelta( delta ); - - if ( item.is( 'rootElement' ) ) { - // If we change attributes of root element, we have to use `RootAttributeOperation`. - operation = new RootAttributeOperation( item, key, previousValue, value, doc.version ); - } else { - if ( item.is( 'element' ) ) { - // If we change the attribute of the element, we do not want to change attributes of its children, so - // the end of the range cannot be after the closing tag, it should be inside that element, before any of - // it's children, so the range will contain only the opening tag. - range = new Range( Position.createBefore( item ), Position.createFromParentAndOffset( item, 0 ) ); - } else { - // If `item` is text proxy, we create a range from the beginning to the end of that text proxy, to change - // all characters represented by it. - range = new Range( Position.createBefore( item ), Position.createAfter( item ) ); - } - - operation = new AttributeOperation( range, key, previousValue, value, doc.version ); - } - - delta.addOperation( operation ); - doc.applyOperation( operation ); - } -} - -// Because attribute operation needs to have the same attribute value on the whole range, this function splits the range -// into smaller parts. -function changeRange( batch, doc, attributeKey, attributeValue, range ) { - const delta = new AttributeDelta(); - - // Position of the last split, the beginning of the new range. - let lastSplitPosition = range.start; - - // Currently position in the scanning range. Because we need value after the position, it is not a current - // position of the iterator but the previous one (we need to iterate one more time to get the value after). - let position, - // Value before the currently position. - attributeValueBefore, - // Value after the currently position. - attributeValueAfter; - - for ( const value of range ) { - attributeValueAfter = value.item.getAttribute( attributeKey ); - - // At the first run of the iterator the position in undefined. We also do not have a attributeValueBefore, but - // because attributeValueAfter may be null, attributeValueBefore may be equal attributeValueAfter ( undefined == null ). - if ( position && attributeValueBefore != attributeValueAfter ) { - // if attributeValueBefore == attributeValue there is nothing to change, so we add operation only if these values are different. - if ( attributeValueBefore != attributeValue ) { - addOperation(); - } - - lastSplitPosition = position; - } - - position = value.nextPosition; - attributeValueBefore = attributeValueAfter; - } - - // Because position in the loop is not the iterator position (see let position comment), the last position in - // the while loop will be last but one position in the range. We need to check the last position manually. - if ( position instanceof Position && position != lastSplitPosition && attributeValueBefore != attributeValue ) { - addOperation(); - } - - function addOperation() { - // Add delta to the batch only if there is at least operation in the delta. Add delta only once. - if ( delta.operations.length === 0 ) { - batch.addDelta( delta ); - } - - const range = new Range( lastSplitPosition, position ); - const operation = new AttributeOperation( range, attributeKey, attributeValueBefore, attributeValue, doc.version ); - - delta.addOperation( operation ); - doc.applyOperation( operation ); - } -} - DeltaFactory.register( AttributeDelta ); DeltaFactory.register( RootAttributeDelta ); diff --git a/src/model/delta/basic-deltas.js b/src/model/delta/basic-deltas.js index 3d4a8b7e7..5161ccd03 100644 --- a/src/model/delta/basic-deltas.js +++ b/src/model/delta/basic-deltas.js @@ -13,7 +13,6 @@ // Import default suite of deltas so a feature have to include only Batch class file. import './attributedelta'; -import './insertdelta'; import './mergedelta'; import './movedelta'; import './removedelta'; diff --git a/src/model/delta/insertdelta.js b/src/model/delta/insertdelta.js index 641b68a0f..370dd1e60 100644 --- a/src/model/delta/insertdelta.js +++ b/src/model/delta/insertdelta.js @@ -10,13 +10,6 @@ import Delta from './delta'; import RemoveDelta from './removedelta'; import DeltaFactory from './deltafactory'; -import InsertOperation from '../operation/insertoperation'; -import { register } from '../batch'; -import { normalizeNodes } from './../writer'; - -import DocumentFragment from '../documentfragment'; -import Range from '../../model/range.js'; -import Position from '../../model/position.js'; /** * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#insert Batch#insert} method @@ -78,47 +71,4 @@ export default class InsertDelta extends Delta { } } -/** - * Inserts a node or nodes at the given position. - * - * When inserted element is a {@link module:engine/model/documentfragment~DocumentFragment} and has markers its markers will - * be set to {@link module:engine/model/document~Document#markers}. - * - * @chainable - * @method module:engine/model/batch~Batch#insert - * @param {module:engine/model/position~Position} position Position of insertion. - * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted. - */ -register( 'insert', function( position, nodes ) { - const normalizedNodes = normalizeNodes( nodes ); - - // If nothing is inserted do not create delta and operation. - if ( normalizedNodes.length === 0 ) { - return this; - } - - const delta = new InsertDelta(); - const insert = new InsertOperation( position, normalizedNodes, this.document.version ); - - this.addDelta( delta ); - delta.addOperation( insert ); - this.document.applyOperation( insert ); - - // When element is a DocumentFragment we need to move its markers to Document#markers. - if ( nodes instanceof DocumentFragment ) { - for ( const [ markerName, markerRange ] of nodes.markers ) { - // We need to migrate marker range from DocumentFragment to Document. - const rangeRootPosition = Position.createAt( markerRange.root ); - const range = new Range( - markerRange.start._getCombined( rangeRootPosition, position ), - markerRange.end._getCombined( rangeRootPosition, position ) - ); - - this.setMarker( markerName, range ); - } - } - - return this; -} ); - DeltaFactory.register( InsertDelta ); diff --git a/src/model/delta/markerdelta.js b/src/model/delta/markerdelta.js index f4f09bf1c..32bc8a25d 100644 --- a/src/model/delta/markerdelta.js +++ b/src/model/delta/markerdelta.js @@ -9,9 +9,6 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; -import { register } from '../batch'; -import MarkerOperation from '../operation/markeroperation'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#setMarker Batch#setMarker} @@ -46,86 +43,4 @@ export default class MarkerDelta extends Delta { } } -/** - * Adds or updates {@link module:engine/model/markercollection~Marker marker} with given name to given `range`. - * - * If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance - * is passed), `range` parameter may be omitted. In this case marker will not be updated in - * {@link module:engine/model/document~Document#markers document marker collection}. However the marker will be added to - * the document history. This may be important for other features, like undo. From document history point of view, it will - * look like the marker was created and added to the document at the moment when it is set using this method. - * - * This is useful if the marker is created before it can be added to document history (e.g. a feature creating the marker - * is waiting for additional data, etc.). In this case, the marker may be first created directly through - * {@link module:engine/model/markercollection~MarkerCollection MarkerCollection API} and only later added using `Batch` API. - * - * @chainable - * @method module:engine/model/batch~Batch#setMarker - * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to add or update. - * @param {module:engine/model/range~Range} [newRange] Marker range. - */ -register( 'setMarker', function( markerOrName, newRange ) { - const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; - const currentMarker = this.document.markers.get( name ); - - if ( !newRange && !currentMarker ) { - /** - * Range parameter is required when adding a new marker. - * - * @error batch-setMarker-no-range - */ - throw new CKEditorError( 'batch-setMarker-no-range: Range parameter is required when adding a new marker.' ); - } - - const currentRange = currentMarker ? currentMarker.getRange() : null; - - if ( !newRange ) { - // If `newRange` is not given, treat this as synchronizing existing marker. - // Create `MarkerOperation` with `oldRange` set to `null`, so reverse operation will remove the marker. - addOperation( this, name, null, currentRange ); - } else { - // Just change marker range. - addOperation( this, name, currentRange, newRange ); - } - - return this; -} ); - -/** - * Removes given {@link module:engine/model/markercollection~Marker marker} or marker with given name. - * - * @chainable - * @method module:engine/model/batch~Batch#removeMarker - * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to remove. - */ -register( 'removeMarker', function( markerOrName ) { - const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; - - if ( !this.document.markers.has( name ) ) { - /** - * Trying to remove marker which does not exist. - * - * @error batch-removeMarker-no-marker - */ - throw new CKEditorError( 'batch-removeMarker-no-marker: Trying to remove marker which does not exist.' ); - } - - const oldRange = this.document.markers.get( name ).getRange(); - - addOperation( this, name, oldRange, null ); - - return this; -} ); - -function addOperation( batch, name, oldRange, newRange ) { - const doc = batch.document; - const delta = new MarkerDelta(); - - const operation = new MarkerOperation( name, oldRange, newRange, doc.markers, doc.version ); - - batch.addDelta( delta ); - delta.addOperation( operation ); - doc.applyOperation( operation ); -} - DeltaFactory.register( MarkerDelta ); diff --git a/src/model/delta/mergedelta.js b/src/model/delta/mergedelta.js index 0bc69da2c..5cd83b5eb 100644 --- a/src/model/delta/mergedelta.js +++ b/src/model/delta/mergedelta.js @@ -10,12 +10,6 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; import SplitDelta from './splitdelta'; -import { register } from '../batch'; -import Position from '../position'; -import Element from '../element'; -import RemoveOperation from '../operation/removeoperation'; -import MoveOperation from '../operation/moveoperation'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#merge} method @@ -70,63 +64,4 @@ export default class MergeDelta extends Delta { } } -/** - * Merges two siblings at the given position. - * - * Node before and after the position have to be an element. Otherwise `batch-merge-no-element-before` or - * `batch-merge-no-element-after` error will be thrown. - * - * @chainable - * @method module:engine/model/batch~Batch#merge - * @param {module:engine/model/position~Position} position Position of merge. - */ -register( 'merge', function( position ) { - const delta = new MergeDelta(); - this.addDelta( delta ); - - const nodeBefore = position.nodeBefore; - const nodeAfter = position.nodeAfter; - - if ( !( nodeBefore instanceof Element ) ) { - /** - * Node before merge position must be an element. - * - * @error batch-merge-no-element-before - */ - throw new CKEditorError( 'batch-merge-no-element-before: Node before merge position must be an element.' ); - } - - if ( !( nodeAfter instanceof Element ) ) { - /** - * Node after merge position must be an element. - * - * @error batch-merge-no-element-after - */ - throw new CKEditorError( 'batch-merge-no-element-after: Node after merge position must be an element.' ); - } - - const positionAfter = Position.createFromParentAndOffset( nodeAfter, 0 ); - const positionBefore = Position.createFromParentAndOffset( nodeBefore, nodeBefore.maxOffset ); - - const move = new MoveOperation( - positionAfter, - nodeAfter.maxOffset, - positionBefore, - this.document.version - ); - - move.isSticky = true; - delta.addOperation( move ); - this.document.applyOperation( move ); - - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - const remove = new RemoveOperation( position, 1, gyPosition, this.document.version ); - delta.addOperation( remove ); - this.document.applyOperation( remove ); - - return this; -} ); - DeltaFactory.register( MergeDelta ); diff --git a/src/model/delta/movedelta.js b/src/model/delta/movedelta.js index f35b1af05..4a34ce2aa 100644 --- a/src/model/delta/movedelta.js +++ b/src/model/delta/movedelta.js @@ -9,11 +9,6 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; -import { register } from '../batch'; -import MoveOperation from '../operation/moveoperation'; -import Position from '../position'; -import Range from '../range'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#move} method @@ -86,40 +81,4 @@ export default class MoveDelta extends Delta { } } -function addMoveOperation( batch, delta, sourcePosition, howMany, targetPosition ) { - const operation = new MoveOperation( sourcePosition, howMany, targetPosition, batch.document.version ); - delta.addOperation( operation ); - batch.document.applyOperation( operation ); -} - -/** - * Moves given {@link module:engine/model/item~Item model item} or given range to target position. - * - * @chainable - * @method module:engine/model/batch~Batch#move - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range of nodes to move. - * @param {module:engine/model/position~Position} targetPosition Position where moved nodes will be inserted. - */ -register( 'move', function( itemOrRange, targetPosition ) { - const delta = new MoveDelta(); - this.addDelta( delta ); - - if ( itemOrRange instanceof Range ) { - if ( !itemOrRange.isFlat ) { - /** - * Range to move is not flat. - * - * @error batch-move-range-not-flat - */ - throw new CKEditorError( 'batch-move-range-not-flat: Range to move is not flat.' ); - } - - addMoveOperation( this, delta, itemOrRange.start, itemOrRange.end.offset - itemOrRange.start.offset, targetPosition ); - } else { - addMoveOperation( this, delta, Position.createBefore( itemOrRange ), 1, targetPosition ); - } - - return this; -} ); - DeltaFactory.register( MoveDelta ); diff --git a/src/model/delta/removedelta.js b/src/model/delta/removedelta.js index 3db9e34aa..8756f717f 100644 --- a/src/model/delta/removedelta.js +++ b/src/model/delta/removedelta.js @@ -8,11 +8,7 @@ */ import MoveDelta from './movedelta'; -import { register } from '../batch'; import DeltaFactory from './deltafactory'; -import RemoveOperation from '../operation/removeoperation'; -import Position from '../position'; -import Range from '../range'; /** * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#remove} method @@ -29,38 +25,4 @@ export default class RemoveDelta extends MoveDelta { } } -function addRemoveDelta( batch, position, howMany ) { - const delta = new RemoveDelta(); - batch.addDelta( delta ); - - const graveyard = batch.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - const operation = new RemoveOperation( position, howMany, gyPosition, batch.document.version ); - delta.addOperation( operation ); - batch.document.applyOperation( operation ); -} - -/** - * Removes given {@link module:engine/model/item~Item model item} or given range. - * - * @chainable - * @method module:engine/model/batch~Batch#remove - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range to remove. - */ -register( 'remove', function( itemOrRange ) { - if ( itemOrRange instanceof Range ) { - // The array is reversed, so the ranges to remove are in correct order and do not have to be updated. - const ranges = itemOrRange.getMinimalFlatRanges().reverse(); - - for ( const flat of ranges ) { - addRemoveDelta( this, flat.start, flat.end.offset - flat.start.offset ); - } - } else { - addRemoveDelta( this, Position.createBefore( itemOrRange ), 1 ); - } - - return this; -} ); - DeltaFactory.register( RemoveDelta ); diff --git a/src/model/delta/renamedelta.js b/src/model/delta/renamedelta.js index 0dcd32ed5..d39780726 100644 --- a/src/model/delta/renamedelta.js +++ b/src/model/delta/renamedelta.js @@ -9,11 +9,6 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; -import { register } from '../batch'; -import RenameOperation from '../operation/renameoperation'; -import Element from '../element'; -import Position from '../position'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#rename Batch#rename} method @@ -44,36 +39,4 @@ export default class RenameDelta extends Delta { } } -function apply( batch, delta, operation ) { - delta.addOperation( operation ); - batch.document.applyOperation( operation ); -} - -/** - * Renames given element. - * - * @chainable - * @method module:engine/model/batch~Batch#rename - * @param {module:engine/model/element~Element} element The element to rename. - * @param {String} newName New element name. - */ -register( 'rename', function( element, newName ) { - if ( !( element instanceof Element ) ) { - /** - * Trying to rename an object which is not an instance of Element. - * - * @error batch-rename-not-element-instance - */ - throw new CKEditorError( 'batch-rename-not-element-instance: Trying to rename an object which is not an instance of Element.' ); - } - - const delta = new RenameDelta(); - this.addDelta( delta ); - - const renameOperation = new RenameOperation( Position.createBefore( element ), element.name, newName, this.document.version ); - apply( this, delta, renameOperation ); - - return this; -} ); - DeltaFactory.register( RenameDelta ); diff --git a/src/model/delta/splitdelta.js b/src/model/delta/splitdelta.js index b62ddd9da..fdc042cd0 100644 --- a/src/model/delta/splitdelta.js +++ b/src/model/delta/splitdelta.js @@ -9,12 +9,7 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; -import { register } from '../batch'; -import Position from '../position'; -import Element from '../element'; -import InsertOperation from '../operation/insertoperation'; import MoveOperation from '../operation/moveoperation'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import MergeDelta from '../delta/mergedelta'; /** @@ -85,54 +80,4 @@ export default class SplitDelta extends Delta { } } -/** - * Splits an element at the given position. - * - * The element cannot be a root element, as root element cannot be split. The `batch-split-root` error will be thrown if - * you try to split the root element. - * - * @chainable - * @method module:engine/model/batch~Batch#split - * @param {module:engine/model/position~Position} position Position of split. - */ -register( 'split', function( position ) { - const delta = new SplitDelta(); - this.addDelta( delta ); - - const splitElement = position.parent; - - if ( !splitElement.parent ) { - /** - * Root element can not be split. - * - * @error batch-split-root - */ - throw new CKEditorError( 'batch-split-root: Root element can not be split.' ); - } - - const copy = new Element( splitElement.name, splitElement.getAttributes() ); - - const insert = new InsertOperation( - Position.createAfter( splitElement ), - copy, - this.document.version - ); - - delta.addOperation( insert ); - this.document.applyOperation( insert ); - - const move = new MoveOperation( - position, - splitElement.maxOffset - position.offset, - Position.createFromParentAndOffset( copy, 0 ), - this.document.version - ); - move.isSticky = true; - - delta.addOperation( move ); - this.document.applyOperation( move ); - - return this; -} ); - DeltaFactory.register( SplitDelta ); diff --git a/src/model/delta/unwrapdelta.js b/src/model/delta/unwrapdelta.js index d37b87db1..23f7aadf9 100644 --- a/src/model/delta/unwrapdelta.js +++ b/src/model/delta/unwrapdelta.js @@ -10,11 +10,6 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; import WrapDelta from './wrapdelta'; -import { register } from '../batch'; -import Position from '../position'; -import RemoveOperation from '../operation/removeoperation'; -import MoveOperation from '../operation/moveoperation'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#merge} method @@ -64,50 +59,4 @@ export default class UnwrapDelta extends Delta { } } -/** - * Unwraps children of the given element – all its children are moved before it and then the element is removed. - * Throws error if you try to unwrap an element which does not have a parent. - * - * @chainable - * @method module:engine/model/batch~Batch#unwrap - * @param {module:engine/model/element~Element} position Element to unwrap. - */ -register( 'unwrap', function( element ) { - if ( element.parent === null ) { - /** - * Trying to unwrap an element which has no parent. - * - * @error batch-unwrap-element-no-parent - */ - throw new CKEditorError( 'batch-unwrap-element-no-parent: Trying to unwrap an element which has no parent.' ); - } - - const delta = new UnwrapDelta(); - this.addDelta( delta ); - - const sourcePosition = Position.createFromParentAndOffset( element, 0 ); - - const move = new MoveOperation( - sourcePosition, - element.maxOffset, - Position.createBefore( element ), - this.document.version - ); - - move.isSticky = true; - delta.addOperation( move ); - this.document.applyOperation( move ); - - // Computing new position because we moved some nodes before `element`. - // If we would cache `Position.createBefore( element )` we remove wrong node. - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - const remove = new RemoveOperation( Position.createBefore( element ), 1, gyPosition, this.document.version ); - delta.addOperation( remove ); - this.document.applyOperation( remove ); - - return this; -} ); - DeltaFactory.register( UnwrapDelta ); diff --git a/src/model/delta/weakinsertdelta.js b/src/model/delta/weakinsertdelta.js index 5fe32dab8..8c63b5187 100644 --- a/src/model/delta/weakinsertdelta.js +++ b/src/model/delta/weakinsertdelta.js @@ -8,10 +8,7 @@ */ import InsertDelta from './insertdelta'; -import { register } from '../batch'; import DeltaFactory from './deltafactory'; -import InsertOperation from '../operation/insertoperation'; -import { normalizeNodes } from './../writer'; /** * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#insert} method @@ -28,41 +25,4 @@ export default class WeakInsertDelta extends InsertDelta { } } -/** - * Inserts a node or nodes at given position. {@link module:engine/model/batch~Batch#weakInsert weakInsert} is commonly used for actions - * like typing or plain-text paste (without formatting). There are two differences between - * {@link module:engine/model/batch~Batch#insert insert} and {@link module:engine/model/batch~Batch#weakInsert weakInsert}: - * - * * When using `weakInsert`, inserted nodes will have same attributes as the current attributes of - * {@link module:engine/model/document~Document#selection document selection}. - * * If {@link module:engine/model/operation/insertoperation~InsertOperation insert operation} position is inside a range changed by - * {@link module:engine/model/operation/attributeoperation~AttributeOperation attribute operation}, - * the attribute operation is split into two operations. - * Thanks to this, attribute change "omits" the inserted nodes. The correct behavior for `WeakInsertDelta` is that - * {@link module:engine/model/operation/attributeoperation~AttributeOperation AttributeOperation} does not "break" and also - * applies attributes for inserted nodes. This behavior has to be reflected during - * {@link module:engine/model/delta/transform~transform delta transformation}. - * - * @chainable - * @method module:engine/model/batch~Batch#weakInsert - * @param {module:engine/model/position~Position} position Position of insertion. - * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted. - */ -register( 'weakInsert', function( position, nodes ) { - const delta = new WeakInsertDelta(); - this.addDelta( delta ); - - nodes = normalizeNodes( nodes ); - - for ( const node of nodes ) { - node.setAttributesTo( this.document.selection.getAttributes() ); - } - - const operation = new InsertOperation( position, nodes, this.document.version ); - delta.addOperation( operation ); - this.document.applyOperation( operation ); - - return this; -} ); - DeltaFactory.register( WeakInsertDelta ); diff --git a/src/model/delta/wrapdelta.js b/src/model/delta/wrapdelta.js index 5f0dc0699..391a9a4f8 100644 --- a/src/model/delta/wrapdelta.js +++ b/src/model/delta/wrapdelta.js @@ -10,13 +10,7 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; import UnwrapDelta from './unwrapdelta'; -import { register } from '../batch'; -import Position from '../position'; import Range from '../range'; -import Element from '../element'; -import InsertOperation from '../operation/insertoperation'; -import MoveOperation from '../operation/moveoperation'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#merge} method @@ -91,63 +85,4 @@ export default class WrapDelta extends Delta { } } -/** - * Wraps given range with given element or with a new element with specified name, if string has been passed. - * **Note:** range to wrap should be a "flat range" (see {@link module:engine/model/range~Range#isFlat}). If not, error will be thrown. - * - * @chainable - * @method module:engine/model/batch~Batch#wrap - * @param {module:engine/model/range~Range} range Range to wrap. - * @param {module:engine/model/element~Element|String} elementOrString Element or name of element to wrap the range with. - */ -register( 'wrap', function( range, elementOrString ) { - if ( !range.isFlat ) { - /** - * Range to wrap is not flat. - * - * @error batch-wrap-range-not-flat - */ - throw new CKEditorError( 'batch-wrap-range-not-flat: Range to wrap is not flat.' ); - } - - const element = elementOrString instanceof Element ? elementOrString : new Element( elementOrString ); - - if ( element.childCount > 0 ) { - /** - * Element to wrap with is not empty. - * - * @error batch-wrap-element-not-empty - */ - throw new CKEditorError( 'batch-wrap-element-not-empty: Element to wrap with is not empty.' ); - } - - if ( element.parent !== null ) { - /** - * Element to wrap with is already attached to a tree model. - * - * @error batch-wrap-element-attached - */ - throw new CKEditorError( 'batch-wrap-element-attached: Element to wrap with is already attached to tree model.' ); - } - - const delta = new WrapDelta(); - this.addDelta( delta ); - - const insert = new InsertOperation( range.end, element, this.document.version ); - delta.addOperation( insert ); - this.document.applyOperation( insert ); - - const targetPosition = Position.createFromParentAndOffset( element, 0 ); - const move = new MoveOperation( - range.start, - range.end.offset - range.start.offset, - targetPosition, - this.document.version - ); - delta.addOperation( move ); - this.document.applyOperation( move ); - - return this; -} ); - DeltaFactory.register( WrapDelta ); diff --git a/tests/model/batch.js b/tests/model/batch.js index 5cbcae0da..207d7428a 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -3,22 +3,27 @@ * For licensing, see LICENSE.md. */ -import deltas from '../../src/model/delta/basic-deltas'; // eslint-disable-line no-unused-vars - -import Document from '../../src/model/document'; -import { default as Batch, register } from '../../src/model/batch'; +import Batch from '../../src/model/batch'; import Delta from '../../src/model/delta/delta'; + import Operation from '../../src/model/operation/operation'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; +import InsertOperation from '../../src/model/operation/insertoperation'; +import MarkerOperation from '../../src/model/operation/markeroperation'; -describe( 'Batch', () => { - it( 'should have registered basic methods', () => { - const batch = new Batch( new Document() ); +import Document from '../../src/model/document'; +import DocumentFragment from '../../src/model/documentfragment'; +import Element from '../../src/model/element'; +import Text from '../../src/model/text'; +import Position from '../../src/model/position'; +import Range from '../../src/model/range'; - expect( batch.setAttribute ).to.be.a( 'function' ); - expect( batch.removeAttribute ).to.be.a( 'function' ); - } ); +import count from '@ckeditor/ckeditor5-utils/src/count'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; + +import { stringify } from '../../src/dev-utils/model'; +import { getNodesAndText } from '../../tests/model/_utils/utils'; +describe( 'Batch', () => { describe( 'type', () => { it( 'should default to "default"', () => { const batch = new Batch( new Document() ); @@ -33,33 +38,25 @@ describe( 'Batch', () => { } ); } ); - describe( 'register', () => { - afterEach( () => { - delete Batch.prototype.foo; - } ); - - it( 'should register function to the batch prototype', () => { - const spy = sinon.spy(); - - register( 'foo', spy ); - + describe( 'baseVersion', () => { + it( 'should return base version of first delta from the batch', () => { const batch = new Batch( new Document() ); + const delta = new Delta(); + const operation = new Operation( 2 ); + delta.addOperation( operation ); + batch.addDelta( delta ); - batch.foo(); - - expect( spy.calledOnce ).to.be.true; + expect( batch.baseVersion ).to.equal( 2 ); } ); - it( 'should throw if one try to register the same batch twice', () => { - register( 'foo', () => {} ); + it( 'should return null if there are no deltas in batch', () => { + const batch = new Batch( new Document() ); - expect( () => { - register( 'foo', () => {} ); - } ).to.throw( CKEditorError, /^model-batch-register-taken/ ); + expect( batch.baseVersion ).to.be.null; } ); } ); - describe( 'addDelta', () => { + describe( 'addDelta()', () => { it( 'should add delta to the batch', () => { const batch = new Batch( new Document() ); const deltaA = new Delta(); @@ -73,7 +70,7 @@ describe( 'Batch', () => { } ); } ); - describe( 'getOperations', () => { + describe( 'getOperations()', () => { it( 'should return collection of operations from all deltas', () => { const doc = new Document(); const batch = new Batch( doc ); @@ -96,21 +93,1055 @@ describe( 'Batch', () => { } ); } ); - describe( 'baseVersion', () => { - it( 'should return base version of first delta from the batch', () => { - const batch = new Batch( new Document() ); - const delta = new Delta(); - const operation = new Operation( 2 ); - delta.addOperation( operation ); - batch.addDelta( delta ); + describe( 'insert', () => { + let doc, root, batch, p, ul, chain; - expect( batch.baseVersion ).to.equal( 2 ); + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + root.insertChildren( 0, new Text( 'abc' ) ); + + batch = doc.batch(); + + p = new Element( 'p' ); + ul = new Element( 'ul' ); + + chain = batch.insert( new Position( root, [ 2 ] ), [ p, ul ] ); } ); - it( 'should return null if there are no deltas in batch', () => { - const batch = new Batch( new Document() ); + it( 'should insert given nodes at given position', () => { + expect( root.childCount ).to.equal( 4 ); + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 1 ) ).to.equal( p ); + expect( root.getChild( 2 ) ).to.equal( ul ); + } ); - expect( batch.baseVersion ).to.be.null; + it( 'should be chainable', () => { + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.insert( new Position( root, [ 2 ] ), [ p, ul ] ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + + it( 'should transfer markers from given DocumentFragment', () => { + const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); + const marker = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 5 ] ) ); + + documentFragment.markers.set( 'marker', marker ); + + batch.insert( new Position( root, [ 3, 0 ] ), documentFragment ); + + expect( Array.from( doc.markers ).length ).to.equal( 1 ); + expect( stringify( root, doc.markers.get( 'marker' ).getRange() ) ).to.equal( 'ab

  • f[oo b]ar
c' ); + } ); + + it( 'should set each marker as separate operation', () => { + sinon.spy( doc, 'applyOperation' ); + + const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); + const marker1 = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 2 ] ) ); + const marker2 = new Range( new Position( documentFragment, [ 0, 5 ] ), new Position( documentFragment, [ 0, 6 ] ) ); + + documentFragment.markers.set( 'marker1', marker1 ); + documentFragment.markers.set( 'marker2', marker2 ); + + batch.insert( new Position( root, [ 3, 0 ] ), documentFragment ); + + expect( doc.applyOperation.calledThrice ); + expect( doc.applyOperation.firstCall.calledWith( sinon.match( operation => operation instanceof InsertOperation ) ) ); + expect( doc.applyOperation.secondCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); + expect( doc.applyOperation.thirdCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); + } ); + + it( 'should not create a delta and an operation if no nodes were inserted', () => { + sinon.spy( doc, 'applyOperation' ); + + batch = doc.batch(); + + batch.insert( new Position( root, [ 0 ] ), [] ); + + expect( batch.deltas.length ).to.equal( 0 ); + expect( doc.applyOperation.called ).to.be.false; + } ); + } ); + + describe( 'weakInsert()', () => { + let doc, root, batch, chain, attrs; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + root.insertChildren( 0, new Text( 'abc' ) ); + + batch = doc.batch(); + + attrs = [ [ 'bold', true ], [ 'foo', 'bar' ] ]; + + doc.selection.setAttributesTo( attrs ); + + chain = batch.weakInsert( new Position( root, [ 2 ] ), 'xyz' ); + } ); + + it( 'should insert given nodes at given position', () => { + expect( root.maxOffset ).to.equal( 6 ); + expect( root.getChild( 0 ).data ).to.equal( 'ab' ); + expect( root.getChild( 1 ).data ).to.equal( 'xyz' ); + expect( root.getChild( 2 ).data ).to.equal( 'c' ); + } ); + + it( 'should set inserted nodes attributes to same as current selection attributes', () => { + expect( Array.from( root.getChild( 1 ).getAttributes() ) ).to.deep.equal( attrs ); + } ); + + it( 'should be chainable', () => { + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.weakInsert( new Position( root, [ 2 ] ), 'xyz' ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'setAttribute() / removeAttribute()', () => { + let batch, doc, root; + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + batch = doc.batch(); + } ); + + function getOperationsCount() { + let totalNumber = 0; + + for ( const delta of batch.deltas ) { + totalNumber += count( delta.operations ); + } + + return totalNumber; + } + + describe( 'change attribute on node', () => { + let node, text; + + beforeEach( () => { + node = new Element( 'p', { a: 1 } ); + text = new Text( 'c', { a: 1 } ); + + root.insertChildren( 0, [ node, text ] ); + } ); + + describe( 'setAttribute', () => { + it( 'should create the attribute on element', () => { + batch.setAttribute( node, 'b', 2 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( node.getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of element', () => { + batch.setAttribute( node, 'a', 2 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( node.getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should create the attribute on text node', () => { + batch.setAttribute( text, 'b', 2 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of text node', () => { + batch.setAttribute( text, 'a', 2 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should do nothing if the attribute value is the same', () => { + batch.setAttribute( node, 'a', 1 ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( node.getAttribute( 'a' ) ).to.equal( 1 ); + } ); + + it( 'should be chainable', () => { + const chain = batch.setAttribute( node, 'b', 2 ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.setAttribute( node, 'b', 2 ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'removeAttribute', () => { + it( 'should remove the attribute from element', () => { + batch.removeAttribute( node, 'a' ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( node.getAttribute( 'a' ) ).to.be.undefined; + } ); + + it( 'should remove the attribute from character', () => { + batch.removeAttribute( text, 'a' ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.be.undefined; + } ); + + it( 'should do nothing if the attribute is not set', () => { + batch.removeAttribute( node, 'b' ); + expect( getOperationsCount() ).to.equal( 0 ); + } ); + + it( 'should be chainable', () => { + const chain = batch.removeAttribute( node, 'a' ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.removeAttribute( node, 'a' ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + } ); + + describe( 'change attribute on range', () => { + beforeEach( () => { + root.insertChildren( 0, [ + new Text( 'xxx', { a: 1 } ), + new Text( 'xxx' ), + new Text( 'xxx', { a: 1 } ), + new Text( 'xxx', { a: 2 } ), + new Text( 'xxx' ), + new Text( 'xxx', { a: 1 } ), + new Element( 'e', { a: 2 }, new Text( 'xxx' ) ), + new Text( 'xxx' ) + ] ); + } ); + + function getRange( startIndex, endIndex ) { + return new Range( + Position.createFromParentAndOffset( root, startIndex ), + Position.createFromParentAndOffset( root, endIndex ) + ); + } + + function getChangesAttrsCount() { + let totalNumber = 0; + + for ( const delta of batch.deltas ) { + for ( const operation of delta.operations ) { + totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); + } + } + + return totalNumber; + } + + function getCompressedAttrs() { + // default: 111---111222---1112------ + const range = Range.createIn( root ); + + return Array.from( range.getItems( { singleCharacters: true } ) ) + .map( item => item.getAttribute( 'a' ) || '-' ) + .join( '' ); + } + + describe( 'setAttribute', () => { + it( 'should set the attribute on the range', () => { + batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 3 ); + expect( getCompressedAttrs() ).to.equal( '111333111222---1112------' ); + } ); + + it( 'should split the operations if parts of the range have different attributes', () => { + batch.setAttribute( getRange( 4, 14 ), 'a', 3 ); + expect( getOperationsCount() ).to.equal( 4 ); + expect( getChangesAttrsCount() ).to.equal( 10 ); + expect( getCompressedAttrs() ).to.equal( '111-3333333333-1112------' ); + } ); + + it( 'should split the operations if parts of the part of the range have the attribute', () => { + batch.setAttribute( getRange( 4, 14 ), 'a', 2 ); + expect( getOperationsCount() ).to.equal( 3 ); + expect( getChangesAttrsCount() ).to.equal( 7 ); + expect( getCompressedAttrs() ).to.equal( '111-2222222222-1112------' ); + } ); + + it( 'should strip the range if the beginning have the attribute', () => { + batch.setAttribute( getRange( 1, 5 ), 'a', 1 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '11111-111222---1112------' ); + } ); + + it( 'should strip the range if the ending have the attribute', () => { + batch.setAttribute( getRange( 13, 17 ), 'a', 1 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '111---111222-111112------' ); + } ); + + it( 'should do nothing if the range has attribute', () => { + batch.setAttribute( getRange( 0, 3 ), 'a', 1 ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not check range\'s start position node when creating operations', () => { + const range = new Range( + new Position( root, [ 18, 1 ] ), + new Position( root, [ 19 ] ) + ); + + batch.setAttribute( range, 'a', 1 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112-11---' ); + } ); + + it( 'should not change elements attribute if range contains closing tag', () => { + const range = new Range( + new Position( root, [ 18, 1 ] ), + new Position( root, [ 21 ] ) + ); + + batch.setAttribute( range, 'a', 1 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 4 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112-1111-' ); + } ); + + it( 'should not create an operation if the range contains only closing tag', () => { + const range = new Range( + new Position( root, [ 18, 3 ] ), + new Position( root, [ 19 ] ) + ); + + batch.setAttribute( range, 'a', 3 ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not create an operation if is collapsed', () => { + batch.setAttribute( getRange( 3, 3 ), 'a', 1 ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should create a proper operations for the mixed range', () => { + batch.setAttribute( getRange( 0, 20 ), 'a', 1 ); + expect( getOperationsCount() ).to.equal( 5 ); + expect( getChangesAttrsCount() ).to.equal( 14 ); + expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); + } ); + + it( 'should be chainable', () => { + const chain = batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'removeAttribute', () => { + it( 'should remove the attribute on the range', () => { + batch.removeAttribute( getRange( 0, 2 ), 'a' ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '--1---111222---1112------' ); + } ); + + it( 'should split the operations if parts of the range have different attributes', () => { + batch.removeAttribute( getRange( 7, 11 ), 'a' ); + expect( getOperationsCount() ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 4 ); + expect( getCompressedAttrs() ).to.equal( '111---1----2---1112------' ); + } ); + + it( 'should split the operations if parts of the part of the range have no attribute', () => { + batch.removeAttribute( getRange( 1, 7 ), 'a' ); + expect( getOperationsCount() ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 3 ); + expect( getCompressedAttrs() ).to.equal( '1------11222---1112------' ); + } ); + + it( 'should strip the range if the beginning have no attribute', () => { + batch.removeAttribute( getRange( 4, 12 ), 'a' ); + expect( getOperationsCount() ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 6 ); + expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); + } ); + + it( 'should strip the range if the ending have no attribute', () => { + batch.removeAttribute( getRange( 7, 15 ), 'a' ); + expect( getOperationsCount() ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 5 ); + expect( getCompressedAttrs() ).to.equal( '111---1--------1112------' ); + } ); + + it( 'should do nothing if the range has no attribute', () => { + batch.removeAttribute( getRange( 4, 5 ), 'a' ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not check range\'s start position node when creating operations', () => { + const range = new Range( + new Position( root, [ 18, 3 ] ), + new Position( root, [ 19 ] ) + ); + + batch.removeAttribute( range, 'a' ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( getChangesAttrsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not apply operation twice in the range contains opening and closing tags', () => { + batch.removeAttribute( getRange( 18, 22 ), 'a' ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 1 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---111-------' ); + } ); + + it( 'should not create an operation if range is collapsed', () => { + batch.removeAttribute( getRange( 3, 3 ), 'a' ); + expect( getOperationsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should create a proper operations for the mixed range', () => { + batch.removeAttribute( getRange( 3, 15 ), 'a' ); + expect( getOperationsCount() ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 6 ); + expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); + } ); + + it( 'should be chainable', () => { + const chain = batch.removeAttribute( getRange( 0, 2 ), 'a' ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.removeAttribute( getRange( 0, 2 ), 'a' ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + } ); + + describe( 'change attribute on root element', () => { + describe( 'setAttribute', () => { + it( 'should create the attribute on root', () => { + batch.setAttribute( root, 'b', 2 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( root.getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of root', () => { + batch.setAttribute( root, 'a', 2 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( root.getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should do nothing if the attribute value is the same', () => { + batch.setAttribute( root, 'a', 1 ); + expect( getOperationsCount() ).to.equal( 1 ); + batch.setAttribute( root, 'a', 1 ); + expect( getOperationsCount() ).to.equal( 1 ); + expect( root.getAttribute( 'a' ) ).to.equal( 1 ); + } ); + } ); + + describe( 'removeAttribute', () => { + it( 'should remove the attribute from root', () => { + batch.setAttribute( root, 'a', 1 ); + batch.removeAttribute( root, 'a' ); + expect( getOperationsCount() ).to.equal( 2 ); + expect( root.getAttribute( 'a' ) ).to.be.undefined; + } ); + + it( 'should do nothing if the attribute is not set', () => { + batch.removeAttribute( root, 'b' ); + expect( getOperationsCount() ).to.equal( 0 ); + } ); + } ); + } ); + + it( 'should not add empty delta to the batch', () => { + const nodeA = new Element( 'p', { a: 1 } ); + const nodeB = new Element( 'p', { b: 2 } ); + root.insertChildren( 0, [ nodeA, nodeB ] ); + + batch.setAttribute( nodeA, 'a', 1 ); + + expect( batch.deltas.length ).to.equal( 0 ); + + batch.removeAttribute( Range.createIn( root ), 'x' ); + + expect( batch.deltas.length ).to.equal( 0 ); + } ); + } ); + + describe( 'merge()', () => { + let doc, root, p1, p2, batch; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + p1 = new Element( 'p', { key1: 'value1' }, new Text( 'foo' ) ); + p2 = new Element( 'p', { key2: 'value2' }, new Text( 'bar' ) ); + + root.insertChildren( 0, [ p1, p2 ] ); + } ); + + it( 'should merge foo and bar into foobar', () => { + doc.batch().merge( new Position( root, [ 1 ] ) ); + + expect( root.maxOffset ).to.equal( 1 ); + expect( root.getChild( 0 ).name ).to.equal( 'p' ); + expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'key1' ) ).to.equal( 'value1' ); + expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); + } ); + + it( 'should throw if there is no element after', () => { + expect( () => { + doc.batch().merge( new Position( root, [ 2 ] ) ); + } ).to.throw( CKEditorError, /^batch-merge-no-element-after/ ); + } ); + + it( 'should throw if there is no element before', () => { + expect( () => { + doc.batch().merge( new Position( root, [ 0, 2 ] ) ); + } ).to.throw( CKEditorError, /^batch-merge-no-element-before/ ); + } ); + + it( 'should be chainable', () => { + batch = doc.batch(); + + const chain = batch.merge( new Position( root, [ 1 ] ) ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch = doc.batch().merge( new Position( root, [ 1 ] ) ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'move()', () => { + let doc, root, div, p, batch, chain; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + div = new Element( 'div', [], new Text( 'foobar' ) ); + p = new Element( 'p', [], new Text( 'abcxyz' ) ); + + div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); + div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); + + root.insertChildren( 0, [ div, p ] ); + + batch = doc.batch(); + } ); + + it( 'should move specified node', () => { + batch.move( div, new Position( root, [ 2 ] ) ); + + expect( root.maxOffset ).to.equal( 2 ); + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); + expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'PggggPfoobarPhhhhP' ); + } ); + + it( 'should move flat range of nodes', () => { + const range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); + batch.move( range, new Position( root, [ 1, 3 ] ) ); + + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggggPfoPhhhhP' ); + expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcobarxyz' ); + } ); + + it( 'should throw if given range is not flat', () => { + const notFlatRange = new Range( new Position( root, [ 0, 2, 2 ] ), new Position( root, [ 0, 6 ] ) ); + + expect( () => { + doc.batch().move( notFlatRange, new Position( root, [ 1, 3 ] ) ); + } ).to.throw( CKEditorError, /^batch-move-range-not-flat/ ); + } ); + + it( 'should be chainable', () => { + chain = batch.move( div, new Position( root, [ 1, 3 ] ) ); + + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.move( div, new Position( root, [ 2 ] ) ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'remove()', () => { + let doc, root, div, p, batch, chain, range; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + div = new Element( 'div', [], new Text( 'foobar' ) ); + p = new Element( 'p', [], new Text( 'abcxyz' ) ); + + div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); + div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); + + root.insertChildren( 0, [ div, p ] ); + + batch = doc.batch(); + + // Range starts in ROOT > DIV > P > gg|gg. + // Range ends in ROOT > DIV > ...|ar. + range = new Range( new Position( root, [ 0, 0, 2 ] ), new Position( root, [ 0, 5 ] ) ); + } ); + + it( 'should remove specified node', () => { + batch.remove( div ); + + expect( root.maxOffset ).to.equal( 1 ); + expect( root.childCount ).to.equal( 1 ); + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should remove any range of nodes', () => { + batch.remove( range ); + + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); + expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should create minimal number of remove deltas, each with only one operation', () => { + batch.remove( range ); + + expect( batch.deltas.length ).to.equal( 2 ); + expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + } ); + + it( 'should be chainable', () => { + chain = batch.remove( range ); + + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.remove( div ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'rename()', () => { + let doc, root, batch, chain; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + const p = new Element( 'p', null, new Text( 'abc' ) ); + root.appendChildren( p ); + + batch = doc.batch(); + + chain = batch.rename( p, 'h' ); + } ); + + it( 'should rename given element', () => { + expect( root.maxOffset ).to.equal( 1 ); + expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); + expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); + } ); + + it( 'should throw if not an Element instance is passed', () => { + expect( () => { + batch.rename( new Text( 'abc' ), 'h' ); + } ).to.throw( CKEditorError, /^batch-rename-not-element-instance/ ); + } ); + + it( 'should be chainable', () => { + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.rename( root.getChild( 0 ), 'p' ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.alwaysCalledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'split()', () => { + let doc, root, p; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + p = new Element( 'p', { key: 'value' }, new Text( 'foobar' ) ); + + root.insertChildren( 0, p ); + } ); + + it( 'should split foobar to foo and bar', () => { + doc.batch().split( new Position( root, [ 0, 3 ] ) ); + + expect( root.maxOffset ).to.equal( 2 ); + + expect( root.getChild( 0 ).name ).to.equal( 'p' ); + expect( root.getChild( 0 ).maxOffset ).to.equal( 3 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); + expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' ); + + expect( root.getChild( 1 ).name ).to.equal( 'p' ); + expect( root.getChild( 1 ).maxOffset ).to.equal( 3 ); + expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); + expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'bar' ); + } ); + + it( 'should create an empty paragraph if we split at the end', () => { + doc.batch().split( new Position( root, [ 0, 6 ] ) ); + + expect( root.maxOffset ).to.equal( 2 ); + + expect( root.getChild( 0 ).name ).to.equal( 'p' ); + expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); + expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); + + expect( root.getChild( 1 ).name ).to.equal( 'p' ); + expect( root.getChild( 1 ).maxOffset ).to.equal( 0 ); + expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); + } ); + + it( 'should throw if we try to split a root', () => { + expect( () => { + doc.batch().split( new Position( root, [ 0 ] ) ); + } ).to.throw( CKEditorError, /^batch-split-root/ ); + } ); + + it( 'should be chainable', () => { + const batch = doc.batch(); + + const chain = batch.split( new Position( root, [ 0, 3 ] ) ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + const batch = doc.batch().split( new Position( root, [ 0, 3 ] ) ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'wrap()', () => { + let doc, root, range; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + root.insertChildren( 0, new Text( 'foobar' ) ); + + range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 4 ] ) ); + } ); + + it( 'should wrap flat range with given element', () => { + const p = new Element( 'p' ); + doc.batch().wrap( range, p ); + + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 0 ).data ).to.equal( 'fo' ); + expect( root.getChild( 1 ) ).to.equal( p ); + expect( p.getChild( 0 ).data ).to.equal( 'ob' ); + expect( root.getChild( 2 ).data ).to.equal( 'ar' ); + } ); + + it( 'should wrap flat range with an element of given name', () => { + doc.batch().wrap( range, 'p' ); + + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 0 ).data ).to.equal( 'fo' ); + expect( root.getChild( 1 ).name ).to.equal( 'p' ); + expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'ob' ); + expect( root.getChild( 2 ).data ).to.equal( 'ar' ); + } ); + + it( 'should throw if range to wrap is not flat', () => { + root.insertChildren( 1, [ new Element( 'p', [], new Text( 'xyz' ) ) ] ); + const notFlatRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6, 2 ] ) ); + + expect( () => { + doc.batch().wrap( notFlatRange, 'p' ); + } ).to.throw( CKEditorError, /^batch-wrap-range-not-flat/ ); + } ); + + it( 'should throw if element to wrap with has children', () => { + const p = new Element( 'p', [], new Text( 'a' ) ); + + expect( () => { + doc.batch().wrap( range, p ); + } ).to.throw( CKEditorError, /^batch-wrap-element-not-empty/ ); + } ); + + it( 'should throw if element to wrap with has children', () => { + const p = new Element( 'p' ); + root.insertChildren( 0, p ); + + expect( () => { + doc.batch().wrap( range, p ); + } ).to.throw( CKEditorError, /^batch-wrap-element-attached/ ); + } ); + + it( 'should be chainable', () => { + const batch = doc.batch(); + + const chain = batch.wrap( range, 'p' ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + const batch = doc.batch().wrap( range, 'p' ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'unwrap()', () => { + let doc, root, p; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + + p = new Element( 'p', [], new Text( 'xyz' ) ); + root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); + } ); + + it( 'should unwrap given element', () => { + doc.batch().unwrap( p ); + + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 0 ).data ).to.equal( 'axyzb' ); + } ); + + it( 'should throw if element to unwrap has no parent', () => { + const element = new Element( 'p' ); + + expect( () => { + doc.batch().unwrap( element ); + } ).to.throw( CKEditorError, /^batch-unwrap-element-no-parent/ ); + } ); + + it( 'should be chainable', () => { + const batch = doc.batch(); + + const chain = batch.unwrap( p ); + expect( chain ).to.equal( batch ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + const batch = doc.batch().unwrap( p ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + } ); + + describe( 'setMarker()', () => { + let doc, root, range; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + root.appendChildren( new Text( 'foo' ) ); + range = Range.createIn( root ); + } ); + + it( 'should add marker to the document marker collection', () => { + doc.batch().setMarker( 'name', range ); + + expect( doc.markers.get( 'name' ).getRange().isEqual( range ) ).to.be.true; + } ); + + it( 'should update marker in the document marker collection', () => { + doc.batch().setMarker( 'name', range ); + + const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); + doc.batch().setMarker( 'name', range2 ); + + expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + } ); + + it( 'should accept marker instance', () => { + doc.batch().setMarker( 'name', range ); + const marker = doc.markers.get( 'name' ); + const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); + + const batch = doc.batch().setMarker( marker, range2 ); + const op = batch.deltas[ 0 ].operations[ 0 ]; + + expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + expect( op.oldRange.isEqual( range ) ).to.be.true; + expect( op.newRange.isEqual( range2 ) ).to.be.true; + } ); + + it( 'should accept empty range parameter if marker instance is passed', () => { + const marker = doc.markers.set( 'name', range ); + + sinon.spy( doc, 'fire' ); + + doc.on( 'change', ( evt, type, changes ) => { + if ( type == 'marker' ) { + expect( changes.type ).to.equal( 'set' ); + expect( changes.name ).to.equal( 'name' ); + } + } ); + + const batch = doc.batch().setMarker( marker ); + const op = batch.deltas[ 0 ].operations[ 0 ]; + + expect( doc.fire.calledWith( 'change', 'marker' ) ).to.be.true; + expect( op.oldRange ).to.be.null; + expect( op.newRange.isEqual( range ) ).to.be.true; + } ); + + it( 'should throw if marker with given name does not exist and range is not passed', () => { + expect( () => { + doc.batch().setMarker( 'name' ); + } ).to.throw( CKEditorError, /^batch-setMarker-no-range/ ); + } ); + + it( 'should be chainable', () => { + const batch = doc.batch(); + const chain = batch.setMarker( 'name', range ); + + expect( chain ).to.equal( batch ); + } ); + } ); + + describe( 'removeMarker()', () => { + let doc, root, range; + + beforeEach( () => { + doc = new Document(); + root = doc.createRoot(); + root.appendChildren( new Text( 'foo' ) ); + range = Range.createIn( root ); + } ); + + it( 'should remove marker from the document marker collection', () => { + doc.batch().setMarker( 'name', range ); + doc.batch().removeMarker( 'name' ); + + expect( doc.markers.get( 'name' ) ).to.be.null; + } ); + + it( 'should throw when trying to remove non existing marker', () => { + expect( () => { + doc.batch().removeMarker( 'name' ); + } ).to.throw( CKEditorError, /^batch-removeMarker-no-marker/ ); + } ); + + it( 'should accept marker instance', () => { + doc.batch().setMarker( 'name', range ); + const marker = doc.markers.get( 'name' ); + + doc.batch().removeMarker( marker ); + + expect( doc.markers.get( 'name' ) ).to.be.null; + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + const batch = doc.batch().setMarker( 'name', range ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; } ); } ); } ); diff --git a/tests/model/delta/attributedelta.js b/tests/model/delta/attributedelta.js index b059ce174..442a17a4c 100644 --- a/tests/model/delta/attributedelta.js +++ b/tests/model/delta/attributedelta.js @@ -3,412 +3,14 @@ * For licensing, see LICENSE.md. */ -import count from '@ckeditor/ckeditor5-utils/src/count'; import Document from '../../../src/model/document'; -import Text from '../../../src/model/text'; import Range from '../../../src/model/range'; import Position from '../../../src/model/position'; -import Element from '../../../src/model/element'; import { default as AttributeDelta, RootAttributeDelta } from '../../../src/model/delta/attributedelta'; import AttributeOperation from '../../../src/model/operation/attributeoperation'; import NoOperation from '../../../src/model/operation/nooperation'; import { jsonParseStringify } from '../../../tests/model/_utils/utils'; -describe( 'Batch', () => { - let batch, doc, root; - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - batch = doc.batch(); - } ); - - function getOperationsCount() { - let totalNumber = 0; - - for ( const delta of batch.deltas ) { - totalNumber += count( delta.operations ); - } - - return totalNumber; - } - - describe( 'change attribute on node', () => { - let node, text; - - beforeEach( () => { - node = new Element( 'p', { a: 1 } ); - text = new Text( 'c', { a: 1 } ); - - root.insertChildren( 0, [ node, text ] ); - } ); - - describe( 'setAttribute', () => { - it( 'should create the attribute on element', () => { - batch.setAttribute( node, 'b', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( node.getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of element', () => { - batch.setAttribute( node, 'a', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( node.getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should create the attribute on text node', () => { - batch.setAttribute( text, 'b', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of text node', () => { - batch.setAttribute( text, 'a', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should do nothing if the attribute value is the same', () => { - batch.setAttribute( node, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( node.getAttribute( 'a' ) ).to.equal( 1 ); - } ); - - it( 'should be chainable', () => { - const chain = batch.setAttribute( node, 'b', 2 ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.setAttribute( node, 'b', 2 ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); - - describe( 'removeAttribute', () => { - it( 'should remove the attribute from element', () => { - batch.removeAttribute( node, 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( node.getAttribute( 'a' ) ).to.be.undefined; - } ); - - it( 'should remove the attribute from character', () => { - batch.removeAttribute( text, 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.be.undefined; - } ); - - it( 'should do nothing if the attribute is not set', () => { - batch.removeAttribute( node, 'b' ); - expect( getOperationsCount() ).to.equal( 0 ); - } ); - - it( 'should be chainable', () => { - const chain = batch.removeAttribute( node, 'a' ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.removeAttribute( node, 'a' ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); - } ); - - describe( 'change attribute on range', () => { - beforeEach( () => { - root.insertChildren( 0, [ - new Text( 'xxx', { a: 1 } ), - new Text( 'xxx' ), - new Text( 'xxx', { a: 1 } ), - new Text( 'xxx', { a: 2 } ), - new Text( 'xxx' ), - new Text( 'xxx', { a: 1 } ), - new Element( 'e', { a: 2 }, new Text( 'xxx' ) ), - new Text( 'xxx' ) - ] ); - } ); - - function getRange( startIndex, endIndex ) { - return new Range( - Position.createFromParentAndOffset( root, startIndex ), - Position.createFromParentAndOffset( root, endIndex ) - ); - } - - function getChangesAttrsCount() { - let totalNumber = 0; - - for ( const delta of batch.deltas ) { - for ( const operation of delta.operations ) { - totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); - } - } - - return totalNumber; - } - - function getCompressedAttrs() { - // default: 111---111222---1112------ - const range = Range.createIn( root ); - - return Array.from( range.getItems( { singleCharacters: true } ) ) - .map( item => item.getAttribute( 'a' ) || '-' ) - .join( '' ); - } - - describe( 'setAttribute', () => { - it( 'should set the attribute on the range', () => { - batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 3 ); - expect( getCompressedAttrs() ).to.equal( '111333111222---1112------' ); - } ); - - it( 'should split the operations if parts of the range have different attributes', () => { - batch.setAttribute( getRange( 4, 14 ), 'a', 3 ); - expect( getOperationsCount() ).to.equal( 4 ); - expect( getChangesAttrsCount() ).to.equal( 10 ); - expect( getCompressedAttrs() ).to.equal( '111-3333333333-1112------' ); - } ); - - it( 'should split the operations if parts of the part of the range have the attribute', () => { - batch.setAttribute( getRange( 4, 14 ), 'a', 2 ); - expect( getOperationsCount() ).to.equal( 3 ); - expect( getChangesAttrsCount() ).to.equal( 7 ); - expect( getCompressedAttrs() ).to.equal( '111-2222222222-1112------' ); - } ); - - it( 'should strip the range if the beginning have the attribute', () => { - batch.setAttribute( getRange( 1, 5 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '11111-111222---1112------' ); - } ); - - it( 'should strip the range if the ending have the attribute', () => { - batch.setAttribute( getRange( 13, 17 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '111---111222-111112------' ); - } ); - - it( 'should do nothing if the range has attribute', () => { - batch.setAttribute( getRange( 0, 3 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not check range\'s start position node when creating operations', () => { - const range = new Range( - new Position( root, [ 18, 1 ] ), - new Position( root, [ 19 ] ) - ); - - batch.setAttribute( range, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112-11---' ); - } ); - - it( 'should not change elements attribute if range contains closing tag', () => { - const range = new Range( - new Position( root, [ 18, 1 ] ), - new Position( root, [ 21 ] ) - ); - - batch.setAttribute( range, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 4 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112-1111-' ); - } ); - - it( 'should not create an operation if the range contains only closing tag', () => { - const range = new Range( - new Position( root, [ 18, 3 ] ), - new Position( root, [ 19 ] ) - ); - - batch.setAttribute( range, 'a', 3 ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not create an operation if is collapsed', () => { - batch.setAttribute( getRange( 3, 3 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should create a proper operations for the mixed range', () => { - batch.setAttribute( getRange( 0, 20 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 5 ); - expect( getChangesAttrsCount() ).to.equal( 14 ); - expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); - } ); - - it( 'should be chainable', () => { - const chain = batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); - - describe( 'removeAttribute', () => { - it( 'should remove the attribute on the range', () => { - batch.removeAttribute( getRange( 0, 2 ), 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '--1---111222---1112------' ); - } ); - - it( 'should split the operations if parts of the range have different attributes', () => { - batch.removeAttribute( getRange( 7, 11 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 4 ); - expect( getCompressedAttrs() ).to.equal( '111---1----2---1112------' ); - } ); - - it( 'should split the operations if parts of the part of the range have no attribute', () => { - batch.removeAttribute( getRange( 1, 7 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 3 ); - expect( getCompressedAttrs() ).to.equal( '1------11222---1112------' ); - } ); - - it( 'should strip the range if the beginning have no attribute', () => { - batch.removeAttribute( getRange( 4, 12 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 6 ); - expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); - } ); - - it( 'should strip the range if the ending have no attribute', () => { - batch.removeAttribute( getRange( 7, 15 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 5 ); - expect( getCompressedAttrs() ).to.equal( '111---1--------1112------' ); - } ); - - it( 'should do nothing if the range has no attribute', () => { - batch.removeAttribute( getRange( 4, 5 ), 'a' ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not check range\'s start position node when creating operations', () => { - const range = new Range( - new Position( root, [ 18, 3 ] ), - new Position( root, [ 19 ] ) - ); - - batch.removeAttribute( range, 'a' ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( getChangesAttrsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not apply operation twice in the range contains opening and closing tags', () => { - batch.removeAttribute( getRange( 18, 22 ), 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 1 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---111-------' ); - } ); - - it( 'should not create an operation if range is collapsed', () => { - batch.removeAttribute( getRange( 3, 3 ), 'a' ); - expect( getOperationsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should create a proper operations for the mixed range', () => { - batch.removeAttribute( getRange( 3, 15 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 6 ); - expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); - } ); - - it( 'should be chainable', () => { - const chain = batch.removeAttribute( getRange( 0, 2 ), 'a' ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.removeAttribute( getRange( 0, 2 ), 'a' ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); - } ); - - describe( 'change attribute on root element', () => { - describe( 'setAttribute', () => { - it( 'should create the attribute on root', () => { - batch.setAttribute( root, 'b', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( root.getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of root', () => { - batch.setAttribute( root, 'a', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( root.getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should do nothing if the attribute value is the same', () => { - batch.setAttribute( root, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); - batch.setAttribute( root, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); - expect( root.getAttribute( 'a' ) ).to.equal( 1 ); - } ); - } ); - - describe( 'removeAttribute', () => { - it( 'should remove the attribute from root', () => { - batch.setAttribute( root, 'a', 1 ); - batch.removeAttribute( root, 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); - expect( root.getAttribute( 'a' ) ).to.be.undefined; - } ); - - it( 'should do nothing if the attribute is not set', () => { - batch.removeAttribute( root, 'b' ); - expect( getOperationsCount() ).to.equal( 0 ); - } ); - } ); - } ); - - it( 'should not add empty delta to the batch', () => { - const nodeA = new Element( 'p', { a: 1 } ); - const nodeB = new Element( 'p', { b: 2 } ); - root.insertChildren( 0, [ nodeA, nodeB ] ); - - batch.setAttribute( nodeA, 'a', 1 ); - - expect( batch.deltas.length ).to.equal( 0 ); - - batch.removeAttribute( Range.createIn( root ), 'x' ); - - expect( batch.deltas.length ).to.equal( 0 ); - } ); -} ); - describe( 'AttributeDelta', () => { let doc, root, delta; diff --git a/tests/model/delta/insertdelta.js b/tests/model/delta/insertdelta.js index d595a1429..9ee9467cf 100644 --- a/tests/model/delta/insertdelta.js +++ b/tests/model/delta/insertdelta.js @@ -5,102 +5,14 @@ import Document from '../../../src/model/document'; import Element from '../../../src/model/element'; -import DocumentFragment from '../../../src/model/documentfragment'; -import Text from '../../../src/model/text'; import Position from '../../../src/model/position'; -import Range from '../../../src/model/range'; import InsertOperation from '../../../src/model/operation/insertoperation'; -import MarkerOperation from '../../../src/model/operation/markeroperation'; import InsertDelta from '../../../src/model/delta/insertdelta'; import RemoveDelta from '../../../src/model/delta/removedelta'; import RemoveOperation from '../../../src/model/operation/removeoperation'; -import { stringify } from '../../../src/dev-utils/model'; - -describe( 'Batch', () => { - let doc, root, batch, p, ul, chain; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - root.insertChildren( 0, new Text( 'abc' ) ); - - batch = doc.batch(); - - p = new Element( 'p' ); - ul = new Element( 'ul' ); - - chain = batch.insert( new Position( root, [ 2 ] ), [ p, ul ] ); - } ); - - describe( 'insert', () => { - it( 'should insert given nodes at given position', () => { - expect( root.childCount ).to.equal( 4 ); - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 1 ) ).to.equal( p ); - expect( root.getChild( 2 ) ).to.equal( ul ); - } ); - - it( 'should be chainable', () => { - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.insert( new Position( root, [ 2 ] ), [ p, ul ] ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - - it( 'should transfer markers from given DocumentFragment', () => { - const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); - const marker = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 5 ] ) ); - - documentFragment.markers.set( 'marker', marker ); - - batch.insert( new Position( root, [ 3, 0 ] ), documentFragment ); - - expect( Array.from( doc.markers ).length ).to.equal( 1 ); - expect( stringify( root, doc.markers.get( 'marker' ).getRange() ) ).to.equal( 'ab

  • f[oo b]ar
c' ); - } ); - - it( 'should set each marker as separate operation', () => { - sinon.spy( doc, 'applyOperation' ); - - const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); - const marker1 = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 2 ] ) ); - const marker2 = new Range( new Position( documentFragment, [ 0, 5 ] ), new Position( documentFragment, [ 0, 6 ] ) ); - - documentFragment.markers.set( 'marker1', marker1 ); - documentFragment.markers.set( 'marker2', marker2 ); - - batch.insert( new Position( root, [ 3, 0 ] ), documentFragment ); - - expect( doc.applyOperation.calledThrice ); - expect( doc.applyOperation.firstCall.calledWith( sinon.match( operation => operation instanceof InsertOperation ) ) ); - expect( doc.applyOperation.secondCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); - expect( doc.applyOperation.thirdCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); - } ); - - it( 'should not create a delta and an operation if no nodes were inserted', () => { - sinon.spy( doc, 'applyOperation' ); - - batch = doc.batch(); - - batch.insert( new Position( root, [ 0 ] ), [] ); - - expect( batch.deltas.length ).to.equal( 0 ); - expect( doc.applyOperation.called ).to.be.false; - } ); - } ); -} ); - describe( 'InsertDelta', () => { let insertDelta, doc, root; diff --git a/tests/model/delta/markerdelta.js b/tests/model/delta/markerdelta.js index b14a97534..87673a073 100644 --- a/tests/model/delta/markerdelta.js +++ b/tests/model/delta/markerdelta.js @@ -5,121 +5,10 @@ import Document from '../../../src/model/document'; import Range from '../../../src/model/range'; -import Text from '../../../src/model/text'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import MarkerDelta from '../../../src/model/delta/markerdelta'; import MarkerOperation from '../../../src/model/operation/markeroperation'; -describe( 'Batch', () => { - let doc, root, range; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - root.appendChildren( new Text( 'foo' ) ); - range = Range.createIn( root ); - } ); - - describe( 'setMarker', () => { - it( 'should add marker to the document marker collection', () => { - doc.batch().setMarker( 'name', range ); - - expect( doc.markers.get( 'name' ).getRange().isEqual( range ) ).to.be.true; - } ); - - it( 'should update marker in the document marker collection', () => { - doc.batch().setMarker( 'name', range ); - - const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); - doc.batch().setMarker( 'name', range2 ); - - expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; - } ); - - it( 'should accept marker instance', () => { - doc.batch().setMarker( 'name', range ); - const marker = doc.markers.get( 'name' ); - const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); - - const batch = doc.batch().setMarker( marker, range2 ); - const op = batch.deltas[ 0 ].operations[ 0 ]; - - expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; - expect( op.oldRange.isEqual( range ) ).to.be.true; - expect( op.newRange.isEqual( range2 ) ).to.be.true; - } ); - - it( 'should accept empty range parameter if marker instance is passed', () => { - const marker = doc.markers.set( 'name', range ); - - sinon.spy( doc, 'fire' ); - - doc.on( 'change', ( evt, type, changes ) => { - if ( type == 'marker' ) { - expect( changes.type ).to.equal( 'set' ); - expect( changes.name ).to.equal( 'name' ); - } - } ); - - const batch = doc.batch().setMarker( marker ); - const op = batch.deltas[ 0 ].operations[ 0 ]; - - expect( doc.fire.calledWith( 'change', 'marker' ) ).to.be.true; - expect( op.oldRange ).to.be.null; - expect( op.newRange.isEqual( range ) ).to.be.true; - } ); - - it( 'should throw if marker with given name does not exist and range is not passed', () => { - expect( () => { - doc.batch().setMarker( 'name' ); - } ).to.throw( CKEditorError, /^batch-setMarker-no-range/ ); - } ); - } ); - - describe( 'removeMarker', () => { - it( 'should remove marker from the document marker collection', () => { - doc.batch().setMarker( 'name', range ); - doc.batch().removeMarker( 'name' ); - - expect( doc.markers.get( 'name' ) ).to.be.null; - } ); - - it( 'should throw when trying to remove non existing marker', () => { - expect( () => { - doc.batch().removeMarker( 'name' ); - } ).to.throw( CKEditorError, /^batch-removeMarker-no-marker/ ); - } ); - - it( 'should accept marker instance', () => { - doc.batch().setMarker( 'name', range ); - const marker = doc.markers.get( 'name' ); - - doc.batch().removeMarker( marker ); - - expect( doc.markers.get( 'name' ) ).to.be.null; - } ); - } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - const chain = batch.setMarker( 'name', range ); - - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().setMarker( 'name', range ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); -} ); - describe( 'MarkerDelta', () => { let markerDelta, doc, root, range; diff --git a/tests/model/delta/mergedelta.js b/tests/model/delta/mergedelta.js index 553f6ff55..96c123a3c 100644 --- a/tests/model/delta/mergedelta.js +++ b/tests/model/delta/mergedelta.js @@ -5,9 +5,6 @@ import Document from '../../../src/model/document'; import Position from '../../../src/model/position'; -import Element from '../../../src/model/element'; -import Text from '../../../src/model/text'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import MergeDelta from '../../../src/model/delta/mergedelta'; import SplitDelta from '../../../src/model/delta/splitdelta'; @@ -16,65 +13,6 @@ import MoveOperation from '../../../src/model/operation/moveoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import ReinsertOperation from '../../../src/model/operation/reinsertoperation'; -import count from '@ckeditor/ckeditor5-utils/src/count'; - -describe( 'Batch', () => { - let doc, root, p1, p2, batch; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - p1 = new Element( 'p', { key1: 'value1' }, new Text( 'foo' ) ); - p2 = new Element( 'p', { key2: 'value2' }, new Text( 'bar' ) ); - - root.insertChildren( 0, [ p1, p2 ] ); - } ); - - describe( 'merge', () => { - it( 'should merge foo and bar into foobar', () => { - doc.batch().merge( new Position( root, [ 1 ] ) ); - - expect( root.maxOffset ).to.equal( 1 ); - expect( root.getChild( 0 ).name ).to.equal( 'p' ); - expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); - expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 0 ).getAttribute( 'key1' ) ).to.equal( 'value1' ); - expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); - } ); - - it( 'should throw if there is no element after', () => { - expect( () => { - doc.batch().merge( new Position( root, [ 2 ] ) ); - } ).to.throw( CKEditorError, /^batch-merge-no-element-after/ ); - } ); - - it( 'should throw if there is no element before', () => { - expect( () => { - doc.batch().merge( new Position( root, [ 0, 2 ] ) ); - } ).to.throw( CKEditorError, /^batch-merge-no-element-before/ ); - } ); - - it( 'should be chainable', () => { - batch = doc.batch(); - - const chain = batch.merge( new Position( root, [ 1 ] ) ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch = doc.batch().merge( new Position( root, [ 1 ] ) ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'MergeDelta', () => { let mergeDelta, doc, root; diff --git a/tests/model/delta/movedelta.js b/tests/model/delta/movedelta.js index c17177a1c..f90c6b412 100644 --- a/tests/model/delta/movedelta.js +++ b/tests/model/delta/movedelta.js @@ -3,79 +3,12 @@ * For licensing, see LICENSE.md. */ -import { getNodesAndText } from '../../../tests/model/_utils/utils'; import Document from '../../../src/model/document'; import Position from '../../../src/model/position'; -import Range from '../../../src/model/range'; -import Element from '../../../src/model/element'; -import Text from '../../../src/model/text'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import MoveDelta from '../../../src/model/delta/movedelta'; import MoveOperation from '../../../src/model/operation/moveoperation'; -describe( 'Batch', () => { - let doc, root, div, p, batch, chain; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - div = new Element( 'div', [], new Text( 'foobar' ) ); - p = new Element( 'p', [], new Text( 'abcxyz' ) ); - - div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); - div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); - - root.insertChildren( 0, [ div, p ] ); - - batch = doc.batch(); - } ); - - describe( 'move', () => { - it( 'should move specified node', () => { - batch.move( div, new Position( root, [ 2 ] ) ); - - expect( root.maxOffset ).to.equal( 2 ); - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'PggggPfoobarPhhhhP' ); - } ); - - it( 'should move flat range of nodes', () => { - const range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); - batch.move( range, new Position( root, [ 1, 3 ] ) ); - - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggggPfoPhhhhP' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcobarxyz' ); - } ); - - it( 'should throw if given range is not flat', () => { - const notFlatRange = new Range( new Position( root, [ 0, 2, 2 ] ), new Position( root, [ 0, 6 ] ) ); - - expect( () => { - doc.batch().move( notFlatRange, new Position( root, [ 1, 3 ] ) ); - } ).to.throw( CKEditorError, /^batch-move-range-not-flat/ ); - } ); - - it( 'should be chainable', () => { - chain = batch.move( div, new Position( root, [ 1, 3 ] ) ); - - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.move( div, new Position( root, [ 2 ] ) ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'MoveDelta', () => { let moveDelta, doc, root; diff --git a/tests/model/delta/removedelta.js b/tests/model/delta/removedelta.js index 6509cbcff..d48c38349 100644 --- a/tests/model/delta/removedelta.js +++ b/tests/model/delta/removedelta.js @@ -3,79 +3,8 @@ * For licensing, see LICENSE.md. */ -import { getNodesAndText } from '../../../tests/model/_utils/utils'; -import Document from '../../../src/model/document'; -import Position from '../../../src/model/position'; -import Range from '../../../src/model/range'; -import Element from '../../../src/model/element'; -import Text from '../../../src/model/text'; import RemoveDelta from '../../../src/model/delta/removedelta'; -describe( 'Batch', () => { - let doc, root, div, p, batch, chain, range; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - div = new Element( 'div', [], new Text( 'foobar' ) ); - p = new Element( 'p', [], new Text( 'abcxyz' ) ); - - div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); - div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); - - root.insertChildren( 0, [ div, p ] ); - - batch = doc.batch(); - - // Range starts in ROOT > DIV > P > gg|gg. - // Range ends in ROOT > DIV > ...|ar. - range = new Range( new Position( root, [ 0, 0, 2 ] ), new Position( root, [ 0, 5 ] ) ); - } ); - - describe( 'remove', () => { - it( 'should remove specified node', () => { - batch.remove( div ); - - expect( root.maxOffset ).to.equal( 1 ); - expect( root.childCount ).to.equal( 1 ); - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); - } ); - - it( 'should remove any range of nodes', () => { - batch.remove( range ); - - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); - } ); - - it( 'should create minimal number of remove deltas, each with only one operation', () => { - batch.remove( range ); - - expect( batch.deltas.length ).to.equal( 2 ); - expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); - expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); - } ); - - it( 'should be chainable', () => { - chain = batch.remove( range ); - - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.remove( div ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'RemoveDelta', () => { it( 'should provide proper className', () => { expect( RemoveDelta.className ).to.equal( 'engine.model.delta.RemoveDelta' ); diff --git a/tests/model/delta/renamedelta.js b/tests/model/delta/renamedelta.js index 97c10fefc..991bd214b 100644 --- a/tests/model/delta/renamedelta.js +++ b/tests/model/delta/renamedelta.js @@ -6,55 +6,9 @@ import Document from '../../../src/model/document'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import RenameDelta from '../../../src/model/delta/renamedelta'; -describe( 'Batch', () => { - let doc, root, batch, chain; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - const p = new Element( 'p', null, new Text( 'abc' ) ); - root.appendChildren( p ); - - batch = doc.batch(); - - chain = batch.rename( p, 'h' ); - } ); - - describe( 'rename', () => { - it( 'should rename given element', () => { - expect( root.maxOffset ).to.equal( 1 ); - expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); - expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); - } ); - - it( 'should throw if not an Element instance is passed', () => { - expect( () => { - batch.rename( new Text( 'abc' ), 'h' ); - } ).to.throw( CKEditorError, /^batch-rename-not-element-instance/ ); - } ); - - it( 'should be chainable', () => { - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.rename( root.getChild( 0 ), 'p' ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.alwaysCalledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'RenameDelta', () => { let renameDelta, doc, root; diff --git a/tests/model/delta/splitdelta.js b/tests/model/delta/splitdelta.js index 9e39e4df7..2503d1cc3 100644 --- a/tests/model/delta/splitdelta.js +++ b/tests/model/delta/splitdelta.js @@ -6,8 +6,6 @@ import Document from '../../../src/model/document'; import Position from '../../../src/model/position'; import Element from '../../../src/model/element'; -import Text from '../../../src/model/text'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import MergeDelta from '../../../src/model/delta/mergedelta'; import SplitDelta from '../../../src/model/delta/splitdelta'; @@ -17,82 +15,6 @@ import MoveOperation from '../../../src/model/operation/moveoperation'; import NoOperation from '../../../src/model/operation/nooperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; -import count from '@ckeditor/ckeditor5-utils/src/count'; - -describe( 'Batch', () => { - let doc, root, p; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - p = new Element( 'p', { key: 'value' }, new Text( 'foobar' ) ); - - root.insertChildren( 0, p ); - } ); - - describe( 'split', () => { - it( 'should split foobar to foo and bar', () => { - doc.batch().split( new Position( root, [ 0, 3 ] ) ); - - expect( root.maxOffset ).to.equal( 2 ); - - expect( root.getChild( 0 ).name ).to.equal( 'p' ); - expect( root.getChild( 0 ).maxOffset ).to.equal( 3 ); - expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); - expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' ); - - expect( root.getChild( 1 ).name ).to.equal( 'p' ); - expect( root.getChild( 1 ).maxOffset ).to.equal( 3 ); - expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); - expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'bar' ); - } ); - - it( 'should create an empty paragraph if we split at the end', () => { - doc.batch().split( new Position( root, [ 0, 6 ] ) ); - - expect( root.maxOffset ).to.equal( 2 ); - - expect( root.getChild( 0 ).name ).to.equal( 'p' ); - expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); - expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); - expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); - - expect( root.getChild( 1 ).name ).to.equal( 'p' ); - expect( root.getChild( 1 ).maxOffset ).to.equal( 0 ); - expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); - } ); - - it( 'should throw if we try to split a root', () => { - expect( () => { - doc.batch().split( new Position( root, [ 0 ] ) ); - } ).to.throw( CKEditorError, /^batch-split-root/ ); - } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - - const chain = batch.split( new Position( root, [ 0, 3 ] ) ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().split( new Position( root, [ 0, 3 ] ) ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'SplitDelta', () => { let splitDelta, doc, root; diff --git a/tests/model/delta/unwrapdelta.js b/tests/model/delta/unwrapdelta.js index 3fbacae2a..6cdeca743 100644 --- a/tests/model/delta/unwrapdelta.js +++ b/tests/model/delta/unwrapdelta.js @@ -4,10 +4,7 @@ */ import Document from '../../../src/model/document'; -import Element from '../../../src/model/element'; -import Text from '../../../src/model/text'; import Position from '../../../src/model/position'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import UnwrapDelta from '../../../src/model/delta/unwrapdelta'; import WrapDelta from '../../../src/model/delta/wrapdelta'; @@ -16,53 +13,6 @@ import MoveOperation from '../../../src/model/operation/moveoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import ReinsertOperation from '../../../src/model/operation/reinsertoperation'; -describe( 'Batch', () => { - let doc, root, p; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - p = new Element( 'p', [], new Text( 'xyz' ) ); - root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); - } ); - - describe( 'unwrap', () => { - it( 'should unwrap given element', () => { - doc.batch().unwrap( p ); - - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 0 ).data ).to.equal( 'axyzb' ); - } ); - - it( 'should throw if element to unwrap has no parent', () => { - const element = new Element( 'p' ); - - expect( () => { - doc.batch().unwrap( element ); - } ).to.throw( CKEditorError, /^batch-unwrap-element-no-parent/ ); - } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - - const chain = batch.unwrap( p ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().unwrap( p ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'UnwrapDelta', () => { let unwrapDelta, doc, root; diff --git a/tests/model/delta/weakinsertdelta.js b/tests/model/delta/weakinsertdelta.js index 98117498a..813e3c64b 100644 --- a/tests/model/delta/weakinsertdelta.js +++ b/tests/model/delta/weakinsertdelta.js @@ -3,58 +3,8 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; -import Position from '../../../src/model/position'; -import Text from '../../../src/model/text'; import WeakInsertDelta from '../../../src/model/delta/weakinsertdelta'; -describe( 'Batch', () => { - let doc, root, batch, chain, attrs; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - root.insertChildren( 0, new Text( 'abc' ) ); - - batch = doc.batch(); - - attrs = [ [ 'bold', true ], [ 'foo', 'bar' ] ]; - - doc.selection.setAttributesTo( attrs ); - - chain = batch.weakInsert( new Position( root, [ 2 ] ), 'xyz' ); - } ); - - describe( 'weakInsert', () => { - it( 'should insert given nodes at given position', () => { - expect( root.maxOffset ).to.equal( 6 ); - expect( root.getChild( 0 ).data ).to.equal( 'ab' ); - expect( root.getChild( 1 ).data ).to.equal( 'xyz' ); - expect( root.getChild( 2 ).data ).to.equal( 'c' ); - } ); - - it( 'should set inserted nodes attributes to same as current selection attributes', () => { - expect( Array.from( root.getChild( 1 ).getAttributes() ) ).to.deep.equal( attrs ); - } ); - - it( 'should be chainable', () => { - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.weakInsert( new Position( root, [ 2 ] ), 'xyz' ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'WeakInsertDelta', () => { it( 'should provide proper className', () => { expect( WeakInsertDelta.className ).to.equal( 'engine.model.delta.WeakInsertDelta' ); diff --git a/tests/model/delta/wrapdelta.js b/tests/model/delta/wrapdelta.js index 53688cffc..2315f692a 100644 --- a/tests/model/delta/wrapdelta.js +++ b/tests/model/delta/wrapdelta.js @@ -5,10 +5,7 @@ import Document from '../../../src/model/document'; import Position from '../../../src/model/position'; -import Range from '../../../src/model/range'; import Element from '../../../src/model/element'; -import Text from '../../../src/model/text'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import WrapDelta from '../../../src/model/delta/wrapdelta'; import UnwrapDelta from '../../../src/model/delta/unwrapdelta'; @@ -17,86 +14,6 @@ import InsertOperation from '../../../src/model/operation/insertoperation'; import MoveOperation from '../../../src/model/operation/moveoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; -describe( 'Batch', () => { - let doc, root, range; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - root.insertChildren( 0, new Text( 'foobar' ) ); - - range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 4 ] ) ); - } ); - - describe( 'wrap', () => { - it( 'should wrap flat range with given element', () => { - const p = new Element( 'p' ); - doc.batch().wrap( range, p ); - - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 0 ).data ).to.equal( 'fo' ); - expect( root.getChild( 1 ) ).to.equal( p ); - expect( p.getChild( 0 ).data ).to.equal( 'ob' ); - expect( root.getChild( 2 ).data ).to.equal( 'ar' ); - } ); - - it( 'should wrap flat range with an element of given name', () => { - doc.batch().wrap( range, 'p' ); - - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 0 ).data ).to.equal( 'fo' ); - expect( root.getChild( 1 ).name ).to.equal( 'p' ); - expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'ob' ); - expect( root.getChild( 2 ).data ).to.equal( 'ar' ); - } ); - - it( 'should throw if range to wrap is not flat', () => { - root.insertChildren( 1, [ new Element( 'p', [], new Text( 'xyz' ) ) ] ); - const notFlatRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6, 2 ] ) ); - - expect( () => { - doc.batch().wrap( notFlatRange, 'p' ); - } ).to.throw( CKEditorError, /^batch-wrap-range-not-flat/ ); - } ); - - it( 'should throw if element to wrap with has children', () => { - const p = new Element( 'p', [], new Text( 'a' ) ); - - expect( () => { - doc.batch().wrap( range, p ); - } ).to.throw( CKEditorError, /^batch-wrap-element-not-empty/ ); - } ); - - it( 'should throw if element to wrap with has children', () => { - const p = new Element( 'p' ); - root.insertChildren( 0, p ); - - expect( () => { - doc.batch().wrap( range, p ); - } ).to.throw( CKEditorError, /^batch-wrap-element-attached/ ); - } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - - const chain = batch.wrap( range, 'p' ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().wrap( range, 'p' ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - } ); -} ); - describe( 'WrapDelta', () => { let wrapDelta, doc, root; From 4c0bd6e1cb0528a830440f7daa0b5f8c1076ee7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 20 Nov 2017 23:57:22 +0100 Subject: [PATCH 041/724] Refactored batch interface. --- src/model/batch.js | 140 ++++--- tests/model/batch.js | 853 ++++++++++++++++++++++++++++++++++++------- 2 files changed, 784 insertions(+), 209 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index a871c5c2c..daaecd2fb 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -28,12 +28,11 @@ import RenameOperation from './operation/renameoperation'; import RootAttributeOperation from './operation/rootattributeoperation'; import DocumentFragment from './documentfragment'; +import Text from './text'; import Element from './element'; import Position from './position'; import Range from './range.js'; -import { normalizeNodes } from './writer'; - import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** @@ -129,34 +128,47 @@ export default class Batch { } } - /** - * Inserts a node or nodes at the given position. - * - * When inserted element is a {@link module:engine/model/documentfragment~DocumentFragment} and has markers its markers will - * be set to {@link module:engine/model/document~Document#markers}. - * - * @chainable - * @param {module:engine/model/position~Position} position Position of insertion. - * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted. - */ - insert( position, nodes ) { - const normalizedNodes = normalizeNodes( nodes ); + createText( data, attributes = {} ) { + return new Text( data, attributes ); + } + + createElement( name, attributes ) { + return new Element( name, attributes ); + } + + createDocumentFragment() { + return new DocumentFragment(); + } + + insert( item, itemOrPosition, offset ) { + const position = Position.createAt( itemOrPosition, offset ); - // If nothing is inserted do not create delta and operation. - if ( normalizedNodes.length === 0 ) { - return this; + // For text that has no parent we need to make WeakInsert. + const delta = item instanceof Text && !item.parent ? new WeakInsertDelta() : new InsertDelta(); + + // If item is already in parent. + if ( item.parent ) { + // We need to check if item is going to be inserted to the same root. + if ( item.root === position.root ) { + // If it's we just need to move it. + return this.move( Range.createOn( item ), position ); + } + // If it isn't the same root + else { + // We need to remove this item from old position first. + this.remove( item ); + } } - const delta = new InsertDelta(); - const insert = new InsertOperation( position, normalizedNodes, this.document.version ); + const insert = new InsertOperation( position, item, this.document.version ); this.addDelta( delta ); delta.addOperation( insert ); this.document.applyOperation( insert ); // When element is a DocumentFragment we need to move its markers to Document#markers. - if ( nodes instanceof DocumentFragment ) { - for ( const [ markerName, markerRange ] of nodes.markers ) { + if ( item instanceof DocumentFragment ) { + for ( const [ markerName, markerRange ] of item.markers ) { // We need to migrate marker range from DocumentFragment to Document. const rangeRootPosition = Position.createAt( markerRange.root ); const range = new Range( @@ -171,40 +183,24 @@ export default class Batch { return this; } - /** - * Inserts a node or nodes at given position. {@link module:engine/model/batch~Batch#weakInsert weakInsert} is commonly used for actions - * like typing or plain-text paste (without formatting). There are two differences between - * {@link module:engine/model/batch~Batch#insert insert} and {@link module:engine/model/batch~Batch#weakInsert weakInsert}: - * - * * When using `weakInsert`, inserted nodes will have same attributes as the current attributes of - * {@link module:engine/model/document~Document#selection document selection}. - * * If {@link module:engine/model/operation/insertoperation~InsertOperation insert operation} position is inside a range changed by - * {@link module:engine/model/operation/attributeoperation~AttributeOperation attribute operation}, - * the attribute operation is split into two operations. - * Thanks to this, attribute change "omits" the inserted nodes. The correct behavior for `WeakInsertDelta` is that - * {@link module:engine/model/operation/attributeoperation~AttributeOperation AttributeOperation} does not "break" and also - * applies attributes for inserted nodes. This behavior has to be reflected during - * {@link module:engine/model/delta/transform~transform delta transformation}. - * - * @chainable - * @param {module:engine/model/position~Position} position Position of insertion. - * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted. - */ - weakInsert( position, nodes ) { - const delta = new WeakInsertDelta(); - this.addDelta( delta ); + insertText( text, attributes, itemOrPosition, offset ) { + return this.insert( this.createText( text, attributes ), itemOrPosition, offset ); + } - nodes = normalizeNodes( nodes ); + insertElement( name, attributes, itemOrPosition, offset ) { + return this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); + } - for ( const node of nodes ) { - node.setAttributesTo( this.document.selection.getAttributes() ); - } + append( item, parent ) { + return this.insert( item, parent, 'end' ); + } - const operation = new InsertOperation( position, nodes, this.document.version ); - delta.addOperation( operation ); - this.document.applyOperation( operation ); + appendText( text, attributes, parent ) { + return this.insert( this.createText( text, attributes ), parent, 'end' ); + } - return this; + appendElement( text, attributes, parent ) { + return this.insert( this.createElement( text, attributes ), parent, 'end' ); } /** @@ -309,34 +305,25 @@ export default class Batch { * Moves given {@link module:engine/model/item~Item model item} or given range to target position. * * @chainable - * @method module:engine/model/batch~Batch#move - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range of nodes to move. - * @param {module:engine/model/position~Position} targetPosition Position where moved nodes will be inserted. */ - move( itemOrRange, targetPosition ) { - const delta = new MoveDelta(); - this.addDelta( delta ); + move( range, itemOrPosition, offset ) { + if ( !range.isFlat ) { + /** + * Range to move is not flat. + * + * @error batch-move-range-not-flat + */ + throw new CKEditorError( 'batch-move-range-not-flat: Range to move is not flat.' ); + } - const addOperation = ( sourcePosition, howMany, targetPosition ) => { - const operation = new MoveOperation( sourcePosition, howMany, targetPosition, this.document.version ); - delta.addOperation( operation ); - this.document.applyOperation( operation ); - }; + const position = Position.createAt( itemOrPosition, offset ); - if ( itemOrRange instanceof Range ) { - if ( !itemOrRange.isFlat ) { - /** - * Range to move is not flat. - * - * @error batch-move-range-not-flat - */ - throw new CKEditorError( 'batch-move-range-not-flat: Range to move is not flat.' ); - } + const delta = new MoveDelta(); + this.addDelta( delta ); - addOperation( itemOrRange.start, itemOrRange.end.offset - itemOrRange.start.offset, targetPosition ); - } else { - addOperation( Position.createBefore( itemOrRange ), 1, targetPosition ); - } + const operation = new MoveOperation( range.start, range.end.offset - range.start.offset, position, this.document.version ); + delta.addOperation( operation ); + this.document.applyOperation( operation ); return this; } @@ -704,9 +691,8 @@ function setAttributeToItem( batch, key, value, item ) { const previousValue = item.getAttribute( key ); let range, operation; - const delta = item.is( 'rootElement' ) ? new RootAttributeDelta() : new AttributeDelta(); - if ( previousValue != value ) { + const delta = item.is( 'rootElement' ) ? new RootAttributeDelta() : new AttributeDelta(); batch.addDelta( delta ); if ( item.is( 'rootElement' ) ) { diff --git a/tests/model/batch.js b/tests/model/batch.js index 207d7428a..094448e4d 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -5,6 +5,8 @@ import Batch from '../../src/model/batch'; import Delta from '../../src/model/delta/delta'; +import InsertDelta from '../../src/model/delta/insertdelta'; +import WeakInsertDelta from '../../src/model/delta/weakinsertdelta'; import Operation from '../../src/model/operation/operation'; import InsertOperation from '../../src/model/operation/insertoperation'; @@ -93,57 +95,270 @@ describe( 'Batch', () => { } ); } ); - describe( 'insert', () => { - let doc, root, batch, p, ul, chain; + describe( 'createText()', () => { + let doc, batch; beforeEach( () => { doc = new Document(); - root = doc.createRoot(); - root.insertChildren( 0, new Text( 'abc' ) ); + batch = doc.batch(); + } ); + + it( 'should create text node', () => { + const text = batch.createText( 'foo' ); + + expect( text ).to.instanceof( Text ); + expect( text.data ).to.equal( 'foo' ); + expect( Array.from( text.getAttributes() ) ).to.length( 0 ); + } ); + + it( 'should create text with attributes', () => { + const text = batch.createText( 'foo', { foo: 'bar', biz: 'baz' } ); + + expect( Array.from( text.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'biz', 'baz' ] ] ); + } ); + } ); + + describe( 'createElement()', () => { + let doc, batch; + beforeEach( () => { + doc = new Document(); batch = doc.batch(); + } ); - p = new Element( 'p' ); - ul = new Element( 'ul' ); + it( 'should create element', () => { + const element = batch.createElement( 'foo' ); - chain = batch.insert( new Position( root, [ 2 ] ), [ p, ul ] ); + expect( element ).to.instanceof( Element ); + expect( element.name ).to.equal( 'foo' ); + expect( Array.from( element.getAttributes() ) ).to.length( 0 ); } ); - it( 'should insert given nodes at given position', () => { - expect( root.childCount ).to.equal( 4 ); - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 1 ) ).to.equal( p ); - expect( root.getChild( 2 ) ).to.equal( ul ); + it( 'should create element with attributes', () => { + const element = batch.createText( 'foo', { foo: 'bar', biz: 'baz' } ); + + expect( Array.from( element.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'biz', 'baz' ] ] ); } ); + } ); - it( 'should be chainable', () => { - expect( chain ).to.equal( batch ); + describe( 'createDocumentFragment()', () => { + let doc, batch; + + beforeEach( () => { + doc = new Document(); + batch = doc.batch(); } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.insert( new Position( root, [ 2 ] ), [ p, ul ] ); + it( 'should create element', () => { + const element = batch.createDocumentFragment(); - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); + expect( element ).to.instanceof( DocumentFragment ); + } ); + } ); - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + describe( 'insert()', () => { + let doc, batch; + + beforeEach( () => { + doc = new Document(); + batch = doc.batch(); } ); - it( 'should transfer markers from given DocumentFragment', () => { - const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); + it( 'should insert node at given position', () => { + const parent = batch.createDocumentFragment(); + const child = batch.createElement( 'child' ); + const textChild = batch.createText( 'textChild' ); + + batch.insert( child, new Position( parent, [ 0 ] ) ); + batch.insert( textChild, new Position( parent, [ 1 ] ) ); + + expect( Array.from( parent ) ).to.deep.equal( [ child, textChild ] ); + } ); + + it( 'should insert node at the beginning of given element', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + + batch.insert( child1, parent ); + batch.insert( child2, parent ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child2, child1 ] ); + } ); + + it( 'should insert node at the end of given element', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + + batch.insert( child1, parent ); + batch.insert( child2, parent, 'end' ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2 ] ); + } ); + + it( 'should insert node at the given offset of given element', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + const child3 = batch.createElement( 'child' ); + + batch.insert( child3, parent ); + batch.insert( child1, parent ); + batch.insert( child2, parent, 1 ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); + } ); + + it( 'should insert node before the given node', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + const child3 = batch.createElement( 'child' ); + + batch.insert( child3, parent ); + batch.insert( child1, parent ); + batch.insert( child2, child3, 'before' ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); + } ); + + it( 'should insert node after the given node', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + const child3 = batch.createElement( 'child' ); + + batch.insert( child3, parent ); + batch.insert( child1, parent ); + batch.insert( child2, child1, 'after' ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); + } ); + + it( 'should move element from one parent to the other within different root', () => { + const parent1 = batch.createDocumentFragment(); + const parent2 = batch.createDocumentFragment(); + const b = batch.createText( 'b', { foo: 'bar' } ); + + batch + .insert( batch.createText( 'a' ), parent1 ) + .insert( b, parent1, 'end' ) + .insert( batch.createText( 'c' ), parent1, 'end' ); + + batch.insert( batch.createText( 'ac' ), parent2 ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( b, parent2, 1 ); + + // Verify result. + expect( Array.from( parent1, item => item.data ) ).to.deep.equal( [ 'ac' ] ); + expect( Array.from( parent2, item => item.data ) ).to.deep.equal( [ 'a', 'b', 'c' ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same root', () => { + const root = batch.createDocumentFragment(); + const parent1 = batch.createElement( 'parent' ); + const parent2 = batch.createElement( 'parent' ); + const b = batch.createText( 'b', { foo: 'bar' } ); + + batch + .insert( parent1, root ) + .insert( batch.createText( 'a' ), parent1 ) + .insert( b, parent1, 'end' ) + .insert( batch.createText( 'c' ), parent1, 'end' ); + + batch + .insert( parent2, root ) + .insert( batch.createText( 'ac' ), parent2 ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( b, parent2, 1 ); + + // Verify result. + expect( Array.from( parent1.getChildren(), item => item.data ) ).to.deep.equal( [ 'ac' ] ); + expect( Array.from( parent2.getChildren(), item => item.data ) ).to.deep.equal( [ 'a', 'b', 'c' ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should create proper delta for element', () => { + const parent = batch.createDocumentFragment(); + const element = batch.createElement( 'child' ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( element, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should create proper delta for text with no parent', () => { + const parent = batch.createDocumentFragment(); + const text = batch.createText( 'child' ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( text, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should create proper delta for text with parent', () => { + const parent1 = batch.createDocumentFragment(); + const parent2 = batch.createDocumentFragment(); + const text = batch.createText( 'child' ); + + batch.insert( text, parent1 ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( text, parent2 ); + + sinon.assert.calledTwice( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it.skip( 'should transfer markers from given DocumentFragment', () => { + const documentFragment = batch.createDocumentFragment(); + const li = batch.createElement( 'li' ); + + batch.insert( batch.createText( 'foo bar' ), li ); + batch.insert( li, documentFragment ); + const marker = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 5 ] ) ); documentFragment.markers.set( 'marker', marker ); - batch.insert( new Position( root, [ 3, 0 ] ), documentFragment ); + batch.insert( documentFragment, new Position( root, [ 3, 0 ] ) ); expect( Array.from( doc.markers ).length ).to.equal( 1 ); expect( stringify( root, doc.markers.get( 'marker' ).getRange() ) ).to.equal( 'ab

  • f[oo b]ar
c' ); } ); - it( 'should set each marker as separate operation', () => { + it.skip( 'should set each marker as separate operation', () => { sinon.spy( doc, 'applyOperation' ); const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); @@ -161,65 +376,447 @@ describe( 'Batch', () => { expect( doc.applyOperation.thirdCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); } ); - it( 'should not create a delta and an operation if no nodes were inserted', () => { - sinon.spy( doc, 'applyOperation' ); + it( 'should be chainable', () => { + const parent = batch.createDocumentFragment(); + const child = batch.createElement( 'child' ); + + expect( batch.insert( child, parent ) ).to.equal( batch ); + } ); + } ); + + describe( 'insertText()', () => { + let doc, batch; + beforeEach( () => { + doc = new Document(); batch = doc.batch(); + } ); - batch.insert( new Position( root, [ 0 ] ), [] ); + it( 'should create and insert text node with attributes at given position', () => { + const parent = batch.createDocumentFragment(); - expect( batch.deltas.length ).to.equal( 0 ); - expect( doc.applyOperation.called ).to.be.false; + batch.insertText( 'foo', { bar: 'biz' }, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + } ); + + it( 'should create and insert text node with no attributes at given position', () => { + const parent = batch.createDocumentFragment(); + + batch.insertText( 'foo', null, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert text node at the beginning of given element', () => { + const parent = batch.createDocumentFragment(); + + batch.insert( batch.createElement( 'child' ), parent ); + + batch.insertText( 'foo', null, parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 1 ) ).to.instanceof( Element ); + } ); + + it( 'should create and insert text node at the end of given element', () => { + const parent = batch.createDocumentFragment(); + + batch.insert( batch.createElement( 'child' ), parent ); + + batch.insertText( 'foo', null, parent, 'end' ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + } ); + + it( 'should create and insert text node at the given offset of given element', () => { + const parent = batch.createDocumentFragment(); + + batch.insert( batch.createElement( 'child' ), parent ); + batch.insert( batch.createElement( 'child' ), parent ); + + batch.insertText( 'foo', null, parent, 1 ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + expect( parent.getChild( 2 ) ).to.instanceof( Element ); + } ); + + it( 'should create and insert text node before the given node', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + + batch.insert( child1, parent ); + batch.insert( child2, parent, 'end' ); + + batch.insertText( 'foo', null, child2, 'before' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + expect( parent.getChild( 2 ) ).to.instanceof( Element ); + } ); + + it( 'should create and insert text node after the given node', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child' ); + const child2 = batch.createElement( 'child' ); + + batch.insert( child1, parent ); + batch.insert( child2, parent, 'end' ); + + batch.insertText( 'foo', null, child1, 'after' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + expect( parent.getChild( 2 ) ).to.instanceof( Element ); + } ); + + it( 'should create proper delta', () => { + const parent = batch.createDocumentFragment(); + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insertText( 'foo', null, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should be chainable', () => { + const parent = batch.createDocumentFragment(); + + expect( batch.insertText( 'foo', null, parent ) ).to.equal( batch ); } ); } ); - describe( 'weakInsert()', () => { - let doc, root, batch, chain, attrs; + describe( 'insertElement()', () => { + let doc, batch; beforeEach( () => { doc = new Document(); - root = doc.createRoot(); + batch = doc.batch(); + } ); + + it( 'should create and insert element with attributes at given position', () => { + const parent = batch.createDocumentFragment(); + + batch.insertElement( 'foo', { bar: 'biz' }, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + } ); + + it( 'should create and insert element with no attributes at given position', () => { + const parent = batch.createDocumentFragment(); + + batch.insertElement( 'foo', null, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert element at the beginning of given element', () => { + const parent = batch.createDocumentFragment(); + + batch.insert( batch.createElement( 'child' ), parent ); + + batch.insertElement( 'foo', null, parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 1 ).name ).to.equal( 'child' ); + } ); + + it( 'should create and insert element at the end of given element', () => { + const parent = batch.createDocumentFragment(); + + batch.insert( batch.createElement( 'child' ), parent ); + + batch.insertElement( 'foo', null, parent, 'end' ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + } ); + + it( 'should create and insert element at the given offset of given element', () => { + const parent = batch.createDocumentFragment(); + + batch.insert( batch.createElement( 'child1' ), parent ); + batch.insert( batch.createElement( 'child2' ), parent, 'end' ); + + batch.insertElement( 'foo', null, parent, 1 ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); + } ); + + it( 'should create and insert element before the given node', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child1' ); + const child2 = batch.createElement( 'child2' ); + + batch.insert( child1, parent ); + batch.insert( child2, parent, 'end' ); + + batch.insertElement( 'foo', null, child2, 'before' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); + } ); + + it( 'should create and insert element after the given node', () => { + const parent = batch.createDocumentFragment(); + const child1 = batch.createElement( 'child1' ); + const child2 = batch.createElement( 'child2' ); + + batch.insert( child1, parent ); + batch.insert( child2, parent, 'end' ); + + batch.insertElement( 'foo', null, child1, 'after' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); + } ); + + it( 'should create proper delta', () => { + const parent = batch.createDocumentFragment(); + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insertText( 'foo', null, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should be chainable', () => { + const parent = batch.createDocumentFragment(); + + expect( batch.insertElement( 'foo', null, parent ) ).to.equal( batch ); + } ); + } ); + + describe( 'append()', () => { + let doc, batch; + + beforeEach( () => { + doc = new Document(); + batch = doc.batch(); + } ); + + it( 'should insert element at the end of the parent', () => { + const parent = doc.batch().createDocumentFragment(); + const childText = doc.batch().createText( 'foo' ); + const childElement = doc.batch().createElement( 'foo' ); + + batch.append( childText, parent ); + batch.append( childElement, parent ); + + expect( Array.from( parent ) ).to.deep.equal( [ childText, childElement ] ); + } ); + + it( 'should create proper delta', () => { + const parent = batch.createDocumentFragment(); + const text = batch.createText( 'foo' ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.append( text, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within different root', () => { + const parent1 = batch.createDocumentFragment(); + const parent2 = batch.createDocumentFragment(); + const b = batch.createText( 'b', { foo: 'bar' } ); + + batch + .append( batch.createText( 'a' ), parent1 ) + .append( b, parent1 ) + .append( batch.createText( 'c' ), parent1 ); + + const spy = sinon.spy( doc, 'applyOperation' ); - root.insertChildren( 0, new Text( 'abc' ) ); + batch.append( b, parent2, 1 ); + // Verify result. + expect( Array.from( parent1, item => item.data ) ).to.deep.equal( [ 'ac' ] ); + expect( Array.from( parent2, item => item.data ) ).to.deep.equal( [ 'b' ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same root', () => { + const root = batch.createDocumentFragment(); + const parent1 = batch.createElement( 'parent' ); + const parent2 = batch.createElement( 'parent' ); + const b = batch.createText( 'b', { foo: 'bar' } ); + + batch + .append( parent1, root ) + .append( batch.createText( 'a' ), parent1 ) + .append( b, parent1 ) + .append( batch.createText( 'c' ), parent1 ); + + batch.append( parent2, root ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.append( b, parent2 ); + + // Verify result. + expect( Array.from( parent1.getChildren(), item => item.data ) ).to.deep.equal( [ 'ac' ] ); + expect( Array.from( parent2.getChildren(), item => item.data ) ).to.deep.equal( [ 'b' ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should be chainable', () => { + expect( batch.append( batch.createElement( 'a' ), batch.createElement( 'b' ) ) ).to.equal( batch ); + } ); + } ); + + describe( 'appendText()', () => { + let doc, batch; + + beforeEach( () => { + doc = new Document(); batch = doc.batch(); + } ); - attrs = [ [ 'bold', true ], [ 'foo', 'bar' ] ]; + it( 'should create and insert text node with attributes at the end of the parent', () => { + const parent = batch.createDocumentFragment(); - doc.selection.setAttributesTo( attrs ); + batch.appendText( 'foo', { bar: 'biz' }, parent ); + batch.appendText( 'bar', { biz: 'bar' }, parent ); - chain = batch.weakInsert( new Position( root, [ 2 ] ), 'xyz' ); + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + expect( parent.getChild( 1 ).data ).to.equal( 'bar' ); + expect( Array.from( parent.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'biz', 'bar' ] ] ); } ); - it( 'should insert given nodes at given position', () => { - expect( root.maxOffset ).to.equal( 6 ); - expect( root.getChild( 0 ).data ).to.equal( 'ab' ); - expect( root.getChild( 1 ).data ).to.equal( 'xyz' ); - expect( root.getChild( 2 ).data ).to.equal( 'c' ); + it( 'should create and insert text node with no attributes at the end of the parent', () => { + const parent = batch.createDocumentFragment(); + + batch.appendText( 'foo', null, parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); - it( 'should set inserted nodes attributes to same as current selection attributes', () => { - expect( Array.from( root.getChild( 1 ).getAttributes() ) ).to.deep.equal( attrs ); + it( 'should create proper delta', () => { + const parent = batch.createDocumentFragment(); + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.appendText( 'foo', null, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); it( 'should be chainable', () => { - expect( chain ).to.equal( batch ); + const parent = batch.createDocumentFragment(); + + expect( batch.appendText( 'foo', null, parent ) ).to.equal( batch ); } ); + } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.weakInsert( new Position( root, [ 2 ] ), 'xyz' ); + describe( 'appendElement()', () => { + let doc, batch; - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); + beforeEach( () => { + doc = new Document(); + batch = doc.batch(); + } ); - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + it( 'should create and insert element with attributes at the end of the parent', () => { + const parent = batch.createDocumentFragment(); + + batch.appendElement( 'foo', { bar: 'biz' }, parent ); + batch.appendElement( 'bar', { biz: 'bar' }, parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + expect( parent.getChild( 1 ).name ).to.equal( 'bar' ); + expect( Array.from( parent.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'biz', 'bar' ] ] ); + } ); + + it( 'should create and insert element with no attributes at the end of the parent', () => { + const parent = batch.createDocumentFragment(); + + batch.appendElement( 'foo', null, parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create proper delta', () => { + const parent = batch.createDocumentFragment(); + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.appendElement( 'foo', null, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should be chainable', () => { + const parent = batch.createDocumentFragment(); + + expect( batch.appendElement( 'foo', null, parent ) ).to.equal( batch ); } ); } ); describe( 'setAttribute() / removeAttribute()', () => { - let batch, doc, root; + let batch, doc, root, spy; const correctDeltaMatcher = sinon.match( operation => { return operation.delta && operation.delta.batch && operation.delta.batch == batch; @@ -231,54 +828,47 @@ describe( 'Batch', () => { batch = doc.batch(); } ); - function getOperationsCount() { - let totalNumber = 0; - - for ( const delta of batch.deltas ) { - totalNumber += count( delta.operations ); - } - - return totalNumber; - } - describe( 'change attribute on node', () => { let node, text; beforeEach( () => { - node = new Element( 'p', { a: 1 } ); - text = new Text( 'c', { a: 1 } ); + node = batch.createElement( 'p', { a: 1 } ); + text = batch.createText( 'c', { a: 1 } ); + + batch.append( node, root ); + batch.append( text, root ); - root.insertChildren( 0, [ node, text ] ); + spy = sinon.spy( doc, 'applyOperation' ); } ); describe( 'setAttribute', () => { it( 'should create the attribute on element', () => { batch.setAttribute( node, 'b', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( node.getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should change the attribute of element', () => { batch.setAttribute( node, 'a', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( node.getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should create the attribute on text node', () => { batch.setAttribute( text, 'b', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( root.getChild( 1 ).getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should change the attribute of text node', () => { batch.setAttribute( text, 'a', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should do nothing if the attribute value is the same', () => { batch.setAttribute( node, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( node.getAttribute( 'a' ) ).to.equal( 1 ); } ); @@ -288,29 +878,28 @@ describe( 'Batch', () => { } ); it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); batch.setAttribute( node, 'b', 2 ); - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + sinon.assert.calledWith( spy, correctDeltaMatcher ); } ); } ); describe( 'removeAttribute', () => { it( 'should remove the attribute from element', () => { batch.removeAttribute( node, 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( node.getAttribute( 'a' ) ).to.be.undefined; } ); it( 'should remove the attribute from character', () => { batch.removeAttribute( text, 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.be.undefined; } ); it( 'should do nothing if the attribute is not set', () => { batch.removeAttribute( node, 'b' ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); } ); it( 'should be chainable', () => { @@ -319,26 +908,29 @@ describe( 'Batch', () => { } ); it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); batch.removeAttribute( node, 'a' ); - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + sinon.assert.calledWith( spy, correctDeltaMatcher ); } ); } ); } ); describe( 'change attribute on range', () => { beforeEach( () => { - root.insertChildren( 0, [ - new Text( 'xxx', { a: 1 } ), - new Text( 'xxx' ), - new Text( 'xxx', { a: 1 } ), - new Text( 'xxx', { a: 2 } ), - new Text( 'xxx' ), - new Text( 'xxx', { a: 1 } ), - new Element( 'e', { a: 2 }, new Text( 'xxx' ) ), - new Text( 'xxx' ) - ] ); + const element = batch.createElement( 'e', { a: 2 } ); + + batch + .appendText( 'xxx', { a: 1 }, root ) + .appendText( 'xxx', null, root ) + .appendText( 'xxx', { a: 1 }, root ) + .appendText( 'xxx', { a: 2 }, root ) + .appendText( 'xxx', null, root ) + .appendText( 'xxx', { a: 1 }, root ) + .appendText( 'xxx', null, element ) + .append( element, root ) + .appendText( 'xxx', null, root ); + + spy = sinon.spy( doc, 'applyOperation' ); } ); function getRange( startIndex, endIndex ) { @@ -353,7 +945,9 @@ describe( 'Batch', () => { for ( const delta of batch.deltas ) { for ( const operation of delta.operations ) { - totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); + if ( operation.range ) { + totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); + } } } @@ -372,42 +966,42 @@ describe( 'Batch', () => { describe( 'setAttribute', () => { it( 'should set the attribute on the range', () => { batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 3 ); expect( getCompressedAttrs() ).to.equal( '111333111222---1112------' ); } ); it( 'should split the operations if parts of the range have different attributes', () => { batch.setAttribute( getRange( 4, 14 ), 'a', 3 ); - expect( getOperationsCount() ).to.equal( 4 ); + expect( spy.callCount ).to.equal( 4 ); expect( getChangesAttrsCount() ).to.equal( 10 ); expect( getCompressedAttrs() ).to.equal( '111-3333333333-1112------' ); } ); it( 'should split the operations if parts of the part of the range have the attribute', () => { batch.setAttribute( getRange( 4, 14 ), 'a', 2 ); - expect( getOperationsCount() ).to.equal( 3 ); + expect( spy.callCount ).to.equal( 3 ); expect( getChangesAttrsCount() ).to.equal( 7 ); expect( getCompressedAttrs() ).to.equal( '111-2222222222-1112------' ); } ); it( 'should strip the range if the beginning have the attribute', () => { batch.setAttribute( getRange( 1, 5 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '11111-111222---1112------' ); } ); it( 'should strip the range if the ending have the attribute', () => { batch.setAttribute( getRange( 13, 17 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '111---111222-111112------' ); } ); it( 'should do nothing if the range has attribute', () => { batch.setAttribute( getRange( 0, 3 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); @@ -418,7 +1012,7 @@ describe( 'Batch', () => { ); batch.setAttribute( range, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112-11---' ); } ); @@ -430,7 +1024,7 @@ describe( 'Batch', () => { ); batch.setAttribute( range, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 4 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112-1111-' ); } ); @@ -442,19 +1036,19 @@ describe( 'Batch', () => { ); batch.setAttribute( range, 'a', 3 ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should not create an operation if is collapsed', () => { batch.setAttribute( getRange( 3, 3 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should create a proper operations for the mixed range', () => { batch.setAttribute( getRange( 0, 20 ), 'a', 1 ); - expect( getOperationsCount() ).to.equal( 5 ); + expect( spy.callCount ).to.equal( 5 ); expect( getChangesAttrsCount() ).to.equal( 14 ); expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); } ); @@ -465,7 +1059,6 @@ describe( 'Batch', () => { } ); it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; @@ -475,42 +1068,42 @@ describe( 'Batch', () => { describe( 'removeAttribute', () => { it( 'should remove the attribute on the range', () => { batch.removeAttribute( getRange( 0, 2 ), 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '--1---111222---1112------' ); } ); it( 'should split the operations if parts of the range have different attributes', () => { batch.removeAttribute( getRange( 7, 11 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); + expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 4 ); expect( getCompressedAttrs() ).to.equal( '111---1----2---1112------' ); } ); it( 'should split the operations if parts of the part of the range have no attribute', () => { batch.removeAttribute( getRange( 1, 7 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); + expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 3 ); expect( getCompressedAttrs() ).to.equal( '1------11222---1112------' ); } ); it( 'should strip the range if the beginning have no attribute', () => { batch.removeAttribute( getRange( 4, 12 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); + expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 6 ); expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); } ); it( 'should strip the range if the ending have no attribute', () => { batch.removeAttribute( getRange( 7, 15 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); + expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 5 ); expect( getCompressedAttrs() ).to.equal( '111---1--------1112------' ); } ); it( 'should do nothing if the range has no attribute', () => { batch.removeAttribute( getRange( 4, 5 ), 'a' ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); @@ -521,27 +1114,27 @@ describe( 'Batch', () => { ); batch.removeAttribute( range, 'a' ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( getChangesAttrsCount() ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should not apply operation twice in the range contains opening and closing tags', () => { batch.removeAttribute( getRange( 18, 22 ), 'a' ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 1 ); expect( getCompressedAttrs() ).to.equal( '111---111222---111-------' ); } ); it( 'should not create an operation if range is collapsed', () => { batch.removeAttribute( getRange( 3, 3 ), 'a' ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should create a proper operations for the mixed range', () => { batch.removeAttribute( getRange( 3, 15 ), 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); + expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 6 ); expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); } ); @@ -552,33 +1145,35 @@ describe( 'Batch', () => { } ); it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); batch.removeAttribute( getRange( 0, 2 ), 'a' ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + sinon.assert.calledWith( spy, correctDeltaMatcher ); } ); } ); } ); describe( 'change attribute on root element', () => { + beforeEach( () => { + spy = sinon.spy( doc, 'applyOperation' ); + } ); + describe( 'setAttribute', () => { it( 'should create the attribute on root', () => { batch.setAttribute( root, 'b', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should change the attribute of root', () => { batch.setAttribute( root, 'a', 2 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should do nothing if the attribute value is the same', () => { batch.setAttribute( root, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); batch.setAttribute( root, 'a', 1 ); - expect( getOperationsCount() ).to.equal( 1 ); + expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'a' ) ).to.equal( 1 ); } ); } ); @@ -587,13 +1182,14 @@ describe( 'Batch', () => { it( 'should remove the attribute from root', () => { batch.setAttribute( root, 'a', 1 ); batch.removeAttribute( root, 'a' ); - expect( getOperationsCount() ).to.equal( 2 ); + + expect( spy.callCount ).to.equal( 2 ); expect( root.getAttribute( 'a' ) ).to.be.undefined; } ); it( 'should do nothing if the attribute is not set', () => { batch.removeAttribute( root, 'b' ); - expect( getOperationsCount() ).to.equal( 0 ); + expect( spy.callCount ).to.equal( 0 ); } ); } ); } ); @@ -669,7 +1265,7 @@ describe( 'Batch', () => { } ); describe( 'move()', () => { - let doc, root, div, p, batch, chain; + let doc, root, range, div, p, batch, chain; beforeEach( () => { doc = new Document(); @@ -683,19 +1279,12 @@ describe( 'Batch', () => { root.insertChildren( 0, [ div, p ] ); - batch = doc.batch(); - } ); - - it( 'should move specified node', () => { - batch.move( div, new Position( root, [ 2 ] ) ); + range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); - expect( root.maxOffset ).to.equal( 2 ); - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'PggggPfoobarPhhhhP' ); + batch = doc.batch(); } ); it( 'should move flat range of nodes', () => { - const range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); batch.move( range, new Position( root, [ 1, 3 ] ) ); expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggggPfoPhhhhP' ); @@ -711,14 +1300,14 @@ describe( 'Batch', () => { } ); it( 'should be chainable', () => { - chain = batch.move( div, new Position( root, [ 1, 3 ] ) ); + chain = batch.move( range, new Position( root, [ 1, 3 ] ) ); expect( chain ).to.equal( batch ); } ); it( 'should add delta to batch and operation to delta before applying operation', () => { sinon.spy( doc, 'applyOperation' ); - batch.move( div, new Position( root, [ 2 ] ) ); + batch.move( range, new Position( root, [ 2 ] ) ); const correctDeltaMatcher = sinon.match( operation => { return operation.delta && operation.delta.batch && operation.delta.batch == batch; From 8da94737b9c1a27da2c3b14f8c362fcbb9ad34e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 21 Nov 2017 00:02:46 +0100 Subject: [PATCH 042/724] Improved checking if target element is a root. --- src/model/documentselection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 7db3fb86b..8b6375a4e 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -723,7 +723,7 @@ function clearAttributesStoredInElement( changes, batch, document ) { // `changes.range` is not set in case of rename, root and marker operations. // None of them may lead to the element becoming non-empty. - if ( !changeParent || changeParent.isEmpty ) { + if ( !changeParent || changeParent.is( 'documentFragment' ) || changeParent.isEmpty ) { return; } From f106f8d824d48378f4e50d3d8a7cd2784636a2e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 21 Nov 2017 08:59:10 +0100 Subject: [PATCH 043/724] Added more methods for changing attributes to the Batch interface. --- src/model/batch.js | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/src/model/batch.js b/src/model/batch.js index daaecd2fb..63ab68f08 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -223,6 +223,12 @@ export default class Batch { return this; } + setAttributes( itemOrRange, attributes ) { + for ( const attribute of Object.keys( attributes ) ) { + this.setAttribute( itemOrRange, attribute, attributes[ attribute ] ); + } + } + /** * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} * or from a {@link module:engine/model/range~Range range}. @@ -243,6 +249,22 @@ export default class Batch { return this; } + clearAttributes( itemOrRange ) { + const removeAttributesFromItem = item => { + for ( const attribute of item.getAttributeKeys() ) { + this.removeAttribute( item, attribute ); + } + }; + + if ( !( itemOrRange instanceof Range ) ) { + removeAttributesFromItem( itemOrRange ); + } else { + for ( const item of itemOrRange.getItems() ) { + removeAttributesFromItem( item ); + } + } + } + /** * Merges two siblings at the given position. * From 6f5ea7fd5ef2077a59bd51f73a83cff0daf4319a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 21 Nov 2017 21:06:51 +0100 Subject: [PATCH 044/724] Improved batch API. --- src/model/batch.js | 155 ++++++++++-------- tests/model/batch.js | 367 +++++++++++++++++++++++++++++++++---------- 2 files changed, 369 insertions(+), 153 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 63ab68f08..afcc99d2d 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -30,9 +30,12 @@ import RootAttributeOperation from './operation/rootattributeoperation'; import DocumentFragment from './documentfragment'; import Text from './text'; import Element from './element'; +import RootElement from './rootelement'; import Position from './position'; import Range from './range.js'; +import toMap from '@ckeditor/ckeditor5-utils/src/tomap'; + import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** @@ -143,17 +146,17 @@ export default class Batch { insert( item, itemOrPosition, offset ) { const position = Position.createAt( itemOrPosition, offset ); - // For text that has no parent we need to make WeakInsert. + // For text that has no parent we need to make a WeakInsert. const delta = item instanceof Text && !item.parent ? new WeakInsertDelta() : new InsertDelta(); - // If item is already in parent. + // If item has a parent already. if ( item.parent ) { - // We need to check if item is going to be inserted to the same root. - if ( item.root === position.root ) { + // We need to check if item is going to be inserted within the same document. + if ( isTheSameDocument( item.root, position.root ) ) { // If it's we just need to move it. return this.move( Range.createOn( item ), position ); } - // If it isn't the same root + // If it isn't the same root. else { // We need to remove this item from old position first. this.remove( item ); @@ -224,8 +227,8 @@ export default class Batch { } setAttributes( itemOrRange, attributes ) { - for ( const attribute of Object.keys( attributes ) ) { - this.setAttribute( itemOrRange, attribute, attributes[ attribute ] ); + for ( const [ key, val ] of toMap( attributes ) ) { + this.setAttribute( itemOrRange, key, val ); } } @@ -265,64 +268,6 @@ export default class Batch { } } - /** - * Merges two siblings at the given position. - * - * Node before and after the position have to be an element. Otherwise `batch-merge-no-element-before` or - * `batch-merge-no-element-after` error will be thrown. - * - * @chainable - * @param {module:engine/model/position~Position} position Position of merge. - */ - merge( position ) { - const delta = new MergeDelta(); - this.addDelta( delta ); - - const nodeBefore = position.nodeBefore; - const nodeAfter = position.nodeAfter; - - if ( !( nodeBefore instanceof Element ) ) { - /** - * Node before merge position must be an element. - * - * @error batch-merge-no-element-before - */ - throw new CKEditorError( 'batch-merge-no-element-before: Node before merge position must be an element.' ); - } - - if ( !( nodeAfter instanceof Element ) ) { - /** - * Node after merge position must be an element. - * - * @error batch-merge-no-element-after - */ - throw new CKEditorError( 'batch-merge-no-element-after: Node after merge position must be an element.' ); - } - - const positionAfter = Position.createFromParentAndOffset( nodeAfter, 0 ); - const positionBefore = Position.createFromParentAndOffset( nodeBefore, nodeBefore.maxOffset ); - - const move = new MoveOperation( - positionAfter, - nodeAfter.maxOffset, - positionBefore, - this.document.version - ); - - move.isSticky = true; - delta.addOperation( move ); - this.document.applyOperation( move ); - - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - const remove = new RemoveOperation( position, 1, gyPosition, this.document.version ); - delta.addOperation( remove ); - this.document.applyOperation( remove ); - - return this; - } - /** * Moves given {@link module:engine/model/item~Item model item} or given range to target position. * @@ -340,6 +285,16 @@ export default class Batch { const position = Position.createAt( itemOrPosition, offset ); + if ( !isTheSameDocument( range.root, position.root ) ) { + /** + * Range is going to be moved within not the same document. Please use + * {@link module:engine/model/batch~Batch#insert insert} instead. + * + * @error batch-move-different-document + */ + throw new CKEditorError( 'batch-move-different-document: Range is going to be moved between different documents.' ); + } + const delta = new MoveDelta(); this.addDelta( delta ); @@ -377,12 +332,72 @@ export default class Batch { addRemoveDelta( flat.start, flat.end.offset - flat.start.offset ); } } else { - addRemoveDelta( Position.createBefore( itemOrRange ), 1 ); + const howMany = itemOrRange.is( 'text' ) ? itemOrRange.offsetSize : 1; + + addRemoveDelta( Position.createBefore( itemOrRange ), howMany ); } return this; } + /** + * Merges two siblings at the given position. + * + * Node before and after the position have to be an element. Otherwise `batch-merge-no-element-before` or + * `batch-merge-no-element-after` error will be thrown. + * + * @chainable + * @param {module:engine/model/position~Position} position Position of merge. + */ + merge( position ) { + const delta = new MergeDelta(); + this.addDelta( delta ); + + const nodeBefore = position.nodeBefore; + const nodeAfter = position.nodeAfter; + + if ( !( nodeBefore instanceof Element ) ) { + /** + * Node before merge position must be an element. + * + * @error batch-merge-no-element-before + */ + throw new CKEditorError( 'batch-merge-no-element-before: Node before merge position must be an element.' ); + } + + if ( !( nodeAfter instanceof Element ) ) { + /** + * Node after merge position must be an element. + * + * @error batch-merge-no-element-after + */ + throw new CKEditorError( 'batch-merge-no-element-after: Node after merge position must be an element.' ); + } + + const positionAfter = Position.createFromParentAndOffset( nodeAfter, 0 ); + const positionBefore = Position.createFromParentAndOffset( nodeBefore, nodeBefore.maxOffset ); + + const move = new MoveOperation( + positionAfter, + nodeAfter.maxOffset, + positionBefore, + this.document.version + ); + + move.isSticky = true; + delta.addOperation( move ); + this.document.applyOperation( move ); + + const graveyard = this.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + const remove = new RemoveOperation( position, 1, gyPosition, this.document.version ); + delta.addOperation( remove ); + this.document.applyOperation( remove ); + + return this; + } + /** * Renames given element. * @@ -759,3 +774,11 @@ function addMarkerOperation( batch, name, oldRange, newRange ) { delta.addOperation( operation ); doc.applyOperation( operation ); } + +function isTheSameDocument( rootA, rootB ) { + if ( rootA === rootB ) { + return true; + } + + return rootA instanceof RootElement && rootB instanceof RootElement; +} diff --git a/tests/model/batch.js b/tests/model/batch.js index 094448e4d..372bfb2ac 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -236,57 +236,73 @@ describe( 'Batch', () => { expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); } ); - it( 'should move element from one parent to the other within different root', () => { - const parent1 = batch.createDocumentFragment(); - const parent2 = batch.createDocumentFragment(); - const b = batch.createText( 'b', { foo: 'bar' } ); + it( 'should create proper delta for inserting element', () => { + const parent = batch.createDocumentFragment(); + const element = batch.createElement( 'child' ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( element, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should create proper delta for inserting text', () => { + const parent = batch.createDocumentFragment(); + const text = batch.createText( 'child' ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.insert( text, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); - batch - .insert( batch.createText( 'a' ), parent1 ) - .insert( b, parent1, 'end' ) - .insert( batch.createText( 'c' ), parent1, 'end' ); + it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { + const rootA = doc.createRoot(); + const parent1 = batch.createElement( 'parent' ); + const parent2 = batch.createElement( 'parent' ); + const node = batch.createText( 'foo' ); - batch.insert( batch.createText( 'ac' ), parent2 ); + batch.insert( node, parent1 ); + batch.insert( parent1, rootA ); + batch.insert( parent2, rootA ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insert( b, parent2, 1 ); + batch.insert( node, parent2 ); // Verify result. - expect( Array.from( parent1, item => item.data ) ).to.deep.equal( [ 'ac' ] ); - expect( Array.from( parent2, item => item.data ) ).to.deep.equal( [ 'a', 'b', 'c' ] ); + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within the same root', () => { - const root = batch.createDocumentFragment(); - const parent1 = batch.createElement( 'parent' ); - const parent2 = batch.createElement( 'parent' ); - const b = batch.createText( 'b', { foo: 'bar' } ); - - batch - .insert( parent1, root ) - .insert( batch.createText( 'a' ), parent1 ) - .insert( b, parent1, 'end' ) - .insert( batch.createText( 'c' ), parent1, 'end' ); + it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { + const rootA = doc.createRoot( '$root', 'A' ); + const rootB = doc.createRoot( '$root', 'B' ); + const node = batch.createText( 'foo' ); - batch - .insert( parent2, root ) - .insert( batch.createText( 'ac' ), parent2 ); + batch.insert( node, rootA ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insert( b, parent2, 1 ); + batch.insert( node, rootB ); // Verify result. - expect( Array.from( parent1.getChildren(), item => item.data ) ).to.deep.equal( [ 'ac' ] ); - expect( Array.from( parent2.getChildren(), item => item.data ) ).to.deep.equal( [ 'a', 'b', 'c' ] ); + expect( Array.from( rootA.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( rootB.getChildren() ) ).to.deep.equal( [ node ] ); // Verify deltas and operations. sinon.assert.calledOnce( spy ); @@ -294,51 +310,74 @@ describe( 'Batch', () => { expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should create proper delta for element', () => { - const parent = batch.createDocumentFragment(); - const element = batch.createElement( 'child' ); + it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { + const docFragA = batch.createDocumentFragment(); + const parent1 = batch.createElement( 'parent' ); + const parent2 = batch.createElement( 'parent' ); + const node = batch.createText( 'foo' ); + + batch.insert( node, parent1 ); + batch.insert( parent1, docFragA ); + batch.insert( parent2, docFragA ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insert( element, parent ); + batch.insert( node, parent2 ); + + // Verify result. + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); + // Verify deltas and operations. sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); - expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should create proper delta for text with no parent', () => { - const parent = batch.createDocumentFragment(); - const text = batch.createText( 'child' ); + it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { + const root = doc.createRoot(); + const docFrag = batch.createDocumentFragment(); + const node = batch.createText( 'foo' ); + + batch.insert( node, root ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insert( text, parent ); + batch.insert( node, docFrag ); - sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + // Verify result. + expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should create proper delta for text with parent', () => { - const parent1 = batch.createDocumentFragment(); - const parent2 = batch.createDocumentFragment(); - const text = batch.createText( 'child' ); + it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { + const docFragA = batch.createDocumentFragment(); + const docFragB = batch.createDocumentFragment(); + const node = batch.createText( 'foo' ); - batch.insert( text, parent1 ); + batch.insert( node, docFragA ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insert( text, parent2 ); + batch.insert( node, docFragB ); + // Verify result. + expect( Array.from( docFragA ) ).to.deep.equal( [] ); + expect( Array.from( docFragB ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. sinon.assert.calledTwice( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); - expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); it.skip( 'should transfer markers from given DocumentFragment', () => { @@ -654,53 +693,68 @@ describe( 'Batch', () => { expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within different root', () => { - const parent1 = batch.createDocumentFragment(); - const parent2 = batch.createDocumentFragment(); - const b = batch.createText( 'b', { foo: 'bar' } ); + it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { + const rootA = doc.createRoot(); + const parent1 = batch.createElement( 'parent' ); + const parent2 = batch.createElement( 'parent' ); + const node = batch.createText( 'foo' ); - batch - .append( batch.createText( 'a' ), parent1 ) - .append( b, parent1 ) - .append( batch.createText( 'c' ), parent1 ); + batch.insert( node, parent1 ); + batch.insert( parent1, rootA ); + batch.insert( parent2, rootA ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.append( b, parent2, 1 ); + batch.append( node, parent2 ); // Verify result. - expect( Array.from( parent1, item => item.data ) ).to.deep.equal( [ 'ac' ] ); - expect( Array.from( parent2, item => item.data ) ).to.deep.equal( [ 'b' ] ); + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within the same root', () => { - const root = batch.createDocumentFragment(); + it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { + const rootA = doc.createRoot( '$root', 'A' ); + const rootB = doc.createRoot( '$root', 'B' ); + const node = batch.createText( 'foo' ); + + batch.insert( node, rootA ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.append( node, rootB ); + + // Verify result. + expect( Array.from( rootA.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( rootB.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { + const docFragA = batch.createDocumentFragment(); const parent1 = batch.createElement( 'parent' ); const parent2 = batch.createElement( 'parent' ); - const b = batch.createText( 'b', { foo: 'bar' } ); - - batch - .append( parent1, root ) - .append( batch.createText( 'a' ), parent1 ) - .append( b, parent1 ) - .append( batch.createText( 'c' ), parent1 ); + const node = batch.createText( 'foo' ); - batch.append( parent2, root ); + batch.insert( node, parent1 ); + batch.insert( parent1, docFragA ); + batch.insert( parent2, docFragA ); const spy = sinon.spy( doc, 'applyOperation' ); - batch.append( b, parent2 ); + batch.append( node, parent2 ); // Verify result. - expect( Array.from( parent1.getChildren(), item => item.data ) ).to.deep.equal( [ 'ac' ] ); - expect( Array.from( parent2.getChildren(), item => item.data ) ).to.deep.equal( [ 'b' ] ); + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); // Verify deltas and operations. sinon.assert.calledOnce( spy ); @@ -708,6 +762,52 @@ describe( 'Batch', () => { expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); + it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { + const root = doc.createRoot(); + const docFrag = batch.createDocumentFragment(); + const node = batch.createText( 'foo' ); + + batch.insert( node, root ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.append( node, docFrag ); + + // Verify result. + expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { + const docFragA = batch.createDocumentFragment(); + const docFragB = batch.createDocumentFragment(); + const node = batch.createText( 'foo' ); + + batch.insert( node, docFragA ); + + const spy = sinon.spy( doc, 'applyOperation' ); + + batch.append( node, docFragB ); + + // Verify result. + expect( Array.from( docFragA ) ).to.deep.equal( [] ); + expect( Array.from( docFragB ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + it( 'should be chainable', () => { expect( batch.append( batch.createElement( 'a' ), batch.createElement( 'b' ) ) ).to.equal( batch ); } ); @@ -1209,6 +1309,91 @@ describe( 'Batch', () => { } ); } ); + describe( 'setAttributes()', () => { + let doc, batch, frag, item; + + beforeEach( () => { + doc = new Document(); + batch = doc.batch(); + + frag = batch.createDocumentFragment(); + item = batch.createText( 'xxx', { b: 2, c: 3 } ); + + batch.appendText( 'xxx', { a: 1 }, frag ); + batch.append( item, frag ); + } ); + + it( 'should set attributes one by one on range', () => { + const range = Range.createIn( frag ); + + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( batch, 'setAttribute' ); + + batch.setAttributes( range, { a: 3, c: null } ); + + // Verify result. + expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); + expect( Array.from( frag.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, range, 'a', 3 ); + sinon.assert.calledWith( spy.secondCall, range, 'c', null ); + } ); + + it( 'should set attributes one by one on range for map as attributes list', () => { + const range = Range.createIn( frag ); + + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( batch, 'setAttribute' ); + + batch.setAttributes( range, new Map( [ [ 'a', 3 ], [ 'c', null ] ] ) ); + + // Verify result. + expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); + expect( Array.from( frag.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, range, 'a', 3 ); + sinon.assert.calledWith( spy.secondCall, range, 'c', null ); + } ); + + it( 'should set attributes one by one on item', () => { + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( batch, 'setAttribute' ); + + batch.setAttributes( item, { a: 3, c: null } ); + + // Verify result. + expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, item, 'a', 3 ); + sinon.assert.calledWith( spy.secondCall, item, 'c', null ); + } ); + + it( 'should set attributes one by one on item for maps as attributes list', () => { + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( batch, 'setAttribute' ); + + batch.setAttributes( item, new Map( [ [ 'a', 3 ], [ 'c', null ] ] ) ); + + // Verify result. + expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, item, 'a', 3 ); + sinon.assert.calledWith( spy.secondCall, item, 'c', null ); + } ); + } ); + describe( 'merge()', () => { let doc, root, p1, p2, batch; @@ -1299,6 +1484,14 @@ describe( 'Batch', () => { } ).to.throw( CKEditorError, /^batch-move-range-not-flat/ ); } ); + it( 'should throw if range is going to be moved to the other document', () => { + const docFrag = batch.createDocumentFragment(); + + expect( () => { + doc.batch().move( range, docFrag ); + } ).to.throw( CKEditorError, /^batch-move-different-document/ ); + } ); + it( 'should be chainable', () => { chain = batch.move( range, new Position( root, [ 1, 3 ] ) ); From f57ed3d62df33593c521f6ca5a5717843fab5daa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 12:16:25 +0100 Subject: [PATCH 045/724] Added root getter to the AttributeOperation. --- src/model/operation/attributeoperation.js | 7 +++++ tests/model/operation/attributeoperation.js | 29 +++++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index 88ab99ad3..6d34fc95d 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -88,6 +88,13 @@ export default class AttributeOperation extends Operation { } } + /** + * @inheritDoc + */ + get root() { + return this.range.root; + } + /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/tests/model/operation/attributeoperation.js b/tests/model/operation/attributeoperation.js index e02569c2c..4a62bf329 100644 --- a/tests/model/operation/attributeoperation.js +++ b/tests/model/operation/attributeoperation.js @@ -59,6 +59,35 @@ describe( 'AttributeOperation', () => { } ); } ); + describe( 'root', () => { + it( 'should return root of range when range is in document', () => { + const op = new AttributeOperation( + new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), + 'key', + 'oldValue', + 'newValue', + doc.version + ); + + expect( op.root ).to.equal( root ); + } ); + + it( 'should return root of range when range is in document fragment', () => { + const docFrag = doc.batch().createDocumentFragment(); + doc.batch().appendText( 'abc', null, docFrag ); + + const op = new AttributeOperation( + Range.createIn( docFrag ), + 'key', + 'oldValue', + 'newValue', + doc.version + ); + + expect( op.root ).to.equal( docFrag ); + } ); + } ); + it( 'should insert attribute to the set of nodes', () => { root.insertChildren( 0, new Text( 'bar' ) ); From 122b3ddcb7f382ec4e75a1a06c092d8cdf594831 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 12:32:48 +0100 Subject: [PATCH 046/724] Added root getter to the InsertOperation. --- src/model/operation/insertoperation.js | 7 +++++++ tests/model/operation/insertoperation.js | 24 ++++++++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 26ff844e2..3d469ea69 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -55,6 +55,13 @@ export default class InsertOperation extends Operation { return 'insert'; } + /** + * @inheritDoc + */ + get root() { + return this.position.root; + } + /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/tests/model/operation/insertoperation.js b/tests/model/operation/insertoperation.js index d862cd04d..0aa0f202b 100644 --- a/tests/model/operation/insertoperation.js +++ b/tests/model/operation/insertoperation.js @@ -206,6 +206,30 @@ describe( 'InsertOperation', () => { expect( op2.nodes.getNode( 0 ) ).not.to.equal( text ); } ); + describe( 'root', () => { + it( 'should return operation root for document', () => { + const op = new InsertOperation( + new Position( root, [ 0 ] ), + new Text( 'x' ), + doc.version + ); + + expect( op.root ).to.equal( root ); + } ); + + it( 'should return operation root for document fragment', () => { + const docFrag = doc.batch().createDocumentFragment(); + + const op = new InsertOperation( + new Position( docFrag, [ 0 ] ), + new Text( 'x' ), + doc.version + ); + + expect( op.root ).to.equal( docFrag ); + } ); + } ); + describe( 'toJSON', () => { it( 'should create proper json object', () => { const position = new Position( root, [ 0 ] ); From fabcad2b9282f9b96c12fe5d4c1641cd41d8452c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 12:34:54 +0100 Subject: [PATCH 047/724] Added root getter to the MarkerOperation. --- src/model/operation/markeroperation.js | 7 +++++++ tests/model/operation/markeroperation.js | 14 ++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/src/model/operation/markeroperation.js b/src/model/operation/markeroperation.js index 96b28d699..586cf7ea4 100644 --- a/src/model/operation/markeroperation.js +++ b/src/model/operation/markeroperation.js @@ -64,6 +64,13 @@ export default class MarkerOperation extends Operation { return 'marker'; } + /** + * @inheritDoc + */ + get root() { + return this.newRange ? this.newRange.root : this.oldRange.root; + } + /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/tests/model/operation/markeroperation.js b/tests/model/operation/markeroperation.js index 50abd0b06..25732caed 100644 --- a/tests/model/operation/markeroperation.js +++ b/tests/model/operation/markeroperation.js @@ -161,6 +161,20 @@ describe( 'MarkerOperation', () => { expect( clone ).to.deep.equal( op ); } ); + describe( 'type', () => { + it( 'should return root of new marker range when new marker is added', () => { + const op = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); + + expect( op.root ).to.equal( root ); + } ); + + it( 'should return root of old marker range when marker is removed', () => { + const op = new MarkerOperation( 'name', range, null, doc.markers, doc.version ); + + expect( op.root ).to.equal( root ); + } ); + } ); + describe( 'toJSON', () => { it( 'should create proper serialized object', () => { const op = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); From 692e79fae0c10d6ac3133435fb80a7deabd238d7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 12:36:02 +0100 Subject: [PATCH 048/724] Added docs for root property to the Operation class. --- src/model/operation/operation.js | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/model/operation/operation.js b/src/model/operation/operation.js index dad5f3a46..eeb3e0f73 100644 --- a/src/model/operation/operation.js +++ b/src/model/operation/operation.js @@ -45,6 +45,15 @@ export default class Operation { * @member {module:engine/model/delta/delta~Delta} #delta */ + /** + * Root within operation is applied. It might be {@link module:engine/model/rootelement~RootElement RootElement} + * when operation is applied on {@link module:engine/model/document~Document Document} or any + * {module:engine/model/item~Item} when operation is applied on detached node. + * + * @readonly + * @member {module:engine/model/item~Item} #root + */ + /** * Creates and returns an operation that has the same parameters as this operation. * From 317a877fa1d67f5ca29acb6986df15979a78b993 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 12:51:18 +0100 Subject: [PATCH 049/724] Added root getter to the MoveOperation. --- src/model/operation/moveoperation.js | 9 +++++++++ tests/model/operation/moveoperation.js | 28 ++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/src/model/operation/moveoperation.js b/src/model/operation/moveoperation.js index 2e03267cb..a45422c8c 100644 --- a/src/model/operation/moveoperation.js +++ b/src/model/operation/moveoperation.js @@ -73,6 +73,15 @@ export default class MoveOperation extends Operation { return 'move'; } + /** + * @inheritDoc + */ + get root() { + // Note that range cannot be moved within different documents e.g. from docFrag to document root so + // root of source and target positions will be always the same. + return this.targetPosition.root; + } + /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/tests/model/operation/moveoperation.js b/tests/model/operation/moveoperation.js index 708cd399c..7a970306a 100644 --- a/tests/model/operation/moveoperation.js +++ b/tests/model/operation/moveoperation.js @@ -267,6 +267,34 @@ describe( 'MoveOperation', () => { expect( clone.baseVersion ).to.equal( baseVersion ); } ); + describe( 'root', () => { + it( 'should return root for document', () => { + const op = new MoveOperation( + new Position( root, [ 0, 0 ] ), + 1, + new Position( root, [ 1, 0 ] ), + doc.version + ); + + expect( op.root ).to.equal( root ); + } ); + + it( 'should return root for document fragment', () => { + const docFrag = doc.batch().createDocumentFragment(); + + doc.batch().appendText( 'abc', null, docFrag ); + + const op = new MoveOperation( + new Position( docFrag, [ 0 ] ), + 1, + new Position( docFrag, [ 2 ] ), + doc.version + ); + + expect( op.root ).to.equal( docFrag ); + } ); + } ); + describe( 'getMovedRangeStart', () => { it( 'should return move operation target position transformed by removing move operation source range', () => { const sourcePosition = new Position( root, [ 0, 2 ] ); From ab481d16cb986c49693adab5a2a6bac2cb91c0bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 12:59:25 +0100 Subject: [PATCH 050/724] Added root getter to the ReinsertOperation. --- src/model/operation/reinsertoperation.js | 7 +++++++ tests/model/operation/reinsertoperation.js | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/src/model/operation/reinsertoperation.js b/src/model/operation/reinsertoperation.js index d3bddfb2a..b461f1054 100644 --- a/src/model/operation/reinsertoperation.js +++ b/src/model/operation/reinsertoperation.js @@ -40,6 +40,13 @@ export default class ReinsertOperation extends MoveOperation { return 'reinsert'; } + /** + * @inheritDoc + */ + get root() { + return this.targetPosition.root; + } + /** * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}. * diff --git a/tests/model/operation/reinsertoperation.js b/tests/model/operation/reinsertoperation.js index b08ca50b5..69444886a 100644 --- a/tests/model/operation/reinsertoperation.js +++ b/tests/model/operation/reinsertoperation.js @@ -99,6 +99,10 @@ describe( 'ReinsertOperation', () => { expect( graveyard.maxOffset ).to.equal( 2 ); } ); + it( 'should return root of operation', () => { + expect( operation.root ).to.equal( root ); + } ); + describe( 'toJSON', () => { it( 'should create proper json object', () => { const serialized = jsonParseStringify( operation ); From cc85957998e4b7b37e32bb71453181adc2f4d71e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 14:36:11 +0100 Subject: [PATCH 051/724] Added isDocumentOperation property to the RemoveOperation. --- src/model/operation/removeoperation.js | 10 ++++++++++ tests/model/operation/removeoperation.js | 11 +++++++++++ 2 files changed, 21 insertions(+) diff --git a/src/model/operation/removeoperation.js b/src/model/operation/removeoperation.js index a08a32849..65fe79076 100644 --- a/src/model/operation/removeoperation.js +++ b/src/model/operation/removeoperation.js @@ -21,6 +21,16 @@ export default class RemoveOperation extends MoveOperation { return 'remove'; } + /** + * Remove operation cannot be applied on element that is not inside the document + * so this will always be a document operation. + * + * @member {Boolean} + */ + get isDocumentOperation() { + return true; + } + /** * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}. * diff --git a/tests/model/operation/removeoperation.js b/tests/model/operation/removeoperation.js index 3553f2d46..3f949dcbc 100644 --- a/tests/model/operation/removeoperation.js +++ b/tests/model/operation/removeoperation.js @@ -140,6 +140,17 @@ describe( 'RemoveOperation', () => { expect( doc.graveyard.getChild( 2 ).name ).to.equal( 'y' ); } ); + it( 'should always be a document operation', () => { + const op = new RemoveOperation( + new Position( root, [ 2 ] ), + 2, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ); + + expect( op.isDocumentOperation ).to.true; + } ); + describe( 'toJSON', () => { it( 'should create proper json object', () => { const op = new RemoveOperation( From 1674e0c45611b074da253efc4feb6a26aad9af2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 14:52:18 +0100 Subject: [PATCH 052/724] Throw when RemoveOperation is executed on detached item. --- src/model/operation/removeoperation.js | 19 +++++++++++++++++++ tests/model/operation/removeoperation.js | 20 ++++++++++++++++++++ 2 files changed, 39 insertions(+) diff --git a/src/model/operation/removeoperation.js b/src/model/operation/removeoperation.js index 65fe79076..32ad7b6d2 100644 --- a/src/model/operation/removeoperation.js +++ b/src/model/operation/removeoperation.js @@ -9,6 +9,7 @@ import MoveOperation from './moveoperation'; import ReinsertOperation from './reinsertoperation'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Operation to remove a range of nodes. @@ -42,6 +43,24 @@ export default class RemoveOperation extends MoveOperation { return new ReinsertOperation( this.getMovedRangeStart(), this.howMany, newTargetPosition, this.baseVersion + 1 ); } + /** + * @inheritDoc + */ + _execute() { + if ( !this.sourcePosition.root.document ) { + /** + * Item that is going to be removed needs to be a {@link module:engine/model/document~Document document} child. + * To remove Item from detached document fragment use + * {@link module:engine/model/operation/detachoperation~DetachOperation DetachOperation}. + * + * @error remove-operation-on-detached-item + */ + throw new CKEditorError( 'remove-operation-on-detached-item: Cannot remove detached item.' ); + } + + return super._execute(); + } + /** * @inheritDoc */ diff --git a/tests/model/operation/removeoperation.js b/tests/model/operation/removeoperation.js index 3f949dcbc..33b755b7d 100644 --- a/tests/model/operation/removeoperation.js +++ b/tests/model/operation/removeoperation.js @@ -10,6 +10,7 @@ import MoveOperation from '../../../src/model/operation/moveoperation'; import Position from '../../../src/model/position'; import Text from '../../../src/model/text'; import Element from '../../../src/model/element'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'RemoveOperation', () => { @@ -140,6 +141,25 @@ describe( 'RemoveOperation', () => { expect( doc.graveyard.getChild( 2 ).name ).to.equal( 'y' ); } ); + it( 'should throw when is executed on detached item', () => { + const batch = doc.batch(); + const docFrag = batch.createDocumentFragment(); + const item = batch.createElement( 'foo' ); + + batch.append( item, docFrag ); + + const op = new RemoveOperation( + new Position( docFrag, [ 0 ] ), + 1, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ); + + expect( () => { + op._execute(); + } ).to.throw( CKEditorError, /^remove-operation-on-detached-item/ ); + } ); + it( 'should always be a document operation', () => { const op = new RemoveOperation( new Position( root, [ 2 ] ), From d7916c1b76445d07aff0c8217063489af2c95954 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 16:20:03 +0100 Subject: [PATCH 053/724] Changed root property to isDocumentOperation. --- src/model/operation/attributeoperation.js | 4 +-- src/model/operation/insertoperation.js | 4 +-- src/model/operation/markeroperation.js | 6 ++-- src/model/operation/moveoperation.js | 4 +-- src/model/operation/nooperation.js | 7 ++++ src/model/operation/operation.js | 6 ++-- src/model/operation/reinsertoperation.js | 24 +++++++++++-- src/model/operation/renameoperation.js | 7 ++++ src/model/operation/rootattributeoperation.js | 10 ++++++ tests/model/operation/attributeoperation.js | 10 +++--- tests/model/operation/insertoperation.js | 10 +++--- tests/model/operation/markeroperation.js | 10 +++--- tests/model/operation/moveoperation.js | 10 +++--- tests/model/operation/nooperation.js | 4 +++ tests/model/operation/reinsertoperation.js | 35 +++++++++++++++++-- tests/model/operation/renameoperation.js | 19 ++++++++++ .../model/operation/rootattributeoperation.js | 28 +++++++++++++++ 17 files changed, 161 insertions(+), 37 deletions(-) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index 6d34fc95d..52dc3bff0 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -91,8 +91,8 @@ export default class AttributeOperation extends Operation { /** * @inheritDoc */ - get root() { - return this.range.root; + get isDocumentOperation() { + return !!this.range.root.document; } /** diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 3d469ea69..e8077e91c 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -58,8 +58,8 @@ export default class InsertOperation extends Operation { /** * @inheritDoc */ - get root() { - return this.position.root; + get isDocumentOperation() { + return !!this.position.root.document; } /** diff --git a/src/model/operation/markeroperation.js b/src/model/operation/markeroperation.js index 586cf7ea4..3a551a7bd 100644 --- a/src/model/operation/markeroperation.js +++ b/src/model/operation/markeroperation.js @@ -67,8 +67,10 @@ export default class MarkerOperation extends Operation { /** * @inheritDoc */ - get root() { - return this.newRange ? this.newRange.root : this.oldRange.root; + get isDocumentOperation() { + const root = this.newRange ? this.newRange.root : this.oldRange.root; + + return !!root.document; } /** diff --git a/src/model/operation/moveoperation.js b/src/model/operation/moveoperation.js index a45422c8c..cededd45a 100644 --- a/src/model/operation/moveoperation.js +++ b/src/model/operation/moveoperation.js @@ -76,10 +76,10 @@ export default class MoveOperation extends Operation { /** * @inheritDoc */ - get root() { + get isDocumentOperation() { // Note that range cannot be moved within different documents e.g. from docFrag to document root so // root of source and target positions will be always the same. - return this.targetPosition.root; + return !!this.targetPosition.root.document; } /** diff --git a/src/model/operation/nooperation.js b/src/model/operation/nooperation.js index 184f0b3e6..a79b37544 100644 --- a/src/model/operation/nooperation.js +++ b/src/model/operation/nooperation.js @@ -42,6 +42,13 @@ export default class NoOperation extends Operation { return new NoOperation( this.baseVersion + 1 ); } + /** + * @inheritDoc + */ + get isDocumentOperation() { + return true; + } + /** * @inheritDoc */ diff --git a/src/model/operation/operation.js b/src/model/operation/operation.js index eeb3e0f73..b5aa08a71 100644 --- a/src/model/operation/operation.js +++ b/src/model/operation/operation.js @@ -46,12 +46,10 @@ export default class Operation { */ /** - * Root within operation is applied. It might be {@link module:engine/model/rootelement~RootElement RootElement} - * when operation is applied on {@link module:engine/model/document~Document Document} or any - * {module:engine/model/item~Item} when operation is applied on detached node. + * Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}. * * @readonly - * @member {module:engine/model/item~Item} #root + * @member {Boolean} #isDocumentOperation */ /** diff --git a/src/model/operation/reinsertoperation.js b/src/model/operation/reinsertoperation.js index b461f1054..edc3304dc 100644 --- a/src/model/operation/reinsertoperation.js +++ b/src/model/operation/reinsertoperation.js @@ -9,6 +9,7 @@ import MoveOperation from './moveoperation'; import RemoveOperation from './removeoperation'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Operation to reinsert previously removed nodes back to the non-graveyard root. This operation acts like @@ -41,10 +42,12 @@ export default class ReinsertOperation extends MoveOperation { } /** - * @inheritDoc + * Reinsert operation is always executed on attached items. + * + * @member {Boolean} */ - get root() { - return this.targetPosition.root; + get isDocumentOperation() { + return true; } /** @@ -58,6 +61,21 @@ export default class ReinsertOperation extends MoveOperation { return new RemoveOperation( this.getMovedRangeStart(), this.howMany, newTargetPosition, this.baseVersion + 1 ); } + /** + * @inheritDoc + */ + _execute() { + if ( !this.sourcePosition.root.document ) { + throw new CKEditorError( 'reinsert-operation-on-detached-item: Cannot reinsert detached item.' ); + } + + if ( !this.targetPosition.root.document ) { + throw new CKEditorError( 'reinsert-operation-to-detached-parent: Cannot reinsert item to detached parent.' ); + } + + return super._execute(); + } + /** * @inheritDoc */ diff --git a/src/model/operation/renameoperation.js b/src/model/operation/renameoperation.js index 502cd6828..bb39e6508 100644 --- a/src/model/operation/renameoperation.js +++ b/src/model/operation/renameoperation.js @@ -60,6 +60,13 @@ export default class RenameOperation extends Operation { return 'rename'; } + /** + * @inheritDoc + */ + get isDocumentOperation() { + return !!this.position.root.document; + } + /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/src/model/operation/rootattributeoperation.js b/src/model/operation/rootattributeoperation.js index 362f03be6..b29202491 100644 --- a/src/model/operation/rootattributeoperation.js +++ b/src/model/operation/rootattributeoperation.js @@ -69,6 +69,9 @@ export default class RootAttributeOperation extends Operation { this.newValue = newValue; } + /** + * @inheritDoc + */ get type() { if ( this.oldValue === null ) { return 'addRootAttribute'; @@ -79,6 +82,13 @@ export default class RootAttributeOperation extends Operation { } } + /** + * @inheritDoc + */ + get isDocumentOperation() { + return !!this.root.document; + } + /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/tests/model/operation/attributeoperation.js b/tests/model/operation/attributeoperation.js index 4a62bf329..ce46e0537 100644 --- a/tests/model/operation/attributeoperation.js +++ b/tests/model/operation/attributeoperation.js @@ -59,8 +59,8 @@ describe( 'AttributeOperation', () => { } ); } ); - describe( 'root', () => { - it( 'should return root of range when range is in document', () => { + describe( 'isDocumentOperation', () => { + it( 'should return true when attribute is applied on attached items', () => { const op = new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), 'key', @@ -69,10 +69,10 @@ describe( 'AttributeOperation', () => { doc.version ); - expect( op.root ).to.equal( root ); + expect( op.isDocumentOperation ).to.true; } ); - it( 'should return root of range when range is in document fragment', () => { + it( 'should return false when attribute is applied on detached items', () => { const docFrag = doc.batch().createDocumentFragment(); doc.batch().appendText( 'abc', null, docFrag ); @@ -84,7 +84,7 @@ describe( 'AttributeOperation', () => { doc.version ); - expect( op.root ).to.equal( docFrag ); + expect( op.isDocumentOperation ).to.false; } ); } ); diff --git a/tests/model/operation/insertoperation.js b/tests/model/operation/insertoperation.js index 0aa0f202b..c0c04844f 100644 --- a/tests/model/operation/insertoperation.js +++ b/tests/model/operation/insertoperation.js @@ -206,18 +206,18 @@ describe( 'InsertOperation', () => { expect( op2.nodes.getNode( 0 ) ).not.to.equal( text ); } ); - describe( 'root', () => { - it( 'should return operation root for document', () => { + describe( 'isDocumentOperation', () => { + it( 'should return true when element is inserted to the document', () => { const op = new InsertOperation( new Position( root, [ 0 ] ), new Text( 'x' ), doc.version ); - expect( op.root ).to.equal( root ); + expect( op.isDocumentOperation ).to.true; } ); - it( 'should return operation root for document fragment', () => { + it( 'should return false when element is inserted to document fragment', () => { const docFrag = doc.batch().createDocumentFragment(); const op = new InsertOperation( @@ -226,7 +226,7 @@ describe( 'InsertOperation', () => { doc.version ); - expect( op.root ).to.equal( docFrag ); + expect( op.isDocumentOperation ).to.false; } ); } ); diff --git a/tests/model/operation/markeroperation.js b/tests/model/operation/markeroperation.js index 25732caed..4139ed8a3 100644 --- a/tests/model/operation/markeroperation.js +++ b/tests/model/operation/markeroperation.js @@ -161,17 +161,17 @@ describe( 'MarkerOperation', () => { expect( clone ).to.deep.equal( op ); } ); - describe( 'type', () => { - it( 'should return root of new marker range when new marker is added', () => { + describe( 'isDocumentOperation', () => { + it( 'should return true when new marker range is added to the document', () => { const op = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); - expect( op.root ).to.equal( root ); + expect( op.isDocumentOperation ).to.true; } ); - it( 'should return root of old marker range when marker is removed', () => { + it( 'should return false when marker range is removed from the document', () => { const op = new MarkerOperation( 'name', range, null, doc.markers, doc.version ); - expect( op.root ).to.equal( root ); + expect( op.isDocumentOperation ).to.true; } ); } ); diff --git a/tests/model/operation/moveoperation.js b/tests/model/operation/moveoperation.js index 7a970306a..d45c49ba7 100644 --- a/tests/model/operation/moveoperation.js +++ b/tests/model/operation/moveoperation.js @@ -267,8 +267,8 @@ describe( 'MoveOperation', () => { expect( clone.baseVersion ).to.equal( baseVersion ); } ); - describe( 'root', () => { - it( 'should return root for document', () => { + describe( 'isDocumentOperation', () => { + it( 'should return root when operation is executed on attached items', () => { const op = new MoveOperation( new Position( root, [ 0, 0 ] ), 1, @@ -276,10 +276,10 @@ describe( 'MoveOperation', () => { doc.version ); - expect( op.root ).to.equal( root ); + expect( op.isDocumentOperation ).to.true; } ); - it( 'should return root for document fragment', () => { + it( 'should return false when operation is executed on detached items', () => { const docFrag = doc.batch().createDocumentFragment(); doc.batch().appendText( 'abc', null, docFrag ); @@ -291,7 +291,7 @@ describe( 'MoveOperation', () => { doc.version ); - expect( op.root ).to.equal( docFrag ); + expect( op.isDocumentOperation ).to.false; } ); } ); diff --git a/tests/model/operation/nooperation.js b/tests/model/operation/nooperation.js index 05e075640..6c7763319 100644 --- a/tests/model/operation/nooperation.js +++ b/tests/model/operation/nooperation.js @@ -37,6 +37,10 @@ describe( 'NoOperation', () => { expect( clone.baseVersion ).to.equal( 0 ); } ); + it( 'should be a document operation', () => { + expect( noop.isDocumentOperation ).to.true; + } ); + describe( 'toJSON', () => { it( 'should create proper json object', () => { const serialized = jsonParseStringify( noop ); diff --git a/tests/model/operation/reinsertoperation.js b/tests/model/operation/reinsertoperation.js index 69444886a..4040ceb42 100644 --- a/tests/model/operation/reinsertoperation.js +++ b/tests/model/operation/reinsertoperation.js @@ -10,6 +10,7 @@ import MoveOperation from '../../../src/model/operation/moveoperation'; import Position from '../../../src/model/position'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'ReinsertOperation', () => { @@ -99,8 +100,38 @@ describe( 'ReinsertOperation', () => { expect( graveyard.maxOffset ).to.equal( 2 ); } ); - it( 'should return root of operation', () => { - expect( operation.root ).to.equal( root ); + it( 'should be a document operation', () => { + expect( operation.isDocumentOperation ).to.true; + } ); + + it( 'should throw when target position is not in the document', () => { + const docFrag = doc.batch().createDocumentFragment(); + + operation = new ReinsertOperation( + graveyardPosition, + 1, + Position.createAt( docFrag ), + doc.version + ); + + expect( () => { + operation._execute(); + } ).to.throw( CKEditorError, /^reinsert-operation-to-detached-parent/ ); + } ); + + it( 'should throw when source position is not in the document', () => { + const docFrag = doc.batch().createDocumentFragment(); + + operation = new ReinsertOperation( + Position.createAt( docFrag ), + 1, + rootPosition, + doc.version + ); + + expect( () => { + operation._execute(); + } ).to.throw( CKEditorError, /^reinsert-operation-on-detached-item/ ); } ); describe( 'toJSON', () => { diff --git a/tests/model/operation/renameoperation.js b/tests/model/operation/renameoperation.js index 8f91f8817..54e141564 100644 --- a/tests/model/operation/renameoperation.js +++ b/tests/model/operation/renameoperation.js @@ -92,6 +92,25 @@ describe( 'RenameOperation', () => { expect( clone.newName ).to.equal( newName ); } ); + describe( 'isDocumentOperation', () => { + it( 'should be true when target item is in the document', () => { + const op = new RenameOperation( position, oldName, newName, doc.version ); + + expect( op.isDocumentOperation ).to.true; + } ); + + it( 'should be false when target item is not in the document', () => { + const batch = doc.batch(); + const docFrag = batch.createDocumentFragment(); + + batch.appendElement( 'element', null, docFrag ); + + const op = new RenameOperation( Position.createAt( docFrag ), oldName, newName, doc.version ); + + expect( op.isDocumentOperation ).to.false; + } ); + } ); + describe( 'toJSON', () => { it( 'should create proper serialized object', () => { const op = new RenameOperation( Position.createAt( root, 'end' ), oldName, newName, doc.version ); diff --git a/tests/model/operation/rootattributeoperation.js b/tests/model/operation/rootattributeoperation.js index dfcbefa09..c7e43519d 100644 --- a/tests/model/operation/rootattributeoperation.js +++ b/tests/model/operation/rootattributeoperation.js @@ -54,6 +54,34 @@ describe( 'RootAttributeOperation', () => { } ); } ); + describe( 'isDocumentOperation', () => { + it( 'should be true when root is in the document', () => { + const operation = new RootAttributeOperation( + root, + 'isNew', + null, + true, + doc.version + ); + + expect( operation.isDocumentOperation ).to.true; + } ); + + it( 'should be false when root is not in the document', () => { + const element = doc.batch().createElement( 'element' ); + + const operation = new RootAttributeOperation( + element, + 'isNew', + null, + true, + doc.version + ); + + expect( operation.isDocumentOperation ).to.false; + } ); + } ); + it( 'should add attribute on the root element', () => { doc.applyOperation( wrapInDelta( new RootAttributeOperation( From 95c5dbf5f68f6e549f0b2c944cc1831e644128f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 16:21:20 +0100 Subject: [PATCH 054/724] Docs. --- src/model/document.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/document.js b/src/model/document.js index 3f5152be2..1ca0a1bc4 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -419,7 +419,7 @@ export default class Document { /** * Fired when document changes by applying an operation. * - * There are 5 types of change: + * There are a few types of change: * * * 'insert' when nodes are inserted, * * 'remove' when nodes are removed, From efa281847e7dc11f3bc9f5beb8d6e848261a49f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 22 Nov 2017 16:59:09 +0100 Subject: [PATCH 055/724] Do not increase document version for non-document operations. --- src/model/document.js | 7 +++--- tests/model/document/document.js | 40 ++++++++++++++++++++++++++++++-- 2 files changed, 42 insertions(+), 5 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index 1ca0a1bc4..fe69cb56d 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -163,9 +163,10 @@ export default class Document { const changes = operation._execute(); - this.version++; - - this.history.addDelta( operation.delta ); + if ( operation.isDocumentOperation ) { + this.version++; + this.history.addDelta( operation.delta ); + } this.fire( 'change', operation.type, changes, operation.delta.batch, operation.delta.type ); } diff --git a/tests/model/document/document.js b/tests/model/document/document.js index 3c6281b7b..b552c1c26 100644 --- a/tests/model/document/document.js +++ b/tests/model/document/document.js @@ -110,7 +110,8 @@ describe( 'Document', () => { } ); describe( 'applyOperation()', () => { - it( 'should increase document version, execute operation and fire event with proper data', () => { + it( 'should increase document version, execute operation and fire event with proper data ' + + 'when operation is a document operation', () => { const changeCallback = sinon.spy(); const type = 't'; const data = { data: 'x' }; @@ -121,6 +122,7 @@ describe( 'Document', () => { const operation = { type, baseVersion: 0, + isDocumentOperation: true, _execute: sinon.stub().returns( data ) }; @@ -131,6 +133,40 @@ describe( 'Document', () => { doc.applyOperation( operation ); expect( doc.version ).to.equal( 1 ); + expect( doc.history._deltas.length ).to.equal( 1 ); + sinon.assert.calledOnce( operation._execute ); + + sinon.assert.calledOnce( changeCallback ); + expect( changeCallback.args[ 0 ][ 1 ] ).to.equal( type ); + expect( changeCallback.args[ 0 ][ 2 ] ).to.equal( data ); + expect( changeCallback.args[ 0 ][ 3 ] ).to.deep.equal( batch ); + expect( changeCallback.args[ 0 ][ 4 ] ).to.equal( delta.type ); + } ); + + it( 'should execute operation, fire event with proper data and not increase document version ' + + 'when operation is not a document operation', () => { + const changeCallback = sinon.spy(); + const type = 't'; + const data = { data: 'x' }; + const batch = new Batch(); + const delta = new Delta(); + delta.type = 'type'; + + const operation = { + type, + baseVersion: 0, + isDocumentOperation: false, + _execute: sinon.stub().returns( data ) + }; + + delta.addOperation( operation ); + batch.addDelta( delta ); + + doc.on( 'change', changeCallback ); + doc.applyOperation( operation ); + + expect( doc.version ).to.equal( 0 ); + expect( doc.history._deltas.length ).to.equal( 0 ); sinon.assert.calledOnce( operation._execute ); sinon.assert.calledOnce( changeCallback ); @@ -149,7 +185,7 @@ describe( 'Document', () => { () => { doc.applyOperation( operation ); } - ).to.throw( CKEditorError, /model-document-applyOperation-wrong-version/ ); + ).to.throw( CKEditorError, /^model-document-applyOperation-wrong-version/ ); } ); } ); From dfb4468d6fef3945a40cce475646018764023f2a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 12:54:02 +0100 Subject: [PATCH 056/724] Added DetachOperation. --- src/model/operation/detachoperation.js | 71 ++++++++++++++++++++++++ tests/model/operation/detachoperation.js | 55 ++++++++++++++++++ 2 files changed, 126 insertions(+) create mode 100644 src/model/operation/detachoperation.js create mode 100644 tests/model/operation/detachoperation.js diff --git a/src/model/operation/detachoperation.js b/src/model/operation/detachoperation.js new file mode 100644 index 000000000..1fe8adaf3 --- /dev/null +++ b/src/model/operation/detachoperation.js @@ -0,0 +1,71 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/model/operation/detachoperation + */ + +import Operation from './operation'; +import { remove } from '../writer'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; + +/** + * Operation to permanently remove node from detached root. + * Note this operation is only a local operation and won't be send to the other clients. + * + * @extends module:engine/model/operation/operation~Operation + */ +export default class DetachOperation extends Operation { + /** + * Creates an insert operation. + * + * @param {module:engine/model/range~Range} range Range to remove. + * @param {Number} baseVersion {@link module:engine/model/document~Document#version} on which operation can be applied. + */ + constructor( range, baseVersion ) { + super( baseVersion ); + + /** + * Node to remove. + * + * @readonly + * @member {module:engine/model/range~Range} #range + */ + this.range = range; + } + + /** + * @inheritDoc + */ + get type() { + return 'detach'; + } + + /** + * @inheritDoc + */ + get isDocumentOperation() { + return false; + } + + /** + * @inheritDoc + */ + _execute() { + if ( this.range.root.document ) { + /** + * Cannot detach document node. + * Use {@link module:engine/model/operation/removeoperation~RemoveOperation remove operation} instead. + * + * @error detach-operation-on-document-node + */ + throw new CKEditorError( 'detach-operation-on-document-node: Cannot detach document node.' ); + } + + const nodes = remove( this.range ); + + return { nodes }; + } +} diff --git a/tests/model/operation/detachoperation.js b/tests/model/operation/detachoperation.js new file mode 100644 index 000000000..95ac17b2a --- /dev/null +++ b/tests/model/operation/detachoperation.js @@ -0,0 +1,55 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import Document from '../../../src/model/document'; +import DetachOperation from '../../../src/model/operation/detachoperation'; +import { wrapInDelta } from '../../../tests/model/_utils/utils'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; +import Range from '../../../src/model/range'; + +describe( 'DetachOperation', () => { + let doc, batch, docFrag, element; + + beforeEach( () => { + doc = new Document(); + batch = doc.batch(); + + docFrag = batch.createDocumentFragment(); + element = batch.createElement( 'element' ); + batch.append( element, docFrag ); + } ); + + it( 'should have type equal to detach', () => { + const op = new DetachOperation( element, doc.version ); + + expect( op.type ).to.equal( 'detach' ); + } ); + + it( 'should remove given element from parent', () => { + const op = new DetachOperation( Range.createOn( element ), doc.version ); + + doc.applyOperation( wrapInDelta( op ) ); + + expect( docFrag.childCount ).to.equal( 0 ); + } ); + + it( 'should throw when is executed on element from document', () => { + const root = doc.createRoot(); + const element = batch.createElement( 'element' ); + batch.append( element, root ); + + const op = new DetachOperation( Range.createOn( element ), doc.version ); + + expect( () => { + op._execute(); + } ).to.throw( CKEditorError, /^detach-operation-on-document-node/ ); + } ); + + it( 'should be not a document operation', () => { + const op = new DetachOperation( element, doc.version ); + + expect( op.isDocumentOperation ).to.false; + } ); +} ); From 9f6f9b1883b49a28344adaa7d4ca010b0195b2ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 13:08:35 +0100 Subject: [PATCH 057/724] Aligned DataController with the new Batch API. --- src/controller/datacontroller.js | 8 ++++---- src/controller/deletecontent.js | 4 ++-- src/controller/insertcontent.js | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index fe17ce684..1bb558dfa 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -21,7 +21,6 @@ import { convertText, convertToModelFragment } from '../conversion/view-to-model import ViewDocumentFragment from '../view/documentfragment'; import ModelRange from '../model/range'; -import ModelPosition from '../model/position'; import ModelElement from '../model/element'; import insertContent from './insertcontent'; @@ -196,9 +195,10 @@ export default class DataController { this.model.selection.clearAttributes(); // Initial batch should be ignored by features like undo, etc. - this.model.batch( 'transparent' ) - .remove( ModelRange.createIn( modelRoot ) ) - .insert( ModelPosition.createAt( modelRoot, 0 ), this.parse( data ) ); + const batch = this.model.batch( 'transparent' ); + + batch.remove( ModelRange.createIn( modelRoot ) ); + batch.insert( this.parse( data ), modelRoot ); } ); } diff --git a/src/controller/deletecontent.js b/src/controller/deletecontent.js index 0664589e9..b03dbc7f2 100644 --- a/src/controller/deletecontent.js +++ b/src/controller/deletecontent.js @@ -128,7 +128,7 @@ function mergeBranches( batch, startPos, endPos ) { // x[]{}y // becomes: // x[]y{} - batch.move( endParent, startPos ); + batch.insert( endParent, startPos ); } // Merge two siblings: @@ -181,7 +181,7 @@ function checkCanBeMerged( leftPos, rightPos ) { function insertParagraph( batch, position, selection ) { const paragraph = new Element( 'paragraph' ); - batch.insert( position, paragraph ); + batch.insert( paragraph, position ); selection.setCollapsedAt( paragraph ); } diff --git a/src/controller/insertcontent.js b/src/controller/insertcontent.js index 52a2e9902..9547592c8 100644 --- a/src/controller/insertcontent.js +++ b/src/controller/insertcontent.js @@ -256,7 +256,7 @@ class Insertion { const livePos = LivePosition.createFromPosition( this.position ); - this.batch.insert( this.position, node ); + this.batch.insert( node, this.position ); this.position = Position.createFromPosition( livePos ); livePos.detach(); From 8fa502510a29d5886b44db66cbb951197c95a22f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 13:11:40 +0100 Subject: [PATCH 058/724] Aligned dev-utils with new Batch API. --- src/dev-utils/model.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 4259c8018..9fa8650e9 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -113,9 +113,10 @@ export function setData( document, data, options = {} ) { document.enqueueChanges( () => { // Replace existing model in document by new one. - document.batch( options.batchType || 'transparent' ) - .remove( ModelRange.createIn( modelRoot ) ) - .insert( ModelPosition.createAt( modelRoot, 0 ), modelDocumentFragment ); + const batch = document.batch( options.batchType || 'transparent' ); + + batch.remove( ModelRange.createIn( modelRoot ) ); + batch.insert( modelDocumentFragment, modelRoot ); // Clean up previous document selection. document.selection.clearAttributes(); From 023fdf2c7998563eb9ef31311cb68c5c1102ed23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 15:08:32 +0100 Subject: [PATCH 059/724] Used DetachOperation for removing detached items. --- src/model/batch.js | 17 +++-- tests/model/batch.js | 160 +++++++++++++++++++++++++++++++++---------- 2 files changed, 135 insertions(+), 42 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index afcc99d2d..6f24a4887 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -20,6 +20,7 @@ import WeakInsertDelta from './delta/weakinsertdelta'; import WrapDelta from './delta/wrapdelta'; import AttributeOperation from './operation/attributeoperation'; +import DetachOperation from './operation/detachoperation'; import InsertOperation from './operation/insertoperation'; import MarkerOperation from './operation/markeroperation'; import MoveOperation from './operation/moveoperation'; @@ -131,7 +132,7 @@ export default class Batch { } } - createText( data, attributes = {} ) { + createText( data, attributes ) { return new Text( data, attributes ); } @@ -315,11 +316,19 @@ export default class Batch { const addRemoveDelta = ( position, howMany ) => { const delta = new RemoveDelta(); this.addDelta( delta ); + let operation; - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); + if ( position.root.document ) { + const graveyard = this.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + operation = new RemoveOperation( position, howMany, gyPosition, this.document.version ); + } else { + const range = Range.createFromPositionAndShift( position, howMany ); + + operation = new DetachOperation( range, this.document.version ); + } - const operation = new RemoveOperation( position, howMany, gyPosition, this.document.version ); delta.addOperation( operation ); this.document.applyOperation( operation ); }; diff --git a/tests/model/batch.js b/tests/model/batch.js index 372bfb2ac..a48a81489 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -1511,65 +1511,149 @@ describe( 'Batch', () => { } ); describe( 'remove()', () => { - let doc, root, div, p, batch, chain, range; + let doc, batch, div, p, range; beforeEach( () => { doc = new Document(); - root = doc.createRoot(); - - div = new Element( 'div', [], new Text( 'foobar' ) ); - p = new Element( 'p', [], new Text( 'abcxyz' ) ); + batch = doc.batch(); - div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); - div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); + div = batch.createElement( 'div' ); + batch.appendText( 'foobar', null, div ); - root.insertChildren( 0, [ div, p ] ); + p = batch.createElement( 'p' ); + batch.appendText( 'abcxyz', null, p ); - batch = doc.batch(); + batch.insertElement( 'p', null, div ); + batch.appendElement( 'p', null, div ); - // Range starts in ROOT > DIV > P > gg|gg. - // Range ends in ROOT > DIV > ...|ar. - range = new Range( new Position( root, [ 0, 0, 2 ] ), new Position( root, [ 0, 5 ] ) ); + batch.insertText( 'gggg', null, new Position( div, [ 0, 0 ] ) ); + batch.insertText( 'hhhh', null, new Position( div, [ 7, 0 ] ) ); } ); - it( 'should remove specified node', () => { - batch.remove( div ); + describe( 'remove from document', () => { + let root; - expect( root.maxOffset ).to.equal( 1 ); - expect( root.childCount ).to.equal( 1 ); - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); - } ); + beforeEach( () => { + root = doc.createRoot(); + batch.append( div, root ); + batch.append( p, root ); - it( 'should remove any range of nodes', () => { - batch.remove( range ); + // Reset batch. + batch = doc.batch(); - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); - } ); + // Range starts in ROOT > DIV > P > gg|gg. + // Range ends in ROOT > DIV > ...|ar. + range = new Range( new Position( root, [ 0, 0, 2 ] ), new Position( root, [ 0, 5 ] ) ); + } ); - it( 'should create minimal number of remove deltas, each with only one operation', () => { - batch.remove( range ); + it( 'should remove specified node', () => { + batch.remove( div ); - expect( batch.deltas.length ).to.equal( 2 ); - expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); - expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); - } ); + expect( root.maxOffset ).to.equal( 1 ); + expect( root.childCount ).to.equal( 1 ); + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); + } ); - it( 'should be chainable', () => { - chain = batch.remove( range ); + it( 'should remove specified text node', () => { + batch.remove( p.getChild( 0 ) ); - expect( chain ).to.equal( batch ); + expect( getNodesAndText( Range.createOn( p ) ) ).to.equal( 'PP' ); + } ); + + it( 'should remove any range of nodes', () => { + batch.remove( range ); + + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); + expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should create minimal number of remove deltas, each with only one operation', () => { + batch.remove( range ); + + expect( batch.deltas.length ).to.equal( 2 ); + expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.remove( div ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + + it( 'should use RemoveOperation', () => { + batch.remove( div ); + + expect( batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'remove' ); + } ); } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.remove( div ); + describe( 'remove from document fragment', () => { + let frag; - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; + beforeEach( () => { + frag = batch.createDocumentFragment(); + batch.append( div, frag ); + batch.append( p, frag ); + + // Reset batch. + batch = doc.batch(); + + // Range starts in FRAG > DIV > P > gg|gg. + // Range ends in FRAG > DIV > ...|ar. + range = new Range( new Position( frag, [ 0, 0, 2 ] ), new Position( frag, [ 0, 5 ] ) ); } ); - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + it( 'should remove specified node', () => { + batch.remove( div ); + + expect( frag.maxOffset ).to.equal( 1 ); + expect( frag.childCount ).to.equal( 1 ); + expect( getNodesAndText( Range.createIn( frag.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should remove specified text node', () => { + batch.remove( p.getChild( 0 ) ); + + expect( getNodesAndText( Range.createOn( p ) ) ).to.equal( 'PP' ); + } ); + + it( 'should remove any range of nodes', () => { + batch.remove( range ); + + expect( getNodesAndText( Range.createIn( frag.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); + expect( getNodesAndText( Range.createIn( frag.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should create minimal number of remove deltas, each with only one operation', () => { + batch.remove( range ); + + expect( batch.deltas.length ).to.equal( 2 ); + expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + } ); + + it( 'should add delta to batch and operation to delta before applying operation', () => { + sinon.spy( doc, 'applyOperation' ); + batch.remove( div ); + + const correctDeltaMatcher = sinon.match( operation => { + return operation.delta && operation.delta.batch && operation.delta.batch == batch; + } ); + + expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; + } ); + + it( 'should use DetachOperation', () => { + batch.remove( div ); + + expect( batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'detach' ); + } ); } ); } ); From e19a6df9cd720e80c2fa366cda64ea041e39b25f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 17:06:43 +0100 Subject: [PATCH 060/724] Made Batch API not chainable. --- src/model/batch.js | 38 ++----- tests/model/batch.js | 258 +++++-------------------------------------- 2 files changed, 37 insertions(+), 259 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 6f24a4887..77592c2cf 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -155,7 +155,9 @@ export default class Batch { // We need to check if item is going to be inserted within the same document. if ( isTheSameDocument( item.root, position.root ) ) { // If it's we just need to move it. - return this.move( Range.createOn( item ), position ); + this.move( Range.createOn( item ), position ); + + return; } // If it isn't the same root. else { @@ -183,28 +185,26 @@ export default class Batch { this.setMarker( markerName, range ); } } - - return this; } insertText( text, attributes, itemOrPosition, offset ) { - return this.insert( this.createText( text, attributes ), itemOrPosition, offset ); + this.insert( this.createText( text, attributes ), itemOrPosition, offset ); } insertElement( name, attributes, itemOrPosition, offset ) { - return this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); + this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); } append( item, parent ) { - return this.insert( item, parent, 'end' ); + this.insert( item, parent, 'end' ); } appendText( text, attributes, parent ) { - return this.insert( this.createText( text, attributes ), parent, 'end' ); + this.insert( this.createText( text, attributes ), parent, 'end' ); } appendElement( text, attributes, parent ) { - return this.insert( this.createElement( text, attributes ), parent, 'end' ); + this.insert( this.createElement( text, attributes ), parent, 'end' ); } /** @@ -223,8 +223,6 @@ export default class Batch { } else { setAttributeToItem( this, key, value, itemOrRange ); } - - return this; } setAttributes( itemOrRange, attributes ) { @@ -249,8 +247,6 @@ export default class Batch { } else { setAttributeToItem( this, key, null, itemOrRange ); } - - return this; } clearAttributes( itemOrRange ) { @@ -302,8 +298,6 @@ export default class Batch { const operation = new MoveOperation( range.start, range.end.offset - range.start.offset, position, this.document.version ); delta.addOperation( operation ); this.document.applyOperation( operation ); - - return this; } /** @@ -345,8 +339,6 @@ export default class Batch { addRemoveDelta( Position.createBefore( itemOrRange ), howMany ); } - - return this; } /** @@ -403,8 +395,6 @@ export default class Batch { const remove = new RemoveOperation( position, 1, gyPosition, this.document.version ); delta.addOperation( remove ); this.document.applyOperation( remove ); - - return this; } /** @@ -430,8 +420,6 @@ export default class Batch { const renameOperation = new RenameOperation( Position.createBefore( element ), element.name, newName, this.document.version ); delta.addOperation( renameOperation ); this.document.applyOperation( renameOperation ); - - return this; } /** @@ -479,8 +467,6 @@ export default class Batch { delta.addOperation( move ); this.document.applyOperation( move ); - - return this; } /** @@ -537,8 +523,6 @@ export default class Batch { ); delta.addOperation( move ); this.document.applyOperation( move ); - - return this; } /** @@ -582,8 +566,6 @@ export default class Batch { const remove = new RemoveOperation( Position.createBefore( element ), 1, gyPosition, this.document.version ); delta.addOperation( remove ); this.document.applyOperation( remove ); - - return this; } /** @@ -626,8 +608,6 @@ export default class Batch { // Just change marker range. addMarkerOperation( this, name, currentRange, newRange ); } - - return this; } /** @@ -651,8 +631,6 @@ export default class Batch { const oldRange = this.document.markers.get( name ).getRange(); addMarkerOperation( this, name, oldRange, null ); - - return this; } } diff --git a/tests/model/batch.js b/tests/model/batch.js index a48a81489..4fdc6613b 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -374,7 +374,7 @@ describe( 'Batch', () => { // Verify deltas and operations. sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'detach' ); expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); @@ -414,13 +414,6 @@ describe( 'Batch', () => { expect( doc.applyOperation.secondCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); expect( doc.applyOperation.thirdCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); } ); - - it( 'should be chainable', () => { - const parent = batch.createDocumentFragment(); - const child = batch.createElement( 'child' ); - - expect( batch.insert( child, parent ) ).to.equal( batch ); - } ); } ); describe( 'insertText()', () => { @@ -534,12 +527,6 @@ describe( 'Batch', () => { expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - - it( 'should be chainable', () => { - const parent = batch.createDocumentFragment(); - - expect( batch.insertText( 'foo', null, parent ) ).to.equal( batch ); - } ); } ); describe( 'insertElement()', () => { @@ -653,12 +640,6 @@ describe( 'Batch', () => { expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - - it( 'should be chainable', () => { - const parent = batch.createDocumentFragment(); - - expect( batch.insertElement( 'foo', null, parent ) ).to.equal( batch ); - } ); } ); describe( 'append()', () => { @@ -802,15 +783,11 @@ describe( 'Batch', () => { // Verify deltas and operations. sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'detach' ); expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - - it( 'should be chainable', () => { - expect( batch.append( batch.createElement( 'a' ), batch.createElement( 'b' ) ) ).to.equal( batch ); - } ); } ); describe( 'appendText()', () => { @@ -845,22 +822,16 @@ describe( 'Batch', () => { expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); - it( 'should create proper delta', () => { + it( 'should create proper delta and operations', () => { const parent = batch.createDocumentFragment(); const spy = sinon.spy( doc, 'applyOperation' ); batch.appendText( 'foo', null, parent ); sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should be chainable', () => { - const parent = batch.createDocumentFragment(); - - expect( batch.appendText( 'foo', null, parent ) ).to.equal( batch ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.firstCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); } ); @@ -895,23 +866,16 @@ describe( 'Batch', () => { expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); - it( 'should create proper delta', () => { + it( 'should create proper delta and operation', () => { const parent = batch.createDocumentFragment(); const spy = sinon.spy( doc, 'applyOperation' ); batch.appendElement( 'foo', null, parent ); sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); - expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should be chainable', () => { - const parent = batch.createDocumentFragment(); - - expect( batch.appendElement( 'foo', null, parent ) ).to.equal( batch ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.firstCall.args[ 0 ].delta ).to.instanceof( InsertDelta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); } ); @@ -972,11 +936,6 @@ describe( 'Batch', () => { expect( node.getAttribute( 'a' ) ).to.equal( 1 ); } ); - it( 'should be chainable', () => { - const chain = batch.setAttribute( node, 'b', 2 ); - expect( chain ).to.equal( batch ); - } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { batch.setAttribute( node, 'b', 2 ); @@ -1002,11 +961,6 @@ describe( 'Batch', () => { expect( spy.callCount ).to.equal( 0 ); } ); - it( 'should be chainable', () => { - const chain = batch.removeAttribute( node, 'a' ); - expect( chain ).to.equal( batch ); - } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { batch.removeAttribute( node, 'a' ); @@ -1019,16 +973,15 @@ describe( 'Batch', () => { beforeEach( () => { const element = batch.createElement( 'e', { a: 2 } ); - batch - .appendText( 'xxx', { a: 1 }, root ) - .appendText( 'xxx', null, root ) - .appendText( 'xxx', { a: 1 }, root ) - .appendText( 'xxx', { a: 2 }, root ) - .appendText( 'xxx', null, root ) - .appendText( 'xxx', { a: 1 }, root ) - .appendText( 'xxx', null, element ) - .append( element, root ) - .appendText( 'xxx', null, root ); + batch.appendText( 'xxx', { a: 1 }, root ); + batch.appendText( 'xxx', null, root ); + batch.appendText( 'xxx', { a: 1 }, root ); + batch.appendText( 'xxx', { a: 2 }, root ); + batch.appendText( 'xxx', null, root ); + batch.appendText( 'xxx', { a: 1 }, root ); + batch.appendText( 'xxx', null, element ); + batch.append( element, root ); + batch.appendText( 'xxx', null, root ); spy = sinon.spy( doc, 'applyOperation' ); } ); @@ -1153,11 +1106,6 @@ describe( 'Batch', () => { expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); } ); - it( 'should be chainable', () => { - const chain = batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); - expect( chain ).to.equal( batch ); - } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); @@ -1239,11 +1187,6 @@ describe( 'Batch', () => { expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); } ); - it( 'should be chainable', () => { - const chain = batch.removeAttribute( getRange( 0, 2 ), 'a' ); - expect( chain ).to.equal( batch ); - } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { batch.removeAttribute( getRange( 0, 2 ), 'a' ); sinon.assert.calledWith( spy, correctDeltaMatcher ); @@ -1395,7 +1338,7 @@ describe( 'Batch', () => { } ); describe( 'merge()', () => { - let doc, root, p1, p2, batch; + let doc, root, p1, p2; beforeEach( () => { doc = new Document(); @@ -1429,28 +1372,10 @@ describe( 'Batch', () => { doc.batch().merge( new Position( root, [ 0, 2 ] ) ); } ).to.throw( CKEditorError, /^batch-merge-no-element-before/ ); } ); - - it( 'should be chainable', () => { - batch = doc.batch(); - - const chain = batch.merge( new Position( root, [ 1 ] ) ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch = doc.batch().merge( new Position( root, [ 1 ] ) ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'move()', () => { - let doc, root, range, div, p, batch, chain; + let doc, root, range, div, p, batch; beforeEach( () => { doc = new Document(); @@ -1491,23 +1416,6 @@ describe( 'Batch', () => { doc.batch().move( range, docFrag ); } ).to.throw( CKEditorError, /^batch-move-different-document/ ); } ); - - it( 'should be chainable', () => { - chain = batch.move( range, new Position( root, [ 1, 3 ] ) ); - - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.move( range, new Position( root, [ 2 ] ) ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'remove()', () => { @@ -1575,17 +1483,6 @@ describe( 'Batch', () => { expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.remove( div ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - it( 'should use RemoveOperation', () => { batch.remove( div ); @@ -1638,17 +1535,6 @@ describe( 'Batch', () => { expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); } ); - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.remove( div ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); - it( 'should use DetachOperation', () => { batch.remove( div ); @@ -1658,7 +1544,7 @@ describe( 'Batch', () => { } ); describe( 'rename()', () => { - let doc, root, batch, chain; + let doc, root, batch; beforeEach( () => { doc = new Document(); @@ -1669,13 +1555,12 @@ describe( 'Batch', () => { batch = doc.batch(); - chain = batch.rename( p, 'h' ); + batch.rename( p, 'h' ); } ); it( 'should rename given element', () => { expect( root.maxOffset ).to.equal( 1 ); expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); - expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); } ); it( 'should throw if not an Element instance is passed', () => { @@ -1683,21 +1568,6 @@ describe( 'Batch', () => { batch.rename( new Text( 'abc' ), 'h' ); } ).to.throw( CKEditorError, /^batch-rename-not-element-instance/ ); } ); - - it( 'should be chainable', () => { - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - batch.rename( root.getChild( 0 ), 'p' ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.alwaysCalledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'split()', () => { @@ -1752,24 +1622,6 @@ describe( 'Batch', () => { doc.batch().split( new Position( root, [ 0 ] ) ); } ).to.throw( CKEditorError, /^batch-split-root/ ); } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - - const chain = batch.split( new Position( root, [ 0, 3 ] ) ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().split( new Position( root, [ 0, 3 ] ) ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'wrap()', () => { @@ -1814,7 +1666,7 @@ describe( 'Batch', () => { } ).to.throw( CKEditorError, /^batch-wrap-range-not-flat/ ); } ); - it( 'should throw if element to wrap with has children', () => { + it( 'should throw if element to wrap with has children #1', () => { const p = new Element( 'p', [], new Text( 'a' ) ); expect( () => { @@ -1822,7 +1674,7 @@ describe( 'Batch', () => { } ).to.throw( CKEditorError, /^batch-wrap-element-not-empty/ ); } ); - it( 'should throw if element to wrap with has children', () => { + it( 'should throw if element to wrap with has children #2', () => { const p = new Element( 'p' ); root.insertChildren( 0, p ); @@ -1830,24 +1682,6 @@ describe( 'Batch', () => { doc.batch().wrap( range, p ); } ).to.throw( CKEditorError, /^batch-wrap-element-attached/ ); } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - - const chain = batch.wrap( range, 'p' ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().wrap( range, 'p' ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'unwrap()', () => { @@ -1875,24 +1709,6 @@ describe( 'Batch', () => { doc.batch().unwrap( element ); } ).to.throw( CKEditorError, /^batch-unwrap-element-no-parent/ ); } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - - const chain = batch.unwrap( p ); - expect( chain ).to.equal( batch ); - } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().unwrap( p ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'setMarker()', () => { @@ -1925,7 +1741,8 @@ describe( 'Batch', () => { const marker = doc.markers.get( 'name' ); const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); - const batch = doc.batch().setMarker( marker, range2 ); + const batch = doc.batch(); + batch.setMarker( marker, range2 ); const op = batch.deltas[ 0 ].operations[ 0 ]; expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; @@ -1945,7 +1762,8 @@ describe( 'Batch', () => { } } ); - const batch = doc.batch().setMarker( marker ); + const batch = doc.batch(); + batch.setMarker( marker ); const op = batch.deltas[ 0 ].operations[ 0 ]; expect( doc.fire.calledWith( 'change', 'marker' ) ).to.be.true; @@ -1958,13 +1776,6 @@ describe( 'Batch', () => { doc.batch().setMarker( 'name' ); } ).to.throw( CKEditorError, /^batch-setMarker-no-range/ ); } ); - - it( 'should be chainable', () => { - const batch = doc.batch(); - const chain = batch.setMarker( 'name', range ); - - expect( chain ).to.equal( batch ); - } ); } ); describe( 'removeMarker()', () => { @@ -1998,16 +1809,5 @@ describe( 'Batch', () => { expect( doc.markers.get( 'name' ) ).to.be.null; } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - sinon.spy( doc, 'applyOperation' ); - const batch = doc.batch().setMarker( 'name', range ); - - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); } ); From 05666ea35fa3e099621096be2676fc16dde80186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 19:33:41 +0100 Subject: [PATCH 061/724] Made attributes as a optional append* and insert* parameter. --- src/model/batch.js | 29 +++++++++----- tests/model/batch.js | 91 ++++++++++++++++++++++++++++++++------------ 2 files changed, 87 insertions(+), 33 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 77592c2cf..6b8065240 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -188,11 +188,19 @@ export default class Batch { } insertText( text, attributes, itemOrPosition, offset ) { - this.insert( this.createText( text, attributes ), itemOrPosition, offset ); + if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { + this.insert( this.createText( text ), attributes, itemOrPosition ); + } else { + this.insert( this.createText( text, attributes ), itemOrPosition, offset ); + } } insertElement( name, attributes, itemOrPosition, offset ) { - this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); + if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { + this.insert( this.createElement( name ), attributes, itemOrPosition ); + } else { + this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); + } } append( item, parent ) { @@ -200,11 +208,19 @@ export default class Batch { } appendText( text, attributes, parent ) { - this.insert( this.createText( text, attributes ), parent, 'end' ); + if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { + this.insert( this.createText( text ), attributes, 'end' ); + } else { + this.insert( this.createText( text, attributes ), parent, 'end' ); + } } appendElement( text, attributes, parent ) { - this.insert( this.createElement( text, attributes ), parent, 'end' ); + if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { + this.insert( this.createElement( text ), attributes, 'end' ); + } else { + this.insert( this.createElement( text, attributes ), parent, 'end' ); + } } /** @@ -265,11 +281,6 @@ export default class Batch { } } - /** - * Moves given {@link module:engine/model/item~Item model item} or given range to target position. - * - * @chainable - */ move( range, itemOrPosition, offset ) { if ( !range.isFlat ) { /** diff --git a/tests/model/batch.js b/tests/model/batch.js index 4fdc6613b..552e5ead2 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -446,12 +446,23 @@ describe( 'Batch', () => { expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); + it( 'should create and insert text node omitting attributes param', () => { + const parent = batch.createDocumentFragment(); + + batch.insertText( 'foo', new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + it( 'should create and insert text node at the beginning of given element', () => { const parent = batch.createDocumentFragment(); batch.insert( batch.createElement( 'child' ), parent ); - batch.insertText( 'foo', null, parent ); + batch.insertText( 'foo', parent ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 0 ) ).to.instanceof( Text ); @@ -463,7 +474,7 @@ describe( 'Batch', () => { batch.insert( batch.createElement( 'child' ), parent ); - batch.insertText( 'foo', null, parent, 'end' ); + batch.insertText( 'foo', parent, 'end' ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 0 ) ).to.instanceof( Element ); @@ -476,7 +487,7 @@ describe( 'Batch', () => { batch.insert( batch.createElement( 'child' ), parent ); batch.insert( batch.createElement( 'child' ), parent ); - batch.insertText( 'foo', null, parent, 1 ); + batch.insertText( 'foo', parent, 1 ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ) ).to.instanceof( Element ); @@ -492,7 +503,7 @@ describe( 'Batch', () => { batch.insert( child1, parent ); batch.insert( child2, parent, 'end' ); - batch.insertText( 'foo', null, child2, 'before' ); + batch.insertText( 'foo', child2, 'before' ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ) ).to.instanceof( Element ); @@ -508,7 +519,7 @@ describe( 'Batch', () => { batch.insert( child1, parent ); batch.insert( child2, parent, 'end' ); - batch.insertText( 'foo', null, child1, 'after' ); + batch.insertText( 'foo', child1, 'after' ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ) ).to.instanceof( Element ); @@ -520,7 +531,7 @@ describe( 'Batch', () => { const parent = batch.createDocumentFragment(); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insertText( 'foo', null, parent ); + batch.insertText( 'foo', parent ); sinon.assert.calledOnce( spy ); expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); @@ -559,12 +570,23 @@ describe( 'Batch', () => { expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); + it( 'should create and insert element with no attributes omitting attributes param', () => { + const parent = batch.createDocumentFragment(); + + batch.insertElement( 'foo', new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + it( 'should create and insert element at the beginning of given element', () => { const parent = batch.createDocumentFragment(); batch.insert( batch.createElement( 'child' ), parent ); - batch.insertElement( 'foo', null, parent ); + batch.insertElement( 'foo', parent ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); @@ -576,7 +598,7 @@ describe( 'Batch', () => { batch.insert( batch.createElement( 'child' ), parent ); - batch.insertElement( 'foo', null, parent, 'end' ); + batch.insertElement( 'foo', parent, 'end' ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 0 ).name ).to.equal( 'child' ); @@ -589,7 +611,7 @@ describe( 'Batch', () => { batch.insert( batch.createElement( 'child1' ), parent ); batch.insert( batch.createElement( 'child2' ), parent, 'end' ); - batch.insertElement( 'foo', null, parent, 1 ); + batch.insertElement( 'foo', parent, 1 ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); @@ -605,7 +627,7 @@ describe( 'Batch', () => { batch.insert( child1, parent ); batch.insert( child2, parent, 'end' ); - batch.insertElement( 'foo', null, child2, 'before' ); + batch.insertElement( 'foo', child2, 'before' ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); @@ -621,7 +643,7 @@ describe( 'Batch', () => { batch.insert( child1, parent ); batch.insert( child2, parent, 'end' ); - batch.insertElement( 'foo', null, child1, 'after' ); + batch.insertElement( 'foo', child1, 'after' ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); @@ -633,7 +655,7 @@ describe( 'Batch', () => { const parent = batch.createDocumentFragment(); const spy = sinon.spy( doc, 'applyOperation' ); - batch.insertText( 'foo', null, parent ); + batch.insertText( 'foo', parent ); sinon.assert.calledOnce( spy ); expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); @@ -822,11 +844,22 @@ describe( 'Batch', () => { expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); + it( 'should create and insert text node with no attributes omitting attributes param', () => { + const parent = batch.createDocumentFragment(); + + batch.appendText( 'foo', parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + it( 'should create proper delta and operations', () => { const parent = batch.createDocumentFragment(); const spy = sinon.spy( doc, 'applyOperation' ); - batch.appendText( 'foo', null, parent ); + batch.appendText( 'foo', parent ); sinon.assert.calledOnce( spy ); expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); @@ -866,11 +899,21 @@ describe( 'Batch', () => { expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); } ); + it( 'should create and insert element with no attributes omitting attributes param', () => { + const parent = batch.createDocumentFragment(); + + batch.appendElement( 'foo', parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + it( 'should create proper delta and operation', () => { const parent = batch.createDocumentFragment(); const spy = sinon.spy( doc, 'applyOperation' ); - batch.appendElement( 'foo', null, parent ); + batch.appendElement( 'foo', parent ); sinon.assert.calledOnce( spy ); expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); @@ -974,14 +1017,14 @@ describe( 'Batch', () => { const element = batch.createElement( 'e', { a: 2 } ); batch.appendText( 'xxx', { a: 1 }, root ); - batch.appendText( 'xxx', null, root ); + batch.appendText( 'xxx', root ); batch.appendText( 'xxx', { a: 1 }, root ); batch.appendText( 'xxx', { a: 2 }, root ); - batch.appendText( 'xxx', null, root ); + batch.appendText( 'xxx', root ); batch.appendText( 'xxx', { a: 1 }, root ); - batch.appendText( 'xxx', null, element ); + batch.appendText( 'xxx', element ); batch.append( element, root ); - batch.appendText( 'xxx', null, root ); + batch.appendText( 'xxx', root ); spy = sinon.spy( doc, 'applyOperation' ); } ); @@ -1426,16 +1469,16 @@ describe( 'Batch', () => { batch = doc.batch(); div = batch.createElement( 'div' ); - batch.appendText( 'foobar', null, div ); + batch.appendText( 'foobar', div ); p = batch.createElement( 'p' ); - batch.appendText( 'abcxyz', null, p ); + batch.appendText( 'abcxyz', p ); - batch.insertElement( 'p', null, div ); - batch.appendElement( 'p', null, div ); + batch.insertElement( 'p', div ); + batch.appendElement( 'p', div ); - batch.insertText( 'gggg', null, new Position( div, [ 0, 0 ] ) ); - batch.insertText( 'hhhh', null, new Position( div, [ 7, 0 ] ) ); + batch.insertText( 'gggg', new Position( div, [ 0, 0 ] ) ); + batch.insertText( 'hhhh', new Position( div, [ 7, 0 ] ) ); } ); describe( 'remove from document', () => { From 4dc8d92e0f840670cbcdd79bf355df7bacc47134 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 19:34:32 +0100 Subject: [PATCH 062/724] Throw when range to move is invalid. --- src/model/batch.js | 9 +++++++++ tests/model/batch.js | 6 ++++++ 2 files changed, 15 insertions(+) diff --git a/src/model/batch.js b/src/model/batch.js index 6b8065240..b643896ba 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -282,6 +282,15 @@ export default class Batch { } move( range, itemOrPosition, offset ) { + if ( !( range instanceof Range ) ) { + /** + * Invalid range to move. + * + * @error batch-move-invalid-range + */ + throw new CKEditorError( 'batch-move-invalid-range: Invalid range to move.' ); + } + if ( !range.isFlat ) { /** * Range to move is not flat. diff --git a/tests/model/batch.js b/tests/model/batch.js index 552e5ead2..aa83dc112 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -1444,6 +1444,12 @@ describe( 'Batch', () => { expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcobarxyz' ); } ); + it( 'should throw if object to move is not a range', () => { + expect( () => { + doc.batch().move( root.getChild( 0 ), new Position( root, [ 1, 3 ] ) ); + } ).to.throw( CKEditorError, /^batch-move-invalid-range/ ); + } ); + it( 'should throw if given range is not flat', () => { const notFlatRange = new Range( new Position( root, [ 0, 2, 2 ] ), new Position( root, [ 0, 6 ] ) ); From 31c8ff54be8b4888adc3d70c87280519b61c66f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 19:35:37 +0100 Subject: [PATCH 063/724] Mark MarkerOperation as document operation when there is no range to remove. --- src/model/operation/markeroperation.js | 11 +++++++++-- tests/model/operation/markeroperation.js | 6 ++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/src/model/operation/markeroperation.js b/src/model/operation/markeroperation.js index 3a551a7bd..d7991d3e5 100644 --- a/src/model/operation/markeroperation.js +++ b/src/model/operation/markeroperation.js @@ -68,9 +68,16 @@ export default class MarkerOperation extends Operation { * @inheritDoc */ get isDocumentOperation() { - const root = this.newRange ? this.newRange.root : this.oldRange.root; + if ( this.newRange ) { + return !!this.newRange.root.document; + } - return !!root.document; + if ( this.oldRange ) { + return !!this.oldRange.root.document; + } + + // This is edge and might happen only on data from the server. + return true; } /** diff --git a/tests/model/operation/markeroperation.js b/tests/model/operation/markeroperation.js index 4139ed8a3..1434b858e 100644 --- a/tests/model/operation/markeroperation.js +++ b/tests/model/operation/markeroperation.js @@ -173,6 +173,12 @@ describe( 'MarkerOperation', () => { expect( op.isDocumentOperation ).to.true; } ); + + it( 'should return true when non-existing marker range is removed from the document', () => { + const op = new MarkerOperation( 'name', null, null, doc.markers, doc.version ); + + expect( op.isDocumentOperation ).to.true; + } ); } ); describe( 'toJSON', () => { From 7f7d2f44fa65739646aed3f1623dc2a1cc0cc177 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 20:04:21 +0100 Subject: [PATCH 064/724] Aligned engine code with new Batch API. --- src/model/document.js | 4 +- tests/controller/editingcontroller.js | 6 +-- tests/conversion/modelconversiondispatcher.js | 38 +++++++++++-------- tests/model/documentselection.js | 10 ++--- tests/model/markercollection.js | 2 +- 5 files changed, 35 insertions(+), 25 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index fe69cb56d..018d1e1c7 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -37,7 +37,9 @@ const graveyardName = '$graveyard'; * All changes in the document are done by {@link module:engine/model/operation/operation~Operation operations}. To create operations in * a simple way, use the {@link module:engine/model/batch~Batch} API, for example: * - * doc.batch().insert( position, nodes ).split( otherPosition ); + * const batch = doc.batch(); + * batch.insert( node, position ); + * batch.split( otherPosition ); * * @see module:engine/model/document~Document#batch * @mixes module:utils/emittermixin~EmitterMixin diff --git a/tests/controller/editingcontroller.js b/tests/controller/editingcontroller.js index a0ae8b850..43180b503 100644 --- a/tests/controller/editingcontroller.js +++ b/tests/controller/editingcontroller.js @@ -159,7 +159,7 @@ describe( 'EditingController', () => { )._children ); model.enqueueChanges( () => { - model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData ); + model.batch().insert( modelData, model.getRoot() ); model.selection.addRange( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) ); } ); @@ -375,7 +375,7 @@ describe( 'EditingController', () => { it( 'should forward add marker event if content is moved into a marker range', () => { model.enqueueChanges( () => { - model.batch().insert( ModelPosition.createAt( model.getRoot(), 'end' ), new ModelElement( 'paragraph' ) ); + model.batch().appendElement( 'paragraph', model.getRoot() ); } ); const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ); @@ -411,7 +411,7 @@ describe( 'EditingController', () => { model.enqueueChanges( () => { const modelData = parse( 'foo', model.schema ).getChild( 0 ); - model.batch().insert( ModelPosition.createAt( model.getRoot(), 0 ), modelData ); + model.batch().insert( modelData, model.getRoot() ); } ); expect( spy.called ).to.be.false; diff --git a/tests/conversion/modelconversiondispatcher.js b/tests/conversion/modelconversiondispatcher.js index 32c98c9af..dac0eb408 100644 --- a/tests/conversion/modelconversiondispatcher.js +++ b/tests/conversion/modelconversiondispatcher.js @@ -63,8 +63,7 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'insert:image', cbInsertImage ); dispatcher.on( 'addAttribute:key:$text', cbAddAttribute ); - const insertedText = new ModelText( 'foo', { key: 'value' } ); - doc.batch().insert( ModelPosition.createFromParentAndOffset( root, 0 ), insertedText ); + doc.batch().insertText( 'foo', { key: 'value' }, root ); expect( cbInsertText.called ).to.be.true; expect( cbAddAttribute.called ).to.be.true; @@ -129,18 +128,21 @@ describe( 'ModelConversionDispatcher', () => { it( 'should fire changeAttribute callbacks for change attribute change', () => { const cbChangeText = sinon.spy(); const cbChangeImage = sinon.spy(); + const batch = doc.batch(); dispatcher.on( 'changeAttribute:key:$text', cbChangeText ); dispatcher.on( 'changeAttribute:key:image', cbChangeImage ); - doc.batch().setAttribute( image, 'key', 'value' ).setAttribute( image, 'key', 'newValue' ); + batch.setAttribute( image, 'key', 'value' ); + batch.setAttribute( image, 'key', 'newValue' ); // Callback for adding attribute on text not called. expect( cbChangeText.called ).to.be.false; expect( cbChangeImage.calledOnce ).to.be.true; const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ); - doc.batch().setAttribute( range, 'key', 'value' ).setAttribute( range, 'key', 'newValue' ); + batch.setAttribute( range, 'key', 'value' ); + batch.setAttribute( range, 'key', 'newValue' ); expect( cbChangeText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -150,18 +152,21 @@ describe( 'ModelConversionDispatcher', () => { it( 'should fire removeAttribute callbacks for remove attribute change', () => { const cbRemoveText = sinon.spy(); const cbRemoveImage = sinon.spy(); + const batch = doc.batch(); dispatcher.on( 'removeAttribute:key:$text', cbRemoveText ); dispatcher.on( 'removeAttribute:key:image', cbRemoveImage ); - doc.batch().setAttribute( image, 'key', 'value' ).removeAttribute( image, 'key' ); + batch.setAttribute( image, 'key', 'value' ); + batch.removeAttribute( image, 'key' ); // Callback for adding attribute on text not called. expect( cbRemoveText.called ).to.be.false; expect( cbRemoveImage.calledOnce ).to.be.true; const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ); - doc.batch().setAttribute( range, 'key', 'value' ).removeAttribute( range, 'key' ); + batch.setAttribute( range, 'key', 'value' ); + batch.removeAttribute( range, 'key' ); expect( cbRemoveText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -616,9 +621,10 @@ describe( 'ModelConversionDispatcher', () => { it( 'should prepare correct list of consumable values', () => { doc.enqueueChanges( () => { - doc.batch() - .setAttribute( ModelRange.createIn( root ), 'bold', true ) - .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); + const batch = doc.batch(); + + batch.setAttribute( ModelRange.createIn( root ), 'bold', true ); + batch.setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); } ); dispatcher.on( 'selection', ( evt, data, consumable ) => { @@ -634,9 +640,10 @@ describe( 'ModelConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); doc.enqueueChanges( () => { - doc.batch() - .setAttribute( ModelRange.createIn( root ), 'bold', true ) - .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); + const batch = doc.batch(); + + batch.setAttribute( ModelRange.createIn( root ), 'bold', true ); + batch.setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); } ); dispatcher.convertSelection( doc.selection, [] ); @@ -653,9 +660,10 @@ describe( 'ModelConversionDispatcher', () => { } ); doc.enqueueChanges( () => { - doc.batch() - .setAttribute( ModelRange.createIn( root ), 'bold', true ) - .setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); + const batch = doc.batch(); + + batch.setAttribute( ModelRange.createIn( root ), 'bold', true ); + batch.setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); } ); dispatcher.convertSelection( doc.selection, [] ); diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index a5a2e872c..4a8d490fc 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -1012,7 +1012,7 @@ describe( 'DocumentSelection', () => { batchTypes.set( batch, batch.type ); } ); - doc.batch().insert( rangeInEmptyP.start, 'x' ); + doc.batch().insertText( 'x', rangeInEmptyP.start ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; @@ -1024,7 +1024,7 @@ describe( 'DocumentSelection', () => { selection.setRanges( [ rangeInEmptyP ] ); selection.setAttribute( 'foo', 'bar' ); - doc.batch().move( fullP.getChild( 0 ), rangeInEmptyP.start ); + doc.batch().move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; } ); @@ -1048,7 +1048,7 @@ describe( 'DocumentSelection', () => { selection.setRanges( [ rangeInFullP ] ); - doc.batch().insert( rangeInEmptyP.start, 'x' ); + doc.batch().insertText( 'x', rangeInEmptyP.start ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; } ); @@ -1076,7 +1076,7 @@ describe( 'DocumentSelection', () => { selection.setAttribute( 'foo', 'bar' ); doc.enqueueChanges( () => { - doc.batch().insert( rangeInEmptyP.start, 'x' ); + doc.batch().insertText( 'x', rangeInEmptyP.start ); // `emptyP` still has the attribute, because attribute clearing is in enqueued block. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; @@ -1109,7 +1109,7 @@ describe( 'DocumentSelection', () => { sinon.spy( doc, 'enqueueChanges' ); - doc.batch( 'transparent' ).insert( rangeInEmptyP.start, 'x' ); + doc.batch( 'transparent' ).insertText( 'x', rangeInEmptyP.start ); expect( doc.enqueueChanges.called ).to.be.false; expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); diff --git a/tests/model/markercollection.js b/tests/model/markercollection.js index 5b9f3e24f..a047813b5 100644 --- a/tests/model/markercollection.js +++ b/tests/model/markercollection.js @@ -225,7 +225,7 @@ describe( 'Marker', () => { expect( marker.getEnd().isEqual( range.end ) ).to.be.true; doc.enqueueChanges( () => { - doc.batch().insert( Position.createAt( root, 0 ), 'abc' ); + doc.batch().insertText( 'abc', root ); } ); const updatedRange = Range.createFromParentsAndOffsets( root, 4, root, 5 ); From f10c1a140eb5980eb9cbf36809dc767f3e32314a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 21:38:12 +0100 Subject: [PATCH 065/724] Refactored skipped Batch#setMarker tests. --- tests/model/batch.js | 57 +++++++++++++++++++++++++------------------- 1 file changed, 33 insertions(+), 24 deletions(-) diff --git a/tests/model/batch.js b/tests/model/batch.js index aa83dc112..eb969a117 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -9,8 +9,6 @@ import InsertDelta from '../../src/model/delta/insertdelta'; import WeakInsertDelta from '../../src/model/delta/weakinsertdelta'; import Operation from '../../src/model/operation/operation'; -import InsertOperation from '../../src/model/operation/insertoperation'; -import MarkerOperation from '../../src/model/operation/markeroperation'; import Document from '../../src/model/document'; import DocumentFragment from '../../src/model/documentfragment'; @@ -22,7 +20,6 @@ import Range from '../../src/model/range'; import count from '@ckeditor/ckeditor5-utils/src/count'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -import { stringify } from '../../src/dev-utils/model'; import { getNodesAndText } from '../../tests/model/_utils/utils'; describe( 'Batch', () => { @@ -380,39 +377,51 @@ describe( 'Batch', () => { expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it.skip( 'should transfer markers from given DocumentFragment', () => { - const documentFragment = batch.createDocumentFragment(); - const li = batch.createElement( 'li' ); + it( 'should transfer markers from given DocumentFragment', () => { + const root = doc.createRoot(); + const docFrag = batch.createDocumentFragment(); - batch.insert( batch.createText( 'foo bar' ), li ); - batch.insert( li, documentFragment ); + batch.appendText( 'abcd', root ); + batch.appendElement( 'p', docFrag ); + batch.insertText( 'foo bar', new Position( docFrag, [ 0, 0 ] ) ); - const marker = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 5 ] ) ); + const marker = new Range( new Position( docFrag, [ 0, 1 ] ), new Position( docFrag, [ 0, 5 ] ) ); - documentFragment.markers.set( 'marker', marker ); + docFrag.markers.set( 'marker', marker ); - batch.insert( documentFragment, new Position( root, [ 3, 0 ] ) ); + batch.insert( docFrag, new Position( root, [ 2 ] ) ); expect( Array.from( doc.markers ).length ).to.equal( 1 ); - expect( stringify( root, doc.markers.get( 'marker' ).getRange() ) ).to.equal( 'ab

  • f[oo b]ar
c' ); + + const range = doc.markers.get( 'marker' ).getRange(); + expect( range.root ).to.equal( root ); + expect( range.start.path ).to.deep.equal( [ 2, 1 ] ); + expect( range.end.path ).to.deep.equal( [ 2, 5 ] ); } ); - it.skip( 'should set each marker as separate operation', () => { - sinon.spy( doc, 'applyOperation' ); + it( 'should set each marker as a separate operation', () => { + const spy = sinon.spy(); + const root = doc.createRoot(); + const docFrag = batch.createDocumentFragment(); + + batch.appendText( 'abcd', root ); + batch.appendElement( 'p', docFrag ); + batch.insertText( 'foo bar', new Position( docFrag, [ 0, 0 ] ) ); + + const marker1 = new Range( new Position( docFrag, [ 0, 1 ] ), new Position( docFrag, [ 0, 2 ] ) ); + const marker2 = new Range( new Position( docFrag, [ 0, 5 ] ), new Position( docFrag, [ 0, 6 ] ) ); - const documentFragment = new DocumentFragment( [ new Element( 'li', null, [ new Text( 'foo bar' ) ] ) ] ); - const marker1 = new Range( new Position( documentFragment, [ 0, 1 ] ), new Position( documentFragment, [ 0, 2 ] ) ); - const marker2 = new Range( new Position( documentFragment, [ 0, 5 ] ), new Position( documentFragment, [ 0, 6 ] ) ); + docFrag.markers.set( 'marker1', marker1 ); + docFrag.markers.set( 'marker2', marker2 ); - documentFragment.markers.set( 'marker1', marker1 ); - documentFragment.markers.set( 'marker2', marker2 ); + doc.on( 'change', spy ); - batch.insert( new Position( root, [ 3, 0 ] ), documentFragment ); + batch.insert( docFrag, new Position( root, [ 2 ] ) ); - expect( doc.applyOperation.calledThrice ); - expect( doc.applyOperation.firstCall.calledWith( sinon.match( operation => operation instanceof InsertOperation ) ) ); - expect( doc.applyOperation.secondCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); - expect( doc.applyOperation.thirdCall.calledWith( sinon.match( operation => operation instanceof MarkerOperation ) ) ); + sinon.assert.calledThrice( spy ); + expect( spy.firstCall.args[ 1 ] ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 1 ] ).to.equal( 'marker' ); + expect( spy.thirdCall.args[ 1 ] ).to.equal( 'marker' ); } ); } ); From 7af892885afaa19fd7d4bfaab8c2a84971f124fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 23 Nov 2017 21:51:40 +0100 Subject: [PATCH 066/724] Improved adding attributes to detached root. --- src/model/batch.js | 4 ++-- tests/model/batch.js | 50 ++++++++++++++++++++------------------------ 2 files changed, 25 insertions(+), 29 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index b643896ba..b1b2ab7bb 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -736,10 +736,10 @@ function setAttributeToItem( batch, key, value, item ) { let range, operation; if ( previousValue != value ) { - const delta = item.is( 'rootElement' ) ? new RootAttributeDelta() : new AttributeDelta(); + const delta = item.root === item ? new RootAttributeDelta() : new AttributeDelta(); batch.addDelta( delta ); - if ( item.is( 'rootElement' ) ) { + if ( item.root === item ) { // If we change attributes of root element, we have to use `RootAttributeOperation`. operation = new RootAttributeOperation( item, key, previousValue, value, doc.version ); } else { diff --git a/tests/model/batch.js b/tests/model/batch.js index eb969a117..1fecf9bb4 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -934,10 +934,6 @@ describe( 'Batch', () => { describe( 'setAttribute() / removeAttribute()', () => { let batch, doc, root, spy; - const correctDeltaMatcher = sinon.match( operation => { - return operation.delta && operation.delta.batch && operation.delta.batch == batch; - } ); - beforeEach( () => { doc = new Document(); root = doc.createRoot(); @@ -987,12 +983,6 @@ describe( 'Batch', () => { expect( spy.callCount ).to.equal( 0 ); expect( node.getAttribute( 'a' ) ).to.equal( 1 ); } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - batch.setAttribute( node, 'b', 2 ); - - sinon.assert.calledWith( spy, correctDeltaMatcher ); - } ); } ); describe( 'removeAttribute', () => { @@ -1012,12 +1002,6 @@ describe( 'Batch', () => { batch.removeAttribute( node, 'b' ); expect( spy.callCount ).to.equal( 0 ); } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - batch.removeAttribute( node, 'a' ); - - sinon.assert.calledWith( spy, correctDeltaMatcher ); - } ); } ); } ); @@ -1157,12 +1141,6 @@ describe( 'Batch', () => { expect( getChangesAttrsCount() ).to.equal( 14 ); expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); - - expect( doc.applyOperation.calledWith( correctDeltaMatcher ) ).to.be.true; - } ); } ); describe( 'removeAttribute', () => { @@ -1238,16 +1216,14 @@ describe( 'Batch', () => { expect( getChangesAttrsCount() ).to.equal( 6 ); expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); } ); - - it( 'should add delta to batch and operation to delta before applying operation', () => { - batch.removeAttribute( getRange( 0, 2 ), 'a' ); - sinon.assert.calledWith( spy, correctDeltaMatcher ); - } ); } ); } ); describe( 'change attribute on root element', () => { + let p; + beforeEach( () => { + p = batch.createElement( 'p', { a: 3 } ); spy = sinon.spy( doc, 'applyOperation' ); } ); @@ -1258,12 +1234,24 @@ describe( 'Batch', () => { expect( root.getAttribute( 'b' ) ).to.equal( 2 ); } ); + it( 'should create the attribute on detached root', () => { + batch.setAttribute( p, 'b', 2 ); + expect( spy.callCount ).to.equal( 1 ); + expect( p.getAttribute( 'b' ) ).to.equal( 2 ); + } ); + it( 'should change the attribute of root', () => { batch.setAttribute( root, 'a', 2 ); expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'a' ) ).to.equal( 2 ); } ); + it( 'should change the attribute of detached root', () => { + batch.setAttribute( p, 'a', 2 ); + expect( spy.callCount ).to.equal( 1 ); + expect( p.getAttribute( 'a' ) ).to.equal( 2 ); + } ); + it( 'should do nothing if the attribute value is the same', () => { batch.setAttribute( root, 'a', 1 ); expect( spy.callCount ).to.equal( 1 ); @@ -1271,6 +1259,14 @@ describe( 'Batch', () => { expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'a' ) ).to.equal( 1 ); } ); + + it( 'should do nothing if the attribute value is the same on detached root', () => { + batch.setAttribute( p, 'a', 1 ); + expect( spy.callCount ).to.equal( 1 ); + batch.setAttribute( p, 'a', 1 ); + expect( spy.callCount ).to.equal( 1 ); + expect( p.getAttribute( 'a' ) ).to.equal( 1 ); + } ); } ); describe( 'removeAttribute', () => { From 92ec864cc2f50e9c5ad6846942f47201796079d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 24 Nov 2017 16:00:01 +0100 Subject: [PATCH 067/724] Extracted RootAttributeDelta to the separate file. --- src/model/batch.js | 3 ++- src/model/delta/attributedelta.js | 18 --------------- src/model/delta/rootattributedelta.js | 30 +++++++++++++++++++++++++ tests/model/delta/attributedelta.js | 8 +------ tests/model/delta/rootattributedelta.js | 12 ++++++++++ 5 files changed, 45 insertions(+), 26 deletions(-) create mode 100644 src/model/delta/rootattributedelta.js create mode 100644 tests/model/delta/rootattributedelta.js diff --git a/src/model/batch.js b/src/model/batch.js index b1b2ab7bb..7fc509cce 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -7,13 +7,14 @@ * @module engine/model/batch */ -import { default as AttributeDelta, RootAttributeDelta } from './delta/attributedelta'; +import AttributeDelta from './delta/attributedelta'; import InsertDelta from './delta/insertdelta'; import MarkerDelta from './delta/markerdelta'; import MergeDelta from './delta/mergedelta'; import MoveDelta from './delta/movedelta'; import RemoveDelta from './delta/removedelta'; import RenameDelta from './delta/renamedelta'; +import RootAttributeDelta from './delta/rootattributedelta'; import SplitDelta from './delta/splitdelta'; import UnwrapDelta from './delta/unwrapdelta'; import WeakInsertDelta from './delta/weakinsertdelta'; diff --git a/src/model/delta/attributedelta.js b/src/model/delta/attributedelta.js index fa27e2256..2be997eef 100644 --- a/src/model/delta/attributedelta.js +++ b/src/model/delta/attributedelta.js @@ -108,22 +108,4 @@ export default class AttributeDelta extends Delta { } } -/** - * To provide specific OT behavior and better collisions solving, methods to change attributes - * ({@link module:engine/model/batch~Batch#setAttribute} and {@link module:engine/model/batch~Batch#removeAttribute}) - * use `RootAttributeDelta` class which inherits from the `Delta` class and may - * overwrite some methods. - * - * @extends module:engine/model/delta/delta~Delta - */ -export class RootAttributeDelta extends Delta { - /** - * @inheritDoc - */ - static get className() { - return 'engine.model.delta.RootAttributeDelta'; - } -} - DeltaFactory.register( AttributeDelta ); -DeltaFactory.register( RootAttributeDelta ); diff --git a/src/model/delta/rootattributedelta.js b/src/model/delta/rootattributedelta.js new file mode 100644 index 000000000..004fc2b2d --- /dev/null +++ b/src/model/delta/rootattributedelta.js @@ -0,0 +1,30 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/model/delta/rootattributedelta + */ + +import Delta from './delta'; +import DeltaFactory from './deltafactory'; + +/** + * To provide specific OT behavior and better collisions solving, methods to change attributes + * ({@link module:engine/model/batch~Batch#setAttribute} and {@link module:engine/model/batch~Batch#removeAttribute}) + * use `RootAttributeDelta` class which inherits from the `Delta` class and may + * overwrite some methods. + * + * @extends module:engine/model/delta/delta~Delta + */ +export default class RootAttributeDelta extends Delta { + /** + * @inheritDoc + */ + static get className() { + return 'engine.model.delta.RootAttributeDelta'; + } +} + +DeltaFactory.register( RootAttributeDelta ); diff --git a/tests/model/delta/attributedelta.js b/tests/model/delta/attributedelta.js index 442a17a4c..d1eb4a88f 100644 --- a/tests/model/delta/attributedelta.js +++ b/tests/model/delta/attributedelta.js @@ -6,7 +6,7 @@ import Document from '../../../src/model/document'; import Range from '../../../src/model/range'; import Position from '../../../src/model/position'; -import { default as AttributeDelta, RootAttributeDelta } from '../../../src/model/delta/attributedelta'; +import AttributeDelta from '../../../src/model/delta/attributedelta'; import AttributeOperation from '../../../src/model/operation/attributeoperation'; import NoOperation from '../../../src/model/operation/nooperation'; import { jsonParseStringify } from '../../../tests/model/_utils/utils'; @@ -128,9 +128,3 @@ describe( 'AttributeDelta', () => { expect( json ).not.to.have.property( '_range' ); } ); } ); - -describe( 'RootAttributeDelta', () => { - it( 'should provide proper className', () => { - expect( RootAttributeDelta.className ).to.equal( 'engine.model.delta.RootAttributeDelta' ); - } ); -} ); diff --git a/tests/model/delta/rootattributedelta.js b/tests/model/delta/rootattributedelta.js new file mode 100644 index 000000000..1061be0d5 --- /dev/null +++ b/tests/model/delta/rootattributedelta.js @@ -0,0 +1,12 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import RootAttributeDelta from '../../../src/model/delta/rootattributedelta'; + +describe( 'RootAttributeDelta', () => { + it( 'should provide proper className', () => { + expect( RootAttributeDelta.className ).to.equal( 'engine.model.delta.RootAttributeDelta' ); + } ); +} ); From 59c4dca0743f542a5a9b87366d06671f37d83979 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 24 Nov 2017 17:52:14 +0100 Subject: [PATCH 068/724] Used position and offset in DetachOperation. --- src/model/operation/detachoperation.js | 34 ++++++++++++++++++------ tests/model/operation/detachoperation.js | 10 +++---- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/src/model/operation/detachoperation.js b/src/model/operation/detachoperation.js index 1fe8adaf3..c6a654a70 100644 --- a/src/model/operation/detachoperation.js +++ b/src/model/operation/detachoperation.js @@ -8,6 +8,8 @@ */ import Operation from './operation'; +import Position from '../position'; +import Range from '../range'; import { remove } from '../writer'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; @@ -21,19 +23,28 @@ export default class DetachOperation extends Operation { /** * Creates an insert operation. * - * @param {module:engine/model/range~Range} range Range to remove. + * @param {module:engine/model/position~Position} sourcePosition + * Position before the first {@link module:engine/model/item~Item model item} to move. + * @param {Number} howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at + * `sourcePosition` with offset shifted by `howMany`. * @param {Number} baseVersion {@link module:engine/model/document~Document#version} on which operation can be applied. */ - constructor( range, baseVersion ) { + constructor( sourcePosition, howMany, baseVersion ) { super( baseVersion ); /** - * Node to remove. + * Position before the first {@link module:engine/model/item~Item model item} to detach. * - * @readonly - * @member {module:engine/model/range~Range} #range + * @member {module:engine/model/position~Position} #sourcePosition */ - this.range = range; + this.sourcePosition = Position.createFromPosition( sourcePosition ); + + /** + * Offset size of moved range. + * + * @member {Number} #howMany + */ + this.howMany = howMany; } /** @@ -54,7 +65,7 @@ export default class DetachOperation extends Operation { * @inheritDoc */ _execute() { - if ( this.range.root.document ) { + if ( this.sourcePosition.root.document ) { /** * Cannot detach document node. * Use {@link module:engine/model/operation/removeoperation~RemoveOperation remove operation} instead. @@ -64,8 +75,15 @@ export default class DetachOperation extends Operation { throw new CKEditorError( 'detach-operation-on-document-node: Cannot detach document node.' ); } - const nodes = remove( this.range ); + const nodes = remove( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ) ); return { nodes }; } + + /** + * @inheritDoc + */ + static get className() { + return 'engine.model.operation.DetachOperation'; + } } diff --git a/tests/model/operation/detachoperation.js b/tests/model/operation/detachoperation.js index 95ac17b2a..6d1a16856 100644 --- a/tests/model/operation/detachoperation.js +++ b/tests/model/operation/detachoperation.js @@ -7,7 +7,7 @@ import Document from '../../../src/model/document'; import DetachOperation from '../../../src/model/operation/detachoperation'; import { wrapInDelta } from '../../../tests/model/_utils/utils'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -import Range from '../../../src/model/range'; +import Position from '../../../src/model/position'; describe( 'DetachOperation', () => { let doc, batch, docFrag, element; @@ -22,13 +22,13 @@ describe( 'DetachOperation', () => { } ); it( 'should have type equal to detach', () => { - const op = new DetachOperation( element, doc.version ); + const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); expect( op.type ).to.equal( 'detach' ); } ); it( 'should remove given element from parent', () => { - const op = new DetachOperation( Range.createOn( element ), doc.version ); + const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); doc.applyOperation( wrapInDelta( op ) ); @@ -40,7 +40,7 @@ describe( 'DetachOperation', () => { const element = batch.createElement( 'element' ); batch.append( element, root ); - const op = new DetachOperation( Range.createOn( element ), doc.version ); + const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); expect( () => { op._execute(); @@ -48,7 +48,7 @@ describe( 'DetachOperation', () => { } ); it( 'should be not a document operation', () => { - const op = new DetachOperation( element, doc.version ); + const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); expect( op.isDocumentOperation ).to.false; } ); From bfe84dcc7218912478a9901a99144d2e855fa88c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 24 Nov 2017 17:53:22 +0100 Subject: [PATCH 069/724] Added DetachOperation to EngineDebug. --- src/dev-utils/enableenginedebug.js | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index 24cabc8d9..2861428e8 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -18,6 +18,7 @@ import ModelTextProxy from '../model/textproxy'; import ModelElement from '../model/element'; import Operation from '../model/operation/operation'; import AttributeOperation from '../model/operation/attributeoperation'; +import DetachOperation from '../model/operation/detachoperation'; import InsertOperation from '../model/operation/insertoperation'; import MarkerOperation from '../model/operation/markeroperation'; import MoveOperation from '../model/operation/moveoperation'; @@ -25,7 +26,8 @@ import NoOperation from '../model/operation/nooperation'; import RenameOperation from '../model/operation/renameoperation'; import RootAttributeOperation from '../model/operation/rootattributeoperation'; import Delta from '../model/delta/delta'; -import { default as AttributeDelta, RootAttributeDelta } from '../model/delta/attributedelta'; +import AttributeDelta from '../model/delta/attributedelta'; +import RootAttributeDelta from '../model/delta/rootattributedelta'; import InsertDelta from '../model/delta/insertdelta'; import MarkerDelta from '../model/delta/markerdelta'; import MergeDelta from '../model/delta/mergedelta'; @@ -273,6 +275,13 @@ function enableLoggingTools() { `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.range }`; }; + DetachOperation.prototype.toString = function() { + const range = ModelRange.createFromPositionAndShift( this.sourcePosition, this.howMany ); + const nodes = Array.from( range.getItems() ); + + return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodes.length > 1 ? range : nodes[ 0 ] + ' ' + range }`; + }; + InsertOperation.prototype.toString = function() { const nodeString = this.nodes.length > 1 ? `[ ${ this.nodes.length } ]` : this.nodes.getNode( 0 ); From ff4ff7d332ecbbe05407428b108d9e14b516564f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 24 Nov 2017 17:54:00 +0100 Subject: [PATCH 070/724] Aligned Batch#remove with new DetachOperation API. --- src/model/batch.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 7fc509cce..1b2149089 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -339,9 +339,7 @@ export default class Batch { operation = new RemoveOperation( position, howMany, gyPosition, this.document.version ); } else { - const range = Range.createFromPositionAndShift( position, howMany ); - - operation = new DetachOperation( range, this.document.version ); + operation = new DetachOperation( position, howMany, this.document.version ); } delta.addOperation( operation ); From c587d71c7c441005181a4db986ed0f53cbe2bcc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 24 Nov 2017 17:56:19 +0100 Subject: [PATCH 071/724] Fixed invalid import path. --- src/dev-utils/enableenginedebug.js | 2 +- tests/dev-utils/enableenginedebug.js | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index 2861428e8..a2644e691 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -27,12 +27,12 @@ import RenameOperation from '../model/operation/renameoperation'; import RootAttributeOperation from '../model/operation/rootattributeoperation'; import Delta from '../model/delta/delta'; import AttributeDelta from '../model/delta/attributedelta'; -import RootAttributeDelta from '../model/delta/rootattributedelta'; import InsertDelta from '../model/delta/insertdelta'; import MarkerDelta from '../model/delta/markerdelta'; import MergeDelta from '../model/delta/mergedelta'; import MoveDelta from '../model/delta/movedelta'; import RenameDelta from '../model/delta/renamedelta'; +import RootAttributeDelta from '../model/delta/rootattributedelta'; import SplitDelta from '../model/delta/splitdelta'; import UnwrapDelta from '../model/delta/unwrapdelta'; import WrapDelta from '../model/delta/wrapdelta'; diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index dc4a3323d..d52e9854e 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -22,12 +22,13 @@ import RootAttributeOperation from '../../src/model/operation/rootattributeopera import RemoveOperation from '../../src/model/operation/removeoperation'; import DeltaFactory from '../../src/model/delta/deltafactory'; import Delta from '../../src/model/delta/delta'; -import { default as AttributeDelta, RootAttributeDelta } from '../../src/model/delta/attributedelta'; +import AttributeDelta from '../../src/model/delta/attributedelta'; import InsertDelta from '../../src/model/delta/insertdelta'; import MarkerDelta from '../../src/model/delta/markerdelta'; import MergeDelta from '../../src/model/delta/mergedelta'; import MoveDelta from '../../src/model/delta/movedelta'; import RenameDelta from '../../src/model/delta/renamedelta'; +import RootAttributeDelta from '../../src/model/delta/rootattributedelta'; import SplitDelta from '../../src/model/delta/splitdelta'; import UnwrapDelta from '../../src/model/delta/unwrapdelta'; import WrapDelta from '../../src/model/delta/wrapdelta'; From 2efb4145d0cea1b7e6823faea001299ae9400ff1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 27 Nov 2017 12:21:00 +0100 Subject: [PATCH 072/724] Increased CC of enginedebug. --- src/dev-utils/enableenginedebug.js | 3 ++- tests/dev-utils/enableenginedebug.js | 34 ++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index a2644e691..e042f26a7 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -278,8 +278,9 @@ function enableLoggingTools() { DetachOperation.prototype.toString = function() { const range = ModelRange.createFromPositionAndShift( this.sourcePosition, this.howMany ); const nodes = Array.from( range.getItems() ); + const nodeString = nodes.length > 1 ? `[ ${ nodes.length } ]` : nodes[ 0 ]; - return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodes.length > 1 ? range : nodes[ 0 ] + ' ' + range }`; + return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ range }`; }; InsertOperation.prototype.toString = function() { diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index d52e9854e..e15857f69 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -13,6 +13,7 @@ import ModelText from '../../src/model/text'; import ModelTextProxy from '../../src/model/textproxy'; import ModelElement from '../../src/model/element'; import AttributeOperation from '../../src/model/operation/attributeoperation'; +import DetachOperation from '../../src/model/operation/detachoperation'; import InsertOperation from '../../src/model/operation/insertoperation'; import MarkerOperation from '../../src/model/operation/markeroperation'; import MoveOperation from '../../src/model/operation/moveoperation'; @@ -210,6 +211,39 @@ describe( 'debug tools', () => { expect( log.calledWithExactly( op.toString() ) ).to.be.true; } ); + it( 'DetachOperation (text node)', () => { + const op = new DetachOperation( ModelPosition.createAt( modelRoot, 0 ), 3, 0 ); + + expect( op.toString() ).to.equal( 'DetachOperation( 0 ): #foo -> main [ 0 ] - [ 3 ]' ); + + op.log(); + expect( log.calledWithExactly( op.toString() ) ).to.be.true; + } ); + + it( 'DetachOperation (element)', () => { + const element = new ModelElement( 'element' ); + modelRoot.insertChildren( 0, element ); + + const op = new DetachOperation( ModelPosition.createBefore( element ), 1, 0 ); + + expect( op.toString() ).to.equal( 'DetachOperation( 0 ): -> main [ 0 ] - [ 1 ]' ); + + op.log(); + expect( log.calledWithExactly( op.toString() ) ).to.be.true; + } ); + + it( 'DetachOperation (multiple nodes)', () => { + const element = new ModelElement( 'element' ); + modelRoot.insertChildren( 0, element ); + + const op = new DetachOperation( ModelPosition.createBefore( element ), 2, 0 ); + + expect( op.toString() ).to.equal( 'DetachOperation( 0 ): [ 2 ] -> main [ 0 ] - [ 2 ]' ); + + op.log(); + expect( log.calledWithExactly( op.toString() ) ).to.be.true; + } ); + it( 'InsertOperation (text node)', () => { const op = new InsertOperation( ModelPosition.createAt( modelRoot, 3 ), [ new ModelText( 'abc' ) ], 0 ); From cf582fb50961b9d3ba2581d307f8c9d217e6ea2a Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Mon, 27 Nov 2017 13:43:22 +0100 Subject: [PATCH 073/724] Tests: add missing tests for clearAttributes. --- tests/model/batch.js | 55 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/tests/model/batch.js b/tests/model/batch.js index 1fecf9bb4..1c482736d 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -1283,6 +1283,61 @@ describe( 'Batch', () => { expect( spy.callCount ).to.equal( 0 ); } ); } ); + + describe( 'clearAttributes', () => { + it( 'should clear attributes from range', () => { + batch.appendText( 'xxx', { a: 1, b: 2, c: 3 }, root ); + batch.appendText( 'xxx', root ); + batch.appendText( 'xxx', { a: 1 }, root ); + batch.appendText( 'xxx', { b: 2 }, root ); + batch.appendText( 'xxx', root ); + batch.appendElement( 'e', { a: 1 }, root ); + batch.appendText( 'xxx', root ); + + const range = Range.createIn( root ); + + batch.clearAttributes( range ); + + let itemsCount = 0; + + for ( const item of range.getItems() ) { + itemsCount++; + expect( Array.from( item.getAttributeKeys() ).length ).to.equal( 0 ); + } + + expect( itemsCount ).to.equal( 3 ); + } ); + + it( 'should clear attributes on element', () => { + const element = batch.createElement( 'x', { a: 1, b: 2, c: 3 }, root ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 3 ); + + batch.clearAttributes( element ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); + } ); + + it( 'should clear attributes on root element', () => { + batch.setAttributes( root, { a: 1, b: 2, c: 3 } ); + + expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 3 ); + + batch.clearAttributes( root ); + + expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 0 ); + } ); + + it( 'should do nothing if there are no attributes', () => { + const element = batch.createElement( 'x' ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); + + batch.clearAttributes( element ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); + } ); + } ); } ); it( 'should not add empty delta to the batch', () => { From 4334b642a62cfc8d7c45e81f32314738fc0ae2dc Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Mon, 27 Nov 2017 15:13:42 +0100 Subject: [PATCH 074/724] Tests: added tests for split element with no parent and document fragment. Docs: Remove @chainable from methods which are not chainable anymore. --- src/model/batch.js | 25 ++++++------------------- tests/model/batch.js | 22 +++++++++++++++++++++- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 1b2149089..17492067e 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -56,9 +56,6 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * batch.insert( firstPosition, 'foo' ); * batch.insert( secondPosition, 'bar' ); * - * Note that all document modification methods (insert, remove, split, etc.) are chainable so you can shorten code to: - * - * doc.batch().insert( firstPosition, 'foo' ).insert( secondPosition, 'bar' ); */ export default class Batch { /** @@ -228,7 +225,6 @@ export default class Batch { * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} * or on a {@link module:engine/model/range~Range range}. * - * @chainable * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange * Model item or range on which the attribute will be set. * @param {String} key Attribute key. @@ -252,7 +248,6 @@ export default class Batch { * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} * or from a {@link module:engine/model/range~Range range}. * - * @chainable * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange * Model item or range from which the attribute will be removed. * @method module:engine/model/batch~Batch#removeAttribute @@ -322,9 +317,8 @@ export default class Batch { } /** - * Removes given {@link module:engine/model/item~Item model item} or given range. + * Removes given model {@link module:engine/model/item~Item item} or {@link module:engine/model/range~Range range}. * - * @chainable * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range to remove. */ remove( itemOrRange ) { @@ -366,7 +360,6 @@ export default class Batch { * Node before and after the position have to be an element. Otherwise `batch-merge-no-element-before` or * `batch-merge-no-element-after` error will be thrown. * - * @chainable * @param {module:engine/model/position~Position} position Position of merge. */ merge( position ) { @@ -419,7 +412,6 @@ export default class Batch { /** * Renames given element. * - * @chainable * @param {module:engine/model/element~Element} element The element to rename. * @param {String} newName New element name. */ @@ -444,10 +436,9 @@ export default class Batch { /** * Splits an element at the given position. * - * The element cannot be a root element, as root element cannot be split. The `batch-split-root` error will be thrown if - * you try to split the root element. + * The element cannot be a root element, as root element cannot be split. The `batch-split-element-no-parent` error + * will be thrown if you try to split an element with no parent. * - * @chainable * @param {module:engine/model/position~Position} position Position of split. */ split( position ) { @@ -458,11 +449,11 @@ export default class Batch { if ( !splitElement.parent ) { /** - * Root element can not be split. + * Element with no parent can not be split. * - * @error batch-split-root + * @error batch-split-element-no-parent */ - throw new CKEditorError( 'batch-split-root: Root element can not be split.' ); + throw new CKEditorError( 'batch-split-element-no-parent: Element with no parent can not be split.' ); } const copy = new Element( splitElement.name, splitElement.getAttributes() ); @@ -492,7 +483,6 @@ export default class Batch { * Wraps given range with given element or with a new element with specified name, if string has been passed. * **Note:** range to wrap should be a "flat range" (see {@link module:engine/model/range~Range#isFlat}). If not, error will be thrown. * - * @chainable * @param {module:engine/model/range~Range} range Range to wrap. * @param {module:engine/model/element~Element|String} elementOrString Element or name of element to wrap the range with. */ @@ -548,7 +538,6 @@ export default class Batch { * Unwraps children of the given element – all its children are moved before it and then the element is removed. * Throws error if you try to unwrap an element which does not have a parent. * - * @chainable * @param {module:engine/model/element~Element} element Element to unwrap. */ unwrap( element ) { @@ -600,7 +589,6 @@ export default class Batch { * is waiting for additional data, etc.). In this case, the marker may be first created directly through * {@link module:engine/model/markercollection~MarkerCollection MarkerCollection API} and only later added using `Batch` API. * - * @chainable * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to add or update. * @param {module:engine/model/range~Range} [newRange] Marker range. */ @@ -632,7 +620,6 @@ export default class Batch { /** * Removes given {@link module:engine/model/markercollection~Marker marker} or marker with given name. * - * @chainable * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to remove. */ removeMarker( markerOrName ) { diff --git a/tests/model/batch.js b/tests/model/batch.js index 1c482736d..9fc9c49f1 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -1729,7 +1729,27 @@ describe( 'Batch', () => { it( 'should throw if we try to split a root', () => { expect( () => { doc.batch().split( new Position( root, [ 0 ] ) ); - } ).to.throw( CKEditorError, /^batch-split-root/ ); + } ).to.throw( CKEditorError, /^batch-split-element-no-parent/ ); + } ); + + it( 'should throw if we try to split an element with no parent', () => { + const batch = doc.batch(); + + expect( () => { + const element = batch.createElement( 'p' ); + + batch.split( new Position( element, [ 0 ] ) ); + } ).to.throw( CKEditorError, /^batch-split-element-no-parent/ ); + } ); + + it( 'should throw if we try to split a document fragment', () => { + const batch = doc.batch(); + + expect( () => { + const documentFragment = batch.createDocumentFragment(); + + batch.split( new Position( documentFragment, [ 0 ] ) ); + } ).to.throw( CKEditorError, /^batch-split-element-no-parent/ ); } ); } ); From 3c88520131416893ab9c479f13c07aeecf1205b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 27 Nov 2017 17:21:51 +0100 Subject: [PATCH 075/724] Refactored conversion and DataController to use new Batch API. --- src/controller/datacontroller.js | 12 ++-- src/controller/insertcontent.js | 6 +- src/conversion/buildviewconverter.js | 21 +++--- src/conversion/view-to-model-converters.js | 10 +-- src/conversion/viewconversiondispatcher.js | 56 ++++++++------- src/dev-utils/model.js | 13 ++-- src/model/document.js | 3 +- src/model/schema.js | 13 +--- tests/controller/datacontroller.js | 36 ++++++---- tests/controller/editingcontroller.js | 9 ++- tests/controller/insertcontent.js | 6 +- tests/conversion/advanced-converters.js | 39 +++++------ tests/conversion/buildviewconverter.js | 71 +++++++++++--------- tests/conversion/view-to-model-converters.js | 22 +++--- tests/conversion/viewconversiondispatcher.js | 39 ++++++----- tests/dev-utils/model.js | 24 +++---- tests/model/document/document.js | 8 +-- tests/model/schema/schema.js | 31 ++------- tests/model/selection.js | 8 +-- 19 files changed, 214 insertions(+), 213 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 1bb558dfa..7443f4c17 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -198,7 +198,7 @@ export default class DataController { const batch = this.model.batch( 'transparent' ); batch.remove( ModelRange.createIn( modelRoot ) ); - batch.insert( this.parse( data ), modelRoot ); + batch.insert( this.parse( data, batch ), modelRoot ); } ); } @@ -208,16 +208,17 @@ export default class DataController { * * @see #set * @param {String} data Data to parse. + * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {String} [context='$root'] Base context in which the view will be converted to the model. See: * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#convert}. * @returns {module:engine/model/documentfragment~DocumentFragment} Parsed data. */ - parse( data, context = '$root' ) { + parse( data, batch, context = '$root' ) { // data -> view const viewDocumentFragment = this.processor.toView( data ); // view -> model - return this.toModel( viewDocumentFragment, context ); + return this.toModel( viewDocumentFragment, batch, context ); } /** @@ -231,12 +232,13 @@ export default class DataController { * * @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} viewElementOrFragment * Element or document fragment which content will be converted. + * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {String} [context='$root'] Base context in which the view will be converted to the model. See: * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#convert}. * @returns {module:engine/model/documentfragment~DocumentFragment} Output document fragment. */ - toModel( viewElementOrFragment, context = '$root' ) { - return this.viewToModel.convert( viewElementOrFragment, { context: [ context ] } ); + toModel( viewElementOrFragment, batch, context = '$root' ) { + return this.viewToModel.convert( viewElementOrFragment, { context: [ context ], batch } ); } /** diff --git a/src/controller/insertcontent.js b/src/controller/insertcontent.js index 9547592c8..4132d8875 100644 --- a/src/controller/insertcontent.js +++ b/src/controller/insertcontent.js @@ -229,7 +229,7 @@ class Insertion { // If the node is a text and bare text is allowed in current position it means that the node // contains disallowed attributes and we have to remove them. else if ( this.schema.check( { name: '$text', inside: this.position } ) ) { - this.schema.removeDisallowedAttributes( [ node ], this.position ); + this.schema.removeDisallowedAttributes( [ node ], this.position, this.batch ); this._handleNode( node, context ); } // If text is not allowed, try autoparagraphing. @@ -341,7 +341,7 @@ class Insertion { * @param {Object} context */ _tryAutoparagraphing( node, context ) { - const paragraph = new Element( 'paragraph' ); + const paragraph = this.batch.createElement( 'paragraph' ); // Do not autoparagraph if the paragraph won't be allowed there, // cause that would lead to an infinite loop. The paragraph would be rejected in @@ -350,7 +350,7 @@ class Insertion { // When node is a text and is disallowed by schema it means that contains disallowed attributes // and we need to remove them. if ( node.is( 'text' ) && !this._checkIsAllowed( node, [ paragraph ] ) ) { - this.schema.removeDisallowedAttributes( [ node ], [ paragraph ] ); + this.schema.removeDisallowedAttributes( [ node ], [ paragraph ], this.batch ); } if ( this._checkIsAllowed( node, [ paragraph ] ) ) { diff --git a/src/conversion/buildviewconverter.js b/src/conversion/buildviewconverter.js index ce7820046..bb4a120e9 100644 --- a/src/conversion/buildviewconverter.js +++ b/src/conversion/buildviewconverter.js @@ -8,9 +8,6 @@ */ import Matcher from '../view/matcher'; -import ModelElement from '../model/element'; -import ModelPosition from '../model/position'; -import modelWriter from '../model/writer'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable'; @@ -266,13 +263,15 @@ class ViewConverterBuilder { * buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); * buildViewConverter().for( dispatcher ) * .fromElement( 'img' ) - * .toElement( ( viewElement ) => new ModelElement( 'image', { src: viewElement.getAttribute( 'src' ) } ); + * .toElement( ( viewElement, batch ) => batch.createElement( 'image', { src: viewElement.getAttribute( 'src' ) } ) ); * * @param {String|Function} element Model element name or model element creator function. */ toElement( element ) { function eventCallbackGen( from ) { return ( evt, data, consumable, conversionApi ) => { + const batch = data.batch; + // There is one callback for all patterns in the matcher. // This will be usually just one pattern but we support matchers with many patterns too. const matchAll = from.matcher.matchAll( data.input ); @@ -285,7 +284,7 @@ class ViewConverterBuilder { // Now, for every match between matcher and actual element, we will try to consume the match. for ( const match of matchAll ) { // Create model element basing on creator function or element name. - const modelElement = element instanceof Function ? element( data.input ) : new ModelElement( element ); + const modelElement = element instanceof Function ? element( data.input, batch ) : batch.createElement( element ); // Do not convert if element building function returned falsy value. if ( !modelElement ) { @@ -310,8 +309,10 @@ class ViewConverterBuilder { // Convert children of converted view element and append them to `modelElement`. const modelChildren = conversionApi.convertChildren( data.input, consumable, data ); - const insertPosition = ModelPosition.createAt( modelElement, 'end' ); - modelWriter.insert( insertPosition, modelChildren ); + + for ( const child of Array.from( modelChildren ) ) { + batch.append( child, modelElement ); + } // Remove created `modelElement` from the parents stack. data.context.pop(); @@ -434,6 +435,8 @@ class ViewConverterBuilder { toMarker( creator ) { function eventCallbackGen( from ) { return ( evt, data, consumable ) => { + const batch = data.batch; + // There is one callback for all patterns in the matcher. // This will be usually just one pattern but we support matchers with many patterns too. const matchAll = from.matcher.matchAll( data.input ); @@ -450,7 +453,7 @@ class ViewConverterBuilder { modelElement = creator( data.input ); // When there is no creator then create model element basing on data from view element. } else { - modelElement = new ModelElement( '$marker', { 'data-name': data.input.getAttribute( 'data-name' ) } ); + modelElement = batch.createElement( '$marker', { 'data-name': data.input.getAttribute( 'data-name' ) } ); } // Check if model element is correct (has proper name and property). @@ -525,7 +528,7 @@ function setAttributeOn( toChange, attribute, data, conversionApi ) { }; if ( conversionApi.schema.check( schemaQuery ) ) { - toChange.setAttribute( attribute.key, attribute.value ); + data.batch.setAttribute( toChange, attribute.key, attribute.value ); } } diff --git a/src/conversion/view-to-model-converters.js b/src/conversion/view-to-model-converters.js index 24c872587..0652c82c2 100644 --- a/src/conversion/view-to-model-converters.js +++ b/src/conversion/view-to-model-converters.js @@ -3,10 +3,6 @@ * For licensing, see LICENSE.md. */ -import ModelDocumentFragment from '../model/documentfragment'; -import ModelText from '../model/text'; -import { normalizeNodes } from '../model/writer'; - /** * Contains {@link module:engine/view/view view} to {@link module:engine/model/model model} converters for * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher}. @@ -33,9 +29,7 @@ export function convertToModelFragment() { return ( evt, data, consumable, conversionApi ) => { // Second argument in `consumable.consume` is discarded for ViewDocumentFragment but is needed for ViewElement. if ( !data.output && consumable.consume( data.input, { name: true } ) ) { - const convertedChildren = conversionApi.convertChildren( data.input, consumable, data ); - - data.output = new ModelDocumentFragment( normalizeNodes( convertedChildren ) ); + data.output = conversionApi.convertChildren( data.input, consumable, data ); } }; } @@ -54,7 +48,7 @@ export function convertText() { if ( conversionApi.schema.check( schemaQuery ) ) { if ( consumable.consume( data.input ) ) { - data.output = new ModelText( data.input.data ); + data.output = data.batch.createText( data.input.data ); } } }; diff --git a/src/conversion/viewconversiondispatcher.js b/src/conversion/viewconversiondispatcher.js index 4a9100cac..32da4824f 100644 --- a/src/conversion/viewconversiondispatcher.js +++ b/src/conversion/viewconversiondispatcher.js @@ -13,7 +13,6 @@ import ModelPosition from '../model/position'; import ModelTreeWalker from '../model/treewalker'; import ModelNode from '../model/node'; import ModelDocumentFragment from '../model/documentfragment'; -import { remove } from '../model/writer'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; @@ -134,13 +133,16 @@ export default class ViewConversionDispatcher { * @fires documentFragment * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element} viewItem * Part of the view to be converted. - * @param {Object} [additionalData] Additional data to be passed in `data` argument when firing `ViewConversionDispatcher` + * @param {Object} additionalData Additional data to be passed in `data` argument when firing `ViewConversionDispatcher` * events. See also {@link ~ViewConversionDispatcher#event:element element event}. + * @param {module:engine/model/batch~Batch} additionalData.batch Batch to which the deltas will be added. * @returns {module:engine/model/documentfragment~DocumentFragment} Model data that is a result of the conversion process * wrapped in `DocumentFragment`. Converted marker elements will be set as that document fragment's * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}. */ - convert( viewItem, additionalData = {} ) { + convert( viewItem, additionalData ) { + const batch = additionalData.batch; + this.fire( 'viewCleanup', viewItem ); const consumable = ViewConsumable.createFrom( viewItem ); @@ -149,16 +151,19 @@ export default class ViewConversionDispatcher { // We can get a null here if conversion failed (see _convertItem()) // or simply if an item could not be converted (e.g. due to the schema). if ( !conversionResult ) { - return new ModelDocumentFragment(); + return batch.createDocumentFragment(); } // When conversion result is not a document fragment we need to wrap it in document fragment. if ( !conversionResult.is( 'documentFragment' ) ) { - conversionResult = new ModelDocumentFragment( [ conversionResult ] ); + const docFrag = batch.createDocumentFragment(); + + batch.append( conversionResult, docFrag ); + conversionResult = docFrag; } // Extract temporary markers elements from model and set as static markers collection. - conversionResult.markers = extractMarkersFromModelFragment( conversionResult ); + conversionResult.markers = extractMarkersFromModelFragment( conversionResult, batch ); return conversionResult; } @@ -203,24 +208,23 @@ export default class ViewConversionDispatcher { * @private * @see module:engine/conversion/viewconversiondispatcher~ViewConversionApi#convertChildren */ - _convertChildren( input, consumable, additionalData = {} ) { - // Get all children of view input item. - const viewChildren = Array.from( input.getChildren() ); - - // 1. Map those children to model. - // 2. Filter out items that has not been converted or for which conversion returned wrong result (for those warning is logged). - // 3. Extract children from document fragments to flatten results. - const convertedChildren = viewChildren - .map( viewChild => this._convertItem( viewChild, consumable, additionalData ) ) - .filter( converted => converted instanceof ModelNode || converted instanceof ModelDocumentFragment ) - .reduce( ( result, filtered ) => { - return result.concat( - filtered.is( 'documentFragment' ) ? Array.from( filtered.getChildren() ) : filtered - ); - }, [] ); - - // Normalize array to model document fragment. - return new ModelDocumentFragment( convertedChildren ); + _convertChildren( input, consumable, additionalData ) { + const batch = additionalData.batch; + const documentFragment = batch.createDocumentFragment(); + + for ( const viewChild of Array.from( input.getChildren() ) ) { + const modelChild = this._convertItem( viewChild, consumable, additionalData ); + + if ( modelChild instanceof ModelNode ) { + batch.append( modelChild, documentFragment ); + } else if ( modelChild instanceof ModelDocumentFragment ) { + for ( const child of Array.from( modelChild ) ) { + batch.append( child, documentFragment ); + } + } + } + + return documentFragment; } /** @@ -278,7 +282,7 @@ mix( ViewConversionDispatcher, EmitterMixin ); // // @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/node~Node} modelItem Fragment of model. // @returns {Map} List of static markers. -function extractMarkersFromModelFragment( modelItem ) { +function extractMarkersFromModelFragment( modelItem, batch ) { const markerElements = new Set(); const markers = new Map(); @@ -310,7 +314,7 @@ function extractMarkersFromModelFragment( modelItem ) { } // Remove marker element from DocumentFragment. - remove( ModelRange.createOn( markerElement ) ); + batch.remove( markerElement ); } return markers; diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 9fa8650e9..2c8103f48 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -96,8 +96,10 @@ export function setData( document, data, options = {} ) { let modelDocumentFragment, selection; const modelRoot = document.getRoot( options.rootName || 'main' ); + const batch = document.batch( options.batchType || 'transparent' ); + // Parse data string to model. - const parsedResult = setData._parse( data, document.schema, { + const parsedResult = setData._parse( data, document.schema, batch, { lastRangeBackward: options.lastRangeBackward, selectionAttributes: options.selectionAttributes, context: [ modelRoot.name ] @@ -113,8 +115,6 @@ export function setData( document, data, options = {} ) { document.enqueueChanges( () => { // Replace existing model in document by new one. - const batch = document.batch( options.batchType || 'transparent' ); - batch.remove( ModelRange.createIn( modelRoot ) ); batch.insert( modelDocumentFragment, modelRoot ); @@ -243,7 +243,8 @@ export function stringify( node, selectionOrPositionOrRange = null ) { * * @param {String} data HTML-like string to be parsed. * @param {module:engine/model/schema~Schema} schema Schema instance uses by converters for element validation. - * @param {Object} options Additional configuration. + * @param {module:engine/model/batch~Batch} batch Batch used for conversion. + * @param {Object} [options={}] Additional configuration. * @param {Array} [options.selectionAttributes] List of attributes which will be passed to the selection. * @param {Boolean} [options.lastRangeBackward=false] If set to true last range will be added as backward. * @param {module:engine/model/schema~SchemaPath} [options.context=[ '$root' ]] The conversion context. @@ -252,7 +253,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { * module:engine/model/documentfragment~DocumentFragment|Object} Returns parsed model node or * object with two fields `model` and `selection` when selection ranges were included in data to parse. */ -export function parse( data, schema, options = {} ) { +export function parse( data, schema, batch, options = {} ) { const mapper = new Mapper(); // Replace not accepted by XML `$text` tag name by valid one `model-text-with-attributes`. @@ -283,7 +284,7 @@ export function parse( data, schema, options = {} ) { viewToModel.on( 'text', convertToModelText() ); // Convert view to model. - let model = viewToModel.convert( viewDocumentFragment.root, { context: options.context || [ '$root' ] } ); + let model = viewToModel.convert( viewDocumentFragment.root, { context: options.context || [ '$root' ], batch } ); // If root DocumentFragment contains only one element - return that element. if ( model.is( 'documentFragment' ) && model.childCount == 1 ) { diff --git a/src/model/document.js b/src/model/document.js index 018d1e1c7..4d023e4d9 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -168,9 +168,8 @@ export default class Document { if ( operation.isDocumentOperation ) { this.version++; this.history.addDelta( operation.delta ); + this.fire( 'change', operation.type, changes, operation.delta.batch, operation.delta.type ); } - - this.fire( 'change', operation.type, changes, operation.delta.batch, operation.delta.type ); } /** diff --git a/src/model/schema.js b/src/model/schema.js index 6a5a0b0e8..1b454059a 100644 --- a/src/model/schema.js +++ b/src/model/schema.js @@ -414,14 +414,11 @@ export default class Schema { } /** - * Removes disallowed by {@link module:engine/model/schema~Schema schema} attributes from given nodes. - * When {@link module:engine/model/batch~Batch batch} parameter is provided then attributes will be removed - * using that batch, by creating {@link module:engine/model/delta/attributedelta~AttributeDelta attribute deltas}. - * Otherwise, attributes will be removed directly from provided nodes using {@link module:engine/model/node~Node node} API. + * Removes disallowed by {@link module:engine/model/schema~Schema schema} attributes from given nodes.. * * @param {Iterable.} nodes Nodes that will be filtered. * @param {module:engine/model/schema~SchemaPath} inside Path inside which schema will be checked. - * @param {module:engine/model/batch~Batch} [batch] Batch to which the deltas will be added. + * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. */ removeDisallowedAttributes( nodes, inside, batch ) { for ( const node of nodes ) { @@ -435,11 +432,7 @@ export default class Schema { // TODO: this should be improved to check all combination of attributes. for ( const attribute of node.getAttributeKeys() ) { if ( !this.check( { name, attributes: attribute, inside: queryPath } ) ) { - if ( batch ) { - batch.removeAttribute( node, attribute ); - } else { - node.removeAttribute( attribute ); - } + batch.removeAttribute( node, attribute ); } } } diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index 53e403b65..f20861294 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -48,7 +48,7 @@ describe( 'DataController', () => { describe( 'parse', () => { it( 'should set text', () => { schema.allow( { name: '$text', inside: '$root' } ); - const model = data.parse( '

foobar

' ); + const model = data.parse( '

foobar

', modelDocument.batch() ); expect( model ).to.instanceof( ModelDocumentFragment ); expect( stringify( model ) ).to.equal( 'foobar' ); @@ -59,7 +59,7 @@ describe( 'DataController', () => { buildViewConverter().for( data.viewToModel ).fromElement( 'p' ).toElement( 'paragraph' ); - const model = data.parse( '

foobar

' ); + const model = data.parse( '

foobar

', modelDocument.batch() ); expect( model ).to.instanceof( ModelDocumentFragment ); expect( stringify( model ) ).to.equal( 'foobar' ); @@ -70,7 +70,7 @@ describe( 'DataController', () => { buildViewConverter().for( data.viewToModel ).fromElement( 'p' ).toElement( 'paragraph' ); - const model = data.parse( '

foo

bar

' ); + const model = data.parse( '

foo

bar

', modelDocument.batch() ); expect( model ).to.instanceof( ModelDocumentFragment ); expect( stringify( model ) ).to.equal( 'foobar' ); @@ -83,20 +83,20 @@ describe( 'DataController', () => { buildViewConverter().for( data.viewToModel ).fromElement( 'p' ).toElement( 'paragraph' ); buildViewConverter().for( data.viewToModel ).fromElement( 'b' ).toAttribute( 'bold', true ); - const model = data.parse( '

foobar

' ); + const model = data.parse( '

foobar

', modelDocument.batch() ); expect( model ).to.instanceof( ModelDocumentFragment ); expect( stringify( model ) ).to.equal( 'foo<$text bold="true">bar' ); } ); it( 'should parse in the root context by default', () => { - const model = data.parse( 'foo' ); + const model = data.parse( 'foo', modelDocument.batch() ); expect( stringify( model ) ).to.equal( '' ); } ); it( 'should accept parsing context', () => { - const model = data.parse( 'foo', '$block' ); + const model = data.parse( 'foo', modelDocument.batch(), '$block' ); expect( stringify( model ) ).to.equal( 'foo' ); } ); @@ -111,7 +111,7 @@ describe( 'DataController', () => { it( 'should convert content of an element #1', () => { const viewElement = parseView( '

foo

' ); - const model = data.toModel( viewElement ); + const model = data.toModel( viewElement, modelDocument.batch() ); expect( model ).to.instanceof( ModelDocumentFragment ); expect( stringify( model ) ).to.equal( 'foo' ); @@ -119,7 +119,7 @@ describe( 'DataController', () => { it( 'should convert content of an element #2', () => { const viewFragment = parseView( '

foo

bar

' ); - const model = data.toModel( viewFragment ); + const model = data.toModel( viewFragment, modelDocument.batch() ); expect( model ).to.be.instanceOf( ModelDocumentFragment ); expect( stringify( model ) ).to.equal( 'foobar' ); @@ -134,10 +134,10 @@ describe( 'DataController', () => { const viewFragment = new ViewDocumentFragment( [ parseView( 'foo' ) ] ); // Model fragment in root. - expect( stringify( data.toModel( viewFragment ) ) ).to.equal( '' ); + expect( stringify( data.toModel( viewFragment, modelDocument.batch() ) ) ).to.equal( '' ); // Model fragment in inline root. - expect( stringify( data.toModel( viewFragment, 'inlineRoot' ) ) ).to.equal( 'foo' ); + expect( stringify( data.toModel( viewFragment, modelDocument.batch(), 'inlineRoot' ) ) ).to.equal( 'foo' ); } ); } ); @@ -264,6 +264,8 @@ describe( 'DataController', () => { } ); describe( 'stringify', () => { + let batch; + beforeEach( () => { modelDocument.schema.registerItem( 'paragraph', '$block' ); modelDocument.schema.registerItem( 'div' ); @@ -272,16 +274,18 @@ describe( 'DataController', () => { modelDocument.schema.allow( { name: 'div', inside: '$root' } ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); + + batch = modelDocument.batch(); } ); it( 'should stringify a content of an element', () => { - const modelElement = parseModel( '
foo
', modelDocument.schema ); + const modelElement = parseModel( '
foo
', modelDocument.schema, batch ); expect( data.stringify( modelElement ) ).to.equal( '

foo

' ); } ); it( 'should stringify a content of a document fragment', () => { - const modelDocumentFragment = parseModel( 'foobar', modelDocument.schema ); + const modelDocumentFragment = parseModel( 'foobar', modelDocument.schema, batch ); expect( data.stringify( modelDocumentFragment ) ).to.equal( '

foo

bar

' ); } ); @@ -299,7 +303,7 @@ describe( 'DataController', () => { } ); it( 'should convert a content of an element', () => { - const modelElement = parseModel( '
foo
', modelDocument.schema ); + const modelElement = parseModel( '
foo
', modelDocument.schema, modelDocument.batch() ); const viewDocumentFragment = data.toView( modelElement ); @@ -313,7 +317,11 @@ describe( 'DataController', () => { } ); it( 'should convert a document fragment', () => { - const modelDocumentFragment = parseModel( 'foobar', modelDocument.schema ); + const modelDocumentFragment = parseModel( + 'foobar', + modelDocument.schema, + modelDocument.batch() + ); const viewDocumentFragment = data.toView( modelDocumentFragment ); diff --git a/tests/controller/editingcontroller.js b/tests/controller/editingcontroller.js index 43180b503..0cd160e5e 100644 --- a/tests/controller/editingcontroller.js +++ b/tests/controller/editingcontroller.js @@ -155,7 +155,8 @@ describe( 'EditingController', () => { 'foo' + '' + 'bar', - model.schema + model.schema, + model.batch() )._children ); model.enqueueChanges( () => { @@ -409,9 +410,11 @@ describe( 'EditingController', () => { editing.destroy(); + const batch = model.batch(); + model.enqueueChanges( () => { - const modelData = parse( 'foo', model.schema ).getChild( 0 ); - model.batch().insert( modelData, model.getRoot() ); + const modelData = parse( 'foo', model.schema, batch ).getChild( 0 ); + batch.insert( modelData, model.getRoot() ); } ); expect( spy.called ).to.be.false; diff --git a/tests/controller/insertcontent.js b/tests/controller/insertcontent.js index 64d0373af..4a11b6ac2 100644 --- a/tests/controller/insertcontent.js +++ b/tests/controller/insertcontent.js @@ -756,12 +756,14 @@ describe( 'DataController', () => { // // @param {module:engine/model/item~Item|String} content function insertHelper( content ) { + const batch = doc.batch(); + if ( typeof content == 'string' ) { - content = parse( content, doc.schema, { + content = parse( content, doc.schema, batch, { context: [ '$clipboardHolder' ] } ); } - insertContent( dataController, content, doc.selection ); + insertContent( dataController, content, doc.selection, batch ); } } ); diff --git a/tests/conversion/advanced-converters.js b/tests/conversion/advanced-converters.js index 02b7bbfee..9cccf90e7 100644 --- a/tests/conversion/advanced-converters.js +++ b/tests/conversion/advanced-converters.js @@ -40,12 +40,13 @@ import { convertToModelFragment, convertText } from '../../src/conversion/view-t import { createRangeOnElementOnly } from '../../tests/model/_utils/utils'; describe( 'advanced-converters', () => { - let modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher; + let modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher, batch; beforeEach( () => { modelDoc = new ModelDocument(); modelRoot = modelDoc.createRoot(); viewRoot = new ViewContainerElement( 'div' ); + batch = modelDoc.batch(); mapper = new Mapper(); mapper.bindElements( modelRoot, viewRoot ); @@ -207,8 +208,8 @@ describe( 'advanced-converters', () => { const viewFigureConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable ); - const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable ); + const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable, { batch } ); + const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable, { batch } ); modelImage.appendChildren( modelCaption ); @@ -231,7 +232,7 @@ describe( 'advanced-converters', () => { const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { const modelCaption = new ModelElement( 'caption' ); - const children = conversionApi.convertChildren( data.input, consumable ); + const children = conversionApi.convertChildren( data.input, consumable, { batch } ); modelCaption.appendChildren( children ); @@ -286,7 +287,7 @@ describe( 'advanced-converters', () => { it( 'should convert view image to model', () => { const viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ); - const modelElement = viewDispatcher.convert( viewElement ); + const modelElement = viewDispatcher.convert( viewElement, { batch } ); expect( modelToString( modelElement ) ).to.equal( '' ); } ); @@ -300,7 +301,7 @@ describe( 'advanced-converters', () => { new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) ) ] ); - const modelElement = viewDispatcher.convert( viewElement ); + const modelElement = viewDispatcher.convert( viewElement, { batch } ); expect( modelToString( modelElement ) ).to.equal( 'foobar' ); } ); @@ -371,7 +372,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable ); + data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); } for ( const child of data.output ) { @@ -383,7 +384,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { attribute: 'title' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable ); + data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); } for ( const child of data.output ) { @@ -468,7 +469,7 @@ describe( 'advanced-converters', () => { } } - const children = conversionApi.convertChildren( data.input, consumable ); + const children = conversionApi.convertChildren( data.input, consumable, { batch } ); data.output.appendChildren( children ); } } ); @@ -519,7 +520,7 @@ describe( 'advanced-converters', () => { it( 'should convert a view element to model', () => { const viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) ); - const modelText = viewDispatcher.convert( viewElement ).getChild( 0 ); + const modelText = viewDispatcher.convert( viewElement, { batch } ).getChild( 0 ); expect( modelText ).to.be.instanceof( ModelText ); expect( modelText.data ).to.equal( 'foo' ); @@ -590,7 +591,7 @@ describe( 'advanced-converters', () => { ] ); - const modelElement = viewDispatcher.convert( viewElement ); + const modelElement = viewDispatcher.convert( viewElement, { batch } ); expect( modelToString( modelElement ) ).to.equal( 'foo' ); } ); @@ -602,7 +603,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable ); + data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); } for ( const child of data.output ) { @@ -615,7 +616,7 @@ describe( 'advanced-converters', () => { if ( consumable.consume( data.input, { name: true } ) ) { data.output = new ModelElement( 'paragraph' ); - const children = conversionApi.convertChildren( data.input, consumable ); + const children = conversionApi.convertChildren( data.input, consumable, { batch } ); for ( let i = 1; i < children.childCount; i++ ) { const child = children.getChild( i ); @@ -632,13 +633,13 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:table', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.convertChildren( data.input, consumable ); + data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); } } ); viewDispatcher.on( 'element:td', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.convertChildren( data.input, consumable ); + data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); } } ); @@ -653,7 +654,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - const model = viewDispatcher.convert( viewTable ); + const model = viewDispatcher.convert( viewTable, { batch } ); const modelFragment = new ModelDocumentFragment( model ); expect( modelToString( modelFragment ) ) @@ -680,7 +681,7 @@ describe( 'advanced-converters', () => { } } - data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) ); + data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, { batch } ) ); } }, { priority: 'lowest' } ); @@ -704,7 +705,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable ); + data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); } for ( const child of data.output ) { @@ -755,7 +756,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - const modelElement = viewDispatcher.convert( viewElement ); + const modelElement = viewDispatcher.convert( viewElement, { batch } ); expect( modelToString( modelElement ) ).to.equal( '' + diff --git a/tests/conversion/buildviewconverter.js b/tests/conversion/buildviewconverter.js index 0b485f10b..9bf2a6065 100644 --- a/tests/conversion/buildviewconverter.js +++ b/tests/conversion/buildviewconverter.js @@ -6,6 +6,7 @@ import buildViewConverter from '../../src/conversion/buildviewconverter'; import ModelSchema from '../../src/model/schema'; +import ModelDocument from '../../src/model/document'; import ModelDocumentFragment from '../../src/model/documentfragment'; import ModelElement from '../../src/model/element'; import ModelTextProxy from '../../src/model/textproxy'; @@ -63,11 +64,15 @@ const textAttributes = [ undefined, 'linkHref', 'linkTitle', 'bold', 'italic', ' const pAttributes = [ undefined, 'class', 'important', 'theme', 'decorated', 'size' ]; describe( 'View converter builder', () => { - let dispatcher, schema, objWithContext; + let dispatcher, schema, additionalData, batch; + + const modelDocument = new ModelDocument(); beforeEach( () => { + batch = modelDocument.batch(); + // `additionalData` parameter for `.convert` calls. - objWithContext = { context: [ '$root' ] }; + additionalData = { context: [ '$root' ], batch }; schema = new ModelSchema(); @@ -95,7 +100,7 @@ describe( 'View converter builder', () => { it( 'should convert from view element to model element', () => { buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); - const conversionResult = dispatcher.convert( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), objWithContext ); + const conversionResult = dispatcher.convert( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -105,7 +110,7 @@ describe( 'View converter builder', () => { .fromElement( 'img' ) .toElement( viewElement => new ModelElement( 'image', { src: viewElement.getAttribute( 'src' ) } ) ); - const conversionResult = dispatcher.convert( new ViewContainerElement( 'img', { src: 'foo.jpg' } ), objWithContext ); + const conversionResult = dispatcher.convert( new ViewContainerElement( 'img', { src: 'foo.jpg' } ), additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); } ); @@ -114,7 +119,7 @@ describe( 'View converter builder', () => { buildViewConverter().for( dispatcher ).fromElement( 'strong' ).toAttribute( 'bold', true ); const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), objWithContext + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), additionalData ); // Have to check root because result is a ModelText. @@ -127,7 +132,7 @@ describe( 'View converter builder', () => { .toAttribute( viewElement => ( { key: 'linkHref', value: viewElement.getAttribute( 'href' ) } ) ); const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ), objWithContext + new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ), additionalData ); // Have to check root because result is a ModelText. @@ -142,7 +147,7 @@ describe( 'View converter builder', () => { .toAttribute( viewElement => ( { key: 'class', value: viewElement.getAttribute( 'class' ) } ) ); const conversionResult = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), objWithContext + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); @@ -164,7 +169,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'p', { 'data-type': 'foo' }, new ViewText( 'xyz' ) ) ] ); - const conversionResult = dispatcher.convert( viewStructure, objWithContext ); + const conversionResult = dispatcher.convert( viewStructure, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' + @@ -190,7 +195,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'span', { style: 'font-weight:bold; font-size:20px' }, new ViewText( 'ddd' ) ) ] ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '<$text bold="true">aaabbbcccddd' ); } ); @@ -207,7 +212,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); const markerSearch = conversionResult.markers.get( 'search' ); @@ -229,7 +234,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); const markerSearch = conversionResult.markers.get( 'search' ); @@ -255,7 +260,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); const marker1 = conversionResult.markers.get( 'marker1' ); const marker2 = conversionResult.markers.get( 'marker2' ); @@ -272,7 +277,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'span' ); - const result = dispatcher.convert( element, objWithContext ); + const result = dispatcher.convert( element, additionalData ); expect( result ).to.be.instanceof( ModelDocumentFragment ); expect( result.childCount ).to.equal( 0 ); @@ -284,7 +289,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { class: 'search' } ); expect( () => { - dispatcher.convert( element, objWithContext ); + dispatcher.convert( element, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -296,7 +301,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { 'data-name': 'search' } ); expect( () => { - dispatcher.convert( element, objWithContext ); + dispatcher.convert( element, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -308,7 +313,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { 'data-name': 'search' } ); expect( () => { - dispatcher.convert( element, objWithContext ); + dispatcher.convert( element, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -325,7 +330,7 @@ describe( 'View converter builder', () => { // Not quite megatron. result = dispatcher.convert( - new ViewContainerElement( 'span', { class: 'megatron' }, new ViewText( 'foo' ) ), objWithContext + new ViewContainerElement( 'span', { class: 'megatron' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -333,7 +338,7 @@ describe( 'View converter builder', () => { // Almost a megatron. Missing a head. result = dispatcher.convert( new ViewContainerElement( 'span', { class: 'megatron', body: 'megatron', legs: 'megatron' }, new ViewText( 'foo' ) ), - objWithContext + additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -345,7 +350,7 @@ describe( 'View converter builder', () => { { class: 'megatron', body: 'megatron', legs: 'megatron', head: 'megatron' }, new ViewText( 'foo' ) ), - objWithContext + additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -357,7 +362,7 @@ describe( 'View converter builder', () => { { class: 'megatron', body: 'megatron', legs: 'megatron', head: 'megatron' }, new ViewText( 'foo' ) ), - objWithContext + additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -377,7 +382,7 @@ describe( 'View converter builder', () => { new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -387,7 +392,7 @@ describe( 'View converter builder', () => { const viewElement = new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( conversionResult.is( 'documentFragment' ) ).to.be.true; } ); @@ -399,7 +404,7 @@ describe( 'View converter builder', () => { buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); const conversionResult = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), objWithContext + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); // Element converter was fired first even though attribute converter was added first. @@ -415,7 +420,7 @@ describe( 'View converter builder', () => { let result; result = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), objWithContext + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -425,7 +430,7 @@ describe( 'View converter builder', () => { .toElement( 'customP' ); result = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), objWithContext + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -446,7 +451,7 @@ describe( 'View converter builder', () => { .toAttribute( 'size', 'small' ); const viewElement = new ViewContainerElement( 'p', { class: 'decorated small' }, new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); // P element and it's children got converted by the converter (1) and the converter (1) got fired // because P name was not consumed in converter (2). Converter (3) could consume class="small" because @@ -469,7 +474,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'abcd', null, new ViewText( 'foo' ) ) ] ); - const conversionResult = dispatcher.convert( viewStructure, objWithContext ); + const conversionResult = dispatcher.convert( viewStructure, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '
foo
' ); } ); @@ -488,7 +493,7 @@ describe( 'View converter builder', () => { ) ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -507,7 +512,7 @@ describe( 'View converter builder', () => { ) ); - const conversionResult = dispatcher.convert( viewElement, objWithContext ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -521,11 +526,11 @@ describe( 'View converter builder', () => { } ); const viewElement = new ViewContainerElement( 'p' ); - let conversionResult = dispatcher.convert( viewElement, objWithContext ); + let conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); viewElement.setAttribute( 'stop', true ); - conversionResult = dispatcher.convert( viewElement, objWithContext ); + conversionResult = dispatcher.convert( viewElement, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); @@ -543,11 +548,11 @@ describe( 'View converter builder', () => { } ); const viewElement = new ViewContainerElement( 'p', { 'data-type': 'foo' } ); - let conversionResult = dispatcher.convert( viewElement, objWithContext ); + let conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); viewElement.setAttribute( 'data-type', 'stop' ); - conversionResult = dispatcher.convert( viewElement, objWithContext ); + conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); } ); } ); diff --git a/tests/conversion/view-to-model-converters.js b/tests/conversion/view-to-model-converters.js index fae127644..b4f19525c 100644 --- a/tests/conversion/view-to-model-converters.js +++ b/tests/conversion/view-to-model-converters.js @@ -9,6 +9,7 @@ import ViewDocumentFragment from '../../src/view/documentfragment'; import ViewText from '../../src/view/text'; import ModelSchema from '../../src/model/schema'; +import ModelDocument from '../../src/model/document'; import ModelDocumentFragment from '../../src/model/documentfragment'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; @@ -16,13 +17,16 @@ import ModelText from '../../src/model/text'; import { convertToModelFragment, convertText } from '../../src/conversion/view-to-model-converters'; describe( 'view-to-model-converters', () => { - let dispatcher, schema, objWithContext; + let dispatcher, schema, additionalData, batch; + + const modelDocument = new ModelDocument(); beforeEach( () => { schema = new ModelSchema(); schema.registerItem( 'paragraph', '$block' ); schema.allow( { name: '$text', inside: '$root' } ); - objWithContext = { context: [ '$root' ] }; + batch = modelDocument.batch(); + additionalData = { context: [ '$root' ], batch }; dispatcher = new ViewConversionDispatcher( { schema } ); } ); @@ -32,7 +36,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, objWithContext ); + const conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -51,7 +55,7 @@ describe( 'view-to-model-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewText, objWithContext ); + const conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -64,12 +68,12 @@ describe( 'view-to-model-converters', () => { const viewText = new ViewText( 'foobar' ); dispatcher.on( 'text', convertText() ); - let conversionResult = dispatcher.convert( viewText, objWithContext ); + let conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); - conversionResult = dispatcher.convert( viewText, { context: [ '$block' ] } ); + conversionResult = dispatcher.convert( viewText, { context: [ '$block' ], batch } ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 1 ); @@ -82,7 +86,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, objWithContext ); + const conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -103,7 +107,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'element', convertToModelFragment() ); dispatcher.on( 'documentFragment', convertToModelFragment() ); - const conversionResult = dispatcher.convert( viewFragment, objWithContext ); + const conversionResult = dispatcher.convert( viewFragment, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.maxOffset ).to.equal( 6 ); @@ -128,7 +132,7 @@ describe( 'view-to-model-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewP, objWithContext ); + const conversionResult = dispatcher.convert( viewP, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelElement ); diff --git a/tests/conversion/viewconversiondispatcher.js b/tests/conversion/viewconversiondispatcher.js index a3a0dd450..1ef8728fc 100644 --- a/tests/conversion/viewconversiondispatcher.js +++ b/tests/conversion/viewconversiondispatcher.js @@ -11,6 +11,7 @@ import ViewText from '../../src/view/text'; import ModelText from '../../src/model/text'; import ModelElement from '../../src/model/element'; import ModelDocumentFragment from '../../src/model/documentfragment'; +import ModelDocument from '../../src/model/document'; import { stringify } from '../../src/dev-utils/model'; import log from '@ckeditor/ckeditor5-utils/src/log'; @@ -35,10 +36,13 @@ describe( 'ViewConversionDispatcher', () => { } ); describe( 'convert', () => { - let dispatcher; + let dispatcher, batch; + + const modelDocument = new ModelDocument(); beforeEach( () => { dispatcher = new ViewConversionDispatcher(); + batch = modelDocument.batch(); } ); it( 'should fire viewCleanup event on converted view part', () => { @@ -47,7 +51,7 @@ describe( 'ViewConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); const viewP = new ViewContainerElement( 'p' ); - dispatcher.convert( viewP ); + dispatcher.convert( viewP, { batch } ); expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true; } ); @@ -61,9 +65,9 @@ describe( 'ViewConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convert( viewText ); - dispatcher.convert( viewElement ); - dispatcher.convert( viewFragment ); + dispatcher.convert( viewText, { batch } ); + dispatcher.convert( viewElement, { batch } ); + dispatcher.convert( viewFragment, { batch } ); expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true; expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true; @@ -95,7 +99,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewText, { foo: 'bar' } ); + const conversionResult = dispatcher.convert( viewText, { foo: 'bar', batch } ); // Check conversion result. // Result should be wrapped in document fragment. @@ -130,7 +134,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewElement, { foo: 'bar' } ); + const conversionResult = dispatcher.convert( viewElement, { foo: 'bar', batch } ); // Check conversion result. // Result should be wrapped in document fragment. @@ -164,7 +168,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewFragment, { foo: 'bar' } ); + const conversionResult = dispatcher.convert( viewFragment, { foo: 'bar', batch } ); // Check conversion result. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); @@ -187,7 +191,7 @@ describe( 'ViewConversionDispatcher', () => { ] ); } ); - const conversionResult = dispatcher.convert( viewFragment ); + const conversionResult = dispatcher.convert( viewFragment, { batch } ); expect( conversionResult.markers.size ).to.equal( 2 ); expect( stringify( conversionResult, conversionResult.markers.get( 'marker1' ) ) ).to.deep.equal( 'fo[ob]ar' ); @@ -197,9 +201,13 @@ describe( 'ViewConversionDispatcher', () => { describe( 'conversionApi', () => { let spy, spyP, spyText, viewP, viewText, modelP, modelText, consumableMock, dispatcher, - spyNull, spyArray, viewDiv, viewNull, viewArray; + spyNull, spyArray, viewDiv, viewNull, viewArray, batch; + + const modelDocument = new ModelDocument(); beforeEach( () => { + batch = modelDocument.batch(); + spy = sinon.spy(); spyP = sinon.spy(); spyText = sinon.spy(); @@ -260,9 +268,10 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewP, consumableMock, data ) ).to.equal( modelP ); expect( conversionApi.convertItem( viewText, consumableMock, data ) ).to.equal( modelText ); + expect( data.batch ).to.equal( batch ); } ); - dispatcher.convert( new ViewDocumentFragment(), { foo: 'bar' } ); + dispatcher.convert( new ViewDocumentFragment(), { foo: 'bar', batch } ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -279,7 +288,7 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewNull ) ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment() ); + dispatcher.convert( new ViewDocumentFragment(), { batch } ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; @@ -297,7 +306,7 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewArray ) ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment() ); + dispatcher.convert( new ViewDocumentFragment(), { batch } ); expect( spy.calledOnce ).to.be.true; expect( spyArray.calledOnce ).to.be.true; @@ -323,7 +332,7 @@ describe( 'ViewConversionDispatcher', () => { expect( result.getChild( 1 ) ).to.equal( modelText ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), { foo: 'bar' } ); + dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), { foo: 'bar', batch } ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -344,7 +353,7 @@ describe( 'ViewConversionDispatcher', () => { expect( result.getChild( 1 ) ).to.equal( modelText ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), { foo: 'bar' } ); + dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), { foo: 'bar', batch } ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; diff --git a/tests/dev-utils/model.js b/tests/dev-utils/model.js index 322019965..c38c2d4d2 100644 --- a/tests/dev-utils/model.js +++ b/tests/dev-utils/model.js @@ -497,21 +497,21 @@ describe( 'model test utils', () => { it( 'throws when invalid XML', () => { expect( () => { - parse( '', document.schema ); + parse( '', document.schema, document.batch() ); } ).to.throw( Error, /Parse error/ ); } ); it( 'throws when try to set element not registered in schema', () => { expect( () => { - parse( '', document.schema ); + parse( '', document.schema, document.batch() ); } ).to.throw( Error, 'Element \'xyz\' not allowed in context ["$root"].' ); } ); it( 'throws when try to set text directly to $root without registering it', () => { - const doc = new Document(); + const document = new Document(); expect( () => { - parse( 'text', doc.schema ); + parse( 'text', document.schema, document.batch() ); } ).to.throw( Error, 'Element \'$text\' not allowed in context ["$root"].' ); } ); @@ -521,7 +521,7 @@ describe( 'model test utils', () => { doc.schema.allow( { name: '$text', inside: 'foo' } ); expect( () => { - parse( 'text', doc.schema, { context: [ 'foo' ] } ); + parse( 'text', doc.schema, doc.batch(), { context: [ 'foo' ] } ); } ).to.not.throw(); } ); @@ -556,7 +556,7 @@ describe( 'model test utils', () => { } ); it( 'sets selection attributes', () => { - const result = parse( 'foo[]bar', document.schema, { selectionAttributes: { + const result = parse( 'foo[]bar', document.schema, document.batch(), { selectionAttributes: { bold: true, italic: true } } ); @@ -577,7 +577,7 @@ describe( 'model test utils', () => { } ); it( 'sets selection with attribute containing an element', () => { - const result = parse( 'x[]', document.schema, { selectionAttributes: { + const result = parse( 'x[]', document.schema, document.batch(), { selectionAttributes: { bold: true } } ); @@ -586,7 +586,7 @@ describe( 'model test utils', () => { } ); it( 'sets a backward selection containing an element', () => { - const result = parse( 'x[]', document.schema, { + const result = parse( 'x[]', document.schema, document.batch(), { lastRangeBackward: true } ); @@ -599,7 +599,7 @@ describe( 'model test utils', () => { } ); it( 'sets selection within a text with different attributes', () => { - const result = parse( '<$text bold="true">fo[oba]r', document.schema, { + const result = parse( '<$text bold="true">fo[oba]r', document.schema, document.batch(), { selectionAttributes: { bold: true } } ); @@ -609,13 +609,13 @@ describe( 'model test utils', () => { it( 'throws when missing selection start', () => { expect( () => { - parse( 'foo]' ); + parse( 'foo]', document.schema, document.batch() ); } ).to.throw( Error ); } ); it( 'throws when missing selection end', () => { expect( () => { - parse( '[foo' ); + parse( '[foo', document.schema, document.batch() ); } ).to.throw( Error ); } ); } ); @@ -623,7 +623,7 @@ describe( 'model test utils', () => { function test( title, options ) { it( title, () => { const output = options.output || options.data; - const data = parse( options.data, document.schema ); + const data = parse( options.data, document.schema, document.batch() ); let model, selection; if ( data.selection && data.model ) { diff --git a/tests/model/document/document.js b/tests/model/document/document.js index b552c1c26..a698870c8 100644 --- a/tests/model/document/document.js +++ b/tests/model/document/document.js @@ -143,7 +143,7 @@ describe( 'Document', () => { expect( changeCallback.args[ 0 ][ 4 ] ).to.equal( delta.type ); } ); - it( 'should execute operation, fire event with proper data and not increase document version ' + + it( 'should execute operation, not fire event and not increase document version ' + 'when operation is not a document operation', () => { const changeCallback = sinon.spy(); const type = 't'; @@ -169,11 +169,7 @@ describe( 'Document', () => { expect( doc.history._deltas.length ).to.equal( 0 ); sinon.assert.calledOnce( operation._execute ); - sinon.assert.calledOnce( changeCallback ); - expect( changeCallback.args[ 0 ][ 1 ] ).to.equal( type ); - expect( changeCallback.args[ 0 ][ 2 ] ).to.equal( data ); - expect( changeCallback.args[ 0 ][ 3 ] ).to.deep.equal( batch ); - expect( changeCallback.args[ 0 ][ 4 ] ).to.equal( delta.type ); + sinon.assert.notCalled( changeCallback ); } ); it( 'should throw an error on the operation base version and the document version is different', () => { diff --git a/tests/model/schema/schema.js b/tests/model/schema/schema.js index d60ab29fb..9f89ca0a5 100644 --- a/tests/model/schema/schema.js +++ b/tests/model/schema/schema.js @@ -793,13 +793,6 @@ describe( 'Schema', () => { } ); it( 'should filter out disallowed attributes from given nodes', () => { - schema.removeDisallowedAttributes( [ text, image ], '$root' ); - - expect( Array.from( text.getAttributeKeys() ) ).to.deep.equal( [ 'a' ] ); - expect( Array.from( image.getAttributeKeys() ) ).to.deep.equal( [ 'b' ] ); - } ); - - it( 'should filter out disallowed attributes from given nodes (batch)', () => { const root = doc.getRoot(); const batch = doc.batch(); @@ -834,22 +827,6 @@ describe( 'Schema', () => { div = new Element( 'div', [], [ paragraph, bar, imageInDiv ] ); } ); - it( 'should filter out disallowed attributes from child nodes', () => { - schema.removeDisallowedAttributes( [ div ], '$root' ); - - expect( stringify( div ) ) - .to.equal( - '
' + - '' + - '<$text b="1">foo' + - '' + - '' + - '<$text a="1">bar' + - '' + - '
' - ); - } ); - it( 'should filter out disallowed attributes from child nodes (batch)', () => { const root = doc.getRoot(); const batch = doc.batch(); @@ -893,21 +870,21 @@ describe( 'Schema', () => { } ); it( 'should accept iterable as nodes', () => { - schema.removeDisallowedAttributes( frag.getChildren(), '$root' ); + schema.removeDisallowedAttributes( frag.getChildren(), '$root', doc.batch() ); expect( stringify( frag ) ) .to.equal( '<$text a="1">foo<$text b="1">barbiz' ); } ); it( 'should accept Position as inside', () => { - schema.removeDisallowedAttributes( frag.getChildren(), Position.createAt( root ) ); + schema.removeDisallowedAttributes( frag.getChildren(), Position.createAt( root ), doc.batch() ); expect( stringify( frag ) ) .to.equal( '<$text a="1">foo<$text b="1">barbiz' ); } ); it( 'should accept Node as inside', () => { - schema.removeDisallowedAttributes( frag.getChildren(), [ root ] ); + schema.removeDisallowedAttributes( frag.getChildren(), [ root ], doc.batch() ); expect( stringify( frag ) ) .to.equal( '<$text a="1">foo<$text b="1">barbiz' ); @@ -920,7 +897,7 @@ describe( 'Schema', () => { const image = new Element( 'image', { a: 1, b: 1 } ); - schema.removeDisallowedAttributes( [ image ], '$root' ); + schema.removeDisallowedAttributes( [ image ], '$root', doc.batch() ); expect( Array.from( image.getAttributeKeys() ) ).to.deep.equal( [ 'a', 'b' ] ); } ); diff --git a/tests/model/selection.js b/tests/model/selection.js index 5314efc26..ad7b2f399 100644 --- a/tests/model/selection.js +++ b/tests/model/selection.js @@ -894,14 +894,14 @@ describe( 'Selection', () => { } ); it( 'should return selected element', () => { - const { selection, model } = parse( '

foo

[

bar

]

baz

', schema ); + const { selection, model } = parse( '

foo

[

bar

]

baz

', schema, doc.batch() ); const p = model.getChild( 1 ); expect( selection.getSelectedElement() ).to.equal( p ); } ); it( 'should return null if there is more than one range', () => { - const { selection } = parse( '[

foo

][

bar

]

baz

', schema ); + const { selection } = parse( '[

foo

][

bar

]

baz

', schema, doc.batch() ); expect( selection.getSelectedElement() ).to.be.null; } ); @@ -911,13 +911,13 @@ describe( 'Selection', () => { } ); it( 'should return null if selection is not over single element #1', () => { - const { selection } = parse( '

foo

[

bar

baz}

', schema ); + const { selection } = parse( '

foo

[

bar

baz}

', schema, doc.batch() ); expect( selection.getSelectedElement() ).to.be.null; } ); it( 'should return null if selection is not over single element #2', () => { - const { selection } = parse( '

{bar}

', schema ); + const { selection } = parse( '

{bar}

', schema, doc.batch() ); expect( selection.getSelectedElement() ).to.be.null; } ); From b7d34becb80b80008040ea1514b0d1413dc495f6 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Mon, 27 Nov 2017 17:51:42 +0100 Subject: [PATCH 076/724] Docs for batch methods. --- src/model/batch.js | 217 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 199 insertions(+), 18 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index 17492067e..a6286dff5 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -130,18 +130,77 @@ export default class Batch { } } + /** + * Creates a new {@link module:engine/model/text~Text text node}. + * + * batch.createText( 'foo' ); + * batch.createText( 'foo', { bold: true } ); + * + * @param {String} data Text data. + * @param {Object} [attributes] Text attributes. + * @returns {module:engine/model/text~Text} Created text node. + */ createText( data, attributes ) { return new Text( data, attributes ); } + /** + * Creates a new {@link module:engine/model/element~Element element}. + * + * batch.createElement( 'paragraph' ); + * batch.createElement( 'paragraph', { 'alignment': 'center' } ); + * + * @param {String} name Name of the element. + * @param {Object} [attributes] Elements attributes. + * @returns {module:engine/model/element~Element} Created element. + */ createElement( name, attributes ) { return new Element( name, attributes ); } + /** + * Creates a new {@link module:engine/model/documentfragment~DocumentFragment document fragment}. + * + * @returns {module:engine/model/documentfragment~DocumentFragment} Created document fragment. + */ createDocumentFragment() { return new DocumentFragment(); } + /** + * Inserts item on given position. + * + * const paragraph = batch.createElement( 'paragraph' ); + * batch.insert( paragraph, position ); + * + * Instead of using position you can use parent and offset: + * + * const text = batch.createText( 'foo' ); + * batch.insert( text, paragraph, 5 ); + * + * You can also use 'end' instead of the offset to insert at the end: + * + * const text = batch.createText( 'foo' ); + * batch.insert( text, paragraph, 'end' ); + * + * Or insert before or after another element: + * + * const anotherParagraph = batch.createElement( 'paragraph' ); + * batch.insert( anotherParagraph, paragraph, 'after' ); + * + * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * + * Note that if the item already has parent it will be removed from the previous parent. + * + * If you want to move {@link module:engine/model/range~Range range} instead of an + * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move batch}. + * + * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} + * item Item or document fragment to insert. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * second parameter is a {@link module:engine/model/item~Item model item}. + */ insert( item, itemOrPosition, offset ) { const position = Position.createAt( itemOrPosition, offset ); @@ -185,6 +244,27 @@ export default class Batch { } } + /** + * Creates and inserts text on given position. You can optionally set text attributes: + * + * batch.insertText( 'foo', position ); + * batch.insertText( 'foo', { 'bold': true }, position ); + * + * Instead of using position you can use parent and offset or define that text should be inserted at the end + * or before or after other node: + * + * batch.insertText( 'foo', paragraph, 5 ); + * batch.insertText( 'foo', paragraph, 'end' ); // insets at the end of the paragraph + * batch.insertText( 'foo', image, 'after' ); // inserts after image + * + * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * + * @param {String} data Text data. + * @param {Object} [attributes] Text attributes. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * third parameter is a {@link module:engine/model/item~Item model item}. + */ insertText( text, attributes, itemOrPosition, offset ) { if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { this.insert( this.createText( text ), attributes, itemOrPosition ); @@ -193,6 +273,27 @@ export default class Batch { } } + /** + * Creates and inserts element on given position. You can optionally set attributes: + * + * batch.insertElement( 'paragraph', position ); + * batch.insertElement( 'paragraph', { 'alignment': 'center' }, position ); + * + * Instead of using position you can use parent and offset or define that text should be inserted at the end + * or before or after other node: + * + * batch.insertElement( 'paragraph', paragraph, 5 ); + * batch.insertElement( 'paragraph', blockquote, 'end' ); // insets at the end of the blockquote + * batch.insertElement( 'paragraph', image, 'after' ); // inserts after image + * + * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * + * @param {String} name Name of the element. + * @param {Object} [attributes] Elements attributes. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * third parameter is a {@link module:engine/model/item~Item model item}. + */ insertElement( name, attributes, itemOrPosition, offset ) { if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { this.insert( this.createElement( name ), attributes, itemOrPosition ); @@ -201,10 +302,35 @@ export default class Batch { } } + /** + * Inserts item at the end of the given parent. + * + * const paragraph = batch.createElement( 'paragraph' ); + * batch.append( paragraph, root ); + * + * Note that if the item already has parent it will be removed from the previous parent. + * + * If you want to move {@link module:engine/model/range~Range range} instead of an + * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move batch}. + * + * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} + * item Item or document fragment to insert. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent + */ append( item, parent ) { this.insert( item, parent, 'end' ); } + /** + * Creates text node and inserts it at the end of the parent. You can optionally set text attributes: + * + * batch.appendText( 'foo', paragraph ); + * batch.appendText( 'foo', { 'bold': true }, paragraph ); + * + * @param {String} data Text data. + * @param {Object} [attributes] Text attributes. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent + */ appendText( text, attributes, parent ) { if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { this.insert( this.createText( text ), attributes, 'end' ); @@ -213,6 +339,16 @@ export default class Batch { } } + /** + * Creates element and inserts it at the end of the parent. You can optionally set attributes: + * + * batch.appendElement( 'paragraph', root ); + * batch.appendElement( 'paragraph', { 'alignment': 'center' }, root ); + * + * @param {String} name Name of the element. + * @param {Object} [attributes] Elements attributes. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent + */ appendElement( text, attributes, parent ) { if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { this.insert( this.createElement( text ), attributes, 'end' ); @@ -238,6 +374,19 @@ export default class Batch { } } + /** + * Sets values of attributes on a {@link module:engine/model/item~Item model item} + * or on a {@link module:engine/model/range~Range range}. + * + * batch.setAttributes( range, { + * 'bold': true, + * 'italic': true + * } ); + * + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range on which the attributes will be set. + * @param {Object} attributes Attributes keys and values. + */ setAttributes( itemOrRange, attributes ) { for ( const [ key, val ] of toMap( attributes ) ) { this.setAttribute( itemOrRange, key, val ); @@ -261,6 +410,12 @@ export default class Batch { } } + /** + * Removes all attributes from all elements in the range or from the given item. + * + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range from which all attributes will be removed. + */ clearAttributes( itemOrRange ) { const removeAttributesFromItem = item => { for ( const attribute of item.getAttributeKeys() ) { @@ -277,6 +432,30 @@ export default class Batch { } } + /** + * Moves all items in the source range to the target position. + * + * batch.move( sourceRange, targetPosition ); + * + * Instead of the target position you can use parent and offset or define that range should be moved to the end + * or before or after chosen item: + * + * batch.move( sourceRange, paragraph, 5 ); // moves all items in the range to the paragraph at offset 5 + * batch.move( sourceRange, blockquote, 'end' ); // moves all items in the range at the end of the blockquote + * batch.move( sourceRange, image, 'after' ); // moves all items in the range after the image + * + * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * + * Note that items can be moved only within the same tree. It means that you can move items within the same root + * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots}, + * but you can not move items from document fragment to the document or from one detached element to another. Use + * {@link module:engine/model/batch~Batch#insert} for such cases. + * + * @param {module:engine/model/range~Range} range Source range. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * second parameter is a {@link module:engine/model/item~Item model item}. + */ move( range, itemOrPosition, offset ) { if ( !( range instanceof Range ) ) { /** @@ -707,15 +886,13 @@ function setAttributeToRange( batch, key, value, range ) { } } -/** - * Sets given attribute to the given node. When attribute value is null then attribute will be removed. - * - * @private - * @param {module:engine/model/batch~Batch} batch - * @param {String} key Attribute key. - * @param {*} value Attribute new value. - * @param {module:engine/model/item~Item} item Model item on which the attribute will be set. - */ +// Sets given attribute to the given node. When attribute value is null then attribute will be removed. +// +// @private +// @param {module:engine/model/batch~Batch} batch +// @param {String} key Attribute key. +// @param {*} value Attribute new value. +// @param {module:engine/model/item~Item} item Model item on which the attribute will be set. function setAttributeToItem( batch, key, value, item ) { const doc = batch.document; const previousValue = item.getAttribute( key ); @@ -748,15 +925,13 @@ function setAttributeToItem( batch, key, value, item ) { } } -/** - * Creates and adds marker operation to {@link module:engine/model/delta/delta~Delta delta}. - * - * @private - * @param {module:engine/model/batch~Batch} batch - * @param {String} name Marker name. - * @param {module:engine/model/range~Range} oldRange Marker range before the change. - * @param {module:engine/model/range~Range} newRange Marker range after the change. - */ +// Creates and adds marker operation to {@link module:engine/model/delta/delta~Delta delta}. +// +// @private +// @param {module:engine/model/batch~Batch} batch +// @param {String} name Marker name. +// @param {module:engine/model/range~Range} oldRange Marker range before the change. +// @param {module:engine/model/range~Range} newRange Marker range after the change. function addMarkerOperation( batch, name, oldRange, newRange ) { const doc = batch.document; const delta = new MarkerDelta(); @@ -768,6 +943,12 @@ function addMarkerOperation( batch, name, oldRange, newRange ) { doc.applyOperation( operation ); } +// Returns true if both elements are in the document or are the same element. +// +// Elements "in the same document" can be moved (you can move element form one documents root to another, or +// within the same document fragment), but when element supposed to be moved from document fragment to the document, or +// to another document it should be removed and inserted to avoid problems it OT. This is because features like undo or +// collaboration may track changes on the document and should not get unexpected move. function isTheSameDocument( rootA, rootB ) { if ( rootA === rootB ) { return true; From 0484d42d53bc78fefa629af49a5e9083c3fb715e Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Mon, 27 Nov 2017 18:02:41 +0100 Subject: [PATCH 077/724] Renamed isTheSameDocument to isSameTree. --- src/model/batch.js | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index a6286dff5..3d110d96b 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -210,7 +210,7 @@ export default class Batch { // If item has a parent already. if ( item.parent ) { // We need to check if item is going to be inserted within the same document. - if ( isTheSameDocument( item.root, position.root ) ) { + if ( isSameTree( item.root, position.root ) ) { // If it's we just need to move it. this.move( Range.createOn( item ), position ); @@ -449,7 +449,7 @@ export default class Batch { * Note that items can be moved only within the same tree. It means that you can move items within the same root * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots}, * but you can not move items from document fragment to the document or from one detached element to another. Use - * {@link module:engine/model/batch~Batch#insert} for such cases. + * {@link module:engine/model/batch~Batch#insert} in such cases. * * @param {module:engine/model/range~Range} range Source range. * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition @@ -477,7 +477,7 @@ export default class Batch { const position = Position.createAt( itemOrPosition, offset ); - if ( !isTheSameDocument( range.root, position.root ) ) { + if ( !isSameTree( range.root, position.root ) ) { /** * Range is going to be moved within not the same document. Please use * {@link module:engine/model/batch~Batch#insert insert} instead. @@ -943,13 +943,14 @@ function addMarkerOperation( batch, name, oldRange, newRange ) { doc.applyOperation( operation ); } -// Returns true if both elements are in the document or are the same element. +// Returns `true` if both root elements are the same element or both are documents root elements. // -// Elements "in the same document" can be moved (you can move element form one documents root to another, or +// Elements in the same tree can be moved (for instance you can move element form one documents root to another, or // within the same document fragment), but when element supposed to be moved from document fragment to the document, or -// to another document it should be removed and inserted to avoid problems it OT. This is because features like undo or -// collaboration may track changes on the document and should not get unexpected move. -function isTheSameDocument( rootA, rootB ) { +// to another document it should be removed and inserted to avoid problems with OT. This is because features like undo or +// collaboration may track changes on the document but ignore changes on detached fragments and should not get +// unexpected `move` operation. +function isSameTree( rootA, rootB ) { if ( rootA === rootB ) { return true; } From bdf434cd9a19e3c62bd12d85257d7c0c78cb27af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 27 Nov 2017 21:22:52 +0100 Subject: [PATCH 078/724] Changed params order in Batch#setAttributes. --- src/conversion/buildviewconverter.js | 2 +- src/model/batch.js | 53 ++++----- src/model/documentselection.js | 10 +- src/model/schema.js | 2 +- tests/conversion/modelconversiondispatcher.js | 34 +++--- tests/manual/tickets/475/1.js | 2 +- tests/model/batch.js | 110 +++++++++--------- 7 files changed, 105 insertions(+), 108 deletions(-) diff --git a/src/conversion/buildviewconverter.js b/src/conversion/buildviewconverter.js index bb4a120e9..8efc18962 100644 --- a/src/conversion/buildviewconverter.js +++ b/src/conversion/buildviewconverter.js @@ -528,7 +528,7 @@ function setAttributeOn( toChange, attribute, data, conversionApi ) { }; if ( conversionApi.schema.check( schemaQuery ) ) { - data.batch.setAttribute( toChange, attribute.key, attribute.value ); + data.batch.setAttribute( attribute.key, attribute.value, toChange ); } } diff --git a/src/model/batch.js b/src/model/batch.js index 3d110d96b..b8123a7ea 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -327,7 +327,7 @@ export default class Batch { * batch.appendText( 'foo', paragraph ); * batch.appendText( 'foo', { 'bold': true }, paragraph ); * - * @param {String} data Text data. + * @param {String} text Text data. * @param {Object} [attributes] Text attributes. * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent */ @@ -349,11 +349,11 @@ export default class Batch { * @param {Object} [attributes] Elements attributes. * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent */ - appendElement( text, attributes, parent ) { + appendElement( name, attributes, parent ) { if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { - this.insert( this.createElement( text ), attributes, 'end' ); + this.insert( this.createElement( name ), attributes, 'end' ); } else { - this.insert( this.createElement( text, attributes ), parent, 'end' ); + this.insert( this.createElement( name, attributes ), parent, 'end' ); } } @@ -361,12 +361,12 @@ export default class Batch { * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} * or on a {@link module:engine/model/range~Range range}. * - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range on which the attribute will be set. * @param {String} key Attribute key. * @param {*} value Attribute new value. + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range on which the attribute will be set. */ - setAttribute( itemOrRange, key, value ) { + setAttribute( key, value, itemOrRange ) { if ( itemOrRange instanceof Range ) { setAttributeToRange( this, key, value, itemOrRange ); } else { @@ -378,18 +378,18 @@ export default class Batch { * Sets values of attributes on a {@link module:engine/model/item~Item model item} * or on a {@link module:engine/model/range~Range range}. * - * batch.setAttributes( range, { + * batch.setAttributes( { * 'bold': true, * 'italic': true - * } ); + * }, range ); * + * @param {Object} attributes Attributes keys and values. * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange * Model item or range on which the attributes will be set. - * @param {Object} attributes Attributes keys and values. */ - setAttributes( itemOrRange, attributes ) { + setAttributes( attributes, itemOrRange ) { for ( const [ key, val ] of toMap( attributes ) ) { - this.setAttribute( itemOrRange, key, val ); + this.setAttribute( key, val, itemOrRange ); } } @@ -397,12 +397,11 @@ export default class Batch { * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} * or from a {@link module:engine/model/range~Range range}. * + * @param {String} key Attribute key. * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange * Model item or range from which the attribute will be removed. - * @method module:engine/model/batch~Batch#removeAttribute - * @param {String} key Attribute key. */ - removeAttribute( itemOrRange, key ) { + removeAttribute( key, itemOrRange ) { if ( itemOrRange instanceof Range ) { setAttributeToRange( this, key, null, itemOrRange ); } else { @@ -419,7 +418,7 @@ export default class Batch { clearAttributes( itemOrRange ) { const removeAttributesFromItem = item => { for ( const attribute of item.getAttributeKeys() ) { - this.removeAttribute( item, attribute ); + this.removeAttribute( attribute, item ); } }; @@ -819,18 +818,16 @@ export default class Batch { } } -/** - * Sets given attribute to each node in given range. When attribute value is null then attribute will be removed. - * - * Because attribute operation needs to have the same attribute value on the whole range, this function splits - * the range into smaller parts. - * - * @private - * @param {module:engine/model/batch~Batch} batch - * @param {String} key Attribute key. - * @param {*} value Attribute new value. - * @param {module:engine/model/range~Range} range Model range on which the attribute will be set. - */ +// Sets given attribute to each node in given range. When attribute value is null then attribute will be removed. +// +// Because attribute operation needs to have the same attribute value on the whole range, this function splits +// the range into smaller parts. +// +// @private +// @param {module:engine/model/batch~Batch} batch +// @param {String} key Attribute key. +// @param {*} value Attribute new value. +// @param {module:engine/model/range~Range} range Model range on which the attribute will be set. function setAttributeToRange( batch, key, value, range ) { const delta = new AttributeDelta(); const doc = batch.document; diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 8b6375a4e..2b44043da 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -543,7 +543,7 @@ export default class DocumentSelection extends Selection { _removeStoredAttribute( key ) { const storeKey = DocumentSelection._getStoreAttributeKey( key ); - this._document.batch().removeAttribute( this.anchor.parent, storeKey ); + this._document.batch().removeAttribute( storeKey, this.anchor.parent ); } /** @@ -556,7 +556,7 @@ export default class DocumentSelection extends Selection { _storeAttribute( key, value ) { const storeKey = DocumentSelection._getStoreAttributeKey( key ); - this._document.batch().setAttribute( this.anchor.parent, storeKey, value ); + this._document.batch().setAttribute( storeKey, value, this.anchor.parent ); } /** @@ -572,13 +572,13 @@ export default class DocumentSelection extends Selection { for ( const [ oldKey ] of this._getStoredAttributes() ) { const storeKey = DocumentSelection._getStoreAttributeKey( oldKey ); - batch.removeAttribute( selectionParent, storeKey ); + batch.removeAttribute( storeKey, selectionParent ); } for ( const [ key, value ] of attrs ) { const storeKey = DocumentSelection._getStoreAttributeKey( key ); - batch.setAttribute( selectionParent, storeKey, value ); + batch.setAttribute( storeKey, value, selectionParent ); } } @@ -731,7 +731,7 @@ function clearAttributesStoredInElement( changes, batch, document ) { const storedAttributes = Array.from( changeParent.getAttributeKeys() ).filter( key => key.startsWith( storePrefix ) ); for ( const key of storedAttributes ) { - batch.removeAttribute( changeParent, key ); + batch.removeAttribute( key, changeParent ); } } ); } diff --git a/src/model/schema.js b/src/model/schema.js index 1b454059a..a981620f3 100644 --- a/src/model/schema.js +++ b/src/model/schema.js @@ -432,7 +432,7 @@ export default class Schema { // TODO: this should be improved to check all combination of attributes. for ( const attribute of node.getAttributeKeys() ) { if ( !this.check( { name, attributes: attribute, inside: queryPath } ) ) { - batch.removeAttribute( node, attribute ); + batch.removeAttribute( attribute, node ); } } } diff --git a/tests/conversion/modelconversiondispatcher.js b/tests/conversion/modelconversiondispatcher.js index dac0eb408..cd3c3ba24 100644 --- a/tests/conversion/modelconversiondispatcher.js +++ b/tests/conversion/modelconversiondispatcher.js @@ -112,13 +112,13 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'addAttribute:key:$text', cbAddText ); dispatcher.on( 'addAttribute:key:image', cbAddImage ); - doc.batch().setAttribute( image, 'key', 'value' ); + doc.batch().setAttribute( 'key', 'value', image ); // Callback for adding attribute on text not called. expect( cbAddText.called ).to.be.false; expect( cbAddImage.calledOnce ).to.be.true; - doc.batch().setAttribute( ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ), 'key', 'value' ); + doc.batch().setAttribute( 'key', 'value', ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ) ); expect( cbAddText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -133,16 +133,16 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'changeAttribute:key:$text', cbChangeText ); dispatcher.on( 'changeAttribute:key:image', cbChangeImage ); - batch.setAttribute( image, 'key', 'value' ); - batch.setAttribute( image, 'key', 'newValue' ); + batch.setAttribute( 'key', 'value', image ); + batch.setAttribute( 'key', 'newValue', image ); // Callback for adding attribute on text not called. expect( cbChangeText.called ).to.be.false; expect( cbChangeImage.calledOnce ).to.be.true; const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ); - batch.setAttribute( range, 'key', 'value' ); - batch.setAttribute( range, 'key', 'newValue' ); + batch.setAttribute( 'key', 'value', range ); + batch.setAttribute( 'key', 'newValue', range ); expect( cbChangeText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -157,16 +157,16 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'removeAttribute:key:$text', cbRemoveText ); dispatcher.on( 'removeAttribute:key:image', cbRemoveImage ); - batch.setAttribute( image, 'key', 'value' ); - batch.removeAttribute( image, 'key' ); + batch.setAttribute( 'key', 'value', image ); + batch.removeAttribute( 'key', image ); // Callback for adding attribute on text not called. expect( cbRemoveText.called ).to.be.false; expect( cbRemoveImage.calledOnce ).to.be.true; const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ); - batch.setAttribute( range, 'key', 'value' ); - batch.removeAttribute( range, 'key' ); + batch.setAttribute( 'key', 'value', range ); + batch.removeAttribute( 'key', range ); expect( cbRemoveText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -187,7 +187,7 @@ describe( 'ModelConversionDispatcher', () => { const gyNode = new ModelElement( 'image' ); doc.graveyard.appendChildren( gyNode ); - doc.batch().setAttribute( gyNode, 'key', 'value' ); + doc.batch().setAttribute( 'key', 'value', gyNode ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -623,8 +623,8 @@ describe( 'ModelConversionDispatcher', () => { doc.enqueueChanges( () => { const batch = doc.batch(); - batch.setAttribute( ModelRange.createIn( root ), 'bold', true ); - batch.setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); + batch.setAttribute( 'bold', true, ModelRange.createIn( root ) ); + batch.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); dispatcher.on( 'selection', ( evt, data, consumable ) => { @@ -642,8 +642,8 @@ describe( 'ModelConversionDispatcher', () => { doc.enqueueChanges( () => { const batch = doc.batch(); - batch.setAttribute( ModelRange.createIn( root ), 'bold', true ); - batch.setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); + batch.setAttribute( 'bold', true, ModelRange.createIn( root ) ); + batch.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); dispatcher.convertSelection( doc.selection, [] ); @@ -662,8 +662,8 @@ describe( 'ModelConversionDispatcher', () => { doc.enqueueChanges( () => { const batch = doc.batch(); - batch.setAttribute( ModelRange.createIn( root ), 'bold', true ); - batch.setAttribute( ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ), 'italic', true ); + batch.setAttribute( 'bold', true, ModelRange.createIn( root ) ); + batch.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); dispatcher.convertSelection( doc.selection, [] ); diff --git a/tests/manual/tickets/475/1.js b/tests/manual/tickets/475/1.js index ecfe61995..f5c090c73 100644 --- a/tests/manual/tickets/475/1.js +++ b/tests/manual/tickets/475/1.js @@ -80,7 +80,7 @@ class AutoLinker extends Plugin { doc.enqueueChanges( () => { const urlRange = Range.createFromPositionAndShift( livePos, url.length ); - batch.setAttribute( urlRange, 'link', url ); + batch.setAttribute( 'link', url, urlRange ); } ); } } ); diff --git a/tests/model/batch.js b/tests/model/batch.js index 9fc9c49f1..34bf7968d 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -955,31 +955,31 @@ describe( 'Batch', () => { describe( 'setAttribute', () => { it( 'should create the attribute on element', () => { - batch.setAttribute( node, 'b', 2 ); + batch.setAttribute( 'b', 2, node ); expect( spy.callCount ).to.equal( 1 ); expect( node.getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should change the attribute of element', () => { - batch.setAttribute( node, 'a', 2 ); + batch.setAttribute( 'a', 2, node ); expect( spy.callCount ).to.equal( 1 ); expect( node.getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should create the attribute on text node', () => { - batch.setAttribute( text, 'b', 2 ); + batch.setAttribute( 'b', 2, text ); expect( spy.callCount ).to.equal( 1 ); expect( root.getChild( 1 ).getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should change the attribute of text node', () => { - batch.setAttribute( text, 'a', 2 ); + batch.setAttribute( 'a', 2, text ); expect( spy.callCount ).to.equal( 1 ); expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should do nothing if the attribute value is the same', () => { - batch.setAttribute( node, 'a', 1 ); + batch.setAttribute( 'a', 1, node ); expect( spy.callCount ).to.equal( 0 ); expect( node.getAttribute( 'a' ) ).to.equal( 1 ); } ); @@ -987,19 +987,19 @@ describe( 'Batch', () => { describe( 'removeAttribute', () => { it( 'should remove the attribute from element', () => { - batch.removeAttribute( node, 'a' ); + batch.removeAttribute( 'a', node ); expect( spy.callCount ).to.equal( 1 ); expect( node.getAttribute( 'a' ) ).to.be.undefined; } ); it( 'should remove the attribute from character', () => { - batch.removeAttribute( text, 'a' ); + batch.removeAttribute( 'a', text ); expect( spy.callCount ).to.equal( 1 ); expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.be.undefined; } ); it( 'should do nothing if the attribute is not set', () => { - batch.removeAttribute( node, 'b' ); + batch.removeAttribute( 'b', node ); expect( spy.callCount ).to.equal( 0 ); } ); } ); @@ -1054,42 +1054,42 @@ describe( 'Batch', () => { describe( 'setAttribute', () => { it( 'should set the attribute on the range', () => { - batch.setAttribute( getRange( 3, 6 ), 'a', 3 ); + batch.setAttribute( 'a', 3, getRange( 3, 6 ) ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 3 ); expect( getCompressedAttrs() ).to.equal( '111333111222---1112------' ); } ); it( 'should split the operations if parts of the range have different attributes', () => { - batch.setAttribute( getRange( 4, 14 ), 'a', 3 ); + batch.setAttribute( 'a', 3, getRange( 4, 14 ) ); expect( spy.callCount ).to.equal( 4 ); expect( getChangesAttrsCount() ).to.equal( 10 ); expect( getCompressedAttrs() ).to.equal( '111-3333333333-1112------' ); } ); it( 'should split the operations if parts of the part of the range have the attribute', () => { - batch.setAttribute( getRange( 4, 14 ), 'a', 2 ); + batch.setAttribute( 'a', 2, getRange( 4, 14 ) ); expect( spy.callCount ).to.equal( 3 ); expect( getChangesAttrsCount() ).to.equal( 7 ); expect( getCompressedAttrs() ).to.equal( '111-2222222222-1112------' ); } ); it( 'should strip the range if the beginning have the attribute', () => { - batch.setAttribute( getRange( 1, 5 ), 'a', 1 ); + batch.setAttribute( 'a', 1, getRange( 1, 5 ) ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '11111-111222---1112------' ); } ); it( 'should strip the range if the ending have the attribute', () => { - batch.setAttribute( getRange( 13, 17 ), 'a', 1 ); + batch.setAttribute( 'a', 1, getRange( 13, 17 ) ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '111---111222-111112------' ); } ); it( 'should do nothing if the range has attribute', () => { - batch.setAttribute( getRange( 0, 3 ), 'a', 1 ); + batch.setAttribute( 'a', 1, getRange( 0, 3 ) ); expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); @@ -1100,7 +1100,7 @@ describe( 'Batch', () => { new Position( root, [ 19 ] ) ); - batch.setAttribute( range, 'a', 1 ); + batch.setAttribute( 'a', 1, range ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112-11---' ); @@ -1112,7 +1112,7 @@ describe( 'Batch', () => { new Position( root, [ 21 ] ) ); - batch.setAttribute( range, 'a', 1 ); + batch.setAttribute( 'a', 1, range ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 4 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112-1111-' ); @@ -1124,19 +1124,19 @@ describe( 'Batch', () => { new Position( root, [ 19 ] ) ); - batch.setAttribute( range, 'a', 3 ); + batch.setAttribute( 'a', 3, range ); expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should not create an operation if is collapsed', () => { - batch.setAttribute( getRange( 3, 3 ), 'a', 1 ); + batch.setAttribute( 'a', 1, getRange( 3, 3 ) ); expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should create a proper operations for the mixed range', () => { - batch.setAttribute( getRange( 0, 20 ), 'a', 1 ); + batch.setAttribute( 'a', 1, getRange( 0, 20 ) ); expect( spy.callCount ).to.equal( 5 ); expect( getChangesAttrsCount() ).to.equal( 14 ); expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); @@ -1145,42 +1145,42 @@ describe( 'Batch', () => { describe( 'removeAttribute', () => { it( 'should remove the attribute on the range', () => { - batch.removeAttribute( getRange( 0, 2 ), 'a' ); + batch.removeAttribute( 'a', getRange( 0, 2 ) ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 2 ); expect( getCompressedAttrs() ).to.equal( '--1---111222---1112------' ); } ); it( 'should split the operations if parts of the range have different attributes', () => { - batch.removeAttribute( getRange( 7, 11 ), 'a' ); + batch.removeAttribute( 'a', getRange( 7, 11 ) ); expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 4 ); expect( getCompressedAttrs() ).to.equal( '111---1----2---1112------' ); } ); it( 'should split the operations if parts of the part of the range have no attribute', () => { - batch.removeAttribute( getRange( 1, 7 ), 'a' ); + batch.removeAttribute( 'a', getRange( 1, 7 ) ); expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 3 ); expect( getCompressedAttrs() ).to.equal( '1------11222---1112------' ); } ); it( 'should strip the range if the beginning have no attribute', () => { - batch.removeAttribute( getRange( 4, 12 ), 'a' ); + batch.removeAttribute( 'a', getRange( 4, 12 ) ); expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 6 ); expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); } ); it( 'should strip the range if the ending have no attribute', () => { - batch.removeAttribute( getRange( 7, 15 ), 'a' ); + batch.removeAttribute( 'a', getRange( 7, 15 ) ); expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 5 ); expect( getCompressedAttrs() ).to.equal( '111---1--------1112------' ); } ); it( 'should do nothing if the range has no attribute', () => { - batch.removeAttribute( getRange( 4, 5 ), 'a' ); + batch.removeAttribute( 'a', getRange( 4, 5 ) ); expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); @@ -1191,27 +1191,27 @@ describe( 'Batch', () => { new Position( root, [ 19 ] ) ); - batch.removeAttribute( range, 'a' ); + batch.removeAttribute( 'a', range ); expect( spy.callCount ).to.equal( 0 ); expect( getChangesAttrsCount() ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should not apply operation twice in the range contains opening and closing tags', () => { - batch.removeAttribute( getRange( 18, 22 ), 'a' ); + batch.removeAttribute( 'a', getRange( 18, 22 ) ); expect( spy.callCount ).to.equal( 1 ); expect( getChangesAttrsCount() ).to.equal( 1 ); expect( getCompressedAttrs() ).to.equal( '111---111222---111-------' ); } ); it( 'should not create an operation if range is collapsed', () => { - batch.removeAttribute( getRange( 3, 3 ), 'a' ); + batch.removeAttribute( 'a', getRange( 3, 3 ) ); expect( spy.callCount ).to.equal( 0 ); expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); } ); it( 'should create a proper operations for the mixed range', () => { - batch.removeAttribute( getRange( 3, 15 ), 'a' ); + batch.removeAttribute( 'a', getRange( 3, 15 ) ); expect( spy.callCount ).to.equal( 2 ); expect( getChangesAttrsCount() ).to.equal( 6 ); expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); @@ -1229,41 +1229,41 @@ describe( 'Batch', () => { describe( 'setAttribute', () => { it( 'should create the attribute on root', () => { - batch.setAttribute( root, 'b', 2 ); + batch.setAttribute( 'b', 2, root ); expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should create the attribute on detached root', () => { - batch.setAttribute( p, 'b', 2 ); + batch.setAttribute( 'b', 2, p ); expect( spy.callCount ).to.equal( 1 ); expect( p.getAttribute( 'b' ) ).to.equal( 2 ); } ); it( 'should change the attribute of root', () => { - batch.setAttribute( root, 'a', 2 ); + batch.setAttribute( 'a', 2, root ); expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should change the attribute of detached root', () => { - batch.setAttribute( p, 'a', 2 ); + batch.setAttribute( 'a', 2, p ); expect( spy.callCount ).to.equal( 1 ); expect( p.getAttribute( 'a' ) ).to.equal( 2 ); } ); it( 'should do nothing if the attribute value is the same', () => { - batch.setAttribute( root, 'a', 1 ); + batch.setAttribute( 'a', 1, root ); expect( spy.callCount ).to.equal( 1 ); - batch.setAttribute( root, 'a', 1 ); + batch.setAttribute( 'a', 1, root ); expect( spy.callCount ).to.equal( 1 ); expect( root.getAttribute( 'a' ) ).to.equal( 1 ); } ); it( 'should do nothing if the attribute value is the same on detached root', () => { - batch.setAttribute( p, 'a', 1 ); + batch.setAttribute( 'a', 1, p ); expect( spy.callCount ).to.equal( 1 ); - batch.setAttribute( p, 'a', 1 ); + batch.setAttribute( 'a', 1, p ); expect( spy.callCount ).to.equal( 1 ); expect( p.getAttribute( 'a' ) ).to.equal( 1 ); } ); @@ -1271,15 +1271,15 @@ describe( 'Batch', () => { describe( 'removeAttribute', () => { it( 'should remove the attribute from root', () => { - batch.setAttribute( root, 'a', 1 ); - batch.removeAttribute( root, 'a' ); + batch.setAttribute( 'a', 1, root ); + batch.removeAttribute( 'a', root ); expect( spy.callCount ).to.equal( 2 ); expect( root.getAttribute( 'a' ) ).to.be.undefined; } ); it( 'should do nothing if the attribute is not set', () => { - batch.removeAttribute( root, 'b' ); + batch.removeAttribute( 'b', root ); expect( spy.callCount ).to.equal( 0 ); } ); } ); @@ -1319,7 +1319,7 @@ describe( 'Batch', () => { } ); it( 'should clear attributes on root element', () => { - batch.setAttributes( root, { a: 1, b: 2, c: 3 } ); + batch.setAttributes( { a: 1, b: 2, c: 3 }, root ); expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 3 ); @@ -1345,11 +1345,11 @@ describe( 'Batch', () => { const nodeB = new Element( 'p', { b: 2 } ); root.insertChildren( 0, [ nodeA, nodeB ] ); - batch.setAttribute( nodeA, 'a', 1 ); + batch.setAttribute( 'a', 1, nodeA ); expect( batch.deltas.length ).to.equal( 0 ); - batch.removeAttribute( Range.createIn( root ), 'x' ); + batch.removeAttribute( 'x', Range.createIn( root ) ); expect( batch.deltas.length ).to.equal( 0 ); } ); @@ -1376,7 +1376,7 @@ describe( 'Batch', () => { // such a big amount of the same tests, so let's use a spy here. const spy = sinon.spy( batch, 'setAttribute' ); - batch.setAttributes( range, { a: 3, c: null } ); + batch.setAttributes( { a: 3, c: null }, range ); // Verify result. expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); @@ -1384,8 +1384,8 @@ describe( 'Batch', () => { // Verify operations sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, range, 'a', 3 ); - sinon.assert.calledWith( spy.secondCall, range, 'c', null ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, range ); + sinon.assert.calledWith( spy.secondCall, 'c', null, range ); } ); it( 'should set attributes one by one on range for map as attributes list', () => { @@ -1395,7 +1395,7 @@ describe( 'Batch', () => { // such a big amount of the same tests, so let's use a spy here. const spy = sinon.spy( batch, 'setAttribute' ); - batch.setAttributes( range, new Map( [ [ 'a', 3 ], [ 'c', null ] ] ) ); + batch.setAttributes( new Map( [ [ 'a', 3 ], [ 'c', null ] ] ), range ); // Verify result. expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); @@ -1403,8 +1403,8 @@ describe( 'Batch', () => { // Verify operations sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, range, 'a', 3 ); - sinon.assert.calledWith( spy.secondCall, range, 'c', null ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, range ); + sinon.assert.calledWith( spy.secondCall, 'c', null, range ); } ); it( 'should set attributes one by one on item', () => { @@ -1412,15 +1412,15 @@ describe( 'Batch', () => { // such a big amount of the same tests, so let's use a spy here. const spy = sinon.spy( batch, 'setAttribute' ); - batch.setAttributes( item, { a: 3, c: null } ); + batch.setAttributes( { a: 3, c: null }, item ); // Verify result. expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); // Verify operations sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, item, 'a', 3 ); - sinon.assert.calledWith( spy.secondCall, item, 'c', null ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, item ); + sinon.assert.calledWith( spy.secondCall, 'c', null, item ); } ); it( 'should set attributes one by one on item for maps as attributes list', () => { @@ -1428,15 +1428,15 @@ describe( 'Batch', () => { // such a big amount of the same tests, so let's use a spy here. const spy = sinon.spy( batch, 'setAttribute' ); - batch.setAttributes( item, new Map( [ [ 'a', 3 ], [ 'c', null ] ] ) ); + batch.setAttributes( new Map( [ [ 'a', 3 ], [ 'c', null ] ] ), item ); // Verify result. expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); // Verify operations sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, item, 'a', 3 ); - sinon.assert.calledWith( spy.secondCall, item, 'c', null ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, item ); + sinon.assert.calledWith( spy.secondCall, 'c', null, item ); } ); } ); From d29d6e9dc40a0294e399fc40fbd10448bad7df80 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Tue, 28 Nov 2017 13:33:45 +0100 Subject: [PATCH 079/724] Fixes in Docs. --- src/model/batch.js | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index b8123a7ea..a73cfce38 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -47,14 +47,14 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * * For example to create two separate undo steps you can call: * - * doc.batch().insert( firstPosition, 'foo' ); - * doc.batch().insert( secondPosition, 'bar' ); + * doc.batch().insert( 'foo', firstPosition ); + * doc.batch().insert( 'bar', secondPosition ); * * To create a single undo step: * * const batch = doc.batch(); - * batch.insert( firstPosition, 'foo' ); - * batch.insert( secondPosition, 'bar' ); + * batch.insert( 'foo', firstPosition ); + * batch.insert( 'bar', secondPosition ); * */ export default class Batch { @@ -134,7 +134,7 @@ export default class Batch { * Creates a new {@link module:engine/model/text~Text text node}. * * batch.createText( 'foo' ); - * batch.createText( 'foo', { bold: true } ); + * batch.createText( 'foo', { 'bold': true } ); * * @param {String} data Text data. * @param {Object} [attributes] Text attributes. @@ -178,22 +178,22 @@ export default class Batch { * const text = batch.createText( 'foo' ); * batch.insert( text, paragraph, 5 ); * - * You can also use 'end' instead of the offset to insert at the end: + * You can also use `end` instead of the offset to insert at the end: * * const text = batch.createText( 'foo' ); * batch.insert( text, paragraph, 'end' ); * * Or insert before or after another element: * - * const anotherParagraph = batch.createElement( 'paragraph' ); - * batch.insert( anotherParagraph, paragraph, 'after' ); + * const paragraph = batch.createElement( 'paragraph' ); + * batch.insert( paragraph, anotherParagraph, 'after' ); * - * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. * * Note that if the item already has parent it will be removed from the previous parent. * * If you want to move {@link module:engine/model/range~Range range} instead of an - * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move batch}. + * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. * * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} * item Item or document fragment to insert. @@ -253,11 +253,11 @@ export default class Batch { * Instead of using position you can use parent and offset or define that text should be inserted at the end * or before or after other node: * - * batch.insertText( 'foo', paragraph, 5 ); - * batch.insertText( 'foo', paragraph, 'end' ); // insets at the end of the paragraph + * batch.insertText( 'foo', paragraph, 5 ); // inserts in paragraph, at offset 5 + * batch.insertText( 'foo', paragraph, 'end' ); // inserts at the end of the paragraph * batch.insertText( 'foo', image, 'after' ); // inserts after image * - * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. * * @param {String} data Text data. * @param {Object} [attributes] Text attributes. @@ -282,11 +282,11 @@ export default class Batch { * Instead of using position you can use parent and offset or define that text should be inserted at the end * or before or after other node: * - * batch.insertElement( 'paragraph', paragraph, 5 ); + * batch.insertElement( 'paragraph', paragraph, 5 ); // inserts in paragraph, at offset 5 * batch.insertElement( 'paragraph', blockquote, 'end' ); // insets at the end of the blockquote * batch.insertElement( 'paragraph', image, 'after' ); // inserts after image * - * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. * * @param {String} name Name of the element. * @param {Object} [attributes] Elements attributes. @@ -311,7 +311,7 @@ export default class Batch { * Note that if the item already has parent it will be removed from the previous parent. * * If you want to move {@link module:engine/model/range~Range range} instead of an - * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move batch}. + * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. * * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} * item Item or document fragment to insert. @@ -443,7 +443,7 @@ export default class Batch { * batch.move( sourceRange, blockquote, 'end' ); // moves all items in the range at the end of the blockquote * batch.move( sourceRange, image, 'after' ); // moves all items in the range after the image * - * These parameters works the same way as {@link module:engine/model/position~Position#createAt}. + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. * * Note that items can be moved only within the same tree. It means that you can move items within the same root * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots}, @@ -614,8 +614,8 @@ export default class Batch { /** * Splits an element at the given position. * - * The element cannot be a root element, as root element cannot be split. The `batch-split-element-no-parent` error - * will be thrown if you try to split an element with no parent. + * The element needs to have a parent. It cannot be a root element nor document fragment. + * The `batch-split-element-no-parent` error will be thrown if you try to split an element with no parent. * * @param {module:engine/model/position~Position} position Position of split. */ @@ -659,6 +659,7 @@ export default class Batch { /** * Wraps given range with given element or with a new element with specified name, if string has been passed. + * * **Note:** range to wrap should be a "flat range" (see {@link module:engine/model/range~Range#isFlat}). If not, error will be thrown. * * @param {module:engine/model/range~Range} range Range to wrap. From 2df57cc28ada73bf1f5c655d7baab976d5729dcb Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Tue, 28 Nov 2017 14:16:35 +0100 Subject: [PATCH 080/724] Improve docs for isSameTree. --- src/model/batch.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/model/batch.js b/src/model/batch.js index a73cfce38..94ea16f91 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -949,9 +949,15 @@ function addMarkerOperation( batch, name, oldRange, newRange ) { // collaboration may track changes on the document but ignore changes on detached fragments and should not get // unexpected `move` operation. function isSameTree( rootA, rootB ) { + // If it is the same root this is the same tree. if ( rootA === rootB ) { return true; } - return rootA instanceof RootElement && rootB instanceof RootElement; + // If both roots are documents root it is operation within the document what we still treat as the same tree. + if ( rootA instanceof RootElement && rootB instanceof RootElement ) { + return true; + } + + return false; } From 233fa44769f14c8f4d24d71ff5e71ef49d1dadf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 28 Nov 2017 14:51:42 +0100 Subject: [PATCH 081/724] Changed the way of checking if operaton is a document operation. --- src/model/operation/attributeoperation.js | 12 ++++------ src/model/operation/detachoperation.js | 12 ++++------ src/model/operation/insertoperation.js | 12 ++++------ src/model/operation/markeroperation.js | 11 +++++++-- src/model/operation/moveoperation.js | 20 +++++++++------- src/model/operation/nooperation.js | 19 +++++++++------ src/model/operation/operation.js | 3 +++ src/model/operation/reinsertoperation.js | 24 ++++++++++++------- src/model/operation/removeoperation.js | 24 ++++++++++++------- src/model/operation/renameoperation.js | 12 ++++------ src/model/operation/rootattributeoperation.js | 12 ++++------ 11 files changed, 90 insertions(+), 71 deletions(-) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index 52dc3bff0..cb57426fb 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -73,6 +73,11 @@ export default class AttributeOperation extends Operation { * @member {*} */ this.newValue = newValue === undefined ? null : newValue; + + /** + * @inheritDoc + */ + this.isDocumentOperation = !!this.range.root.document; } /** @@ -88,13 +93,6 @@ export default class AttributeOperation extends Operation { } } - /** - * @inheritDoc - */ - get isDocumentOperation() { - return !!this.range.root.document; - } - /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/src/model/operation/detachoperation.js b/src/model/operation/detachoperation.js index c6a654a70..23110f0b9 100644 --- a/src/model/operation/detachoperation.js +++ b/src/model/operation/detachoperation.js @@ -45,6 +45,11 @@ export default class DetachOperation extends Operation { * @member {Number} #howMany */ this.howMany = howMany; + + /** + * @inheritDoc + */ + this.isDocumentOperation = false; } /** @@ -54,13 +59,6 @@ export default class DetachOperation extends Operation { return 'detach'; } - /** - * @inheritDoc - */ - get isDocumentOperation() { - return false; - } - /** * @inheritDoc */ diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index e8077e91c..7806be1ea 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -46,6 +46,11 @@ export default class InsertOperation extends Operation { * @member {module:engine/model/nodelist~NodeList} module:engine/model/operation/insertoperation~InsertOperation#nodeList */ this.nodes = new NodeList( normalizeNodes( nodes ) ); + + /** + * @inheritDoc + */ + this.isDocumentOperation = !!this.position.root.document; } /** @@ -55,13 +60,6 @@ export default class InsertOperation extends Operation { return 'insert'; } - /** - * @inheritDoc - */ - get isDocumentOperation() { - return !!this.position.root.document; - } - /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/src/model/operation/markeroperation.js b/src/model/operation/markeroperation.js index d7991d3e5..4c610ccd1 100644 --- a/src/model/operation/markeroperation.js +++ b/src/model/operation/markeroperation.js @@ -55,6 +55,11 @@ export default class MarkerOperation extends Operation { * @member {module:engine/model/markercollection~MarkerCollection} */ this._markers = markers; + + /** + * @inheritDoc + */ + this.isDocumentOperation = this._isDocumentOperation(); } /** @@ -65,9 +70,11 @@ export default class MarkerOperation extends Operation { } /** - * @inheritDoc + * Checks if operation is executed on document or document fragment nodes. + * + * @private */ - get isDocumentOperation() { + _isDocumentOperation() { if ( this.newRange ) { return !!this.newRange.root.document; } diff --git a/src/model/operation/moveoperation.js b/src/model/operation/moveoperation.js index cededd45a..1e04c81ec 100644 --- a/src/model/operation/moveoperation.js +++ b/src/model/operation/moveoperation.js @@ -64,6 +64,17 @@ export default class MoveOperation extends Operation { * @member {Boolean} module:engine/model/operation/moveoperation~MoveOperation#isSticky */ this.isSticky = false; + + /** + * Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}. + * + * Note that range cannot be moved within different documents e.g. from docFrag to document root so + * root of source and target positions is always the same. + * + * @readonly + * @member {Boolean} #isDocumentOperation + */ + this.isDocumentOperation = !!this.targetPosition.root.document; } /** @@ -73,15 +84,6 @@ export default class MoveOperation extends Operation { return 'move'; } - /** - * @inheritDoc - */ - get isDocumentOperation() { - // Note that range cannot be moved within different documents e.g. from docFrag to document root so - // root of source and target positions will be always the same. - return !!this.targetPosition.root.document; - } - /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/src/model/operation/nooperation.js b/src/model/operation/nooperation.js index a79b37544..ca238e3e0 100644 --- a/src/model/operation/nooperation.js +++ b/src/model/operation/nooperation.js @@ -20,6 +20,18 @@ import Operation from './operation'; * @extends module:engine/model/operation/operation~Operation */ export default class NoOperation extends Operation { + /** + * @inheritDoc + */ + constructor( baseVersion ) { + super( baseVersion ); + + /** + * @inheritDoc + */ + this.isDocumentOperation = true; + } + get type() { return 'noop'; } @@ -42,13 +54,6 @@ export default class NoOperation extends Operation { return new NoOperation( this.baseVersion + 1 ); } - /** - * @inheritDoc - */ - get isDocumentOperation() { - return true; - } - /** * @inheritDoc */ diff --git a/src/model/operation/operation.js b/src/model/operation/operation.js index b5aa08a71..43dc7fa79 100644 --- a/src/model/operation/operation.js +++ b/src/model/operation/operation.js @@ -97,6 +97,9 @@ export default class Operation { // Remove parent delta to avoid circular dependencies. delete json.delta; + // Only document operations are shared with other clients so it is not necessary to keep this information. + delete json.isDocumentOperation; + return json; } diff --git a/src/model/operation/reinsertoperation.js b/src/model/operation/reinsertoperation.js index edc3304dc..34ed54572 100644 --- a/src/model/operation/reinsertoperation.js +++ b/src/model/operation/reinsertoperation.js @@ -18,6 +18,21 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * and fires different change event. */ export default class ReinsertOperation extends MoveOperation { + /** + * @inheritDocs + */ + constructor( sourcePosition, howMany, targetPosition, baseVersion ) { + super( sourcePosition, howMany, targetPosition, baseVersion ); + + /** + * Reinsert operation is always executed on attached items. + * + * @readonly + * @member {Boolean} + */ + this.isDocumentOperation = true; + } + /** * Position where nodes will be re-inserted. * @@ -41,15 +56,6 @@ export default class ReinsertOperation extends MoveOperation { return 'reinsert'; } - /** - * Reinsert operation is always executed on attached items. - * - * @member {Boolean} - */ - get isDocumentOperation() { - return true; - } - /** * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}. * diff --git a/src/model/operation/removeoperation.js b/src/model/operation/removeoperation.js index 32ad7b6d2..6142d84db 100644 --- a/src/model/operation/removeoperation.js +++ b/src/model/operation/removeoperation.js @@ -16,20 +16,26 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; */ export default class RemoveOperation extends MoveOperation { /** - * @inheritDoc + * @inheritDocs */ - get type() { - return 'remove'; + constructor( sourcePosition, howMany, targetPosition, baseVersion ) { + super( sourcePosition, howMany, targetPosition, baseVersion ); + + /** + * Remove operation cannot be applied on element that is not inside the document + * so this will always be a document operation. + * + * @readonly + * @member {Boolean} + */ + this.isDocumentOperation = true; } /** - * Remove operation cannot be applied on element that is not inside the document - * so this will always be a document operation. - * - * @member {Boolean} + * @inheritDoc */ - get isDocumentOperation() { - return true; + get type() { + return 'remove'; } /** diff --git a/src/model/operation/renameoperation.js b/src/model/operation/renameoperation.js index bb39e6508..7f7334a4f 100644 --- a/src/model/operation/renameoperation.js +++ b/src/model/operation/renameoperation.js @@ -51,6 +51,11 @@ export default class RenameOperation extends Operation { * @member {String} module:engine/model/operation/renameoperation~RenameOperation#newName */ this.newName = newName; + + /** + * @inheritDoc + */ + this.isDocumentOperation = !!this.position.root.document; } /** @@ -60,13 +65,6 @@ export default class RenameOperation extends Operation { return 'rename'; } - /** - * @inheritDoc - */ - get isDocumentOperation() { - return !!this.position.root.document; - } - /** * Creates and returns an operation that has the same parameters as this operation. * diff --git a/src/model/operation/rootattributeoperation.js b/src/model/operation/rootattributeoperation.js index b29202491..606efe04e 100644 --- a/src/model/operation/rootattributeoperation.js +++ b/src/model/operation/rootattributeoperation.js @@ -67,6 +67,11 @@ export default class RootAttributeOperation extends Operation { * @member {*} */ this.newValue = newValue; + + /** + * @inheritDoc + */ + this.isDocumentOperation = !!this.root.document; } /** @@ -82,13 +87,6 @@ export default class RootAttributeOperation extends Operation { } } - /** - * @inheritDoc - */ - get isDocumentOperation() { - return !!this.root.document; - } - /** * Creates and returns an operation that has the same parameters as this operation. * From 3f2be2d2657402c64d934d2630ea6f9c9752cfff Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Tue, 28 Nov 2017 15:10:56 +0100 Subject: [PATCH 082/724] Changed way how the mocks are created in engine debug tool. --- src/dev-utils/enableenginedebug.js | 292 +++++++++++++++------------ tests/dev-utils/enableenginedebug.js | 6 +- 2 files changed, 171 insertions(+), 127 deletions(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index 24cabc8d9..62f426627 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -50,6 +50,38 @@ import Editor from '@ckeditor/ckeditor5-core/src/editor/editor'; import clone from '@ckeditor/ckeditor5-utils/src/lib/lodash/clone'; +class Sandbox { + constructor() { + this._stubs = new Set(); + } + + create( object, methodName, fakeMethod ) { + const originalMethod = object[ methodName ]; + + object[ methodName ] = fakeMethod; + + fakeMethod.restore = function restore() { + if ( originalMethod ) { + Object.defineProperty( object, methodName, originalMethod ); + } else { + delete object[ methodName ]; + } + }; + + this._stubs.add( object[ methodName ] ); + } + + restore() { + for ( const stub of this._stubs.values() ) { + stub.restore(); + } + + this._stubs.clear(); + } +} + +const sandbox = new Sandbox(); + const treeDump = Symbol( '_treeDump' ); // Maximum number of stored states of model and view document. @@ -118,60 +150,68 @@ export default function enableEngineDebug( _logger = console ) { return DebugPlugin; } +/** + * Restores all methods that have been overwritten. + */ +export function disableEngineDebug() { + sandbox.restore(); + enabled = false; +} + function enableLoggingTools() { - ModelPosition.prototype.toString = function() { + sandbox.create( ModelPosition.prototype, 'toString', function() { return `${ this.root } [ ${ this.path.join( ', ' ) } ]`; - }; + } ); - ModelPosition.prototype.log = function() { + sandbox.create( ModelPosition.prototype, 'log', function() { logger.log( 'ModelPosition: ' + this ); - }; + } ); - ModelRange.prototype.toString = function() { + sandbox.create( ModelRange.prototype, 'toString', function() { return `${ this.root } [ ${ this.start.path.join( ', ' ) } ] - [ ${ this.end.path.join( ', ' ) } ]`; - }; + } ); - ModelRange.prototype.log = function() { + sandbox.create( ModelRange.prototype, 'log', function() { logger.log( 'ModelRange: ' + this ); - }; + } ); - ModelText.prototype.toString = function() { + sandbox.create( ModelText.prototype, 'toString', function() { return `#${ this.data }`; - }; + } ); - ModelText.prototype.logExtended = function() { + sandbox.create( ModelText.prototype, 'logExtended', function() { logger.log( `ModelText: ${ this }, attrs: ${ mapString( this.getAttributes() ) }` ); - }; + } ); - ModelText.prototype.log = function() { + sandbox.create( ModelText.prototype, 'log', function() { logger.log( 'ModelText: ' + this ); - }; + } ); - ModelTextProxy.prototype.toString = function() { + sandbox.create( ModelTextProxy.prototype, 'toString', function() { return `#${ this.data }`; - }; + } ); - ModelTextProxy.prototype.logExtended = function() { + sandbox.create( ModelTextProxy.prototype, 'logExtended', function() { logger.log( `ModelTextProxy: ${ this }, attrs: ${ mapString( this.getAttributes() ) }` ); - }; + } ); - ModelTextProxy.prototype.log = function() { + sandbox.create( ModelTextProxy.prototype, 'log', function() { logger.log( 'ModelTextProxy: ' + this ); - }; + } ); - ModelElement.prototype.toString = function() { + sandbox.create( ModelElement.prototype, 'toString', function() { return `<${ this.rootName || this.name }>`; - }; + } ); - ModelElement.prototype.log = function() { + sandbox.create( ModelElement.prototype, 'log', function() { logger.log( 'ModelElement: ' + this ); - }; + } ); - ModelElement.prototype.logExtended = function() { + sandbox.create( ModelElement.prototype, 'logExtended', function() { logger.log( `ModelElement: ${ this }, ${ this.childCount } children, attrs: ${ mapString( this.getAttributes() ) }` ); - }; + } ); - ModelElement.prototype.logAll = function() { + sandbox.create( ModelElement.prototype, 'logAll', function() { logger.log( '--------------------' ); this.logExtended(); @@ -180,9 +220,9 @@ function enableLoggingTools() { for ( const child of this.getChildren() ) { child.log(); } - }; + } ); - ModelElement.prototype.printTree = function( level = 0 ) { + sandbox.create( ModelElement.prototype, 'printTree', function( level = 0 ) { let string = ''; string += '\t'.repeat( level ) + `<${ this.rootName || this.name }${ mapToTags( this.getAttributes() ) }>`; @@ -212,29 +252,29 @@ function enableLoggingTools() { string += ``; return string; - }; + } ); - ModelElement.prototype.logTree = function() { + sandbox.create( ModelElement.prototype, 'logTree', function() { logger.log( this.printTree() ); - }; + } ); - ModelRootElement.prototype.toString = function() { + sandbox.create( ModelRootElement.prototype, 'toString', function() { return this.rootName; - }; + } ); - ModelRootElement.prototype.log = function() { + sandbox.create( ModelRootElement.prototype, 'log', function() { logger.log( 'ModelRootElement: ' + this ); - }; + } ); - ModelDocumentFragment.prototype.toString = function() { + sandbox.create( ModelDocumentFragment.prototype, 'toString', function() { return 'documentFragment'; - }; + } ); - ModelDocumentFragment.prototype.log = function() { + sandbox.create( ModelDocumentFragment.prototype, 'log', function() { logger.log( 'ModelDocumentFragment: ' + this ); - }; + } ); - ModelDocumentFragment.prototype.printTree = function() { + sandbox.create( ModelDocumentFragment.prototype, 'printTree', function() { let string = 'ModelDocumentFragment: ['; for ( const child of this.getChildren() ) { @@ -258,58 +298,58 @@ function enableLoggingTools() { string += '\n]'; return string; - }; + } ); - ModelDocumentFragment.prototype.logTree = function() { + sandbox.create( ModelDocumentFragment.prototype, 'logTree', function() { logger.log( this.printTree() ); - }; + } ); - Operation.prototype.log = function() { + sandbox.create( Operation.prototype, 'log', function() { logger.log( this.toString() ); - }; + } ); - AttributeOperation.prototype.toString = function() { + sandbox.create( AttributeOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.range }`; - }; + } ); - InsertOperation.prototype.toString = function() { + sandbox.create( InsertOperation.prototype, 'toString', function() { const nodeString = this.nodes.length > 1 ? `[ ${ this.nodes.length } ]` : this.nodes.getNode( 0 ); return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ this.position }`; - }; + } ); - MarkerOperation.prototype.toString = function() { + sandbox.create( MarkerOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.name }": ${ this.oldRange } -> ${ this.newRange }`; - }; + } ); - MoveOperation.prototype.toString = function() { + sandbox.create( MoveOperation.prototype, 'toString', function() { const range = ModelRange.createFromPositionAndShift( this.sourcePosition, this.howMany ); return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ range } -> ${ this.targetPosition }${ this.isSticky ? ' (sticky)' : '' }`; - }; + } ); - NoOperation.prototype.toString = function() { + sandbox.create( NoOperation.prototype, 'toString', function() { return `NoOperation( ${ this.baseVersion } )`; - }; + } ); - RenameOperation.prototype.toString = function() { + sandbox.create( RenameOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ this.position }: "${ this.oldName }" -> "${ this.newName }"`; - }; + } ); - RootAttributeOperation.prototype.toString = function() { + sandbox.create( RootAttributeOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.root.rootName }`; - }; + } ); - Delta.prototype.log = function() { + sandbox.create( Delta.prototype, 'log', function() { logger.log( this.toString() ); - }; + } ); - Delta.prototype.logAll = function() { + sandbox.create( Delta.prototype, 'logAll', function() { logger.log( '--------------------' ); this.log(); @@ -317,9 +357,9 @@ function enableLoggingTools() { for ( const op of this.operations ) { op.log(); } - }; + } ); - Delta.prototype._saveHistory = function( itemToSave ) { + sandbox.create( Delta.prototype, '_saveHistory', function( itemToSave ) { const history = itemToSave.before.history ? itemToSave.before.history : []; itemToSave.before = clone( itemToSave.before ); @@ -331,11 +371,11 @@ function enableLoggingTools() { itemToSave.transformedBy = JSON.stringify( itemToSave.transformedBy ); this.history = history.concat( itemToSave ); - }; + } ); const _deltaTransformTransform = deltaTransform.transform; - deltaTransform.transform = function( a, b, context ) { + sandbox.create( deltaTransform, 'transform', function( a, b, context ) { let results; try { @@ -359,36 +399,36 @@ function enableLoggingTools() { } return results; - }; + } ); - AttributeDelta.prototype.toString = function() { + sandbox.create( AttributeDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.key }": -> ${ JSON.stringify( this.value ) }, ${ this.range }, ${ this.operations.length } ops`; - }; + } ); - InsertDelta.prototype.toString = function() { + sandbox.create( InsertDelta.prototype, 'toString', function() { const op = this._insertOperation; const nodeString = op.nodes.length > 1 ? `[ ${ op.nodes.length } ]` : op.nodes.getNode( 0 ); return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ op.position }`; - }; + } ); - MarkerDelta.prototype.toString = function() { + sandbox.create( MarkerDelta.prototype, 'toString', function() { const op = this.operations[ 0 ]; return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ op.name }": ${ op.oldRange } -> ${ op.newRange }`; - }; + } ); - MergeDelta.prototype.toString = function() { + sandbox.create( MergeDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + ( this.position ? this.position.toString() : `(move from ${ this.operations[ 0 ].sourcePosition })` ); - }; + } ); - MoveDelta.prototype.toString = function() { + sandbox.create( MoveDelta.prototype, 'toString', function() { const opStrings = []; for ( const op of this.operations ) { @@ -399,67 +439,67 @@ function enableLoggingTools() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + opStrings.join( '; ' ); - }; + } ); - RenameDelta.prototype.toString = function() { + sandbox.create( RenameDelta.prototype, 'toString', function() { const op = this.operations[ 0 ]; return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ op.position }: "${ op.oldName }" -> "${ op.newName }"`; - }; + } ); - RootAttributeDelta.prototype.toString = function() { + sandbox.create( RootAttributeDelta.prototype, 'toString', function() { const op = this.operations[ 0 ]; return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ op.key }": ${ JSON.stringify( op.oldValue ) } -> ${ JSON.stringify( op.newValue ) }, ${ op.root.rootName }`; - }; + } ); - SplitDelta.prototype.toString = function() { + sandbox.create( SplitDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + ( this.position ? this.position.toString() : `(clone to ${ this._cloneOperation.position || this._cloneOperation.targetPosition })` ); - }; + } ); - UnwrapDelta.prototype.toString = function() { + sandbox.create( UnwrapDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + this.position.toString(); - }; + } ); - WrapDelta.prototype.toString = function() { + sandbox.create( WrapDelta.prototype, 'toString', function() { const wrapElement = this._insertOperation.nodes.getNode( 0 ); return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ this.range } -> ${ wrapElement }`; - }; + } ); - ViewText.prototype.toString = function() { + sandbox.create( ViewText.prototype, 'toString', function() { return `#${ this.data }`; - }; + } ); - ViewText.prototype.logExtended = function() { + sandbox.create( ViewText.prototype, 'logExtended', function() { logger.log( 'ViewText: ' + this ); - }; + } ); - ViewText.prototype.log = function() { + sandbox.create( ViewText.prototype, 'log', function() { logger.log( 'ViewText: ' + this ); - }; + } ); - ViewTextProxy.prototype.toString = function() { + sandbox.create( ViewTextProxy.prototype, 'toString', function() { return `#${ this.data }`; - }; + } ); - ViewTextProxy.prototype.logExtended = function() { + sandbox.create( ViewTextProxy.prototype, 'logExtended', function() { logger.log( 'ViewTextProxy: ' + this ); - }; + } ); - ViewTextProxy.prototype.log = function() { + sandbox.create( ViewTextProxy.prototype, 'log', function() { logger.log( 'ViewTextProxy: ' + this ); - }; + } ); - ViewElement.prototype.printTree = function( level = 0 ) { + sandbox.create( ViewElement.prototype, 'printTree', function( level = 0 ) { let string = ''; string += '\t'.repeat( level ) + `<${ this.name }${ mapToTags( this.getAttributes() ) }>`; @@ -479,13 +519,13 @@ function enableLoggingTools() { string += ``; return string; - }; + } ); - ViewElement.prototype.logTree = function() { + sandbox.create( ViewElement.prototype, 'logTree', function() { logger.log( this.printTree() ); - }; + } ); - ViewDocumentFragment.prototype.printTree = function() { + sandbox.create( ViewDocumentFragment.prototype, 'printTree', function() { let string = 'ViewDocumentFragment: ['; for ( const child of this.getChildren() ) { @@ -499,17 +539,17 @@ function enableLoggingTools() { string += '\n]'; return string; - }; + } ); - ViewDocumentFragment.prototype.logTree = function() { + sandbox.create( ViewDocumentFragment.prototype, 'logTree', function() { logger.log( this.printTree() ); - }; + } ); } function enableReplayerTools() { const _modelDocumentApplyOperation = ModelDocument.prototype.applyOperation; - ModelDocument.prototype.applyOperation = function( operation ) { + sandbox.create( ModelDocument.prototype, 'applyOperation', function( operation ) { if ( !this._lastDelta ) { this._appliedDeltas = []; } else if ( this._lastDelta !== operation.delta ) { @@ -519,9 +559,9 @@ function enableReplayerTools() { this._lastDelta = operation.delta; _modelDocumentApplyOperation.call( this, operation ); - }; + } ); - ModelDocument.prototype.getAppliedDeltas = function() { + sandbox.create( ModelDocument.prototype, 'getAppliedDeltas', function() { // No deltas has been applied yet, return empty string. if ( !this._lastDelta ) { return ''; @@ -530,17 +570,17 @@ function enableReplayerTools() { const appliedDeltas = this._appliedDeltas.concat( this._lastDelta ); return appliedDeltas.map( JSON.stringify ).join( LOG_SEPARATOR ); - }; + } ); - ModelDocument.prototype.createReplayer = function( stringifiedDeltas ) { + sandbox.create( ModelDocument.prototype, 'createReplayer', function( stringifiedDeltas ) { return new DeltaReplayer( this, LOG_SEPARATOR, stringifiedDeltas ); - }; + } ); } function enableDocumentTools() { const _modelDocumentApplyOperation = ModelDocument.prototype.applyOperation; - ModelDocument.prototype.applyOperation = function( operation ) { + sandbox.create( ModelDocument.prototype, 'applyOperation', function( operation ) { logger.log( 'Applying ' + operation ); if ( !this._operationLogs ) { @@ -550,34 +590,34 @@ function enableDocumentTools() { this._operationLogs.push( JSON.stringify( operation.toJSON() ) ); _modelDocumentApplyOperation.call( this, operation ); - }; + } ); - ModelDocument.prototype.log = function( version = null ) { + sandbox.create( ModelDocument.prototype, 'log', function( version = null ) { version = version === null ? this.version : version; logDocument( this, version ); - }; + } ); - ViewDocument.prototype.log = function( version ) { + sandbox.create( ViewDocument.prototype, 'log', function( version ) { logDocument( this, version ); - }; + } ); - Editor.prototype.logModel = function( version = null ) { + sandbox.create( Editor.prototype, 'logModel', function( version = null ) { version = version === null ? this.document.version : version; this.document.log( version ); - }; + } ); - Editor.prototype.logView = function( version ) { + sandbox.create( Editor.prototype, 'logView', function( version ) { this.editing.view.log( version ); - }; + } ); - Editor.prototype.logDocuments = function( version = null ) { + sandbox.create( Editor.prototype, 'logDocuments', function( version = null ) { version = version === null ? this.document.version : version; this.logModel( version ); this.logView( version ); - }; + } ); function logDocument( document, version ) { logger.log( '--------------------' ); diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index 47ab15443..d46f91c2c 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import enableEngineDebug from '../../src/dev-utils/enableenginedebug'; +import { default as enableEngineDebug, disableEngineDebug } from '../../src/dev-utils/enableenginedebug'; import StandardEditor from '@ckeditor/ckeditor5-core/src/editor/standardeditor'; import Plugin from '@ckeditor/ckeditor5-core/src/plugin'; @@ -48,6 +48,10 @@ testUtils.createSinonSandbox(); /* global document */ +after( () => { + disableEngineDebug(); +} ); + describe( 'enableEngineDebug', () => { it( 'should return plugin class', () => { const result = enableEngineDebug(); From 84266ed5c0de09c78e8d0c7d9a39a3bcab569a2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 28 Nov 2017 15:26:55 +0100 Subject: [PATCH 083/724] Moved batch from conversion additionalData do conversionApi. --- src/controller/datacontroller.js | 2 +- src/conversion/buildviewconverter.js | 8 +-- src/conversion/view-to-model-converters.js | 2 +- src/conversion/viewconversiondispatcher.js | 19 +++--- src/dev-utils/model.js | 2 +- tests/conversion/advanced-converters.js | 36 ++++++------ tests/conversion/buildviewconverter.js | 61 ++++++++++---------- tests/conversion/view-to-model-converters.js | 16 ++--- tests/conversion/viewconversiondispatcher.js | 28 ++++----- 9 files changed, 90 insertions(+), 84 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 7443f4c17..9da0827a6 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -238,7 +238,7 @@ export default class DataController { * @returns {module:engine/model/documentfragment~DocumentFragment} Output document fragment. */ toModel( viewElementOrFragment, batch, context = '$root' ) { - return this.viewToModel.convert( viewElementOrFragment, { context: [ context ], batch } ); + return this.viewToModel.convert( viewElementOrFragment, batch, { context: [ context ] } ); } /** diff --git a/src/conversion/buildviewconverter.js b/src/conversion/buildviewconverter.js index 8efc18962..373510d1c 100644 --- a/src/conversion/buildviewconverter.js +++ b/src/conversion/buildviewconverter.js @@ -270,7 +270,7 @@ class ViewConverterBuilder { toElement( element ) { function eventCallbackGen( from ) { return ( evt, data, consumable, conversionApi ) => { - const batch = data.batch; + const batch = conversionApi.batch; // There is one callback for all patterns in the matcher. // This will be usually just one pattern but we support matchers with many patterns too. @@ -434,8 +434,8 @@ class ViewConverterBuilder { */ toMarker( creator ) { function eventCallbackGen( from ) { - return ( evt, data, consumable ) => { - const batch = data.batch; + return ( evt, data, consumable, conversionApi ) => { + const batch = conversionApi.batch; // There is one callback for all patterns in the matcher. // This will be usually just one pattern but we support matchers with many patterns too. @@ -528,7 +528,7 @@ function setAttributeOn( toChange, attribute, data, conversionApi ) { }; if ( conversionApi.schema.check( schemaQuery ) ) { - data.batch.setAttribute( attribute.key, attribute.value, toChange ); + conversionApi.batch.setAttribute( attribute.key, attribute.value, toChange ); } } diff --git a/src/conversion/view-to-model-converters.js b/src/conversion/view-to-model-converters.js index 0652c82c2..f76ea6217 100644 --- a/src/conversion/view-to-model-converters.js +++ b/src/conversion/view-to-model-converters.js @@ -48,7 +48,7 @@ export function convertText() { if ( conversionApi.schema.check( schemaQuery ) ) { if ( consumable.consume( data.input ) ) { - data.output = data.batch.createText( data.input.data ); + data.output = conversionApi.batch.createText( data.input.data ); } } }; diff --git a/src/conversion/viewconversiondispatcher.js b/src/conversion/viewconversiondispatcher.js index 32da4824f..6b1f8a101 100644 --- a/src/conversion/viewconversiondispatcher.js +++ b/src/conversion/viewconversiondispatcher.js @@ -16,7 +16,6 @@ import ModelDocumentFragment from '../model/documentfragment'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; -import extend from '@ckeditor/ckeditor5-utils/src/lib/lodash/extend'; import log from '@ckeditor/ckeditor5-utils/src/log'; /** @@ -92,7 +91,7 @@ import log from '@ckeditor/ckeditor5-utils/src/log'; * // Fire conversion. * // Always take care where the converted model structure will be appended to. If this `viewDocumentFragment` * // is going to be appended directly to a '$root' element, use that in `context`. - * viewDispatcher.convert( viewDocumentFragment, { context: [ '$root' ] } ); + * viewDispatcher.convert( viewDocumentFragment, batch, { context: [ '$root' ] } ); * * Before each conversion process, `ViewConversionDispatcher` fires {@link ~ViewConversionDispatcher#event:viewCleanup} * event which can be used to prepare tree view for conversion. @@ -117,12 +116,15 @@ export default class ViewConversionDispatcher { * * @member {module:engine/conversion/viewconversiondispatcher~ViewConversionApi} */ - this.conversionApi = extend( {}, conversionApi ); + this.conversionApi = Object.assign( {}, conversionApi ); // `convertItem` and `convertChildren` are bound to this `ViewConversionDispatcher` instance and // set on `conversionApi`. This way only a part of `ViewConversionDispatcher` API is exposed. this.conversionApi.convertItem = this._convertItem.bind( this ); this.conversionApi.convertChildren = this._convertChildren.bind( this ); + + // Batch used for conversion. Is passed to #convert method and removed at the and of the conversion. + this.conversionApi.batch = null; } /** @@ -133,15 +135,16 @@ export default class ViewConversionDispatcher { * @fires documentFragment * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element} viewItem * Part of the view to be converted. + * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {Object} additionalData Additional data to be passed in `data` argument when firing `ViewConversionDispatcher` * events. See also {@link ~ViewConversionDispatcher#event:element element event}. - * @param {module:engine/model/batch~Batch} additionalData.batch Batch to which the deltas will be added. * @returns {module:engine/model/documentfragment~DocumentFragment} Model data that is a result of the conversion process * wrapped in `DocumentFragment`. Converted marker elements will be set as that document fragment's * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}. */ - convert( viewItem, additionalData ) { - const batch = additionalData.batch; + convert( viewItem, batch, additionalData ) { + // Store batch in current conversion as conversionApi, will be removed at the end of this conversion. + this.conversionApi.batch = batch; this.fire( 'viewCleanup', viewItem ); @@ -173,7 +176,7 @@ export default class ViewConversionDispatcher { * @see module:engine/conversion/viewconversiondispatcher~ViewConversionApi#convertItem */ _convertItem( input, consumable, additionalData = {} ) { - const data = extend( {}, additionalData, { + const data = Object.assign( {}, additionalData, { input, output: null } ); @@ -209,7 +212,7 @@ export default class ViewConversionDispatcher { * @see module:engine/conversion/viewconversiondispatcher~ViewConversionApi#convertChildren */ _convertChildren( input, consumable, additionalData ) { - const batch = additionalData.batch; + const batch = this.conversionApi.batch; const documentFragment = batch.createDocumentFragment(); for ( const viewChild of Array.from( input.getChildren() ) ) { diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 2c8103f48..295160bff 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -284,7 +284,7 @@ export function parse( data, schema, batch, options = {} ) { viewToModel.on( 'text', convertToModelText() ); // Convert view to model. - let model = viewToModel.convert( viewDocumentFragment.root, { context: options.context || [ '$root' ], batch } ); + let model = viewToModel.convert( viewDocumentFragment.root, batch, { context: options.context || [ '$root' ] } ); // If root DocumentFragment contains only one element - return that element. if ( model.is( 'documentFragment' ) && model.childCount == 1 ) { diff --git a/tests/conversion/advanced-converters.js b/tests/conversion/advanced-converters.js index 9cccf90e7..c2e5659ec 100644 --- a/tests/conversion/advanced-converters.js +++ b/tests/conversion/advanced-converters.js @@ -208,8 +208,8 @@ describe( 'advanced-converters', () => { const viewFigureConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable, { batch } ); - const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable, { batch } ); + const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable, batch ); + const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable, batch ); modelImage.appendChildren( modelCaption ); @@ -232,7 +232,7 @@ describe( 'advanced-converters', () => { const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { const modelCaption = new ModelElement( 'caption' ); - const children = conversionApi.convertChildren( data.input, consumable, { batch } ); + const children = conversionApi.convertChildren( data.input, consumable, batch ); modelCaption.appendChildren( children ); @@ -287,7 +287,7 @@ describe( 'advanced-converters', () => { it( 'should convert view image to model', () => { const viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ); - const modelElement = viewDispatcher.convert( viewElement, { batch } ); + const modelElement = viewDispatcher.convert( viewElement, batch ); expect( modelToString( modelElement ) ).to.equal( '' ); } ); @@ -301,7 +301,7 @@ describe( 'advanced-converters', () => { new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) ) ] ); - const modelElement = viewDispatcher.convert( viewElement, { batch } ); + const modelElement = viewDispatcher.convert( viewElement, batch ); expect( modelToString( modelElement ) ).to.equal( '' ); } ); @@ -372,7 +372,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); + data.output = conversionApi.convertChildren( data.input, consumable, batch ); } for ( const child of data.output ) { @@ -384,7 +384,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { attribute: 'title' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); + data.output = conversionApi.convertChildren( data.input, consumable, batch ); } for ( const child of data.output ) { @@ -469,7 +469,7 @@ describe( 'advanced-converters', () => { } } - const children = conversionApi.convertChildren( data.input, consumable, { batch } ); + const children = conversionApi.convertChildren( data.input, consumable, batch ); data.output.appendChildren( children ); } } ); @@ -520,7 +520,7 @@ describe( 'advanced-converters', () => { it( 'should convert a view element to model', () => { const viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) ); - const modelText = viewDispatcher.convert( viewElement, { batch } ).getChild( 0 ); + const modelText = viewDispatcher.convert( viewElement, batch ).getChild( 0 ); expect( modelText ).to.be.instanceof( ModelText ); expect( modelText.data ).to.equal( 'foo' ); @@ -591,7 +591,7 @@ describe( 'advanced-converters', () => { ] ); - const modelElement = viewDispatcher.convert( viewElement, { batch } ); + const modelElement = viewDispatcher.convert( viewElement, batch ); expect( modelToString( modelElement ) ).to.equal( 'foo' ); } ); @@ -603,7 +603,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); + data.output = conversionApi.convertChildren( data.input, consumable, batch ); } for ( const child of data.output ) { @@ -616,7 +616,7 @@ describe( 'advanced-converters', () => { if ( consumable.consume( data.input, { name: true } ) ) { data.output = new ModelElement( 'paragraph' ); - const children = conversionApi.convertChildren( data.input, consumable, { batch } ); + const children = conversionApi.convertChildren( data.input, consumable, batch ); for ( let i = 1; i < children.childCount; i++ ) { const child = children.getChild( i ); @@ -633,13 +633,13 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:table', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); + data.output = conversionApi.convertChildren( data.input, consumable, batch ); } } ); viewDispatcher.on( 'element:td', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); + data.output = conversionApi.convertChildren( data.input, consumable, batch ); } } ); @@ -654,7 +654,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - const model = viewDispatcher.convert( viewTable, { batch } ); + const model = viewDispatcher.convert( viewTable, batch ); const modelFragment = new ModelDocumentFragment( model ); expect( modelToString( modelFragment ) ) @@ -681,7 +681,7 @@ describe( 'advanced-converters', () => { } } - data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, { batch } ) ); + data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, batch ) ); } }, { priority: 'lowest' } ); @@ -705,7 +705,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, { batch } ); + data.output = conversionApi.convertChildren( data.input, consumable, batch ); } for ( const child of data.output ) { @@ -756,7 +756,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - const modelElement = viewDispatcher.convert( viewElement, { batch } ); + const modelElement = viewDispatcher.convert( viewElement, batch ); expect( modelToString( modelElement ) ).to.equal( '
foobar
' + diff --git a/tests/conversion/buildviewconverter.js b/tests/conversion/buildviewconverter.js index 9bf2a6065..a4b90d0dd 100644 --- a/tests/conversion/buildviewconverter.js +++ b/tests/conversion/buildviewconverter.js @@ -72,7 +72,7 @@ describe( 'View converter builder', () => { batch = modelDocument.batch(); // `additionalData` parameter for `.convert` calls. - additionalData = { context: [ '$root' ], batch }; + additionalData = { context: [ '$root' ] }; schema = new ModelSchema(); @@ -100,7 +100,7 @@ describe( 'View converter builder', () => { it( 'should convert from view element to model element', () => { buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); - const conversionResult = dispatcher.convert( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), additionalData ); + const conversionResult = dispatcher.convert( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -110,7 +110,7 @@ describe( 'View converter builder', () => { .fromElement( 'img' ) .toElement( viewElement => new ModelElement( 'image', { src: viewElement.getAttribute( 'src' ) } ) ); - const conversionResult = dispatcher.convert( new ViewContainerElement( 'img', { src: 'foo.jpg' } ), additionalData ); + const conversionResult = dispatcher.convert( new ViewContainerElement( 'img', { src: 'foo.jpg' } ), batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); } ); @@ -119,7 +119,7 @@ describe( 'View converter builder', () => { buildViewConverter().for( dispatcher ).fromElement( 'strong' ).toAttribute( 'bold', true ); const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), additionalData + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData ); // Have to check root because result is a ModelText. @@ -132,7 +132,7 @@ describe( 'View converter builder', () => { .toAttribute( viewElement => ( { key: 'linkHref', value: viewElement.getAttribute( 'href' ) } ) ); const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ), additionalData + new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ), batch, additionalData ); // Have to check root because result is a ModelText. @@ -147,7 +147,7 @@ describe( 'View converter builder', () => { .toAttribute( viewElement => ( { key: 'class', value: viewElement.getAttribute( 'class' ) } ) ); const conversionResult = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); @@ -169,7 +169,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'p', { 'data-type': 'foo' }, new ViewText( 'xyz' ) ) ] ); - const conversionResult = dispatcher.convert( viewStructure, additionalData ); + const conversionResult = dispatcher.convert( viewStructure, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' + @@ -195,7 +195,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'span', { style: 'font-weight:bold; font-size:20px' }, new ViewText( 'ddd' ) ) ] ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '<$text bold="true">aaabbbcccddd' ); } ); @@ -212,7 +212,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); const markerSearch = conversionResult.markers.get( 'search' ); @@ -234,7 +234,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); const markerSearch = conversionResult.markers.get( 'search' ); @@ -260,7 +260,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); const marker1 = conversionResult.markers.get( 'marker1' ); const marker2 = conversionResult.markers.get( 'marker2' ); @@ -277,7 +277,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'span' ); - const result = dispatcher.convert( element, additionalData ); + const result = dispatcher.convert( element, batch, additionalData ); expect( result ).to.be.instanceof( ModelDocumentFragment ); expect( result.childCount ).to.equal( 0 ); @@ -289,7 +289,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { class: 'search' } ); expect( () => { - dispatcher.convert( element, additionalData ); + dispatcher.convert( element, batch, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -301,7 +301,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { 'data-name': 'search' } ); expect( () => { - dispatcher.convert( element, additionalData ); + dispatcher.convert( element, batch, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -313,7 +313,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { 'data-name': 'search' } ); expect( () => { - dispatcher.convert( element, additionalData ); + dispatcher.convert( element, batch, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -330,7 +330,7 @@ describe( 'View converter builder', () => { // Not quite megatron. result = dispatcher.convert( - new ViewContainerElement( 'span', { class: 'megatron' }, new ViewText( 'foo' ) ), additionalData + new ViewContainerElement( 'span', { class: 'megatron' }, new ViewText( 'foo' ) ), batch, additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -338,6 +338,7 @@ describe( 'View converter builder', () => { // Almost a megatron. Missing a head. result = dispatcher.convert( new ViewContainerElement( 'span', { class: 'megatron', body: 'megatron', legs: 'megatron' }, new ViewText( 'foo' ) ), + batch, additionalData ); @@ -350,6 +351,7 @@ describe( 'View converter builder', () => { { class: 'megatron', body: 'megatron', legs: 'megatron', head: 'megatron' }, new ViewText( 'foo' ) ), + batch, additionalData ); @@ -362,6 +364,7 @@ describe( 'View converter builder', () => { { class: 'megatron', body: 'megatron', legs: 'megatron', head: 'megatron' }, new ViewText( 'foo' ) ), + batch, additionalData ); @@ -382,7 +385,7 @@ describe( 'View converter builder', () => { new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -392,7 +395,7 @@ describe( 'View converter builder', () => { const viewElement = new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( conversionResult.is( 'documentFragment' ) ).to.be.true; } ); @@ -404,7 +407,7 @@ describe( 'View converter builder', () => { buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); const conversionResult = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData ); // Element converter was fired first even though attribute converter was added first. @@ -420,7 +423,7 @@ describe( 'View converter builder', () => { let result; result = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -430,7 +433,7 @@ describe( 'View converter builder', () => { .toElement( 'customP' ); result = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -451,7 +454,7 @@ describe( 'View converter builder', () => { .toAttribute( 'size', 'small' ); const viewElement = new ViewContainerElement( 'p', { class: 'decorated small' }, new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); // P element and it's children got converted by the converter (1) and the converter (1) got fired // because P name was not consumed in converter (2). Converter (3) could consume class="small" because @@ -474,7 +477,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'abcd', null, new ViewText( 'foo' ) ) ] ); - const conversionResult = dispatcher.convert( viewStructure, additionalData ); + const conversionResult = dispatcher.convert( viewStructure, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '
foo
' ); } ); @@ -493,7 +496,7 @@ describe( 'View converter builder', () => { ) ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -512,7 +515,7 @@ describe( 'View converter builder', () => { ) ); - const conversionResult = dispatcher.convert( viewElement, additionalData ); + const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -526,11 +529,11 @@ describe( 'View converter builder', () => { } ); const viewElement = new ViewContainerElement( 'p' ); - let conversionResult = dispatcher.convert( viewElement, additionalData ); + let conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); viewElement.setAttribute( 'stop', true ); - conversionResult = dispatcher.convert( viewElement, additionalData ); + conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); @@ -548,11 +551,11 @@ describe( 'View converter builder', () => { } ); const viewElement = new ViewContainerElement( 'p', { 'data-type': 'foo' } ); - let conversionResult = dispatcher.convert( viewElement, additionalData ); + let conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); viewElement.setAttribute( 'data-type', 'stop' ); - conversionResult = dispatcher.convert( viewElement, additionalData ); + conversionResult = dispatcher.convert( viewElement, batch, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); } ); } ); diff --git a/tests/conversion/view-to-model-converters.js b/tests/conversion/view-to-model-converters.js index b4f19525c..550946ee8 100644 --- a/tests/conversion/view-to-model-converters.js +++ b/tests/conversion/view-to-model-converters.js @@ -26,7 +26,7 @@ describe( 'view-to-model-converters', () => { schema.registerItem( 'paragraph', '$block' ); schema.allow( { name: '$text', inside: '$root' } ); batch = modelDocument.batch(); - additionalData = { context: [ '$root' ], batch }; + additionalData = { context: [ '$root' ] }; dispatcher = new ViewConversionDispatcher( { schema } ); } ); @@ -36,7 +36,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, additionalData ); + const conversionResult = dispatcher.convert( viewText, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -55,7 +55,7 @@ describe( 'view-to-model-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewText, additionalData ); + const conversionResult = dispatcher.convert( viewText, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -68,12 +68,12 @@ describe( 'view-to-model-converters', () => { const viewText = new ViewText( 'foobar' ); dispatcher.on( 'text', convertText() ); - let conversionResult = dispatcher.convert( viewText, additionalData ); + let conversionResult = dispatcher.convert( viewText, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); - conversionResult = dispatcher.convert( viewText, { context: [ '$block' ], batch } ); + conversionResult = dispatcher.convert( viewText, batch, { context: [ '$block' ] } ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 1 ); @@ -86,7 +86,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, additionalData ); + const conversionResult = dispatcher.convert( viewText, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -107,7 +107,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'element', convertToModelFragment() ); dispatcher.on( 'documentFragment', convertToModelFragment() ); - const conversionResult = dispatcher.convert( viewFragment, additionalData ); + const conversionResult = dispatcher.convert( viewFragment, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.maxOffset ).to.equal( 6 ); @@ -132,7 +132,7 @@ describe( 'view-to-model-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewP, additionalData ); + const conversionResult = dispatcher.convert( viewP, batch, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelElement ); diff --git a/tests/conversion/viewconversiondispatcher.js b/tests/conversion/viewconversiondispatcher.js index 1ef8728fc..7a5d8f06a 100644 --- a/tests/conversion/viewconversiondispatcher.js +++ b/tests/conversion/viewconversiondispatcher.js @@ -51,7 +51,7 @@ describe( 'ViewConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); const viewP = new ViewContainerElement( 'p' ); - dispatcher.convert( viewP, { batch } ); + dispatcher.convert( viewP, batch ); expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true; } ); @@ -65,9 +65,9 @@ describe( 'ViewConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convert( viewText, { batch } ); - dispatcher.convert( viewElement, { batch } ); - dispatcher.convert( viewFragment, { batch } ); + dispatcher.convert( viewText, batch ); + dispatcher.convert( viewElement, batch ); + dispatcher.convert( viewFragment, batch ); expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true; expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true; @@ -99,7 +99,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewText, { foo: 'bar', batch } ); + const conversionResult = dispatcher.convert( viewText, batch, { foo: 'bar' } ); // Check conversion result. // Result should be wrapped in document fragment. @@ -134,7 +134,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewElement, { foo: 'bar', batch } ); + const conversionResult = dispatcher.convert( viewElement, batch, { foo: 'bar' } ); // Check conversion result. // Result should be wrapped in document fragment. @@ -168,7 +168,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewFragment, { foo: 'bar', batch } ); + const conversionResult = dispatcher.convert( viewFragment, batch, { foo: 'bar' } ); // Check conversion result. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); @@ -191,7 +191,7 @@ describe( 'ViewConversionDispatcher', () => { ] ); } ); - const conversionResult = dispatcher.convert( viewFragment, { batch } ); + const conversionResult = dispatcher.convert( viewFragment, batch ); expect( conversionResult.markers.size ).to.equal( 2 ); expect( stringify( conversionResult, conversionResult.markers.get( 'marker1' ) ) ).to.deep.equal( 'fo[ob]ar' ); @@ -268,10 +268,10 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewP, consumableMock, data ) ).to.equal( modelP ); expect( conversionApi.convertItem( viewText, consumableMock, data ) ).to.equal( modelText ); - expect( data.batch ).to.equal( batch ); + expect( conversionApi.batch ).to.equal( batch ); } ); - dispatcher.convert( new ViewDocumentFragment(), { foo: 'bar', batch } ); + dispatcher.convert( new ViewDocumentFragment(), batch, { foo: 'bar' } ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -288,7 +288,7 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewNull ) ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment(), { batch } ); + dispatcher.convert( new ViewDocumentFragment(), batch ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; @@ -306,7 +306,7 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewArray ) ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment(), { batch } ); + dispatcher.convert( new ViewDocumentFragment(), batch ); expect( spy.calledOnce ).to.be.true; expect( spyArray.calledOnce ).to.be.true; @@ -332,7 +332,7 @@ describe( 'ViewConversionDispatcher', () => { expect( result.getChild( 1 ) ).to.equal( modelText ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), { foo: 'bar', batch } ); + dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), batch, { foo: 'bar' } ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -353,7 +353,7 @@ describe( 'ViewConversionDispatcher', () => { expect( result.getChild( 1 ) ).to.equal( modelText ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), { foo: 'bar', batch } ); + dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), batch, { foo: 'bar' } ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; From f183da5a9fabdb5a7f540aa486cb8f66ba174308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 28 Nov 2017 16:03:09 +0100 Subject: [PATCH 084/724] Simplified some code. --- src/conversion/viewconversiondispatcher.js | 6 +----- src/model/documentselection.js | 2 +- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/src/conversion/viewconversiondispatcher.js b/src/conversion/viewconversiondispatcher.js index 6b1f8a101..36ee9de70 100644 --- a/src/conversion/viewconversiondispatcher.js +++ b/src/conversion/viewconversiondispatcher.js @@ -218,12 +218,8 @@ export default class ViewConversionDispatcher { for ( const viewChild of Array.from( input.getChildren() ) ) { const modelChild = this._convertItem( viewChild, consumable, additionalData ); - if ( modelChild instanceof ModelNode ) { + if ( modelChild instanceof ModelNode || modelChild instanceof ModelDocumentFragment ) { batch.append( modelChild, documentFragment ); - } else if ( modelChild instanceof ModelDocumentFragment ) { - for ( const child of Array.from( modelChild ) ) { - batch.append( child, documentFragment ); - } } } diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 2b44043da..f213430cd 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -723,7 +723,7 @@ function clearAttributesStoredInElement( changes, batch, document ) { // `changes.range` is not set in case of rename, root and marker operations. // None of them may lead to the element becoming non-empty. - if ( !changeParent || changeParent.is( 'documentFragment' ) || changeParent.isEmpty ) { + if ( !changeParent || changeParent.isEmpty ) { return; } From 7ffe2ce318ba4c1152def7d5bbb2b34ccea821cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 28 Nov 2017 16:06:14 +0100 Subject: [PATCH 085/724] Proper cleaning after engine debugging utilities testing. --- src/dev-utils/enableenginedebug.js | 16 +++++++--------- tests/dev-utils/enableenginedebug.js | 12 ++++++++---- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index 62f426627..41b76b568 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -52,7 +52,7 @@ import clone from '@ckeditor/ckeditor5-utils/src/lib/lodash/clone'; class Sandbox { constructor() { - this._stubs = new Set(); + this._restores = []; } create( object, methodName, fakeMethod ) { @@ -60,23 +60,21 @@ class Sandbox { object[ methodName ] = fakeMethod; - fakeMethod.restore = function restore() { + this._restores.unshift( () => { if ( originalMethod ) { - Object.defineProperty( object, methodName, originalMethod ); + object[ methodName ] = originalMethod; } else { delete object[ methodName ]; } - }; - - this._stubs.add( object[ methodName ] ); + } ); } restore() { - for ( const stub of this._stubs.values() ) { - stub.restore(); + for ( const restore of this._restores ) { + restore(); } - this._stubs.clear(); + this._restores = []; } } diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index d46f91c2c..90145e421 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -48,11 +48,11 @@ testUtils.createSinonSandbox(); /* global document */ -after( () => { - disableEngineDebug(); -} ); - describe( 'enableEngineDebug', () => { + afterEach( () => { + disableEngineDebug(); + } ); + it( 'should return plugin class', () => { const result = enableEngineDebug(); @@ -86,6 +86,10 @@ describe( 'debug tools', () => { DebugPlugin = enableEngineDebug( { log, error } ); } ); + after( () => { + disableEngineDebug(); + } ); + afterEach( () => { log.reset(); } ); From df9060e76570a546e3b24172bc5ed73eafad21ab Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 29 Nov 2017 08:37:40 +0100 Subject: [PATCH 086/724] Added a test which checks "disableEngineDebug()" function. --- tests/dev-utils/enableenginedebug.js | 31 ++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index 5dd979060..322e093b5 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -4,6 +4,7 @@ */ import { default as enableEngineDebug, disableEngineDebug } from '../../src/dev-utils/enableenginedebug'; +import Editor from '@ckeditor/ckeditor5-core/src/editor/editor'; import StandardEditor from '@ckeditor/ckeditor5-core/src/editor/standardeditor'; import Plugin from '@ckeditor/ckeditor5-core/src/plugin'; @@ -43,6 +44,7 @@ import ViewContainerElement from '../../src/view/containerelement'; import ViewText from '../../src/view/text'; import ViewTextProxy from '../../src/view/textproxy'; import ViewDocumentFragment from '../../src/view/documentfragment'; +import ViewElement from '../../src/view/element'; import testUtils from '@ckeditor/ckeditor5-core/tests/_utils/utils'; @@ -70,6 +72,35 @@ describe( 'enableEngineDebug', () => { } ); } ); +describe( 'disableEngineDebug', () => { + it( 'restores modified stubs', () => { + expect( ModelPosition.prototype.log ).to.equal( undefined, 'Initial value (model/position)' ); + expect( ModelElement.prototype.printTree ).to.equal( undefined, 'Initial value (model/element)' ); + expect( Delta.prototype.log ).to.equal( undefined, 'Initial value (model/delta/delta)' ); + expect( ViewElement.prototype.printTree ).to.equal( undefined, 'Initial value (view/element)' ); + expect( ModelDocument.prototype.createReplayer ).to.equal( undefined, 'Initial value (model/document)' ); + expect( Editor.prototype.logDocuments ).to.equal( undefined, 'Initial value (core~editor/editor)' ); + + enableEngineDebug(); + + expect( ModelPosition.prototype.log ).to.be.a( 'function', 'After enabling engine debug (model/position)\'' ); + expect( ModelElement.prototype.printTree ).to.be.a( 'function', 'After enabling engine debug (model/element)' ); + expect( Delta.prototype.log ).to.be.a( 'function', 'After enabling engine debug (model/delta/delta)' ); + expect( ViewElement.prototype.printTree ).to.be.a( 'function', 'After enabling engine debug (view/element)' ); + expect( ModelDocument.prototype.createReplayer ).to.be.a( 'function', 'After enabling engine debug (model/document)' ); + expect( Editor.prototype.logDocuments ).to.be.a( 'function', 'After enabling engine debug (core~editor/editor)' ); + + disableEngineDebug(); + + expect( ModelPosition.prototype.log ).to.equal( undefined, 'After disabling engine debug (model/position)\'' ); + expect( ModelElement.prototype.printTree ).to.equal( undefined, 'After disabling engine debug (model/element)' ); + expect( Delta.prototype.log ).to.equal( undefined, 'After disabling engine debug (model/delta/delta)' ); + expect( ViewElement.prototype.printTree ).to.equal( undefined, 'After disabling engine debug (view/element)' ); + expect( ModelDocument.prototype.createReplayer ).to.equal( undefined, 'After disabling engine debug (model/document)' ); + expect( Editor.prototype.logDocuments ).to.equal( undefined, 'After disabling engine debug (core~editor/editor)' ); + } ); +} ); + describe( 'debug tools', () => { let DebugPlugin, log, error; From 52bdd8ea662a210788c20e2e6f173c534bac6754 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 29 Nov 2017 08:43:43 +0100 Subject: [PATCH 087/724] Renamed "Sandbox#create()" to "Sandbox#mock()". --- src/dev-utils/enableenginedebug.js | 130 ++++++++++++++--------------- 1 file changed, 65 insertions(+), 65 deletions(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index d599ddd7b..e9251675c 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -57,7 +57,7 @@ class Sandbox { this._restores = []; } - create( object, methodName, fakeMethod ) { + mock( object, methodName, fakeMethod ) { const originalMethod = object[ methodName ]; object[ methodName ] = fakeMethod; @@ -159,59 +159,59 @@ export function disableEngineDebug() { } function enableLoggingTools() { - sandbox.create( ModelPosition.prototype, 'toString', function() { + sandbox.mock( ModelPosition.prototype, 'toString', function() { return `${ this.root } [ ${ this.path.join( ', ' ) } ]`; } ); - sandbox.create( ModelPosition.prototype, 'log', function() { + sandbox.mock( ModelPosition.prototype, 'log', function() { logger.log( 'ModelPosition: ' + this ); } ); - sandbox.create( ModelRange.prototype, 'toString', function() { + sandbox.mock( ModelRange.prototype, 'toString', function() { return `${ this.root } [ ${ this.start.path.join( ', ' ) } ] - [ ${ this.end.path.join( ', ' ) } ]`; } ); - sandbox.create( ModelRange.prototype, 'log', function() { + sandbox.mock( ModelRange.prototype, 'log', function() { logger.log( 'ModelRange: ' + this ); } ); - sandbox.create( ModelText.prototype, 'toString', function() { + sandbox.mock( ModelText.prototype, 'toString', function() { return `#${ this.data }`; } ); - sandbox.create( ModelText.prototype, 'logExtended', function() { + sandbox.mock( ModelText.prototype, 'logExtended', function() { logger.log( `ModelText: ${ this }, attrs: ${ mapString( this.getAttributes() ) }` ); } ); - sandbox.create( ModelText.prototype, 'log', function() { + sandbox.mock( ModelText.prototype, 'log', function() { logger.log( 'ModelText: ' + this ); } ); - sandbox.create( ModelTextProxy.prototype, 'toString', function() { + sandbox.mock( ModelTextProxy.prototype, 'toString', function() { return `#${ this.data }`; } ); - sandbox.create( ModelTextProxy.prototype, 'logExtended', function() { + sandbox.mock( ModelTextProxy.prototype, 'logExtended', function() { logger.log( `ModelTextProxy: ${ this }, attrs: ${ mapString( this.getAttributes() ) }` ); } ); - sandbox.create( ModelTextProxy.prototype, 'log', function() { + sandbox.mock( ModelTextProxy.prototype, 'log', function() { logger.log( 'ModelTextProxy: ' + this ); } ); - sandbox.create( ModelElement.prototype, 'toString', function() { + sandbox.mock( ModelElement.prototype, 'toString', function() { return `<${ this.rootName || this.name }>`; } ); - sandbox.create( ModelElement.prototype, 'log', function() { + sandbox.mock( ModelElement.prototype, 'log', function() { logger.log( 'ModelElement: ' + this ); } ); - sandbox.create( ModelElement.prototype, 'logExtended', function() { + sandbox.mock( ModelElement.prototype, 'logExtended', function() { logger.log( `ModelElement: ${ this }, ${ this.childCount } children, attrs: ${ mapString( this.getAttributes() ) }` ); } ); - sandbox.create( ModelElement.prototype, 'logAll', function() { + sandbox.mock( ModelElement.prototype, 'logAll', function() { logger.log( '--------------------' ); this.logExtended(); @@ -222,7 +222,7 @@ function enableLoggingTools() { } } ); - sandbox.create( ModelElement.prototype, 'printTree', function( level = 0 ) { + sandbox.mock( ModelElement.prototype, 'printTree', function( level = 0 ) { let string = ''; string += '\t'.repeat( level ) + `<${ this.rootName || this.name }${ mapToTags( this.getAttributes() ) }>`; @@ -254,27 +254,27 @@ function enableLoggingTools() { return string; } ); - sandbox.create( ModelElement.prototype, 'logTree', function() { + sandbox.mock( ModelElement.prototype, 'logTree', function() { logger.log( this.printTree() ); } ); - sandbox.create( ModelRootElement.prototype, 'toString', function() { + sandbox.mock( ModelRootElement.prototype, 'toString', function() { return this.rootName; } ); - sandbox.create( ModelRootElement.prototype, 'log', function() { + sandbox.mock( ModelRootElement.prototype, 'log', function() { logger.log( 'ModelRootElement: ' + this ); } ); - sandbox.create( ModelDocumentFragment.prototype, 'toString', function() { + sandbox.mock( ModelDocumentFragment.prototype, 'toString', function() { return 'documentFragment'; } ); - sandbox.create( ModelDocumentFragment.prototype, 'log', function() { + sandbox.mock( ModelDocumentFragment.prototype, 'log', function() { logger.log( 'ModelDocumentFragment: ' + this ); } ); - sandbox.create( ModelDocumentFragment.prototype, 'printTree', function() { + sandbox.mock( ModelDocumentFragment.prototype, 'printTree', function() { let string = 'ModelDocumentFragment: ['; for ( const child of this.getChildren() ) { @@ -300,20 +300,20 @@ function enableLoggingTools() { return string; } ); - sandbox.create( ModelDocumentFragment.prototype, 'logTree', function() { + sandbox.mock( ModelDocumentFragment.prototype, 'logTree', function() { logger.log( this.printTree() ); } ); - sandbox.create( Operation.prototype, 'log', function() { + sandbox.mock( Operation.prototype, 'log', function() { logger.log( this.toString() ); } ); - sandbox.create( AttributeOperation.prototype, 'toString', function() { + sandbox.mock( AttributeOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.range }`; } ); - sandbox.create( DetachOperation.prototype, 'toString', function() { + sandbox.mock( DetachOperation.prototype, 'toString', function() { const range = ModelRange.createFromPositionAndShift( this.sourcePosition, this.howMany ); const nodes = Array.from( range.getItems() ); const nodeString = nodes.length > 1 ? `[ ${ nodes.length } ]` : nodes[ 0 ]; @@ -321,43 +321,43 @@ function enableLoggingTools() { return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ range }`; } ); - sandbox.create( InsertOperation.prototype, 'toString', function() { + sandbox.mock( InsertOperation.prototype, 'toString', function() { const nodeString = this.nodes.length > 1 ? `[ ${ this.nodes.length } ]` : this.nodes.getNode( 0 ); return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ this.position }`; } ); - sandbox.create( MarkerOperation.prototype, 'toString', function() { + sandbox.mock( MarkerOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.name }": ${ this.oldRange } -> ${ this.newRange }`; } ); - sandbox.create( MoveOperation.prototype, 'toString', function() { + sandbox.mock( MoveOperation.prototype, 'toString', function() { const range = ModelRange.createFromPositionAndShift( this.sourcePosition, this.howMany ); return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ range } -> ${ this.targetPosition }${ this.isSticky ? ' (sticky)' : '' }`; } ); - sandbox.create( NoOperation.prototype, 'toString', function() { + sandbox.mock( NoOperation.prototype, 'toString', function() { return `NoOperation( ${ this.baseVersion } )`; } ); - sandbox.create( RenameOperation.prototype, 'toString', function() { + sandbox.mock( RenameOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ this.position }: "${ this.oldName }" -> "${ this.newName }"`; } ); - sandbox.create( RootAttributeOperation.prototype, 'toString', function() { + sandbox.mock( RootAttributeOperation.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.key }": ${ JSON.stringify( this.oldValue ) } -> ${ JSON.stringify( this.newValue ) }, ${ this.root.rootName }`; } ); - sandbox.create( Delta.prototype, 'log', function() { + sandbox.mock( Delta.prototype, 'log', function() { logger.log( this.toString() ); } ); - sandbox.create( Delta.prototype, 'logAll', function() { + sandbox.mock( Delta.prototype, 'logAll', function() { logger.log( '--------------------' ); this.log(); @@ -367,7 +367,7 @@ function enableLoggingTools() { } } ); - sandbox.create( Delta.prototype, '_saveHistory', function( itemToSave ) { + sandbox.mock( Delta.prototype, '_saveHistory', function( itemToSave ) { const history = itemToSave.before.history ? itemToSave.before.history : []; itemToSave.before = clone( itemToSave.before ); @@ -383,7 +383,7 @@ function enableLoggingTools() { const _deltaTransformTransform = deltaTransform.transform; - sandbox.create( deltaTransform, 'transform', function( a, b, context ) { + sandbox.mock( deltaTransform, 'transform', function( a, b, context ) { let results; try { @@ -409,26 +409,26 @@ function enableLoggingTools() { return results; } ); - sandbox.create( AttributeDelta.prototype, 'toString', function() { + sandbox.mock( AttributeDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ this.key }": -> ${ JSON.stringify( this.value ) }, ${ this.range }, ${ this.operations.length } ops`; } ); - sandbox.create( InsertDelta.prototype, 'toString', function() { + sandbox.mock( InsertDelta.prototype, 'toString', function() { const op = this._insertOperation; const nodeString = op.nodes.length > 1 ? `[ ${ op.nodes.length } ]` : op.nodes.getNode( 0 ); return getClassName( this ) + `( ${ this.baseVersion } ): ${ nodeString } -> ${ op.position }`; } ); - sandbox.create( MarkerDelta.prototype, 'toString', function() { + sandbox.mock( MarkerDelta.prototype, 'toString', function() { const op = this.operations[ 0 ]; return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ op.name }": ${ op.oldRange } -> ${ op.newRange }`; } ); - sandbox.create( MergeDelta.prototype, 'toString', function() { + sandbox.mock( MergeDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + ( this.position ? this.position.toString() : @@ -436,7 +436,7 @@ function enableLoggingTools() { ); } ); - sandbox.create( MoveDelta.prototype, 'toString', function() { + sandbox.mock( MoveDelta.prototype, 'toString', function() { const opStrings = []; for ( const op of this.operations ) { @@ -449,21 +449,21 @@ function enableLoggingTools() { opStrings.join( '; ' ); } ); - sandbox.create( RenameDelta.prototype, 'toString', function() { + sandbox.mock( RenameDelta.prototype, 'toString', function() { const op = this.operations[ 0 ]; return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ op.position }: "${ op.oldName }" -> "${ op.newName }"`; } ); - sandbox.create( RootAttributeDelta.prototype, 'toString', function() { + sandbox.mock( RootAttributeDelta.prototype, 'toString', function() { const op = this.operations[ 0 ]; return getClassName( this ) + `( ${ this.baseVersion } ): ` + `"${ op.key }": ${ JSON.stringify( op.oldValue ) } -> ${ JSON.stringify( op.newValue ) }, ${ op.root.rootName }`; } ); - sandbox.create( SplitDelta.prototype, 'toString', function() { + sandbox.mock( SplitDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + ( this.position ? this.position.toString() : @@ -471,43 +471,43 @@ function enableLoggingTools() { ); } ); - sandbox.create( UnwrapDelta.prototype, 'toString', function() { + sandbox.mock( UnwrapDelta.prototype, 'toString', function() { return getClassName( this ) + `( ${ this.baseVersion } ): ` + this.position.toString(); } ); - sandbox.create( WrapDelta.prototype, 'toString', function() { + sandbox.mock( WrapDelta.prototype, 'toString', function() { const wrapElement = this._insertOperation.nodes.getNode( 0 ); return getClassName( this ) + `( ${ this.baseVersion } ): ` + `${ this.range } -> ${ wrapElement }`; } ); - sandbox.create( ViewText.prototype, 'toString', function() { + sandbox.mock( ViewText.prototype, 'toString', function() { return `#${ this.data }`; } ); - sandbox.create( ViewText.prototype, 'logExtended', function() { + sandbox.mock( ViewText.prototype, 'logExtended', function() { logger.log( 'ViewText: ' + this ); } ); - sandbox.create( ViewText.prototype, 'log', function() { + sandbox.mock( ViewText.prototype, 'log', function() { logger.log( 'ViewText: ' + this ); } ); - sandbox.create( ViewTextProxy.prototype, 'toString', function() { + sandbox.mock( ViewTextProxy.prototype, 'toString', function() { return `#${ this.data }`; } ); - sandbox.create( ViewTextProxy.prototype, 'logExtended', function() { + sandbox.mock( ViewTextProxy.prototype, 'logExtended', function() { logger.log( 'ViewTextProxy: ' + this ); } ); - sandbox.create( ViewTextProxy.prototype, 'log', function() { + sandbox.mock( ViewTextProxy.prototype, 'log', function() { logger.log( 'ViewTextProxy: ' + this ); } ); - sandbox.create( ViewElement.prototype, 'printTree', function( level = 0 ) { + sandbox.mock( ViewElement.prototype, 'printTree', function( level = 0 ) { let string = ''; string += '\t'.repeat( level ) + `<${ this.name }${ mapToTags( this.getAttributes() ) }>`; @@ -529,11 +529,11 @@ function enableLoggingTools() { return string; } ); - sandbox.create( ViewElement.prototype, 'logTree', function() { + sandbox.mock( ViewElement.prototype, 'logTree', function() { logger.log( this.printTree() ); } ); - sandbox.create( ViewDocumentFragment.prototype, 'printTree', function() { + sandbox.mock( ViewDocumentFragment.prototype, 'printTree', function() { let string = 'ViewDocumentFragment: ['; for ( const child of this.getChildren() ) { @@ -549,7 +549,7 @@ function enableLoggingTools() { return string; } ); - sandbox.create( ViewDocumentFragment.prototype, 'logTree', function() { + sandbox.mock( ViewDocumentFragment.prototype, 'logTree', function() { logger.log( this.printTree() ); } ); } @@ -557,7 +557,7 @@ function enableLoggingTools() { function enableReplayerTools() { const _modelDocumentApplyOperation = ModelDocument.prototype.applyOperation; - sandbox.create( ModelDocument.prototype, 'applyOperation', function( operation ) { + sandbox.mock( ModelDocument.prototype, 'applyOperation', function( operation ) { if ( !this._lastDelta ) { this._appliedDeltas = []; } else if ( this._lastDelta !== operation.delta ) { @@ -569,7 +569,7 @@ function enableReplayerTools() { _modelDocumentApplyOperation.call( this, operation ); } ); - sandbox.create( ModelDocument.prototype, 'getAppliedDeltas', function() { + sandbox.mock( ModelDocument.prototype, 'getAppliedDeltas', function() { // No deltas has been applied yet, return empty string. if ( !this._lastDelta ) { return ''; @@ -580,7 +580,7 @@ function enableReplayerTools() { return appliedDeltas.map( JSON.stringify ).join( LOG_SEPARATOR ); } ); - sandbox.create( ModelDocument.prototype, 'createReplayer', function( stringifiedDeltas ) { + sandbox.mock( ModelDocument.prototype, 'createReplayer', function( stringifiedDeltas ) { return new DeltaReplayer( this, LOG_SEPARATOR, stringifiedDeltas ); } ); } @@ -588,7 +588,7 @@ function enableReplayerTools() { function enableDocumentTools() { const _modelDocumentApplyOperation = ModelDocument.prototype.applyOperation; - sandbox.create( ModelDocument.prototype, 'applyOperation', function( operation ) { + sandbox.mock( ModelDocument.prototype, 'applyOperation', function( operation ) { logger.log( 'Applying ' + operation ); if ( !this._operationLogs ) { @@ -600,27 +600,27 @@ function enableDocumentTools() { _modelDocumentApplyOperation.call( this, operation ); } ); - sandbox.create( ModelDocument.prototype, 'log', function( version = null ) { + sandbox.mock( ModelDocument.prototype, 'log', function( version = null ) { version = version === null ? this.version : version; logDocument( this, version ); } ); - sandbox.create( ViewDocument.prototype, 'log', function( version ) { + sandbox.mock( ViewDocument.prototype, 'log', function( version ) { logDocument( this, version ); } ); - sandbox.create( Editor.prototype, 'logModel', function( version = null ) { + sandbox.mock( Editor.prototype, 'logModel', function( version = null ) { version = version === null ? this.document.version : version; this.document.log( version ); } ); - sandbox.create( Editor.prototype, 'logView', function( version ) { + sandbox.mock( Editor.prototype, 'logView', function( version ) { this.editing.view.log( version ); } ); - sandbox.create( Editor.prototype, 'logDocuments', function( version = null ) { + sandbox.mock( Editor.prototype, 'logDocuments', function( version = null ) { version = version === null ? this.document.version : version; this.logModel( version ); From 102b9f4f19820a1a9d398344c50ebc70b8718ef8 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 29 Nov 2017 08:50:04 +0100 Subject: [PATCH 088/724] Added docs to Sandbox class. [skip ci] --- src/dev-utils/enableenginedebug.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index e9251675c..4d593cb64 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -52,11 +52,20 @@ import Editor from '@ckeditor/ckeditor5-core/src/editor/editor'; import clone from '@ckeditor/ckeditor5-utils/src/lib/lodash/clone'; +// Sandbox class allows creating mocks of the functions and restoring these mocks to the original values. class Sandbox { constructor() { + // An array that contains functions which restore the original values of mocked objects. + // @private + // @type {Array.} this._restores = []; } + // Creates a new mock. + // + // @param {Object} object Object to mock. + // @param {String} methodName Function to mock. + // @param {Function} fakeMethod Function that will be executed. mock( object, methodName, fakeMethod ) { const originalMethod = object[ methodName ]; @@ -71,6 +80,7 @@ class Sandbox { } ); } + // Restores all mocked functions. restore() { for ( const restore of this._restores ) { restore(); From 15aabe9f30cbabcaeaacc78f30c239a0b37b4b76 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 29 Nov 2017 08:53:12 +0100 Subject: [PATCH 089/724] Removed unnecessary apostrophe. --- tests/dev-utils/enableenginedebug.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index 322e093b5..a1a1c11bc 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -83,7 +83,7 @@ describe( 'disableEngineDebug', () => { enableEngineDebug(); - expect( ModelPosition.prototype.log ).to.be.a( 'function', 'After enabling engine debug (model/position)\'' ); + expect( ModelPosition.prototype.log ).to.be.a( 'function', 'After enabling engine debug (model/position)' ); expect( ModelElement.prototype.printTree ).to.be.a( 'function', 'After enabling engine debug (model/element)' ); expect( Delta.prototype.log ).to.be.a( 'function', 'After enabling engine debug (model/delta/delta)' ); expect( ViewElement.prototype.printTree ).to.be.a( 'function', 'After enabling engine debug (view/element)' ); @@ -92,7 +92,7 @@ describe( 'disableEngineDebug', () => { disableEngineDebug(); - expect( ModelPosition.prototype.log ).to.equal( undefined, 'After disabling engine debug (model/position)\'' ); + expect( ModelPosition.prototype.log ).to.equal( undefined, 'After disabling engine debug (model/position)' ); expect( ModelElement.prototype.printTree ).to.equal( undefined, 'After disabling engine debug (model/element)' ); expect( Delta.prototype.log ).to.equal( undefined, 'After disabling engine debug (model/delta/delta)' ); expect( ViewElement.prototype.printTree ).to.equal( undefined, 'After disabling engine debug (view/element)' ); From b70c5c3650faa0217def1c21e4fc5c909c82527f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 09:08:49 +0100 Subject: [PATCH 090/724] Replaced writer by bath in getSelectedContent. --- src/controller/datacontroller.js | 5 +- src/controller/getselectedcontent.js | 22 ++++----- tests/controller/datacontroller.js | 4 +- tests/controller/getselectedcontent.js | 68 +++++++++++++------------- 4 files changed, 49 insertions(+), 50 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 9da0827a6..45d3a8c9c 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -295,10 +295,11 @@ export default class DataController { * * @fires module:engine/controller/datacontroller~DataController#getSelectedContent * @param {module:engine/model/selection~Selection} selection The selection of which content will be retrieved. + * @param {module:engine/model/batch~Batch} batch Batch to which deltas will be added. * @returns {module:engine/model/documentfragment~DocumentFragment} Document fragment holding the clone of the selected content. */ - getSelectedContent( selection ) { - return getSelectedContent( selection ); + getSelectedContent( selection, batch ) { + return getSelectedContent( selection, batch ); } /** diff --git a/src/controller/getselectedcontent.js b/src/controller/getselectedcontent.js index 6e3fefa67..16e98bb27 100644 --- a/src/controller/getselectedcontent.js +++ b/src/controller/getselectedcontent.js @@ -7,11 +7,8 @@ * @module engine/controller/getselectedcontent */ -import DocumentFragment from '../model/documentfragment'; import Range from '../model/range'; import Position from '../model/position'; -import Text from '../model/text'; -import { remove } from '../model/writer'; /** * Gets a clone of the selected content. @@ -25,10 +22,11 @@ import { remove } from '../model/writer'; * st

se

* * @param {module:engine/model/selection~Selection} selection The selection of which content will be returned. + * @param {module:engine/model/batch~Batch} batch Batch to which deltas will be added. * @returns {module:engine/model/documentfragment~DocumentFragment} */ -export default function getSelectedContent( selection ) { - const frag = new DocumentFragment(); +export default function getSelectedContent( selection, batch ) { + const frag = batch.createDocumentFragment(); const range = selection.getFirstRange(); if ( !range || range.isCollapsed ) { @@ -69,9 +67,9 @@ export default function getSelectedContent( selection ) { // Clone the whole contents. for ( const item of flatSubtreeRange.getItems( { shallow: true } ) ) { if ( item.is( 'textProxy' ) ) { - frag.appendChildren( new Text( item.data, item.getAttributes() ) ); + batch.appendText( item.data, item.getAttributes(), frag ); } else { - frag.appendChildren( item.clone( true ) ); + batch.append( item.clone( true ), frag ); } } @@ -97,8 +95,8 @@ export default function getSelectedContent( selection ) { const leftExcessRange = new Range( Position.createAt( frag ), newRange.start ); const rightExcessRange = new Range( newRange.end, Position.createAt( frag, 'end' ) ); - removeRangeContent( rightExcessRange ); - removeRangeContent( leftExcessRange ); + removeRangeContent( rightExcessRange, batch ); + removeRangeContent( leftExcessRange, batch ); } return frag; @@ -106,7 +104,7 @@ export default function getSelectedContent( selection ) { // After https://github.com/ckeditor/ckeditor5-engine/issues/690 is fixed, // this function will, most likely, be able to rewritten using getMinimalFlatRanges(). -function removeRangeContent( range ) { +function removeRangeContent( range, batch ) { const parentsToCheck = []; Array.from( range.getItems( { direction: 'backward' } ) ) @@ -128,7 +126,7 @@ function removeRangeContent( range ) { .forEach( itemRange => { parentsToCheck.push( itemRange.start.parent ); - remove( itemRange ); + batch.remove( itemRange ); } ); // Remove ancestors of the removed items if they turned to be empty now @@ -141,7 +139,7 @@ function removeRangeContent( range ) { parent = parent.parent; - remove( removeRange ); + batch.remove( removeRange ); } } ); } diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index f20861294..e15efaf24 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -433,7 +433,7 @@ describe( 'DataController', () => { data.on( 'getSelectedContent', spy ); - data.getSelectedContent( sel ); + data.getSelectedContent( sel, modelDocument.batch() ); expect( spy.calledOnce ).to.be.true; } ); @@ -443,7 +443,7 @@ describe( 'DataController', () => { setData( modelDocument, 'fo[ob]ar' ); - const content = data.getSelectedContent( modelDocument.selection ); + const content = data.getSelectedContent( modelDocument.selection, modelDocument.batch() ); expect( stringify( content ) ).to.equal( 'ob' ); } ); diff --git a/tests/controller/getselectedcontent.js b/tests/controller/getselectedcontent.js index bac043f61..923cd7d2c 100644 --- a/tests/controller/getselectedcontent.js +++ b/tests/controller/getselectedcontent.js @@ -30,7 +30,7 @@ describe( 'Delete utils', () => { it( 'returns empty fragment for no selection', () => { setData( doc, 'abc' ); - const frag = getSelectedContent( doc.selection ); + const frag = getSelectedContent( doc.selection, doc.batch() ); expect( frag ).instanceOf( DocumentFragment ); expect( frag.isEmpty ).to.be.true; @@ -39,7 +39,7 @@ describe( 'Delete utils', () => { it( 'returns empty fragment for empty selection', () => { setData( doc, 'a[]bc' ); - const frag = getSelectedContent( doc.selection ); + const frag = getSelectedContent( doc.selection, doc.batch() ); expect( frag ).instanceOf( DocumentFragment ); expect( frag.isEmpty ).to.be.true; @@ -48,7 +48,7 @@ describe( 'Delete utils', () => { it( 'gets one character', () => { setData( doc, 'a[b]c' ); - const frag = getSelectedContent( doc.selection ); + const frag = getSelectedContent( doc.selection, doc.batch() ); const content = stringify( frag ); expect( frag ).instanceOf( DocumentFragment ); @@ -58,49 +58,49 @@ describe( 'Delete utils', () => { it( 'gets full text', () => { setData( doc, '[abc]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abc' ); } ); it( 'gets text with an attribute', () => { setData( doc, 'xxx<$text bold="true">a[b]c' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '<$text bold="true">b' ); } ); it( 'gets text with attributes', () => { setData( doc, 'x<$text bold="true">a[b<$text italic="true">c]dx' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '<$text bold="true">b<$text italic="true">c' ); } ); it( 'gets text with and without attribute', () => { setData( doc, '<$text bold="true">a[bc]d' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '<$text bold="true">bc' ); } ); it( 'gets text and element', () => { setData( doc, '[abc]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abc' ); } ); it( 'gets one element', () => { setData( doc, 'a[]b' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '' ); } ); it( 'gets multiple elements', () => { setData( doc, '[]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '' ); } ); } ); @@ -128,63 +128,63 @@ describe( 'Delete utils', () => { it( 'gets one character', () => { setData( doc, 'a[b]c' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'b' ); } ); it( 'gets entire paragraph content', () => { setData( doc, '[ab]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'ab' ); } ); it( 'gets two blocks - partial, partial', () => { setData( doc, 'a[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets two blocks - full, partial', () => { setData( doc, '[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - full, partial 2', () => { setData( doc, '[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - full, partial 3', () => { setData( doc, 'x[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - full, partial 4', () => { setData( doc, '[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - partial, full', () => { setData( doc, 'a[bcdef]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcdef' ); } ); it( 'gets two blocks - partial, full 2', () => { setData( doc, 'a[bcdef]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcdef' ); } ); @@ -192,7 +192,7 @@ describe( 'Delete utils', () => { it( 'gets two blocks - empty, full', () => { setData( doc, 'abc[def]' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'def' ); } ); @@ -200,28 +200,28 @@ describe( 'Delete utils', () => { it( 'gets two blocks - partial, empty', () => { setData( doc, 'a[bc]def' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bc' ); } ); it( 'gets three blocks', () => { setData( doc, 'a[bcxde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcxde' ); } ); it( 'gets block image', () => { setData( doc, 'a[]b' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '' ); } ); it( 'gets two blocks', () => { setData( doc, 'a[]b' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( '' ); } ); @@ -229,7 +229,7 @@ describe( 'Delete utils', () => { it( 'gets content when multiple text items needs to be removed from the right excess', () => { setData( doc, 'a[bc]d<$text bold="true">ef' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ) .to.equal( 'bc' ); } ); @@ -238,7 +238,7 @@ describe( 'Delete utils', () => { it( 'gets content when multiple text items needs to be removed from the left excess', () => { setData( doc, 'a<$text bold="true">bc[de]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ) .to.equal( 'de' ); } ); @@ -262,28 +262,28 @@ describe( 'Delete utils', () => { it( 'gets content when ends are equally deeply nested', () => { setData( doc, 'xa[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets content when left end nested deeper', () => { setData( doc, 'a[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets content when left end nested deeper 2', () => { setData( doc, 'a[bcxde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcxde' ); } ); it( 'gets content when left end nested deeper 3', () => { setData( doc, 'xa[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcde' ); } ); @@ -291,21 +291,21 @@ describe( 'Delete utils', () => { it( 'gets content when left end nested deeper 4', () => { setData( doc, 'x[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets content when right end nested deeper', () => { setData( doc, 'a[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets content when both ends nested deeper than the middle element', () => { setData( doc, 'a[bcxde]f' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ) .to.equal( 'bcxde' ); } ); @@ -325,7 +325,7 @@ describe( 'Delete utils', () => { '' ); - const content = stringify( getSelectedContent( doc.selection ) ); + const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); expect( content ) .to.equal( 'arbo' ); } ); From 567b38013437b4a336c5226a2c04a076a23b2a44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 09:21:56 +0100 Subject: [PATCH 091/724] Removed unnecessary batch from additionalData. --- tests/conversion/advanced-converters.js | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/tests/conversion/advanced-converters.js b/tests/conversion/advanced-converters.js index c2e5659ec..786ee4630 100644 --- a/tests/conversion/advanced-converters.js +++ b/tests/conversion/advanced-converters.js @@ -208,8 +208,8 @@ describe( 'advanced-converters', () => { const viewFigureConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable, batch ); - const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable, batch ); + const modelImage = conversionApi.convertItem( data.input.getChild( 0 ), consumable ); + const modelCaption = conversionApi.convertItem( data.input.getChild( 1 ), consumable ); modelImage.appendChildren( modelCaption ); @@ -232,7 +232,7 @@ describe( 'advanced-converters', () => { const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { const modelCaption = new ModelElement( 'caption' ); - const children = conversionApi.convertChildren( data.input, consumable, batch ); + const children = conversionApi.convertChildren( data.input, consumable ); modelCaption.appendChildren( children ); @@ -372,7 +372,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, batch ); + data.output = conversionApi.convertChildren( data.input, consumable ); } for ( const child of data.output ) { @@ -384,7 +384,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { attribute: 'title' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, batch ); + data.output = conversionApi.convertChildren( data.input, consumable ); } for ( const child of data.output ) { @@ -469,7 +469,7 @@ describe( 'advanced-converters', () => { } } - const children = conversionApi.convertChildren( data.input, consumable, batch ); + const children = conversionApi.convertChildren( data.input, consumable ); data.output.appendChildren( children ); } } ); @@ -603,7 +603,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:a', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true, attribute: 'href' } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, batch ); + data.output = conversionApi.convertChildren( data.input, consumable ); } for ( const child of data.output ) { @@ -616,7 +616,7 @@ describe( 'advanced-converters', () => { if ( consumable.consume( data.input, { name: true } ) ) { data.output = new ModelElement( 'paragraph' ); - const children = conversionApi.convertChildren( data.input, consumable, batch ); + const children = conversionApi.convertChildren( data.input, consumable ); for ( let i = 1; i < children.childCount; i++ ) { const child = children.getChild( i ); @@ -633,13 +633,13 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:table', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.convertChildren( data.input, consumable, batch ); + data.output = conversionApi.convertChildren( data.input, consumable ); } } ); viewDispatcher.on( 'element:td', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.convertChildren( data.input, consumable, batch ); + data.output = conversionApi.convertChildren( data.input, consumable ); } } ); @@ -681,7 +681,7 @@ describe( 'advanced-converters', () => { } } - data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, batch ) ); + data.output.appendChildren( conversionApi.convertChildren( data.input, consumable ) ); } }, { priority: 'lowest' } ); @@ -705,7 +705,7 @@ describe( 'advanced-converters', () => { viewDispatcher.on( 'element:strong', ( evt, data, consumable, conversionApi ) => { if ( consumable.consume( data.input, { name: true } ) ) { if ( !data.output ) { - data.output = conversionApi.convertChildren( data.input, consumable, batch ); + data.output = conversionApi.convertChildren( data.input, consumable ); } for ( const child of data.output ) { From e17d4391c7123c79b2756aa790c04eee1acc0835 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 09:23:11 +0100 Subject: [PATCH 092/724] Simplified documentFragment conversion in model dev-util. --- src/dev-utils/model.js | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 295160bff..5bdd30d2b 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -20,7 +20,6 @@ import ModelSelection from '../model/selection'; import ModelDocumentFragment from '../model/documentfragment'; import ModelElement from '../model/element'; import ModelText from '../model/text'; -import modelWriter from '../model/writer'; import ViewConversionDispatcher from '../conversion/viewconversiondispatcher'; import ViewSelection from '../view/selection'; @@ -324,9 +323,7 @@ export function parse( data, schema, batch, options = {} ) { function convertToModelFragment() { return ( evt, data, consumable, conversionApi ) => { - const convertedChildren = conversionApi.convertChildren( data.input, consumable, data ); - - data.output = new ModelDocumentFragment( modelWriter.normalizeNodes( convertedChildren ) ); + data.output = conversionApi.convertChildren( data.input, consumable, data ); conversionApi.mapper.bindElements( data.output, data.input ); evt.stop(); From 4fb3eeea806e4d6f0d2ea2f676c43d1eb88b86b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 09:38:27 +0100 Subject: [PATCH 093/724] Replaced model writer by batch API in advanced conversion tests. --- tests/conversion/advanced-converters.js | 42 ++++++++++--------------- 1 file changed, 16 insertions(+), 26 deletions(-) diff --git a/tests/conversion/advanced-converters.js b/tests/conversion/advanced-converters.js index 786ee4630..f8c23fb2b 100644 --- a/tests/conversion/advanced-converters.js +++ b/tests/conversion/advanced-converters.js @@ -4,14 +4,12 @@ */ import ModelDocument from '../../src/model/document'; -import ModelDocumentFragment from '../../src/model/documentfragment'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; import ModelTextProxy from '../../src/model/textproxy'; import ModelRange from '../../src/model/range'; import ModelPosition from '../../src/model/position'; import ModelWalker from '../../src/model/treewalker'; -import modelWriter from '../../src/model/writer'; import ViewElement from '../../src/view/element'; import ViewContainerElement from '../../src/view/containerelement'; @@ -217,24 +215,18 @@ describe( 'advanced-converters', () => { } }; - const viewImageConverter = function( evt, data, consumable ) { + const viewImageConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - const modelImage = new ModelElement( 'image' ); - - for ( const attributeKey of data.input.getAttributeKeys() ) { - modelImage.setAttribute( attributeKey, data.input.getAttribute( attributeKey ) ); - } - - data.output = modelImage; + data.output = conversionApi.batch.createElement( 'image', data.input.getAttributes() ); } }; const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - const modelCaption = new ModelElement( 'caption' ); + const modelCaption = conversionApi.batch.createElement( 'caption' ); const children = conversionApi.convertChildren( data.input, consumable ); - modelCaption.appendChildren( children ); + conversionApi.batch.append( children, modelCaption ); data.output = modelCaption; } @@ -250,14 +242,14 @@ describe( 'advanced-converters', () => { } ); it( 'should convert model images changes without caption to view', () => { - const modelElement = new ModelElement( 'image', { src: 'bar.jpg', title: 'bar' } ); - modelRoot.appendChildren( modelElement ); + const modelElement = batch.createElement( 'image', { src: 'bar.jpg', title: 'bar' } ); + batch.append( modelElement, modelRoot ); modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
' ); - modelElement.setAttribute( 'src', 'new.jpg' ); - modelElement.removeAttribute( 'title' ); + batch.setAttribute( 'src', 'new.jpg', modelElement ); + batch.removeAttribute( 'title', modelElement ); modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'src', 'bar.jpg', 'new.jpg' ); modelDispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'title', 'bar', null ); @@ -486,15 +478,16 @@ describe( 'advanced-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '' ); // Let's change link's attributes. - modelWriter.setAttribute( range, 'linkHref', 'bar.html' ); - modelWriter.setAttribute( range, 'linkTitle', 'Bar title' ); + batch.setAttributes( { + linkHref: 'bar.html', + linkTitle: 'Bar title' + }, range ); modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkHref', 'foo.html', 'bar.html' ); modelDispatcher.convertAttribute( 'changeAttribute', range, 'linkTitle', 'Foo title', 'Bar title' ); expect( viewToString( viewRoot ) ).to.equal( '' ); - const removed = modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); - modelDoc.graveyard.appendChildren( removed ); + batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); modelDispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 0 ), ModelRange.createIn( modelDoc.graveyard ) @@ -505,13 +498,13 @@ describe( 'advanced-converters', () => { range = ModelRange.createIn( modelRoot ); // Let's remove just one attribute. - modelWriter.removeAttribute( range, 'linkTitle' ); + batch.removeAttribute( 'linkTitle', range ); modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkTitle', 'Bar title', null ); expect( viewToString( viewRoot ) ).to.equal( '' ); // Let's remove the other attribute. - modelWriter.removeAttribute( range, 'linkHref' ); + batch.removeAttribute( 'linkHref', range ); modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkHref', 'bar.html', null ); expect( viewToString( viewRoot ) ).to.equal( '
oo
' ); @@ -654,10 +647,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - const model = viewDispatcher.convert( viewTable, batch ); - const modelFragment = new ModelDocumentFragment( model ); - - expect( modelToString( modelFragment ) ) + expect( modelToString( viewDispatcher.convert( viewTable, batch ) ) ) .to.equal( 'foo <$text linkHref="bar.html">barabc' ); } ); From 0023da564417c625228bae0e63d8f640244665cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 10:45:22 +0100 Subject: [PATCH 094/724] Replaced writed by batch in conversion tests. --- tests/conversion/buildmodelconverter.js | 13 +++--- tests/conversion/model-to-view-converters.js | 49 +++++++------------- 2 files changed, 23 insertions(+), 39 deletions(-) diff --git a/tests/conversion/buildmodelconverter.js b/tests/conversion/buildmodelconverter.js index 468b5a4c7..226fc7de6 100644 --- a/tests/conversion/buildmodelconverter.js +++ b/tests/conversion/buildmodelconverter.js @@ -10,7 +10,6 @@ import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; import ModelRange from '../../src/model/range'; import ModelPosition from '../../src/model/position'; -import modelWriter from '../../src/model/writer'; import ViewDocument from '../../src/view/document'; import ViewElement from '../../src/view/element'; @@ -70,12 +69,14 @@ function viewToString( item ) { } describe( 'Model converter builder', () => { - let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection; + let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, batch; beforeEach( () => { modelDoc = new ModelDocument(); modelRoot = modelDoc.createRoot( 'root', 'root' ); + batch = modelDoc.batch(); + viewDoc = new ViewDocument(); viewRoot = viewDoc.createRoot( 'div' ); viewSelection = viewDoc.selection; @@ -145,7 +146,7 @@ describe( 'Model converter builder', () => { expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' ); + batch.removeAttribute( 'bold', modelRoot ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null ); @@ -162,7 +163,7 @@ describe( 'Model converter builder', () => { expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'bold' ); + batch.removeAttribute( 'bold', modelRoot ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null ); @@ -179,13 +180,13 @@ describe( 'Model converter builder', () => { expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - modelWriter.setAttribute( ModelRange.createIn( modelRoot ), 'italic', 'i' ); + batch.setAttribute( 'italic', 'i', modelRoot ); dispatcher.convertAttribute( 'changeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'em', 'i' ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - modelWriter.removeAttribute( ModelRange.createIn( modelRoot ), 'italic' ); + batch.removeAttribute( 'italic', modelRoot ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'i', null ); diff --git a/tests/conversion/model-to-view-converters.js b/tests/conversion/model-to-view-converters.js index f4ffcfb7c..449a79044 100644 --- a/tests/conversion/model-to-view-converters.js +++ b/tests/conversion/model-to-view-converters.js @@ -8,7 +8,6 @@ import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; import ModelRange from '../../src/model/range'; import ModelPosition from '../../src/model/position'; -import modelWriter from '../../src/model/writer'; import ViewElement from '../../src/view/element'; import ViewContainerElement from '../../src/view/containerelement'; @@ -36,13 +35,15 @@ import { import { createRangeOnElementOnly } from '../../tests/model/_utils/utils'; describe( 'model-to-view-converters', () => { - let dispatcher, modelDoc, modelRoot, mapper, viewRoot; + let dispatcher, modelDoc, modelRoot, mapper, viewRoot, batch; beforeEach( () => { modelDoc = new ModelDocument(); modelRoot = modelDoc.createRoot(); viewRoot = new ViewContainerElement( 'div' ); + batch = modelDoc.batch(); + mapper = new Mapper(); mapper.bindElements( modelRoot, viewRoot ); @@ -537,7 +538,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' ); + batch.removeAttribute( 'bold', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null ); @@ -564,7 +565,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'style' ); + batch.removeAttribute( 'style', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null ); @@ -594,7 +595,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

xfoox

' ); - modelWriter.setAttribute( ModelRange.createIn( modelElement ), 'link', 'http://foobar.com' ); + batch.setAttribute( 'link', 'http://foobar.com', modelElement ); dispatcher.convertAttribute( 'changeAttribute', @@ -622,7 +623,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

நிலைக்கு

' ); - modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' ); + batch.removeAttribute( 'bold', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null ); @@ -665,7 +666,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - modelWriter.removeAttribute( ModelRange.createIn( modelElement ), 'bold' ); + batch.removeAttribute( 'bold', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null ); @@ -1011,10 +1012,7 @@ describe( 'model-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); - modelWriter.move( - ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ), - ModelPosition.createAt( modelDoc.graveyard, 'end' ) - ); + batch.remove( ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelDiv, 0 ), @@ -1035,10 +1033,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Remove 'b'. - modelWriter.move( - ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ), - ModelPosition.createAt( modelDoc.graveyard, 'end' ) - ); + batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 3 ), @@ -1059,10 +1054,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Remove 'ob'. - modelWriter.move( - ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ), - ModelPosition.createAt( modelDoc.graveyard, 'end' ) - ); + batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 2 ), @@ -1084,7 +1076,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Move after "b". Can be e.g. a part of an unwrap delta (move + remove). - modelWriter.move( + batch.move( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ), ModelPosition.createAt( modelRoot, 'end' ) ); @@ -1111,11 +1103,8 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); - // Move to graveyard. - modelWriter.move( - ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ), - ModelPosition.createAt( modelDoc.graveyard, 'end' ) - ); + // Remove . + batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 0 ), @@ -1188,10 +1177,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); - modelWriter.move( - ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ), - ModelPosition.createAt( modelDoc.graveyard, 'end' ) - ); + batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 1 ), @@ -1215,10 +1201,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); - modelWriter.move( - ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ), - ModelPosition.createAt( modelDoc.graveyard, 'end' ) - ); + batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 3 ), From ed2ae83ebec06470dc66bbd67ab757c56be36e6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 13:54:35 +0100 Subject: [PATCH 095/724] Changed model writer to protected operation utils. --- src/model/operation/attributeoperation.js | 4 +- src/model/operation/detachoperation.js | 2 +- src/model/operation/insertoperation.js | 2 +- src/model/operation/moveoperation.js | 4 +- src/model/{writer.js => operation/utils.js} | 70 ++++++--------- tests/model/{writer.js => operation/utils.js} | 89 +++++++------------ 6 files changed, 68 insertions(+), 103 deletions(-) rename src/model/{writer.js => operation/utils.js} (82%) rename tests/model/{writer.js => operation/utils.js} (66%) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index cb57426fb..21b533a80 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -10,7 +10,7 @@ import Operation from './operation'; import Range from '../range'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -import writer from '../writer'; +import { setAttribute } from './utils'; import isEqual from '@ckeditor/ckeditor5-utils/src/lib/lodash/isEqual'; /** @@ -151,7 +151,7 @@ export default class AttributeOperation extends Operation { // If value to set is same as old value, don't do anything. if ( !isEqual( this.oldValue, this.newValue ) ) { // Execution. - writer.setAttribute( this.range, this.key, this.newValue ); + setAttribute( this.range, this.key, this.newValue ); } return { range: this.range, key: this.key, oldValue: this.oldValue, newValue: this.newValue }; diff --git a/src/model/operation/detachoperation.js b/src/model/operation/detachoperation.js index 23110f0b9..edb607436 100644 --- a/src/model/operation/detachoperation.js +++ b/src/model/operation/detachoperation.js @@ -10,7 +10,7 @@ import Operation from './operation'; import Position from '../position'; import Range from '../range'; -import { remove } from '../writer'; +import { remove } from './utils'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 7806be1ea..3ae34f0a6 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -11,7 +11,7 @@ import Operation from './operation'; import Position from '../position'; import NodeList from '../nodelist'; import RemoveOperation from './removeoperation'; -import { insert, normalizeNodes } from '../writer'; +import { insert, normalizeNodes } from './utils'; import Text from '../text'; import Element from '../element'; diff --git a/src/model/operation/moveoperation.js b/src/model/operation/moveoperation.js index 1e04c81ec..e7b29aef6 100644 --- a/src/model/operation/moveoperation.js +++ b/src/model/operation/moveoperation.js @@ -12,7 +12,7 @@ import Position from '../position'; import Range from '../range'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; -import writer from './../writer'; +import { move } from './utils'; /** * Operation to move a range of {@link module:engine/model/item~Item model items} @@ -184,7 +184,7 @@ export default class MoveOperation extends Operation { } } - const range = writer.move( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition ); + const range = move( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition ); return { sourcePosition: this.sourcePosition, diff --git a/src/model/writer.js b/src/model/operation/utils.js similarity index 82% rename from src/model/writer.js rename to src/model/operation/utils.js index 553f5afb3..7b3ac49a3 100644 --- a/src/model/writer.js +++ b/src/model/operation/utils.js @@ -4,48 +4,39 @@ */ /** - * @module engine/model/writer + * @module engine/model/operation/utils */ -import Node from './node'; -import Text from './text'; -import TextProxy from './textproxy'; -import Range from './range'; -import DocumentFragment from './documentfragment'; -import NodeList from './nodelist'; +import Node from '../node'; +import Text from '../text'; +import TextProxy from '../textproxy'; +import Range from '../range'; +import DocumentFragment from '../documentfragment'; +import NodeList from '../nodelist'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** - * Contains functions used for composing model tree, grouped together under "model writer" name. Those functions - * are built on top of {@link module:engine/model/node~Node node}, and it's child classes', APIs. + * Contains functions used for composing model tree by {@link module:engine/model/operation~Operation operations}. + * Those functions are built on top of {@link module:engine/model/node~Node node}, and it's child classes', APIs. * - * Model writer API has multiple advantages and it is highly recommended to use it when changing model tree and nodes: - * * model writer API {@link module:engine/model/writer~writer.normalizeNodes normalizes inserted nodes}, which means that you can insert - * not only {@link module:engine/model/node~Node nodes}, but also `String`s, {@link module:engine/model/textproxy~TextProxy text proxies} - * and - * {@link module:engine/model/documentfragment~DocumentFragment document fragments}, - * * model writer API operates on {@link module:engine/model/position~Position positions}, which means that you have - * better control over manipulating model tree as positions operate on offsets rather than indexes, - * * model writer API automatically merges {@link module:engine/model/text~Text text nodes} with same attributes, which means - * lower memory usage and better efficiency. - * - * @namespace writer + * @protected + * @namespace utils */ -const writer = { +const utils = { insert, remove, move, setAttribute, - removeAttribute, normalizeNodes }; -export default writer; +export default utils; /** * Inserts given nodes at given position. * - * @function module:engine/model/writer~writer.insert + * @protected + * @function module:engine/model/operation/utils~utils.insert * @param {module:engine/model/position~Position} position Position at which nodes should be inserted. * @param {module:engine/model/node~NodeSet} nodes Nodes to insert. * @returns {module:engine/model/range~Range} Range spanning over inserted elements. @@ -75,7 +66,8 @@ export function insert( position, nodes ) { /** * Removed nodes in given range. Only {@link module:engine/model/range~Range#isFlat flat} ranges are accepted. * - * @function module:engine/model/writer~writer.remove + * @protected + * @function module:engine/model/operation/utils~utils.remove * @param {module:engine/model/range~Range} range Range containing nodes to remove. * @returns {Array.} */ @@ -84,9 +76,9 @@ export function remove( range ) { /** * Trying to remove a range which starts and ends in different element. * - * @error model-writer-remove-range-not-flat + * @error operation-utils-remove-range-not-flat */ - throw new CKEditorError( 'model-writer-remove-range-not-flat: ' + + throw new CKEditorError( 'operation-utils-remove-range-not-flat: ' + 'Trying to remove a range which starts and ends in different element.' ); } @@ -109,6 +101,8 @@ export function remove( range ) { /** * Moves nodes in given range to given target position. Only {@link module:engine/model/range~Range#isFlat flat} ranges are accepted. * + * @protected + * @function module:engine/model/operation/utils~utils.move * @param {module:engine/model/range~Range} sourceRange Range containing nodes to move. * @param {module:engine/model/position~Position} targetPosition Position to which nodes should be moved. * @returns {module:engine/model/range~Range} Range containing moved nodes. @@ -118,24 +112,26 @@ export function move( sourceRange, targetPosition ) { /** * Trying to move a range which starts and ends in different element. * - * @error model-writer-move-range-not-flat + * @error operation-utils-move-range-not-flat */ - throw new CKEditorError( 'model-writer-move-range-not-flat: ' + + throw new CKEditorError( 'operation-utils-move-range-not-flat: ' + 'Trying to move a range which starts and ends in different element.' ); } - const nodes = this.remove( sourceRange ); + const nodes = remove( sourceRange ); // We have to fix `targetPosition` because model changed after nodes from `sourceRange` got removed and // that change might have an impact on `targetPosition`. targetPosition = targetPosition._getTransformedByDeletion( sourceRange.start, sourceRange.end.offset - sourceRange.start.offset ); - return this.insert( targetPosition, nodes ); + return insert( targetPosition, nodes ); } /** * Sets given attribute on nodes in given range. * + * @protected + * @function module:engine/model/operation/utils~utils.setAttribute * @param {module:engine/model/range~Range} range Range containing nodes that should have the attribute set. * @param {String} key Key of attribute to set. * @param {*} value Attribute value. @@ -166,20 +162,12 @@ export function setAttribute( range, key, value ) { _mergeNodesAtIndex( range.end.parent, range.end.index ); } -/** - * Removes given attribute from nodes in given range. - * - * @param {module:engine/model/range~Range} range Range containing nodes that should have the attribute removed. - * @param {String} key Key of attribute to remove. - */ -export function removeAttribute( range, key ) { - this.setAttribute( range, key, null ); -} - /** * Normalizes given object or an array of objects to an array of {@link module:engine/model/node~Node nodes}. See * {@link module:engine/model/node~NodeSet NodeSet} for details on how normalization is performed. * + * @protected + * @function module:engine/model/operation/utils~utils.normalizeNodes * @param {module:engine/model/node~NodeSet} nodes Objects to normalize. * @returns {Array.} Normalized nodes. */ diff --git a/tests/model/writer.js b/tests/model/operation/utils.js similarity index 66% rename from tests/model/writer.js rename to tests/model/operation/utils.js index 528113afa..d51cb913f 100644 --- a/tests/model/writer.js +++ b/tests/model/operation/utils.js @@ -3,21 +3,21 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; -import DocumentFragment from '../../src/model/documentfragment'; -import Element from '../../src/model/element'; -import Text from '../../src/model/text'; -import TextProxy from '../../src/model/textproxy'; -import Position from '../../src/model/position'; -import Range from '../../src/model/range'; -import writer from '../../src/model/writer'; -import { getData } from '../../src/dev-utils/model'; +import Document from '../../../src/model/document'; +import DocumentFragment from '../../../src/model/documentfragment'; +import Element from '../../../src/model/element'; +import Text from '../../../src/model/text'; +import TextProxy from '../../../src/model/textproxy'; +import Position from '../../../src/model/position'; +import Range from '../../../src/model/range'; +import utils from '../../../src/model/operation/utils'; +import { getData } from '../../../src/dev-utils/model'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; let doc, root; -describe( 'writer', () => { +describe( 'writer utils', () => { beforeEach( () => { doc = new Document(); doc.schema.allow( { name: '$text', inside: '$root' } ); @@ -38,19 +38,19 @@ describe( 'writer', () => { describe( 'insert', () => { it( 'should insert nodes between nodes', () => { - writer.insert( Position.createAt( root, 3 ), [ 'xxx', new Element( 'p' ) ] ); + utils.insert( Position.createAt( root, 3 ), [ 'xxx', new Element( 'p' ) ] ); expectData( 'fooxxx

<$text bold="true">barxyz' ); } ); it( 'should split text node if nodes at inserted at offset inside text node', () => { - writer.insert( Position.createAt( root, 5 ), new Element( 'p' ) ); + utils.insert( Position.createAt( root, 5 ), new Element( 'p' ) ); expectData( 'foo<$text bold="true">ba

<$text bold="true">rxyz' ); } ); it( 'should merge text nodes if possible', () => { - writer.insert( Position.createAt( root, 3 ), new Text( 'xxx', { bold: true } ) ); + utils.insert( Position.createAt( root, 3 ), new Text( 'xxx', { bold: true } ) ); expectData( 'foo<$text bold="true">xxxbarxyz' ); } ); @@ -59,21 +59,21 @@ describe( 'writer', () => { describe( 'remove', () => { it( 'should remove nodes in given range', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - writer.remove( range ); + utils.remove( range ); expectData( 'fooxyz' ); } ); it( 'should split text node if range starts or ends inside text node', () => { const range = Range.createFromParentsAndOffsets( root, 1, root, 5 ); - writer.remove( range ); + utils.remove( range ); expectData( 'f<$text bold="true">rxyz' ); } ); it( 'should merge text nodes if possible', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 7 ); - writer.remove( range ); + utils.remove( range ); expectData( 'fooxyz' ); expect( root.childCount ).to.equal( 1 ); @@ -81,89 +81,66 @@ describe( 'writer', () => { it( 'should throw if given range is not flat', () => { expect( () => { - writer.remove( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ) ); - } ).to.throw( CKEditorError, /model-writer-remove-range-not-flat/ ); + utils.remove( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ) ); + } ).to.throw( CKEditorError, /operation-utils-remove-range-not-flat/ ); } ); } ); describe( 'move', () => { it( 'should move a range of nodes', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - writer.move( range, Position.createAt( root, 0 ) ); + utils.move( range, Position.createAt( root, 0 ) ); expectData( '<$text bold="true">barfooxyz' ); } ); - it( 'should use remove and insert methods', () => { - sinon.spy( writer, 'remove' ); - sinon.spy( writer, 'insert' ); - - const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - const position = Position.createAt( root, 0 ); - writer.move( range, position ); - - expect( writer.remove.calledWithExactly( range ) ).to.be.true; - expect( writer.insert.calledWith( position ) ).to.be.true; - } ); - it( 'should correctly move if target position is in same element as moved range, but after range', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - writer.move( range, Position.createAt( root, 10 ) ); + utils.move( range, Position.createAt( root, 10 ) ); expectData( 'fooxyz<$text bold="true">bar' ); } ); it( 'should throw if given range is not flat', () => { expect( () => { - writer.move( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ), null ); - } ).to.throw( CKEditorError, /model-writer-move-range-not-flat/ ); + utils.move( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ), null ); + } ).to.throw( CKEditorError, /operation-utils-move-range-not-flat/ ); } ); } ); describe( 'setAttribute', () => { it( 'should set attribute on given range of nodes', () => { const range = Range.createFromParentsAndOffsets( root, 6, root, 8 ); - writer.setAttribute( range, 'newAttr', true ); + utils.setAttribute( range, 'newAttr', true ); expectData( 'foo<$text bold="true">bar<$text newAttr="true">xyz' ); } ); it( 'should remove attribute if null was passed as a value', () => { const range = Range.createFromParentsAndOffsets( root, 6, root, 7 ); - writer.setAttribute( range, 'src', null ); + utils.setAttribute( range, 'src', null ); expectData( 'foo<$text bold="true">barxyz' ); } ); it( 'should merge nodes if possible', () => { const range = Range.createFromParentsAndOffsets( root, 0, root, 3 ); - writer.setAttribute( range, 'bold', true ); + utils.setAttribute( range, 'bold', true ); expectData( '<$text bold="true">foobarxyz' ); } ); } ); - - describe( 'removeAttribute', () => { - it( 'should use setAttribute', () => { - sinon.spy( writer, 'setAttribute' ); - - const range = Range.createFromParentsAndOffsets( root, 6, root, 7 ); - writer.removeAttribute( range, 'src' ); - - expect( writer.setAttribute.calledWithExactly( range, 'src', null ) ).to.be.true; - } ); - } ); } ); describe( 'normalizeNodes', () => { it( 'should change single object into an array', () => { const p = new Element( 'p' ); - expect( writer.normalizeNodes( p ) ).to.deep.equal( [ p ] ); + expect( utils.normalizeNodes( p ) ).to.deep.equal( [ p ] ); } ); it( 'should change strings to text nodes', () => { - const text = writer.normalizeNodes( 'abc' )[ 0 ]; + const text = utils.normalizeNodes( 'abc' )[ 0 ]; expect( text ).to.be.instanceof( Text ); expect( text.data ).to.equal( 'abc' ); @@ -173,7 +150,7 @@ describe( 'normalizeNodes', () => { const textNode = new Text( 'abc' ); const textProxy = new TextProxy( textNode, 1, 1 ); - const text = writer.normalizeNodes( textProxy )[ 0 ]; + const text = utils.normalizeNodes( textProxy )[ 0 ]; expect( text ).to.be.instanceof( Text ); expect( text.data ).to.equal( 'b' ); @@ -182,11 +159,11 @@ describe( 'normalizeNodes', () => { it( 'should not change elements', () => { const p = new Element( 'p' ); - expect( writer.normalizeNodes( p )[ 0 ] ).to.equal( p ); + expect( utils.normalizeNodes( p )[ 0 ] ).to.equal( p ); } ); it( 'should omit unrecognized objects', () => { - expect( writer.normalizeNodes( 1 ) ).to.deep.equal( [] ); + expect( utils.normalizeNodes( 1 ) ).to.deep.equal( [] ); } ); it( 'should accept arrays', () => { @@ -194,7 +171,7 @@ describe( 'normalizeNodes', () => { const image = new Element( 'image' ); const nodes = [ 'abc', text, image, 1, 'xyz' ]; - const normalized = writer.normalizeNodes( nodes ); + const normalized = utils.normalizeNodes( nodes ); expect( normalized[ 0 ] ).to.be.instanceof( Text ); expect( normalized[ 1 ] ).to.equal( text ); @@ -203,7 +180,7 @@ describe( 'normalizeNodes', () => { } ); it( 'should merge text nodes if mergeTextNodes flag is set to true', () => { - const normalized = writer.normalizeNodes( [ 'foo', 'bar' ], true ); + const normalized = utils.normalizeNodes( [ 'foo', 'bar' ], true ); expect( normalized.length ).to.equal( 1 ); expect( normalized[ 0 ].data ).to.equal( 'foobar' ); @@ -216,7 +193,7 @@ describe( 'normalizeNodes', () => { 'xyz' ]; - const normalized = writer.normalizeNodes( nodes, true ); + const normalized = utils.normalizeNodes( nodes, true ); expect( normalized[ 0 ] ).to.be.instanceof( Text ); expect( normalized[ 0 ].getAttribute( 'bold' ) ).to.be.true; From 1d68fe6333ebb535606554415c9d85984ee64cc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 29 Nov 2017 14:20:14 +0100 Subject: [PATCH 096/724] Increased operations CC. --- tests/model/operation/attributeoperation.js | 16 +++++++++++++ tests/model/operation/detachoperation.js | 18 +++++++++++++- tests/model/operation/operationfactory.js | 26 +++++++++++++++++++++ tests/model/operation/renameoperation.js | 8 +++++++ 4 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 tests/model/operation/operationfactory.js diff --git a/tests/model/operation/attributeoperation.js b/tests/model/operation/attributeoperation.js index ce46e0537..24e41fadf 100644 --- a/tests/model/operation/attributeoperation.js +++ b/tests/model/operation/attributeoperation.js @@ -398,6 +398,22 @@ describe( 'AttributeOperation', () => { expect( root.getChild( 1 ).data ).to.equal( 'bcxyz' ); } ); + it( 'should do nothing when attribute value is the same', () => { + root.insertChildren( 0, new Text( 'x', { foo: true } ) ); + + expect( () => { + doc.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), + 'foo', + true, + true, + doc.version + ) + ) ); + } ).to.not.throw(); + } ); + describe( 'toJSON', () => { it( 'should create proper serialized object', () => { const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ); diff --git a/tests/model/operation/detachoperation.js b/tests/model/operation/detachoperation.js index 6d1a16856..f62f666de 100644 --- a/tests/model/operation/detachoperation.js +++ b/tests/model/operation/detachoperation.js @@ -5,7 +5,7 @@ import Document from '../../../src/model/document'; import DetachOperation from '../../../src/model/operation/detachoperation'; -import { wrapInDelta } from '../../../tests/model/_utils/utils'; +import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import Position from '../../../src/model/position'; @@ -52,4 +52,20 @@ describe( 'DetachOperation', () => { expect( op.isDocumentOperation ).to.false; } ); + + describe( 'toJSON', () => { + it( 'should create proper json object', () => { + const position = Position.createBefore( element ); + const op = new DetachOperation( position, 1, doc.version ); + + const serialized = jsonParseStringify( op ); + + expect( serialized ).to.deep.equal( { + __className: 'engine.model.operation.DetachOperation', + baseVersion: 0, + sourcePosition: jsonParseStringify( position ), + howMany: 1 + } ); + } ); + } ); } ); diff --git a/tests/model/operation/operationfactory.js b/tests/model/operation/operationfactory.js new file mode 100644 index 000000000..ca23002b0 --- /dev/null +++ b/tests/model/operation/operationfactory.js @@ -0,0 +1,26 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import Document from '../../../src/model/document'; +import NoOperation from '../../../src/model/operation/nooperation'; +import OperationFactory from '../../../src/model/operation/operationfactory'; + +describe( 'OperationFactory', () => { + let doc; + + beforeEach( () => { + doc = new Document(); + } ); + + it( 'should create operation from JSON', () => { + const operation = OperationFactory.fromJSON( { + __className: 'engine.model.operation.NoOperation', + baseVersion: 0 + }, doc ); + + expect( operation ).to.instanceof( NoOperation ); + expect( operation.baseVersion ).to.equal( 0 ); + } ); +} ); diff --git a/tests/model/operation/renameoperation.js b/tests/model/operation/renameoperation.js index 54e141564..669f829b9 100644 --- a/tests/model/operation/renameoperation.js +++ b/tests/model/operation/renameoperation.js @@ -92,6 +92,14 @@ describe( 'RenameOperation', () => { expect( clone.newName ).to.equal( newName ); } ); + it( 'should do nothing when new name is the same as previous', () => { + const op = new RenameOperation( position, oldName, oldName, doc.version ); + + expect( () => { + doc.applyOperation( wrapInDelta( op ) ); + } ).to.not.throw(); + } ); + describe( 'isDocumentOperation', () => { it( 'should be true when target item is in the document', () => { const op = new RenameOperation( position, oldName, newName, doc.version ); From ebd9137fbcecc6212a2f4a8e1cdc5c5cbfd4a6d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 30 Nov 2017 10:33:39 +0100 Subject: [PATCH 097/724] Marked operation utils names as protected. --- src/model/operation/attributeoperation.js | 4 +-- src/model/operation/detachoperation.js | 4 +-- src/model/operation/insertoperation.js | 6 ++-- src/model/operation/moveoperation.js | 4 +-- src/model/operation/utils.js | 25 +++++-------- tests/model/operation/utils.js | 44 +++++++++++------------ 6 files changed, 39 insertions(+), 48 deletions(-) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index 21b533a80..2036e8c4e 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -10,7 +10,7 @@ import Operation from './operation'; import Range from '../range'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -import { setAttribute } from './utils'; +import { _setAttribute } from './utils'; import isEqual from '@ckeditor/ckeditor5-utils/src/lib/lodash/isEqual'; /** @@ -151,7 +151,7 @@ export default class AttributeOperation extends Operation { // If value to set is same as old value, don't do anything. if ( !isEqual( this.oldValue, this.newValue ) ) { // Execution. - setAttribute( this.range, this.key, this.newValue ); + _setAttribute( this.range, this.key, this.newValue ); } return { range: this.range, key: this.key, oldValue: this.oldValue, newValue: this.newValue }; diff --git a/src/model/operation/detachoperation.js b/src/model/operation/detachoperation.js index edb607436..a647bd0b0 100644 --- a/src/model/operation/detachoperation.js +++ b/src/model/operation/detachoperation.js @@ -10,7 +10,7 @@ import Operation from './operation'; import Position from '../position'; import Range from '../range'; -import { remove } from './utils'; +import { _remove } from './utils'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** @@ -73,7 +73,7 @@ export default class DetachOperation extends Operation { throw new CKEditorError( 'detach-operation-on-document-node: Cannot detach document node.' ); } - const nodes = remove( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ) ); + const nodes = _remove( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ) ); return { nodes }; } diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 3ae34f0a6..41442d7c8 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -11,7 +11,7 @@ import Operation from './operation'; import Position from '../position'; import NodeList from '../nodelist'; import RemoveOperation from './removeoperation'; -import { insert, normalizeNodes } from './utils'; +import { _insert, _normalizeNodes } from './utils'; import Text from '../text'; import Element from '../element'; @@ -45,7 +45,7 @@ export default class InsertOperation extends Operation { * @readonly * @member {module:engine/model/nodelist~NodeList} module:engine/model/operation/insertoperation~InsertOperation#nodeList */ - this.nodes = new NodeList( normalizeNodes( nodes ) ); + this.nodes = new NodeList( _normalizeNodes( nodes ) ); /** * @inheritDoc @@ -94,7 +94,7 @@ export default class InsertOperation extends Operation { const originalNodes = this.nodes; this.nodes = new NodeList( [ ...originalNodes ].map( node => node.clone( true ) ) ); - const range = insert( this.position, originalNodes ); + const range = _insert( this.position, originalNodes ); return { range }; } diff --git a/src/model/operation/moveoperation.js b/src/model/operation/moveoperation.js index e7b29aef6..6290823d9 100644 --- a/src/model/operation/moveoperation.js +++ b/src/model/operation/moveoperation.js @@ -12,7 +12,7 @@ import Position from '../position'; import Range from '../range'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; -import { move } from './utils'; +import { _move } from './utils'; /** * Operation to move a range of {@link module:engine/model/item~Item model items} @@ -184,7 +184,7 @@ export default class MoveOperation extends Operation { } } - const range = move( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition ); + const range = _move( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition ); return { sourcePosition: this.sourcePosition, diff --git a/src/model/operation/utils.js b/src/model/operation/utils.js index 7b3ac49a3..cfaf8c4b9 100644 --- a/src/model/operation/utils.js +++ b/src/model/operation/utils.js @@ -22,15 +22,6 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * @protected * @namespace utils */ -const utils = { - insert, - remove, - move, - setAttribute, - normalizeNodes -}; - -export default utils; /** * Inserts given nodes at given position. @@ -41,8 +32,8 @@ export default utils; * @param {module:engine/model/node~NodeSet} nodes Nodes to insert. * @returns {module:engine/model/range~Range} Range spanning over inserted elements. */ -export function insert( position, nodes ) { - nodes = normalizeNodes( nodes ); +export function _insert( position, nodes ) { + nodes = _normalizeNodes( nodes ); // We have to count offset before inserting nodes because they can get merged and we would get wrong offsets. const offset = nodes.reduce( ( sum, node ) => sum + node.offsetSize, 0 ); @@ -71,7 +62,7 @@ export function insert( position, nodes ) { * @param {module:engine/model/range~Range} range Range containing nodes to remove. * @returns {Array.} */ -export function remove( range ) { +export function _remove( range ) { if ( !range.isFlat ) { /** * Trying to remove a range which starts and ends in different element. @@ -107,7 +98,7 @@ export function remove( range ) { * @param {module:engine/model/position~Position} targetPosition Position to which nodes should be moved. * @returns {module:engine/model/range~Range} Range containing moved nodes. */ -export function move( sourceRange, targetPosition ) { +export function _move( sourceRange, targetPosition ) { if ( !sourceRange.isFlat ) { /** * Trying to move a range which starts and ends in different element. @@ -118,13 +109,13 @@ export function move( sourceRange, targetPosition ) { 'Trying to move a range which starts and ends in different element.' ); } - const nodes = remove( sourceRange ); + const nodes = _remove( sourceRange ); // We have to fix `targetPosition` because model changed after nodes from `sourceRange` got removed and // that change might have an impact on `targetPosition`. targetPosition = targetPosition._getTransformedByDeletion( sourceRange.start, sourceRange.end.offset - sourceRange.start.offset ); - return insert( targetPosition, nodes ); + return _insert( targetPosition, nodes ); } /** @@ -136,7 +127,7 @@ export function move( sourceRange, targetPosition ) { * @param {String} key Key of attribute to set. * @param {*} value Attribute value. */ -export function setAttribute( range, key, value ) { +export function _setAttribute( range, key, value ) { // Range might start or end in text nodes, so we have to split them. _splitNodeAtPosition( range.start ); _splitNodeAtPosition( range.end ); @@ -171,7 +162,7 @@ export function setAttribute( range, key, value ) { * @param {module:engine/model/node~NodeSet} nodes Objects to normalize. * @returns {Array.} Normalized nodes. */ -export function normalizeNodes( nodes ) { +export function _normalizeNodes( nodes ) { const normalized = []; if ( !( nodes instanceof Array ) ) { diff --git a/tests/model/operation/utils.js b/tests/model/operation/utils.js index d51cb913f..fa30e86e7 100644 --- a/tests/model/operation/utils.js +++ b/tests/model/operation/utils.js @@ -10,7 +10,7 @@ import Text from '../../../src/model/text'; import TextProxy from '../../../src/model/textproxy'; import Position from '../../../src/model/position'; import Range from '../../../src/model/range'; -import utils from '../../../src/model/operation/utils'; +import * as utils from '../../../src/model/operation/utils'; import { getData } from '../../../src/dev-utils/model'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; @@ -38,19 +38,19 @@ describe( 'writer utils', () => { describe( 'insert', () => { it( 'should insert nodes between nodes', () => { - utils.insert( Position.createAt( root, 3 ), [ 'xxx', new Element( 'p' ) ] ); + utils._insert( Position.createAt( root, 3 ), [ 'xxx', new Element( 'p' ) ] ); expectData( 'fooxxx

<$text bold="true">barxyz' ); } ); it( 'should split text node if nodes at inserted at offset inside text node', () => { - utils.insert( Position.createAt( root, 5 ), new Element( 'p' ) ); + utils._insert( Position.createAt( root, 5 ), new Element( 'p' ) ); expectData( 'foo<$text bold="true">ba

<$text bold="true">rxyz' ); } ); it( 'should merge text nodes if possible', () => { - utils.insert( Position.createAt( root, 3 ), new Text( 'xxx', { bold: true } ) ); + utils._insert( Position.createAt( root, 3 ), new Text( 'xxx', { bold: true } ) ); expectData( 'foo<$text bold="true">xxxbarxyz' ); } ); @@ -59,21 +59,21 @@ describe( 'writer utils', () => { describe( 'remove', () => { it( 'should remove nodes in given range', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - utils.remove( range ); + utils._remove( range ); expectData( 'fooxyz' ); } ); it( 'should split text node if range starts or ends inside text node', () => { const range = Range.createFromParentsAndOffsets( root, 1, root, 5 ); - utils.remove( range ); + utils._remove( range ); expectData( 'f<$text bold="true">rxyz' ); } ); it( 'should merge text nodes if possible', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 7 ); - utils.remove( range ); + utils._remove( range ); expectData( 'fooxyz' ); expect( root.childCount ).to.equal( 1 ); @@ -81,7 +81,7 @@ describe( 'writer utils', () => { it( 'should throw if given range is not flat', () => { expect( () => { - utils.remove( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ) ); + utils._remove( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ) ); } ).to.throw( CKEditorError, /operation-utils-remove-range-not-flat/ ); } ); } ); @@ -89,21 +89,21 @@ describe( 'writer utils', () => { describe( 'move', () => { it( 'should move a range of nodes', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - utils.move( range, Position.createAt( root, 0 ) ); + utils._move( range, Position.createAt( root, 0 ) ); expectData( '<$text bold="true">barfooxyz' ); } ); it( 'should correctly move if target position is in same element as moved range, but after range', () => { const range = Range.createFromParentsAndOffsets( root, 3, root, 6 ); - utils.move( range, Position.createAt( root, 10 ) ); + utils._move( range, Position.createAt( root, 10 ) ); expectData( 'fooxyz<$text bold="true">bar' ); } ); it( 'should throw if given range is not flat', () => { expect( () => { - utils.move( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ), null ); + utils._move( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1, 2 ] ) ), null ); } ).to.throw( CKEditorError, /operation-utils-move-range-not-flat/ ); } ); } ); @@ -111,21 +111,21 @@ describe( 'writer utils', () => { describe( 'setAttribute', () => { it( 'should set attribute on given range of nodes', () => { const range = Range.createFromParentsAndOffsets( root, 6, root, 8 ); - utils.setAttribute( range, 'newAttr', true ); + utils._setAttribute( range, 'newAttr', true ); expectData( 'foo<$text bold="true">bar<$text newAttr="true">xyz' ); } ); it( 'should remove attribute if null was passed as a value', () => { const range = Range.createFromParentsAndOffsets( root, 6, root, 7 ); - utils.setAttribute( range, 'src', null ); + utils._setAttribute( range, 'src', null ); expectData( 'foo<$text bold="true">barxyz' ); } ); it( 'should merge nodes if possible', () => { const range = Range.createFromParentsAndOffsets( root, 0, root, 3 ); - utils.setAttribute( range, 'bold', true ); + utils._setAttribute( range, 'bold', true ); expectData( '<$text bold="true">foobarxyz' ); } ); @@ -136,11 +136,11 @@ describe( 'normalizeNodes', () => { it( 'should change single object into an array', () => { const p = new Element( 'p' ); - expect( utils.normalizeNodes( p ) ).to.deep.equal( [ p ] ); + expect( utils._normalizeNodes( p ) ).to.deep.equal( [ p ] ); } ); it( 'should change strings to text nodes', () => { - const text = utils.normalizeNodes( 'abc' )[ 0 ]; + const text = utils._normalizeNodes( 'abc' )[ 0 ]; expect( text ).to.be.instanceof( Text ); expect( text.data ).to.equal( 'abc' ); @@ -150,7 +150,7 @@ describe( 'normalizeNodes', () => { const textNode = new Text( 'abc' ); const textProxy = new TextProxy( textNode, 1, 1 ); - const text = utils.normalizeNodes( textProxy )[ 0 ]; + const text = utils._normalizeNodes( textProxy )[ 0 ]; expect( text ).to.be.instanceof( Text ); expect( text.data ).to.equal( 'b' ); @@ -159,11 +159,11 @@ describe( 'normalizeNodes', () => { it( 'should not change elements', () => { const p = new Element( 'p' ); - expect( utils.normalizeNodes( p )[ 0 ] ).to.equal( p ); + expect( utils._normalizeNodes( p )[ 0 ] ).to.equal( p ); } ); it( 'should omit unrecognized objects', () => { - expect( utils.normalizeNodes( 1 ) ).to.deep.equal( [] ); + expect( utils._normalizeNodes( 1 ) ).to.deep.equal( [] ); } ); it( 'should accept arrays', () => { @@ -171,7 +171,7 @@ describe( 'normalizeNodes', () => { const image = new Element( 'image' ); const nodes = [ 'abc', text, image, 1, 'xyz' ]; - const normalized = utils.normalizeNodes( nodes ); + const normalized = utils._normalizeNodes( nodes ); expect( normalized[ 0 ] ).to.be.instanceof( Text ); expect( normalized[ 1 ] ).to.equal( text ); @@ -180,7 +180,7 @@ describe( 'normalizeNodes', () => { } ); it( 'should merge text nodes if mergeTextNodes flag is set to true', () => { - const normalized = utils.normalizeNodes( [ 'foo', 'bar' ], true ); + const normalized = utils._normalizeNodes( [ 'foo', 'bar' ], true ); expect( normalized.length ).to.equal( 1 ); expect( normalized[ 0 ].data ).to.equal( 'foobar' ); @@ -193,7 +193,7 @@ describe( 'normalizeNodes', () => { 'xyz' ]; - const normalized = utils.normalizeNodes( nodes, true ); + const normalized = utils._normalizeNodes( nodes, true ); expect( normalized[ 0 ] ).to.be.instanceof( Text ); expect( normalized[ 0 ].getAttribute( 'bold' ) ).to.be.true; From c7a0fc51316d5b6c65ffe392f01a4bb1318d0a5d Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 1 Dec 2017 13:59:58 +0100 Subject: [PATCH 098/724] Introduce model class. --- src/model/document.js | 91 +++++++++--------------- src/model/model.js | 98 +++++++++++++++++++++++++ tests/model/model.js | 161 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 291 insertions(+), 59 deletions(-) create mode 100644 src/model/model.js create mode 100644 tests/model/model.js diff --git a/src/model/document.js b/src/model/document.js index 4d023e4d9..4f2cddbb4 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -14,12 +14,9 @@ import './delta/basic-transformations'; import Range from './range'; import Position from './position'; import RootElement from './rootelement'; -import Batch from './batch'; import History from './history'; import DocumentSelection from './documentselection'; -import Schema from './schema'; import TreeWalker from './treewalker'; -import MarkerCollection from './markercollection'; import deltaTransform from './delta/transform'; import clone from '@ckeditor/ckeditor5-utils/src/lib/lodash/clone'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; @@ -49,7 +46,10 @@ export default class Document { * Creates an empty document instance with no {@link #roots} (other than * the {@link #graveyard graveyard root}). */ - constructor() { + constructor( model ) { + + this.model = model; + /** * Document version. It starts from `0` and every operation increases the version number. It is used to ensure that * operations are applied on the proper document version. @@ -61,13 +61,6 @@ export default class Document { */ this.version = 0; - /** - * Schema for this document. - * - * @member {module:engine/model/schema~Schema} - */ - this.schema = new Schema(); - /** * Document's history. * @@ -78,14 +71,6 @@ export default class Document { */ this.history = new History( this ); - /** - * Document's markers' collection. - * - * @readonly - * @member {module:engine/model/markercollection~MarkerCollection} - */ - this.markers = new MarkerCollection(); - /** * Selection done on this document. * @@ -94,14 +79,6 @@ export default class Document { */ this.selection = new DocumentSelection( this ); - /** - * Array of pending changes. See: {@link #enqueueChanges}. - * - * @private - * @member {Array.} - */ - this._pendingChanges = []; - /** * List of roots that are owned and managed by this document. Use {@link #createRoot} and * {@link #getRoot} to manipulate it. @@ -130,6 +107,32 @@ export default class Document { // Graveyard tree root. Document always have a graveyard root, which stores removed nodes. this.createRoot( '$root', graveyardName ); + + this.listenTo( model, 'applyOperation', () => { + const operation = args[ 0 ]; + + if ( operation.isDocumentOperation && operation.baseVersion !== this.version ) { + /** + * Only operations with matching versions can be applied. + * + * @error document-applyOperation-wrong-version + * @param {module:engine/model/operation/operation~Operation} operation + */ + throw new CKEditorError( + 'model-document-applyOperation-wrong-version: Only operations with matching versions can be applied.', + { operation } ); + } + }, { priority: 'high' } ); + + this.listenTo( model, 'applyOperation', ( evt, args ) => { + const operation = args[ 0 ]; + + if ( operation.isDocumentOperation ) { + this.version++; + this.history.addDelta( operation.delta ); + this.fire( 'change', operation.type, evt.return, operation.delta.batch, operation.delta.type ); + } + }, { priority: 'low' } ); } /** @@ -142,36 +145,6 @@ export default class Document { return this.getRoot( graveyardName ); } - /** - * This is the entry point for all document changes. All changes on the document are done using - * {@link module:engine/model/operation/operation~Operation operations}. To create operations in the simple way use the - * {@link module:engine/model/batch~Batch} API available via {@link #batch} method. - * - * @fires event:change - * @param {module:engine/model/operation/operation~Operation} operation Operation to be applied. - */ - applyOperation( operation ) { - if ( operation.baseVersion !== this.version ) { - /** - * Only operations with matching versions can be applied. - * - * @error document-applyOperation-wrong-version - * @param {module:engine/model/operation/operation~Operation} operation - */ - throw new CKEditorError( - 'model-document-applyOperation-wrong-version: Only operations with matching versions can be applied.', - { operation } ); - } - - const changes = operation._execute(); - - if ( operation.isDocumentOperation ) { - this.version++; - this.history.addDelta( operation.delta ); - this.fire( 'change', operation.type, changes, operation.delta.batch, operation.delta.type ); - } - } - /** * Creates a {@link module:engine/model/batch~Batch} instance which allows to change the document. * @@ -499,7 +472,7 @@ function* combineWalkers( backward, forward ) { if ( !step.done ) { done = false; - yield{ + yield { walker: backward, value: step.value }; @@ -511,7 +484,7 @@ function* combineWalkers( backward, forward ) { if ( !step.done ) { done = false; - yield{ + yield { walker: forward, value: step.value }; diff --git a/src/model/model.js b/src/model/model.js new file mode 100644 index 000000000..316c5fee8 --- /dev/null +++ b/src/model/model.js @@ -0,0 +1,98 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/model + */ + +import Batch from './batch'; +import Schema from './schema'; +import Document from './document'; +import MarkerCollection from './markercollection'; +import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; +import mix from '@ckeditor/ckeditor5-utils/src/mix'; + +export default class Model { + constructor() { + this._pendingChanges = []; + + this.document = new Document( this ); + + /** + * Schema for this document. + * + * @member {module:engine/model/schema~Schema} + */ + this.schema = new Schema(); + + /** + * Document's markers' collection. + * + * @readonly + * @member {module:engine/model/markercollection~MarkerCollection} + */ + this.markers = new MarkerCollection(); + + this.decorate( 'applyOperation' ); + } + + change( callback ) { + if ( arguments.length != 1 ) { + throw new CKEditorError( 'model-enqueueChange-two-arguments: Model.enqueueChange expect 1 argument.' ); + } + + if ( this._pendingChanges.length === 0 ) { + this._pendingChanges.push( { batch: new Batch(), callback } ); + + return this._runPendingChanges()[ 0 ]; + } else { + return callback( this._currentWriter ); + } + } + + enqueueChange( batch, callback ) { + if ( arguments.length != 2 ) { + throw new CKEditorError( 'model-enqueueChange-two-arguments: Model.enqueueChange expect 2 arguments.' ); + } + + this._pendingChanges.push( { batch, callback } ); + + if ( this._pendingChanges.length == 1 ) { + this._runPendingChanges(); + + this.fire( 'changesDone' ); + } + } + + _runPendingChanges() { + const ret = []; + + while ( this._pendingChanges.length ) { + this._currentWriter = this._pendingChanges[ 0 ].batch; + + ret.push( this._pendingChanges[ 0 ].callback( this._currentWriter ) ); + + this.fire( 'change' ); + + this._pendingChanges.shift(); + + this._currentWriter = null; + } + + this.fire( 'changesDone' ); + + return ret; + } + + applyOperation( operation ) { + return operation._execute(); + } + + transformDeltas() { + // ... + } +} + +mix( Model, ObservableMixin ); diff --git a/tests/model/model.js b/tests/model/model.js new file mode 100644 index 000000000..432b6872d --- /dev/null +++ b/tests/model/model.js @@ -0,0 +1,161 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import Model from '../../src/model/model'; +import Batch from '../../src/model/batch'; + +describe( 'Model', () => { + let model; + let changes = ''; + + beforeEach( () => { + model = new Model(); + changes = ''; + } ); + + describe( 'change & enqueueChange', () => { + it( 'should execute changes immediately', () => { + model.change( () => { + changes += 'A'; + } ); + + expect( changes ).to.equal( 'A' ); + } ); + + it( 'should pass returned value', () => { + const ret = model.change( () => { + changes += 'A'; + + return 'B'; + } ); + + changes += ret; + + expect( changes ).to.equal( 'AB' ); + } ); + + it( 'should not mixed the order when nested change is called', () => { + const ret = model.change( () => { + changes += 'A'; + + nested(); + + return 'D'; + } ); + + changes += ret; + + expect( changes ).to.equal( 'ABCD' ); + + function nested() { + const ret = model.change( () => { + changes += 'B'; + + return 'C'; + } ); + + changes += ret; + } + } ); + + it( 'should execute enqueueChanges immediately if its the first block', () => { + model.enqueueChange( new Batch(), () => { + changes += 'A'; + + nested(); + } ); + + expect( changes ).to.equal( 'ABC' ); + + function nested() { + const ret = model.change( () => { + changes += 'B'; + + return 'C'; + } ); + + changes += ret; + } + } ); + + it( 'should be possible to enqueueChanges immediately if its the first block', () => { + model.enqueueChange( new Batch(), () => { + changes += 'A'; + + nested(); + } ); + + expect( changes ).to.equal( 'AB' ); + + function nested() { + const ret = model.change( () => { + changes += 'B'; + } ); + } + } ); + + it( 'should be possible to nest change in enqueueChanges', () => { + model.enqueueChange( new Batch(), () => { + changes += 'A'; + + nested(); + + changes += 'D'; + } ); + + expect( changes ).to.equal( 'ABCD' ); + + function nested() { + const ret = model.change( () => { + changes += 'B'; + + return 'C'; + } ); + + changes += ret; + } + } ); + + it( 'should be possible to nest enqueueChanges in enqueueChanges', () => { + model.enqueueChange( new Batch(), () => { + changes += 'A'; + + nestedEnqueue(); + + changes += 'B'; + } ); + + expect( changes ).to.equal( 'ABC' ); + + function nestedEnqueue() { + model.enqueueChange( new Batch(), () => { + changes += 'C'; + } ); + } + } ); + + it( 'should be possible to nest enqueueChanges in changes', () => { + const ret = model.change( () => { + changes += 'A'; + + nestedEnqueue(); + + changes += 'B'; + + return 'D'; + } ); + + changes += ret; + + expect( changes ).to.equal( 'ABCD' ); + + function nestedEnqueue() { + model.enqueueChange( new Batch(), () => { + changes += 'C'; + } ); + } + } ); + } ); +} ); From ef5fa3a28c71b88058d9021f1ca036a3b6c347b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Fri, 1 Dec 2017 14:00:42 +0100 Subject: [PATCH 099/724] Internal: Upgraded eslint-config-ckeditor5. [skip ci] --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9dc227c18..6f2518984 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "@ckeditor/ckeditor5-undo": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-widget": "^1.0.0-alpha.2", "eslint": "^4.8.0", - "eslint-config-ckeditor5": "^1.0.6", + "eslint-config-ckeditor5": "^1.0.7", "husky": "^0.14.3", "lint-staged": "^4.2.3" }, From 5bbf541e21ca4eefb96f5ae34a83997c43a0efec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Fri, 1 Dec 2017 14:04:32 +0100 Subject: [PATCH 100/724] Internal: Fixed code style after upgrading eslint-config-ckeditor5. --- src/model/document.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index 4d023e4d9..7d8408849 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -499,7 +499,7 @@ function* combineWalkers( backward, forward ) { if ( !step.done ) { done = false; - yield{ + yield { walker: backward, value: step.value }; @@ -511,7 +511,7 @@ function* combineWalkers( backward, forward ) { if ( !step.done ) { done = false; - yield{ + yield { walker: forward, value: step.value }; From b45e8159ef589ded6aed66acff546443cd81789f Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 1 Dec 2017 14:34:22 +0100 Subject: [PATCH 101/724] Use model instead of the document in controllers. --- src/controller/datacontroller.js | 16 ++++++++-------- src/controller/editingcontroller.js | 16 ++++++++-------- src/model/document.js | 13 +------------ src/model/model.js | 3 ++- 4 files changed, 19 insertions(+), 29 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 45d3a8c9c..71f539460 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -44,15 +44,15 @@ export default class DataController { /** * Creates data controller instance. * - * @param {module:engine/model/document~Document} model Document model. + * @param {module:engine/model/model~Model} model Data model. * @param {module:engine/dataprocessor/dataprocessor~DataProcessor} [dataProcessor] Data processor which should used by the controller. */ constructor( model, dataProcessor ) { /** - * Document model. + * Data model. * * @readonly - * @member {module:engine/model/document~Document} + * @member {module:engine/model/model~Model} */ this.model = model; @@ -86,7 +86,7 @@ export default class DataController { * @readonly * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} */ - this.modelToView = new ModelConversionDispatcher( this.model, { + this.modelToView = new ModelConversionDispatcher( this.model.document, { mapper: this.mapper } ); this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } ); @@ -130,7 +130,7 @@ export default class DataController { */ get( rootName = 'main' ) { // Get model range. - return this.stringify( this.model.getRoot( rootName ) ); + return this.stringify( this.model.document.getRoot( rootName ) ); } /** @@ -186,13 +186,13 @@ export default class DataController { */ set( data, rootName = 'main' ) { // Save to model. - const modelRoot = this.model.getRoot( rootName ); + const modelRoot = this.model.document.getRoot( rootName ); this.model.enqueueChanges( () => { // Clearing selection is a workaround for ticket #569 (LiveRange loses position after removing data from document). // After fixing it this code should be removed. - this.model.selection.removeAllRanges(); - this.model.selection.clearAttributes(); + this.model.document.selection.removeAllRanges(); + this.model.document.selection.clearAttributes(); // Initial batch should be ignored by features like undo, etc. const batch = this.model.batch( 'transparent' ); diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index a2082567c..219595139 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -36,14 +36,14 @@ export default class EditingController { /** * Creates editing controller instance. * - * @param {module:engine/model/document~Document} model Document model. + * @param {module:engine/model/model~Model} model Editing model. */ constructor( model ) { /** - * Document model. + * Editing model. * * @readonly - * @member {module:engine/model/document~Document} + * @member {module:engine/model/model~Model} */ this.model = model; @@ -78,18 +78,18 @@ export default class EditingController { * @readonly * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} #modelToView */ - this.modelToView = new ModelConversionDispatcher( this.model, { + this.modelToView = new ModelConversionDispatcher( this.model.document, { mapper: this.mapper, viewSelection: this.view.selection } ); // Convert changes in model to view. - this.listenTo( this.model, 'change', ( evt, type, changes ) => { + this.listenTo( this.model.document, 'change', ( evt, type, changes ) => { this.modelToView.convertChange( type, changes ); }, { priority: 'low' } ); // Convert model selection to view. - this.listenTo( this.model, 'changesDone', () => { + this.listenTo( this.model.document, 'changesDone', () => { const selection = this.model.selection; this.modelToView.convertSelection( selection ); @@ -106,7 +106,7 @@ export default class EditingController { } ); // Convert view selection to model. - this.listenTo( this.view, 'selectionChange', convertSelectionChange( this.model, this.mapper ) ); + this.listenTo( this.view, 'selectionChange', convertSelectionChange( this.model.document, this.mapper ) ); // Attach default content converters. this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } ); @@ -139,7 +139,7 @@ export default class EditingController { */ createRoot( domRoot, name = 'main' ) { const viewRoot = this.view.createRoot( domRoot, name ); - const modelRoot = this.model.getRoot( name ); + const modelRoot = this.model.document.getRoot( name ); this.mapper.bindElements( modelRoot, viewRoot ); diff --git a/src/model/document.js b/src/model/document.js index 4f2cddbb4..b3842106c 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -47,7 +47,6 @@ export default class Document { * the {@link #graveyard graveyard root}). */ constructor( model ) { - this.model = model; /** @@ -108,7 +107,7 @@ export default class Document { // Graveyard tree root. Document always have a graveyard root, which stores removed nodes. this.createRoot( '$root', graveyardName ); - this.listenTo( model, 'applyOperation', () => { + this.listenTo( model, 'applyOperation', ( evt, args ) => { const operation = args[ 0 ]; if ( operation.isDocumentOperation && operation.baseVersion !== this.version ) { @@ -145,16 +144,6 @@ export default class Document { return this.getRoot( graveyardName ); } - /** - * Creates a {@link module:engine/model/batch~Batch} instance which allows to change the document. - * - * @param {String} [type] Batch type. See {@link module:engine/model/batch~Batch#type}. - * @returns {module:engine/model/batch~Batch} Batch instance. - */ - batch( type ) { - return new Batch( this, type ); - } - /** * Creates a new top-level root. * diff --git a/src/model/model.js b/src/model/model.js index 316c5fee8..9bb2e502e 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -4,13 +4,14 @@ */ /** - * @module engine/model + * @module engine/model/model */ import Batch from './batch'; import Schema from './schema'; import Document from './document'; import MarkerCollection from './markercollection'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; From 0a7e6e214bd8688cca8ad8c0d72f610365b27101 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 1 Dec 2017 15:25:14 +0100 Subject: [PATCH 102/724] Update usage of the new API in data controller. Make batch a optional parameter in enqueueChange. --- src/controller/datacontroller.js | 37 +++++++++++------------------ src/controller/editingcontroller.js | 2 +- src/model/model.js | 15 +++++++----- 3 files changed, 24 insertions(+), 30 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 71f539460..af2f4cea8 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -86,7 +86,7 @@ export default class DataController { * @readonly * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} */ - this.modelToView = new ModelConversionDispatcher( this.model.document, { + this.modelToView = new ModelConversionDispatcher( this.model, { mapper: this.mapper } ); this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } ); @@ -188,17 +188,14 @@ export default class DataController { // Save to model. const modelRoot = this.model.document.getRoot( rootName ); - this.model.enqueueChanges( () => { + this.model.enqueueChanges( 'transparent', writer => { // Clearing selection is a workaround for ticket #569 (LiveRange loses position after removing data from document). // After fixing it this code should be removed. this.model.document.selection.removeAllRanges(); this.model.document.selection.clearAttributes(); - // Initial batch should be ignored by features like undo, etc. - const batch = this.model.batch( 'transparent' ); - - batch.remove( ModelRange.createIn( modelRoot ) ); - batch.insert( this.parse( data, batch ), modelRoot ); + writer.remove( ModelRange.createIn( modelRoot ) ); + writer.insert( this.parse( data ), modelRoot ); } ); } @@ -208,17 +205,16 @@ export default class DataController { * * @see #set * @param {String} data Data to parse. - * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {String} [context='$root'] Base context in which the view will be converted to the model. See: * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#convert}. * @returns {module:engine/model/documentfragment~DocumentFragment} Parsed data. */ - parse( data, batch, context = '$root' ) { + parse( data, context = '$root' ) { // data -> view const viewDocumentFragment = this.processor.toView( data ); // view -> model - return this.toModel( viewDocumentFragment, batch, context ); + return this.toModel( viewDocumentFragment, context ); } /** @@ -232,13 +228,12 @@ export default class DataController { * * @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} viewElementOrFragment * Element or document fragment which content will be converted. - * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {String} [context='$root'] Base context in which the view will be converted to the model. See: * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher#convert}. * @returns {module:engine/model/documentfragment~DocumentFragment} Output document fragment. */ - toModel( viewElementOrFragment, batch, context = '$root' ) { - return this.viewToModel.convert( viewElementOrFragment, batch, { context: [ context ] } ); + toModel( viewElementOrFragment, context = '$root' ) { + return this.viewToModel.convert( viewElementOrFragment, { context: [ context ] } ); } /** @@ -252,11 +247,9 @@ export default class DataController { * @fires insertContent * @param {module:engine/model/documentfragment~DocumentFragment|module:engine/model/item~Item} content The content to insert. * @param {module:engine/model/selection~Selection} selection Selection into which the content should be inserted. - * @param {module:engine/model/batch~Batch} [batch] Batch to which deltas will be added. If not specified, then - * changes will be added to a new batch. */ - insertContent( content, selection, batch ) { - insertContent( this, content, selection, batch ); + insertContent( content, selection ) { + insertContent( this, content, selection ); } /** @@ -272,11 +265,10 @@ export default class DataController { * * @fires deleteContent * @param {module:engine/model/selection~Selection} selection Selection of which the content should be deleted. - * @param {module:engine/model/batch~Batch} batch Batch to which deltas will be added. * @param {Object} options See {@link module:engine/controller/deletecontent~deleteContent}'s options. */ - deleteContent( selection, batch, options ) { - deleteContent( selection, batch, options ); + deleteContent( selection, options ) { + deleteContent( selection, options ); } /** @@ -295,11 +287,10 @@ export default class DataController { * * @fires module:engine/controller/datacontroller~DataController#getSelectedContent * @param {module:engine/model/selection~Selection} selection The selection of which content will be retrieved. - * @param {module:engine/model/batch~Batch} batch Batch to which deltas will be added. * @returns {module:engine/model/documentfragment~DocumentFragment} Document fragment holding the clone of the selected content. */ - getSelectedContent( selection, batch ) { - return getSelectedContent( selection, batch ); + getSelectedContent( selection ) { + return getSelectedContent( selection ); } /** diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 219595139..17ee2b1f0 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -78,7 +78,7 @@ export default class EditingController { * @readonly * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} #modelToView */ - this.modelToView = new ModelConversionDispatcher( this.model.document, { + this.modelToView = new ModelConversionDispatcher( this.model, { mapper: this.mapper, viewSelection: this.view.selection } ); diff --git a/src/model/model.js b/src/model/model.js index 9bb2e502e..06526373d 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -40,10 +40,6 @@ export default class Model { } change( callback ) { - if ( arguments.length != 1 ) { - throw new CKEditorError( 'model-enqueueChange-two-arguments: Model.enqueueChange expect 1 argument.' ); - } - if ( this._pendingChanges.length === 0 ) { this._pendingChanges.push( { batch: new Batch(), callback } ); @@ -54,8 +50,11 @@ export default class Model { } enqueueChange( batch, callback ) { - if ( arguments.length != 2 ) { - throw new CKEditorError( 'model-enqueueChange-two-arguments: Model.enqueueChange expect 2 arguments.' ); + if ( typeof batch === 'string' ) { + batch = this.batch( batch ); + } else if ( typeof batch == 'function' ) { + callback = batch; + batch = this.batch(); } this._pendingChanges.push( { batch, callback } ); @@ -87,6 +86,10 @@ export default class Model { return ret; } + batch( type ) { + return new Batch( type ); + } + applyOperation( operation ) { return operation._execute(); } From 8edd0f37e8a43bdded4616f0fea2c481820bc235 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 1 Dec 2017 15:42:05 +0100 Subject: [PATCH 103/724] Splited Batch to Writer and Batch. --- src/model/batch.js | 884 +------------------ src/model/document.js | 2 +- src/model/writer.js | 913 ++++++++++++++++++++ tests/model/batch.js | 1884 +---------------------------------------- tests/model/writer.js | 1799 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 2729 insertions(+), 2753 deletions(-) create mode 100644 src/model/writer.js create mode 100644 tests/model/writer.js diff --git a/src/model/batch.js b/src/model/batch.js index 94ea16f91..07b4e7196 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -7,41 +7,8 @@ * @module engine/model/batch */ -import AttributeDelta from './delta/attributedelta'; -import InsertDelta from './delta/insertdelta'; -import MarkerDelta from './delta/markerdelta'; -import MergeDelta from './delta/mergedelta'; -import MoveDelta from './delta/movedelta'; -import RemoveDelta from './delta/removedelta'; -import RenameDelta from './delta/renamedelta'; -import RootAttributeDelta from './delta/rootattributedelta'; -import SplitDelta from './delta/splitdelta'; -import UnwrapDelta from './delta/unwrapdelta'; -import WeakInsertDelta from './delta/weakinsertdelta'; -import WrapDelta from './delta/wrapdelta'; - -import AttributeOperation from './operation/attributeoperation'; -import DetachOperation from './operation/detachoperation'; -import InsertOperation from './operation/insertoperation'; -import MarkerOperation from './operation/markeroperation'; -import MoveOperation from './operation/moveoperation'; -import RemoveOperation from './operation/removeoperation'; -import RenameOperation from './operation/renameoperation'; -import RootAttributeOperation from './operation/rootattributeoperation'; - -import DocumentFragment from './documentfragment'; -import Text from './text'; -import Element from './element'; -import RootElement from './rootelement'; -import Position from './position'; -import Range from './range.js'; - -import toMap from '@ckeditor/ckeditor5-utils/src/tomap'; - -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; - /** - * `Batch` instance groups document changes ({@link module:engine/model/delta/delta~Delta deltas}). All deltas grouped in a single `Batch` + * `Batch` instance groups model changes ({@link module:engine/model/delta/delta~Delta deltas}). All deltas grouped in a single `Batch` * can be reverted together, so you can think about `Batch` as of a single undo step. If you want to extend given undo step you * can call another method on the same `Batch` object. If you want to create a separate undo step you can create a new `Batch`. * @@ -59,25 +26,17 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; */ export default class Batch { /** - * Creates `Batch` instance. Not recommended to use directly, use {@link module:engine/model/document~Document#batch} instead. + * Creates `Batch` instance. Not recommended to use directly, use {@link module:engine/model~model#change} or + * {@link module:engine/model~model#enqueueChanges} instead. * - * @param {module:engine/model/document~Document} document Document which this Batch changes. * @param {'transparent'|'default'} [type='default'] Type of the batch. */ - constructor( document, type = 'default' ) { - /** - * Document which this batch changes. - * - * @readonly - * @member {module:engine/model/document~Document} module:engine/model/batch~Batch#document - */ - this.document = document; - + constructor( type = 'default' ) { /** * Array of deltas which compose this batch. * * @readonly - * @member {Array.} module:engine/model/batch~Batch#deltas + * @type {Array.} */ this.deltas = []; @@ -89,7 +48,7 @@ export default class Batch { * * `'transparent'` - batch that should be ignored by other features, i.e. initial batch or collaborative editing changes. * * @readonly - * @member {'transparent'|'default'} module:engine/model/batch~Batch#type + * @type {'transparent'|'default'} */ this.type = type; } @@ -129,835 +88,4 @@ export default class Batch { yield* delta.operations; } } - - /** - * Creates a new {@link module:engine/model/text~Text text node}. - * - * batch.createText( 'foo' ); - * batch.createText( 'foo', { 'bold': true } ); - * - * @param {String} data Text data. - * @param {Object} [attributes] Text attributes. - * @returns {module:engine/model/text~Text} Created text node. - */ - createText( data, attributes ) { - return new Text( data, attributes ); - } - - /** - * Creates a new {@link module:engine/model/element~Element element}. - * - * batch.createElement( 'paragraph' ); - * batch.createElement( 'paragraph', { 'alignment': 'center' } ); - * - * @param {String} name Name of the element. - * @param {Object} [attributes] Elements attributes. - * @returns {module:engine/model/element~Element} Created element. - */ - createElement( name, attributes ) { - return new Element( name, attributes ); - } - - /** - * Creates a new {@link module:engine/model/documentfragment~DocumentFragment document fragment}. - * - * @returns {module:engine/model/documentfragment~DocumentFragment} Created document fragment. - */ - createDocumentFragment() { - return new DocumentFragment(); - } - - /** - * Inserts item on given position. - * - * const paragraph = batch.createElement( 'paragraph' ); - * batch.insert( paragraph, position ); - * - * Instead of using position you can use parent and offset: - * - * const text = batch.createText( 'foo' ); - * batch.insert( text, paragraph, 5 ); - * - * You can also use `end` instead of the offset to insert at the end: - * - * const text = batch.createText( 'foo' ); - * batch.insert( text, paragraph, 'end' ); - * - * Or insert before or after another element: - * - * const paragraph = batch.createElement( 'paragraph' ); - * batch.insert( paragraph, anotherParagraph, 'after' ); - * - * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. - * - * Note that if the item already has parent it will be removed from the previous parent. - * - * If you want to move {@link module:engine/model/range~Range range} instead of an - * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. - * - * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} - * item Item or document fragment to insert. - * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition - * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when - * second parameter is a {@link module:engine/model/item~Item model item}. - */ - insert( item, itemOrPosition, offset ) { - const position = Position.createAt( itemOrPosition, offset ); - - // For text that has no parent we need to make a WeakInsert. - const delta = item instanceof Text && !item.parent ? new WeakInsertDelta() : new InsertDelta(); - - // If item has a parent already. - if ( item.parent ) { - // We need to check if item is going to be inserted within the same document. - if ( isSameTree( item.root, position.root ) ) { - // If it's we just need to move it. - this.move( Range.createOn( item ), position ); - - return; - } - // If it isn't the same root. - else { - // We need to remove this item from old position first. - this.remove( item ); - } - } - - const insert = new InsertOperation( position, item, this.document.version ); - - this.addDelta( delta ); - delta.addOperation( insert ); - this.document.applyOperation( insert ); - - // When element is a DocumentFragment we need to move its markers to Document#markers. - if ( item instanceof DocumentFragment ) { - for ( const [ markerName, markerRange ] of item.markers ) { - // We need to migrate marker range from DocumentFragment to Document. - const rangeRootPosition = Position.createAt( markerRange.root ); - const range = new Range( - markerRange.start._getCombined( rangeRootPosition, position ), - markerRange.end._getCombined( rangeRootPosition, position ) - ); - - this.setMarker( markerName, range ); - } - } - } - - /** - * Creates and inserts text on given position. You can optionally set text attributes: - * - * batch.insertText( 'foo', position ); - * batch.insertText( 'foo', { 'bold': true }, position ); - * - * Instead of using position you can use parent and offset or define that text should be inserted at the end - * or before or after other node: - * - * batch.insertText( 'foo', paragraph, 5 ); // inserts in paragraph, at offset 5 - * batch.insertText( 'foo', paragraph, 'end' ); // inserts at the end of the paragraph - * batch.insertText( 'foo', image, 'after' ); // inserts after image - * - * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. - * - * @param {String} data Text data. - * @param {Object} [attributes] Text attributes. - * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition - * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when - * third parameter is a {@link module:engine/model/item~Item model item}. - */ - insertText( text, attributes, itemOrPosition, offset ) { - if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { - this.insert( this.createText( text ), attributes, itemOrPosition ); - } else { - this.insert( this.createText( text, attributes ), itemOrPosition, offset ); - } - } - - /** - * Creates and inserts element on given position. You can optionally set attributes: - * - * batch.insertElement( 'paragraph', position ); - * batch.insertElement( 'paragraph', { 'alignment': 'center' }, position ); - * - * Instead of using position you can use parent and offset or define that text should be inserted at the end - * or before or after other node: - * - * batch.insertElement( 'paragraph', paragraph, 5 ); // inserts in paragraph, at offset 5 - * batch.insertElement( 'paragraph', blockquote, 'end' ); // insets at the end of the blockquote - * batch.insertElement( 'paragraph', image, 'after' ); // inserts after image - * - * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. - * - * @param {String} name Name of the element. - * @param {Object} [attributes] Elements attributes. - * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition - * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when - * third parameter is a {@link module:engine/model/item~Item model item}. - */ - insertElement( name, attributes, itemOrPosition, offset ) { - if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { - this.insert( this.createElement( name ), attributes, itemOrPosition ); - } else { - this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); - } - } - - /** - * Inserts item at the end of the given parent. - * - * const paragraph = batch.createElement( 'paragraph' ); - * batch.append( paragraph, root ); - * - * Note that if the item already has parent it will be removed from the previous parent. - * - * If you want to move {@link module:engine/model/range~Range range} instead of an - * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. - * - * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} - * item Item or document fragment to insert. - * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent - */ - append( item, parent ) { - this.insert( item, parent, 'end' ); - } - - /** - * Creates text node and inserts it at the end of the parent. You can optionally set text attributes: - * - * batch.appendText( 'foo', paragraph ); - * batch.appendText( 'foo', { 'bold': true }, paragraph ); - * - * @param {String} text Text data. - * @param {Object} [attributes] Text attributes. - * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent - */ - appendText( text, attributes, parent ) { - if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { - this.insert( this.createText( text ), attributes, 'end' ); - } else { - this.insert( this.createText( text, attributes ), parent, 'end' ); - } - } - - /** - * Creates element and inserts it at the end of the parent. You can optionally set attributes: - * - * batch.appendElement( 'paragraph', root ); - * batch.appendElement( 'paragraph', { 'alignment': 'center' }, root ); - * - * @param {String} name Name of the element. - * @param {Object} [attributes] Elements attributes. - * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent - */ - appendElement( name, attributes, parent ) { - if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { - this.insert( this.createElement( name ), attributes, 'end' ); - } else { - this.insert( this.createElement( name, attributes ), parent, 'end' ); - } - } - - /** - * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} - * or on a {@link module:engine/model/range~Range range}. - * - * @param {String} key Attribute key. - * @param {*} value Attribute new value. - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range on which the attribute will be set. - */ - setAttribute( key, value, itemOrRange ) { - if ( itemOrRange instanceof Range ) { - setAttributeToRange( this, key, value, itemOrRange ); - } else { - setAttributeToItem( this, key, value, itemOrRange ); - } - } - - /** - * Sets values of attributes on a {@link module:engine/model/item~Item model item} - * or on a {@link module:engine/model/range~Range range}. - * - * batch.setAttributes( { - * 'bold': true, - * 'italic': true - * }, range ); - * - * @param {Object} attributes Attributes keys and values. - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range on which the attributes will be set. - */ - setAttributes( attributes, itemOrRange ) { - for ( const [ key, val ] of toMap( attributes ) ) { - this.setAttribute( key, val, itemOrRange ); - } - } - - /** - * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} - * or from a {@link module:engine/model/range~Range range}. - * - * @param {String} key Attribute key. - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range from which the attribute will be removed. - */ - removeAttribute( key, itemOrRange ) { - if ( itemOrRange instanceof Range ) { - setAttributeToRange( this, key, null, itemOrRange ); - } else { - setAttributeToItem( this, key, null, itemOrRange ); - } - } - - /** - * Removes all attributes from all elements in the range or from the given item. - * - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange - * Model item or range from which all attributes will be removed. - */ - clearAttributes( itemOrRange ) { - const removeAttributesFromItem = item => { - for ( const attribute of item.getAttributeKeys() ) { - this.removeAttribute( attribute, item ); - } - }; - - if ( !( itemOrRange instanceof Range ) ) { - removeAttributesFromItem( itemOrRange ); - } else { - for ( const item of itemOrRange.getItems() ) { - removeAttributesFromItem( item ); - } - } - } - - /** - * Moves all items in the source range to the target position. - * - * batch.move( sourceRange, targetPosition ); - * - * Instead of the target position you can use parent and offset or define that range should be moved to the end - * or before or after chosen item: - * - * batch.move( sourceRange, paragraph, 5 ); // moves all items in the range to the paragraph at offset 5 - * batch.move( sourceRange, blockquote, 'end' ); // moves all items in the range at the end of the blockquote - * batch.move( sourceRange, image, 'after' ); // moves all items in the range after the image - * - * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. - * - * Note that items can be moved only within the same tree. It means that you can move items within the same root - * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots}, - * but you can not move items from document fragment to the document or from one detached element to another. Use - * {@link module:engine/model/batch~Batch#insert} in such cases. - * - * @param {module:engine/model/range~Range} range Source range. - * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition - * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when - * second parameter is a {@link module:engine/model/item~Item model item}. - */ - move( range, itemOrPosition, offset ) { - if ( !( range instanceof Range ) ) { - /** - * Invalid range to move. - * - * @error batch-move-invalid-range - */ - throw new CKEditorError( 'batch-move-invalid-range: Invalid range to move.' ); - } - - if ( !range.isFlat ) { - /** - * Range to move is not flat. - * - * @error batch-move-range-not-flat - */ - throw new CKEditorError( 'batch-move-range-not-flat: Range to move is not flat.' ); - } - - const position = Position.createAt( itemOrPosition, offset ); - - if ( !isSameTree( range.root, position.root ) ) { - /** - * Range is going to be moved within not the same document. Please use - * {@link module:engine/model/batch~Batch#insert insert} instead. - * - * @error batch-move-different-document - */ - throw new CKEditorError( 'batch-move-different-document: Range is going to be moved between different documents.' ); - } - - const delta = new MoveDelta(); - this.addDelta( delta ); - - const operation = new MoveOperation( range.start, range.end.offset - range.start.offset, position, this.document.version ); - delta.addOperation( operation ); - this.document.applyOperation( operation ); - } - - /** - * Removes given model {@link module:engine/model/item~Item item} or {@link module:engine/model/range~Range range}. - * - * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range to remove. - */ - remove( itemOrRange ) { - const addRemoveDelta = ( position, howMany ) => { - const delta = new RemoveDelta(); - this.addDelta( delta ); - let operation; - - if ( position.root.document ) { - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - operation = new RemoveOperation( position, howMany, gyPosition, this.document.version ); - } else { - operation = new DetachOperation( position, howMany, this.document.version ); - } - - delta.addOperation( operation ); - this.document.applyOperation( operation ); - }; - - if ( itemOrRange instanceof Range ) { - // The array is reversed, so the ranges to remove are in correct order and do not have to be updated. - const ranges = itemOrRange.getMinimalFlatRanges().reverse(); - - for ( const flat of ranges ) { - addRemoveDelta( flat.start, flat.end.offset - flat.start.offset ); - } - } else { - const howMany = itemOrRange.is( 'text' ) ? itemOrRange.offsetSize : 1; - - addRemoveDelta( Position.createBefore( itemOrRange ), howMany ); - } - } - - /** - * Merges two siblings at the given position. - * - * Node before and after the position have to be an element. Otherwise `batch-merge-no-element-before` or - * `batch-merge-no-element-after` error will be thrown. - * - * @param {module:engine/model/position~Position} position Position of merge. - */ - merge( position ) { - const delta = new MergeDelta(); - this.addDelta( delta ); - - const nodeBefore = position.nodeBefore; - const nodeAfter = position.nodeAfter; - - if ( !( nodeBefore instanceof Element ) ) { - /** - * Node before merge position must be an element. - * - * @error batch-merge-no-element-before - */ - throw new CKEditorError( 'batch-merge-no-element-before: Node before merge position must be an element.' ); - } - - if ( !( nodeAfter instanceof Element ) ) { - /** - * Node after merge position must be an element. - * - * @error batch-merge-no-element-after - */ - throw new CKEditorError( 'batch-merge-no-element-after: Node after merge position must be an element.' ); - } - - const positionAfter = Position.createFromParentAndOffset( nodeAfter, 0 ); - const positionBefore = Position.createFromParentAndOffset( nodeBefore, nodeBefore.maxOffset ); - - const move = new MoveOperation( - positionAfter, - nodeAfter.maxOffset, - positionBefore, - this.document.version - ); - - move.isSticky = true; - delta.addOperation( move ); - this.document.applyOperation( move ); - - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - const remove = new RemoveOperation( position, 1, gyPosition, this.document.version ); - delta.addOperation( remove ); - this.document.applyOperation( remove ); - } - - /** - * Renames given element. - * - * @param {module:engine/model/element~Element} element The element to rename. - * @param {String} newName New element name. - */ - rename( element, newName ) { - if ( !( element instanceof Element ) ) { - /** - * Trying to rename an object which is not an instance of Element. - * - * @error batch-rename-not-element-instance - */ - throw new CKEditorError( 'batch-rename-not-element-instance: Trying to rename an object which is not an instance of Element.' ); - } - - const delta = new RenameDelta(); - this.addDelta( delta ); - - const renameOperation = new RenameOperation( Position.createBefore( element ), element.name, newName, this.document.version ); - delta.addOperation( renameOperation ); - this.document.applyOperation( renameOperation ); - } - - /** - * Splits an element at the given position. - * - * The element needs to have a parent. It cannot be a root element nor document fragment. - * The `batch-split-element-no-parent` error will be thrown if you try to split an element with no parent. - * - * @param {module:engine/model/position~Position} position Position of split. - */ - split( position ) { - const delta = new SplitDelta(); - this.addDelta( delta ); - - const splitElement = position.parent; - - if ( !splitElement.parent ) { - /** - * Element with no parent can not be split. - * - * @error batch-split-element-no-parent - */ - throw new CKEditorError( 'batch-split-element-no-parent: Element with no parent can not be split.' ); - } - - const copy = new Element( splitElement.name, splitElement.getAttributes() ); - - const insert = new InsertOperation( - Position.createAfter( splitElement ), - copy, - this.document.version - ); - - delta.addOperation( insert ); - this.document.applyOperation( insert ); - - const move = new MoveOperation( - position, - splitElement.maxOffset - position.offset, - Position.createFromParentAndOffset( copy, 0 ), - this.document.version - ); - move.isSticky = true; - - delta.addOperation( move ); - this.document.applyOperation( move ); - } - - /** - * Wraps given range with given element or with a new element with specified name, if string has been passed. - * - * **Note:** range to wrap should be a "flat range" (see {@link module:engine/model/range~Range#isFlat}). If not, error will be thrown. - * - * @param {module:engine/model/range~Range} range Range to wrap. - * @param {module:engine/model/element~Element|String} elementOrString Element or name of element to wrap the range with. - */ - wrap( range, elementOrString ) { - if ( !range.isFlat ) { - /** - * Range to wrap is not flat. - * - * @error batch-wrap-range-not-flat - */ - throw new CKEditorError( 'batch-wrap-range-not-flat: Range to wrap is not flat.' ); - } - - const element = elementOrString instanceof Element ? elementOrString : new Element( elementOrString ); - - if ( element.childCount > 0 ) { - /** - * Element to wrap with is not empty. - * - * @error batch-wrap-element-not-empty - */ - throw new CKEditorError( 'batch-wrap-element-not-empty: Element to wrap with is not empty.' ); - } - - if ( element.parent !== null ) { - /** - * Element to wrap with is already attached to a tree model. - * - * @error batch-wrap-element-attached - */ - throw new CKEditorError( 'batch-wrap-element-attached: Element to wrap with is already attached to tree model.' ); - } - - const delta = new WrapDelta(); - this.addDelta( delta ); - - const insert = new InsertOperation( range.end, element, this.document.version ); - delta.addOperation( insert ); - this.document.applyOperation( insert ); - - const targetPosition = Position.createFromParentAndOffset( element, 0 ); - const move = new MoveOperation( - range.start, - range.end.offset - range.start.offset, - targetPosition, - this.document.version - ); - delta.addOperation( move ); - this.document.applyOperation( move ); - } - - /** - * Unwraps children of the given element – all its children are moved before it and then the element is removed. - * Throws error if you try to unwrap an element which does not have a parent. - * - * @param {module:engine/model/element~Element} element Element to unwrap. - */ - unwrap( element ) { - if ( element.parent === null ) { - /** - * Trying to unwrap an element which has no parent. - * - * @error batch-unwrap-element-no-parent - */ - throw new CKEditorError( 'batch-unwrap-element-no-parent: Trying to unwrap an element which has no parent.' ); - } - - const delta = new UnwrapDelta(); - this.addDelta( delta ); - - const sourcePosition = Position.createFromParentAndOffset( element, 0 ); - - const move = new MoveOperation( - sourcePosition, - element.maxOffset, - Position.createBefore( element ), - this.document.version - ); - - move.isSticky = true; - delta.addOperation( move ); - this.document.applyOperation( move ); - - // Computing new position because we moved some nodes before `element`. - // If we would cache `Position.createBefore( element )` we remove wrong node. - const graveyard = this.document.graveyard; - const gyPosition = new Position( graveyard, [ 0 ] ); - - const remove = new RemoveOperation( Position.createBefore( element ), 1, gyPosition, this.document.version ); - delta.addOperation( remove ); - this.document.applyOperation( remove ); - } - - /** - * Adds or updates {@link module:engine/model/markercollection~Marker marker} with given name to given `range`. - * - * If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance - * is passed), `range` parameter may be omitted. In this case marker will not be updated in - * {@link module:engine/model/document~Document#markers document marker collection}. However the marker will be added to - * the document history. This may be important for other features, like undo. From document history point of view, it will - * look like the marker was created and added to the document at the moment when it is set using this method. - * - * This is useful if the marker is created before it can be added to document history (e.g. a feature creating the marker - * is waiting for additional data, etc.). In this case, the marker may be first created directly through - * {@link module:engine/model/markercollection~MarkerCollection MarkerCollection API} and only later added using `Batch` API. - * - * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to add or update. - * @param {module:engine/model/range~Range} [newRange] Marker range. - */ - setMarker( markerOrName, newRange ) { - const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; - const currentMarker = this.document.markers.get( name ); - - if ( !newRange && !currentMarker ) { - /** - * Range parameter is required when adding a new marker. - * - * @error batch-setMarker-no-range - */ - throw new CKEditorError( 'batch-setMarker-no-range: Range parameter is required when adding a new marker.' ); - } - - const currentRange = currentMarker ? currentMarker.getRange() : null; - - if ( !newRange ) { - // If `newRange` is not given, treat this as synchronizing existing marker. - // Create `MarkerOperation` with `oldRange` set to `null`, so reverse operation will remove the marker. - addMarkerOperation( this, name, null, currentRange ); - } else { - // Just change marker range. - addMarkerOperation( this, name, currentRange, newRange ); - } - } - - /** - * Removes given {@link module:engine/model/markercollection~Marker marker} or marker with given name. - * - * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to remove. - */ - removeMarker( markerOrName ) { - const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; - - if ( !this.document.markers.has( name ) ) { - /** - * Trying to remove marker which does not exist. - * - * @error batch-removeMarker-no-marker - */ - throw new CKEditorError( 'batch-removeMarker-no-marker: Trying to remove marker which does not exist.' ); - } - - const oldRange = this.document.markers.get( name ).getRange(); - - addMarkerOperation( this, name, oldRange, null ); - } -} - -// Sets given attribute to each node in given range. When attribute value is null then attribute will be removed. -// -// Because attribute operation needs to have the same attribute value on the whole range, this function splits -// the range into smaller parts. -// -// @private -// @param {module:engine/model/batch~Batch} batch -// @param {String} key Attribute key. -// @param {*} value Attribute new value. -// @param {module:engine/model/range~Range} range Model range on which the attribute will be set. -function setAttributeToRange( batch, key, value, range ) { - const delta = new AttributeDelta(); - const doc = batch.document; - - // Position of the last split, the beginning of the new range. - let lastSplitPosition = range.start; - - // Currently position in the scanning range. Because we need value after the position, it is not a current - // position of the iterator but the previous one (we need to iterate one more time to get the value after). - let position; - - // Value before the currently position. - let valueBefore; - - // Value after the currently position. - let valueAfter; - - for ( const val of range ) { - valueAfter = val.item.getAttribute( key ); - - // At the first run of the iterator the position in undefined. We also do not have a valueBefore, but - // because valueAfter may be null, valueBefore may be equal valueAfter ( undefined == null ). - if ( position && valueBefore != valueAfter ) { - // if valueBefore == value there is nothing to change, so we add operation only if these values are different. - if ( valueBefore != value ) { - addOperation(); - } - - lastSplitPosition = position; - } - - position = val.nextPosition; - valueBefore = valueAfter; - } - - // Because position in the loop is not the iterator position (see let position comment), the last position in - // the while loop will be last but one position in the range. We need to check the last position manually. - if ( position instanceof Position && position != lastSplitPosition && valueBefore != value ) { - addOperation(); - } - - function addOperation() { - // Add delta to the batch only if there is at least operation in the delta. Add delta only once. - if ( delta.operations.length === 0 ) { - batch.addDelta( delta ); - } - - const range = new Range( lastSplitPosition, position ); - const operation = new AttributeOperation( range, key, valueBefore, value, doc.version ); - - delta.addOperation( operation ); - doc.applyOperation( operation ); - } -} - -// Sets given attribute to the given node. When attribute value is null then attribute will be removed. -// -// @private -// @param {module:engine/model/batch~Batch} batch -// @param {String} key Attribute key. -// @param {*} value Attribute new value. -// @param {module:engine/model/item~Item} item Model item on which the attribute will be set. -function setAttributeToItem( batch, key, value, item ) { - const doc = batch.document; - const previousValue = item.getAttribute( key ); - let range, operation; - - if ( previousValue != value ) { - const delta = item.root === item ? new RootAttributeDelta() : new AttributeDelta(); - batch.addDelta( delta ); - - if ( item.root === item ) { - // If we change attributes of root element, we have to use `RootAttributeOperation`. - operation = new RootAttributeOperation( item, key, previousValue, value, doc.version ); - } else { - if ( item.is( 'element' ) ) { - // If we change the attribute of the element, we do not want to change attributes of its children, so - // the end of the range cannot be after the closing tag, it should be inside that element, before any of - // it's children, so the range will contain only the opening tag. - range = new Range( Position.createBefore( item ), Position.createFromParentAndOffset( item, 0 ) ); - } else { - // If `item` is text proxy, we create a range from the beginning to the end of that text proxy, to change - // all characters represented by it. - range = new Range( Position.createBefore( item ), Position.createAfter( item ) ); - } - - operation = new AttributeOperation( range, key, previousValue, value, doc.version ); - } - - delta.addOperation( operation ); - doc.applyOperation( operation ); - } -} - -// Creates and adds marker operation to {@link module:engine/model/delta/delta~Delta delta}. -// -// @private -// @param {module:engine/model/batch~Batch} batch -// @param {String} name Marker name. -// @param {module:engine/model/range~Range} oldRange Marker range before the change. -// @param {module:engine/model/range~Range} newRange Marker range after the change. -function addMarkerOperation( batch, name, oldRange, newRange ) { - const doc = batch.document; - const delta = new MarkerDelta(); - - const operation = new MarkerOperation( name, oldRange, newRange, doc.markers, doc.version ); - - batch.addDelta( delta ); - delta.addOperation( operation ); - doc.applyOperation( operation ); -} - -// Returns `true` if both root elements are the same element or both are documents root elements. -// -// Elements in the same tree can be moved (for instance you can move element form one documents root to another, or -// within the same document fragment), but when element supposed to be moved from document fragment to the document, or -// to another document it should be removed and inserted to avoid problems with OT. This is because features like undo or -// collaboration may track changes on the document but ignore changes on detached fragments and should not get -// unexpected `move` operation. -function isSameTree( rootA, rootB ) { - // If it is the same root this is the same tree. - if ( rootA === rootB ) { - return true; - } - - // If both roots are documents root it is operation within the document what we still treat as the same tree. - if ( rootA instanceof RootElement && rootB instanceof RootElement ) { - return true; - } - - return false; } diff --git a/src/model/document.js b/src/model/document.js index b3842106c..3e48cb232 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -269,7 +269,7 @@ export default class Document { */ getNearestSelectionRange( position, direction = 'both' ) { // Return collapsed range if provided position is valid. - if ( this.schema.check( { name: '$text', inside: position } ) ) { + if ( this.model.schema.check( { name: '$text', inside: position } ) ) { return new Range( position ); } diff --git a/src/model/writer.js b/src/model/writer.js new file mode 100644 index 000000000..b91e51f8d --- /dev/null +++ b/src/model/writer.js @@ -0,0 +1,913 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/model/writer + */ + +import AttributeDelta from './delta/attributedelta'; +import InsertDelta from './delta/insertdelta'; +import MarkerDelta from './delta/markerdelta'; +import MergeDelta from './delta/mergedelta'; +import MoveDelta from './delta/movedelta'; +import RemoveDelta from './delta/removedelta'; +import RenameDelta from './delta/renamedelta'; +import RootAttributeDelta from './delta/rootattributedelta'; +import SplitDelta from './delta/splitdelta'; +import UnwrapDelta from './delta/unwrapdelta'; +import WeakInsertDelta from './delta/weakinsertdelta'; +import WrapDelta from './delta/wrapdelta'; + +import AttributeOperation from './operation/attributeoperation'; +import DetachOperation from './operation/detachoperation'; +import InsertOperation from './operation/insertoperation'; +import MarkerOperation from './operation/markeroperation'; +import MoveOperation from './operation/moveoperation'; +import RemoveOperation from './operation/removeoperation'; +import RenameOperation from './operation/renameoperation'; +import RootAttributeOperation from './operation/rootattributeoperation'; + +import DocumentFragment from './documentfragment'; +import Text from './text'; +import Element from './element'; +import RootElement from './rootelement'; +import Position from './position'; +import Range from './range.js'; + +import toMap from '@ckeditor/ckeditor5-utils/src/tomap'; + +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; + +/** + * `Batch` instance groups document changes ({@link module:engine/model/delta/delta~Delta deltas}). All deltas grouped in a single `Batch` + * can be reverted together, so you can think about `Batch` as of a single undo step. If you want to extend given undo step you + * can call another method on the same `Batch` object. If you want to create a separate undo step you can create a new `Batch`. + * + * For example to create two separate undo steps you can call: + * + * doc.batch().insert( 'foo', firstPosition ); + * doc.batch().insert( 'bar', secondPosition ); + * + * To create a single undo step: + * + * const batch = doc.batch(); + * writer.insert( 'foo', firstPosition ); + * writer.insert( 'bar', secondPosition ); + * + */ +export default class Writer { + /** + * @param {module:engine/model~Model} model + * @param {module:engine/model/batch~Batch} batch + */ + constructor( model, batch ) { + /** + * @type {module:engine/model~Model} + */ + this.model = model; + + /** + * @protected + * @type {module:engine/model/batch~Batch} + */ + this._batch = batch; + } + + /** + * Creates a new {@link module:engine/model/text~Text text node}. + * + * writer.createText( 'foo' ); + * writer.createText( 'foo', { 'bold': true } ); + * + * @param {String} data Text data. + * @param {Object} [attributes] Text attributes. + * @returns {module:engine/model/text~Text} Created text node. + */ + createText( data, attributes ) { + return new Text( data, attributes ); + } + + /** + * Creates a new {@link module:engine/model/element~Element element}. + * + * writer.createElement( 'paragraph' ); + * writer.createElement( 'paragraph', { 'alignment': 'center' } ); + * + * @param {String} name Name of the element. + * @param {Object} [attributes] Elements attributes. + * @returns {module:engine/model/element~Element} Created element. + */ + createElement( name, attributes ) { + return new Element( name, attributes ); + } + + /** + * Creates a new {@link module:engine/model/documentfragment~DocumentFragment document fragment}. + * + * @returns {module:engine/model/documentfragment~DocumentFragment} Created document fragment. + */ + createDocumentFragment() { + return new DocumentFragment(); + } + + /** + * Inserts item on given position. + * + * const paragraph = writer.createElement( 'paragraph' ); + * writer.insert( paragraph, position ); + * + * Instead of using position you can use parent and offset: + * + * const text = writer.createText( 'foo' ); + * writer.insert( text, paragraph, 5 ); + * + * You can also use `end` instead of the offset to insert at the end: + * + * const text = writer.createText( 'foo' ); + * writer.insert( text, paragraph, 'end' ); + * + * Or insert before or after another element: + * + * const paragraph = writer.createElement( 'paragraph' ); + * writer.insert( paragraph, anotherParagraph, 'after' ); + * + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. + * + * Note that if the item already has parent it will be removed from the previous parent. + * + * If you want to move {@link module:engine/model/range~Range range} instead of an + * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. + * + * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} + * item Item or document fragment to insert. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * second parameter is a {@link module:engine/model/item~Item model item}. + */ + insert( item, itemOrPosition, offset ) { + const position = Position.createAt( itemOrPosition, offset ); + + // For text that has no parent we need to make a WeakInsert. + const delta = item instanceof Text && !item.parent ? new WeakInsertDelta() : new InsertDelta(); + + // If item has a parent already. + if ( item.parent ) { + // We need to check if item is going to be inserted within the same document. + if ( isSameTree( item.root, position.root ) ) { + // If it's we just need to move it. + this.move( Range.createOn( item ), position ); + + return; + } + // If it isn't the same root. + else { + // We need to remove this item from old position first. + this.remove( item ); + } + } + + const insert = new InsertOperation( position, item, this.model.document.version ); + + this._batch.addDelta( delta ); + delta.addOperation( insert ); + this.model.applyOperation( insert ); + + // When element is a DocumentFragment we need to move its markers to Document#markers. + if ( item instanceof DocumentFragment ) { + for ( const [ markerName, markerRange ] of item.markers ) { + // We need to migrate marker range from DocumentFragment to Document. + const rangeRootPosition = Position.createAt( markerRange.root ); + const range = new Range( + markerRange.start._getCombined( rangeRootPosition, position ), + markerRange.end._getCombined( rangeRootPosition, position ) + ); + + this.setMarker( markerName, range ); + } + } + } + + /** + * Creates and inserts text on given position. You can optionally set text attributes: + * + * writer.insertText( 'foo', position ); + * writer.insertText( 'foo', { 'bold': true }, position ); + * + * Instead of using position you can use parent and offset or define that text should be inserted at the end + * or before or after other node: + * + * writer.insertText( 'foo', paragraph, 5 ); // inserts in paragraph, at offset 5 + * writer.insertText( 'foo', paragraph, 'end' ); // inserts at the end of the paragraph + * writer.insertText( 'foo', image, 'after' ); // inserts after image + * + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. + * + * @param {String} data Text data. + * @param {Object} [attributes] Text attributes. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * third parameter is a {@link module:engine/model/item~Item model item}. + */ + insertText( text, attributes, itemOrPosition, offset ) { + if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { + this.insert( this.createText( text ), attributes, itemOrPosition ); + } else { + this.insert( this.createText( text, attributes ), itemOrPosition, offset ); + } + } + + /** + * Creates and inserts element on given position. You can optionally set attributes: + * + * writer.insertElement( 'paragraph', position ); + * writer.insertElement( 'paragraph', { 'alignment': 'center' }, position ); + * + * Instead of using position you can use parent and offset or define that text should be inserted at the end + * or before or after other node: + * + * writer.insertElement( 'paragraph', paragraph, 5 ); // inserts in paragraph, at offset 5 + * writer.insertElement( 'paragraph', blockquote, 'end' ); // insets at the end of the blockquote + * writer.insertElement( 'paragraph', image, 'after' ); // inserts after image + * + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. + * + * @param {String} name Name of the element. + * @param {Object} [attributes] Elements attributes. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * third parameter is a {@link module:engine/model/item~Item model item}. + */ + insertElement( name, attributes, itemOrPosition, offset ) { + if ( attributes instanceof DocumentFragment || attributes instanceof Element || attributes instanceof Position ) { + this.insert( this.createElement( name ), attributes, itemOrPosition ); + } else { + this.insert( this.createElement( name, attributes ), itemOrPosition, offset ); + } + } + + /** + * Inserts item at the end of the given parent. + * + * const paragraph = writer.createElement( 'paragraph' ); + * writer.append( paragraph, root ); + * + * Note that if the item already has parent it will be removed from the previous parent. + * + * If you want to move {@link module:engine/model/range~Range range} instead of an + * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. + * + * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} + * item Item or document fragment to insert. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent + */ + append( item, parent ) { + this.insert( item, parent, 'end' ); + } + + /** + * Creates text node and inserts it at the end of the parent. You can optionally set text attributes: + * + * writer.appendText( 'foo', paragraph ); + * writer.appendText( 'foo', { 'bold': true }, paragraph ); + * + * @param {String} text Text data. + * @param {Object} [attributes] Text attributes. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent + */ + appendText( text, attributes, parent ) { + if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { + this.insert( this.createText( text ), attributes, 'end' ); + } else { + this.insert( this.createText( text, attributes ), parent, 'end' ); + } + } + + /** + * Creates element and inserts it at the end of the parent. You can optionally set attributes: + * + * writer.appendElement( 'paragraph', root ); + * writer.appendElement( 'paragraph', { 'alignment': 'center' }, root ); + * + * @param {String} name Name of the element. + * @param {Object} [attributes] Elements attributes. + * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} parent + */ + appendElement( name, attributes, parent ) { + if ( attributes instanceof DocumentFragment || attributes instanceof Element ) { + this.insert( this.createElement( name ), attributes, 'end' ); + } else { + this.insert( this.createElement( name, attributes ), parent, 'end' ); + } + } + + /** + * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} + * or on a {@link module:engine/model/range~Range range}. + * + * @param {String} key Attribute key. + * @param {*} value Attribute new value. + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range on which the attribute will be set. + */ + setAttribute( key, value, itemOrRange ) { + if ( itemOrRange instanceof Range ) { + setAttributeToRange( this, key, value, itemOrRange ); + } else { + setAttributeToItem( this, key, value, itemOrRange ); + } + } + + /** + * Sets values of attributes on a {@link module:engine/model/item~Item model item} + * or on a {@link module:engine/model/range~Range range}. + * + * writer.setAttributes( { + * 'bold': true, + * 'italic': true + * }, range ); + * + * @param {Object} attributes Attributes keys and values. + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range on which the attributes will be set. + */ + setAttributes( attributes, itemOrRange ) { + for ( const [ key, val ] of toMap( attributes ) ) { + this.setAttribute( key, val, itemOrRange ); + } + } + + /** + * Removes an attribute with given key from a {@link module:engine/model/item~Item model item} + * or from a {@link module:engine/model/range~Range range}. + * + * @param {String} key Attribute key. + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range from which the attribute will be removed. + */ + removeAttribute( key, itemOrRange ) { + if ( itemOrRange instanceof Range ) { + setAttributeToRange( this, key, null, itemOrRange ); + } else { + setAttributeToItem( this, key, null, itemOrRange ); + } + } + + /** + * Removes all attributes from all elements in the range or from the given item. + * + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange + * Model item or range from which all attributes will be removed. + */ + clearAttributes( itemOrRange ) { + const removeAttributesFromItem = item => { + for ( const attribute of item.getAttributeKeys() ) { + this.removeAttribute( attribute, item ); + } + }; + + if ( !( itemOrRange instanceof Range ) ) { + removeAttributesFromItem( itemOrRange ); + } else { + for ( const item of itemOrRange.getItems() ) { + removeAttributesFromItem( item ); + } + } + } + + /** + * Moves all items in the source range to the target position. + * + * writer.move( sourceRange, targetPosition ); + * + * Instead of the target position you can use parent and offset or define that range should be moved to the end + * or before or after chosen item: + * + * writer.move( sourceRange, paragraph, 5 ); // moves all items in the range to the paragraph at offset 5 + * writer.move( sourceRange, blockquote, 'end' ); // moves all items in the range at the end of the blockquote + * writer.move( sourceRange, image, 'after' ); // moves all items in the range after the image + * + * These parameters works the same way as {@link module:engine/model/position~Position.createAt}. + * + * Note that items can be moved only within the same tree. It means that you can move items within the same root + * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots}, + * but you can not move items from document fragment to the document or from one detached element to another. Use + * {@link module:engine/model/batch~Batch#insert} in such cases. + * + * @param {module:engine/model/range~Range} range Source range. + * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition + * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when + * second parameter is a {@link module:engine/model/item~Item model item}. + */ + move( range, itemOrPosition, offset ) { + if ( !( range instanceof Range ) ) { + /** + * Invalid range to move. + * + * @error writer-move-invalid-range + */ + throw new CKEditorError( 'writer-move-invalid-range: Invalid range to move.' ); + } + + if ( !range.isFlat ) { + /** + * Range to move is not flat. + * + * @error writer-move-range-not-flat + */ + throw new CKEditorError( 'writer-move-range-not-flat: Range to move is not flat.' ); + } + + const position = Position.createAt( itemOrPosition, offset ); + + if ( !isSameTree( range.root, position.root ) ) { + /** + * Range is going to be moved within not the same document. Please use + * {@link module:engine/model/batch~Batch#insert insert} instead. + * + * @error writer-move-different-document + */ + throw new CKEditorError( 'writer-move-different-document: Range is going to be moved between different documents.' ); + } + + const delta = new MoveDelta(); + this._batch.addDelta( delta ); + + const operation = new MoveOperation( range.start, range.end.offset - range.start.offset, position, this.model.document.version ); + delta.addOperation( operation ); + this.model.applyOperation( operation ); + } + + /** + * Removes given model {@link module:engine/model/item~Item item} or {@link module:engine/model/range~Range range}. + * + * @param {module:engine/model/item~Item|module:engine/model/range~Range} itemOrRange Model item or range to remove. + */ + remove( itemOrRange ) { + const addRemoveDelta = ( position, howMany ) => { + const delta = new RemoveDelta(); + this._batch.addDelta( delta ); + let operation; + + if ( position.root.document ) { + const graveyard = this.model.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + operation = new RemoveOperation( position, howMany, gyPosition, this.model.document.version ); + } else { + operation = new DetachOperation( position, howMany, this.model.document.version ); + } + + delta.addOperation( operation ); + this.model.applyOperation( operation ); + }; + + if ( itemOrRange instanceof Range ) { + // The array is reversed, so the ranges to remove are in correct order and do not have to be updated. + const ranges = itemOrRange.getMinimalFlatRanges().reverse(); + + for ( const flat of ranges ) { + addRemoveDelta( flat.start, flat.end.offset - flat.start.offset ); + } + } else { + const howMany = itemOrRange.is( 'text' ) ? itemOrRange.offsetSize : 1; + + addRemoveDelta( Position.createBefore( itemOrRange ), howMany ); + } + } + + /** + * Merges two siblings at the given position. + * + * Node before and after the position have to be an element. Otherwise `writer-merge-no-element-before` or + * `writer-merge-no-element-after` error will be thrown. + * + * @param {module:engine/model/position~Position} position Position of merge. + */ + merge( position ) { + const delta = new MergeDelta(); + this._batch.addDelta( delta ); + + const nodeBefore = position.nodeBefore; + const nodeAfter = position.nodeAfter; + + if ( !( nodeBefore instanceof Element ) ) { + /** + * Node before merge position must be an element. + * + * @error writer-merge-no-element-before + */ + throw new CKEditorError( 'writer-merge-no-element-before: Node before merge position must be an element.' ); + } + + if ( !( nodeAfter instanceof Element ) ) { + /** + * Node after merge position must be an element. + * + * @error writer-merge-no-element-after + */ + throw new CKEditorError( 'writer-merge-no-element-after: Node after merge position must be an element.' ); + } + + const positionAfter = Position.createFromParentAndOffset( nodeAfter, 0 ); + const positionBefore = Position.createFromParentAndOffset( nodeBefore, nodeBefore.maxOffset ); + + const move = new MoveOperation( + positionAfter, + nodeAfter.maxOffset, + positionBefore, + this.model.document.version + ); + + move.isSticky = true; + delta.addOperation( move ); + this.model.applyOperation( move ); + + const graveyard = this.model.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + const remove = new RemoveOperation( position, 1, gyPosition, this.model.document.version ); + delta.addOperation( remove ); + this.model.applyOperation( remove ); + } + + /** + * Renames given element. + * + * @param {module:engine/model/element~Element} element The element to rename. + * @param {String} newName New element name. + */ + rename( element, newName ) { + if ( !( element instanceof Element ) ) { + /** + * Trying to rename an object which is not an instance of Element. + * + * @error writer-rename-not-element-instance + */ + throw new CKEditorError( + 'writer-rename-not-element-instance: Trying to rename an object which is not an instance of Element.' + ); + } + + const delta = new RenameDelta(); + this._batch.addDelta( delta ); + + const renameOperation = new RenameOperation( Position.createBefore( element ), element.name, newName, this.model.document.version ); + delta.addOperation( renameOperation ); + this.model.applyOperation( renameOperation ); + } + + /** + * Splits an element at the given position. + * + * The element needs to have a parent. It cannot be a root element nor document fragment. + * The `writer-split-element-no-parent` error will be thrown if you try to split an element with no parent. + * + * @param {module:engine/model/position~Position} position Position of split. + */ + split( position ) { + const delta = new SplitDelta(); + this._batch.addDelta( delta ); + + const splitElement = position.parent; + + if ( !splitElement.parent ) { + /** + * Element with no parent can not be split. + * + * @error writer-split-element-no-parent + */ + throw new CKEditorError( 'writer-split-element-no-parent: Element with no parent can not be split.' ); + } + + const copy = new Element( splitElement.name, splitElement.getAttributes() ); + + const insert = new InsertOperation( + Position.createAfter( splitElement ), + copy, + this.model.document.version + ); + + delta.addOperation( insert ); + this.model.applyOperation( insert ); + + const move = new MoveOperation( + position, + splitElement.maxOffset - position.offset, + Position.createFromParentAndOffset( copy, 0 ), + this.model.document.version + ); + move.isSticky = true; + + delta.addOperation( move ); + this.model.applyOperation( move ); + } + + /** + * Wraps given range with given element or with a new element with specified name, if string has been passed. + * + * **Note:** range to wrap should be a "flat range" (see {@link module:engine/model/range~Range#isFlat}). If not, error will be thrown. + * + * @param {module:engine/model/range~Range} range Range to wrap. + * @param {module:engine/model/element~Element|String} elementOrString Element or name of element to wrap the range with. + */ + wrap( range, elementOrString ) { + if ( !range.isFlat ) { + /** + * Range to wrap is not flat. + * + * @error writer-wrap-range-not-flat + */ + throw new CKEditorError( 'writer-wrap-range-not-flat: Range to wrap is not flat.' ); + } + + const element = elementOrString instanceof Element ? elementOrString : new Element( elementOrString ); + + if ( element.childCount > 0 ) { + /** + * Element to wrap with is not empty. + * + * @error writer-wrap-element-not-empty + */ + throw new CKEditorError( 'writer-wrap-element-not-empty: Element to wrap with is not empty.' ); + } + + if ( element.parent !== null ) { + /** + * Element to wrap with is already attached to a tree model. + * + * @error writer-wrap-element-attached + */ + throw new CKEditorError( 'writer-wrap-element-attached: Element to wrap with is already attached to tree model.' ); + } + + const delta = new WrapDelta(); + this._batch.addDelta( delta ); + + const insert = new InsertOperation( range.end, element, this.model.document.version ); + delta.addOperation( insert ); + this.model.applyOperation( insert ); + + const targetPosition = Position.createFromParentAndOffset( element, 0 ); + const move = new MoveOperation( + range.start, + range.end.offset - range.start.offset, + targetPosition, + this.model.document.version + ); + delta.addOperation( move ); + this.model.applyOperation( move ); + } + + /** + * Unwraps children of the given element – all its children are moved before it and then the element is removed. + * Throws error if you try to unwrap an element which does not have a parent. + * + * @param {module:engine/model/element~Element} element Element to unwrap. + */ + unwrap( element ) { + if ( element.parent === null ) { + /** + * Trying to unwrap an element which has no parent. + * + * @error writer-unwrap-element-no-parent + */ + throw new CKEditorError( 'writer-unwrap-element-no-parent: Trying to unwrap an element which has no parent.' ); + } + + const delta = new UnwrapDelta(); + this._batch.addDelta( delta ); + + const sourcePosition = Position.createFromParentAndOffset( element, 0 ); + + const move = new MoveOperation( + sourcePosition, + element.maxOffset, + Position.createBefore( element ), + this.model.document.version + ); + + move.isSticky = true; + delta.addOperation( move ); + this.model.applyOperation( move ); + + // Computing new position because we moved some nodes before `element`. + // If we would cache `Position.createBefore( element )` we remove wrong node. + const graveyard = this.model.document.graveyard; + const gyPosition = new Position( graveyard, [ 0 ] ); + + const remove = new RemoveOperation( Position.createBefore( element ), 1, gyPosition, this.model.document.version ); + delta.addOperation( remove ); + this.model.applyOperation( remove ); + } + + /** + * Adds or updates {@link module:engine/model/markercollection~Marker marker} with given name to given `range`. + * + * If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance + * is passed), `range` parameter may be omitted. In this case marker will not be updated in + * {@link module:engine/model/document~Document#markers document marker collection}. However the marker will be added to + * the document history. This may be important for other features, like undo. From document history point of view, it will + * look like the marker was created and added to the document at the moment when it is set using this method. + * + * This is useful if the marker is created before it can be added to document history (e.g. a feature creating the marker + * is waiting for additional data, etc.). In this case, the marker may be first created directly through + * {@link module:engine/model/markercollection~MarkerCollection MarkerCollection API} and only later added using `Batch` API. + * + * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to add or update. + * @param {module:engine/model/range~Range} [newRange] Marker range. + */ + setMarker( markerOrName, newRange ) { + const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; + const currentMarker = this.model.markers.get( name ); + + if ( !newRange && !currentMarker ) { + /** + * Range parameter is required when adding a new marker. + * + * @error writer-setMarker-no-range + */ + throw new CKEditorError( 'writer-setMarker-no-range: Range parameter is required when adding a new marker.' ); + } + + const currentRange = currentMarker ? currentMarker.getRange() : null; + + if ( !newRange ) { + // If `newRange` is not given, treat this as synchronizing existing marker. + // Create `MarkerOperation` with `oldRange` set to `null`, so reverse operation will remove the marker. + addMarkerOperation( this, name, null, currentRange ); + } else { + // Just change marker range. + addMarkerOperation( this, name, currentRange, newRange ); + } + } + + /** + * Removes given {@link module:engine/model/markercollection~Marker marker} or marker with given name. + * + * @param {module:engine/model/markercollection~Marker|String} markerOrName Marker or marker name to remove. + */ + removeMarker( markerOrName ) { + const name = typeof markerOrName == 'string' ? markerOrName : markerOrName.name; + + if ( !this.model.markers.has( name ) ) { + /** + * Trying to remove marker which does not exist. + * + * @error writer-removeMarker-no-marker + */ + throw new CKEditorError( 'writer-removeMarker-no-marker: Trying to remove marker which does not exist.' ); + } + + const oldRange = this.model.markers.get( name ).getRange(); + + addMarkerOperation( this, name, oldRange, null ); + } +} + +// Sets given attribute to each node in given range. When attribute value is null then attribute will be removed. +// +// Because attribute operation needs to have the same attribute value on the whole range, this function splits +// the range into smaller parts. +// +// @private +// @param {module:engine/model/writer~Writer} writer +// @param {String} key Attribute key. +// @param {*} value Attribute new value. +// @param {module:engine/model/range~Range} range Model range on which the attribute will be set. +function setAttributeToRange( writer, key, value, range ) { + const delta = new AttributeDelta(); + const model = writer.model; + const doc = model.document; + + // Position of the last split, the beginning of the new range. + let lastSplitPosition = range.start; + + // Currently position in the scanning range. Because we need value after the position, it is not a current + // position of the iterator but the previous one (we need to iterate one more time to get the value after). + let position; + + // Value before the currently position. + let valueBefore; + + // Value after the currently position. + let valueAfter; + + for ( const val of range ) { + valueAfter = val.item.getAttribute( key ); + + // At the first run of the iterator the position in undefined. We also do not have a valueBefore, but + // because valueAfter may be null, valueBefore may be equal valueAfter ( undefined == null ). + if ( position && valueBefore != valueAfter ) { + // if valueBefore == value there is nothing to change, so we add operation only if these values are different. + if ( valueBefore != value ) { + addOperation(); + } + + lastSplitPosition = position; + } + + position = val.nextPosition; + valueBefore = valueAfter; + } + + // Because position in the loop is not the iterator position (see let position comment), the last position in + // the while loop will be last but one position in the range. We need to check the last position manually. + if ( position instanceof Position && position != lastSplitPosition && valueBefore != value ) { + addOperation(); + } + + function addOperation() { + // Add delta to the batch only if there is at least operation in the delta. Add delta only once. + if ( delta.operations.length === 0 ) { + writer._batch.addDelta( delta ); + } + + const range = new Range( lastSplitPosition, position ); + const operation = new AttributeOperation( range, key, valueBefore, value, doc.version ); + + delta.addOperation( operation ); + model.applyOperation( operation ); + } +} + +// Sets given attribute to the given node. When attribute value is null then attribute will be removed. +// +// @private +// @param {module:engine/model/writer~Writer} writer +// @param {String} key Attribute key. +// @param {*} value Attribute new value. +// @param {module:engine/model/item~Item} item Model item on which the attribute will be set. +function setAttributeToItem( writer, key, value, item ) { + const model = writer.model; + const doc = model.document; + const previousValue = item.getAttribute( key ); + let range, operation; + + if ( previousValue != value ) { + const delta = item.root === item ? new RootAttributeDelta() : new AttributeDelta(); + writer._batch.addDelta( delta ); + + if ( item.root === item ) { + // If we change attributes of root element, we have to use `RootAttributeOperation`. + operation = new RootAttributeOperation( item, key, previousValue, value, doc.version ); + } else { + if ( item.is( 'element' ) ) { + // If we change the attribute of the element, we do not want to change attributes of its children, so + // the end of the range cannot be after the closing tag, it should be inside that element, before any of + // it's children, so the range will contain only the opening tag. + range = new Range( Position.createBefore( item ), Position.createFromParentAndOffset( item, 0 ) ); + } else { + // If `item` is text proxy, we create a range from the beginning to the end of that text proxy, to change + // all characters represented by it. + range = new Range( Position.createBefore( item ), Position.createAfter( item ) ); + } + + operation = new AttributeOperation( range, key, previousValue, value, doc.version ); + } + + delta.addOperation( operation ); + model.applyOperation( operation ); + } +} + +// Creates and adds marker operation to {@link module:engine/model/delta/delta~Delta delta}. +// +// @private +// @param {module:engine/model/writer~Writer} writer +// @param {String} name Marker name. +// @param {module:engine/model/range~Range} oldRange Marker range before the change. +// @param {module:engine/model/range~Range} newRange Marker range after the change. +function addMarkerOperation( writer, name, oldRange, newRange ) { + const model = writer.model; + const doc = model.document; + const delta = new MarkerDelta(); + + const operation = new MarkerOperation( name, oldRange, newRange, model.markers, doc.version ); + + writer._batch.addDelta( delta ); + delta.addOperation( operation ); + model.applyOperation( operation ); +} + +// Returns `true` if both root elements are the same element or both are documents root elements. +// +// Elements in the same tree can be moved (for instance you can move element form one documents root to another, or +// within the same document fragment), but when element supposed to be moved from document fragment to the document, or +// to another document it should be removed and inserted to avoid problems with OT. This is because features like undo or +// collaboration may track changes on the document but ignore changes on detached fragments and should not get +// unexpected `move` operation. +function isSameTree( rootA, rootB ) { + // If it is the same root this is the same tree. + if ( rootA === rootB ) { + return true; + } + + // If both roots are documents root it is operation within the document what we still treat as the same tree. + if ( rootA instanceof RootElement && rootB instanceof RootElement ) { + return true; + } + + return false; +} diff --git a/tests/model/batch.js b/tests/model/batch.js index 34bf7968d..7a40ddd1d 100644 --- a/tests/model/batch.js +++ b/tests/model/batch.js @@ -5,33 +5,18 @@ import Batch from '../../src/model/batch'; import Delta from '../../src/model/delta/delta'; -import InsertDelta from '../../src/model/delta/insertdelta'; -import WeakInsertDelta from '../../src/model/delta/weakinsertdelta'; - import Operation from '../../src/model/operation/operation'; -import Document from '../../src/model/document'; -import DocumentFragment from '../../src/model/documentfragment'; -import Element from '../../src/model/element'; -import Text from '../../src/model/text'; -import Position from '../../src/model/position'; -import Range from '../../src/model/range'; - -import count from '@ckeditor/ckeditor5-utils/src/count'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; - -import { getNodesAndText } from '../../tests/model/_utils/utils'; - describe( 'Batch', () => { describe( 'type', () => { - it( 'should default to "default"', () => { - const batch = new Batch( new Document() ); + it( 'should default be "default"', () => { + const batch = new Batch(); expect( batch.type ).to.equal( 'default' ); } ); it( 'should be set to the value set in constructor', () => { - const batch = new Batch( new Document(), 'ignore' ); + const batch = new Batch( 'ignore' ); expect( batch.type ).to.equal( 'ignore' ); } ); @@ -39,7 +24,7 @@ describe( 'Batch', () => { describe( 'baseVersion', () => { it( 'should return base version of first delta from the batch', () => { - const batch = new Batch( new Document() ); + const batch = new Batch(); const delta = new Delta(); const operation = new Operation( 2 ); delta.addOperation( operation ); @@ -49,7 +34,7 @@ describe( 'Batch', () => { } ); it( 'should return null if there are no deltas in batch', () => { - const batch = new Batch( new Document() ); + const batch = new Batch(); expect( batch.baseVersion ).to.be.null; } ); @@ -57,7 +42,7 @@ describe( 'Batch', () => { describe( 'addDelta()', () => { it( 'should add delta to the batch', () => { - const batch = new Batch( new Document() ); + const batch = new Batch(); const deltaA = new Delta(); const deltaB = new Delta(); batch.addDelta( deltaA ); @@ -71,14 +56,13 @@ describe( 'Batch', () => { describe( 'getOperations()', () => { it( 'should return collection of operations from all deltas', () => { - const doc = new Document(); - const batch = new Batch( doc ); + const batch = new Batch(); const deltaA = new Delta(); const deltaB = new Delta(); const ops = [ - new Operation( doc.version ), - new Operation( doc.version + 1 ), - new Operation( doc.version + 2 ) + new Operation( 0 ), + new Operation( 1 ), + new Operation( 2 ) ]; batch.addDelta( deltaA ); @@ -91,1852 +75,4 @@ describe( 'Batch', () => { expect( batch.getOperations() ).to.have.property( 'next' ); } ); } ); - - describe( 'createText()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create text node', () => { - const text = batch.createText( 'foo' ); - - expect( text ).to.instanceof( Text ); - expect( text.data ).to.equal( 'foo' ); - expect( Array.from( text.getAttributes() ) ).to.length( 0 ); - } ); - - it( 'should create text with attributes', () => { - const text = batch.createText( 'foo', { foo: 'bar', biz: 'baz' } ); - - expect( Array.from( text.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'biz', 'baz' ] ] ); - } ); - } ); - - describe( 'createElement()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create element', () => { - const element = batch.createElement( 'foo' ); - - expect( element ).to.instanceof( Element ); - expect( element.name ).to.equal( 'foo' ); - expect( Array.from( element.getAttributes() ) ).to.length( 0 ); - } ); - - it( 'should create element with attributes', () => { - const element = batch.createText( 'foo', { foo: 'bar', biz: 'baz' } ); - - expect( Array.from( element.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'biz', 'baz' ] ] ); - } ); - } ); - - describe( 'createDocumentFragment()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create element', () => { - const element = batch.createDocumentFragment(); - - expect( element ).to.instanceof( DocumentFragment ); - } ); - } ); - - describe( 'insert()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should insert node at given position', () => { - const parent = batch.createDocumentFragment(); - const child = batch.createElement( 'child' ); - const textChild = batch.createText( 'textChild' ); - - batch.insert( child, new Position( parent, [ 0 ] ) ); - batch.insert( textChild, new Position( parent, [ 1 ] ) ); - - expect( Array.from( parent ) ).to.deep.equal( [ child, textChild ] ); - } ); - - it( 'should insert node at the beginning of given element', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - - batch.insert( child1, parent ); - batch.insert( child2, parent ); - - expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child2, child1 ] ); - } ); - - it( 'should insert node at the end of given element', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - - batch.insert( child1, parent ); - batch.insert( child2, parent, 'end' ); - - expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2 ] ); - } ); - - it( 'should insert node at the given offset of given element', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - const child3 = batch.createElement( 'child' ); - - batch.insert( child3, parent ); - batch.insert( child1, parent ); - batch.insert( child2, parent, 1 ); - - expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); - } ); - - it( 'should insert node before the given node', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - const child3 = batch.createElement( 'child' ); - - batch.insert( child3, parent ); - batch.insert( child1, parent ); - batch.insert( child2, child3, 'before' ); - - expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); - } ); - - it( 'should insert node after the given node', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - const child3 = batch.createElement( 'child' ); - - batch.insert( child3, parent ); - batch.insert( child1, parent ); - batch.insert( child2, child1, 'after' ); - - expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); - } ); - - it( 'should create proper delta for inserting element', () => { - const parent = batch.createDocumentFragment(); - const element = batch.createElement( 'child' ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( element, parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); - expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should create proper delta for inserting text', () => { - const parent = batch.createDocumentFragment(); - const text = batch.createText( 'child' ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( text, parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { - const rootA = doc.createRoot(); - const parent1 = batch.createElement( 'parent' ); - const parent2 = batch.createElement( 'parent' ); - const node = batch.createText( 'foo' ); - - batch.insert( node, parent1 ); - batch.insert( parent1, rootA ); - batch.insert( parent2, rootA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( node, parent2 ); - - // Verify result. - expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { - const rootA = doc.createRoot( '$root', 'A' ); - const rootB = doc.createRoot( '$root', 'B' ); - const node = batch.createText( 'foo' ); - - batch.insert( node, rootA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( node, rootB ); - - // Verify result. - expect( Array.from( rootA.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( rootB.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { - const docFragA = batch.createDocumentFragment(); - const parent1 = batch.createElement( 'parent' ); - const parent2 = batch.createElement( 'parent' ); - const node = batch.createText( 'foo' ); - - batch.insert( node, parent1 ); - batch.insert( parent1, docFragA ); - batch.insert( parent2, docFragA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( node, parent2 ); - - // Verify result. - expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { - const root = doc.createRoot(); - const docFrag = batch.createDocumentFragment(); - const node = batch.createText( 'foo' ); - - batch.insert( node, root ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( node, docFrag ); - - // Verify result. - expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { - const docFragA = batch.createDocumentFragment(); - const docFragB = batch.createDocumentFragment(); - const node = batch.createText( 'foo' ); - - batch.insert( node, docFragA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insert( node, docFragB ); - - // Verify result. - expect( Array.from( docFragA ) ).to.deep.equal( [] ); - expect( Array.from( docFragB ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'detach' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should transfer markers from given DocumentFragment', () => { - const root = doc.createRoot(); - const docFrag = batch.createDocumentFragment(); - - batch.appendText( 'abcd', root ); - batch.appendElement( 'p', docFrag ); - batch.insertText( 'foo bar', new Position( docFrag, [ 0, 0 ] ) ); - - const marker = new Range( new Position( docFrag, [ 0, 1 ] ), new Position( docFrag, [ 0, 5 ] ) ); - - docFrag.markers.set( 'marker', marker ); - - batch.insert( docFrag, new Position( root, [ 2 ] ) ); - - expect( Array.from( doc.markers ).length ).to.equal( 1 ); - - const range = doc.markers.get( 'marker' ).getRange(); - expect( range.root ).to.equal( root ); - expect( range.start.path ).to.deep.equal( [ 2, 1 ] ); - expect( range.end.path ).to.deep.equal( [ 2, 5 ] ); - } ); - - it( 'should set each marker as a separate operation', () => { - const spy = sinon.spy(); - const root = doc.createRoot(); - const docFrag = batch.createDocumentFragment(); - - batch.appendText( 'abcd', root ); - batch.appendElement( 'p', docFrag ); - batch.insertText( 'foo bar', new Position( docFrag, [ 0, 0 ] ) ); - - const marker1 = new Range( new Position( docFrag, [ 0, 1 ] ), new Position( docFrag, [ 0, 2 ] ) ); - const marker2 = new Range( new Position( docFrag, [ 0, 5 ] ), new Position( docFrag, [ 0, 6 ] ) ); - - docFrag.markers.set( 'marker1', marker1 ); - docFrag.markers.set( 'marker2', marker2 ); - - doc.on( 'change', spy ); - - batch.insert( docFrag, new Position( root, [ 2 ] ) ); - - sinon.assert.calledThrice( spy ); - expect( spy.firstCall.args[ 1 ] ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 1 ] ).to.equal( 'marker' ); - expect( spy.thirdCall.args[ 1 ] ).to.equal( 'marker' ); - } ); - } ); - - describe( 'insertText()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create and insert text node with attributes at given position', () => { - const parent = batch.createDocumentFragment(); - - batch.insertText( 'foo', { bar: 'biz' }, new Position( parent, [ 0 ] ) ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Text ); - expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); - } ); - - it( 'should create and insert text node with no attributes at given position', () => { - const parent = batch.createDocumentFragment(); - - batch.insertText( 'foo', null, new Position( parent, [ 0 ] ) ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Text ); - expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create and insert text node omitting attributes param', () => { - const parent = batch.createDocumentFragment(); - - batch.insertText( 'foo', new Position( parent, [ 0 ] ) ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Text ); - expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create and insert text node at the beginning of given element', () => { - const parent = batch.createDocumentFragment(); - - batch.insert( batch.createElement( 'child' ), parent ); - - batch.insertText( 'foo', parent ); - - expect( parent.childCount ).to.equal( 2 ); - expect( parent.getChild( 0 ) ).to.instanceof( Text ); - expect( parent.getChild( 1 ) ).to.instanceof( Element ); - } ); - - it( 'should create and insert text node at the end of given element', () => { - const parent = batch.createDocumentFragment(); - - batch.insert( batch.createElement( 'child' ), parent ); - - batch.insertText( 'foo', parent, 'end' ); - - expect( parent.childCount ).to.equal( 2 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 1 ) ).to.instanceof( Text ); - } ); - - it( 'should create and insert text node at the given offset of given element', () => { - const parent = batch.createDocumentFragment(); - - batch.insert( batch.createElement( 'child' ), parent ); - batch.insert( batch.createElement( 'child' ), parent ); - - batch.insertText( 'foo', parent, 1 ); - - expect( parent.childCount ).to.equal( 3 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 1 ) ).to.instanceof( Text ); - expect( parent.getChild( 2 ) ).to.instanceof( Element ); - } ); - - it( 'should create and insert text node before the given node', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - - batch.insert( child1, parent ); - batch.insert( child2, parent, 'end' ); - - batch.insertText( 'foo', child2, 'before' ); - - expect( parent.childCount ).to.equal( 3 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 1 ) ).to.instanceof( Text ); - expect( parent.getChild( 2 ) ).to.instanceof( Element ); - } ); - - it( 'should create and insert text node after the given node', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child' ); - const child2 = batch.createElement( 'child' ); - - batch.insert( child1, parent ); - batch.insert( child2, parent, 'end' ); - - batch.insertText( 'foo', child1, 'after' ); - - expect( parent.childCount ).to.equal( 3 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 1 ) ).to.instanceof( Text ); - expect( parent.getChild( 2 ) ).to.instanceof( Element ); - } ); - - it( 'should create proper delta', () => { - const parent = batch.createDocumentFragment(); - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insertText( 'foo', parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - } ); - - describe( 'insertElement()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create and insert element with attributes at given position', () => { - const parent = batch.createDocumentFragment(); - - batch.insertElement( 'foo', { bar: 'biz' }, new Position( parent, [ 0 ] ) ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); - } ); - - it( 'should create and insert element with no attributes at given position', () => { - const parent = batch.createDocumentFragment(); - - batch.insertElement( 'foo', null, new Position( parent, [ 0 ] ) ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create and insert element with no attributes omitting attributes param', () => { - const parent = batch.createDocumentFragment(); - - batch.insertElement( 'foo', new Position( parent, [ 0 ] ) ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Element ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create and insert element at the beginning of given element', () => { - const parent = batch.createDocumentFragment(); - - batch.insert( batch.createElement( 'child' ), parent ); - - batch.insertElement( 'foo', parent ); - - expect( parent.childCount ).to.equal( 2 ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( parent.getChild( 1 ).name ).to.equal( 'child' ); - } ); - - it( 'should create and insert element at the end of given element', () => { - const parent = batch.createDocumentFragment(); - - batch.insert( batch.createElement( 'child' ), parent ); - - batch.insertElement( 'foo', parent, 'end' ); - - expect( parent.childCount ).to.equal( 2 ); - expect( parent.getChild( 0 ).name ).to.equal( 'child' ); - expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); - } ); - - it( 'should create and insert element at the given offset of given element', () => { - const parent = batch.createDocumentFragment(); - - batch.insert( batch.createElement( 'child1' ), parent ); - batch.insert( batch.createElement( 'child2' ), parent, 'end' ); - - batch.insertElement( 'foo', parent, 1 ); - - expect( parent.childCount ).to.equal( 3 ); - expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); - expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); - expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); - } ); - - it( 'should create and insert element before the given node', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child1' ); - const child2 = batch.createElement( 'child2' ); - - batch.insert( child1, parent ); - batch.insert( child2, parent, 'end' ); - - batch.insertElement( 'foo', child2, 'before' ); - - expect( parent.childCount ).to.equal( 3 ); - expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); - expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); - expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); - } ); - - it( 'should create and insert element after the given node', () => { - const parent = batch.createDocumentFragment(); - const child1 = batch.createElement( 'child1' ); - const child2 = batch.createElement( 'child2' ); - - batch.insert( child1, parent ); - batch.insert( child2, parent, 'end' ); - - batch.insertElement( 'foo', child1, 'after' ); - - expect( parent.childCount ).to.equal( 3 ); - expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); - expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); - expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); - } ); - - it( 'should create proper delta', () => { - const parent = batch.createDocumentFragment(); - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.insertText( 'foo', parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - } ); - - describe( 'append()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should insert element at the end of the parent', () => { - const parent = doc.batch().createDocumentFragment(); - const childText = doc.batch().createText( 'foo' ); - const childElement = doc.batch().createElement( 'foo' ); - - batch.append( childText, parent ); - batch.append( childElement, parent ); - - expect( Array.from( parent ) ).to.deep.equal( [ childText, childElement ] ); - } ); - - it( 'should create proper delta', () => { - const parent = batch.createDocumentFragment(); - const text = batch.createText( 'foo' ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.append( text, parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { - const rootA = doc.createRoot(); - const parent1 = batch.createElement( 'parent' ); - const parent2 = batch.createElement( 'parent' ); - const node = batch.createText( 'foo' ); - - batch.insert( node, parent1 ); - batch.insert( parent1, rootA ); - batch.insert( parent2, rootA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.append( node, parent2 ); - - // Verify result. - expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { - const rootA = doc.createRoot( '$root', 'A' ); - const rootB = doc.createRoot( '$root', 'B' ); - const node = batch.createText( 'foo' ); - - batch.insert( node, rootA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.append( node, rootB ); - - // Verify result. - expect( Array.from( rootA.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( rootB.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { - const docFragA = batch.createDocumentFragment(); - const parent1 = batch.createElement( 'parent' ); - const parent2 = batch.createElement( 'parent' ); - const node = batch.createText( 'foo' ); - - batch.insert( node, parent1 ); - batch.insert( parent1, docFragA ); - batch.insert( parent2, docFragA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.append( node, parent2 ); - - // Verify result. - expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { - const root = doc.createRoot(); - const docFrag = batch.createDocumentFragment(); - const node = batch.createText( 'foo' ); - - batch.insert( node, root ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.append( node, docFrag ); - - // Verify result. - expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { - const docFragA = batch.createDocumentFragment(); - const docFragB = batch.createDocumentFragment(); - const node = batch.createText( 'foo' ); - - batch.insert( node, docFragA ); - - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.append( node, docFragB ); - - // Verify result. - expect( Array.from( docFragA ) ).to.deep.equal( [] ); - expect( Array.from( docFragB ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'detach' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - } ); - - describe( 'appendText()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create and insert text node with attributes at the end of the parent', () => { - const parent = batch.createDocumentFragment(); - - batch.appendText( 'foo', { bar: 'biz' }, parent ); - batch.appendText( 'bar', { biz: 'bar' }, parent ); - - expect( parent.childCount ).to.equal( 2 ); - expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); - expect( parent.getChild( 1 ).data ).to.equal( 'bar' ); - expect( Array.from( parent.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'biz', 'bar' ] ] ); - } ); - - it( 'should create and insert text node with no attributes at the end of the parent', () => { - const parent = batch.createDocumentFragment(); - - batch.appendText( 'foo', null, parent ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Text ); - expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create and insert text node with no attributes omitting attributes param', () => { - const parent = batch.createDocumentFragment(); - - batch.appendText( 'foo', parent ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ) ).to.instanceof( Text ); - expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create proper delta and operations', () => { - const parent = batch.createDocumentFragment(); - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.appendText( 'foo', parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.firstCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - } ); - - describe( 'appendElement()', () => { - let doc, batch; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - } ); - - it( 'should create and insert element with attributes at the end of the parent', () => { - const parent = batch.createDocumentFragment(); - - batch.appendElement( 'foo', { bar: 'biz' }, parent ); - batch.appendElement( 'bar', { biz: 'bar' }, parent ); - - expect( parent.childCount ).to.equal( 2 ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); - expect( parent.getChild( 1 ).name ).to.equal( 'bar' ); - expect( Array.from( parent.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'biz', 'bar' ] ] ); - } ); - - it( 'should create and insert element with no attributes at the end of the parent', () => { - const parent = batch.createDocumentFragment(); - - batch.appendElement( 'foo', null, parent ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create and insert element with no attributes omitting attributes param', () => { - const parent = batch.createDocumentFragment(); - - batch.appendElement( 'foo', parent ); - - expect( parent.childCount ).to.equal( 1 ); - expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); - expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); - } ); - - it( 'should create proper delta and operation', () => { - const parent = batch.createDocumentFragment(); - const spy = sinon.spy( doc, 'applyOperation' ); - - batch.appendElement( 'foo', parent ); - - sinon.assert.calledOnce( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.firstCall.args[ 0 ].delta ).to.instanceof( InsertDelta ).to.not.instanceof( WeakInsertDelta ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - } ); - - describe( 'setAttribute() / removeAttribute()', () => { - let batch, doc, root, spy; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - batch = doc.batch(); - } ); - - describe( 'change attribute on node', () => { - let node, text; - - beforeEach( () => { - node = batch.createElement( 'p', { a: 1 } ); - text = batch.createText( 'c', { a: 1 } ); - - batch.append( node, root ); - batch.append( text, root ); - - spy = sinon.spy( doc, 'applyOperation' ); - } ); - - describe( 'setAttribute', () => { - it( 'should create the attribute on element', () => { - batch.setAttribute( 'b', 2, node ); - expect( spy.callCount ).to.equal( 1 ); - expect( node.getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of element', () => { - batch.setAttribute( 'a', 2, node ); - expect( spy.callCount ).to.equal( 1 ); - expect( node.getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should create the attribute on text node', () => { - batch.setAttribute( 'b', 2, text ); - expect( spy.callCount ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of text node', () => { - batch.setAttribute( 'a', 2, text ); - expect( spy.callCount ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should do nothing if the attribute value is the same', () => { - batch.setAttribute( 'a', 1, node ); - expect( spy.callCount ).to.equal( 0 ); - expect( node.getAttribute( 'a' ) ).to.equal( 1 ); - } ); - } ); - - describe( 'removeAttribute', () => { - it( 'should remove the attribute from element', () => { - batch.removeAttribute( 'a', node ); - expect( spy.callCount ).to.equal( 1 ); - expect( node.getAttribute( 'a' ) ).to.be.undefined; - } ); - - it( 'should remove the attribute from character', () => { - batch.removeAttribute( 'a', text ); - expect( spy.callCount ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.be.undefined; - } ); - - it( 'should do nothing if the attribute is not set', () => { - batch.removeAttribute( 'b', node ); - expect( spy.callCount ).to.equal( 0 ); - } ); - } ); - } ); - - describe( 'change attribute on range', () => { - beforeEach( () => { - const element = batch.createElement( 'e', { a: 2 } ); - - batch.appendText( 'xxx', { a: 1 }, root ); - batch.appendText( 'xxx', root ); - batch.appendText( 'xxx', { a: 1 }, root ); - batch.appendText( 'xxx', { a: 2 }, root ); - batch.appendText( 'xxx', root ); - batch.appendText( 'xxx', { a: 1 }, root ); - batch.appendText( 'xxx', element ); - batch.append( element, root ); - batch.appendText( 'xxx', root ); - - spy = sinon.spy( doc, 'applyOperation' ); - } ); - - function getRange( startIndex, endIndex ) { - return new Range( - Position.createFromParentAndOffset( root, startIndex ), - Position.createFromParentAndOffset( root, endIndex ) - ); - } - - function getChangesAttrsCount() { - let totalNumber = 0; - - for ( const delta of batch.deltas ) { - for ( const operation of delta.operations ) { - if ( operation.range ) { - totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); - } - } - } - - return totalNumber; - } - - function getCompressedAttrs() { - // default: 111---111222---1112------ - const range = Range.createIn( root ); - - return Array.from( range.getItems( { singleCharacters: true } ) ) - .map( item => item.getAttribute( 'a' ) || '-' ) - .join( '' ); - } - - describe( 'setAttribute', () => { - it( 'should set the attribute on the range', () => { - batch.setAttribute( 'a', 3, getRange( 3, 6 ) ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 3 ); - expect( getCompressedAttrs() ).to.equal( '111333111222---1112------' ); - } ); - - it( 'should split the operations if parts of the range have different attributes', () => { - batch.setAttribute( 'a', 3, getRange( 4, 14 ) ); - expect( spy.callCount ).to.equal( 4 ); - expect( getChangesAttrsCount() ).to.equal( 10 ); - expect( getCompressedAttrs() ).to.equal( '111-3333333333-1112------' ); - } ); - - it( 'should split the operations if parts of the part of the range have the attribute', () => { - batch.setAttribute( 'a', 2, getRange( 4, 14 ) ); - expect( spy.callCount ).to.equal( 3 ); - expect( getChangesAttrsCount() ).to.equal( 7 ); - expect( getCompressedAttrs() ).to.equal( '111-2222222222-1112------' ); - } ); - - it( 'should strip the range if the beginning have the attribute', () => { - batch.setAttribute( 'a', 1, getRange( 1, 5 ) ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '11111-111222---1112------' ); - } ); - - it( 'should strip the range if the ending have the attribute', () => { - batch.setAttribute( 'a', 1, getRange( 13, 17 ) ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '111---111222-111112------' ); - } ); - - it( 'should do nothing if the range has attribute', () => { - batch.setAttribute( 'a', 1, getRange( 0, 3 ) ); - expect( spy.callCount ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not check range\'s start position node when creating operations', () => { - const range = new Range( - new Position( root, [ 18, 1 ] ), - new Position( root, [ 19 ] ) - ); - - batch.setAttribute( 'a', 1, range ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112-11---' ); - } ); - - it( 'should not change elements attribute if range contains closing tag', () => { - const range = new Range( - new Position( root, [ 18, 1 ] ), - new Position( root, [ 21 ] ) - ); - - batch.setAttribute( 'a', 1, range ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 4 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112-1111-' ); - } ); - - it( 'should not create an operation if the range contains only closing tag', () => { - const range = new Range( - new Position( root, [ 18, 3 ] ), - new Position( root, [ 19 ] ) - ); - - batch.setAttribute( 'a', 3, range ); - expect( spy.callCount ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not create an operation if is collapsed', () => { - batch.setAttribute( 'a', 1, getRange( 3, 3 ) ); - expect( spy.callCount ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should create a proper operations for the mixed range', () => { - batch.setAttribute( 'a', 1, getRange( 0, 20 ) ); - expect( spy.callCount ).to.equal( 5 ); - expect( getChangesAttrsCount() ).to.equal( 14 ); - expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); - } ); - } ); - - describe( 'removeAttribute', () => { - it( 'should remove the attribute on the range', () => { - batch.removeAttribute( 'a', getRange( 0, 2 ) ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 2 ); - expect( getCompressedAttrs() ).to.equal( '--1---111222---1112------' ); - } ); - - it( 'should split the operations if parts of the range have different attributes', () => { - batch.removeAttribute( 'a', getRange( 7, 11 ) ); - expect( spy.callCount ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 4 ); - expect( getCompressedAttrs() ).to.equal( '111---1----2---1112------' ); - } ); - - it( 'should split the operations if parts of the part of the range have no attribute', () => { - batch.removeAttribute( 'a', getRange( 1, 7 ) ); - expect( spy.callCount ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 3 ); - expect( getCompressedAttrs() ).to.equal( '1------11222---1112------' ); - } ); - - it( 'should strip the range if the beginning have no attribute', () => { - batch.removeAttribute( 'a', getRange( 4, 12 ) ); - expect( spy.callCount ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 6 ); - expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); - } ); - - it( 'should strip the range if the ending have no attribute', () => { - batch.removeAttribute( 'a', getRange( 7, 15 ) ); - expect( spy.callCount ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 5 ); - expect( getCompressedAttrs() ).to.equal( '111---1--------1112------' ); - } ); - - it( 'should do nothing if the range has no attribute', () => { - batch.removeAttribute( 'a', getRange( 4, 5 ) ); - expect( spy.callCount ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not check range\'s start position node when creating operations', () => { - const range = new Range( - new Position( root, [ 18, 3 ] ), - new Position( root, [ 19 ] ) - ); - - batch.removeAttribute( 'a', range ); - expect( spy.callCount ).to.equal( 0 ); - expect( getChangesAttrsCount() ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should not apply operation twice in the range contains opening and closing tags', () => { - batch.removeAttribute( 'a', getRange( 18, 22 ) ); - expect( spy.callCount ).to.equal( 1 ); - expect( getChangesAttrsCount() ).to.equal( 1 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---111-------' ); - } ); - - it( 'should not create an operation if range is collapsed', () => { - batch.removeAttribute( 'a', getRange( 3, 3 ) ); - expect( spy.callCount ).to.equal( 0 ); - expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); - } ); - - it( 'should create a proper operations for the mixed range', () => { - batch.removeAttribute( 'a', getRange( 3, 15 ) ); - expect( spy.callCount ).to.equal( 2 ); - expect( getChangesAttrsCount() ).to.equal( 6 ); - expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); - } ); - } ); - } ); - - describe( 'change attribute on root element', () => { - let p; - - beforeEach( () => { - p = batch.createElement( 'p', { a: 3 } ); - spy = sinon.spy( doc, 'applyOperation' ); - } ); - - describe( 'setAttribute', () => { - it( 'should create the attribute on root', () => { - batch.setAttribute( 'b', 2, root ); - expect( spy.callCount ).to.equal( 1 ); - expect( root.getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should create the attribute on detached root', () => { - batch.setAttribute( 'b', 2, p ); - expect( spy.callCount ).to.equal( 1 ); - expect( p.getAttribute( 'b' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of root', () => { - batch.setAttribute( 'a', 2, root ); - expect( spy.callCount ).to.equal( 1 ); - expect( root.getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should change the attribute of detached root', () => { - batch.setAttribute( 'a', 2, p ); - expect( spy.callCount ).to.equal( 1 ); - expect( p.getAttribute( 'a' ) ).to.equal( 2 ); - } ); - - it( 'should do nothing if the attribute value is the same', () => { - batch.setAttribute( 'a', 1, root ); - expect( spy.callCount ).to.equal( 1 ); - batch.setAttribute( 'a', 1, root ); - expect( spy.callCount ).to.equal( 1 ); - expect( root.getAttribute( 'a' ) ).to.equal( 1 ); - } ); - - it( 'should do nothing if the attribute value is the same on detached root', () => { - batch.setAttribute( 'a', 1, p ); - expect( spy.callCount ).to.equal( 1 ); - batch.setAttribute( 'a', 1, p ); - expect( spy.callCount ).to.equal( 1 ); - expect( p.getAttribute( 'a' ) ).to.equal( 1 ); - } ); - } ); - - describe( 'removeAttribute', () => { - it( 'should remove the attribute from root', () => { - batch.setAttribute( 'a', 1, root ); - batch.removeAttribute( 'a', root ); - - expect( spy.callCount ).to.equal( 2 ); - expect( root.getAttribute( 'a' ) ).to.be.undefined; - } ); - - it( 'should do nothing if the attribute is not set', () => { - batch.removeAttribute( 'b', root ); - expect( spy.callCount ).to.equal( 0 ); - } ); - } ); - - describe( 'clearAttributes', () => { - it( 'should clear attributes from range', () => { - batch.appendText( 'xxx', { a: 1, b: 2, c: 3 }, root ); - batch.appendText( 'xxx', root ); - batch.appendText( 'xxx', { a: 1 }, root ); - batch.appendText( 'xxx', { b: 2 }, root ); - batch.appendText( 'xxx', root ); - batch.appendElement( 'e', { a: 1 }, root ); - batch.appendText( 'xxx', root ); - - const range = Range.createIn( root ); - - batch.clearAttributes( range ); - - let itemsCount = 0; - - for ( const item of range.getItems() ) { - itemsCount++; - expect( Array.from( item.getAttributeKeys() ).length ).to.equal( 0 ); - } - - expect( itemsCount ).to.equal( 3 ); - } ); - - it( 'should clear attributes on element', () => { - const element = batch.createElement( 'x', { a: 1, b: 2, c: 3 }, root ); - - expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 3 ); - - batch.clearAttributes( element ); - - expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); - } ); - - it( 'should clear attributes on root element', () => { - batch.setAttributes( { a: 1, b: 2, c: 3 }, root ); - - expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 3 ); - - batch.clearAttributes( root ); - - expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 0 ); - } ); - - it( 'should do nothing if there are no attributes', () => { - const element = batch.createElement( 'x' ); - - expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); - - batch.clearAttributes( element ); - - expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); - } ); - } ); - } ); - - it( 'should not add empty delta to the batch', () => { - const nodeA = new Element( 'p', { a: 1 } ); - const nodeB = new Element( 'p', { b: 2 } ); - root.insertChildren( 0, [ nodeA, nodeB ] ); - - batch.setAttribute( 'a', 1, nodeA ); - - expect( batch.deltas.length ).to.equal( 0 ); - - batch.removeAttribute( 'x', Range.createIn( root ) ); - - expect( batch.deltas.length ).to.equal( 0 ); - } ); - } ); - - describe( 'setAttributes()', () => { - let doc, batch, frag, item; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - - frag = batch.createDocumentFragment(); - item = batch.createText( 'xxx', { b: 2, c: 3 } ); - - batch.appendText( 'xxx', { a: 1 }, frag ); - batch.append( item, frag ); - } ); - - it( 'should set attributes one by one on range', () => { - const range = Range.createIn( frag ); - - // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate - // such a big amount of the same tests, so let's use a spy here. - const spy = sinon.spy( batch, 'setAttribute' ); - - batch.setAttributes( { a: 3, c: null }, range ); - - // Verify result. - expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); - expect( Array.from( frag.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); - - // Verify operations - sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, 'a', 3, range ); - sinon.assert.calledWith( spy.secondCall, 'c', null, range ); - } ); - - it( 'should set attributes one by one on range for map as attributes list', () => { - const range = Range.createIn( frag ); - - // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate - // such a big amount of the same tests, so let's use a spy here. - const spy = sinon.spy( batch, 'setAttribute' ); - - batch.setAttributes( new Map( [ [ 'a', 3 ], [ 'c', null ] ] ), range ); - - // Verify result. - expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); - expect( Array.from( frag.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); - - // Verify operations - sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, 'a', 3, range ); - sinon.assert.calledWith( spy.secondCall, 'c', null, range ); - } ); - - it( 'should set attributes one by one on item', () => { - // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate - // such a big amount of the same tests, so let's use a spy here. - const spy = sinon.spy( batch, 'setAttribute' ); - - batch.setAttributes( { a: 3, c: null }, item ); - - // Verify result. - expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); - - // Verify operations - sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, 'a', 3, item ); - sinon.assert.calledWith( spy.secondCall, 'c', null, item ); - } ); - - it( 'should set attributes one by one on item for maps as attributes list', () => { - // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate - // such a big amount of the same tests, so let's use a spy here. - const spy = sinon.spy( batch, 'setAttribute' ); - - batch.setAttributes( new Map( [ [ 'a', 3 ], [ 'c', null ] ] ), item ); - - // Verify result. - expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); - - // Verify operations - sinon.assert.calledTwice( spy ); - sinon.assert.calledWith( spy.firstCall, 'a', 3, item ); - sinon.assert.calledWith( spy.secondCall, 'c', null, item ); - } ); - } ); - - describe( 'merge()', () => { - let doc, root, p1, p2; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - p1 = new Element( 'p', { key1: 'value1' }, new Text( 'foo' ) ); - p2 = new Element( 'p', { key2: 'value2' }, new Text( 'bar' ) ); - - root.insertChildren( 0, [ p1, p2 ] ); - } ); - - it( 'should merge foo and bar into foobar', () => { - doc.batch().merge( new Position( root, [ 1 ] ) ); - - expect( root.maxOffset ).to.equal( 1 ); - expect( root.getChild( 0 ).name ).to.equal( 'p' ); - expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); - expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 0 ).getAttribute( 'key1' ) ).to.equal( 'value1' ); - expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); - } ); - - it( 'should throw if there is no element after', () => { - expect( () => { - doc.batch().merge( new Position( root, [ 2 ] ) ); - } ).to.throw( CKEditorError, /^batch-merge-no-element-after/ ); - } ); - - it( 'should throw if there is no element before', () => { - expect( () => { - doc.batch().merge( new Position( root, [ 0, 2 ] ) ); - } ).to.throw( CKEditorError, /^batch-merge-no-element-before/ ); - } ); - } ); - - describe( 'move()', () => { - let doc, root, range, div, p, batch; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - div = new Element( 'div', [], new Text( 'foobar' ) ); - p = new Element( 'p', [], new Text( 'abcxyz' ) ); - - div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); - div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); - - root.insertChildren( 0, [ div, p ] ); - - range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); - - batch = doc.batch(); - } ); - - it( 'should move flat range of nodes', () => { - batch.move( range, new Position( root, [ 1, 3 ] ) ); - - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggggPfoPhhhhP' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcobarxyz' ); - } ); - - it( 'should throw if object to move is not a range', () => { - expect( () => { - doc.batch().move( root.getChild( 0 ), new Position( root, [ 1, 3 ] ) ); - } ).to.throw( CKEditorError, /^batch-move-invalid-range/ ); - } ); - - it( 'should throw if given range is not flat', () => { - const notFlatRange = new Range( new Position( root, [ 0, 2, 2 ] ), new Position( root, [ 0, 6 ] ) ); - - expect( () => { - doc.batch().move( notFlatRange, new Position( root, [ 1, 3 ] ) ); - } ).to.throw( CKEditorError, /^batch-move-range-not-flat/ ); - } ); - - it( 'should throw if range is going to be moved to the other document', () => { - const docFrag = batch.createDocumentFragment(); - - expect( () => { - doc.batch().move( range, docFrag ); - } ).to.throw( CKEditorError, /^batch-move-different-document/ ); - } ); - } ); - - describe( 'remove()', () => { - let doc, batch, div, p, range; - - beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - - div = batch.createElement( 'div' ); - batch.appendText( 'foobar', div ); - - p = batch.createElement( 'p' ); - batch.appendText( 'abcxyz', p ); - - batch.insertElement( 'p', div ); - batch.appendElement( 'p', div ); - - batch.insertText( 'gggg', new Position( div, [ 0, 0 ] ) ); - batch.insertText( 'hhhh', new Position( div, [ 7, 0 ] ) ); - } ); - - describe( 'remove from document', () => { - let root; - - beforeEach( () => { - root = doc.createRoot(); - batch.append( div, root ); - batch.append( p, root ); - - // Reset batch. - batch = doc.batch(); - - // Range starts in ROOT > DIV > P > gg|gg. - // Range ends in ROOT > DIV > ...|ar. - range = new Range( new Position( root, [ 0, 0, 2 ] ), new Position( root, [ 0, 5 ] ) ); - } ); - - it( 'should remove specified node', () => { - batch.remove( div ); - - expect( root.maxOffset ).to.equal( 1 ); - expect( root.childCount ).to.equal( 1 ); - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); - } ); - - it( 'should remove specified text node', () => { - batch.remove( p.getChild( 0 ) ); - - expect( getNodesAndText( Range.createOn( p ) ) ).to.equal( 'PP' ); - } ); - - it( 'should remove any range of nodes', () => { - batch.remove( range ); - - expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); - expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); - } ); - - it( 'should create minimal number of remove deltas, each with only one operation', () => { - batch.remove( range ); - - expect( batch.deltas.length ).to.equal( 2 ); - expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); - expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); - } ); - - it( 'should use RemoveOperation', () => { - batch.remove( div ); - - expect( batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'remove' ); - } ); - } ); - - describe( 'remove from document fragment', () => { - let frag; - - beforeEach( () => { - frag = batch.createDocumentFragment(); - batch.append( div, frag ); - batch.append( p, frag ); - - // Reset batch. - batch = doc.batch(); - - // Range starts in FRAG > DIV > P > gg|gg. - // Range ends in FRAG > DIV > ...|ar. - range = new Range( new Position( frag, [ 0, 0, 2 ] ), new Position( frag, [ 0, 5 ] ) ); - } ); - - it( 'should remove specified node', () => { - batch.remove( div ); - - expect( frag.maxOffset ).to.equal( 1 ); - expect( frag.childCount ).to.equal( 1 ); - expect( getNodesAndText( Range.createIn( frag.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); - } ); - - it( 'should remove specified text node', () => { - batch.remove( p.getChild( 0 ) ); - - expect( getNodesAndText( Range.createOn( p ) ) ).to.equal( 'PP' ); - } ); - - it( 'should remove any range of nodes', () => { - batch.remove( range ); - - expect( getNodesAndText( Range.createIn( frag.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); - expect( getNodesAndText( Range.createIn( frag.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); - } ); - - it( 'should create minimal number of remove deltas, each with only one operation', () => { - batch.remove( range ); - - expect( batch.deltas.length ).to.equal( 2 ); - expect( batch.deltas[ 0 ].operations.length ).to.equal( 1 ); - expect( batch.deltas[ 1 ].operations.length ).to.equal( 1 ); - } ); - - it( 'should use DetachOperation', () => { - batch.remove( div ); - - expect( batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'detach' ); - } ); - } ); - } ); - - describe( 'rename()', () => { - let doc, root, batch; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - const p = new Element( 'p', null, new Text( 'abc' ) ); - root.appendChildren( p ); - - batch = doc.batch(); - - batch.rename( p, 'h' ); - } ); - - it( 'should rename given element', () => { - expect( root.maxOffset ).to.equal( 1 ); - expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); - } ); - - it( 'should throw if not an Element instance is passed', () => { - expect( () => { - batch.rename( new Text( 'abc' ), 'h' ); - } ).to.throw( CKEditorError, /^batch-rename-not-element-instance/ ); - } ); - } ); - - describe( 'split()', () => { - let doc, root, p; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - p = new Element( 'p', { key: 'value' }, new Text( 'foobar' ) ); - - root.insertChildren( 0, p ); - } ); - - it( 'should split foobar to foo and bar', () => { - doc.batch().split( new Position( root, [ 0, 3 ] ) ); - - expect( root.maxOffset ).to.equal( 2 ); - - expect( root.getChild( 0 ).name ).to.equal( 'p' ); - expect( root.getChild( 0 ).maxOffset ).to.equal( 3 ); - expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); - expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' ); - - expect( root.getChild( 1 ).name ).to.equal( 'p' ); - expect( root.getChild( 1 ).maxOffset ).to.equal( 3 ); - expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); - expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'bar' ); - } ); - - it( 'should create an empty paragraph if we split at the end', () => { - doc.batch().split( new Position( root, [ 0, 6 ] ) ); - - expect( root.maxOffset ).to.equal( 2 ); - - expect( root.getChild( 0 ).name ).to.equal( 'p' ); - expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); - expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); - expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); - - expect( root.getChild( 1 ).name ).to.equal( 'p' ); - expect( root.getChild( 1 ).maxOffset ).to.equal( 0 ); - expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); - expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); - } ); - - it( 'should throw if we try to split a root', () => { - expect( () => { - doc.batch().split( new Position( root, [ 0 ] ) ); - } ).to.throw( CKEditorError, /^batch-split-element-no-parent/ ); - } ); - - it( 'should throw if we try to split an element with no parent', () => { - const batch = doc.batch(); - - expect( () => { - const element = batch.createElement( 'p' ); - - batch.split( new Position( element, [ 0 ] ) ); - } ).to.throw( CKEditorError, /^batch-split-element-no-parent/ ); - } ); - - it( 'should throw if we try to split a document fragment', () => { - const batch = doc.batch(); - - expect( () => { - const documentFragment = batch.createDocumentFragment(); - - batch.split( new Position( documentFragment, [ 0 ] ) ); - } ).to.throw( CKEditorError, /^batch-split-element-no-parent/ ); - } ); - } ); - - describe( 'wrap()', () => { - let doc, root, range; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - root.insertChildren( 0, new Text( 'foobar' ) ); - - range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 4 ] ) ); - } ); - - it( 'should wrap flat range with given element', () => { - const p = new Element( 'p' ); - doc.batch().wrap( range, p ); - - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 0 ).data ).to.equal( 'fo' ); - expect( root.getChild( 1 ) ).to.equal( p ); - expect( p.getChild( 0 ).data ).to.equal( 'ob' ); - expect( root.getChild( 2 ).data ).to.equal( 'ar' ); - } ); - - it( 'should wrap flat range with an element of given name', () => { - doc.batch().wrap( range, 'p' ); - - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 0 ).data ).to.equal( 'fo' ); - expect( root.getChild( 1 ).name ).to.equal( 'p' ); - expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'ob' ); - expect( root.getChild( 2 ).data ).to.equal( 'ar' ); - } ); - - it( 'should throw if range to wrap is not flat', () => { - root.insertChildren( 1, [ new Element( 'p', [], new Text( 'xyz' ) ) ] ); - const notFlatRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6, 2 ] ) ); - - expect( () => { - doc.batch().wrap( notFlatRange, 'p' ); - } ).to.throw( CKEditorError, /^batch-wrap-range-not-flat/ ); - } ); - - it( 'should throw if element to wrap with has children #1', () => { - const p = new Element( 'p', [], new Text( 'a' ) ); - - expect( () => { - doc.batch().wrap( range, p ); - } ).to.throw( CKEditorError, /^batch-wrap-element-not-empty/ ); - } ); - - it( 'should throw if element to wrap with has children #2', () => { - const p = new Element( 'p' ); - root.insertChildren( 0, p ); - - expect( () => { - doc.batch().wrap( range, p ); - } ).to.throw( CKEditorError, /^batch-wrap-element-attached/ ); - } ); - } ); - - describe( 'unwrap()', () => { - let doc, root, p; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - - p = new Element( 'p', [], new Text( 'xyz' ) ); - root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); - } ); - - it( 'should unwrap given element', () => { - doc.batch().unwrap( p ); - - expect( root.maxOffset ).to.equal( 5 ); - expect( root.getChild( 0 ).data ).to.equal( 'axyzb' ); - } ); - - it( 'should throw if element to unwrap has no parent', () => { - const element = new Element( 'p' ); - - expect( () => { - doc.batch().unwrap( element ); - } ).to.throw( CKEditorError, /^batch-unwrap-element-no-parent/ ); - } ); - } ); - - describe( 'setMarker()', () => { - let doc, root, range; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - root.appendChildren( new Text( 'foo' ) ); - range = Range.createIn( root ); - } ); - - it( 'should add marker to the document marker collection', () => { - doc.batch().setMarker( 'name', range ); - - expect( doc.markers.get( 'name' ).getRange().isEqual( range ) ).to.be.true; - } ); - - it( 'should update marker in the document marker collection', () => { - doc.batch().setMarker( 'name', range ); - - const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); - doc.batch().setMarker( 'name', range2 ); - - expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; - } ); - - it( 'should accept marker instance', () => { - doc.batch().setMarker( 'name', range ); - const marker = doc.markers.get( 'name' ); - const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); - - const batch = doc.batch(); - batch.setMarker( marker, range2 ); - const op = batch.deltas[ 0 ].operations[ 0 ]; - - expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; - expect( op.oldRange.isEqual( range ) ).to.be.true; - expect( op.newRange.isEqual( range2 ) ).to.be.true; - } ); - - it( 'should accept empty range parameter if marker instance is passed', () => { - const marker = doc.markers.set( 'name', range ); - - sinon.spy( doc, 'fire' ); - - doc.on( 'change', ( evt, type, changes ) => { - if ( type == 'marker' ) { - expect( changes.type ).to.equal( 'set' ); - expect( changes.name ).to.equal( 'name' ); - } - } ); - - const batch = doc.batch(); - batch.setMarker( marker ); - const op = batch.deltas[ 0 ].operations[ 0 ]; - - expect( doc.fire.calledWith( 'change', 'marker' ) ).to.be.true; - expect( op.oldRange ).to.be.null; - expect( op.newRange.isEqual( range ) ).to.be.true; - } ); - - it( 'should throw if marker with given name does not exist and range is not passed', () => { - expect( () => { - doc.batch().setMarker( 'name' ); - } ).to.throw( CKEditorError, /^batch-setMarker-no-range/ ); - } ); - } ); - - describe( 'removeMarker()', () => { - let doc, root, range; - - beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); - root.appendChildren( new Text( 'foo' ) ); - range = Range.createIn( root ); - } ); - - it( 'should remove marker from the document marker collection', () => { - doc.batch().setMarker( 'name', range ); - doc.batch().removeMarker( 'name' ); - - expect( doc.markers.get( 'name' ) ).to.be.null; - } ); - - it( 'should throw when trying to remove non existing marker', () => { - expect( () => { - doc.batch().removeMarker( 'name' ); - } ).to.throw( CKEditorError, /^batch-removeMarker-no-marker/ ); - } ); - - it( 'should accept marker instance', () => { - doc.batch().setMarker( 'name', range ); - const marker = doc.markers.get( 'name' ); - - doc.batch().removeMarker( marker ); - - expect( doc.markers.get( 'name' ) ).to.be.null; - } ); - } ); } ); diff --git a/tests/model/writer.js b/tests/model/writer.js new file mode 100644 index 000000000..60ec5b884 --- /dev/null +++ b/tests/model/writer.js @@ -0,0 +1,1799 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import Model from '../../src/model/model'; +import Writer from '../../src/model/writer'; +import Batch from '../../src/model/batch'; +import InsertDelta from '../../src/model/delta/insertdelta'; +import WeakInsertDelta from '../../src/model/delta/weakinsertdelta'; + +import DocumentFragment from '../../src/model/documentfragment'; +import Element from '../../src/model/element'; +import Text from '../../src/model/text'; +import Position from '../../src/model/position'; +import Range from '../../src/model/range'; + +import count from '@ckeditor/ckeditor5-utils/src/count'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; + +import { getNodesAndText } from '../../tests/model/_utils/utils'; + +describe( 'Writer', () => { + let writer, model, batch, doc; + + beforeEach( () => { + model = new Model(); + batch = new Batch(); + writer = new Writer( model, batch ); + doc = model.document; + } ); + + describe( 'constructor()', () => { + it( 'should have model instance', () => { + expect( writer.model ).to.instanceof( Model ); + } ); + } ); + + describe( 'createText()', () => { + it( 'should create text node', () => { + const text = writer.createText( 'foo' ); + + expect( text ).to.instanceof( Text ); + expect( text.data ).to.equal( 'foo' ); + expect( Array.from( text.getAttributes() ) ).to.length( 0 ); + } ); + + it( 'should create text with attributes', () => { + const text = writer.createText( 'foo', { foo: 'bar', biz: 'baz' } ); + + expect( Array.from( text.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'biz', 'baz' ] ] ); + } ); + } ); + + describe( 'createElement()', () => { + it( 'should create element', () => { + const element = writer.createElement( 'foo' ); + + expect( element ).to.instanceof( Element ); + expect( element.name ).to.equal( 'foo' ); + expect( Array.from( element.getAttributes() ) ).to.length( 0 ); + } ); + + it( 'should create element with attributes', () => { + const element = writer.createText( 'foo', { foo: 'bar', biz: 'baz' } ); + + expect( Array.from( element.getAttributes() ) ).to.deep.equal( [ [ 'foo', 'bar' ], [ 'biz', 'baz' ] ] ); + } ); + } ); + + describe( 'createDocumentFragment()', () => { + it( 'should create element', () => { + const element = writer.createDocumentFragment(); + + expect( element ).to.instanceof( DocumentFragment ); + } ); + } ); + + describe( 'insert()', () => { + it( 'should insert node at given position', () => { + const parent = writer.createDocumentFragment(); + const child = writer.createElement( 'child' ); + const textChild = writer.createText( 'textChild' ); + + writer.insert( child, new Position( parent, [ 0 ] ) ); + writer.insert( textChild, new Position( parent, [ 1 ] ) ); + + expect( Array.from( parent ) ).to.deep.equal( [ child, textChild ] ); + } ); + + it( 'should insert node at the beginning of given element', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + + writer.insert( child1, parent ); + writer.insert( child2, parent ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child2, child1 ] ); + } ); + + it( 'should insert node at the end of given element', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + + writer.insert( child1, parent ); + writer.insert( child2, parent, 'end' ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2 ] ); + } ); + + it( 'should insert node at the given offset of given element', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + const child3 = writer.createElement( 'child' ); + + writer.insert( child3, parent ); + writer.insert( child1, parent ); + writer.insert( child2, parent, 1 ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); + } ); + + it( 'should insert node before the given node', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + const child3 = writer.createElement( 'child' ); + + writer.insert( child3, parent ); + writer.insert( child1, parent ); + writer.insert( child2, child3, 'before' ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); + } ); + + it( 'should insert node after the given node', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + const child3 = writer.createElement( 'child' ); + + writer.insert( child3, parent ); + writer.insert( child1, parent ); + writer.insert( child2, child1, 'after' ); + + expect( Array.from( parent.getChildren() ) ).to.deep.equal( [ child1, child2, child3 ] ); + } ); + + it( 'should create proper delta for inserting element', () => { + const parent = writer.createDocumentFragment(); + const element = writer.createElement( 'child' ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( element, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should create proper delta for inserting text', () => { + const parent = writer.createDocumentFragment(); + const text = writer.createText( 'child' ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( text, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { + const rootA = doc.createRoot(); + const parent1 = writer.createElement( 'parent' ); + const parent2 = writer.createElement( 'parent' ); + const node = writer.createText( 'foo' ); + + writer.insert( node, parent1 ); + writer.insert( parent1, rootA ); + writer.insert( parent2, rootA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( node, parent2 ); + + // Verify result. + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { + const rootA = doc.createRoot( '$root', 'A' ); + const rootB = doc.createRoot( '$root', 'B' ); + const node = writer.createText( 'foo' ); + + writer.insert( node, rootA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( node, rootB ); + + // Verify result. + expect( Array.from( rootA.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( rootB.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { + const docFragA = writer.createDocumentFragment(); + const parent1 = writer.createElement( 'parent' ); + const parent2 = writer.createElement( 'parent' ); + const node = writer.createText( 'foo' ); + + writer.insert( node, parent1 ); + writer.insert( parent1, docFragA ); + writer.insert( parent2, docFragA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( node, parent2 ); + + // Verify result. + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { + const root = doc.createRoot(); + const docFrag = writer.createDocumentFragment(); + const node = writer.createText( 'foo' ); + + writer.insert( node, root ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( node, docFrag ); + + // Verify result. + expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { + const docFragA = writer.createDocumentFragment(); + const docFragB = writer.createDocumentFragment(); + const node = writer.createText( 'foo' ); + + writer.insert( node, docFragA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insert( node, docFragB ); + + // Verify result. + expect( Array.from( docFragA ) ).to.deep.equal( [] ); + expect( Array.from( docFragB ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'detach' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should transfer markers from given DocumentFragment', () => { + const root = doc.createRoot(); + const docFrag = writer.createDocumentFragment(); + + writer.appendText( 'abcd', root ); + writer.appendElement( 'p', docFrag ); + writer.insertText( 'foo bar', new Position( docFrag, [ 0, 0 ] ) ); + + const marker = new Range( new Position( docFrag, [ 0, 1 ] ), new Position( docFrag, [ 0, 5 ] ) ); + + docFrag.markers.set( 'marker', marker ); + + writer.insert( docFrag, new Position( root, [ 2 ] ) ); + + expect( Array.from( model.markers ).length ).to.equal( 1 ); + + const range = model.markers.get( 'marker' ).getRange(); + expect( range.root ).to.equal( root ); + expect( range.start.path ).to.deep.equal( [ 2, 1 ] ); + expect( range.end.path ).to.deep.equal( [ 2, 5 ] ); + } ); + + it( 'should set each marker as a separate operation', () => { + const spy = sinon.spy(); + const root = doc.createRoot(); + const docFrag = writer.createDocumentFragment(); + + writer.appendText( 'abcd', root ); + writer.appendElement( 'p', docFrag ); + writer.insertText( 'foo bar', new Position( docFrag, [ 0, 0 ] ) ); + + const marker1 = new Range( new Position( docFrag, [ 0, 1 ] ), new Position( docFrag, [ 0, 2 ] ) ); + const marker2 = new Range( new Position( docFrag, [ 0, 5 ] ), new Position( docFrag, [ 0, 6 ] ) ); + + docFrag.markers.set( 'marker1', marker1 ); + docFrag.markers.set( 'marker2', marker2 ); + + model.on( 'change', spy ); + + writer.insert( docFrag, new Position( root, [ 2 ] ) ); + + sinon.assert.calledThrice( spy ); + expect( spy.firstCall.args[ 1 ] ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 1 ] ).to.equal( 'marker' ); + expect( spy.thirdCall.args[ 1 ] ).to.equal( 'marker' ); + } ); + } ); + + describe( 'insertText()', () => { + it( 'should create and insert text node with attributes at given position', () => { + const parent = writer.createDocumentFragment(); + + writer.insertText( 'foo', { bar: 'biz' }, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + } ); + + it( 'should create and insert text node with no attributes at given position', () => { + const parent = writer.createDocumentFragment(); + + writer.insertText( 'foo', null, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert text node omitting attributes param', () => { + const parent = writer.createDocumentFragment(); + + writer.insertText( 'foo', new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert text node at the beginning of given element', () => { + const parent = writer.createDocumentFragment(); + + writer.insert( writer.createElement( 'child' ), parent ); + + writer.insertText( 'foo', parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 1 ) ).to.instanceof( Element ); + } ); + + it( 'should create and insert text node at the end of given element', () => { + const parent = writer.createDocumentFragment(); + + writer.insert( writer.createElement( 'child' ), parent ); + + writer.insertText( 'foo', parent, 'end' ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + } ); + + it( 'should create and insert text node at the given offset of given element', () => { + const parent = writer.createDocumentFragment(); + + writer.insert( writer.createElement( 'child' ), parent ); + writer.insert( writer.createElement( 'child' ), parent ); + + writer.insertText( 'foo', parent, 1 ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + expect( parent.getChild( 2 ) ).to.instanceof( Element ); + } ); + + it( 'should create and insert text node before the given node', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + + writer.insert( child1, parent ); + writer.insert( child2, parent, 'end' ); + + writer.insertText( 'foo', child2, 'before' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + expect( parent.getChild( 2 ) ).to.instanceof( Element ); + } ); + + it( 'should create and insert text node after the given node', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child' ); + const child2 = writer.createElement( 'child' ); + + writer.insert( child1, parent ); + writer.insert( child2, parent, 'end' ); + + writer.insertText( 'foo', child1, 'after' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 1 ) ).to.instanceof( Text ); + expect( parent.getChild( 2 ) ).to.instanceof( Element ); + } ); + + it( 'should create proper delta', () => { + const parent = writer.createDocumentFragment(); + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insertText( 'foo', parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + } ); + + describe( 'insertElement()', () => { + it( 'should create and insert element with attributes at given position', () => { + const parent = writer.createDocumentFragment(); + + writer.insertElement( 'foo', { bar: 'biz' }, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + } ); + + it( 'should create and insert element with no attributes at given position', () => { + const parent = writer.createDocumentFragment(); + + writer.insertElement( 'foo', null, new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert element with no attributes omitting attributes param', () => { + const parent = writer.createDocumentFragment(); + + writer.insertElement( 'foo', new Position( parent, [ 0 ] ) ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Element ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert element at the beginning of given element', () => { + const parent = writer.createDocumentFragment(); + + writer.insert( writer.createElement( 'child' ), parent ); + + writer.insertElement( 'foo', parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 1 ).name ).to.equal( 'child' ); + } ); + + it( 'should create and insert element at the end of given element', () => { + const parent = writer.createDocumentFragment(); + + writer.insert( writer.createElement( 'child' ), parent ); + + writer.insertElement( 'foo', parent, 'end' ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + } ); + + it( 'should create and insert element at the given offset of given element', () => { + const parent = writer.createDocumentFragment(); + + writer.insert( writer.createElement( 'child1' ), parent ); + writer.insert( writer.createElement( 'child2' ), parent, 'end' ); + + writer.insertElement( 'foo', parent, 1 ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); + } ); + + it( 'should create and insert element before the given node', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child1' ); + const child2 = writer.createElement( 'child2' ); + + writer.insert( child1, parent ); + writer.insert( child2, parent, 'end' ); + + writer.insertElement( 'foo', child2, 'before' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); + } ); + + it( 'should create and insert element after the given node', () => { + const parent = writer.createDocumentFragment(); + const child1 = writer.createElement( 'child1' ); + const child2 = writer.createElement( 'child2' ); + + writer.insert( child1, parent ); + writer.insert( child2, parent, 'end' ); + + writer.insertElement( 'foo', child1, 'after' ); + + expect( parent.childCount ).to.equal( 3 ); + expect( parent.getChild( 0 ).name ).to.equal( 'child1' ); + expect( parent.getChild( 1 ).name ).to.equal( 'foo' ); + expect( parent.getChild( 2 ).name ).to.equal( 'child2' ); + } ); + + it( 'should create proper delta', () => { + const parent = writer.createDocumentFragment(); + const spy = sinon.spy( model, 'applyOperation' ); + + writer.insertText( 'foo', parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta ).to.instanceof( InsertDelta ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + } ); + + describe( 'append()', () => { + it( 'should insert element at the end of the parent', () => { + const parent = writer.createDocumentFragment(); + const childText = writer.createText( 'foo' ); + const childElement = writer.createElement( 'foo' ); + + writer.append( childText, parent ); + writer.append( childElement, parent ); + + expect( Array.from( parent ) ).to.deep.equal( [ childText, childElement ] ); + } ); + + it( 'should create proper delta', () => { + const parent = writer.createDocumentFragment(); + const text = writer.createText( 'foo' ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.append( text, parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.lastCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { + const rootA = doc.createRoot(); + const parent1 = writer.createElement( 'parent' ); + const parent2 = writer.createElement( 'parent' ); + const node = writer.createText( 'foo' ); + + writer.insert( node, parent1 ); + writer.insert( parent1, rootA ); + writer.insert( parent2, rootA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.append( node, parent2 ); + + // Verify result. + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { + const rootA = doc.createRoot( '$root', 'A' ); + const rootB = doc.createRoot( '$root', 'B' ); + const node = writer.createText( 'foo' ); + + writer.insert( node, rootA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.append( node, rootB ); + + // Verify result. + expect( Array.from( rootA.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( rootB.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { + const docFragA = writer.createDocumentFragment(); + const parent1 = writer.createElement( 'parent' ); + const parent2 = writer.createElement( 'parent' ); + const node = writer.createText( 'foo' ); + + writer.insert( node, parent1 ); + writer.insert( parent1, docFragA ); + writer.insert( parent2, docFragA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.append( node, parent2 ); + + // Verify result. + expect( Array.from( parent1.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( parent2.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'move' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { + const root = doc.createRoot(); + const docFrag = writer.createDocumentFragment(); + const node = writer.createText( 'foo' ); + + writer.insert( node, root ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.append( node, docFrag ); + + // Verify result. + expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); + expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + + it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { + const docFragA = writer.createDocumentFragment(); + const docFragB = writer.createDocumentFragment(); + const node = writer.createText( 'foo' ); + + writer.insert( node, docFragA ); + + const spy = sinon.spy( model, 'applyOperation' ); + + writer.append( node, docFragB ); + + // Verify result. + expect( Array.from( docFragA ) ).to.deep.equal( [] ); + expect( Array.from( docFragB ) ).to.deep.equal( [ node ] ); + + // Verify deltas and operations. + sinon.assert.calledTwice( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'detach' ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + } ); + + describe( 'appendText()', () => { + it( 'should create and insert text node with attributes at the end of the parent', () => { + const parent = writer.createDocumentFragment(); + + writer.appendText( 'foo', { bar: 'biz' }, parent ); + writer.appendText( 'bar', { biz: 'bar' }, parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + expect( parent.getChild( 1 ).data ).to.equal( 'bar' ); + expect( Array.from( parent.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'biz', 'bar' ] ] ); + } ); + + it( 'should create and insert text node with no attributes at the end of the parent', () => { + const parent = writer.createDocumentFragment(); + + writer.appendText( 'foo', null, parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert text node with no attributes omitting attributes param', () => { + const parent = writer.createDocumentFragment(); + + writer.appendText( 'foo', parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ) ).to.instanceof( Text ); + expect( parent.getChild( 0 ).data ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create proper delta and operations', () => { + const parent = writer.createDocumentFragment(); + const spy = sinon.spy( model, 'applyOperation' ); + + writer.appendText( 'foo', parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.firstCall.args[ 0 ].delta ).to.instanceof( WeakInsertDelta ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + } ); + + describe( 'appendElement()', () => { + it( 'should create and insert element with attributes at the end of the parent', () => { + const parent = writer.createDocumentFragment(); + + writer.appendElement( 'foo', { bar: 'biz' }, parent ); + writer.appendElement( 'bar', { biz: 'bar' }, parent ); + + expect( parent.childCount ).to.equal( 2 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'bar', 'biz' ] ] ); + expect( parent.getChild( 1 ).name ).to.equal( 'bar' ); + expect( Array.from( parent.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'biz', 'bar' ] ] ); + } ); + + it( 'should create and insert element with no attributes at the end of the parent', () => { + const parent = writer.createDocumentFragment(); + + writer.appendElement( 'foo', null, parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create and insert element with no attributes omitting attributes param', () => { + const parent = writer.createDocumentFragment(); + + writer.appendElement( 'foo', parent ); + + expect( parent.childCount ).to.equal( 1 ); + expect( parent.getChild( 0 ).name ).to.equal( 'foo' ); + expect( Array.from( parent.getChild( 0 ).getAttributes() ) ).to.deep.equal( [] ); + } ); + + it( 'should create proper delta and operation', () => { + const parent = writer.createDocumentFragment(); + const spy = sinon.spy( model, 'applyOperation' ); + + writer.appendElement( 'foo', parent ); + + sinon.assert.calledOnce( spy ); + expect( spy.firstCall.args[ 0 ].type ).to.equal( 'insert' ); + expect( spy.firstCall.args[ 0 ].delta ).to.instanceof( InsertDelta ).to.not.instanceof( WeakInsertDelta ); + expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); + } ); + } ); + + describe( 'setAttribute() / removeAttribute()', () => { + let root, spy; + + beforeEach( () => { + root = doc.createRoot(); + } ); + + describe( 'change attribute on node', () => { + let node, text; + + beforeEach( () => { + node = writer.createElement( 'p', { a: 1 } ); + text = writer.createText( 'c', { a: 1 } ); + + writer.append( node, root ); + writer.append( text, root ); + + spy = sinon.spy( model, 'applyOperation' ); + } ); + + describe( 'setAttribute', () => { + it( 'should create the attribute on element', () => { + writer.setAttribute( 'b', 2, node ); + expect( spy.callCount ).to.equal( 1 ); + expect( node.getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of element', () => { + writer.setAttribute( 'a', 2, node ); + expect( spy.callCount ).to.equal( 1 ); + expect( node.getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should create the attribute on text node', () => { + writer.setAttribute( 'b', 2, text ); + expect( spy.callCount ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of text node', () => { + writer.setAttribute( 'a', 2, text ); + expect( spy.callCount ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should do nothing if the attribute value is the same', () => { + writer.setAttribute( 'a', 1, node ); + expect( spy.callCount ).to.equal( 0 ); + expect( node.getAttribute( 'a' ) ).to.equal( 1 ); + } ); + } ); + + describe( 'removeAttribute', () => { + it( 'should remove the attribute from element', () => { + writer.removeAttribute( 'a', node ); + expect( spy.callCount ).to.equal( 1 ); + expect( node.getAttribute( 'a' ) ).to.be.undefined; + } ); + + it( 'should remove the attribute from character', () => { + writer.removeAttribute( 'a', text ); + expect( spy.callCount ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'a' ) ).to.be.undefined; + } ); + + it( 'should do nothing if the attribute is not set', () => { + writer.removeAttribute( 'b', node ); + expect( spy.callCount ).to.equal( 0 ); + } ); + } ); + } ); + + describe( 'change attribute on range', () => { + beforeEach( () => { + const element = writer.createElement( 'e', { a: 2 } ); + + writer.appendText( 'xxx', { a: 1 }, root ); + writer.appendText( 'xxx', root ); + writer.appendText( 'xxx', { a: 1 }, root ); + writer.appendText( 'xxx', { a: 2 }, root ); + writer.appendText( 'xxx', root ); + writer.appendText( 'xxx', { a: 1 }, root ); + writer.appendText( 'xxx', element ); + writer.append( element, root ); + writer.appendText( 'xxx', root ); + + spy = sinon.spy( model, 'applyOperation' ); + } ); + + function getRange( startIndex, endIndex ) { + return new Range( + Position.createFromParentAndOffset( root, startIndex ), + Position.createFromParentAndOffset( root, endIndex ) + ); + } + + function getChangesAttrsCount() { + let totalNumber = 0; + + for ( const delta of writer._batch.deltas ) { + for ( const operation of delta.operations ) { + if ( operation.range ) { + totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); + } + } + } + + return totalNumber; + } + + function getCompressedAttrs() { + // default: 111---111222---1112------ + const range = Range.createIn( root ); + + return Array.from( range.getItems( { singleCharacters: true } ) ) + .map( item => item.getAttribute( 'a' ) || '-' ) + .join( '' ); + } + + describe( 'setAttribute', () => { + it( 'should set the attribute on the range', () => { + writer.setAttribute( 'a', 3, getRange( 3, 6 ) ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 3 ); + expect( getCompressedAttrs() ).to.equal( '111333111222---1112------' ); + } ); + + it( 'should split the operations if parts of the range have different attributes', () => { + writer.setAttribute( 'a', 3, getRange( 4, 14 ) ); + expect( spy.callCount ).to.equal( 4 ); + expect( getChangesAttrsCount() ).to.equal( 10 ); + expect( getCompressedAttrs() ).to.equal( '111-3333333333-1112------' ); + } ); + + it( 'should split the operations if parts of the part of the range have the attribute', () => { + writer.setAttribute( 'a', 2, getRange( 4, 14 ) ); + expect( spy.callCount ).to.equal( 3 ); + expect( getChangesAttrsCount() ).to.equal( 7 ); + expect( getCompressedAttrs() ).to.equal( '111-2222222222-1112------' ); + } ); + + it( 'should strip the range if the beginning have the attribute', () => { + writer.setAttribute( 'a', 1, getRange( 1, 5 ) ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '11111-111222---1112------' ); + } ); + + it( 'should strip the range if the ending have the attribute', () => { + writer.setAttribute( 'a', 1, getRange( 13, 17 ) ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '111---111222-111112------' ); + } ); + + it( 'should do nothing if the range has attribute', () => { + writer.setAttribute( 'a', 1, getRange( 0, 3 ) ); + expect( spy.callCount ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not check range\'s start position node when creating operations', () => { + const range = new Range( + new Position( root, [ 18, 1 ] ), + new Position( root, [ 19 ] ) + ); + + writer.setAttribute( 'a', 1, range ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112-11---' ); + } ); + + it( 'should not change elements attribute if range contains closing tag', () => { + const range = new Range( + new Position( root, [ 18, 1 ] ), + new Position( root, [ 21 ] ) + ); + + writer.setAttribute( 'a', 1, range ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 4 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112-1111-' ); + } ); + + it( 'should not create an operation if the range contains only closing tag', () => { + const range = new Range( + new Position( root, [ 18, 3 ] ), + new Position( root, [ 19 ] ) + ); + + writer.setAttribute( 'a', 3, range ); + expect( spy.callCount ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not create an operation if is collapsed', () => { + writer.setAttribute( 'a', 1, getRange( 3, 3 ) ); + expect( spy.callCount ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should create a proper operations for the mixed range', () => { + writer.setAttribute( 'a', 1, getRange( 0, 20 ) ); + expect( spy.callCount ).to.equal( 5 ); + expect( getChangesAttrsCount() ).to.equal( 14 ); + expect( getCompressedAttrs() ).to.equal( '11111111111111111111111--' ); + } ); + } ); + + describe( 'removeAttribute', () => { + it( 'should remove the attribute on the range', () => { + writer.removeAttribute( 'a', getRange( 0, 2 ) ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 2 ); + expect( getCompressedAttrs() ).to.equal( '--1---111222---1112------' ); + } ); + + it( 'should split the operations if parts of the range have different attributes', () => { + writer.removeAttribute( 'a', getRange( 7, 11 ) ); + expect( spy.callCount ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 4 ); + expect( getCompressedAttrs() ).to.equal( '111---1----2---1112------' ); + } ); + + it( 'should split the operations if parts of the part of the range have no attribute', () => { + writer.removeAttribute( 'a', getRange( 1, 7 ) ); + expect( spy.callCount ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 3 ); + expect( getCompressedAttrs() ).to.equal( '1------11222---1112------' ); + } ); + + it( 'should strip the range if the beginning have no attribute', () => { + writer.removeAttribute( 'a', getRange( 4, 12 ) ); + expect( spy.callCount ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 6 ); + expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); + } ); + + it( 'should strip the range if the ending have no attribute', () => { + writer.removeAttribute( 'a', getRange( 7, 15 ) ); + expect( spy.callCount ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 5 ); + expect( getCompressedAttrs() ).to.equal( '111---1--------1112------' ); + } ); + + it( 'should do nothing if the range has no attribute', () => { + writer.removeAttribute( 'a', getRange( 4, 5 ) ); + expect( spy.callCount ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not check range\'s start position node when creating operations', () => { + const range = new Range( + new Position( root, [ 18, 3 ] ), + new Position( root, [ 19 ] ) + ); + + writer.removeAttribute( 'a', range ); + expect( spy.callCount ).to.equal( 0 ); + expect( getChangesAttrsCount() ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should not apply operation twice in the range contains opening and closing tags', () => { + writer.removeAttribute( 'a', getRange( 18, 22 ) ); + expect( spy.callCount ).to.equal( 1 ); + expect( getChangesAttrsCount() ).to.equal( 1 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---111-------' ); + } ); + + it( 'should not create an operation if range is collapsed', () => { + writer.removeAttribute( 'a', getRange( 3, 3 ) ); + expect( spy.callCount ).to.equal( 0 ); + expect( getCompressedAttrs() ).to.equal( '111---111222---1112------' ); + } ); + + it( 'should create a proper operations for the mixed range', () => { + writer.removeAttribute( 'a', getRange( 3, 15 ) ); + expect( spy.callCount ).to.equal( 2 ); + expect( getChangesAttrsCount() ).to.equal( 6 ); + expect( getCompressedAttrs() ).to.equal( '111------------1112------' ); + } ); + } ); + } ); + + describe( 'change attribute on root element', () => { + let p; + + beforeEach( () => { + p = writer.createElement( 'p', { a: 3 } ); + spy = sinon.spy( model, 'applyOperation' ); + } ); + + describe( 'setAttribute', () => { + it( 'should create the attribute on root', () => { + writer.setAttribute( 'b', 2, root ); + expect( spy.callCount ).to.equal( 1 ); + expect( root.getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should create the attribute on detached root', () => { + writer.setAttribute( 'b', 2, p ); + expect( spy.callCount ).to.equal( 1 ); + expect( p.getAttribute( 'b' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of root', () => { + writer.setAttribute( 'a', 2, root ); + expect( spy.callCount ).to.equal( 1 ); + expect( root.getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should change the attribute of detached root', () => { + writer.setAttribute( 'a', 2, p ); + expect( spy.callCount ).to.equal( 1 ); + expect( p.getAttribute( 'a' ) ).to.equal( 2 ); + } ); + + it( 'should do nothing if the attribute value is the same', () => { + writer.setAttribute( 'a', 1, root ); + expect( spy.callCount ).to.equal( 1 ); + writer.setAttribute( 'a', 1, root ); + expect( spy.callCount ).to.equal( 1 ); + expect( root.getAttribute( 'a' ) ).to.equal( 1 ); + } ); + + it( 'should do nothing if the attribute value is the same on detached root', () => { + writer.setAttribute( 'a', 1, p ); + expect( spy.callCount ).to.equal( 1 ); + writer.setAttribute( 'a', 1, p ); + expect( spy.callCount ).to.equal( 1 ); + expect( p.getAttribute( 'a' ) ).to.equal( 1 ); + } ); + } ); + + describe( 'removeAttribute', () => { + it( 'should remove the attribute from root', () => { + writer.setAttribute( 'a', 1, root ); + writer.removeAttribute( 'a', root ); + + expect( spy.callCount ).to.equal( 2 ); + expect( root.getAttribute( 'a' ) ).to.be.undefined; + } ); + + it( 'should do nothing if the attribute is not set', () => { + writer.removeAttribute( 'b', root ); + expect( spy.callCount ).to.equal( 0 ); + } ); + } ); + + describe( 'clearAttributes', () => { + it( 'should clear attributes from range', () => { + writer.appendText( 'xxx', { a: 1, b: 2, c: 3 }, root ); + writer.appendText( 'xxx', root ); + writer.appendText( 'xxx', { a: 1 }, root ); + writer.appendText( 'xxx', { b: 2 }, root ); + writer.appendText( 'xxx', root ); + writer.appendElement( 'e', { a: 1 }, root ); + writer.appendText( 'xxx', root ); + + const range = Range.createIn( root ); + + writer.clearAttributes( range ); + + let itemsCount = 0; + + for ( const item of range.getItems() ) { + itemsCount++; + expect( Array.from( item.getAttributeKeys() ).length ).to.equal( 0 ); + } + + expect( itemsCount ).to.equal( 3 ); + } ); + + it( 'should clear attributes on element', () => { + const element = writer.createElement( 'x', { a: 1, b: 2, c: 3 }, root ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 3 ); + + writer.clearAttributes( element ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); + } ); + + it( 'should clear attributes on root element', () => { + writer.setAttributes( { a: 1, b: 2, c: 3 }, root ); + + expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 3 ); + + writer.clearAttributes( root ); + + expect( Array.from( root.getAttributeKeys() ).length ).to.equal( 0 ); + } ); + + it( 'should do nothing if there are no attributes', () => { + const element = writer.createElement( 'x' ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); + + writer.clearAttributes( element ); + + expect( Array.from( element.getAttributeKeys() ).length ).to.equal( 0 ); + } ); + } ); + } ); + + it( 'should not add empty delta to the batch', () => { + const nodeA = new Element( 'p', { a: 1 } ); + const nodeB = new Element( 'p', { b: 2 } ); + root.insertChildren( 0, [ nodeA, nodeB ] ); + + writer.setAttribute( 'a', 1, nodeA ); + + expect( writer._batch.deltas.length ).to.equal( 0 ); + + writer.removeAttribute( 'x', Range.createIn( root ) ); + + expect( writer._batch.deltas.length ).to.equal( 0 ); + } ); + } ); + + describe( 'setAttributes()', () => { + let frag, item; + + beforeEach( () => { + frag = writer.createDocumentFragment(); + item = writer.createText( 'xxx', { b: 2, c: 3 } ); + + writer.appendText( 'xxx', { a: 1 }, frag ); + writer.append( item, frag ); + } ); + + it( 'should set attributes one by one on range', () => { + const range = Range.createIn( frag ); + + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( writer, 'setAttribute' ); + + writer.setAttributes( { a: 3, c: null }, range ); + + // Verify result. + expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); + expect( Array.from( frag.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, range ); + sinon.assert.calledWith( spy.secondCall, 'c', null, range ); + } ); + + it( 'should set attributes one by one on range for map as attributes list', () => { + const range = Range.createIn( frag ); + + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( writer, 'setAttribute' ); + + writer.setAttributes( new Map( [ [ 'a', 3 ], [ 'c', null ] ] ), range ); + + // Verify result. + expect( Array.from( frag.getChild( 0 ).getAttributes() ) ).to.deep.equal( [ [ 'a', 3 ] ] ); + expect( Array.from( frag.getChild( 1 ).getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, range ); + sinon.assert.calledWith( spy.secondCall, 'c', null, range ); + } ); + + it( 'should set attributes one by one on item', () => { + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( writer, 'setAttribute' ); + + writer.setAttributes( { a: 3, c: null }, item ); + + // Verify result. + expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, item ); + sinon.assert.calledWith( spy.secondCall, 'c', null, item ); + } ); + + it( 'should set attributes one by one on item for maps as attributes list', () => { + // `setAttribute` is a not trivial operation and is deeply tested above, there is no point to duplicate + // such a big amount of the same tests, so let's use a spy here. + const spy = sinon.spy( writer, 'setAttribute' ); + + writer.setAttributes( new Map( [ [ 'a', 3 ], [ 'c', null ] ] ), item ); + + // Verify result. + expect( Array.from( item.getAttributes() ) ).to.deep.equal( [ [ 'b', 2 ], [ 'a', 3 ] ] ); + + // Verify operations + sinon.assert.calledTwice( spy ); + sinon.assert.calledWith( spy.firstCall, 'a', 3, item ); + sinon.assert.calledWith( spy.secondCall, 'c', null, item ); + } ); + } ); + + describe( 'merge()', () => { + let root, p1, p2; + + beforeEach( () => { + root = doc.createRoot(); + + p1 = new Element( 'p', { key1: 'value1' }, new Text( 'foo' ) ); + p2 = new Element( 'p', { key2: 'value2' }, new Text( 'bar' ) ); + + root.insertChildren( 0, [ p1, p2 ] ); + } ); + + it( 'should merge foo and bar into foobar', () => { + writer.merge( new Position( root, [ 1 ] ) ); + + expect( root.maxOffset ).to.equal( 1 ); + expect( root.getChild( 0 ).name ).to.equal( 'p' ); + expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'key1' ) ).to.equal( 'value1' ); + expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); + } ); + + it( 'should throw if there is no element after', () => { + expect( () => { + writer.merge( new Position( root, [ 2 ] ) ); + } ).to.throw( CKEditorError, /^writer-merge-no-element-after/ ); + } ); + + it( 'should throw if there is no element before', () => { + expect( () => { + writer.merge( new Position( root, [ 0, 2 ] ) ); + } ).to.throw( CKEditorError, /^writer-merge-no-element-before/ ); + } ); + } ); + + describe( 'move()', () => { + let root, range, div, p; + + beforeEach( () => { + root = doc.createRoot(); + + div = new Element( 'div', [], new Text( 'foobar' ) ); + p = new Element( 'p', [], new Text( 'abcxyz' ) ); + + div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); + div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); + + root.insertChildren( 0, [ div, p ] ); + + range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); + } ); + + it( 'should move flat range of nodes', () => { + writer.move( range, new Position( root, [ 1, 3 ] ) ); + + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggggPfoPhhhhP' ); + expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcobarxyz' ); + } ); + + it( 'should throw if object to move is not a range', () => { + expect( () => { + writer.move( root.getChild( 0 ), new Position( root, [ 1, 3 ] ) ); + } ).to.throw( CKEditorError, /^writer-move-invalid-range/ ); + } ); + + it( 'should throw if given range is not flat', () => { + const notFlatRange = new Range( new Position( root, [ 0, 2, 2 ] ), new Position( root, [ 0, 6 ] ) ); + + expect( () => { + writer.move( notFlatRange, new Position( root, [ 1, 3 ] ) ); + } ).to.throw( CKEditorError, /^writer-move-range-not-flat/ ); + } ); + + it( 'should throw if range is going to be moved to the other document', () => { + const docFrag = writer.createDocumentFragment(); + + expect( () => { + writer.move( range, docFrag ); + } ).to.throw( CKEditorError, /^writer-move-different-document/ ); + } ); + } ); + + describe( 'remove()', () => { + let div, p, range; + + beforeEach( () => { + div = writer.createElement( 'div' ); + writer.appendText( 'foobar', div ); + + p = writer.createElement( 'p' ); + writer.appendText( 'abcxyz', p ); + + writer.insertElement( 'p', div ); + writer.appendElement( 'p', div ); + + writer.insertText( 'gggg', new Position( div, [ 0, 0 ] ) ); + writer.insertText( 'hhhh', new Position( div, [ 7, 0 ] ) ); + } ); + + describe( 'remove from document', () => { + let root; + + beforeEach( () => { + root = doc.createRoot(); + writer.append( div, root ); + writer.append( p, root ); + + // Reset batch inside a writer. + batch = new Batch(); + writer = new Writer( model, batch ); + + // Range starts in ROOT > DIV > P > gg|gg. + // Range ends in ROOT > DIV > ...|ar. + range = new Range( new Position( root, [ 0, 0, 2 ] ), new Position( root, [ 0, 5 ] ) ); + } ); + + it( 'should remove specified node', () => { + writer.remove( div ); + + expect( root.maxOffset ).to.equal( 1 ); + expect( root.childCount ).to.equal( 1 ); + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should remove specified text node', () => { + writer.remove( p.getChild( 0 ) ); + + expect( getNodesAndText( Range.createOn( p ) ) ).to.equal( 'PP' ); + } ); + + it( 'should remove any range of nodes', () => { + writer.remove( range ); + + expect( getNodesAndText( Range.createIn( root.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); + expect( getNodesAndText( Range.createIn( root.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should create minimal number of remove deltas, each with only one operation', () => { + writer.remove( range ); + + expect( writer._batch.deltas.length ).to.equal( 2 ); + expect( writer._batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( writer._batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + } ); + + it( 'should use RemoveOperation', () => { + writer.remove( div ); + + expect( writer._batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'remove' ); + } ); + } ); + + describe( 'remove from document fragment', () => { + let frag; + + beforeEach( () => { + frag = writer.createDocumentFragment(); + writer.append( div, frag ); + writer.append( p, frag ); + + // Reset batch in writer. + batch = new Batch(); + writer = new Writer( model, batch ); + + // Range starts in FRAG > DIV > P > gg|gg. + // Range ends in FRAG > DIV > ...|ar. + range = new Range( new Position( frag, [ 0, 0, 2 ] ), new Position( frag, [ 0, 5 ] ) ); + } ); + + it( 'should remove specified node', () => { + writer.remove( div ); + + expect( frag.maxOffset ).to.equal( 1 ); + expect( frag.childCount ).to.equal( 1 ); + expect( getNodesAndText( Range.createIn( frag.getChild( 0 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should remove specified text node', () => { + writer.remove( p.getChild( 0 ) ); + + expect( getNodesAndText( Range.createOn( p ) ) ).to.equal( 'PP' ); + } ); + + it( 'should remove any range of nodes', () => { + writer.remove( range ); + + expect( getNodesAndText( Range.createIn( frag.getChild( 0 ) ) ) ).to.equal( 'PggParPhhhhP' ); + expect( getNodesAndText( Range.createIn( frag.getChild( 1 ) ) ) ).to.equal( 'abcxyz' ); + } ); + + it( 'should create minimal number of remove deltas, each with only one operation', () => { + writer.remove( range ); + + expect( writer._batch.deltas.length ).to.equal( 2 ); + expect( writer._batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( writer._batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + } ); + + it( 'should use DetachOperation', () => { + writer.remove( div ); + + expect( writer._batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'detach' ); + } ); + } ); + } ); + + describe( 'rename()', () => { + let root; + + beforeEach( () => { + root = doc.createRoot(); + + const p = new Element( 'p', null, new Text( 'abc' ) ); + root.appendChildren( p ); + + writer.rename( p, 'h' ); + } ); + + it( 'should rename given element', () => { + expect( root.maxOffset ).to.equal( 1 ); + expect( root.getChild( 0 ) ).to.have.property( 'name', 'h' ); + } ); + + it( 'should throw if not an Element instance is passed', () => { + expect( () => { + writer.rename( new Text( 'abc' ), 'h' ); + } ).to.throw( CKEditorError, /^writer-rename-not-element-instance/ ); + } ); + } ); + + describe( 'split()', () => { + let root, p; + + beforeEach( () => { + root = doc.createRoot(); + + p = new Element( 'p', { key: 'value' }, new Text( 'foobar' ) ); + + root.insertChildren( 0, p ); + } ); + + it( 'should split foobar to foo and bar', () => { + writer.split( new Position( root, [ 0, 3 ] ) ); + + expect( root.maxOffset ).to.equal( 2 ); + + expect( root.getChild( 0 ).name ).to.equal( 'p' ); + expect( root.getChild( 0 ).maxOffset ).to.equal( 3 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); + expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foo' ); + + expect( root.getChild( 1 ).name ).to.equal( 'p' ); + expect( root.getChild( 1 ).maxOffset ).to.equal( 3 ); + expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); + expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'bar' ); + } ); + + it( 'should create an empty paragraph if we split at the end', () => { + writer.split( new Position( root, [ 0, 6 ] ) ); + + expect( root.maxOffset ).to.equal( 2 ); + + expect( root.getChild( 0 ).name ).to.equal( 'p' ); + expect( root.getChild( 0 ).maxOffset ).to.equal( 6 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'key' ) ).to.equal( 'value' ); + expect( root.getChild( 0 ).getChild( 0 ).data ).to.equal( 'foobar' ); + + expect( root.getChild( 1 ).name ).to.equal( 'p' ); + expect( root.getChild( 1 ).maxOffset ).to.equal( 0 ); + expect( count( root.getChild( 1 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 1 ).getAttribute( 'key' ) ).to.equal( 'value' ); + } ); + + it( 'should throw if we try to split a root', () => { + expect( () => { + writer.split( new Position( root, [ 0 ] ) ); + } ).to.throw( CKEditorError, /^writer-split-element-no-parent/ ); + } ); + + it( 'should throw if we try to split an element with no parent', () => { + expect( () => { + const element = writer.createElement( 'p' ); + + writer.split( new Position( element, [ 0 ] ) ); + } ).to.throw( CKEditorError, /^writer-split-element-no-parent/ ); + } ); + + it( 'should throw if we try to split a document fragment', () => { + expect( () => { + const documentFragment = writer.createDocumentFragment(); + + writer.split( new Position( documentFragment, [ 0 ] ) ); + } ).to.throw( CKEditorError, /^writer-split-element-no-parent/ ); + } ); + } ); + + describe( 'wrap()', () => { + let root, range; + + beforeEach( () => { + root = doc.createRoot(); + + root.insertChildren( 0, new Text( 'foobar' ) ); + + range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 4 ] ) ); + } ); + + it( 'should wrap flat range with given element', () => { + const p = new Element( 'p' ); + writer.wrap( range, p ); + + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 0 ).data ).to.equal( 'fo' ); + expect( root.getChild( 1 ) ).to.equal( p ); + expect( p.getChild( 0 ).data ).to.equal( 'ob' ); + expect( root.getChild( 2 ).data ).to.equal( 'ar' ); + } ); + + it( 'should wrap flat range with an element of given name', () => { + writer.wrap( range, 'p' ); + + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 0 ).data ).to.equal( 'fo' ); + expect( root.getChild( 1 ).name ).to.equal( 'p' ); + expect( root.getChild( 1 ).getChild( 0 ).data ).to.equal( 'ob' ); + expect( root.getChild( 2 ).data ).to.equal( 'ar' ); + } ); + + it( 'should throw if range to wrap is not flat', () => { + root.insertChildren( 1, [ new Element( 'p', [], new Text( 'xyz' ) ) ] ); + const notFlatRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6, 2 ] ) ); + + expect( () => { + writer.wrap( notFlatRange, 'p' ); + } ).to.throw( CKEditorError, /^writer-wrap-range-not-flat/ ); + } ); + + it( 'should throw if element to wrap with has children #1', () => { + const p = new Element( 'p', [], new Text( 'a' ) ); + + expect( () => { + writer.wrap( range, p ); + } ).to.throw( CKEditorError, /^writer-wrap-element-not-empty/ ); + } ); + + it( 'should throw if element to wrap with has children #2', () => { + const p = new Element( 'p' ); + root.insertChildren( 0, p ); + + expect( () => { + writer.wrap( range, p ); + } ).to.throw( CKEditorError, /^writer-wrap-element-attached/ ); + } ); + } ); + + describe( 'unwrap()', () => { + let root, p; + + beforeEach( () => { + root = doc.createRoot(); + + p = new Element( 'p', [], new Text( 'xyz' ) ); + root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); + } ); + + it( 'should unwrap given element', () => { + writer.unwrap( p ); + + expect( root.maxOffset ).to.equal( 5 ); + expect( root.getChild( 0 ).data ).to.equal( 'axyzb' ); + } ); + + it( 'should throw if element to unwrap has no parent', () => { + const element = new Element( 'p' ); + + expect( () => { + writer.unwrap( element ); + } ).to.throw( CKEditorError, /^writer-unwrap-element-no-parent/ ); + } ); + } ); + + describe( 'setMarker()', () => { + let root, range; + + beforeEach( () => { + root = doc.createRoot(); + root.appendChildren( new Text( 'foo' ) ); + range = Range.createIn( root ); + } ); + + it( 'should add marker to the document marker collection', () => { + writer.setMarker( 'name', range ); + + expect( model.markers.get( 'name' ).getRange().isEqual( range ) ).to.be.true; + } ); + + it( 'should update marker in the document marker collection', () => { + writer.setMarker( 'name', range ); + + const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); + writer.setMarker( 'name', range2 ); + + expect( model.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + } ); + + it( 'should accept marker instance', () => { + writer.setMarker( 'name', range ); + const marker = model.markers.get( 'name' ); + const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); + + writer.setMarker( marker, range2 ); + const op = writer._batch.deltas[ 0 ].operations[ 0 ]; + + expect( model.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + expect( op.oldRange.isEqual( range ) ).to.be.true; + expect( op.newRange.isEqual( range2 ) ).to.be.true; + } ); + + it( 'should accept empty range parameter if marker instance is passed', () => { + const marker = model.markers.set( 'name', range ); + + sinon.spy( model, 'fire' ); + + model.on( 'change', ( evt, type, changes ) => { + if ( type == 'marker' ) { + expect( changes.type ).to.equal( 'set' ); + expect( changes.name ).to.equal( 'name' ); + } + } ); + + writer.setMarker( marker ); + const op = writer._batch.deltas[ 0 ].operations[ 0 ]; + + expect( model.fire.calledWith( 'change', 'marker' ) ).to.be.true; + expect( op.oldRange ).to.be.null; + expect( op.newRange.isEqual( range ) ).to.be.true; + } ); + + it( 'should throw if marker with given name does not exist and range is not passed', () => { + expect( () => { + writer.setMarker( 'name' ); + } ).to.throw( CKEditorError, /^writer-setMarker-no-range/ ); + } ); + } ); + + describe( 'removeMarker()', () => { + let root, range; + + beforeEach( () => { + root = doc.createRoot(); + root.appendChildren( new Text( 'foo' ) ); + range = Range.createIn( root ); + } ); + + it( 'should remove marker from the document marker collection', () => { + writer.setMarker( 'name', range ); + writer.removeMarker( 'name' ); + + expect( model.markers.get( 'name' ) ).to.be.null; + } ); + + it( 'should throw when trying to remove non existing marker', () => { + expect( () => { + writer.removeMarker( 'name' ); + } ).to.throw( CKEditorError, /^writer-removeMarker-no-marker/ ); + } ); + + it( 'should accept marker instance', () => { + writer.setMarker( 'name', range ); + const marker = model.markers.get( 'name' ); + + writer.removeMarker( marker ); + + expect( model.markers.get( 'name' ) ).to.be.null; + } ); + } ); +} ); From 11d01a105aee4f8f8ff33fc810757407e1dae918 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 1 Dec 2017 15:46:51 +0100 Subject: [PATCH 104/724] Batch should be created only through change block. --- src/model/model.js | 18 +++++++----------- tests/model/model.js | 15 +++++++-------- 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/src/model/model.js b/src/model/model.js index 06526373d..0178468e0 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -49,15 +49,15 @@ export default class Model { } } - enqueueChange( batch, callback ) { - if ( typeof batch === 'string' ) { - batch = this.batch( batch ); - } else if ( typeof batch == 'function' ) { - callback = batch; - batch = this.batch(); + enqueueChange( batchOrType, callback ) { + if ( typeof batchOrType === 'string' ) { + batchOrType = new Batch( batchOrType ); + } else if ( typeof batchOrType == 'function' ) { + callback = batchOrType; + batchOrType = new Batch(); } - this._pendingChanges.push( { batch, callback } ); + this._pendingChanges.push( { batchOrType, callback } ); if ( this._pendingChanges.length == 1 ) { this._runPendingChanges(); @@ -86,10 +86,6 @@ export default class Model { return ret; } - batch( type ) { - return new Batch( type ); - } - applyOperation( operation ) { return operation._execute(); } diff --git a/tests/model/model.js b/tests/model/model.js index 432b6872d..a455b62de 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -4,7 +4,6 @@ */ import Model from '../../src/model/model'; -import Batch from '../../src/model/batch'; describe( 'Model', () => { let model; @@ -61,7 +60,7 @@ describe( 'Model', () => { } ); it( 'should execute enqueueChanges immediately if its the first block', () => { - model.enqueueChange( new Batch(), () => { + model.enqueueChange( () => { changes += 'A'; nested(); @@ -81,7 +80,7 @@ describe( 'Model', () => { } ); it( 'should be possible to enqueueChanges immediately if its the first block', () => { - model.enqueueChange( new Batch(), () => { + model.enqueueChange( () => { changes += 'A'; nested(); @@ -90,14 +89,14 @@ describe( 'Model', () => { expect( changes ).to.equal( 'AB' ); function nested() { - const ret = model.change( () => { + model.change( () => { changes += 'B'; } ); } } ); it( 'should be possible to nest change in enqueueChanges', () => { - model.enqueueChange( new Batch(), () => { + model.enqueueChange( () => { changes += 'A'; nested(); @@ -119,7 +118,7 @@ describe( 'Model', () => { } ); it( 'should be possible to nest enqueueChanges in enqueueChanges', () => { - model.enqueueChange( new Batch(), () => { + model.enqueueChange( () => { changes += 'A'; nestedEnqueue(); @@ -130,7 +129,7 @@ describe( 'Model', () => { expect( changes ).to.equal( 'ABC' ); function nestedEnqueue() { - model.enqueueChange( new Batch(), () => { + model.enqueueChange( () => { changes += 'C'; } ); } @@ -152,7 +151,7 @@ describe( 'Model', () => { expect( changes ).to.equal( 'ABCD' ); function nestedEnqueue() { - model.enqueueChange( new Batch(), () => { + model.enqueueChange( () => { changes += 'C'; } ); } From 60b679a13726acfc6aa76a3e621d42d6c69eedc7 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 1 Dec 2017 15:50:22 +0100 Subject: [PATCH 105/724] Change block now creates writer. --- src/model/model.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/model/model.js b/src/model/model.js index 0178468e0..c4a5e3bcf 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -8,6 +8,7 @@ */ import Batch from './batch'; +import Writer from './writer'; import Schema from './schema'; import Document from './document'; import MarkerCollection from './markercollection'; @@ -70,7 +71,7 @@ export default class Model { const ret = []; while ( this._pendingChanges.length ) { - this._currentWriter = this._pendingChanges[ 0 ].batch; + this._currentWriter = new Writer( this, this._pendingChanges[ 0 ].batch ); ret.push( this._pendingChanges[ 0 ].callback( this._currentWriter ) ); From d72cddd295caa912610c2e9e13fc764deaa9c9de Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 1 Dec 2017 17:11:26 +0100 Subject: [PATCH 106/724] Added tests for change and enqueueChange methods. Change writer.batch to public. Fix small bugs. --- src/model/model.js | 9 +-- src/model/writer.js | 3 +- tests/model/model.js | 147 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 149 insertions(+), 10 deletions(-) diff --git a/src/model/model.js b/src/model/model.js index c4a5e3bcf..4685b9406 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -12,7 +12,6 @@ import Writer from './writer'; import Schema from './schema'; import Document from './document'; import MarkerCollection from './markercollection'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; @@ -58,12 +57,10 @@ export default class Model { batchOrType = new Batch(); } - this._pendingChanges.push( { batchOrType, callback } ); + this._pendingChanges.push( { batch: batchOrType, callback } ); if ( this._pendingChanges.length == 1 ) { this._runPendingChanges(); - - this.fire( 'changesDone' ); } } @@ -90,10 +87,6 @@ export default class Model { applyOperation( operation ) { return operation._execute(); } - - transformDeltas() { - // ... - } } mix( Model, ObservableMixin ); diff --git a/src/model/writer.js b/src/model/writer.js index b91e51f8d..2f97ca0a0 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -69,10 +69,9 @@ export default class Writer { this.model = model; /** - * @protected * @type {module:engine/model/batch~Batch} */ - this._batch = batch; + this.batch = batch; } /** diff --git a/tests/model/model.js b/tests/model/model.js index a455b62de..5002e5e86 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -156,5 +156,152 @@ describe( 'Model', () => { } ); } } ); + + it( 'should be possible to nest enqueueChanges in enqueueChanges event', () => { + model.once( 'change', () => { + model.enqueueChange( () => { + changes += 'C'; + } ); + + changes += 'B'; + } ); + + model.on( 'changesDone', () => { + changes += 'D'; + } ); + + model.enqueueChange( () => { + changes += 'A'; + } ); + + expect( changes ).to.equal( 'ABCD' ); + } ); + + it( 'should be possible to nest enqueueChanges in changes event', () => { + model.once( 'change', () => { + model.enqueueChange( () => { + changes += 'C'; + } ); + + changes += 'B'; + } ); + + model.on( 'changesDone', () => { + changes += 'D'; + } ); + + model.change( () => { + changes += 'A'; + } ); + + expect( changes ).to.equal( 'ABCD' ); + } ); + + it( 'should be possible to nest changes in enqueueChanges event', () => { + model.once( 'change', () => { + model.change( () => { + changes += 'B'; + } ); + + changes += 'C'; + } ); + + model.on( 'changesDone', () => { + changes += 'D'; + } ); + + model.enqueueChange( () => { + changes += 'A'; + } ); + + expect( changes ).to.equal( 'ABCD' ); + } ); + + it( 'should be possible to nest changes in changes event', () => { + model.once( 'change', () => { + model.change( () => { + changes += 'B'; + } ); + + changes += 'C'; + } ); + + model.on( 'changesDone', () => { + changes += 'D'; + } ); + + model.change( () => { + changes += 'A'; + } ); + + expect( changes ).to.equal( 'ABCD' ); + } ); + + it( 'should let mix blocks', () => { + model.once( 'change', () => { + model.change( () => { + changes += 'B'; + + nestedEnqueue(); + } ); + + model.change( () => { + changes += 'C'; + } ); + + changes += 'D'; + } ); + + model.on( 'changesDone', () => { + changes += 'F'; + } ); + + model.change( () => { + changes += 'A'; + } ); + + expect( changes ).to.equal( 'ABCDEF' ); + + function nestedEnqueue() { + model.enqueueChange( () => { + changes += 'E'; + } ); + } + } ); + + it( 'should use the same writer in all change blocks (change & change)', () => { + model.change( outerWriter => { + model.change( innerWriter => { + expect( innerWriter ).to.equal( outerWriter ); + } ); + } ); + } ); + + it( 'should create new writer in enqueue block', () => { + model.change( outerWriter => { + model.enqueueChange( innerWriter => { + expect( innerWriter ).to.not.equal( outerWriter ); + expect( innerWriter.batch ).to.not.equal( outerWriter.batch ); + } ); + } ); + } ); + + it( 'should let you pass batch', () => { + let outerBatch; + + model.change( outerWriter => { + outerBatch = outerWriter.batch; + + model.enqueueChange( outerBatch, innerWriter => { + expect( innerWriter.batch ).to.equal( outerBatch ); + } ); + } ); + } ); + + it( 'should let you create transparent batch', () => { + model.enqueueChange( 'transparent', writer => { + expect( writer.batch.type ).to.equal( 'transparent' ); + } ); + } ); } ); } ); From 1a7e0607057b436b8df9a8085fb4760f71d5767b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 1 Dec 2017 17:14:38 +0100 Subject: [PATCH 107/724] Added model instance to the Documentselection. --- src/model/document.js | 10 +++++---- src/model/documentselection.js | 37 ++++++++++++++++++++-------------- 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index 3e48cb232..cca9ba5d1 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -76,7 +76,7 @@ export default class Document { * @readonly * @member {module:engine/model/documentselection~DocumentSelection} */ - this.selection = new DocumentSelection( this ); + this.selection = new DocumentSelection( this, this.model ); /** * List of roots that are owned and managed by this document. Use {@link #createRoot} and @@ -268,8 +268,10 @@ export default class Document { * @returns {module:engine/model/range~Range|null} Nearest selection range or `null` if one cannot be found. */ getNearestSelectionRange( position, direction = 'both' ) { + const schema = this.model.schema; + // Return collapsed range if provided position is valid. - if ( this.model.schema.check( { name: '$text', inside: position } ) ) { + if ( schema.check( { name: '$text', inside: position } ) ) { return new Range( position ); } @@ -287,11 +289,11 @@ export default class Document { const type = ( data.walker == backwardWalker ? 'elementEnd' : 'elementStart' ); const value = data.value; - if ( value.type == type && this.schema.objects.has( value.item.name ) ) { + if ( value.type == type && schema.objects.has( value.item.name ) ) { return Range.createOn( value.item ); } - if ( this.schema.check( { name: '$text', inside: value.nextPosition } ) ) { + if ( schema.check( { name: '$text', inside: value.nextPosition } ) ) { return new Range( value.nextPosition ); } } diff --git a/src/model/documentselection.js b/src/model/documentselection.js index f213430cd..8a4df81ff 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -52,15 +52,24 @@ export default class DocumentSelection extends Selection { * Creates an empty live selection for given {@link module:engine/model/document~Document}. * * @param {module:engine/model/document~Document} document Document which owns this selection. + * @param {module:engine/model/model~Model} model */ - constructor( document ) { + constructor( document, model ) { super(); /** * Document which owns this selection. * * @protected - * @member {module:engine/model/document~Document} module:engine/model/documentselection~DocumentSelection#_document + * @member {module:engine/model/model~Model} + */ + this._model = model; + + /** + * Document which owns this selection. + * + * @protected + * @member {module:engine/model/document~Document} */ this._document = document; @@ -83,9 +92,14 @@ export default class DocumentSelection extends Selection { this._updateAttributes( false ); } - // Whenever element which had selection's attributes stored in it stops being empty, - // the attributes need to be removed. - clearAttributesStoredInElement( changes, batch, this._document ); + // Batch may not be passed to the document#change event in some tests. + // See https://github.com/ckeditor/ckeditor5-engine/issues/1001#issuecomment-314202352 + // Ignore also transparent batches because they are... transparent. + if ( batch && batch.type !== 'transparent' ) { + // Whenever element which had selection's attributes stored in it stops being empty, + // the attributes need to be removed. + clearAttributesStoredInElement( changes, this._model ); + } } ); } @@ -711,14 +725,7 @@ function getAttrsIfCharacter( node ) { } // Removes selection attributes from element which is not empty anymore. -function clearAttributesStoredInElement( changes, batch, document ) { - // Batch may not be passed to the document#change event in some tests. - // See https://github.com/ckeditor/ckeditor5-engine/issues/1001#issuecomment-314202352 - // Ignore also transparent batches because they are... transparent. - if ( !batch || batch.type == 'transparent' ) { - return; - } - +function clearAttributesStoredInElement( changes, model ) { const changeParent = changes.range && changes.range.start.parent; // `changes.range` is not set in case of rename, root and marker operations. @@ -727,11 +734,11 @@ function clearAttributesStoredInElement( changes, batch, document ) { return; } - document.enqueueChanges( () => { + model.change( writer => { const storedAttributes = Array.from( changeParent.getAttributeKeys() ).filter( key => key.startsWith( storePrefix ) ); for ( const key of storedAttributes ) { - batch.removeAttribute( key, changeParent ); + writer.removeAttribute( key, changeParent ); } } ); } From b750c67e780853040b26e9a8d876ce1b68c21f51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 1 Dec 2017 17:16:01 +0100 Subject: [PATCH 108/724] Fixed Writer failing tests. --- src/model/writer.js | 22 ++++++++++---------- tests/model/writer.js | 48 +++++++++++++++++++++---------------------- 2 files changed, 34 insertions(+), 36 deletions(-) diff --git a/src/model/writer.js b/src/model/writer.js index 2f97ca0a0..d609c6bb2 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -169,7 +169,7 @@ export default class Writer { const insert = new InsertOperation( position, item, this.model.document.version ); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); delta.addOperation( insert ); this.model.applyOperation( insert ); @@ -431,7 +431,7 @@ export default class Writer { } const delta = new MoveDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); const operation = new MoveOperation( range.start, range.end.offset - range.start.offset, position, this.model.document.version ); delta.addOperation( operation ); @@ -446,7 +446,7 @@ export default class Writer { remove( itemOrRange ) { const addRemoveDelta = ( position, howMany ) => { const delta = new RemoveDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); let operation; if ( position.root.document ) { @@ -486,7 +486,7 @@ export default class Writer { */ merge( position ) { const delta = new MergeDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); const nodeBefore = position.nodeBefore; const nodeAfter = position.nodeAfter; @@ -550,7 +550,7 @@ export default class Writer { } const delta = new RenameDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); const renameOperation = new RenameOperation( Position.createBefore( element ), element.name, newName, this.model.document.version ); delta.addOperation( renameOperation ); @@ -567,7 +567,7 @@ export default class Writer { */ split( position ) { const delta = new SplitDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); const splitElement = position.parent; @@ -642,7 +642,7 @@ export default class Writer { } const delta = new WrapDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); const insert = new InsertOperation( range.end, element, this.model.document.version ); delta.addOperation( insert ); @@ -676,7 +676,7 @@ export default class Writer { } const delta = new UnwrapDelta(); - this._batch.addDelta( delta ); + this.batch.addDelta( delta ); const sourcePosition = Position.createFromParentAndOffset( element, 0 ); @@ -820,7 +820,7 @@ function setAttributeToRange( writer, key, value, range ) { function addOperation() { // Add delta to the batch only if there is at least operation in the delta. Add delta only once. if ( delta.operations.length === 0 ) { - writer._batch.addDelta( delta ); + writer.batch.addDelta( delta ); } const range = new Range( lastSplitPosition, position ); @@ -846,7 +846,7 @@ function setAttributeToItem( writer, key, value, item ) { if ( previousValue != value ) { const delta = item.root === item ? new RootAttributeDelta() : new AttributeDelta(); - writer._batch.addDelta( delta ); + writer.batch.addDelta( delta ); if ( item.root === item ) { // If we change attributes of root element, we have to use `RootAttributeOperation`. @@ -885,7 +885,7 @@ function addMarkerOperation( writer, name, oldRange, newRange ) { const operation = new MarkerOperation( name, oldRange, newRange, model.markers, doc.version ); - writer._batch.addDelta( delta ); + writer.batch.addDelta( delta ); delta.addOperation( operation ); model.applyOperation( operation ); } diff --git a/tests/model/writer.js b/tests/model/writer.js index 60ec5b884..f85a7f987 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -34,6 +34,10 @@ describe( 'Writer', () => { it( 'should have model instance', () => { expect( writer.model ).to.instanceof( Model ); } ); + + it( 'should have batch instance', () => { + expect( writer.batch ).to.instanceof( Batch ); + } ); } ); describe( 'createText()', () => { @@ -330,7 +334,7 @@ describe( 'Writer', () => { docFrag.markers.set( 'marker1', marker1 ); docFrag.markers.set( 'marker2', marker2 ); - model.on( 'change', spy ); + doc.on( 'change', spy ); writer.insert( docFrag, new Position( root, [ 2 ] ) ); @@ -911,7 +915,7 @@ describe( 'Writer', () => { function getChangesAttrsCount() { let totalNumber = 0; - for ( const delta of writer._batch.deltas ) { + for ( const delta of writer.batch.deltas ) { for ( const operation of delta.operations ) { if ( operation.range ) { totalNumber += count( operation.range.getItems( { singleCharacters: true } ) ); @@ -1226,11 +1230,11 @@ describe( 'Writer', () => { writer.setAttribute( 'a', 1, nodeA ); - expect( writer._batch.deltas.length ).to.equal( 0 ); + expect( writer.batch.deltas.length ).to.equal( 0 ); writer.removeAttribute( 'x', Range.createIn( root ) ); - expect( writer._batch.deltas.length ).to.equal( 0 ); + expect( writer.batch.deltas.length ).to.equal( 0 ); } ); } ); @@ -1457,15 +1461,15 @@ describe( 'Writer', () => { it( 'should create minimal number of remove deltas, each with only one operation', () => { writer.remove( range ); - expect( writer._batch.deltas.length ).to.equal( 2 ); - expect( writer._batch.deltas[ 0 ].operations.length ).to.equal( 1 ); - expect( writer._batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + expect( writer.batch.deltas.length ).to.equal( 2 ); + expect( writer.batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( writer.batch.deltas[ 1 ].operations.length ).to.equal( 1 ); } ); it( 'should use RemoveOperation', () => { writer.remove( div ); - expect( writer._batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'remove' ); + expect( writer.batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'remove' ); } ); } ); @@ -1510,15 +1514,15 @@ describe( 'Writer', () => { it( 'should create minimal number of remove deltas, each with only one operation', () => { writer.remove( range ); - expect( writer._batch.deltas.length ).to.equal( 2 ); - expect( writer._batch.deltas[ 0 ].operations.length ).to.equal( 1 ); - expect( writer._batch.deltas[ 1 ].operations.length ).to.equal( 1 ); + expect( writer.batch.deltas.length ).to.equal( 2 ); + expect( writer.batch.deltas[ 0 ].operations.length ).to.equal( 1 ); + expect( writer.batch.deltas[ 1 ].operations.length ).to.equal( 1 ); } ); it( 'should use DetachOperation', () => { writer.remove( div ); - expect( writer._batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'detach' ); + expect( writer.batch.deltas[ 0 ].operations[ 0 ].type ).to.equal( 'detach' ); } ); } ); } ); @@ -1726,12 +1730,11 @@ describe( 'Writer', () => { } ); it( 'should accept marker instance', () => { - writer.setMarker( 'name', range ); - const marker = model.markers.get( 'name' ); + const marker = model.markers.set( 'name', range ); const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); writer.setMarker( marker, range2 ); - const op = writer._batch.deltas[ 0 ].operations[ 0 ]; + const op = writer.batch.deltas[ 0 ].operations[ 0 ]; expect( model.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; expect( op.oldRange.isEqual( range ) ).to.be.true; @@ -1740,20 +1743,15 @@ describe( 'Writer', () => { it( 'should accept empty range parameter if marker instance is passed', () => { const marker = model.markers.set( 'name', range ); + const spy = sinon.spy(); - sinon.spy( model, 'fire' ); - - model.on( 'change', ( evt, type, changes ) => { - if ( type == 'marker' ) { - expect( changes.type ).to.equal( 'set' ); - expect( changes.name ).to.equal( 'name' ); - } - } ); + doc.on( 'change', spy ); writer.setMarker( marker ); - const op = writer._batch.deltas[ 0 ].operations[ 0 ]; + const op = writer.batch.deltas[ 0 ].operations[ 0 ]; - expect( model.fire.calledWith( 'change', 'marker' ) ).to.be.true; + sinon.assert.calledOnce( spy ); + sinon.assert.calledWith( spy, sinon.match.any, 'marker' ); expect( op.oldRange ).to.be.null; expect( op.newRange.isEqual( range ) ).to.be.true; } ); From 53ad06c8ea364a8ee940d5b2b8f9e74ee6d99a8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Mon, 4 Dec 2017 10:55:31 +0100 Subject: [PATCH 109/724] Docs: Added missing docs and prevented errors in other ones. --- src/model/documentfragment.js | 2 +- src/model/element.js | 2 ++ src/model/item.jsdoc | 2 +- src/model/operation/utils.js | 2 +- src/model/text.js | 4 +++- src/model/textproxy.js | 2 +- 6 files changed, 9 insertions(+), 5 deletions(-) diff --git a/src/model/documentfragment.js b/src/model/documentfragment.js index 7f1c671ae..0a2e44329 100644 --- a/src/model/documentfragment.js +++ b/src/model/documentfragment.js @@ -18,7 +18,7 @@ import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable'; * * DocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection * will be set to the {@link module:engine/model/document~Document#markers document markers} by a - * {@link module:engine/model/writer~writer.insert} function. + * {@linkTODO module:engine/model/writer~writer.insert} function. */ export default class DocumentFragment { /** diff --git a/src/model/element.js b/src/model/element.js index fcceac9f5..e9cd6bc8a 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -17,6 +17,8 @@ import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable'; * {@link module:engine/model/element~Element#getChildren child nodes}. * * **Important**: see {@link module:engine/model/node~Node} to read about restrictions using `Element` and `Node` API. + * + * @extends {module:engine/model/node~Node} */ export default class Element extends Node { /** diff --git a/src/model/item.jsdoc b/src/model/item.jsdoc index ce800ca30..57d0ed79b 100644 --- a/src/model/item.jsdoc +++ b/src/model/item.jsdoc @@ -8,7 +8,7 @@ */ /** - * Item is a {@link module:engine/model/node~Node Node} or {@link module:engine/model/textproxy~TextProxy TextProxy}. + * Item is a {@link module:engine/model/node~Node} or {@link module:engine/model/textproxy~TextProxy}. * * @typedef {module:engine/model/node~Node|module:engine/model/textproxy~TextProxy} module:engine/model/item~Item */ diff --git a/src/model/operation/utils.js b/src/model/operation/utils.js index cfaf8c4b9..c7e9ba00b 100644 --- a/src/model/operation/utils.js +++ b/src/model/operation/utils.js @@ -16,7 +16,7 @@ import NodeList from '../nodelist'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** - * Contains functions used for composing model tree by {@link module:engine/model/operation~Operation operations}. + * Contains functions used for composing model tree by {@link module:engine/model/operation/operation~Operation operations}. * Those functions are built on top of {@link module:engine/model/node~Node node}, and it's child classes', APIs. * * @protected diff --git a/src/model/text.js b/src/model/text.js index a46f5778c..de2895b42 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -15,10 +15,12 @@ import Node from './node'; * **Important:** see {@link module:engine/model/node~Node} to read about restrictions using `Text` and `Node` API. * * **Note:** keep in mind that `Text` instances might indirectly got removed from model tree when model is changed. - * This happens when {@link module:engine/model/writer~writer model writer} is used to change model and the text node is merged with + * This happens when {@linkTODO module:engine/model/writer~writer model writer} is used to change model and the text node is merged with * another text node. Then, both text nodes are removed and a new text node is inserted into the model. Because of * this behavior, keeping references to `Text` is not recommended. Instead, consider creating * {@link module:engine/model/liveposition~LivePosition live position} placed before the text node. + * + * @extends {module:engine/model/node~Node} */ export default class Text extends Node { /** diff --git a/src/model/textproxy.js b/src/model/textproxy.js index eec73498d..763aa0d90 100644 --- a/src/model/textproxy.js +++ b/src/model/textproxy.js @@ -28,7 +28,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * parameter of methods. * * **Note:** `TextProxy` is a readonly interface. If you want to perform changes on model data represented by a `TextProxy` - * use {@link module:engine/model/writer~writer model writer API}. + * use {@linkTODO module:engine/model/writer~writer model writer API}. * * **Note:** `TextProxy` instances are created on the fly, basing on the current state of model. Because of this, it is * highly unrecommended to store references to `TextProxy` instances. `TextProxy` instances are not refreshed when From f91451072df0c1ef9a20dfca4ec0d155370eaf51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 4 Dec 2017 12:59:54 +0100 Subject: [PATCH 110/724] Refactored conversion to use writer instead of batch. --- src/controller/datacontroller.js | 4 +- src/controller/editingcontroller.js | 2 +- src/conversion/buildviewconverter.js | 14 ++-- src/conversion/modelconversiondispatcher.js | 12 ++-- .../view-selection-to-model-converters.js | 10 +-- src/conversion/view-to-model-converters.js | 2 +- src/conversion/viewconversiondispatcher.js | 72 +++++++++++-------- src/model/documentselection.js | 27 ++++--- 8 files changed, 79 insertions(+), 64 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index af2f4cea8..246532f74 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -104,7 +104,7 @@ export default class DataController { * @readonly * @member {module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher} */ - this.viewToModel = new ViewConversionDispatcher( { + this.viewToModel = new ViewConversionDispatcher( this.model, { schema: model.schema } ); @@ -188,7 +188,7 @@ export default class DataController { // Save to model. const modelRoot = this.model.document.getRoot( rootName ); - this.model.enqueueChanges( 'transparent', writer => { + this.model.enqueueChange( 'transparent', writer => { // Clearing selection is a workaround for ticket #569 (LiveRange loses position after removing data from document). // After fixing it this code should be removed. this.model.document.selection.removeAllRanges(); diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 17ee2b1f0..11413740c 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -106,7 +106,7 @@ export default class EditingController { } ); // Convert view selection to model. - this.listenTo( this.view, 'selectionChange', convertSelectionChange( this.model.document, this.mapper ) ); + this.listenTo( this.view, 'selectionChange', convertSelectionChange( this.model, this.mapper ) ); // Attach default content converters. this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } ); diff --git a/src/conversion/buildviewconverter.js b/src/conversion/buildviewconverter.js index 373510d1c..aea071bea 100644 --- a/src/conversion/buildviewconverter.js +++ b/src/conversion/buildviewconverter.js @@ -263,14 +263,14 @@ class ViewConverterBuilder { * buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); * buildViewConverter().for( dispatcher ) * .fromElement( 'img' ) - * .toElement( ( viewElement, batch ) => batch.createElement( 'image', { src: viewElement.getAttribute( 'src' ) } ) ); + * .toElement( ( viewElement, writer ) => writer.createElement( 'image', { src: viewElement.getAttribute( 'src' ) } ) ); * * @param {String|Function} element Model element name or model element creator function. */ toElement( element ) { function eventCallbackGen( from ) { return ( evt, data, consumable, conversionApi ) => { - const batch = conversionApi.batch; + const writer = conversionApi.writer; // There is one callback for all patterns in the matcher. // This will be usually just one pattern but we support matchers with many patterns too. @@ -284,7 +284,7 @@ class ViewConverterBuilder { // Now, for every match between matcher and actual element, we will try to consume the match. for ( const match of matchAll ) { // Create model element basing on creator function or element name. - const modelElement = element instanceof Function ? element( data.input, batch ) : batch.createElement( element ); + const modelElement = element instanceof Function ? element( data.input, writer ) : writer.createElement( element ); // Do not convert if element building function returned falsy value. if ( !modelElement ) { @@ -311,7 +311,7 @@ class ViewConverterBuilder { const modelChildren = conversionApi.convertChildren( data.input, consumable, data ); for ( const child of Array.from( modelChildren ) ) { - batch.append( child, modelElement ); + writer.append( child, modelElement ); } // Remove created `modelElement` from the parents stack. @@ -435,7 +435,7 @@ class ViewConverterBuilder { toMarker( creator ) { function eventCallbackGen( from ) { return ( evt, data, consumable, conversionApi ) => { - const batch = conversionApi.batch; + const writer = conversionApi.writer; // There is one callback for all patterns in the matcher. // This will be usually just one pattern but we support matchers with many patterns too. @@ -453,7 +453,7 @@ class ViewConverterBuilder { modelElement = creator( data.input ); // When there is no creator then create model element basing on data from view element. } else { - modelElement = batch.createElement( '$marker', { 'data-name': data.input.getAttribute( 'data-name' ) } ); + modelElement = writer.createElement( '$marker', { 'data-name': data.input.getAttribute( 'data-name' ) } ); } // Check if model element is correct (has proper name and property). @@ -528,7 +528,7 @@ function setAttributeOn( toChange, attribute, data, conversionApi ) { }; if ( conversionApi.schema.check( schemaQuery ) ) { - conversionApi.batch.setAttribute( attribute.key, attribute.value, toChange ); + conversionApi.writer.setAttribute( attribute.key, attribute.value, toChange ); } } diff --git a/src/conversion/modelconversiondispatcher.js b/src/conversion/modelconversiondispatcher.js index bef1750e9..f2a1ef973 100644 --- a/src/conversion/modelconversiondispatcher.js +++ b/src/conversion/modelconversiondispatcher.js @@ -110,17 +110,17 @@ export default class ModelConversionDispatcher { /** * Creates a `ModelConversionDispatcher` that operates using passed API. * - * @param {module:engine/model/document~Document} modelDocument Model document instance bound with this dispatcher. + * @param {module:engine/model/document~Document} model Data model. * @param {Object} [conversionApi] Interface passed by dispatcher to the events callbacks. */ - constructor( modelDocument, conversionApi = {} ) { + constructor( model, conversionApi = {} ) { /** - * Model document instance bound with this dispatcher. + * Data model instance bound with this dispatcher. * * @private * @member {module:engine/model/document~Document} */ - this._modelDocument = modelDocument; + this._model = model; /** * Interface passed by dispatcher to the events callbacks. @@ -215,7 +215,7 @@ export default class ModelConversionDispatcher { } } - for ( const marker of this._modelDocument.markers ) { + for ( const marker of this._model.markers ) { const markerRange = marker.getRange(); const intersection = markerRange.getIntersection( range ); @@ -357,7 +357,7 @@ export default class ModelConversionDispatcher { * @param {module:engine/model/selection~Selection} selection Selection to convert. */ convertSelection( selection ) { - const markers = Array.from( this._modelDocument.markers.getMarkersAtPosition( selection.getFirstPosition() ) ); + const markers = Array.from( this._model.markers.getMarkersAtPosition( selection.getFirstPosition() ) ); const consumable = this._createSelectionConsumable( selection, markers ); this.fire( 'selection', { selection }, consumable, this.conversionApi ); diff --git a/src/conversion/view-selection-to-model-converters.js b/src/conversion/view-selection-to-model-converters.js index d715279aa..63be13035 100644 --- a/src/conversion/view-selection-to-model-converters.js +++ b/src/conversion/view-selection-to-model-converters.js @@ -22,11 +22,11 @@ import ModelSelection from '../model/selection'; * * view.document.on( 'selectionChange', convertSelectionChange( modelDocument, mapper ) ); * - * @param {module:engine/model/document~Document} modelDocument Model document on which selection should be updated. + * @param {module:engine/model/model~Model} model Data model. * @param {module:engine/conversion/mapper~Mapper} mapper Conversion mapper. * @returns {Function} {@link module:engine/view/document~Document#event:selectionChange} callback function. */ -export function convertSelectionChange( modelDocument, mapper ) { +export function convertSelectionChange( model, mapper ) { return ( evt, data ) => { const viewSelection = data.newSelection; const modelSelection = new ModelSelection(); @@ -39,9 +39,9 @@ export function convertSelectionChange( modelDocument, mapper ) { modelSelection.setRanges( ranges, viewSelection.isBackward ); - if ( !modelSelection.isEqual( modelDocument.selection ) ) { - modelDocument.enqueueChanges( () => { - modelDocument.selection.setTo( modelSelection ); + if ( !modelSelection.isEqual( model.document.selection ) ) { + model.enqueueChanges( () => { + model.document.selection.setTo( modelSelection ); } ); } }; diff --git a/src/conversion/view-to-model-converters.js b/src/conversion/view-to-model-converters.js index f76ea6217..2cc91adfa 100644 --- a/src/conversion/view-to-model-converters.js +++ b/src/conversion/view-to-model-converters.js @@ -48,7 +48,7 @@ export function convertText() { if ( conversionApi.schema.check( schemaQuery ) ) { if ( consumable.consume( data.input ) ) { - data.output = conversionApi.batch.createText( data.input.data ); + data.output = conversionApi.writer.createText( data.input.data ); } } }; diff --git a/src/conversion/viewconversiondispatcher.js b/src/conversion/viewconversiondispatcher.js index 36ee9de70..e9aac69ee 100644 --- a/src/conversion/viewconversiondispatcher.js +++ b/src/conversion/viewconversiondispatcher.js @@ -91,7 +91,7 @@ import log from '@ckeditor/ckeditor5-utils/src/log'; * // Fire conversion. * // Always take care where the converted model structure will be appended to. If this `viewDocumentFragment` * // is going to be appended directly to a '$root' element, use that in `context`. - * viewDispatcher.convert( viewDocumentFragment, batch, { context: [ '$root' ] } ); + * viewDispatcher.convert( viewDocumentFragment, { context: [ '$root' ] } ); * * Before each conversion process, `ViewConversionDispatcher` fires {@link ~ViewConversionDispatcher#event:viewCleanup} * event which can be used to prepare tree view for conversion. @@ -107,10 +107,19 @@ export default class ViewConversionDispatcher { * Creates a `ViewConversionDispatcher` that operates using passed API. * * @see module:engine/conversion/viewconversiondispatcher~ViewConversionApi + * @param {module:engine/model/model~Model} model Data model. * @param {Object} [conversionApi] Additional properties for interface that will be passed to events fired * by `ViewConversionDispatcher`. */ - constructor( conversionApi = {} ) { + constructor( model, conversionApi = {} ) { + /** + * Data model. + * + * @private + * @type {module:engine/model/model~Model} + */ + this._model = model; + /** * Interface passed by dispatcher to the events callbacks. * @@ -122,9 +131,6 @@ export default class ViewConversionDispatcher { // set on `conversionApi`. This way only a part of `ViewConversionDispatcher` API is exposed. this.conversionApi.convertItem = this._convertItem.bind( this ); this.conversionApi.convertChildren = this._convertChildren.bind( this ); - - // Batch used for conversion. Is passed to #convert method and removed at the and of the conversion. - this.conversionApi.batch = null; } /** @@ -135,40 +141,44 @@ export default class ViewConversionDispatcher { * @fires documentFragment * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element} viewItem * Part of the view to be converted. - * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {Object} additionalData Additional data to be passed in `data` argument when firing `ViewConversionDispatcher` * events. See also {@link ~ViewConversionDispatcher#event:element element event}. * @returns {module:engine/model/documentfragment~DocumentFragment} Model data that is a result of the conversion process * wrapped in `DocumentFragment`. Converted marker elements will be set as that document fragment's * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}. */ - convert( viewItem, batch, additionalData ) { - // Store batch in current conversion as conversionApi, will be removed at the end of this conversion. - this.conversionApi.batch = batch; + convert( viewItem, additionalData ) { + return this._model.change( writer => { + // Store writer in current conversion as a conversion API. + this.conversionApi.writer = writer; - this.fire( 'viewCleanup', viewItem ); + this.fire( 'viewCleanup', viewItem ); - const consumable = ViewConsumable.createFrom( viewItem ); - let conversionResult = this._convertItem( viewItem, consumable, additionalData ); + const consumable = ViewConsumable.createFrom( viewItem ); + let conversionResult = this._convertItem( viewItem, consumable, additionalData ); - // We can get a null here if conversion failed (see _convertItem()) - // or simply if an item could not be converted (e.g. due to the schema). - if ( !conversionResult ) { - return batch.createDocumentFragment(); - } + // Remove writer from conversion API after conversion. + this.conversionApi.writer = null; - // When conversion result is not a document fragment we need to wrap it in document fragment. - if ( !conversionResult.is( 'documentFragment' ) ) { - const docFrag = batch.createDocumentFragment(); + // We can get a null here if conversion failed (see _convertItem()) + // or simply if an item could not be converted (e.g. due to the schema). + if ( !conversionResult ) { + return writer.createDocumentFragment(); + } - batch.append( conversionResult, docFrag ); - conversionResult = docFrag; - } + // When conversion result is not a document fragment we need to wrap it in document fragment. + if ( !conversionResult.is( 'documentFragment' ) ) { + const docFrag = writer.createDocumentFragment(); - // Extract temporary markers elements from model and set as static markers collection. - conversionResult.markers = extractMarkersFromModelFragment( conversionResult, batch ); + writer.append( conversionResult, docFrag ); + conversionResult = docFrag; + } - return conversionResult; + // Extract temporary markers elements from model and set as static markers collection. + conversionResult.markers = extractMarkersFromModelFragment( conversionResult, writer ); + + return conversionResult; + } ); } /** @@ -212,14 +222,14 @@ export default class ViewConversionDispatcher { * @see module:engine/conversion/viewconversiondispatcher~ViewConversionApi#convertChildren */ _convertChildren( input, consumable, additionalData ) { - const batch = this.conversionApi.batch; - const documentFragment = batch.createDocumentFragment(); + const writer = this.conversionApi.writer; + const documentFragment = writer.createDocumentFragment(); for ( const viewChild of Array.from( input.getChildren() ) ) { const modelChild = this._convertItem( viewChild, consumable, additionalData ); if ( modelChild instanceof ModelNode || modelChild instanceof ModelDocumentFragment ) { - batch.append( modelChild, documentFragment ); + writer.append( modelChild, documentFragment ); } } @@ -281,7 +291,7 @@ mix( ViewConversionDispatcher, EmitterMixin ); // // @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/node~Node} modelItem Fragment of model. // @returns {Map} List of static markers. -function extractMarkersFromModelFragment( modelItem, batch ) { +function extractMarkersFromModelFragment( modelItem, writer ) { const markerElements = new Set(); const markers = new Map(); @@ -313,7 +323,7 @@ function extractMarkersFromModelFragment( modelItem, batch ) { } // Remove marker element from DocumentFragment. - batch.remove( markerElement ); + writer.remove( markerElement ); } return markers; diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 8a4df81ff..cd64f1ca0 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -557,7 +557,9 @@ export default class DocumentSelection extends Selection { _removeStoredAttribute( key ) { const storeKey = DocumentSelection._getStoreAttributeKey( key ); - this._document.batch().removeAttribute( storeKey, this.anchor.parent ); + this._model.change( writer => { + writer.removeAttribute( storeKey, this.anchor.parent ); + } ); } /** @@ -570,7 +572,9 @@ export default class DocumentSelection extends Selection { _storeAttribute( key, value ) { const storeKey = DocumentSelection._getStoreAttributeKey( key ); - this._document.batch().setAttribute( storeKey, value, this.anchor.parent ); + this._model.change( writer => { + writer.setAttribute( storeKey, value, this.anchor.parent ); + } ); } /** @@ -581,19 +585,20 @@ export default class DocumentSelection extends Selection { */ _setStoredAttributesTo( attrs ) { const selectionParent = this.anchor.parent; - const batch = this._document.batch(); - for ( const [ oldKey ] of this._getStoredAttributes() ) { - const storeKey = DocumentSelection._getStoreAttributeKey( oldKey ); + this._model.change( writer => { + for ( const [ oldKey ] of this._getStoredAttributes() ) { + const storeKey = DocumentSelection._getStoreAttributeKey( oldKey ); - batch.removeAttribute( storeKey, selectionParent ); - } + writer.removeAttribute( storeKey, selectionParent ); + } - for ( const [ key, value ] of attrs ) { - const storeKey = DocumentSelection._getStoreAttributeKey( key ); + for ( const [ key, value ] of attrs ) { + const storeKey = DocumentSelection._getStoreAttributeKey( key ); - batch.setAttribute( storeKey, value, selectionParent ); - } + writer.setAttribute( storeKey, value, selectionParent ); + } + } ); } /** From f46b04c9f46f89040bd7a381f00d042ae2ad5fd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 4 Dec 2017 15:41:19 +0100 Subject: [PATCH 111/724] Aligned delete content with the engine changes. --- src/controller/datacontroller.js | 2 +- src/controller/deletecontent.js | 112 ++++++++++++++++--------------- 2 files changed, 58 insertions(+), 56 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 246532f74..5becf8cf8 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -268,7 +268,7 @@ export default class DataController { * @param {Object} options See {@link module:engine/controller/deletecontent~deleteContent}'s options. */ deleteContent( selection, options ) { - deleteContent( selection, options ); + deleteContent( this, selection, options ); } /** diff --git a/src/controller/deletecontent.js b/src/controller/deletecontent.js index b03dbc7f2..7bf12e7f5 100644 --- a/src/controller/deletecontent.js +++ b/src/controller/deletecontent.js @@ -10,11 +10,12 @@ import LivePosition from '../model/liveposition'; import Position from '../model/position'; import Range from '../model/range'; -import Element from '../model/element'; /** * Deletes content of the selection and merge siblings. The resulting selection is always collapsed. * + * @param {module:engine/controller/datacontroller~DataController} dataController The data controller in context of which the insertion + * should be performed. * @param {module:engine/model/selection~Selection} selection Selection of which the content should be deleted. * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. * @param {Object} [options] @@ -36,63 +37,65 @@ import Element from '../model/element'; * * `^` with the option disabled (`doNotResetEntireContent == false`) * * `^` with enabled (`doNotResetEntireContent == true`). */ -export default function deleteContent( selection, batch, options = {} ) { +export default function deleteContent( dataController, selection, options = {} ) { if ( selection.isCollapsed ) { return; } - const schema = batch.document.schema; + const schema = dataController.model.schema; - // 1. Replace the entire content with paragraph. - // See: https://github.com/ckeditor/ckeditor5-engine/issues/1012#issuecomment-315017594. - if ( !options.doNotResetEntireContent && shouldEntireContentBeReplacedWithParagraph( schema, selection ) ) { - replaceEntireContentWithParagraph( batch, selection ); + dataController.model.change( writer => { + // 1. Replace the entire content with paragraph. + // See: https://github.com/ckeditor/ckeditor5-engine/issues/1012#issuecomment-315017594. + if ( !options.doNotResetEntireContent && shouldEntireContentBeReplacedWithParagraph( schema, selection ) ) { + replaceEntireContentWithParagraph( writer, selection, schema ); - return; - } + return; + } - const selRange = selection.getFirstRange(); - const startPos = selRange.start; - const endPos = LivePosition.createFromPosition( selRange.end ); + const selRange = selection.getFirstRange(); + const startPos = selRange.start; + const endPos = LivePosition.createFromPosition( selRange.end ); - // 2. Remove the content if there is any. - if ( !selRange.start.isTouching( selRange.end ) ) { - batch.remove( selRange ); - } + // 2. Remove the content if there is any. + if ( !selRange.start.isTouching( selRange.end ) ) { + writer.remove( selRange ); + } - // 3. Merge elements in the right branch to the elements in the left branch. - // The only reasonable (in terms of data and selection correctness) case in which we need to do that is: - // - // Fo[]ar => Fo^ar - // - // However, the algorithm supports also merging deeper structures (up to the depth of the shallower branch), - // as it's hard to imagine what should actually be the default behavior. Usually, specific features will - // want to override that behavior anyway. - if ( !options.leaveUnmerged ) { - mergeBranches( batch, startPos, endPos ); - - // We need to check and strip disallowed attributes in all nested nodes because after merge - // some attributes could end up in a path where are disallowed. + // 3. Merge elements in the right branch to the elements in the left branch. + // The only reasonable (in terms of data and selection correctness) case in which we need to do that is: // - // e.g. bold is disallowed for

- //

Fo{o

b}ar

->

Fo{}ar

->

Fo{}ar

. - schema.removeDisallowedAttributes( startPos.parent.getChildren(), startPos, batch ); - } + // Fo[]ar => Fo^ar + // + // However, the algorithm supports also merging deeper structures (up to the depth of the shallower branch), + // as it's hard to imagine what should actually be the default behavior. Usually, specific features will + // want to override that behavior anyway. + if ( !options.leaveUnmerged ) { + mergeBranches( writer, startPos, endPos ); + + // We need to check and strip disallowed attributes in all nested nodes because after merge + // some attributes could end up in a path where are disallowed. + // + // e.g. bold is disallowed for

+ //

Fo{o

b}ar

->

Fo{}ar

->

Fo{}ar

. + schema.removeDisallowedAttributes( startPos.parent.getChildren(), startPos, writer ); + } - selection.setCollapsedAt( startPos ); + selection.setCollapsedAt( startPos ); - // 4. Autoparagraphing. - // Check if a text is allowed in the new container. If not, try to create a new paragraph (if it's allowed here). - if ( shouldAutoparagraph( schema, startPos ) ) { - insertParagraph( batch, startPos, selection ); - } + // 4. Autoparagraphing. + // Check if a text is allowed in the new container. If not, try to create a new paragraph (if it's allowed here). + if ( shouldAutoparagraph( schema, startPos ) ) { + insertParagraph( writer, startPos, selection ); + } - endPos.detach(); + endPos.detach(); + } ); } // This function is a result of reaching the Ballmer's peak for just the right amount of time. // Even I had troubles documenting it after a while and after reading it again I couldn't believe that it really works. -function mergeBranches( batch, startPos, endPos ) { +function mergeBranches( writer, startPos, endPos ) { const startParent = startPos.parent; const endParent = endPos.parent; @@ -112,7 +115,7 @@ function mergeBranches( batch, startPos, endPos ) { // Check if operations we'll need to do won't need to cross object or limit boundaries. // E.g., we can't merge endParent into startParent in this case: // x[]{} - if ( !checkCanBeMerged( startPos, endPos ) ) { + if ( !checkCanBeMerged( startPos, endPos, writer.model.schema ) ) { return; } @@ -128,13 +131,13 @@ function mergeBranches( batch, startPos, endPos ) { // x[]{}y // becomes: // x[]y{} - batch.insert( endParent, startPos ); + writer.insert( endParent, startPos ); } // Merge two siblings: // x[]y -> xy (the usual case) // x[]y -> xy[] (this is the "move parent" case shown above) - batch.merge( startPos ); + writer.merge( startPos ); // Remove empty end ancestors: // fo[obar] @@ -146,11 +149,11 @@ function mergeBranches( batch, startPos, endPos ) { endPos = Position.createBefore( parentToRemove ); - batch.remove( parentToRemove ); + writer.remove( parentToRemove ); } // Continue merging next level. - mergeBranches( batch, startPos, endPos ); + mergeBranches( writer, startPos, endPos ); } function shouldAutoparagraph( schema, position ) { @@ -166,8 +169,7 @@ function shouldAutoparagraph( schema, position ) { // E.g. in

x[]

 // we'll check

, , and

' ); } ); @@ -478,7 +483,7 @@ describe( 'advanced-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '' ); // Let's change link's attributes. - batch.setAttributes( { + modelWriter.setAttributes( { linkHref: 'bar.html', linkTitle: 'Bar title' }, range ); @@ -487,7 +492,7 @@ describe( 'advanced-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '' ); - batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); modelDispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 0 ), ModelRange.createIn( modelDoc.graveyard ) @@ -498,13 +503,13 @@ describe( 'advanced-converters', () => { range = ModelRange.createIn( modelRoot ); // Let's remove just one attribute. - batch.removeAttribute( 'linkTitle', range ); + modelWriter.removeAttribute( 'linkTitle', range ); modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkTitle', 'Bar title', null ); expect( viewToString( viewRoot ) ).to.equal( '' ); // Let's remove the other attribute. - batch.removeAttribute( 'linkHref', range ); + modelWriter.removeAttribute( 'linkHref', range ); modelDispatcher.convertAttribute( 'removeAttribute', range, 'linkHref', 'bar.html', null ); expect( viewToString( viewRoot ) ).to.equal( '
oo
' ); @@ -513,7 +518,7 @@ describe( 'advanced-converters', () => { it( 'should convert a view element to model', () => { const viewElement = new ViewAttributeElement( 'a', { href: 'foo.html', title: 'Foo title' }, new ViewText( 'foo' ) ); - const modelText = viewDispatcher.convert( viewElement, batch ).getChild( 0 ); + const modelText = viewDispatcher.convert( viewElement ).getChild( 0 ); expect( modelText ).to.be.instanceof( ModelText ); expect( modelText.data ).to.equal( 'foo' ); @@ -584,7 +589,7 @@ describe( 'advanced-converters', () => { ] ); - const modelElement = viewDispatcher.convert( viewElement, batch ); + const modelElement = viewDispatcher.convert( viewElement ); expect( modelToString( modelElement ) ).to.equal( 'foo' ); } ); @@ -647,7 +652,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - expect( modelToString( viewDispatcher.convert( viewTable, batch ) ) ) + expect( modelToString( viewDispatcher.convert( viewTable ) ) ) .to.equal( 'foo <$text linkHref="bar.html">barabc' ); } ); @@ -746,7 +751,7 @@ describe( 'advanced-converters', () => { ] ) ] ); - const modelElement = viewDispatcher.convert( viewElement, batch ); + const modelElement = viewDispatcher.convert( viewElement ); expect( modelToString( modelElement ) ).to.equal( '
FooFoo{}. // Usually, widget and caption are marked as objects/limits in the schema, so in this case merging will be blocked. -function checkCanBeMerged( leftPos, rightPos ) { - const schema = leftPos.root.document.schema; +function checkCanBeMerged( leftPos, rightPos, schema ) { const rangeToCheck = new Range( leftPos, rightPos ); for ( const value of rangeToCheck.getWalker() ) { @@ -179,18 +181,18 @@ function checkCanBeMerged( leftPos, rightPos ) { return true; } -function insertParagraph( batch, position, selection ) { - const paragraph = new Element( 'paragraph' ); - batch.insert( paragraph, position ); +function insertParagraph( writer, position, selection ) { + const paragraph = writer.createElement( 'paragraph' ); + writer.insert( paragraph, position ); selection.setCollapsedAt( paragraph ); } -function replaceEntireContentWithParagraph( batch, selection ) { - const limitElement = batch.document.schema.getLimitElement( selection ); +function replaceEntireContentWithParagraph( writer, selection ) { + const limitElement = writer.model.schema.getLimitElement( selection ); - batch.remove( Range.createIn( limitElement ) ); - insertParagraph( batch, Position.createAt( limitElement ), selection ); + writer.remove( Range.createIn( limitElement ) ); + insertParagraph( writer, Position.createAt( limitElement ), selection ); } // We want to replace the entire content with a paragraph when: From 61e0e8f45f54702025f076c4884be13b0e8a2b23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 4 Dec 2017 15:44:58 +0100 Subject: [PATCH 112/724] Aligned code with the engine changes. --- src/controller/editingcontroller.js | 2 +- src/conversion/view-selection-to-model-converters.js | 2 +- src/model/documentselection.js | 2 +- src/model/model.js | 2 ++ src/model/schema.js | 8 ++++---- src/model/selection.js | 2 +- 6 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 11413740c..de93e7970 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -90,7 +90,7 @@ export default class EditingController { // Convert model selection to view. this.listenTo( this.model.document, 'changesDone', () => { - const selection = this.model.selection; + const selection = this.model.document.selection; this.modelToView.convertSelection( selection ); this.view.render(); diff --git a/src/conversion/view-selection-to-model-converters.js b/src/conversion/view-selection-to-model-converters.js index 63be13035..08c9190a3 100644 --- a/src/conversion/view-selection-to-model-converters.js +++ b/src/conversion/view-selection-to-model-converters.js @@ -40,7 +40,7 @@ export function convertSelectionChange( model, mapper ) { modelSelection.setRanges( ranges, viewSelection.isBackward ); if ( !modelSelection.isEqual( model.document.selection ) ) { - model.enqueueChanges( () => { + model.enqueueChange( () => { model.document.selection.setTo( modelSelection ); } ); } diff --git a/src/model/documentselection.js b/src/model/documentselection.js index cd64f1ca0..d7c44b64e 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -611,7 +611,7 @@ export default class DocumentSelection extends Selection { */ _getSurroundingAttributes() { const position = this.getFirstPosition(); - const schema = this._document.schema; + const schema = this._model.schema; let attrs = null; diff --git a/src/model/model.js b/src/model/model.js index 4685b9406..1e9c29589 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -62,6 +62,8 @@ export default class Model { if ( this._pendingChanges.length == 1 ) { this._runPendingChanges(); } + + this.document.fire( 'changesDone' ); } _runPendingChanges() { diff --git a/src/model/schema.js b/src/model/schema.js index a981620f3..149ff37e2 100644 --- a/src/model/schema.js +++ b/src/model/schema.js @@ -418,9 +418,9 @@ export default class Schema { * * @param {Iterable.} nodes Nodes that will be filtered. * @param {module:engine/model/schema~SchemaPath} inside Path inside which schema will be checked. - * @param {module:engine/model/batch~Batch} batch Batch to which the deltas will be added. + * @param {module:engine/model/writer~Writer} writer */ - removeDisallowedAttributes( nodes, inside, batch ) { + removeDisallowedAttributes( nodes, inside, writer ) { for ( const node of nodes ) { const name = node.is( 'text' ) ? '$text' : node.name; const attributes = Array.from( node.getAttributeKeys() ); @@ -432,13 +432,13 @@ export default class Schema { // TODO: this should be improved to check all combination of attributes. for ( const attribute of node.getAttributeKeys() ) { if ( !this.check( { name, attributes: attribute, inside: queryPath } ) ) { - batch.removeAttribute( attribute, node ); + writer.removeAttribute( attribute, node ); } } } if ( node.is( 'element' ) ) { - this.removeDisallowedAttributes( node.getChildren(), queryPath.concat( node.name ), batch ); + this.removeDisallowedAttributes( node.getChildren(), queryPath.concat( node.name ), writer ); } } } diff --git a/src/model/selection.js b/src/model/selection.js index 27569afe8..101c15d24 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -787,7 +787,7 @@ function isUnvisitedBlockContainer( element, visited ) { // TODO https://github.com/ckeditor/ckeditor5-engine/issues/532#issuecomment-278900072. // This should not be a `$block` check. - return element.document.schema.itemExtends( element.name, '$block' ) && element.parent; + return element.document.model.schema.itemExtends( element.name, '$block' ) && element.parent; } // Finds the lowest element in position's ancestors which is a block. From b6465429e76fc9815412160a1d4729a998d0069e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 5 Dec 2017 08:41:03 +0100 Subject: [PATCH 113/724] Changed DataController to use model.change. --- src/controller/datacontroller.js | 2 +- src/controller/getselectedcontent.js | 155 ++++++++++++++------------- src/controller/insertcontent.js | 102 +++++++++--------- 3 files changed, 129 insertions(+), 130 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 5becf8cf8..695ade9cf 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -290,7 +290,7 @@ export default class DataController { * @returns {module:engine/model/documentfragment~DocumentFragment} Document fragment holding the clone of the selected content. */ getSelectedContent( selection ) { - return getSelectedContent( selection ); + return getSelectedContent( this, selection ); } /** diff --git a/src/controller/getselectedcontent.js b/src/controller/getselectedcontent.js index 16e98bb27..dd5bc9b99 100644 --- a/src/controller/getselectedcontent.js +++ b/src/controller/getselectedcontent.js @@ -21,90 +21,93 @@ import Position from '../model/position'; * * st

se

* + * @param {module:engine/controller/datacontroller~DataController} dataController The data controller in context of which + * the selection modification should be performed. * @param {module:engine/model/selection~Selection} selection The selection of which content will be returned. - * @param {module:engine/model/batch~Batch} batch Batch to which deltas will be added. * @returns {module:engine/model/documentfragment~DocumentFragment} */ -export default function getSelectedContent( selection, batch ) { - const frag = batch.createDocumentFragment(); - const range = selection.getFirstRange(); +export default function getSelectedContent( dataController, selection ) { + return dataController.model.change( writer => { + const frag = writer.createDocumentFragment(); + const range = selection.getFirstRange(); - if ( !range || range.isCollapsed ) { - return frag; - } - - const root = range.start.root; - const commonPath = range.start.getCommonPath( range.end ); - const commonParent = root.getNodeByPath( commonPath ); - - // ## 1st step - // - // First, we'll clone a fragment represented by a minimal flat range - // containing the original range to be cloned. - // E.g. let's consider such a range: - // - //

x

y

fir[st

se]cond

z

- // - // A minimal flat range containing this one is: - // - //

x

[

y

first

second

]

z

- // - // We can easily clone this structure, preserving e.g. the element. - let flatSubtreeRange; - - if ( range.start.parent == range.end.parent ) { - // The original range is flat, so take it. - flatSubtreeRange = range; - } else { - flatSubtreeRange = Range.createFromParentsAndOffsets( - commonParent, range.start.path[ commonPath.length ], - commonParent, range.end.path[ commonPath.length ] + 1 - ); - } - - const howMany = flatSubtreeRange.end.offset - flatSubtreeRange.start.offset; - - // Clone the whole contents. - for ( const item of flatSubtreeRange.getItems( { shallow: true } ) ) { - if ( item.is( 'textProxy' ) ) { - batch.appendText( item.data, item.getAttributes(), frag ); + if ( !range || range.isCollapsed ) { + return frag; + } + + const root = range.start.root; + const commonPath = range.start.getCommonPath( range.end ); + const commonParent = root.getNodeByPath( commonPath ); + + // ## 1st step + // + // First, we'll clone a fragment represented by a minimal flat range + // containing the original range to be cloned. + // E.g. let's consider such a range: + // + //

x

y

fir[st

se]cond

z

+ // + // A minimal flat range containing this one is: + // + //

x

[

y

first

second

]

z

+ // + // We can easily clone this structure, preserving e.g. the element. + let flatSubtreeRange; + + if ( range.start.parent == range.end.parent ) { + // The original range is flat, so take it. + flatSubtreeRange = range; } else { - batch.append( item.clone( true ), frag ); + flatSubtreeRange = Range.createFromParentsAndOffsets( + commonParent, range.start.path[ commonPath.length ], + commonParent, range.end.path[ commonPath.length ] + 1 + ); } - } - - // ## 2nd step - // - // If the original range wasn't flat, then we need to remove the excess nodes from the both ends of the cloned fragment. - // - // For example, for the range shown in the 1st step comment, we need to remove these pieces: - // - // [

y

][fir]st

se[cond]

- // - // So this will be the final copied content: - // - // st

se

- // - // In order to do that, we remove content from these two ranges: - // - // [

y

fir]st

se[cond

] - if ( flatSubtreeRange != range ) { - // Find the position of the original range in the cloned fragment. - const newRange = range._getTransformedByMove( flatSubtreeRange.start, Position.createAt( frag, 0 ), howMany )[ 0 ]; - - const leftExcessRange = new Range( Position.createAt( frag ), newRange.start ); - const rightExcessRange = new Range( newRange.end, Position.createAt( frag, 'end' ) ); - - removeRangeContent( rightExcessRange, batch ); - removeRangeContent( leftExcessRange, batch ); - } - - return frag; + + const howMany = flatSubtreeRange.end.offset - flatSubtreeRange.start.offset; + + // Clone the whole contents. + for ( const item of flatSubtreeRange.getItems( { shallow: true } ) ) { + if ( item.is( 'textProxy' ) ) { + writer.appendText( item.data, item.getAttributes(), frag ); + } else { + writer.append( item.clone( true ), frag ); + } + } + + // ## 2nd step + // + // If the original range wasn't flat, then we need to remove the excess nodes from the both ends of the cloned fragment. + // + // For example, for the range shown in the 1st step comment, we need to remove these pieces: + // + // [

y

][fir]st

se[cond]

+ // + // So this will be the final copied content: + // + // st

se

+ // + // In order to do that, we remove content from these two ranges: + // + // [

y

fir]st

se[cond

] + if ( flatSubtreeRange != range ) { + // Find the position of the original range in the cloned fragment. + const newRange = range._getTransformedByMove( flatSubtreeRange.start, Position.createAt( frag, 0 ), howMany )[ 0 ]; + + const leftExcessRange = new Range( Position.createAt( frag ), newRange.start ); + const rightExcessRange = new Range( newRange.end, Position.createAt( frag, 'end' ) ); + + removeRangeContent( rightExcessRange, writer ); + removeRangeContent( leftExcessRange, writer ); + } + + return frag; + } ); } // After https://github.com/ckeditor/ckeditor5-engine/issues/690 is fixed, // this function will, most likely, be able to rewritten using getMinimalFlatRanges(). -function removeRangeContent( range, batch ) { +function removeRangeContent( range, writer ) { const parentsToCheck = []; Array.from( range.getItems( { direction: 'backward' } ) ) @@ -126,7 +129,7 @@ function removeRangeContent( range, batch ) { .forEach( itemRange => { parentsToCheck.push( itemRange.start.parent ); - batch.remove( itemRange ); + writer.remove( itemRange ); } ); // Remove ancestors of the removed items if they turned to be empty now @@ -139,7 +142,7 @@ function removeRangeContent( range, batch ) { parent = parent.parent; - batch.remove( removeRange ); + writer.remove( removeRange ); } } ); } diff --git a/src/controller/insertcontent.js b/src/controller/insertcontent.js index 4132d8875..76196678e 100644 --- a/src/controller/insertcontent.js +++ b/src/controller/insertcontent.js @@ -26,51 +26,47 @@ import log from '@ckeditor/ckeditor5-utils/src/log'; * should be performed. * @param {module:engine/model/documentfragment~DocumentFragment|module:engine/model/item~Item} content The content to insert. * @param {module:engine/model/selection~Selection} selection Selection into which the content should be inserted. - * @param {module:engine/model/batch~Batch} [batch] Batch to which deltas will be added. If not specified, then - * changes will be added to a new batch. */ -export default function insertContent( dataController, content, selection, batch ) { - if ( !batch ) { - batch = dataController.model.batch(); - } - - if ( !selection.isCollapsed ) { - dataController.deleteContent( selection, batch ); - } +export default function insertContent( dataController, content, selection ) { + dataController.model.change( writer => { + if ( !selection.isCollapsed ) { + dataController.deleteContent( selection ); + } - const insertion = new Insertion( dataController, batch, selection.anchor ); + const insertion = new Insertion( dataController, writer, selection.anchor ); - let nodesToInsert; + let nodesToInsert; - if ( content.is( 'documentFragment' ) ) { - nodesToInsert = content.getChildren(); - } else { - nodesToInsert = [ content ]; - } - - insertion.handleNodes( nodesToInsert, { - // The set of children being inserted is the only set in this context - // so it's the first and last (it's a hack ;)). - isFirst: true, - isLast: true - } ); + if ( content.is( 'documentFragment' ) ) { + nodesToInsert = content.getChildren(); + } else { + nodesToInsert = [ content ]; + } - const newRange = insertion.getSelectionRange(); + insertion.handleNodes( nodesToInsert, { + // The set of children being inserted is the only set in this context + // so it's the first and last (it's a hack ;)). + isFirst: true, + isLast: true + } ); - /* istanbul ignore else */ - if ( newRange ) { - selection.setRanges( [ newRange ] ); - } else { - // We are not testing else because it's a safe check for unpredictable edge cases: - // an insertion without proper range to select. + const newRange = insertion.getSelectionRange(); - /** - * Cannot determine a proper selection range after insertion. - * - * @warning insertcontent-no-range - */ - log.warn( 'insertcontent-no-range: Cannot determine a proper selection range after insertion.' ); - } + /* istanbul ignore else */ + if ( newRange ) { + selection.setRanges( [ newRange ] ); + } else { + // We are not testing else because it's a safe check for unpredictable edge cases: + // an insertion without proper range to select. + + /** + * Cannot determine a proper selection range after insertion. + * + * @warning insertcontent-no-range + */ + log.warn( 'insertcontent-no-range: Cannot determine a proper selection range after insertion.' ); + } + } ); } /** @@ -79,7 +75,7 @@ export default function insertContent( dataController, content, selection, batch * @private */ class Insertion { - constructor( dataController, batch, position ) { + constructor( dataController, writer, position ) { /** * The data controller in context of which the insertion should be performed. * @@ -90,9 +86,9 @@ class Insertion { /** * Batch to which deltas will be added. * - * @member {module:engine/controller/batch~Batch} #batch + * @member {module:engine/controller/writer~Batch} #writer */ - this.batch = batch; + this.writer = writer; /** * The position at which (or near which) the next node will be inserted. @@ -153,7 +149,7 @@ class Insertion { return Range.createOn( this.nodeToSelect ); } - return this.dataController.model.getNearestSelectionRange( this.position ); + return this.dataController.model.document.getNearestSelectionRange( this.position ); } /** @@ -229,7 +225,7 @@ class Insertion { // If the node is a text and bare text is allowed in current position it means that the node // contains disallowed attributes and we have to remove them. else if ( this.schema.check( { name: '$text', inside: this.position } ) ) { - this.schema.removeDisallowedAttributes( [ node ], this.position, this.batch ); + this.schema.removeDisallowedAttributes( [ node ], this.position, this.writer ); this._handleNode( node, context ); } // If text is not allowed, try autoparagraphing. @@ -256,7 +252,7 @@ class Insertion { const livePos = LivePosition.createFromPosition( this.position ); - this.batch.insert( node, this.position ); + this.writer.insert( node, this.position ); this.position = Position.createFromPosition( livePos ); livePos.detach(); @@ -286,12 +282,12 @@ class Insertion { if ( mergeLeft ) { const position = LivePosition.createFromPosition( this.position ); - this.batch.merge( mergePosLeft ); + this.writer.merge( mergePosLeft ); // We need to check and strip disallowed attributes in all nested nodes because after merge // some attributes could end up in a path where are disallowed. const parent = position.nodeBefore; - this.schema.removeDisallowedAttributes( parent.getChildren(), Position.createAt( parent ), this.batch ); + this.schema.removeDisallowedAttributes( parent.getChildren(), Position.createAt( parent ), this.writer ); this.position = Position.createFromPosition( position ); position.detach(); @@ -314,11 +310,11 @@ class Insertion { // NOK:

xx[]

+

yy

=>

xxyy[]

(when sticks to next) const position = new LivePosition( this.position.root, this.position.path, 'sticksToPrevious' ); - this.batch.merge( mergePosRight ); + this.writer.merge( mergePosRight ); // We need to check and strip disallowed attributes in all nested nodes because after merge // some attributes could end up in a place where are disallowed. - this.schema.removeDisallowedAttributes( position.parent.getChildren(), position, this.batch ); + this.schema.removeDisallowedAttributes( position.parent.getChildren(), position, this.writer ); this.position = Position.createFromPosition( position ); position.detach(); @@ -330,7 +326,7 @@ class Insertion { // When there was no merge we need to check and strip disallowed attributes in all nested nodes of // just inserted node because some attributes could end up in a place where are disallowed. if ( !mergeLeft && !mergeRight ) { - this.schema.removeDisallowedAttributes( node.getChildren(), Position.createAt( node ), this.batch ); + this.schema.removeDisallowedAttributes( node.getChildren(), Position.createAt( node ), this.writer ); } } @@ -341,7 +337,7 @@ class Insertion { * @param {Object} context */ _tryAutoparagraphing( node, context ) { - const paragraph = this.batch.createElement( 'paragraph' ); + const paragraph = this.writer.createElement( 'paragraph' ); // Do not autoparagraph if the paragraph won't be allowed there, // cause that would lead to an infinite loop. The paragraph would be rejected in @@ -350,7 +346,7 @@ class Insertion { // When node is a text and is disallowed by schema it means that contains disallowed attributes // and we need to remove them. if ( node.is( 'text' ) && !this._checkIsAllowed( node, [ paragraph ] ) ) { - this.schema.removeDisallowedAttributes( [ node ], [ paragraph ], this.batch ); + this.schema.removeDisallowedAttributes( [ node ], [ paragraph ], this.writer ); } if ( this._checkIsAllowed( node, [ paragraph ] ) ) { @@ -385,14 +381,14 @@ class Insertion { // Special case – parent is empty (

^

) so isAtStart == isAtEnd == true. // We can remove the element after moving selection out of it. if ( parent.isEmpty ) { - this.batch.remove( parent ); + this.writer.remove( parent ); } } else if ( this.position.isAtEnd ) { this.position = Position.createAfter( this.position.parent ); } else { const tempPos = Position.createAfter( this.position.parent ); - this.batch.split( this.position ); + this.writer.split( this.position ); this.position = tempPos; From c5145d18b20e0e2381d0af638742acef9e396998 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 5 Dec 2017 08:42:58 +0100 Subject: [PATCH 114/724] Changed enqueueChange to change. --- src/conversion/view-selection-to-model-converters.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/conversion/view-selection-to-model-converters.js b/src/conversion/view-selection-to-model-converters.js index 08c9190a3..fa8144b5d 100644 --- a/src/conversion/view-selection-to-model-converters.js +++ b/src/conversion/view-selection-to-model-converters.js @@ -40,7 +40,7 @@ export function convertSelectionChange( model, mapper ) { modelSelection.setRanges( ranges, viewSelection.isBackward ); if ( !modelSelection.isEqual( model.document.selection ) ) { - model.enqueueChange( () => { + model.change( () => { model.document.selection.setTo( modelSelection ); } ); } From b7a5b3d0099351ef29fbe41dd78a46f9b3ba0961 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 5 Dec 2017 08:43:38 +0100 Subject: [PATCH 115/724] Added changesDone event to document - backward compatibility. --- src/model/document.js | 3 +++ src/model/model.js | 2 -- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index cca9ba5d1..bcfafd7c1 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -132,6 +132,9 @@ export default class Document { this.fire( 'change', operation.type, evt.return, operation.delta.batch, operation.delta.type ); } }, { priority: 'low' } ); + + // Temporary compatibility. + model.delegate( 'changesDone' ).to( this ); } /** diff --git a/src/model/model.js b/src/model/model.js index 1e9c29589..4685b9406 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -62,8 +62,6 @@ export default class Model { if ( this._pendingChanges.length == 1 ) { this._runPendingChanges(); } - - this.document.fire( 'changesDone' ); } _runPendingChanges() { From 2b4352a79eb4eaba2f5f220000a43addc167492b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 5 Dec 2017 14:47:31 +0100 Subject: [PATCH 116/724] Other: Initial implementation of unified converters from ViewElementDefinition interface. --- src/conversion/attributeconverters.js | 78 +++++++++++++++++++++++++++ src/conversion/elementconverters.js | 52 ++++++++++++++++++ src/view/matcher.js | 14 +++++ src/view/viewelementdefinition.jsdoc | 22 ++++++++ 4 files changed, 166 insertions(+) create mode 100644 src/conversion/attributeconverters.js create mode 100644 src/conversion/elementconverters.js create mode 100644 src/view/viewelementdefinition.jsdoc diff --git a/src/conversion/attributeconverters.js b/src/conversion/attributeconverters.js new file mode 100644 index 000000000..41eb1de1b --- /dev/null +++ b/src/conversion/attributeconverters.js @@ -0,0 +1,78 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import AttributeElement from '../view/attributeelement'; +import buildModelConverter from './buildmodelconverter'; +import buildViewConverter from './buildviewconverter'; + +export function viewToModelAttribute( attributeName, attributeValue, view, dispatchers ) { + const viewDefinitions = view.from ? view.from : [ view ]; + + for ( const viewDefinition of viewDefinitions ) { + const element = viewDefinition.name; + const classes = viewDefinition.class; + const styles = viewDefinition.style; + + const pattern = { name: element }; + + if ( classes ) { + pattern.class = classes; + } + + if ( styles ) { + pattern.style = styles; + } + + buildViewConverter() + .for( ...dispatchers ) + .from( pattern ) + .toAttribute( () => ( { + key: attributeName, + value: attributeValue + } ) ); + } +} + +export function modelAttributeToView( attributeName, attributeValue, view, dispatchers ) { + buildModelConverter() + .for( ...dispatchers ) + .fromAttribute( attributeName ) + .toElement( value => { + // TODO: string vs numeric values + if ( value != attributeValue ) { + return; + } + + const viewDefinition = view.to ? view.to : view; + // TODO: AttributeElement.fromDefinition() ? + + const classes = viewDefinition.class; + const styles = viewDefinition.style; + + const attributes = {}; + + // TODO: AttributeElement does no accept Array + if ( classes ) { + attributes.class = Array.isArray( classes ) ? classes.join( ' ' ) : classes; + } + + // TODO: Attribute element does not accept Object + if ( styles ) { + attributes.style = typeof styles === 'string' ? styles : toStylesString( styles ); + } + + return new AttributeElement( viewDefinition.name, attributes ); + } ); +} + +function toStylesString( stylesObject ) { + const styles = []; + + for ( const key in stylesObject ) { + styles.push( key + ':' + stylesObject[ key ] ); + } + + return styles.join( ';' ); +} diff --git a/src/conversion/elementconverters.js b/src/conversion/elementconverters.js new file mode 100644 index 000000000..627139e42 --- /dev/null +++ b/src/conversion/elementconverters.js @@ -0,0 +1,52 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import buildModelConverter from './buildmodelconverter'; +import buildViewConverter from './buildviewconverter'; +import ViewContainerElement from '../view/containerelement'; + +export function modelElementToView( modelElement, view, dispatchers ) { + const viewDefinition = view.to ? view.to : view; + + const attributes = {}; + + if ( viewDefinition.class ) { + attributes.class = viewDefinition.class; + } + + if ( viewDefinition.style ) { + attributes.style = viewDefinition.style; + } + + if ( viewDefinition.attribute ) { + attributes.attribute = viewDefinition.attribute; + } + + buildModelConverter().for( ...dispatchers ) + .fromElement( modelElement ) + .toElement( () => { + // TODO: create method from definition + return new ViewContainerElement( viewDefinition.name, attributes ); + } ); +} + +export function viewToModelElement( element, view, dispatchers ) { + // TODO: support multiple definitions + // { name: option.view.name } + + const viewDefinitions = view.from ? view.from : [ view ]; + + const converter = buildViewConverter().for( ...dispatchers ); + + for ( const viewDefinition of viewDefinitions ) { + converter.from( viewDefinition ); + + if ( viewDefinition.priority ) { + converter.withPriority( viewDefinition.priority ); + } + } + + converter.toElement( element ); +} diff --git a/src/view/matcher.js b/src/view/matcher.js index d13622113..22a76824e 100644 --- a/src/view/matcher.js +++ b/src/view/matcher.js @@ -378,3 +378,17 @@ function matchStyles( patterns, element ) { return match; } + +/** + * @typedef {Object} @module engine/view/matcher~Pattern + * + * @param {String|RegExp} [name] Name or regular expression to match element's name. + * @param {Object} [attribute] Object with key-value pairs representing attributes to match. Each object key + * represents attribute name. Value under that key can be either a string or a regular expression and it will be + * used to match attribute value. + * @param {String|RegExp|Array} [class] Class name or array of class names to match. Each name can be + * provided in a form of string or regular expression. + * @param {Object} [style] Object with key-value pairs representing styles to match. Each object key + * represents style name. Value under that key can be either a string or a regular expression and it will be used + * to match style value. + */ diff --git a/src/view/viewelementdefinition.jsdoc b/src/view/viewelementdefinition.jsdoc new file mode 100644 index 000000000..db076ad10 --- /dev/null +++ b/src/view/viewelementdefinition.jsdoc @@ -0,0 +1,22 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/view/viewelementdefinition + */ + +/** + * An object defining view element used for defining elements for conversion. + * + * @typedef {Object} module:engine/view/viewelementdefinition~ViewElementDefinition + * + * @property {String} name View element attribute name. + * @property {String|Array.} [class] Class name or array of class names to match. Each name can be + * provided in a form of string. + * @property {Object} [style] Object with key-value pairs representing styles to match. Each object key + * represents style name. Value under that key must be a string. + * @property {Object} [attribute] Object with key-value pairs representing attributes to match. Each object key + * represents attribute name. Value under that key must be a string. + */ From 0b8c6d8a5dbe5ed0c65a63b12f48c7da2e855477 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 7 Dec 2017 12:33:29 +0100 Subject: [PATCH 117/724] Aligned model dev-utils with engine changes. --- src/dev-utils/model.js | 64 +++++++++++----------- tests/dev-utils/model.js | 115 ++++++++++++++++++++------------------- 2 files changed, 89 insertions(+), 90 deletions(-) diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 5bdd30d2b..3c5f146cb 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -12,14 +12,13 @@ */ import RootElement from '../model/rootelement'; -import ModelDocument from '../model/document'; +import Model from '../model/model'; +import Batch from '../model/batch'; import ModelRange from '../model/range'; import ModelPosition from '../model/position'; import ModelConversionDispatcher from '../conversion/modelconversiondispatcher'; import ModelSelection from '../model/selection'; import ModelDocumentFragment from '../model/documentfragment'; -import ModelElement from '../model/element'; -import ModelText from '../model/text'; import ViewConversionDispatcher from '../conversion/viewconversiondispatcher'; import ViewSelection from '../view/selection'; @@ -44,7 +43,7 @@ import isPlainObject from '@ckeditor/ckeditor5-utils/src/lib/lodash/isPlainObjec * * <$text attribute="value">Text data * - * @param {module:engine/model/document~Document} document + * @param {module:engine/model/model~Model} model * @param {Object} [options] * @param {Boolean} [options.withoutSelection=false] Whether to write the selection. When set to `true` selection will * be not included in returned string. @@ -52,16 +51,16 @@ import isPlainObject from '@ckeditor/ckeditor5-utils/src/lib/lodash/isPlainObjec * default `main` name will be used. * @returns {String} The stringified data. */ -export function getData( document, options = {} ) { - if ( !( document instanceof ModelDocument ) ) { - throw new TypeError( 'Document needs to be an instance of module:engine/model/document~Document.' ); +export function getData( model, options = {} ) { + if ( !( model instanceof Model ) ) { + throw new TypeError( 'Model needs to be an instance of module:engine/model/model~Model.' ); } const withoutSelection = !!options.withoutSelection; const rootName = options.rootName || 'main'; - const root = document.getRoot( rootName ); + const root = model.document.getRoot( rootName ); - return withoutSelection ? getData._stringify( root ) : getData._stringify( root, document.selection ); + return withoutSelection ? getData._stringify( root ) : getData._stringify( root, model.document.selection ); } // Set stringify as getData private method - needed for testing/spying. @@ -77,7 +76,7 @@ getData._stringify = stringify; * * <$text attribute="value">Text data * - * @param {module:engine/model/document~Document} document + * @param {module:engine/model/model~Model} model * @param {String} data HTML-like string to write into Document. * @param {Object} options * @param {String} [options.rootName='main'] Root name where parsed data will be stored. If not provided, default `main` @@ -87,18 +86,17 @@ getData._stringify = stringify; * @param {String} [options.batchType='transparent'] Batch type used for inserting elements. * See {@link module:engine/model/batch~Batch#type}. */ -export function setData( document, data, options = {} ) { - if ( !( document instanceof ModelDocument ) ) { - throw new TypeError( 'Document needs to be an instance of module:engine/model/document~Document.' ); +export function setData( model, data, options = {} ) { + if ( !( model instanceof Model ) ) { + throw new TypeError( 'Model needs to be an instance of module:engine/model/model~Model.' ); } let modelDocumentFragment, selection; - const modelRoot = document.getRoot( options.rootName || 'main' ); - - const batch = document.batch( options.batchType || 'transparent' ); + const modelRoot = model.document.getRoot( options.rootName || 'main' ); + const batch = new Batch( options.batchType || 'transparent' ); // Parse data string to model. - const parsedResult = setData._parse( data, document.schema, batch, { + const parsedResult = setData._parse( data, model.schema, { lastRangeBackward: options.lastRangeBackward, selectionAttributes: options.selectionAttributes, context: [ modelRoot.name ] @@ -112,14 +110,14 @@ export function setData( document, data, options = {} ) { modelDocumentFragment = parsedResult; } - document.enqueueChanges( () => { + model.enqueueChange( batch, writer => { // Replace existing model in document by new one. - batch.remove( ModelRange.createIn( modelRoot ) ); - batch.insert( modelDocumentFragment, modelRoot ); + writer.remove( ModelRange.createIn( modelRoot ) ); + writer.insert( modelDocumentFragment, modelRoot ); // Clean up previous document selection. - document.selection.clearAttributes(); - document.selection.removeAllRanges(); + model.document.selection.clearAttributes(); + model.document.selection.removeAllRanges(); // Update document selection if specified. if ( selection ) { @@ -132,10 +130,10 @@ export function setData( document, data, options = {} ) { ranges.push( new ModelRange( start, end ) ); } - document.selection.setRanges( ranges, selection.isBackward ); + model.document.selection.setRanges( ranges, selection.isBackward ); if ( options.selectionAttributes ) { - document.selection.setAttributesTo( selection.getAttributes() ); + model.document.selection.setAttributesTo( selection.getAttributes() ); } } } ); @@ -161,7 +159,7 @@ setData._parse = parse; * @returns {String} HTML-like string representing the model. */ export function stringify( node, selectionOrPositionOrRange = null ) { - const modelDoc = new ModelDocument(); + const model = new Model(); const mapper = new Mapper(); let selection, range; @@ -195,7 +193,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { // Setup model to view converter. const viewDocumentFragment = new ViewDocumentFragment(); const viewSelection = new ViewSelection(); - const modelToView = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); + const modelToView = new ModelConversionDispatcher( model, { mapper, viewSelection } ); // Bind root elements. mapper.bindElements( node.root, viewDocumentFragment ); @@ -252,7 +250,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { * module:engine/model/documentfragment~DocumentFragment|Object} Returns parsed model node or * object with two fields `model` and `selection` when selection ranges were included in data to parse. */ -export function parse( data, schema, batch, options = {} ) { +export function parse( data, schema, options = {} ) { const mapper = new Mapper(); // Replace not accepted by XML `$text` tag name by valid one `model-text-with-attributes`. @@ -275,7 +273,7 @@ export function parse( data, schema, batch, options = {} ) { } // Setup view to model converter. - const viewToModel = new ViewConversionDispatcher( { schema, mapper } ); + const viewToModel = new ViewConversionDispatcher( new Model(), { schema, mapper } ); viewToModel.on( 'documentFragment', convertToModelFragment() ); viewToModel.on( 'element:model-text-with-attributes', convertToModelText( true ) ); @@ -283,10 +281,10 @@ export function parse( data, schema, batch, options = {} ) { viewToModel.on( 'text', convertToModelText() ); // Convert view to model. - let model = viewToModel.convert( viewDocumentFragment.root, batch, { context: options.context || [ '$root' ] } ); + let model = viewToModel.convert( viewDocumentFragment.root, { context: options.context || [ '$root' ] } ); // If root DocumentFragment contains only one element - return that element. - if ( model.is( 'documentFragment' ) && model.childCount == 1 ) { + if ( model.childCount == 1 ) { model = model.getChild( 0 ); } @@ -346,7 +344,7 @@ function convertToModelElement() { // E.g. `bold="true"` - value will be parsed from string `"true"` to boolean `true`. const attributes = convertAttributes( data.input.getAttributes(), parseAttributeValue ); - data.output = new ModelElement( data.input.name, attributes ); + data.output = conversionApi.writer.createElement( data.input.name, attributes ); conversionApi.mapper.bindElements( data.output, data.input ); data.context.push( data.output ); @@ -375,9 +373,9 @@ function convertToModelText( withAttributes = false ) { // E.g. `bold="true"` - value will be parsed from string `"true"` to boolean `true`. const attributes = convertAttributes( data.input.getAttributes(), parseAttributeValue ); - node = new ModelText( data.input.getChild( 0 ).data, attributes ); + node = conversionApi.writer.createText( data.input.getChild( 0 ).data, attributes ); } else { - node = new ModelText( data.input.data ); + node = conversionApi.writer.createText( data.input.data ); } data.output = node; diff --git a/tests/dev-utils/model.js b/tests/dev-utils/model.js index c38c2d4d2..abee4b96a 100644 --- a/tests/dev-utils/model.js +++ b/tests/dev-utils/model.js @@ -4,7 +4,7 @@ */ import { stringify, parse, getData, setData } from '../../src/dev-utils/model'; -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DocumentFragment from '../../src/model/documentfragment'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; @@ -13,31 +13,32 @@ import Position from '../../src/model/position'; import count from '@ckeditor/ckeditor5-utils/src/count'; describe( 'model test utils', () => { - let document, root, selection, sandbox; + let model, document, root, selection, sandbox; beforeEach( () => { - document = new Document(); + model = new Model(); + document = model.document; root = document.createRoot(); selection = document.selection; sandbox = sinon.sandbox.create(); selection.removeAllRanges(); - document.schema.registerItem( 'a', '$inline' ); - document.schema.allow( { name: 'a', inside: '$root' } ); - document.schema.allow( { name: 'a', inside: '$root', attributes: [ 'bar', 'car', 'foo' ] } ); + model.schema.registerItem( 'a', '$inline' ); + model.schema.allow( { name: 'a', inside: '$root' } ); + model.schema.allow( { name: 'a', inside: '$root', attributes: [ 'bar', 'car', 'foo' ] } ); - document.schema.registerItem( 'b', '$inline' ); - document.schema.allow( { name: 'b', inside: '$root' } ); - document.schema.allow( { name: 'b', inside: '$root', attributes: [ 'barFoo', 'fooBar', 'x' ] } ); + model.schema.registerItem( 'b', '$inline' ); + model.schema.allow( { name: 'b', inside: '$root' } ); + model.schema.allow( { name: 'b', inside: '$root', attributes: [ 'barFoo', 'fooBar', 'x' ] } ); - document.schema.registerItem( 'c', '$inline' ); - document.schema.allow( { name: 'c', inside: '$root' } ); + model.schema.registerItem( 'c', '$inline' ); + model.schema.allow( { name: 'c', inside: '$root' } ); - document.schema.registerItem( 'paragraph', '$block' ); - document.schema.allow( { name: '$text', inside: '$root' } ); - document.schema.allow( { name: '$text', inside: 'a' } ); - document.schema.allow( { name: '$text', inside: 'b' } ); - document.schema.allow( { name: 'c', inside: 'b' } ); + model.schema.registerItem( 'paragraph', '$block' ); + model.schema.allow( { name: '$text', inside: '$root' } ); + model.schema.allow( { name: '$text', inside: 'a' } ); + model.schema.allow( { name: '$text', inside: 'b' } ); + model.schema.allow( { name: 'c', inside: 'b' } ); } ); afterEach( () => { @@ -49,7 +50,7 @@ describe( 'model test utils', () => { const stringifySpy = sandbox.spy( getData, '_stringify' ); root.appendChildren( new Element( 'b', null, new Text( 'btext' ) ) ); - expect( getData( document, { withoutSelection: true } ) ).to.equal( 'btext' ); + expect( getData( model, { withoutSelection: true } ) ).to.equal( 'btext' ); sinon.assert.calledOnce( stringifySpy ); sinon.assert.calledWithExactly( stringifySpy, root ); } ); @@ -59,7 +60,7 @@ describe( 'model test utils', () => { root.appendChildren( new Element( 'b', null, new Text( 'btext' ) ) ); document.selection.addRange( Range.createFromParentsAndOffsets( root, 0, root, 1 ) ); - expect( getData( document ) ).to.equal( '[btext]' ); + expect( getData( model ) ).to.equal( '[btext]' ); sinon.assert.calledOnce( stringifySpy ); sinon.assert.calledWithExactly( stringifySpy, root, document.selection ); } ); @@ -67,7 +68,7 @@ describe( 'model test utils', () => { it( 'should throw an error when passing invalid document', () => { expect( () => { getData( { invalid: 'document' } ); - } ).to.throw( TypeError, 'Document needs to be an instance of module:engine/model/document~Document.' ); + } ).to.throw( TypeError, 'Model needs to be an instance of module:engine/model/model~Model.' ); } ); } ); @@ -77,9 +78,9 @@ describe( 'model test utils', () => { const options = {}; const data = 'btexttext'; - setData( document, data, options ); + setData( model, data, options ); - expect( getData( document, { withoutSelection: true } ) ).to.equal( data ); + expect( getData( model, { withoutSelection: true } ) ).to.equal( data ); sinon.assert.calledOnce( parseSpy ); const args = parseSpy.firstCall.args; expect( args[ 0 ] ).to.equal( data ); @@ -90,9 +91,9 @@ describe( 'model test utils', () => { const options = {}; const data = '[btext]'; - setData( document, data, options ); + setData( model, data, options ); - expect( getData( document ) ).to.equal( data ); + expect( getData( model ) ).to.equal( data ); sinon.assert.calledOnce( parseSpy ); const args = parseSpy.firstCall.args; expect( args[ 0 ] ).to.equal( data ); @@ -139,41 +140,41 @@ describe( 'model test utils', () => { } ); it( 'should insert backward selection', () => { - setData( document, '[foo bar]', { lastRangeBackward: true } ); + setData( model, '[foo bar]', { lastRangeBackward: true } ); - expect( getData( document ) ).to.equal( '[foo bar]' ); + expect( getData( model ) ).to.equal( '[foo bar]' ); expect( document.selection.isBackward ).to.true; } ); it( 'should throw an error when passing invalid document', () => { expect( () => { setData( { invalid: 'document' } ); - } ).to.throw( TypeError, 'Document needs to be an instance of module:engine/model/document~Document.' ); + } ).to.throw( TypeError, 'Model needs to be an instance of module:engine/model/model~Model.' ); } ); it( 'should set attributes to the selection', () => { - setData( document, '[foo bar]', { selectionAttributes: { foo: 'bar' } } ); + setData( model, '[foo bar]', { selectionAttributes: { foo: 'bar' } } ); expect( document.selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); } ); // #815. it( 'should work in a special root', () => { - const document = new Document(); + const model = new Model(); - document.schema.registerItem( 'textOnly' ); - document.schema.allow( { name: '$text', inside: 'textOnly' } ); - document.createRoot( 'textOnly', 'textOnly' ); + model.schema.registerItem( 'textOnly' ); + model.schema.allow( { name: '$text', inside: 'textOnly' } ); + model.document.createRoot( 'textOnly', 'textOnly' ); - setData( document, 'a[b]c', { rootName: 'textOnly' } ); - expect( getData( document, { rootName: 'textOnly' } ) ).to.equal( 'a[b]c' ); + setData( model, 'a[b]c', { rootName: 'textOnly' } ); + expect( getData( model, { rootName: 'textOnly' } ) ).to.equal( 'a[b]c' ); } ); function test( data, expected ) { expected = expected || data; - setData( document, data ); - expect( getData( document ) ).to.equal( expected ); + setData( model, data ); + expect( getData( model ) ).to.equal( expected ); } } ); @@ -497,31 +498,31 @@ describe( 'model test utils', () => { it( 'throws when invalid XML', () => { expect( () => { - parse( '', document.schema, document.batch() ); + parse( '', model.schema ); } ).to.throw( Error, /Parse error/ ); } ); it( 'throws when try to set element not registered in schema', () => { expect( () => { - parse( '', document.schema, document.batch() ); + parse( '', model.schema ); } ).to.throw( Error, 'Element \'xyz\' not allowed in context ["$root"].' ); } ); it( 'throws when try to set text directly to $root without registering it', () => { - const document = new Document(); + const model = new Model(); expect( () => { - parse( 'text', document.schema, document.batch() ); + parse( 'text', model.schema ); } ).to.throw( Error, 'Element \'$text\' not allowed in context ["$root"].' ); } ); it( 'converts data in the specified context', () => { - const doc = new Document(); - doc.schema.registerItem( 'foo' ); - doc.schema.allow( { name: '$text', inside: 'foo' } ); + const model = new Model(); + model.schema.registerItem( 'foo' ); + model.schema.allow( { name: '$text', inside: 'foo' } ); expect( () => { - parse( 'text', doc.schema, doc.batch(), { context: [ 'foo' ] } ); + parse( 'text', model.schema, { context: [ 'foo' ] } ); } ).to.not.throw(); } ); @@ -556,7 +557,7 @@ describe( 'model test utils', () => { } ); it( 'sets selection attributes', () => { - const result = parse( 'foo[]bar', document.schema, document.batch(), { selectionAttributes: { + const result = parse( 'foo[]bar', model.schema, { selectionAttributes: { bold: true, italic: true } } ); @@ -577,7 +578,7 @@ describe( 'model test utils', () => { } ); it( 'sets selection with attribute containing an element', () => { - const result = parse( 'x[]', document.schema, document.batch(), { selectionAttributes: { + const result = parse( 'x[]', model.schema, { selectionAttributes: { bold: true } } ); @@ -586,7 +587,7 @@ describe( 'model test utils', () => { } ); it( 'sets a backward selection containing an element', () => { - const result = parse( 'x[]', document.schema, document.batch(), { + const result = parse( 'x[]', model.schema, { lastRangeBackward: true } ); @@ -599,7 +600,7 @@ describe( 'model test utils', () => { } ); it( 'sets selection within a text with different attributes', () => { - const result = parse( '<$text bold="true">fo[oba]r', document.schema, document.batch(), { + const result = parse( '<$text bold="true">fo[oba]r', model.schema, { selectionAttributes: { bold: true } } ); @@ -609,34 +610,34 @@ describe( 'model test utils', () => { it( 'throws when missing selection start', () => { expect( () => { - parse( 'foo]', document.schema, document.batch() ); - } ).to.throw( Error ); + parse( 'foo]', model.schema ); + } ).to.throw( Error, /^Parse error/ ); } ); it( 'throws when missing selection end', () => { expect( () => { - parse( '[foo', document.schema, document.batch() ); - } ).to.throw( Error ); + parse( '[foo', model.schema ); + } ).to.throw( Error, /^Parse error/ ); } ); } ); function test( title, options ) { it( title, () => { const output = options.output || options.data; - const data = parse( options.data, document.schema, document.batch() ); - let model, selection; + const data = parse( options.data, model.schema ); + let converted, selection; if ( data.selection && data.model ) { - model = data.model; + converted = data.model; selection = data.selection; } else { - model = data; + converted = data; } - expect( stringify( model, selection ) ).to.equal( output ); + expect( stringify( converted, selection ) ).to.equal( output ); if ( options.check ) { - options.check( model, selection ); + options.check( converted, selection ); } } ); } From 8dc3030b54009047a6169eff3a2c60f39f652b40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 7 Dec 2017 15:44:27 +0100 Subject: [PATCH 118/724] Fixed conversion tests. --- tests/conversion/advanced-converters.js | 53 ++++---- tests/conversion/buildmodelconverter.js | 19 ++- tests/conversion/buildviewconverter.js | 69 +++++------ .../model-selection-to-view-converters.js | 63 +++++----- tests/conversion/model-to-view-converters.js | 56 +++++---- tests/conversion/modelconversiondispatcher.js | 116 ++++++++++-------- .../view-selection-to-model-converters.js | 10 +- tests/conversion/view-to-model-converters.js | 23 ++-- tests/conversion/viewconversiondispatcher.js | 50 ++++---- 9 files changed, 234 insertions(+), 225 deletions(-) diff --git a/tests/conversion/advanced-converters.js b/tests/conversion/advanced-converters.js index f8c23fb2b..e980570a8 100644 --- a/tests/conversion/advanced-converters.js +++ b/tests/conversion/advanced-converters.js @@ -3,13 +3,15 @@ * For licensing, see LICENSE.md. */ -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; import ModelTextProxy from '../../src/model/textproxy'; import ModelRange from '../../src/model/range'; import ModelPosition from '../../src/model/position'; import ModelWalker from '../../src/model/treewalker'; +import ModelWriter from '../../src/model/writer'; +import Batch from '../../src/model/batch'; import ViewElement from '../../src/view/element'; import ViewContainerElement from '../../src/view/containerelement'; @@ -38,25 +40,28 @@ import { convertToModelFragment, convertText } from '../../src/conversion/view-t import { createRangeOnElementOnly } from '../../tests/model/_utils/utils'; describe( 'advanced-converters', () => { - let modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher, batch; + let model, modelDoc, modelRoot, viewRoot, mapper, modelDispatcher, viewDispatcher, modelWriter; beforeEach( () => { - modelDoc = new ModelDocument(); + model = new Model(); + modelDoc = model.document; modelRoot = modelDoc.createRoot(); viewRoot = new ViewContainerElement( 'div' ); - batch = modelDoc.batch(); mapper = new Mapper(); mapper.bindElements( modelRoot, viewRoot ); - modelDispatcher = new ModelConversionDispatcher( modelDoc, { mapper } ); + modelDispatcher = new ModelConversionDispatcher( model, { mapper } ); // Schema is mocked up because we don't care about it in those tests. - viewDispatcher = new ViewConversionDispatcher( { schema: { check: () => true } } ); + viewDispatcher = new ViewConversionDispatcher( model, { schema: { check: () => true } } ); modelDispatcher.on( 'insert:$text', insertText() ); modelDispatcher.on( 'remove', remove() ); viewDispatcher.on( 'text', convertText() ); viewDispatcher.on( 'documentFragment', convertToModelFragment() ); + + // We need to create a model writer to modify model tree in tests. + modelWriter = new ModelWriter( model, new Batch() ); } ); function viewAttributesToString( item ) { @@ -217,16 +222,16 @@ describe( 'advanced-converters', () => { const viewImageConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - data.output = conversionApi.batch.createElement( 'image', data.input.getAttributes() ); + data.output = conversionApi.writer.createElement( 'image', data.input.getAttributes() ); } }; const viewFigcaptionConverter = function( evt, data, consumable, conversionApi ) { if ( consumable.consume( data.input, { name: true } ) ) { - const modelCaption = conversionApi.batch.createElement( 'caption' ); + const modelCaption = conversionApi.writer.createElement( 'caption' ); const children = conversionApi.convertChildren( data.input, consumable ); - conversionApi.batch.append( children, modelCaption ); + conversionApi.writer.append( children, modelCaption ); data.output = modelCaption; } @@ -242,14 +247,14 @@ describe( 'advanced-converters', () => { } ); it( 'should convert model images changes without caption to view', () => { - const modelElement = batch.createElement( 'image', { src: 'bar.jpg', title: 'bar' } ); - batch.append( modelElement, modelRoot ); + const modelElement = new ModelElement( 'image', { src: 'bar.jpg', title: 'bar' } ); + modelRoot.appendChildren( modelElement ); modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( '
' ); - batch.setAttribute( 'src', 'new.jpg', modelElement ); - batch.removeAttribute( 'title', modelElement ); + modelElement.setAttribute( 'src', 'new.jpg' ); + modelElement.removeAttribute( 'title' ); modelDispatcher.convertAttribute( 'changeAttribute', createRangeOnElementOnly( modelElement ), 'src', 'bar.jpg', 'new.jpg' ); modelDispatcher.convertAttribute( 'removeAttribute', createRangeOnElementOnly( modelElement ), 'title', 'bar', null ); @@ -260,7 +265,7 @@ describe( 'advanced-converters', () => { const modelElement = new ModelElement( 'image', { src: 'foo.jpg', title: 'foo' }, [ new ModelElement( 'caption', {}, new ModelText( 'foobar' ) ) ] ); - modelRoot.appendChildren( modelElement ); + modelRoot.appendChildren( [ modelElement ] ); modelDispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); expect( viewToString( viewRoot ) ).to.equal( @@ -279,7 +284,7 @@ describe( 'advanced-converters', () => { it( 'should convert view image to model', () => { const viewElement = new ViewContainerElement( 'img', { src: 'bar.jpg', title: 'bar' } ); - const modelElement = viewDispatcher.convert( viewElement, batch ); + const modelElement = viewDispatcher.convert( viewElement ); expect( modelToString( modelElement ) ).to.equal( '' ); } ); @@ -293,7 +298,7 @@ describe( 'advanced-converters', () => { new ViewContainerElement( 'figcaption', null, new ViewText( 'foobar' ) ) ] ); - const modelElement = viewDispatcher.convert( viewElement, batch ); + const modelElement = viewDispatcher.convert( viewElement ); expect( modelToString( modelElement ) ).to.equal( 'foobar
' + diff --git a/tests/conversion/buildmodelconverter.js b/tests/conversion/buildmodelconverter.js index 226fc7de6..b20eb22a4 100644 --- a/tests/conversion/buildmodelconverter.js +++ b/tests/conversion/buildmodelconverter.js @@ -5,7 +5,7 @@ import buildModelConverter from '../../src/conversion/buildmodelconverter'; -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; import ModelRange from '../../src/model/range'; @@ -69,14 +69,13 @@ function viewToString( item ) { } describe( 'Model converter builder', () => { - let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, batch; + let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, model; beforeEach( () => { - modelDoc = new ModelDocument(); + model = new Model(); + modelDoc = model.document; modelRoot = modelDoc.createRoot( 'root', 'root' ); - batch = modelDoc.batch(); - viewDoc = new ViewDocument(); viewRoot = viewDoc.createRoot( 'div' ); viewSelection = viewDoc.selection; @@ -84,7 +83,7 @@ describe( 'Model converter builder', () => { mapper = new Mapper(); mapper.bindElements( modelRoot, viewRoot ); - dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); + dispatcher = new ModelConversionDispatcher( model, { mapper, viewSelection } ); dispatcher.on( 'insert:$text', insertText() ); dispatcher.on( 'remove', remove() ); @@ -146,7 +145,7 @@ describe( 'Model converter builder', () => { expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - batch.removeAttribute( 'bold', modelRoot ); + modelRoot.removeAttribute( 'bold' ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null ); @@ -163,7 +162,7 @@ describe( 'Model converter builder', () => { expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - batch.removeAttribute( 'bold', modelRoot ); + modelRoot.removeAttribute( 'bold' ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'bold', true, null ); @@ -180,13 +179,13 @@ describe( 'Model converter builder', () => { expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - batch.setAttribute( 'italic', 'i', modelRoot ); + modelRoot.setAttribute( 'italic', 'i' ); dispatcher.convertAttribute( 'changeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'em', 'i' ); expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - batch.removeAttribute( 'italic', modelRoot ); + modelRoot.removeAttribute( 'italic' ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'italic', 'i', null ); diff --git a/tests/conversion/buildviewconverter.js b/tests/conversion/buildviewconverter.js index a4b90d0dd..9e3362100 100644 --- a/tests/conversion/buildviewconverter.js +++ b/tests/conversion/buildviewconverter.js @@ -5,8 +5,8 @@ import buildViewConverter from '../../src/conversion/buildviewconverter'; +import Model from '../../src/model/model'; import ModelSchema from '../../src/model/schema'; -import ModelDocument from '../../src/model/document'; import ModelDocumentFragment from '../../src/model/documentfragment'; import ModelElement from '../../src/model/element'; import ModelTextProxy from '../../src/model/textproxy'; @@ -64,13 +64,11 @@ const textAttributes = [ undefined, 'linkHref', 'linkTitle', 'bold', 'italic', ' const pAttributes = [ undefined, 'class', 'important', 'theme', 'decorated', 'size' ]; describe( 'View converter builder', () => { - let dispatcher, schema, additionalData, batch; + let dispatcher, schema, additionalData; - const modelDocument = new ModelDocument(); + const model = new Model(); beforeEach( () => { - batch = modelDocument.batch(); - // `additionalData` parameter for `.convert` calls. additionalData = { context: [ '$root' ] }; @@ -93,14 +91,14 @@ describe( 'View converter builder', () => { schema.allow( { name: 'span', attributes: [ 'transformer' ], inside: '$root' } ); schema.allow( { name: 'div', attributes: [ 'class' ], inside: '$root' } ); - dispatcher = new ViewConversionDispatcher( { schema } ); + dispatcher = new ViewConversionDispatcher( model, { schema } ); dispatcher.on( 'text', convertText() ); } ); it( 'should convert from view element to model element', () => { buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); - const conversionResult = dispatcher.convert( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), batch, additionalData ); + const conversionResult = dispatcher.convert( new ViewContainerElement( 'p', null, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -110,7 +108,7 @@ describe( 'View converter builder', () => { .fromElement( 'img' ) .toElement( viewElement => new ModelElement( 'image', { src: viewElement.getAttribute( 'src' ) } ) ); - const conversionResult = dispatcher.convert( new ViewContainerElement( 'img', { src: 'foo.jpg' } ), batch, additionalData ); + const conversionResult = dispatcher.convert( new ViewContainerElement( 'img', { src: 'foo.jpg' } ), additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); } ); @@ -119,7 +117,7 @@ describe( 'View converter builder', () => { buildViewConverter().for( dispatcher ).fromElement( 'strong' ).toAttribute( 'bold', true ); const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), additionalData ); // Have to check root because result is a ModelText. @@ -132,7 +130,7 @@ describe( 'View converter builder', () => { .toAttribute( viewElement => ( { key: 'linkHref', value: viewElement.getAttribute( 'href' ) } ) ); const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ), batch, additionalData + new ViewAttributeElement( 'a', { href: 'foo.html' }, new ViewText( 'foo' ) ), additionalData ); // Have to check root because result is a ModelText. @@ -147,7 +145,7 @@ describe( 'View converter builder', () => { .toAttribute( viewElement => ( { key: 'class', value: viewElement.getAttribute( 'class' ) } ) ); const conversionResult = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); @@ -169,7 +167,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'p', { 'data-type': 'foo' }, new ViewText( 'xyz' ) ) ] ); - const conversionResult = dispatcher.convert( viewStructure, batch, additionalData ); + const conversionResult = dispatcher.convert( viewStructure, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' + @@ -195,7 +193,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'span', { style: 'font-weight:bold; font-size:20px' }, new ViewText( 'ddd' ) ) ] ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '<$text bold="true">aaabbbcccddd' ); } ); @@ -212,7 +210,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); const markerSearch = conversionResult.markers.get( 'search' ); @@ -234,7 +232,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); const markerSearch = conversionResult.markers.get( 'search' ); @@ -260,7 +258,7 @@ describe( 'View converter builder', () => { new ViewText( 'r' ) ] ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); const marker1 = conversionResult.markers.get( 'marker1' ); const marker2 = conversionResult.markers.get( 'marker2' ); @@ -277,7 +275,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'span' ); - const result = dispatcher.convert( element, batch, additionalData ); + const result = dispatcher.convert( element, additionalData ); expect( result ).to.be.instanceof( ModelDocumentFragment ); expect( result.childCount ).to.equal( 0 ); @@ -289,7 +287,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { class: 'search' } ); expect( () => { - dispatcher.convert( element, batch, additionalData ); + dispatcher.convert( element, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -301,7 +299,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { 'data-name': 'search' } ); expect( () => { - dispatcher.convert( element, batch, additionalData ); + dispatcher.convert( element, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -313,7 +311,7 @@ describe( 'View converter builder', () => { const element = new ViewAttributeElement( 'marker', { 'data-name': 'search' } ); expect( () => { - dispatcher.convert( element, batch, additionalData ); + dispatcher.convert( element, additionalData ); } ).to.throw( CKEditorError, /^build-view-converter-invalid-marker/ ); } ); @@ -330,7 +328,7 @@ describe( 'View converter builder', () => { // Not quite megatron. result = dispatcher.convert( - new ViewContainerElement( 'span', { class: 'megatron' }, new ViewText( 'foo' ) ), batch, additionalData + new ViewContainerElement( 'span', { class: 'megatron' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -338,7 +336,6 @@ describe( 'View converter builder', () => { // Almost a megatron. Missing a head. result = dispatcher.convert( new ViewContainerElement( 'span', { class: 'megatron', body: 'megatron', legs: 'megatron' }, new ViewText( 'foo' ) ), - batch, additionalData ); @@ -351,7 +348,6 @@ describe( 'View converter builder', () => { { class: 'megatron', body: 'megatron', legs: 'megatron', head: 'megatron' }, new ViewText( 'foo' ) ), - batch, additionalData ); @@ -364,7 +360,6 @@ describe( 'View converter builder', () => { { class: 'megatron', body: 'megatron', legs: 'megatron', head: 'megatron' }, new ViewText( 'foo' ) ), - batch, additionalData ); @@ -385,7 +380,7 @@ describe( 'View converter builder', () => { new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -395,7 +390,7 @@ describe( 'View converter builder', () => { const viewElement = new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( conversionResult.is( 'documentFragment' ) ).to.be.true; } ); @@ -407,7 +402,7 @@ describe( 'View converter builder', () => { buildViewConverter().for( dispatcher ).fromElement( 'p' ).toElement( 'paragraph' ); const conversionResult = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); // Element converter was fired first even though attribute converter was added first. @@ -423,7 +418,7 @@ describe( 'View converter builder', () => { let result; result = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -433,7 +428,7 @@ describe( 'View converter builder', () => { .toElement( 'customP' ); result = dispatcher.convert( - new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), batch, additionalData + new ViewContainerElement( 'p', { class: 'myClass' }, new ViewText( 'foo' ) ), additionalData ); expect( modelToString( result ) ).to.equal( 'foo' ); @@ -454,7 +449,7 @@ describe( 'View converter builder', () => { .toAttribute( 'size', 'small' ); const viewElement = new ViewContainerElement( 'p', { class: 'decorated small' }, new ViewText( 'foo' ) ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); // P element and it's children got converted by the converter (1) and the converter (1) got fired // because P name was not consumed in converter (2). Converter (3) could consume class="small" because @@ -477,7 +472,7 @@ describe( 'View converter builder', () => { new ViewContainerElement( 'abcd', null, new ViewText( 'foo' ) ) ] ); - const conversionResult = dispatcher.convert( viewStructure, batch, additionalData ); + const conversionResult = dispatcher.convert( viewStructure, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '
foo
' ); } ); @@ -496,7 +491,7 @@ describe( 'View converter builder', () => { ) ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -515,7 +510,7 @@ describe( 'View converter builder', () => { ) ); - const conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + const conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( 'foo' ); } ); @@ -529,11 +524,11 @@ describe( 'View converter builder', () => { } ); const viewElement = new ViewContainerElement( 'p' ); - let conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + let conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); viewElement.setAttribute( 'stop', true ); - conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + conversionResult = dispatcher.convert( viewElement, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); @@ -551,11 +546,11 @@ describe( 'View converter builder', () => { } ); const viewElement = new ViewContainerElement( 'p', { 'data-type': 'foo' } ); - let conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + let conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); viewElement.setAttribute( 'data-type', 'stop' ); - conversionResult = dispatcher.convert( viewElement, batch, additionalData ); + conversionResult = dispatcher.convert( viewElement, additionalData ); expect( modelToString( conversionResult ) ).to.equal( '' ); } ); } ); diff --git a/tests/conversion/model-selection-to-view-converters.js b/tests/conversion/model-selection-to-view-converters.js index 87033c9f4..a5b1bc562 100644 --- a/tests/conversion/model-selection-to-view-converters.js +++ b/tests/conversion/model-selection-to-view-converters.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import ModelElement from '../../src/model/element'; import ModelRange from '../../src/model/range'; import ModelPosition from '../../src/model/position'; @@ -37,14 +37,15 @@ import { stringify as stringifyView } from '../../src/dev-utils/view'; import { setData as setModelData } from '../../src/dev-utils/model'; describe( 'model-selection-to-view-converters', () => { - let dispatcher, mapper, modelDoc, modelRoot, modelSelection, viewDoc, viewRoot, viewSelection, highlightDescriptor; + let dispatcher, mapper, model, modelDoc, modelRoot, modelSelection, viewDoc, viewRoot, viewSelection, highlightDescriptor; beforeEach( () => { - modelDoc = new ModelDocument(); + model = new Model(); + modelDoc = model.document; modelRoot = modelDoc.createRoot(); modelSelection = modelDoc.selection; - modelDoc.schema.allow( { name: '$text', inside: '$root' } ); + model.schema.allow( { name: '$text', inside: '$root' } ); viewDoc = new ViewDocument(); viewRoot = viewDoc.createRoot( 'div' ); @@ -55,7 +56,7 @@ describe( 'model-selection-to-view-converters', () => { highlightDescriptor = { class: 'marker', priority: 1 }; - dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); + dispatcher = new ModelConversionDispatcher( model, { mapper, viewSelection } ); dispatcher.on( 'insert:$text', insertText() ); dispatcher.on( 'addAttribute:bold', wrapItem( new ViewAttributeElement( 'strong' ) ) ); @@ -218,8 +219,8 @@ describe( 'model-selection-to-view-converters', () => { } ); it( 'in attribute and marker', () => { - setModelData( modelDoc, 'fo<$text bold="true">obar' ); - const marker = modelDoc.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); + setModelData( model, 'fo<$text bold="true">obar' ); + const marker = model.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] ); @@ -233,7 +234,7 @@ describe( 'model-selection-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() ); - const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); dispatcher.convertSelection( modelSelection, markers ); // Stringify view and check if it is same as expected. @@ -243,8 +244,8 @@ describe( 'model-selection-to-view-converters', () => { } ); it( 'in attribute and marker - no attribute', () => { - setModelData( modelDoc, 'fo<$text bold="true">obar' ); - const marker = modelDoc.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); + setModelData( model, 'fo<$text bold="true">obar' ); + const marker = model.markers.set( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] ); @@ -260,7 +261,7 @@ describe( 'model-selection-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() ); - const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); dispatcher.convertSelection( modelSelection, markers ); // Stringify view and check if it is same as expected. @@ -273,8 +274,8 @@ describe( 'model-selection-to-view-converters', () => { data => ( { 'class': data.markerName } ) ) ); - setModelData( modelDoc, 'foobar' ); - const marker = modelDoc.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); + setModelData( model, 'foobar' ); + const marker = model.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] ); @@ -285,7 +286,7 @@ describe( 'model-selection-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() ); - const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); dispatcher.convertSelection( modelSelection, markers ); // Stringify view and check if it is same as expected. @@ -297,8 +298,8 @@ describe( 'model-selection-to-view-converters', () => { dispatcher.on( 'addMarker:marker2', highlightText( data => ( { 'class': data.markerName } ) ) ); dispatcher.on( 'selectionMarker:marker2', convertSelectionMarker( data => ( { 'class': data.markerName } ) ) ); - setModelData( modelDoc, 'foobar' ); - const marker = modelDoc.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); + setModelData( model, 'foobar' ); + const marker = model.markers.set( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] ); @@ -309,7 +310,7 @@ describe( 'model-selection-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() ); - const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); dispatcher.convertSelection( modelSelection, markers ); // Stringify view and check if it is same as expected. @@ -322,8 +323,8 @@ describe( 'model-selection-to-view-converters', () => { } ) ); - setModelData( modelDoc, 'foobar' ); - const marker = modelDoc.markers.set( 'marker3', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); + setModelData( model, 'foobar' ); + const marker = model.markers.set( 'marker3', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) ); modelSelection.setRanges( [ new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) ] ); @@ -334,7 +335,7 @@ describe( 'model-selection-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); dispatcher.convertMarker( 'addMarker', marker.name, marker.getRange() ); - const markers = Array.from( modelDoc.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( modelSelection.getFirstPosition() ) ); dispatcher.convertSelection( modelSelection, markers ); // Stringify view and check if it is same as expected. @@ -344,7 +345,7 @@ describe( 'model-selection-to-view-converters', () => { // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements. it( 'selection with attribute before ui element - no non-ui children', () => { - setModelData( modelDoc, '' ); + setModelData( model, '' ); // Add two ui elements to view. viewRoot.appendChildren( [ @@ -365,7 +366,7 @@ describe( 'model-selection-to-view-converters', () => { // #1072. it( 'selection with attribute before ui element - has non-ui children #1', () => { - setModelData( modelDoc, 'x' ); + setModelData( model, 'x' ); modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] ); modelSelection.setAttribute( 'bold', true ); @@ -386,7 +387,7 @@ describe( 'model-selection-to-view-converters', () => { // #1072. it( 'selection with attribute before ui element - has non-ui children #2', () => { - setModelData( modelDoc, '<$text bold="true">xy' ); + setModelData( model, '<$text bold="true">xy' ); modelSelection.setRanges( [ new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) ] ); modelSelection.setAttribute( 'bold', true ); @@ -635,14 +636,14 @@ describe( 'model-selection-to-view-converters', () => { describe( 'table cell selection converter', () => { beforeEach( () => { - modelDoc.schema.registerItem( 'table' ); - modelDoc.schema.registerItem( 'tr' ); - modelDoc.schema.registerItem( 'td' ); + model.schema.registerItem( 'table' ); + model.schema.registerItem( 'tr' ); + model.schema.registerItem( 'td' ); - modelDoc.schema.allow( { name: 'table', inside: '$root' } ); - modelDoc.schema.allow( { name: 'tr', inside: 'table' } ); - modelDoc.schema.allow( { name: 'td', inside: 'tr' } ); - modelDoc.schema.allow( { name: '$text', inside: 'td' } ); + model.schema.allow( { name: 'table', inside: '$root' } ); + model.schema.allow( { name: 'tr', inside: 'table' } ); + model.schema.allow( { name: 'td', inside: 'tr' } ); + model.schema.allow( { name: '$text', inside: 'td' } ); // "Universal" converter to convert table structure. const tableConverter = insertElement( data => new ViewContainerElement( data.item.name ) ); @@ -705,7 +706,7 @@ describe( 'model-selection-to-view-converters', () => { // that are offsets or paths of selection positions in root element. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) { // Parse passed `modelInput` string and set it as current model. - setModelData( modelDoc, modelInput ); + setModelData( model, modelInput ); // Manually set selection ranges using passed `selectionPaths`. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ]; diff --git a/tests/conversion/model-to-view-converters.js b/tests/conversion/model-to-view-converters.js index 449a79044..a65914606 100644 --- a/tests/conversion/model-to-view-converters.js +++ b/tests/conversion/model-to-view-converters.js @@ -3,7 +3,9 @@ * For licensing, see LICENSE.md. */ -import ModelDocument from '../../src/model/document'; +import ModelWriter from '../../src/model/writer'; +import Batch from '../../src/model/batch'; +import Model from '../../src/model/model'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; import ModelRange from '../../src/model/range'; @@ -35,19 +37,21 @@ import { import { createRangeOnElementOnly } from '../../tests/model/_utils/utils'; describe( 'model-to-view-converters', () => { - let dispatcher, modelDoc, modelRoot, mapper, viewRoot, batch; + let dispatcher, model, modelDoc, modelRoot, modelWriter, mapper, viewRoot; beforeEach( () => { - modelDoc = new ModelDocument(); + model = new Model(); + modelDoc = model.document; modelRoot = modelDoc.createRoot(); viewRoot = new ViewContainerElement( 'div' ); - batch = modelDoc.batch(); - mapper = new Mapper(); mapper.bindElements( modelRoot, viewRoot ); - dispatcher = new ModelConversionDispatcher( modelDoc, { mapper } ); + dispatcher = new ModelConversionDispatcher( model, { mapper } ); + + // As an util for modifying model tree. + modelWriter = new ModelWriter( model, new Batch() ); } ); function viewAttributesToString( item ) { @@ -110,7 +114,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'removeMarker:marker', highlightText( highlightDescriptor ) ); dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker', markerRange ); expect( viewToString( viewRoot ) ).to.equal( @@ -138,7 +142,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'removeMarker:marker', highlightText( newDescriptor ), { priority: 'high' } ); dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker', markerRange ); expect( viewToString( viewRoot ) ).to.equal( @@ -163,7 +167,7 @@ describe( 'model-to-view-converters', () => { dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker', markerRange ); expect( viewToString( viewRoot ) ).to.equal( '

foo

bar

' ); @@ -222,7 +226,7 @@ describe( 'model-to-view-converters', () => { } ), { priority: 'high' } ); dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker', markerRange ); expect( viewToString( viewRoot ) ).to.equal( @@ -264,7 +268,7 @@ describe( 'model-to-view-converters', () => { } ), { priority: 'high' } ); dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker', markerRange ); expect( viewToString( viewRoot ) ).to.equal( @@ -310,7 +314,7 @@ describe( 'model-to-view-converters', () => { } ), { priority: 'high' } ); dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker:foo-bar-baz', markerRange ); } ); @@ -320,7 +324,7 @@ describe( 'model-to-view-converters', () => { dispatcher.convertInsertion( markerRange ); - modelDoc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); dispatcher.convertMarker( 'addMarker', 'marker', markerRange ); expect( viewToString( viewRoot ) ).to.equal( '

foo

bar

' ); @@ -538,7 +542,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - batch.removeAttribute( 'bold', modelElement ); + modelWriter.removeAttribute( 'bold', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null ); @@ -565,7 +569,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - batch.removeAttribute( 'style', modelElement ); + modelWriter.removeAttribute( 'style', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'style', 'bold', null ); @@ -595,7 +599,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

xfoox

' ); - batch.setAttribute( 'link', 'http://foobar.com', modelElement ); + modelWriter.setAttribute( 'link', 'http://foobar.com', modelElement ); dispatcher.convertAttribute( 'changeAttribute', @@ -623,7 +627,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

நிலைக்கு

' ); - batch.removeAttribute( 'bold', modelElement ); + modelWriter.removeAttribute( 'bold', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null ); @@ -666,7 +670,7 @@ describe( 'model-to-view-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - batch.removeAttribute( 'bold', modelElement ); + modelWriter.removeAttribute( 'bold', modelElement ); dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelElement ), 'bold', true, null ); @@ -1012,7 +1016,7 @@ describe( 'model-to-view-converters', () => { dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); - batch.remove( ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelDiv, 6 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelDiv, 0 ), @@ -1033,7 +1037,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Remove 'b'. - batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 3 ), @@ -1054,7 +1058,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Remove 'ob'. - batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 2, modelRoot, 4 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 2 ), @@ -1076,7 +1080,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Move after "b". Can be e.g. a part of an unwrap delta (move + remove). - batch.move( + modelWriter.move( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ), ModelPosition.createAt( modelRoot, 'end' ) ); @@ -1104,7 +1108,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); // Remove . - batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 1 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 0 ), @@ -1145,7 +1149,7 @@ describe( 'model-to-view-converters', () => { dispatcher.convertChange( type, changes ); } ); - modelDoc.batch().unwrap( modelWElement ); + modelWriter.unwrap( modelWElement ); expect( viewToString( viewRoot ) ).to.equal( '
' ); @@ -1177,7 +1181,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); - batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 2 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 1 ), @@ -1201,7 +1205,7 @@ describe( 'model-to-view-converters', () => { dispatcher.on( 'remove', remove() ); - batch.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) ); + modelWriter.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 3, modelRoot, 4 ) ); dispatcher.convertRemove( ModelPosition.createFromParentAndOffset( modelRoot, 3 ), diff --git a/tests/conversion/modelconversiondispatcher.js b/tests/conversion/modelconversiondispatcher.js index cd3c3ba24..b7a059eba 100644 --- a/tests/conversion/modelconversiondispatcher.js +++ b/tests/conversion/modelconversiondispatcher.js @@ -4,11 +4,13 @@ */ import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import ModelText from '../../src/model/text'; import ModelElement from '../../src/model/element'; import ModelRange from '../../src/model/range'; import ModelPosition from '../../src/model/position'; +import ModelWriter from '../../src/model/writer'; +import Batch from '../../src/model/batch'; import RemoveOperation from '../../src/model/operation/removeoperation'; import NoOperation from '../../src/model/operation/nooperation'; import RenameOperation from '../../src/model/operation/renameoperation'; @@ -18,20 +20,24 @@ import { wrapInDelta } from '../../tests/model/_utils/utils'; import ViewContainerElement from '../../src/view/containerelement'; describe( 'ModelConversionDispatcher', () => { - let dispatcher, doc, root, gyPos; + let dispatcher, doc, root, gyPos, model, writer; beforeEach( () => { - doc = new ModelDocument(); - dispatcher = new ModelConversionDispatcher( doc ); + model = new Model(); + doc = model.document; + dispatcher = new ModelConversionDispatcher( model ); root = doc.createRoot(); gyPos = new ModelPosition( doc.graveyard, [ 0 ] ); + + // As an util for modifying model tree. + writer = new ModelWriter( model, new Batch() ); } ); describe( 'constructor()', () => { it( 'should create ModelConversionDispatcher with given api', () => { const apiObj = {}; - const dispatcher = new ModelConversionDispatcher( doc, { apiObj } ); + const dispatcher = new ModelConversionDispatcher( model, { apiObj } ); expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj ); } ); @@ -63,7 +69,9 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'insert:image', cbInsertImage ); dispatcher.on( 'addAttribute:key:$text', cbAddAttribute ); - doc.batch().insertText( 'foo', { key: 'value' }, root ); + model.change( writer => { + writer.insertText( 'foo', { key: 'value' }, root ); + } ); expect( cbInsertText.called ).to.be.true; expect( cbAddAttribute.called ).to.be.true; @@ -78,7 +86,7 @@ describe( 'ModelConversionDispatcher', () => { const removeOperation = new RemoveOperation( imagePos, 1, gyPos, 0 ); // Let's apply remove operation so reinsert operation won't break. - doc.applyOperation( wrapInDelta( removeOperation ) ); + model.applyOperation( wrapInDelta( removeOperation ) ); const cbInsertText = sinon.spy(); const cbInsertImage = sinon.spy(); @@ -88,7 +96,7 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'insert:image', cbInsertImage ); dispatcher.on( 'addAttribute:key:image', cbAddAttribute ); - doc.applyOperation( wrapInDelta( removeOperation.getReversed() ) ); + model.applyOperation( wrapInDelta( removeOperation.getReversed() ) ); expect( cbInsertImage.called ).to.be.true; expect( cbAddAttribute.called ).to.be.true; @@ -100,7 +108,9 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'remove', cbRemove ); - doc.batch().remove( image ); + model.change( writer => { + writer.remove( image ); + } ); expect( cbRemove.called ).to.be.true; } ); @@ -112,13 +122,17 @@ describe( 'ModelConversionDispatcher', () => { dispatcher.on( 'addAttribute:key:$text', cbAddText ); dispatcher.on( 'addAttribute:key:image', cbAddImage ); - doc.batch().setAttribute( 'key', 'value', image ); + model.change( writer => { + writer.setAttribute( 'key', 'value', image ); + } ); // Callback for adding attribute on text not called. expect( cbAddText.called ).to.be.false; expect( cbAddImage.calledOnce ).to.be.true; - doc.batch().setAttribute( 'key', 'value', ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ) ); + model.change( writer => { + writer.setAttribute( 'key', 'value', ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ) ); + } ); expect( cbAddText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -128,21 +142,24 @@ describe( 'ModelConversionDispatcher', () => { it( 'should fire changeAttribute callbacks for change attribute change', () => { const cbChangeText = sinon.spy(); const cbChangeImage = sinon.spy(); - const batch = doc.batch(); dispatcher.on( 'changeAttribute:key:$text', cbChangeText ); dispatcher.on( 'changeAttribute:key:image', cbChangeImage ); - batch.setAttribute( 'key', 'value', image ); - batch.setAttribute( 'key', 'newValue', image ); + model.change( writer => { + writer.setAttribute( 'key', 'value', image ); + writer.setAttribute( 'key', 'newValue', image ); + } ); // Callback for adding attribute on text not called. expect( cbChangeText.called ).to.be.false; expect( cbChangeImage.calledOnce ).to.be.true; const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ); - batch.setAttribute( 'key', 'value', range ); - batch.setAttribute( 'key', 'newValue', range ); + model.change( writer => { + writer.setAttribute( 'key', 'value', range ); + writer.setAttribute( 'key', 'newValue', range ); + } ); expect( cbChangeText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -152,21 +169,20 @@ describe( 'ModelConversionDispatcher', () => { it( 'should fire removeAttribute callbacks for remove attribute change', () => { const cbRemoveText = sinon.spy(); const cbRemoveImage = sinon.spy(); - const batch = doc.batch(); dispatcher.on( 'removeAttribute:key:$text', cbRemoveText ); dispatcher.on( 'removeAttribute:key:image', cbRemoveImage ); - batch.setAttribute( 'key', 'value', image ); - batch.removeAttribute( 'key', image ); + writer.setAttribute( 'key', 'value', image ); + writer.removeAttribute( 'key', image ); // Callback for adding attribute on text not called. expect( cbRemoveText.called ).to.be.false; expect( cbRemoveImage.calledOnce ).to.be.true; const range = ModelRange.createFromParentsAndOffsets( root, 3, root, 4 ); - batch.setAttribute( 'key', 'value', range ); - batch.removeAttribute( 'key', range ); + writer.setAttribute( 'key', 'value', range ); + writer.removeAttribute( 'key', range ); expect( cbRemoveText.calledOnce ).to.be.true; // Callback for adding attribute on image not called this time. @@ -187,7 +203,7 @@ describe( 'ModelConversionDispatcher', () => { const gyNode = new ModelElement( 'image' ); doc.graveyard.appendChildren( gyNode ); - doc.batch().setAttribute( 'key', 'value', gyNode ); + writer.setAttribute( 'key', 'value', gyNode ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -199,7 +215,7 @@ describe( 'ModelConversionDispatcher', () => { const gyNode = new ModelElement( 'image' ); doc.graveyard.appendChildren( gyNode ); - doc.batch().remove( gyNode ); + writer.remove( gyNode ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -211,7 +227,7 @@ describe( 'ModelConversionDispatcher', () => { const gyNode = new ModelElement( 'image' ); doc.graveyard.appendChildren( gyNode ); - doc.batch().rename( gyNode, 'p' ); + writer.rename( gyNode, 'p' ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -219,7 +235,7 @@ describe( 'ModelConversionDispatcher', () => { it( 'should not fire any event after NoOperation is applied', () => { sinon.spy( dispatcher, 'fire' ); - doc.applyOperation( wrapInDelta( new NoOperation( 0 ) ) ); + model.applyOperation( wrapInDelta( new NoOperation( 0 ) ) ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -230,7 +246,7 @@ describe( 'ModelConversionDispatcher', () => { root.removeChildren( 0, root.childCount ); root.appendChildren( [ new ModelElement( 'paragraph' ) ] ); - doc.applyOperation( wrapInDelta( new RenameOperation( new ModelPosition( root, [ 0 ] ), 'paragraph', 'paragraph', 0 ) ) ); + model.applyOperation( wrapInDelta( new RenameOperation( new ModelPosition( root, [ 0 ] ), 'paragraph', 'paragraph', 0 ) ) ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -242,7 +258,7 @@ describe( 'ModelConversionDispatcher', () => { root.appendChildren( [ new ModelElement( 'paragraph', { foo: 'bar' } ) ] ); const range = new ModelRange( new ModelPosition( root, [ 0 ] ), new ModelPosition( root, [ 0, 0 ] ) ); - doc.applyOperation( wrapInDelta( new AttributeOperation( range, 'foo', 'bar', 'bar', 0 ) ) ); + model.applyOperation( wrapInDelta( new AttributeOperation( range, 'foo', 'bar', 'bar', 0 ) ) ); expect( dispatcher.fire.called ).to.be.false; } ); @@ -337,7 +353,7 @@ describe( 'ModelConversionDispatcher', () => { root.appendChildren( [ paragraph1, paragraph2 ] ); const markerRange = ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ); - doc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); const insertionRange = ModelRange.createOn( paragraph2 ); dispatcher.convertInsertion( insertionRange ); @@ -356,7 +372,7 @@ describe( 'ModelConversionDispatcher', () => { root.appendChildren( [ paragraph1, paragraph2 ] ); const markerRange = ModelRange.createIn( paragraph2 ); - doc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); const insertionRange = ModelRange.createOn( paragraph2 ); dispatcher.convertInsertion( insertionRange ); @@ -396,7 +412,7 @@ describe( 'ModelConversionDispatcher', () => { }; const markerRange = ModelRange.createFromParentsAndOffsets( root, 0, root, 1 ); - doc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); const insertionRange = ModelRange.createFromParentsAndOffsets( caption, 1, caption, 2 ); dispatcher.convertInsertion( insertionRange ); @@ -432,7 +448,7 @@ describe( 'ModelConversionDispatcher', () => { }; const markerRange = ModelRange.createFromParentsAndOffsets( caption, 0, caption, 3 ); - doc.markers.set( 'marker', markerRange ); + model.markers.set( 'marker', markerRange ); const insertionRange = ModelRange.createFromParentsAndOffsets( caption, 2, caption, 3 ); dispatcher.convertInsertion( insertionRange ); @@ -620,11 +636,9 @@ describe( 'ModelConversionDispatcher', () => { } ); it( 'should prepare correct list of consumable values', () => { - doc.enqueueChanges( () => { - const batch = doc.batch(); - - batch.setAttribute( 'bold', true, ModelRange.createIn( root ) ); - batch.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); + model.enqueueChange( writer => { + writer.setAttribute( 'bold', true, ModelRange.createIn( root ) ); + writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); dispatcher.on( 'selection', ( evt, data, consumable ) => { @@ -639,11 +653,9 @@ describe( 'ModelConversionDispatcher', () => { it( 'should fire attributes events for selection', () => { sinon.spy( dispatcher, 'fire' ); - doc.enqueueChanges( () => { - const batch = doc.batch(); - - batch.setAttribute( 'bold', true, ModelRange.createIn( root ) ); - batch.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); + model.enqueueChange( writer => { + writer.setAttribute( 'bold', true, ModelRange.createIn( root ) ); + writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); dispatcher.convertSelection( doc.selection, [] ); @@ -659,11 +671,9 @@ describe( 'ModelConversionDispatcher', () => { consumable.consume( data.selection, 'selectionAttribute:bold' ); } ); - doc.enqueueChanges( () => { - const batch = doc.batch(); - - batch.setAttribute( 'bold', true, ModelRange.createIn( root ) ); - batch.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); + model.enqueueChange( writer => { + writer.setAttribute( 'bold', true, ModelRange.createIn( root ) ); + writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); dispatcher.convertSelection( doc.selection, [] ); @@ -672,11 +682,11 @@ describe( 'ModelConversionDispatcher', () => { } ); it( 'should fire events for each marker which contains selection', () => { - doc.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) ); + model.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) ); sinon.spy( dispatcher, 'fire' ); - const markers = Array.from( doc.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); dispatcher.convertSelection( doc.selection, markers ); expect( dispatcher.fire.calledWith( 'selectionMarker:name' ) ).to.be.true; @@ -710,12 +720,12 @@ describe( 'ModelConversionDispatcher', () => { } }; - doc.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 1 ) ); + model.markers.set( 'name', ModelRange.createFromParentsAndOffsets( root, 0, root, 1 ) ); doc.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( caption, 1, caption, 1 ) ] ); sinon.spy( dispatcher, 'fire' ); - const markers = Array.from( doc.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); dispatcher.convertSelection( doc.selection, markers ); @@ -723,8 +733,8 @@ describe( 'ModelConversionDispatcher', () => { } ); it( 'should not fire events if information about marker has been consumed', () => { - doc.markers.set( 'foo', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) ); - doc.markers.set( 'bar', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) ); + model.markers.set( 'foo', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) ); + model.markers.set( 'bar', ModelRange.createFromParentsAndOffsets( root, 0, root, 2 ) ); sinon.spy( dispatcher, 'fire' ); @@ -732,7 +742,7 @@ describe( 'ModelConversionDispatcher', () => { consumable.consume( data.selection, 'selectionMarker:bar' ); } ); - const markers = Array.from( doc.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); + const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); dispatcher.convertSelection( doc.selection, markers ); expect( dispatcher.fire.calledWith( 'selectionMarker:foo' ) ).to.be.true; diff --git a/tests/conversion/view-selection-to-model-converters.js b/tests/conversion/view-selection-to-model-converters.js index a2601e87f..5751912f0 100644 --- a/tests/conversion/view-selection-to-model-converters.js +++ b/tests/conversion/view-selection-to-model-converters.js @@ -7,7 +7,7 @@ import ViewDocument from '../../src/view/document'; import ViewSelection from '../../src/view/selection'; import ViewRange from '../../src/view/range'; -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import Mapper from '../../src/conversion/mapper'; import { convertSelectionChange } from '../../src/conversion/view-selection-to-model-converters'; @@ -19,8 +19,8 @@ describe( 'convertSelectionChange', () => { let model, view, mapper, convertSelection, modelRoot, viewRoot; beforeEach( () => { - model = new ModelDocument(); - modelRoot = model.createRoot(); + model = new Model(); + modelRoot = model.document.createRoot(); model.schema.registerItem( 'paragraph', '$block' ); modelSetData( model, 'foobar' ); @@ -82,7 +82,7 @@ describe( 'convertSelectionChange', () => { expect( modelGetData( model ) ).to.equal( 'f[o]ob[a]r' ); - const ranges = Array.from( model.selection.getRanges() ); + const ranges = Array.from( model.document.selection.getRanges() ); expect( ranges.length ).to.equal( 2 ); expect( ranges[ 0 ].start.parent ).to.equal( modelRoot.getChild( 0 ) ); @@ -106,7 +106,7 @@ describe( 'convertSelectionChange', () => { convertSelection( null, { newSelection: viewSelection } ); expect( modelGetData( model ) ).to.equal( 'f[o]ob[a]r' ); - expect( model.selection.isBackward ).to.true; + expect( model.document.selection.isBackward ).to.true; } ); it( 'should not enqueue changes if selection has not changed', () => { diff --git a/tests/conversion/view-to-model-converters.js b/tests/conversion/view-to-model-converters.js index 550946ee8..4dcddd894 100644 --- a/tests/conversion/view-to-model-converters.js +++ b/tests/conversion/view-to-model-converters.js @@ -8,8 +8,8 @@ import ViewContainerElement from '../../src/view/containerelement'; import ViewDocumentFragment from '../../src/view/documentfragment'; import ViewText from '../../src/view/text'; +import Model from '../../src/model/model'; import ModelSchema from '../../src/model/schema'; -import ModelDocument from '../../src/model/document'; import ModelDocumentFragment from '../../src/model/documentfragment'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; @@ -17,17 +17,16 @@ import ModelText from '../../src/model/text'; import { convertToModelFragment, convertText } from '../../src/conversion/view-to-model-converters'; describe( 'view-to-model-converters', () => { - let dispatcher, schema, additionalData, batch; + let dispatcher, schema, additionalData; - const modelDocument = new ModelDocument(); + const model = new Model(); beforeEach( () => { schema = new ModelSchema(); schema.registerItem( 'paragraph', '$block' ); schema.allow( { name: '$text', inside: '$root' } ); - batch = modelDocument.batch(); additionalData = { context: [ '$root' ] }; - dispatcher = new ViewConversionDispatcher( { schema } ); + dispatcher = new ViewConversionDispatcher( model, { schema } ); } ); describe( 'convertText', () => { @@ -36,7 +35,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, batch, additionalData ); + const conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -55,7 +54,7 @@ describe( 'view-to-model-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewText, batch, additionalData ); + const conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -68,12 +67,12 @@ describe( 'view-to-model-converters', () => { const viewText = new ViewText( 'foobar' ); dispatcher.on( 'text', convertText() ); - let conversionResult = dispatcher.convert( viewText, batch, additionalData ); + let conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); - conversionResult = dispatcher.convert( viewText, batch, { context: [ '$block' ] } ); + conversionResult = dispatcher.convert( viewText, { context: [ '$block' ] } ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 1 ); @@ -86,7 +85,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, batch, additionalData ); + const conversionResult = dispatcher.convert( viewText, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -107,7 +106,7 @@ describe( 'view-to-model-converters', () => { dispatcher.on( 'element', convertToModelFragment() ); dispatcher.on( 'documentFragment', convertToModelFragment() ); - const conversionResult = dispatcher.convert( viewFragment, batch, additionalData ); + const conversionResult = dispatcher.convert( viewFragment, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.maxOffset ).to.equal( 6 ); @@ -132,7 +131,7 @@ describe( 'view-to-model-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewP, batch, additionalData ); + const conversionResult = dispatcher.convert( viewP, additionalData ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelElement ); diff --git a/tests/conversion/viewconversiondispatcher.js b/tests/conversion/viewconversiondispatcher.js index 7a5d8f06a..bc8ed7753 100644 --- a/tests/conversion/viewconversiondispatcher.js +++ b/tests/conversion/viewconversiondispatcher.js @@ -8,10 +8,10 @@ import ViewContainerElement from '../../src/view/containerelement'; import ViewDocumentFragment from '../../src/view/documentfragment'; import ViewText from '../../src/view/text'; +import Model from '../../src/model/model'; import ModelText from '../../src/model/text'; import ModelElement from '../../src/model/element'; import ModelDocumentFragment from '../../src/model/documentfragment'; -import ModelDocument from '../../src/model/document'; import { stringify } from '../../src/dev-utils/model'; import log from '@ckeditor/ckeditor5-utils/src/log'; @@ -20,15 +20,19 @@ import log from '@ckeditor/ckeditor5-utils/src/log'; const logWarn = log.warn; describe( 'ViewConversionDispatcher', () => { + let model; + afterEach( () => { + model = new Model(); log.warn = logWarn; } ); describe( 'constructor()', () => { it( 'should create ViewConversionDispatcher with passed api', () => { const apiObj = {}; - const dispatcher = new ViewConversionDispatcher( { apiObj } ); + const dispatcher = new ViewConversionDispatcher( model, { apiObj } ); + expect( dispatcher.model ).to.equal( model ); expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj ); expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function ); expect( dispatcher.conversionApi ).to.have.property( 'convertChildren' ).that.is.instanceof( Function ); @@ -36,13 +40,10 @@ describe( 'ViewConversionDispatcher', () => { } ); describe( 'convert', () => { - let dispatcher, batch; - - const modelDocument = new ModelDocument(); + let dispatcher; beforeEach( () => { - dispatcher = new ViewConversionDispatcher(); - batch = modelDocument.batch(); + dispatcher = new ViewConversionDispatcher( model ); } ); it( 'should fire viewCleanup event on converted view part', () => { @@ -51,7 +52,7 @@ describe( 'ViewConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); const viewP = new ViewContainerElement( 'p' ); - dispatcher.convert( viewP, batch ); + dispatcher.convert( viewP ); expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true; } ); @@ -65,9 +66,9 @@ describe( 'ViewConversionDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convert( viewText, batch ); - dispatcher.convert( viewElement, batch ); - dispatcher.convert( viewFragment, batch ); + dispatcher.convert( viewText ); + dispatcher.convert( viewElement ); + dispatcher.convert( viewFragment ); expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true; expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true; @@ -99,7 +100,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewText, batch, { foo: 'bar' } ); + const conversionResult = dispatcher.convert( viewText, { foo: 'bar' } ); // Check conversion result. // Result should be wrapped in document fragment. @@ -134,7 +135,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewElement, batch, { foo: 'bar' } ); + const conversionResult = dispatcher.convert( viewElement, { foo: 'bar' } ); // Check conversion result. // Result should be wrapped in document fragment. @@ -168,7 +169,7 @@ describe( 'ViewConversionDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewFragment, batch, { foo: 'bar' } ); + const conversionResult = dispatcher.convert( viewFragment, { foo: 'bar' } ); // Check conversion result. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); @@ -191,7 +192,7 @@ describe( 'ViewConversionDispatcher', () => { ] ); } ); - const conversionResult = dispatcher.convert( viewFragment, batch ); + const conversionResult = dispatcher.convert( viewFragment ); expect( conversionResult.markers.size ).to.equal( 2 ); expect( stringify( conversionResult, conversionResult.markers.get( 'marker1' ) ) ).to.deep.equal( 'fo[ob]ar' ); @@ -201,13 +202,9 @@ describe( 'ViewConversionDispatcher', () => { describe( 'conversionApi', () => { let spy, spyP, spyText, viewP, viewText, modelP, modelText, consumableMock, dispatcher, - spyNull, spyArray, viewDiv, viewNull, viewArray, batch; - - const modelDocument = new ModelDocument(); + spyNull, spyArray, viewDiv, viewNull, viewArray; beforeEach( () => { - batch = modelDocument.batch(); - spy = sinon.spy(); spyP = sinon.spy(); spyText = sinon.spy(); @@ -219,7 +216,7 @@ describe( 'ViewConversionDispatcher', () => { consumableMock = {}; - dispatcher = new ViewConversionDispatcher(); + dispatcher = new ViewConversionDispatcher( model ); dispatcher.on( 'element:p', ( evt, data, consumable ) => { spyP(); @@ -268,10 +265,9 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewP, consumableMock, data ) ).to.equal( modelP ); expect( conversionApi.convertItem( viewText, consumableMock, data ) ).to.equal( modelText ); - expect( conversionApi.batch ).to.equal( batch ); } ); - dispatcher.convert( new ViewDocumentFragment(), batch, { foo: 'bar' } ); + dispatcher.convert( new ViewDocumentFragment(), { foo: 'bar' } ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -288,7 +284,7 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewNull ) ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment(), batch ); + dispatcher.convert( new ViewDocumentFragment() ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; @@ -306,7 +302,7 @@ describe( 'ViewConversionDispatcher', () => { expect( conversionApi.convertItem( viewArray ) ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment(), batch ); + dispatcher.convert( new ViewDocumentFragment() ); expect( spy.calledOnce ).to.be.true; expect( spyArray.calledOnce ).to.be.true; @@ -332,7 +328,7 @@ describe( 'ViewConversionDispatcher', () => { expect( result.getChild( 1 ) ).to.equal( modelText ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), batch, { foo: 'bar' } ); + dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), { foo: 'bar' } ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -353,7 +349,7 @@ describe( 'ViewConversionDispatcher', () => { expect( result.getChild( 1 ) ).to.equal( modelText ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), batch, { foo: 'bar' } ); + dispatcher.convert( new ViewDocumentFragment( [ viewArray, viewP, viewDiv, viewText, viewNull ] ), { foo: 'bar' } ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; From cf2c9a8a0346ec3e9cf5e22dc1ef6d6d2241c1c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 7 Dec 2017 16:11:51 +0100 Subject: [PATCH 119/724] Fixed failing DataController tests. --- tests/controller/datacontroller.js | 220 ++++++++++++++++------------- 1 file changed, 122 insertions(+), 98 deletions(-) diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index e15efaf24..18d428abe 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import DataController from '../../src/controller/datacontroller'; import HtmlDataProcessor from '../../src/dataprocessor/htmldataprocessor'; @@ -23,35 +23,36 @@ import { parse as parseView } from '../../src/dev-utils/view'; import count from '@ckeditor/ckeditor5-utils/src/count'; describe( 'DataController', () => { - let modelDocument, htmlDataProcessor, data, schema; + let model, modelDocument, htmlDataProcessor, data, schema; beforeEach( () => { - modelDocument = new ModelDocument(); + model = new Model(); + modelDocument = model.document; modelDocument.createRoot(); modelDocument.createRoot( '$root', 'title' ); htmlDataProcessor = new HtmlDataProcessor(); - data = new DataController( modelDocument, htmlDataProcessor ); + data = new DataController( model, htmlDataProcessor ); - schema = modelDocument.schema; + schema = model.schema; } ); describe( 'constructor()', () => { it( 'works without data processor', () => { - const data = new DataController( modelDocument ); + const data = new DataController( model ); expect( data.processor ).to.be.undefined; } ); } ); - describe( 'parse', () => { + describe( 'parse()', () => { it( 'should set text', () => { schema.allow( { name: '$text', inside: '$root' } ); - const model = data.parse( '

foobar

', modelDocument.batch() ); + const output = data.parse( '

foobar

' ); - expect( model ).to.instanceof( ModelDocumentFragment ); - expect( stringify( model ) ).to.equal( 'foobar' ); + expect( output ).to.instanceof( ModelDocumentFragment ); + expect( stringify( output ) ).to.equal( 'foobar' ); } ); it( 'should set paragraph', () => { @@ -59,10 +60,10 @@ describe( 'DataController', () => { buildViewConverter().for( data.viewToModel ).fromElement( 'p' ).toElement( 'paragraph' ); - const model = data.parse( '

foobar

', modelDocument.batch() ); + const output = data.parse( '

foobar

' ); - expect( model ).to.instanceof( ModelDocumentFragment ); - expect( stringify( model ) ).to.equal( 'foobar' ); + expect( output ).to.instanceof( ModelDocumentFragment ); + expect( stringify( output ) ).to.equal( 'foobar' ); } ); it( 'should set two paragraphs', () => { @@ -70,10 +71,10 @@ describe( 'DataController', () => { buildViewConverter().for( data.viewToModel ).fromElement( 'p' ).toElement( 'paragraph' ); - const model = data.parse( '

foo

bar

', modelDocument.batch() ); + const output = data.parse( '

foo

bar

' ); - expect( model ).to.instanceof( ModelDocumentFragment ); - expect( stringify( model ) ).to.equal( 'foobar' ); + expect( output ).to.instanceof( ModelDocumentFragment ); + expect( stringify( output ) ).to.equal( 'foobar' ); } ); it( 'should set paragraphs with bold', () => { @@ -83,26 +84,26 @@ describe( 'DataController', () => { buildViewConverter().for( data.viewToModel ).fromElement( 'p' ).toElement( 'paragraph' ); buildViewConverter().for( data.viewToModel ).fromElement( 'b' ).toAttribute( 'bold', true ); - const model = data.parse( '

foobar

', modelDocument.batch() ); + const output = data.parse( '

foobar

' ); - expect( model ).to.instanceof( ModelDocumentFragment ); - expect( stringify( model ) ).to.equal( 'foo<$text bold="true">bar' ); + expect( output ).to.instanceof( ModelDocumentFragment ); + expect( stringify( output ) ).to.equal( 'foo<$text bold="true">bar' ); } ); it( 'should parse in the root context by default', () => { - const model = data.parse( 'foo', modelDocument.batch() ); + const output = data.parse( 'foo' ); - expect( stringify( model ) ).to.equal( '' ); + expect( stringify( output ) ).to.equal( '' ); } ); it( 'should accept parsing context', () => { - const model = data.parse( 'foo', modelDocument.batch(), '$block' ); + const output = data.parse( 'foo', '$block' ); - expect( stringify( model ) ).to.equal( 'foo' ); + expect( stringify( output ) ).to.equal( 'foo' ); } ); } ); - describe( 'toModel', () => { + describe( 'toModel()', () => { beforeEach( () => { schema.registerItem( 'paragraph', '$block' ); @@ -111,18 +112,18 @@ describe( 'DataController', () => { it( 'should convert content of an element #1', () => { const viewElement = parseView( '

foo

' ); - const model = data.toModel( viewElement, modelDocument.batch() ); + const output = data.toModel( viewElement ); - expect( model ).to.instanceof( ModelDocumentFragment ); - expect( stringify( model ) ).to.equal( 'foo' ); + expect( output ).to.instanceof( ModelDocumentFragment ); + expect( stringify( output ) ).to.equal( 'foo' ); } ); it( 'should convert content of an element #2', () => { const viewFragment = parseView( '

foo

bar

' ); - const model = data.toModel( viewFragment, modelDocument.batch() ); + const output = data.toModel( viewFragment ); - expect( model ).to.be.instanceOf( ModelDocumentFragment ); - expect( stringify( model ) ).to.equal( 'foobar' ); + expect( output ).to.be.instanceOf( ModelDocumentFragment ); + expect( stringify( output ) ).to.equal( 'foobar' ); } ); it( 'should accept parsing context', () => { @@ -134,19 +135,19 @@ describe( 'DataController', () => { const viewFragment = new ViewDocumentFragment( [ parseView( 'foo' ) ] ); // Model fragment in root. - expect( stringify( data.toModel( viewFragment, modelDocument.batch() ) ) ).to.equal( '' ); + expect( stringify( data.toModel( viewFragment ) ) ).to.equal( '' ); // Model fragment in inline root. - expect( stringify( data.toModel( viewFragment, modelDocument.batch(), 'inlineRoot' ) ) ).to.equal( 'foo' ); + expect( stringify( data.toModel( viewFragment, 'inlineRoot' ) ) ).to.equal( 'foo' ); } ); } ); - describe( 'set', () => { + describe( 'set()', () => { it( 'should set data to root', () => { schema.allow( { name: '$text', inside: '$root' } ); data.set( 'foo' ); - expect( getData( modelDocument, { withoutSelection: true } ) ).to.equal( 'foo' ); + expect( getData( model, { withoutSelection: true } ) ).to.equal( 'foo' ); } ); it( 'should create a batch', () => { @@ -172,8 +173,8 @@ describe( 'DataController', () => { data.set( 'foo', 'main' ); data.set( 'Bar', 'title' ); - expect( getData( modelDocument, { withoutSelection: true, rootName: 'main' } ) ).to.equal( 'foo' ); - expect( getData( modelDocument, { withoutSelection: true, rootName: 'title' } ) ).to.equal( 'Bar' ); + expect( getData( model, { withoutSelection: true, rootName: 'main' } ) ).to.equal( 'foo' ); + expect( getData( model, { withoutSelection: true, rootName: 'title' } ) ).to.equal( 'Bar' ); expect( count( modelDocument.history.getDeltas() ) ).to.equal( 2 ); } ); @@ -185,18 +186,18 @@ describe( 'DataController', () => { data.set( 'foo', 'title' ); - expect( getData( modelDocument, { withoutSelection: true, rootName: 'title' } ) ).to.equal( 'foo' ); + expect( getData( model, { withoutSelection: true, rootName: 'title' } ) ).to.equal( 'foo' ); data.set( '', 'title' ); - expect( getData( modelDocument, { withoutSelection: true, rootName: 'title' } ) ).to.equal( '' ); + expect( getData( model, { withoutSelection: true, rootName: 'title' } ) ).to.equal( '' ); } ); } ); - describe( 'get', () => { + describe( 'get()', () => { it( 'should get paragraph with text', () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'foo' ); + schema.registerItem( 'paragraph', '$block' ); + setData( model, 'foo' ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); @@ -204,8 +205,8 @@ describe( 'DataController', () => { } ); it( 'should get empty paragraph', () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, '' ); + schema.registerItem( 'paragraph', '$block' ); + setData( model, '' ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); @@ -213,8 +214,8 @@ describe( 'DataController', () => { } ); it( 'should get two paragraphs', () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'foobar' ); + schema.registerItem( 'paragraph', '$block' ); + setData( model, 'foobar' ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); @@ -222,15 +223,15 @@ describe( 'DataController', () => { } ); it( 'should get text directly in root', () => { - modelDocument.schema.allow( { name: '$text', inside: '$root' } ); - setData( modelDocument, 'foo' ); + schema.allow( { name: '$text', inside: '$root' } ); + setData( model, 'foo' ); expect( data.get() ).to.equal( 'foo' ); } ); it( 'should get paragraphs without bold', () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'foo<$text bold="true">bar' ); + schema.registerItem( 'paragraph', '$block' ); + setData( model, 'foo<$text bold="true">bar' ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); @@ -238,8 +239,8 @@ describe( 'DataController', () => { } ); it( 'should get paragraphs with bold', () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'foo<$text bold="true">bar' ); + schema.registerItem( 'paragraph', '$block' ); + setData( model, 'foo<$text bold="true">bar' ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); buildModelConverter().for( data.modelToView ).fromAttribute( 'bold' ).toElement( 'b' ); @@ -248,11 +249,11 @@ describe( 'DataController', () => { } ); it( 'should get root name as a parameter', () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - modelDocument.schema.allow( { name: '$text', inside: '$root' } ); + schema.registerItem( 'paragraph', '$block' ); + schema.allow( { name: '$text', inside: '$root' } ); - setData( modelDocument, 'foo', { rootName: 'main' } ); - setData( modelDocument, 'Bar', { rootName: 'title' } ); + setData( model, 'foo', { rootName: 'main' } ); + setData( model, 'Bar', { rootName: 'title' } ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); buildModelConverter().for( data.modelToView ).fromAttribute( 'bold' ).toElement( 'b' ); @@ -263,47 +264,43 @@ describe( 'DataController', () => { } ); } ); - describe( 'stringify', () => { - let batch; - + describe( 'stringify()', () => { beforeEach( () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - modelDocument.schema.registerItem( 'div' ); + schema.registerItem( 'paragraph', '$block' ); + schema.registerItem( 'div' ); - modelDocument.schema.allow( { name: '$block', inside: 'div' } ); - modelDocument.schema.allow( { name: 'div', inside: '$root' } ); + schema.allow( { name: '$block', inside: 'div' } ); + schema.allow( { name: 'div', inside: '$root' } ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); - - batch = modelDocument.batch(); } ); it( 'should stringify a content of an element', () => { - const modelElement = parseModel( '
foo
', modelDocument.schema, batch ); + const modelElement = parseModel( '
foo
', schema ); expect( data.stringify( modelElement ) ).to.equal( '

foo

' ); } ); it( 'should stringify a content of a document fragment', () => { - const modelDocumentFragment = parseModel( 'foobar', modelDocument.schema, batch ); + const modelDocumentFragment = parseModel( 'foobar', schema ); expect( data.stringify( modelDocumentFragment ) ).to.equal( '

foo

bar

' ); } ); } ); - describe( 'toView', () => { + describe( 'toView()', () => { beforeEach( () => { - modelDocument.schema.registerItem( 'paragraph', '$block' ); - modelDocument.schema.registerItem( 'div' ); + schema.registerItem( 'paragraph', '$block' ); + schema.registerItem( 'div' ); - modelDocument.schema.allow( { name: '$block', inside: 'div' } ); - modelDocument.schema.allow( { name: 'div', inside: '$root' } ); + schema.allow( { name: '$block', inside: 'div' } ); + schema.allow( { name: 'div', inside: '$root' } ); buildModelConverter().for( data.modelToView ).fromElement( 'paragraph' ).toElement( 'p' ); } ); it( 'should convert a content of an element', () => { - const modelElement = parseModel( '
foo
', modelDocument.schema, modelDocument.batch() ); + const modelElement = parseModel( '
foo
', schema ); const viewDocumentFragment = data.toView( modelElement ); @@ -317,12 +314,7 @@ describe( 'DataController', () => { } ); it( 'should convert a document fragment', () => { - const modelDocumentFragment = parseModel( - 'foobar', - modelDocument.schema, - modelDocument.batch() - ); - + const modelDocumentFragment = parseModel( 'foobar', schema ); const viewDocumentFragment = data.toView( modelDocumentFragment ); expect( viewDocumentFragment ).to.be.instanceOf( ViewDocumentFragment ); @@ -336,7 +328,7 @@ describe( 'DataController', () => { } ); } ); - describe( 'destroy', () => { + describe( 'destroy()', () => { it( 'should be there for you', () => { // Should not throw. data.destroy(); @@ -345,7 +337,7 @@ describe( 'DataController', () => { } ); } ); - describe( 'insertContent', () => { + describe( 'insertContent()', () => { it( 'should be decorated', () => { schema.allow( { name: '$text', inside: '$root' } ); // To surpress warnings. @@ -361,25 +353,35 @@ describe( 'DataController', () => { it( 'should insert content (item)', () => { schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'fo[]ar' ); + setData( model, 'fo[]ar' ); data.insertContent( new ModelText( 'ob' ), modelDocument.selection ); - expect( getData( modelDocument ) ).to.equal( 'foob[]ar' ); + expect( getData( model ) ).to.equal( 'foob[]ar' ); } ); it( 'should insert content (document fragment)', () => { schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'fo[]ar' ); + setData( model, 'fo[]ar' ); data.insertContent( new ModelDocumentFragment( [ new ModelText( 'ob' ) ] ), modelDocument.selection ); - expect( getData( modelDocument ) ).to.equal( 'foob[]ar' ); + expect( getData( model ) ).to.equal( 'foob[]ar' ); + } ); + + it( 'should use parent batch', () => { + schema.registerItem( 'paragraph', '$block' ); + setData( model, '[]' ); + + model.change( writer => { + data.insertContent( new ModelText( 'abc' ), modelDocument.selection ); + expect( writer.batch.deltas ).to.length( 1 ); + } ); } ); } ); - describe( 'deleteContent', () => { + describe( 'deleteContent()', () => { it( 'should be decorated', () => { const spy = sinon.spy(); @@ -393,18 +395,29 @@ describe( 'DataController', () => { it( 'should delete selected content', () => { schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'fo[ob]ar' ); + setData( model, 'fo[ob]ar' ); - data.deleteContent( modelDocument.selection, modelDocument.batch() ); + data.deleteContent( modelDocument.selection ); - expect( getData( modelDocument ) ).to.equal( 'fo[]ar' ); + expect( getData( model ) ).to.equal( 'fo[]ar' ); + } ); + + it( 'should use parent batch', () => { + schema.registerItem( 'paragraph', '$block' ); + + setData( model, 'fo[ob]ar' ); + + model.change( writer => { + data.deleteContent( modelDocument.selection ); + expect( writer.batch.deltas ).to.length( 1 ); + } ); } ); } ); - describe( 'modifySelection', () => { + describe( 'modifySelection()', () => { it( 'should be decorated', () => { schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'fo[ob]ar' ); + setData( model, 'fo[ob]ar' ); const spy = sinon.spy(); @@ -418,22 +431,22 @@ describe( 'DataController', () => { it( 'should modify a selection', () => { schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'fo[ob]ar' ); + setData( model, 'fo[ob]ar' ); data.modifySelection( modelDocument.selection, { direction: 'backward' } ); - expect( getData( modelDocument ) ).to.equal( 'fo[o]bar' ); + expect( getData( model ) ).to.equal( 'fo[o]bar' ); } ); } ); - describe( 'getSelectedContent', () => { + describe( 'getSelectedContent()', () => { it( 'should be decorated', () => { const spy = sinon.spy(); const sel = new ModelSelection(); data.on( 'getSelectedContent', spy ); - data.getSelectedContent( sel, modelDocument.batch() ); + data.getSelectedContent( sel ); expect( spy.calledOnce ).to.be.true; } ); @@ -441,15 +454,26 @@ describe( 'DataController', () => { it( 'should return selected content', () => { schema.registerItem( 'paragraph', '$block' ); - setData( modelDocument, 'fo[ob]ar' ); + setData( model, 'fo[ob]ar' ); - const content = data.getSelectedContent( modelDocument.selection, modelDocument.batch() ); + const content = data.getSelectedContent( modelDocument.selection ); expect( stringify( content ) ).to.equal( 'ob' ); } ); + + it( 'should use parent batch', () => { + schema.registerItem( 'paragraph', '$block' ); + + setData( model, 'fo[ob]ar' ); + + model.change( writer => { + data.getSelectedContent( modelDocument.selection ); + expect( writer.batch.deltas ).to.length( 1 ); + } ); + } ); } ); - describe( 'hasContent', () => { + describe( 'hasContent()', () => { let root; beforeEach( () => { @@ -461,7 +485,7 @@ describe( 'DataController', () => { schema.objects.add( 'image' ); setData( - modelDocument, + model, '
' + '' + From 92cdaabc1a89ad7d56f6168aff280f22ff4e335a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 8 Dec 2017 08:27:04 +0100 Subject: [PATCH 120/724] Fixed failing EditingController tests. --- tests/controller/editingcontroller.js | 83 +++++++++++++-------------- 1 file changed, 40 insertions(+), 43 deletions(-) diff --git a/tests/controller/editingcontroller.js b/tests/controller/editingcontroller.js index 0cd160e5e..cad628f25 100644 --- a/tests/controller/editingcontroller.js +++ b/tests/controller/editingcontroller.js @@ -15,7 +15,7 @@ import Mapper from '../../src/conversion/mapper'; import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; import buildModelConverter from '../../src/conversion/buildmodelconverter'; -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import ModelPosition from '../../src/model/position'; import ModelElement from '../../src/model/element'; import ModelText from '../../src/model/text'; @@ -32,7 +32,7 @@ describe( 'EditingController', () => { let model, editing; beforeEach( () => { - model = new ModelDocument(); + model = new Model(); editing = new EditingController( model ); } ); @@ -63,9 +63,9 @@ describe( 'EditingController', () => { let model, modelRoot, editing; beforeEach( () => { - model = new ModelDocument(); - modelRoot = model.createRoot(); - model.createRoot( '$root', 'header' ); + model = new Model(); + modelRoot = model.document.createRoot(); + model.document.createRoot( '$root', 'header' ); editing = new EditingController( model ); } ); @@ -101,8 +101,8 @@ describe( 'EditingController', () => { expect( editing.view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domRoot ); expect( editing.view.renderer.markedChildren.has( viewRoot ) ).to.be.true; - expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.getRoot( 'header' ) ); - expect( editing.mapper.toViewElement( model.getRoot( 'header' ) ) ).to.equal( viewRoot ); + expect( editing.mapper.toModelElement( viewRoot ) ).to.equal( model.document.getRoot( 'header' ) ); + expect( editing.mapper.toViewElement( model.document.getRoot( 'header' ) ) ).to.equal( viewRoot ); } ); it( 'should be possible to attach DOM element later', () => { @@ -131,8 +131,8 @@ describe( 'EditingController', () => { beforeEach( () => { listener = Object.create( EmitterMixin ); - model = new ModelDocument(); - modelRoot = model.createRoot(); + model = new Model(); + modelRoot = model.document.createRoot(); editing = new EditingController( model ); @@ -146,7 +146,7 @@ describe( 'EditingController', () => { buildModelConverter().for( editing.modelToView ).fromElement( 'div' ).toElement( 'div' ); // Note: The below code is highly overcomplicated due to #455. - model.selection.removeAllRanges(); + model.document.selection.removeAllRanges(); modelRoot.removeChildren( 0, modelRoot.childCount ); viewRoot.removeChildren( 0, viewRoot.childCount ); @@ -155,13 +155,12 @@ describe( 'EditingController', () => { 'foo' + '' + 'bar', - model.schema, - model.batch() + model.schema )._children ); - model.enqueueChanges( () => { - model.batch().insert( modelData, model.getRoot() ); - model.selection.addRange( ModelRange.createFromParentsAndOffsets( + model.enqueueChange( writer => { + writer.insert( modelData, model.document.getRoot() ); + model.document.selection.addRange( ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) ); } ); } ); @@ -179,9 +178,9 @@ describe( 'EditingController', () => { it( 'should convert split', () => { expect( getViewData( editing.view ) ).to.equal( '

f{}oo

bar

' ); - model.enqueueChanges( () => { - model.batch().split( model.selection.getFirstPosition() ); - model.selection.setRanges( [ + model.enqueueChange( writer => { + writer.split( model.document.selection.getFirstPosition() ); + model.document.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 1 ), 0, modelRoot.getChild( 1 ), 0 ) ] ); } ); @@ -192,19 +191,19 @@ describe( 'EditingController', () => { it( 'should convert rename', () => { expect( getViewData( editing.view ) ).to.equal( '

f{}oo

bar

' ); - model.enqueueChanges( () => { - model.batch().rename( modelRoot.getChild( 0 ), 'div' ); + model.enqueueChange( writer => { + writer.rename( modelRoot.getChild( 0 ), 'div' ); } ); expect( getViewData( editing.view ) ).to.equal( '
f{}oo

bar

' ); } ); it( 'should convert delete', () => { - model.enqueueChanges( () => { - model.batch().remove( - ModelRange.createFromPositionAndShift( model.selection.getFirstPosition(), 1 ) + model.enqueueChange( writer => { + writer.remove( + ModelRange.createFromPositionAndShift( model.document.selection.getFirstPosition(), 1 ) ); - model.selection.setRanges( [ + model.document.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 0 ), 1, modelRoot.getChild( 0 ), 1 ) ] ); } ); @@ -235,8 +234,8 @@ describe( 'EditingController', () => { } ); it( 'should convert collapsed selection', () => { - model.enqueueChanges( () => { - model.selection.setRanges( [ + model.enqueueChange( () => { + model.document.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 ) ] ); } ); @@ -245,8 +244,8 @@ describe( 'EditingController', () => { } ); it( 'should convert not collapsed selection', () => { - model.enqueueChanges( () => { - model.selection.setRanges( [ + model.enqueueChange( () => { + model.document.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 2 ) ] ); } ); @@ -255,16 +254,16 @@ describe( 'EditingController', () => { } ); it( 'should clear previous selection', () => { - model.enqueueChanges( () => { - model.selection.setRanges( [ + model.enqueueChange( () => { + model.document.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 1, modelRoot.getChild( 2 ), 1 ) ] ); } ); expect( getViewData( editing.view ) ).to.equal( '

foo

b{}ar

' ); - model.enqueueChanges( () => { - model.selection.setRanges( [ + model.enqueueChange( () => { + model.document.selection.setRanges( [ ModelRange.createFromParentsAndOffsets( modelRoot.getChild( 2 ), 2, modelRoot.getChild( 2 ), 2 ) ] ); } ); @@ -375,8 +374,8 @@ describe( 'EditingController', () => { } ); it( 'should forward add marker event if content is moved into a marker range', () => { - model.enqueueChanges( () => { - model.batch().appendElement( 'paragraph', model.getRoot() ); + model.enqueueChange( writer => { + writer.appendElement( 'paragraph', model.document.getRoot() ); } ); const markerRange = ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, 3 ); @@ -398,8 +397,8 @@ describe( 'EditingController', () => { describe( 'destroy()', () => { it( 'should remove listenters', () => { - const model = new ModelDocument(); - model.createRoot(); + const model = new Model(); + model.document.createRoot(); model.schema.registerItem( 'paragraph', '$block' ); const editing = new EditingController( model ); @@ -410,11 +409,9 @@ describe( 'EditingController', () => { editing.destroy(); - const batch = model.batch(); - - model.enqueueChanges( () => { - const modelData = parse( 'foo', model.schema, batch ).getChild( 0 ); - batch.insert( modelData, model.getRoot() ); + model.enqueueChange( writer => { + const modelData = parse( 'foo', model.schema ).getChild( 0 ); + writer.insert( modelData, model.document.getRoot() ); } ); expect( spy.called ).to.be.false; @@ -423,8 +420,8 @@ describe( 'EditingController', () => { } ); it( 'should destroy view', () => { - const model = new ModelDocument(); - model.createRoot(); + const model = new Model(); + model.document.createRoot(); model.schema.registerItem( 'paragraph', '$block' ); const editing = new EditingController( model ); From 1a439f27ca23fddf09b8ececf6f71b7e5e1db39c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 8 Dec 2017 09:19:39 +0100 Subject: [PATCH 121/724] Fixed failing deleteContent util tests. --- tests/controller/deletecontent.js | 206 +++++++++++++++++------------- 1 file changed, 115 insertions(+), 91 deletions(-) diff --git a/tests/controller/deletecontent.js b/tests/controller/deletecontent.js index fe408ff23..e27a91b37 100644 --- a/tests/controller/deletecontent.js +++ b/tests/controller/deletecontent.js @@ -3,23 +3,27 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import Position from '../../src/model/position'; import Range from '../../src/model/range'; import Element from '../../src/model/element'; +import DataController from '../../src/controller/datacontroller'; +import HtmlDataProcessor from '../../src/dataprocessor/htmldataprocessor'; import deleteContent from '../../src/controller/deletecontent'; import { setData, getData } from '../../src/dev-utils/model'; -describe( 'DataController', () => { - let doc; +describe( 'DataController utils', () => { + let model, doc, data; describe( 'deleteContent', () => { describe( 'in simple scenarios', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'image', '$inline' ); @@ -40,11 +44,11 @@ describe( 'DataController', () => { ); it( 'deletes single character (backward selection)', () => { - setData( doc, 'f[o]o', { lastRangeBackward: true } ); + setData( model, 'f[o]o', { lastRangeBackward: true } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ).to.equal( 'f[]o' ); + expect( getData( model ) ).to.equal( 'f[]o' ); } ); test( @@ -80,10 +84,12 @@ describe( 'DataController', () => { describe( 'with text attributes', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'image', '$inline' ); schema.registerItem( 'paragraph', '$block' ); @@ -93,35 +99,35 @@ describe( 'DataController', () => { } ); it( 'deletes characters (first half has attrs)', () => { - setData( doc, '<$text bold="true">fo[ob]ar' ); + setData( model, '<$text bold="true">fo[ob]ar' ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ).to.equal( '<$text bold="true">fo[]ar' ); + expect( getData( model ) ).to.equal( '<$text bold="true">fo[]ar' ); expect( doc.selection.getAttribute( 'bold' ) ).to.equal( true ); } ); it( 'deletes characters (2nd half has attrs)', () => { - setData( doc, 'fo[o<$text bold="true">b]ar' ); + setData( model, 'fo[o<$text bold="true">b]ar' ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ).to.equal( 'fo[]<$text bold="true">ar' ); + expect( getData( model ) ).to.equal( 'fo[]<$text bold="true">ar' ); expect( doc.selection.getAttribute( 'bold' ) ).to.undefined; } ); it( 'clears selection attrs when emptied content', () => { - setData( doc, 'x[<$text bold="true">foo]y' ); + setData( model, 'x[<$text bold="true">foo]y' ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ).to.equal( 'x[]y' ); + expect( getData( model ) ).to.equal( 'x[]y' ); expect( doc.selection.getAttribute( 'bold' ) ).to.undefined; } ); it( 'leaves selection attributes when text contains them', () => { setData( - doc, + model, 'x<$text bold="true">a[foo]by', { selectionAttributes: { @@ -130,9 +136,9 @@ describe( 'DataController', () => { } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ).to.equal( 'x<$text bold="true">a[]by' ); + expect( getData( model ) ).to.equal( 'x<$text bold="true">a[]by' ); expect( doc.selection.getAttribute( 'bold' ) ).to.equal( true ); } ); } ); @@ -148,10 +154,12 @@ describe( 'DataController', () => { // Those case should, again, be handled by their specific implementations. describe( 'in multi-element scenarios', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'paragraph', '$block' ); schema.registerItem( 'heading1', '$block' ); @@ -199,14 +207,14 @@ describe( 'DataController', () => { // forward and backward delete. it( 'merges second element into the first one (different name, backward selection)', () => { setData( - doc, + model, 'xfo[ob]ary', { lastRangeBackward: true } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ).to.equal( 'xfo[]ary' ); + expect( getData( model ) ).to.equal( 'xfo[]ary' ); } ); test( @@ -234,44 +242,50 @@ describe( 'DataController', () => { ); it( 'uses merge delta even if merged element is empty', () => { - setData( doc, 'ab[cdefgh]' ); + let mergeSpy; - const batch = doc.batch(); - const spyMerge = sinon.spy( batch, 'merge' ); + setData( model, 'ab[cdefgh]' ); - deleteContent( doc.selection, batch ); + model.change( writer => { + mergeSpy = sinon.spy( writer, 'merge' ); + deleteContent( data, doc.selection ); + } ); - expect( getData( doc ) ).to.equal( 'ab[]' ); + expect( getData( model ) ).to.equal( 'ab[]' ); - expect( spyMerge.called ).to.be.true; + expect( mergeSpy.called ).to.be.true; } ); it( 'uses merge delta even if merged element is empty #2', () => { - setData( doc, 'ab[]' ); + let mergeSpy; - const batch = doc.batch(); - const spyMerge = sinon.spy( batch, 'merge' ); + setData( model, 'ab[]' ); - deleteContent( doc.selection, batch ); + model.change( writer => { + mergeSpy = sinon.spy( writer, 'merge' ); + deleteContent( data, doc.selection ); + } ); - expect( getData( doc ) ).to.equal( 'ab[]' ); + expect( getData( model ) ).to.equal( 'ab[]' ); - expect( spyMerge.called ).to.be.true; + expect( mergeSpy.called ).to.be.true; } ); it( 'does not try to move the second block if not needed', () => { - setData( doc, 'ab[cdef]gh' ); + let mergeSpy, moveSpy; - const batch = doc.batch(); - const spyMerge = sinon.spy( batch, 'merge' ); - const spyMove = sinon.spy( batch, 'move' ); + setData( model, 'ab[cdef]gh' ); - deleteContent( doc.selection, batch ); + model.change( writer => { + mergeSpy = sinon.spy( writer, 'merge' ); + moveSpy = sinon.spy( writer, 'move' ); + deleteContent( data, doc.selection ); + } ); - expect( getData( doc ) ).to.equal( 'ab[]gh' ); + expect( getData( model ) ).to.equal( 'ab[]gh' ); - expect( spyMove.called ).to.be.false; - expect( spyMerge.called ).to.be.true; + expect( moveSpy.called ).to.be.false; + expect( mergeSpy.called ).to.be.true; } ); // Note: in all these cases we ignore the direction of merge. @@ -318,9 +332,9 @@ describe( 'DataController', () => { doc.selection.setRanges( [ range ] ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'xxfo[]aryy' ); } ); @@ -363,9 +377,9 @@ describe( 'DataController', () => { doc.selection.setRanges( [ range ] ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'xfooba[]om' ); } ); @@ -406,16 +420,16 @@ describe( 'DataController', () => { doc.selection.setRanges( [ range ] ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'fo[]' ); } ); } ); describe( 'with object elements', () => { beforeEach( () => { - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'blockWidget' ); schema.registerItem( 'nestedEditable' ); @@ -444,7 +458,7 @@ describe( 'DataController', () => { describe( 'filtering out', () => { beforeEach( () => { - const schema = doc.schema; + const schema = model.schema; schema.allow( { name: '$text', attributes: [ 'a', 'b' ], inside: 'paragraph' } ); schema.allow( { name: '$text', attributes: [ 'b', 'c' ], inside: 'pchild' } ); @@ -490,7 +504,9 @@ describe( 'DataController', () => { describe( 'in element selections scenarios', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; + //

like root. doc.createRoot( 'paragraph', 'paragraphRoot' ); // like root. @@ -498,7 +514,9 @@ describe( 'DataController', () => { // Special root which allows only blockWidgets inside itself. doc.createRoot( 'restrictedRoot', 'restrictedRoot' ); - const schema = doc.schema; + data = new DataController( model, new HtmlDataProcessor() ); + + const schema = model.schema; schema.limits.add( 'restrictedRoot' ); @@ -517,105 +535,107 @@ describe( 'DataController', () => { // See also "in simple scenarios => deletes an element". it( 'deletes two inline elements', () => { - doc.schema.limits.add( 'paragraph' ); + model.schema.limits.add( 'paragraph' ); setData( - doc, + model, 'x[]z', { rootName: 'paragraphRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'paragraphRoot' } ) ) + expect( getData( model, { rootName: 'paragraphRoot' } ) ) .to.equal( 'x[]z' ); } ); it( 'creates a paragraph when text is not allowed (paragraph selected)', () => { setData( - doc, + model, 'x[yyy]z', { rootName: 'bodyRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'bodyRoot' } ) ) + expect( getData( model, { rootName: 'bodyRoot' } ) ) .to.equal( 'x[]z' ); } ); it( 'creates a paragraph when text is not allowed (block widget selected)', () => { setData( - doc, + model, 'x[]z', { rootName: 'bodyRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'bodyRoot' } ) ) + expect( getData( model, { rootName: 'bodyRoot' } ) ) .to.equal( 'x[]z' ); } ); it( 'creates paragraph when text is not allowed (heading selected)', () => { setData( - doc, + model, 'x[yyy]z', { rootName: 'bodyRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'bodyRoot' } ) ) + expect( getData( model, { rootName: 'bodyRoot' } ) ) .to.equal( 'x[]z' ); } ); it( 'creates paragraph when text is not allowed (two blocks selected)', () => { setData( - doc, + model, 'x[yyyyyy]z', { rootName: 'bodyRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'bodyRoot' } ) ) + expect( getData( model, { rootName: 'bodyRoot' } ) ) .to.equal( 'x[]z' ); } ); it( 'creates paragraph when text is not allowed (all content selected)', () => { setData( - doc, + model, '[xz]', { rootName: 'bodyRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'bodyRoot' } ) ) + expect( getData( model, { rootName: 'bodyRoot' } ) ) .to.equal( '[]' ); } ); it( 'does not create a paragraph when it is not allowed', () => { setData( - doc, + model, '[]', { rootName: 'restrictedRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'restrictedRoot' } ) ) + expect( getData( model, { rootName: 'restrictedRoot' } ) ) .to.equal( '[]' ); } ); } ); describe( 'integration with inline limit elements', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'inlineLimit' ); schema.allow( { name: 'inlineLimit', inside: '$root' } ); @@ -668,10 +688,12 @@ describe( 'DataController', () => { describe( 'integration with block limit elements', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'blockLimit' ); schema.allow( { name: 'blockLimit', inside: '$root' } ); @@ -715,10 +737,12 @@ describe( 'DataController', () => { describe( 'should leave a paragraph if the entire content was selected', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'div', '$block' ); schema.limits.add( 'div' ); @@ -789,14 +813,14 @@ describe( 'DataController', () => { doc.createRoot( 'paragraph', 'paragraphRoot' ); setData( - doc, + model, 'x[]z', { rootName: 'paragraphRoot' } ); - deleteContent( doc.selection, doc.batch() ); + deleteContent( data, doc.selection ); - expect( getData( doc, { rootName: 'paragraphRoot' } ) ) + expect( getData( model, { rootName: 'paragraphRoot' } ) ) .to.equal( 'x[]z' ); } ); @@ -812,11 +836,11 @@ describe( 'DataController', () => { function test( title, input, output, options ) { it( title, () => { - setData( doc, input ); + setData( model, input ); - deleteContent( doc.selection, doc.batch(), options ); + deleteContent( data, doc.selection, options ); - expect( getData( doc ) ).to.equal( output ); + expect( getData( model ) ).to.equal( output ); } ); } } ); From b38d8c101c6f20e56e1f0df61c894162fcaf5178 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 8 Dec 2017 11:28:23 +0100 Subject: [PATCH 122/724] Fixed failing getSelectedContent util tests. --- tests/controller/getselectedcontent.js | 166 +++++++++++++------------ 1 file changed, 87 insertions(+), 79 deletions(-) diff --git a/tests/controller/getselectedcontent.js b/tests/controller/getselectedcontent.js index 923cd7d2c..4692e6d51 100644 --- a/tests/controller/getselectedcontent.js +++ b/tests/controller/getselectedcontent.js @@ -3,21 +3,25 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; +import DataController from '../../src/controller/datacontroller'; +import HtmlDataProcessor from '../../src/dataprocessor/htmldataprocessor'; import DocumentFragment from '../../src/model/documentfragment'; import getSelectedContent from '../../src/controller/getselectedcontent'; import { setData, stringify } from '../../src/dev-utils/model'; -describe( 'Delete utils', () => { - let doc; +describe( 'DataController utils', () => { + let model, doc, data; describe( 'getSelectedContent', () => { describe( 'in simple scenarios', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'image', '$inline' ); @@ -28,27 +32,27 @@ describe( 'Delete utils', () => { } ); it( 'returns empty fragment for no selection', () => { - setData( doc, 'abc' ); + setData( model, 'abc' ); - const frag = getSelectedContent( doc.selection, doc.batch() ); + const frag = getSelectedContent( data, doc.selection ); expect( frag ).instanceOf( DocumentFragment ); expect( frag.isEmpty ).to.be.true; } ); it( 'returns empty fragment for empty selection', () => { - setData( doc, 'a[]bc' ); + setData( model, 'a[]bc' ); - const frag = getSelectedContent( doc.selection, doc.batch() ); + const frag = getSelectedContent( data, doc.selection ); expect( frag ).instanceOf( DocumentFragment ); expect( frag.isEmpty ).to.be.true; } ); it( 'gets one character', () => { - setData( doc, 'a[b]c' ); + setData( model, 'a[b]c' ); - const frag = getSelectedContent( doc.selection, doc.batch() ); + const frag = getSelectedContent( data, doc.selection ); const content = stringify( frag ); expect( frag ).instanceOf( DocumentFragment ); @@ -56,61 +60,63 @@ describe( 'Delete utils', () => { } ); it( 'gets full text', () => { - setData( doc, '[abc]' ); + setData( model, '[abc]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abc' ); } ); it( 'gets text with an attribute', () => { - setData( doc, 'xxx<$text bold="true">a[b]c' ); + setData( model, 'xxx<$text bold="true">a[b]c' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '<$text bold="true">b' ); } ); it( 'gets text with attributes', () => { - setData( doc, 'x<$text bold="true">a[b<$text italic="true">c]dx' ); + setData( model, 'x<$text bold="true">a[b<$text italic="true">c]dx' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '<$text bold="true">b<$text italic="true">c' ); } ); it( 'gets text with and without attribute', () => { - setData( doc, '<$text bold="true">a[bc]d' ); + setData( model, '<$text bold="true">a[bc]d' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '<$text bold="true">bc' ); } ); it( 'gets text and element', () => { - setData( doc, '[abc]' ); + setData( model, '[abc]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abc' ); } ); it( 'gets one element', () => { - setData( doc, 'a[]b' ); + setData( model, 'a[]b' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '' ); } ); it( 'gets multiple elements', () => { - setData( doc, '[]' ); + setData( model, '[]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '' ); } ); } ); describe( 'in blocks', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'paragraph', '$block' ); schema.registerItem( 'heading1', '$block' ); @@ -126,119 +132,119 @@ describe( 'Delete utils', () => { } ); it( 'gets one character', () => { - setData( doc, 'a[b]c' ); + setData( model, 'a[b]c' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'b' ); } ); it( 'gets entire paragraph content', () => { - setData( doc, '[ab]' ); + setData( model, '[ab]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'ab' ); } ); it( 'gets two blocks - partial, partial', () => { - setData( doc, 'a[bcde]f' ); + setData( model, 'a[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets two blocks - full, partial', () => { - setData( doc, '[abcde]f' ); + setData( model, '[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - full, partial 2', () => { - setData( doc, '[abcde]f' ); + setData( model, '[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - full, partial 3', () => { - setData( doc, 'x[abcde]f' ); + setData( model, 'x[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - full, partial 4', () => { - setData( doc, '[abcde]f' ); + setData( model, '[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets two blocks - partial, full', () => { - setData( doc, 'a[bcdef]' ); + setData( model, 'a[bcdef]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcdef' ); } ); it( 'gets two blocks - partial, full 2', () => { - setData( doc, 'a[bcdef]' ); + setData( model, 'a[bcdef]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcdef' ); } ); // See https://github.com/ckeditor/ckeditor5-engine/issues/652#issuecomment-261358484 it( 'gets two blocks - empty, full', () => { - setData( doc, 'abc[def]' ); + setData( model, 'abc[def]' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'def' ); } ); // See https://github.com/ckeditor/ckeditor5-engine/issues/652#issuecomment-261358484 it( 'gets two blocks - partial, empty', () => { - setData( doc, 'a[bc]def' ); + setData( model, 'a[bc]def' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bc' ); } ); it( 'gets three blocks', () => { - setData( doc, 'a[bcxde]f' ); + setData( model, 'a[bcxde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcxde' ); } ); it( 'gets block image', () => { - setData( doc, 'a[

]b' ); + setData( model, 'a[]b' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '' ); } ); it( 'gets two blocks', () => { - setData( doc, 'a[]b' ); + setData( model, 'a[]b' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( '' ); } ); // Purely related to the current implementation. it( 'gets content when multiple text items needs to be removed from the right excess', () => { - setData( doc, 'a[bc]d<$text bold="true">ef' ); + setData( model, 'a[bc]d<$text bold="true">ef' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ) .to.equal( 'bc' ); } ); // Purely related to the current implementation. it( 'gets content when multiple text items needs to be removed from the left excess', () => { - setData( doc, 'a<$text bold="true">bc[de]f' ); + setData( model, 'a<$text bold="true">bc[de]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ) .to.equal( 'de' ); } ); @@ -246,10 +252,12 @@ describe( 'Delete utils', () => { describe( 'in blocks (deeply nested)', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + data = new DataController( model, new HtmlDataProcessor() ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'paragraph', '$block' ); schema.registerItem( 'heading1', '$block' ); @@ -260,62 +268,62 @@ describe( 'Delete utils', () => { } ); it( 'gets content when ends are equally deeply nested', () => { - setData( doc, 'xa[bcde]f' ); + setData( model, 'xa[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets content when left end nested deeper', () => { - setData( doc, 'a[bcde]f' ); + setData( model, 'a[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets content when left end nested deeper 2', () => { - setData( doc, 'a[bcxde]f' ); + setData( model, 'a[bcxde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcxde' ); } ); it( 'gets content when left end nested deeper 3', () => { - setData( doc, 'xa[bcde]f' ); + setData( model, 'xa[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcde' ); } ); // See https://github.com/ckeditor/ckeditor5-engine/issues/652#issuecomment-261358484 it( 'gets content when left end nested deeper 4', () => { - setData( doc, 'x[abcde]f' ); + setData( model, 'x[abcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'abcde' ); } ); it( 'gets content when right end nested deeper', () => { - setData( doc, 'a[bcde]f' ); + setData( model, 'a[bcde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ).to.equal( 'bcde' ); } ); it( 'gets content when both ends nested deeper than the middle element', () => { - setData( doc, 'a[bcxde]f' ); + setData( model, 'a[bcxde]f' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ) .to.equal( 'bcxde' ); } ); // See: https://github.com/ckeditor/ckeditor5-engine/pull/1043#issuecomment-318012286 it( 'ensures that elements are retrieved by indexes instead of offsets', () => { - doc.schema.allow( { name: '$text', inside: '$root' } ); - doc.schema.allow( { name: '$text', inside: 'quote' } ); + model.schema.allow( { name: '$text', inside: '$root' } ); + model.schema.allow( { name: '$text', inside: 'quote' } ); - setData( doc, + setData( model, 'foo' + '' + '' + @@ -325,7 +333,7 @@ describe( 'Delete utils', () => { '' ); - const content = stringify( getSelectedContent( doc.selection, doc.batch() ) ); + const content = stringify( getSelectedContent( data, doc.selection ) ); expect( content ) .to.equal( 'arbo' ); } ); From 0122183eebf117360f803a77341a254cb3c1962e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 8 Dec 2017 11:41:56 +0100 Subject: [PATCH 123/724] Fixed failing deleteContent util tests. --- tests/controller/insertcontent.js | 432 +++++++++++++++--------------- 1 file changed, 216 insertions(+), 216 deletions(-) diff --git a/tests/controller/insertcontent.js b/tests/controller/insertcontent.js index 4a11b6ac2..cdfdd217b 100644 --- a/tests/controller/insertcontent.js +++ b/tests/controller/insertcontent.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DataController from '../../src/controller/datacontroller'; import insertContent from '../../src/controller/insertcontent'; @@ -13,83 +13,82 @@ import Element from '../../src/model/element'; import { setData, getData, parse } from '../../src/dev-utils/model'; -describe( 'DataController', () => { - let doc, dataController; +describe( 'DataController utils', () => { + let model, doc, dataController; describe( 'insertContent', () => { - it( 'uses the passed batch', () => { - const doc = new Document(); + it( 'should use parent batch', () => { + model = new Model(); + doc = model.document; doc.createRoot(); - doc.schema.allow( { name: '$text', inside: '$root' } ); + dataController = new DataController( model ); - const dataController = new DataController( doc ); + model.schema.allow( { name: '$text', inside: '$root' } ); + setData( model, 'x[]x' ); - const batch = doc.batch(); - - setData( doc, 'x[]x' ); - - insertContent( dataController, new DocumentFragment( [ new Text( 'a' ) ] ), doc.selection, batch ); - - expect( batch.deltas.length ).to.be.above( 0 ); + model.change( writer => { + insertContent( dataController, new Text( 'a' ), doc.selection ); + expect( writer.batch.deltas ).to.length( 1 ); + } ); } ); it( 'accepts DocumentFragment', () => { - const doc = new Document(); - const dataController = new DataController( doc ); - const batch = doc.batch(); - + model = new Model(); + doc = model.document; doc.createRoot(); - doc.schema.allow( { name: '$text', inside: '$root' } ); + dataController = new DataController( model ); + + model.schema.allow( { name: '$text', inside: '$root' } ); - setData( doc, 'x[]x' ); + setData( model, 'x[]x' ); - insertContent( dataController, new DocumentFragment( [ new Text( 'a' ) ] ), doc.selection, batch ); + insertContent( dataController, new DocumentFragment( [ new Text( 'a' ) ] ), doc.selection ); - expect( getData( doc ) ).to.equal( 'xa[]x' ); + expect( getData( model ) ).to.equal( 'xa[]x' ); } ); it( 'accepts Text', () => { - const doc = new Document(); - const dataController = new DataController( doc ); - const batch = doc.batch(); - + model = new Model(); + doc = model.document; doc.createRoot(); - doc.schema.allow( { name: '$text', inside: '$root' } ); + dataController = new DataController( model ); + + model.schema.allow( { name: '$text', inside: '$root' } ); - setData( doc, 'x[]x' ); + setData( model, 'x[]x' ); - insertContent( dataController, new Text( 'a' ), doc.selection, batch ); + insertContent( dataController, new Text( 'a' ), doc.selection ); - expect( getData( doc ) ).to.equal( 'xa[]x' ); + expect( getData( model ) ).to.equal( 'xa[]x' ); } ); it( 'should save the reference to the original object', () => { - const doc = new Document(); - const dataController = new DataController( doc ); - const batch = doc.batch(); - const content = new Element( 'image' ); - + model = new Model(); + doc = model.document; doc.createRoot(); + dataController = new DataController( model ); + + const content = new Element( 'image' ); - doc.schema.registerItem( 'paragraph', '$block' ); - doc.schema.registerItem( 'image', '$inline' ); - doc.schema.objects.add( 'image' ); + model.schema.registerItem( 'paragraph', '$block' ); + model.schema.registerItem( 'image', '$inline' ); + model.schema.objects.add( 'image' ); - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); - insertContent( dataController, content, doc.selection, batch ); + insertContent( dataController, content, doc.selection ); expect( doc.getRoot().getChild( 0 ).getChild( 1 ) ).to.equal( content ); } ); describe( 'in simple scenarios', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + dataController = new DataController( model ); - dataController = new DataController( doc ); - - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'image', '$inline' ); schema.registerItem( 'disallowedElement' ); @@ -98,7 +97,7 @@ describe( 'DataController', () => { schema.allow( { name: 'image', inside: '$root' } ); // Otherwise it won't be passed to the temporary model fragment used inside insert(). schema.allow( { name: 'disallowedElement', inside: '$clipboardHolder' } ); - doc.schema.allow( { name: '$text', inside: 'disallowedElement' } ); + model.schema.allow( { name: '$text', inside: 'disallowedElement' } ); schema.allow( { name: '$inline', attributes: [ 'bold' ] } ); schema.allow( { name: '$inline', attributes: [ 'italic' ] } ); @@ -107,29 +106,29 @@ describe( 'DataController', () => { } ); it( 'inserts one text node', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'inserts one text node (at the end)', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fooxyz[]' ); + expect( getData( model ) ).to.equal( 'fooxyz[]' ); } ); it( 'inserts one text node with attribute', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '<$text bold="true">xyz' ); - expect( getData( doc ) ).to.equal( 'f<$text bold="true">xyz[]oo' ); + expect( getData( model ) ).to.equal( 'f<$text bold="true">xyz[]oo' ); expect( doc.selection.getAttribute( 'bold' ) ).to.be.true; } ); it( 'inserts one text node with attribute into text with a different attribute', () => { - setData( doc, '<$text bold="true">f[]oo' ); + setData( model, '<$text bold="true">f[]oo' ); insertHelper( '<$text italic="true">xyz' ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( '<$text bold="true">f<$text italic="true">xyz[]<$text bold="true">oo' ); expect( doc.selection.getAttribute( 'italic' ) ).to.be.true; @@ -137,44 +136,44 @@ describe( 'DataController', () => { } ); it( 'inserts one text node with attribute into text with the same attribute', () => { - setData( doc, '<$text bold="true">f[]oo' ); + setData( model, '<$text bold="true">f[]oo' ); insertHelper( '<$text bold="true">xyz' ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( '<$text bold="true">fxyz[]oo' ); expect( doc.selection.getAttribute( 'bold' ) ).to.be.true; } ); it( 'inserts a text without attributes into a text with an attribute', () => { - setData( doc, '<$text bold="true">f[]oo' ); + setData( model, '<$text bold="true">f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( '<$text bold="true">fxyz[]<$text bold="true">oo' ); + expect( getData( model ) ).to.equal( '<$text bold="true">fxyz[]<$text bold="true">oo' ); expect( doc.selection.hasAttribute( 'bold' ) ).to.be.false; } ); it( 'inserts an element', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( 'f[]oo' ); + expect( getData( model ) ).to.equal( 'f[]oo' ); } ); it( 'inserts a text and an element', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'strips a disallowed element', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'deletes selection before inserting the content', () => { - setData( doc, 'f[abc]oo' ); + setData( model, 'f[abc]oo' ); insertHelper( 'x' ); - expect( getData( doc ) ).to.equal( 'fx[]oo' ); + expect( getData( model ) ).to.equal( 'fx[]oo' ); } ); describe( 'spaces handling', () => { @@ -182,45 +181,45 @@ describe( 'DataController', () => { // inserted into the model as is. The conversion to nbsps happen on view<=>DOM conversion. it( 'inserts one space', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( new Text( ' ' ) ); - expect( getData( doc ) ).to.equal( 'f []oo' ); + expect( getData( model ) ).to.equal( 'f []oo' ); } ); it( 'inserts three spaces', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( new Text( ' ' ) ); - expect( getData( doc ) ).to.equal( 'f []oo' ); + expect( getData( model ) ).to.equal( 'f []oo' ); } ); it( 'inserts spaces at the end', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( new Text( ' ' ) ); - expect( getData( doc ) ).to.equal( 'foo []' ); + expect( getData( model ) ).to.equal( 'foo []' ); } ); it( 'inserts one nbsp', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( new Text( '\u200a' ) ); - expect( getData( doc ) ).to.equal( 'f\u200a[]oo' ); + expect( getData( model ) ).to.equal( 'f\u200a[]oo' ); } ); it( 'inserts word surrounded by spaces', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( new Text( ' xyz ' ) ); - expect( getData( doc ) ).to.equal( 'f xyz []oo' ); + expect( getData( model ) ).to.equal( 'f xyz []oo' ); } ); } ); } ); describe( 'in blocks', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + dataController = new DataController( model ); - dataController = new DataController( doc ); - - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'paragraph', '$block' ); schema.registerItem( 'heading1', '$block' ); @@ -244,137 +243,137 @@ describe( 'DataController', () => { } ); it( 'inserts one text node', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'inserts one text node to fully selected paragraph', () => { - setData( doc, '[foo]' ); + setData( model, '[foo]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'xyz[]' ); + expect( getData( model ) ).to.equal( 'xyz[]' ); } ); it( 'inserts one text node to fully selected paragraphs (from outside)', () => { - setData( doc, '[foobar]' ); + setData( model, '[foobar]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'xyz[]' ); + expect( getData( model ) ).to.equal( 'xyz[]' ); } ); it( 'merges two blocks before inserting content (p+p)', () => { - setData( doc, 'fo[ob]ar' ); + setData( model, 'fo[ob]ar' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'foxyz[]ar' ); + expect( getData( model ) ).to.equal( 'foxyz[]ar' ); } ); it( 'inserts inline widget and text', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); // Note: In CKEditor 4 the blocks are not merged, but to KISS we're merging here // because that's what deleteContent() does. it( 'merges two blocks before inserting content (h+p)', () => { - setData( doc, 'fo[ob]ar' ); + setData( model, 'fo[ob]ar' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'foxyz[]ar' ); + expect( getData( model ) ).to.equal( 'foxyz[]ar' ); } ); it( 'not insert autoparagraph when paragraph is disallowed at the current position', () => { - doc.schema.disallow( { name: 'paragraph', inside: '$root' } ); + model.schema.disallow( { name: 'paragraph', inside: '$root' } ); const content = new DocumentFragment( [ new Element( 'heading1', [], [ new Text( 'bar' ) ] ), new Text( 'biz' ) ] ); - setData( doc, '[foo]' ); + setData( model, '[foo]' ); insertContent( dataController, content, doc.selection ); - expect( getData( doc ) ).to.equal( 'bar[]' ); + expect( getData( model ) ).to.equal( 'bar[]' ); } ); describe( 'block to block handling', () => { it( 'inserts one paragraph', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'inserts one paragraph (at the end)', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fooxyz[]' ); + expect( getData( model ) ).to.equal( 'fooxyz[]' ); } ); it( 'inserts one paragraph into an empty paragraph', () => { - setData( doc, '[]' ); + setData( model, '[]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'xyz[]' ); + expect( getData( model ) ).to.equal( 'xyz[]' ); } ); it( 'inserts one empty paragraph', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( 'f[]oo' ); + expect( getData( model ) ).to.equal( 'f[]oo' ); } ); it( 'inserts one block into a fully selected content', () => { - setData( doc, '[foobar]' ); + setData( model, '[foobar]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'xyz[]' ); + expect( getData( model ) ).to.equal( 'xyz[]' ); } ); it( 'inserts one heading', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'inserts two headings', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ).to.equal( 'fxxxyyy[]oo' ); + expect( getData( model ) ).to.equal( 'fxxxyyy[]oo' ); } ); it( 'inserts one object', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( 'f[]oo' ); + expect( getData( model ) ).to.equal( 'f[]oo' ); } ); it( 'inserts one object (at the end)', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( 'foo[]' ); + expect( getData( model ) ).to.equal( 'foo[]' ); } ); it( 'inserts one object (at the beginning)', () => { - setData( doc, '[]bar' ); + setData( model, '[]bar' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( '[]bar' ); + expect( getData( model ) ).to.equal( '[]bar' ); } ); it( 'inserts one list item', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'fxyz[]oo' ); + expect( getData( model ) ).to.equal( 'fxyz[]oo' ); } ); it( 'inserts list item to empty element', () => { - setData( doc, '[]' ); + setData( model, '[]' ); insertHelper( 'xyz' ); - expect( getData( doc ) ).to.equal( 'xyz[]' ); + expect( getData( model ) ).to.equal( 'xyz[]' ); } ); it( 'inserts three list items at the end of paragraph', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'xxx' + 'yyy' + 'zzz' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fooxxx' + 'yyy' + 'zzz[]' @@ -382,12 +381,12 @@ describe( 'DataController', () => { } ); it( 'inserts two list items to an empty paragraph', () => { - setData( doc, 'a[]b' ); + setData( model, 'a[]b' ); insertHelper( 'xxx' + 'yyy' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'a' + 'xxx' + 'yyy[]' + @@ -398,51 +397,51 @@ describe( 'DataController', () => { describe( 'mixed content to block', () => { it( 'inserts text + paragraph', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ).to.equal( 'fxxxyyy[]oo' ); + expect( getData( model ) ).to.equal( 'fxxxyyy[]oo' ); } ); it( 'inserts text + inlineWidget + text + paragraph', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxxyyyzzz' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fxxxyyyzzz[]oo' ); } ); it( 'inserts text + paragraph (at the beginning)', () => { - setData( doc, '[]foo' ); + setData( model, '[]foo' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ).to.equal( 'xxxyyy[]foo' ); + expect( getData( model ) ).to.equal( 'xxxyyy[]foo' ); } ); it( 'inserts text + paragraph (at the end)', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ).to.equal( 'fooxxxyyy[]' ); + expect( getData( model ) ).to.equal( 'fooxxxyyy[]' ); } ); it( 'inserts paragraph + text', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'yyyxxx' ); - expect( getData( doc ) ).to.equal( 'fyyyxxx[]oo' ); + expect( getData( model ) ).to.equal( 'fyyyxxx[]oo' ); } ); // This is the expected result, but it was so hard to achieve at this stage that I // decided to go with the what the next test represents. // it( 'inserts paragraph + text + inlineWidget + text', () => { - // setData( doc, 'f[]oo' ); + // setData( model, 'f[]oo' ); // insertHelper( 'yyyxxxzzz' ); - // expect( getData( doc ) ) + // expect( getData( model ) ) // .to.equal( 'fyyyxxxzzz[]oo' ); // } ); // See the comment above. it( 'inserts paragraph + text + inlineWidget + text', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'yyyxxxzzz' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fyyyxxx' + '' + 'zzz[]oo' @@ -450,43 +449,43 @@ describe( 'DataController', () => { } ); it( 'inserts paragraph + text + paragraph', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'yyyxxxzzz' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fyyyxxxzzz[]oo' ); } ); it( 'inserts paragraph + text (at the beginning)', () => { - setData( doc, '[]foo' ); + setData( model, '[]foo' ); insertHelper( 'yyyxxx' ); - expect( getData( doc ) ).to.equal( 'yyyxxx[]foo' ); + expect( getData( model ) ).to.equal( 'yyyxxx[]foo' ); } ); it( 'inserts paragraph + text (at the end)', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'yyyxxx' ); - expect( getData( doc ) ).to.equal( 'fooyyyxxx[]' ); + expect( getData( model ) ).to.equal( 'fooyyyxxx[]' ); } ); it( 'inserts text + heading', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ).to.equal( 'fxxxyyy[]oo' ); + expect( getData( model ) ).to.equal( 'fxxxyyy[]oo' ); } ); it( 'inserts paragraph + object', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fxxx[]oo' ); } ); it( 'inserts object + paragraph', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fxxx[]oo' ); } ); @@ -494,50 +493,51 @@ describe( 'DataController', () => { describe( 'content over a block object', () => { it( 'inserts text', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'fooxxx[]bar' ); } ); it( 'inserts paragraph', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( 'fooxxx[]bar' ); + expect( getData( model ) ) + .to.equal( 'fooxxx[]bar' ); } ); it( 'inserts text + paragraph', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'yyyxxx' ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'fooyyyxxx[]bar' ); } ); it( 'inserts two blocks', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'fooxxxyyy[]bar' ); } ); it( 'inserts block object', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( '' ); // It's enough, don't worry. - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'foo[]bar' ); } ); it( 'inserts inline object', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( '' ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'foo[]bar' ); @@ -546,39 +546,39 @@ describe( 'DataController', () => { describe( 'content over an inline object', () => { it( 'inserts text', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( 'fooxxx[]bar' ); + expect( getData( model ) ).to.equal( 'fooxxx[]bar' ); } ); it( 'inserts paragraph', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( 'fooxxx[]bar' ); + expect( getData( model ) ).to.equal( 'fooxxx[]bar' ); } ); it( 'inserts text + paragraph', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'yyyxxx' ); - expect( getData( doc ) ).to.equal( 'fooyyyxxx[]bar' ); + expect( getData( model ) ).to.equal( 'fooyyyxxx[]bar' ); } ); it( 'inserts two blocks', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'xxxyyy' ); - expect( getData( doc ) ).to.equal( 'fooxxxyyy[]bar' ); + expect( getData( model ) ).to.equal( 'fooxxxyyy[]bar' ); } ); it( 'inserts inline object', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( 'foo[]bar' ); + expect( getData( model ) ).to.equal( 'foo[]bar' ); } ); it( 'inserts block object', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( + expect( getData( model ) ).to.equal( 'foo[]bar' ); } ); @@ -587,12 +587,12 @@ describe( 'DataController', () => { describe( 'filtering out', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); + dataController = new DataController( model ); - dataController = new DataController( doc ); - - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'paragraph', '$block' ); schema.registerItem( 'heading1', '$block' ); @@ -624,80 +624,82 @@ describe( 'DataController', () => { } ); it( 'filters out disallowed elements and leaves out the text', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '
FooFooFoo
xxxyyy
' ); - expect( getData( doc ) ).to.equal( 'fxxxyyy[]oo' ); + expect( getData( model ) ).to.equal( 'fxxxyyy[]oo' ); } ); it( 'filters out disallowed elements and leaves out the paragraphs', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '
xxxyyyzzz
' ); - expect( getData( doc ) ).to.equal( 'fxxxyyyzzz[]oo' ); + expect( getData( model ) ) + .to.equal( 'fxxxyyyzzz[]oo' ); } ); it( 'filters out disallowed objects', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxx' ); - expect( getData( doc ) ).to.equal( 'f[]oo' ); + expect( getData( model ) ).to.equal( 'f[]oo' ); } ); it( 'filters out disallowed attributes when inserting text', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'x<$text a="1" b="1">xxy<$text a="1">yy' ); - expect( getData( doc ) ).to.equal( 'fx<$text b="1">xxyyy[]oo' ); + expect( getData( model ) ).to.equal( 'fx<$text b="1">xxyyy[]oo' ); } ); it( 'filters out disallowed attributes when inserting nested elements', () => { - setData( doc, '[]' ); + setData( model, '[]' ); insertHelper( '
f<$text a="1" b="1" c="1">oo
' ); - expect( getData( doc ) ).to.equal( '
f<$text b="1">oo
[]' ); + expect( getData( model ) ).to.equal( '
f<$text b="1">oo
[]' ); } ); it( 'filters out disallowed attributes when inserting text in disallowed elements', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( '
x<$text a="1" b="1">xxy<$text a="1">yy
' ); - expect( getData( doc ) ).to.equal( 'fx<$text b="1">xxyyy[]oo' ); + expect( getData( model ) ).to.equal( 'fx<$text b="1">xxyyy[]oo' ); } ); it( 'filters out disallowed attributes when merging #1', () => { - setData( doc, '[]foo' ); + setData( model, '[]foo' ); insertHelper( 'x<$text a="1" b="1">xx' ); - expect( getData( doc ) ).to.equal( 'x<$text b="1">xx[]foo' ); + expect( getData( model ) ).to.equal( 'x<$text b="1">xx[]foo' ); } ); it( 'filters out disallowed attributes when merging #2', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'x<$text a="1" b="1">xx' ); - expect( getData( doc ) ).to.equal( 'fx<$text b="1">xx[]oo' ); + expect( getData( model ) ).to.equal( 'fx<$text b="1">xx[]oo' ); } ); it( 'filters out disallowed attributes when merging #3', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'x<$text a="1" b="1">xx' ); - expect( getData( doc ) ).to.equal( 'foox<$text b="1">xx[]' ); + expect( getData( model ) ).to.equal( 'foox<$text b="1">xx[]' ); } ); it( 'filters out disallowed attributes from nested nodes when merging', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xb<$text a="1" b="1">arx' ); - expect( getData( doc ) ).to.equal( 'fxb<$text b="1">arx[]oo' ); + expect( getData( model ) ).to.equal( 'fxb<$text b="1">arx[]oo' ); } ); it( 'filters out disallowed attributes when autoparagraphing', () => { - setData( doc, 'f[]oo' ); + setData( model, 'f[]oo' ); insertHelper( 'xxx<$text a="1" b="1">yyy' ); - expect( getData( doc ) ).to.equal( 'fxxx<$text b="1">yyy[]oo' ); + expect( getData( model ) ).to.equal( 'fxxx<$text b="1">yyy[]oo' ); } ); } ); } ); describe( 'integration with limit elements', () => { beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); - dataController = new DataController( doc ); + dataController = new DataController( model ); - const schema = doc.schema; + const schema = model.schema; schema.registerItem( 'limit' ); schema.allow( { name: 'limit', inside: '$root' } ); @@ -713,42 +715,42 @@ describe( 'DataController', () => { it( 'should insert limit element', () => { insertHelper( '' ); - expect( getData( doc ) ).to.equal( '[]' ); + expect( getData( model ) ).to.equal( '[]' ); } ); it( 'should insert text into limit element', () => { - setData( doc, '[]' ); + setData( model, '[]' ); insertHelper( 'foo bar' ); - expect( getData( doc ) ).to.equal( 'foo bar[]' ); + expect( getData( model ) ).to.equal( 'foo bar[]' ); } ); it( 'should insert text into limit element', () => { - setData( doc, 'foo[]bar' ); + setData( model, 'foo[]bar' ); insertHelper( 'baz' ); - expect( getData( doc ) ).to.equal( 'foobaz[]bar' ); + expect( getData( model ) ).to.equal( 'foobaz[]bar' ); } ); it( 'should not insert disallowed elements inside limit elements', () => { - setData( doc, '[]' ); + setData( model, '[]' ); insertHelper( '' ); - expect( getData( doc ) ).to.equal( '[]' ); + expect( getData( model ) ).to.equal( '[]' ); } ); it( 'should not leave the limit element when inserting at the end', () => { - setData( doc, 'foo[]' ); + setData( model, 'foo[]' ); insertHelper( 'ab' ); - expect( getData( doc ) ).to.equal( 'fooab[]' ); + expect( getData( model ) ).to.equal( 'fooab[]' ); } ); it( 'should not leave the limit element when inserting at the beginning', () => { - setData( doc, '[]foo' ); + setData( model, '[]foo' ); insertHelper( 'ab' ); - expect( getData( doc ) ).to.equal( 'ab[]foo' ); + expect( getData( model ) ).to.equal( 'ab[]foo' ); } ); } ); @@ -756,14 +758,12 @@ describe( 'DataController', () => { // // @param {module:engine/model/item~Item|String} content function insertHelper( content ) { - const batch = doc.batch(); - if ( typeof content == 'string' ) { - content = parse( content, doc.schema, batch, { + content = parse( content, model.schema, { context: [ '$clipboardHolder' ] } ); } - insertContent( dataController, content, doc.selection, batch ); + insertContent( dataController, content, doc.selection ); } } ); From e1f1a4482cb1a89af3f24aa87d76e65df547ff16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 8 Dec 2017 11:57:56 +0100 Subject: [PATCH 124/724] Improved DataController utils test. --- tests/controller/deletecontent.js | 30 +++- tests/controller/getselectedcontent.js | 22 ++- tests/controller/insertcontent.js | 30 ++-- tests/controller/modifyselection.js | 217 +++++++++++++------------ 4 files changed, 164 insertions(+), 135 deletions(-) diff --git a/tests/controller/deletecontent.js b/tests/controller/deletecontent.js index e27a91b37..30afdd617 100644 --- a/tests/controller/deletecontent.js +++ b/tests/controller/deletecontent.js @@ -8,7 +8,6 @@ import Position from '../../src/model/position'; import Range from '../../src/model/range'; import Element from '../../src/model/element'; import DataController from '../../src/controller/datacontroller'; -import HtmlDataProcessor from '../../src/dataprocessor/htmldataprocessor'; import deleteContent from '../../src/controller/deletecontent'; import { setData, getData } from '../../src/dev-utils/model'; @@ -16,12 +15,27 @@ describe( 'DataController utils', () => { let model, doc, data; describe( 'deleteContent', () => { + it( 'should use parent batch', () => { + model = new Model(); + doc = model.document; + doc.createRoot(); + data = new DataController( model ); + + model.schema.allow( { name: '$text', inside: '$root' } ); + setData( model, 'x[abc]x' ); + + model.change( writer => { + deleteContent( data, doc.selection ); + expect( writer.batch.deltas ).to.length( 1 ); + } ); + } ); + describe( 'in simple scenarios', () => { beforeEach( () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -87,7 +101,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -157,7 +171,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -514,7 +528,7 @@ describe( 'DataController utils', () => { // Special root which allows only blockWidgets inside itself. doc.createRoot( 'restrictedRoot', 'restrictedRoot' ); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -633,7 +647,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -691,7 +705,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -740,7 +754,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; diff --git a/tests/controller/getselectedcontent.js b/tests/controller/getselectedcontent.js index 4692e6d51..a2aa5dbba 100644 --- a/tests/controller/getselectedcontent.js +++ b/tests/controller/getselectedcontent.js @@ -5,7 +5,6 @@ import Model from '../../src/model/model'; import DataController from '../../src/controller/datacontroller'; -import HtmlDataProcessor from '../../src/dataprocessor/htmldataprocessor'; import DocumentFragment from '../../src/model/documentfragment'; import getSelectedContent from '../../src/controller/getselectedcontent'; import { setData, stringify } from '../../src/dev-utils/model'; @@ -14,12 +13,27 @@ describe( 'DataController utils', () => { let model, doc, data; describe( 'getSelectedContent', () => { + it( 'should use parent batch', () => { + model = new Model(); + doc = model.document; + doc.createRoot(); + data = new DataController( model ); + + model.schema.allow( { name: '$text', inside: '$root' } ); + setData( model, 'x[abc]x' ); + + model.change( writer => { + getSelectedContent( data, doc.selection ); + expect( writer.batch.deltas ).to.length( 1 ); + } ); + } ); + describe( 'in simple scenarios', () => { beforeEach( () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -114,7 +128,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; @@ -255,7 +269,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - data = new DataController( model, new HtmlDataProcessor() ); + data = new DataController( model ); const schema = model.schema; diff --git a/tests/controller/insertcontent.js b/tests/controller/insertcontent.js index cdfdd217b..6bc644fca 100644 --- a/tests/controller/insertcontent.js +++ b/tests/controller/insertcontent.js @@ -14,20 +14,20 @@ import Element from '../../src/model/element'; import { setData, getData, parse } from '../../src/dev-utils/model'; describe( 'DataController utils', () => { - let model, doc, dataController; + let model, doc, data; describe( 'insertContent', () => { it( 'should use parent batch', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); model.schema.allow( { name: '$text', inside: '$root' } ); setData( model, 'x[]x' ); model.change( writer => { - insertContent( dataController, new Text( 'a' ), doc.selection ); + insertContent( data, new Text( 'a' ), doc.selection ); expect( writer.batch.deltas ).to.length( 1 ); } ); } ); @@ -36,13 +36,13 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); model.schema.allow( { name: '$text', inside: '$root' } ); setData( model, 'x[]x' ); - insertContent( dataController, new DocumentFragment( [ new Text( 'a' ) ] ), doc.selection ); + insertContent( data, new DocumentFragment( [ new Text( 'a' ) ] ), doc.selection ); expect( getData( model ) ).to.equal( 'xa[]x' ); } ); @@ -51,13 +51,13 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); model.schema.allow( { name: '$text', inside: '$root' } ); setData( model, 'x[]x' ); - insertContent( dataController, new Text( 'a' ), doc.selection ); + insertContent( data, new Text( 'a' ), doc.selection ); expect( getData( model ) ).to.equal( 'xa[]x' ); } ); @@ -66,7 +66,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); const content = new Element( 'image' ); @@ -76,7 +76,7 @@ describe( 'DataController utils', () => { setData( model, 'foo[]' ); - insertContent( dataController, content, doc.selection ); + insertContent( data, content, doc.selection ); expect( doc.getRoot().getChild( 0 ).getChild( 1 ) ).to.equal( content ); } ); @@ -86,7 +86,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); const schema = model.schema; @@ -217,7 +217,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); const schema = model.schema; @@ -289,7 +289,7 @@ describe( 'DataController utils', () => { ] ); setData( model, '[foo]' ); - insertContent( dataController, content, doc.selection ); + insertContent( data, content, doc.selection ); expect( getData( model ) ).to.equal( 'bar[]' ); } ); @@ -590,7 +590,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); const schema = model.schema; @@ -697,7 +697,7 @@ describe( 'DataController utils', () => { model = new Model(); doc = model.document; doc.createRoot(); - dataController = new DataController( model ); + data = new DataController( model ); const schema = model.schema; @@ -764,6 +764,6 @@ describe( 'DataController utils', () => { } ); } - insertContent( dataController, content, doc.selection ); + insertContent( data, content, doc.selection ); } } ); diff --git a/tests/controller/modifyselection.js b/tests/controller/modifyselection.js index 57484ed5f..f4f75bcfa 100644 --- a/tests/controller/modifyselection.js +++ b/tests/controller/modifyselection.js @@ -3,24 +3,25 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DataController from '../../src/controller/datacontroller'; import Selection from '../../src/model/selection'; import modifySelection from '../../src/controller/modifyselection'; import { setData, stringify } from '../../src/dev-utils/model'; -describe( 'DataController', () => { - let document, dataController; +describe( 'DataController utils', () => { + let model, doc, data; beforeEach( () => { - document = new Document(); - dataController = new DataController( document ); - document.schema.registerItem( 'p', '$block' ); - document.schema.registerItem( 'x', '$block' ); + model = new Model(); + doc = model.document; + data = new DataController( model ); - document.schema.allow( { name: 'x', inside: 'p' } ); + model.schema.registerItem( 'p', '$block' ); + model.schema.registerItem( 'x', '$block' ); + model.schema.allow( { name: 'x', inside: 'p' } ); - document.createRoot(); + doc.createRoot(); } ); describe( 'modifySelection', () => { @@ -65,12 +66,12 @@ describe( 'DataController', () => { ); it( 'extends one character backward', () => { - setData( document, '

fo[]o

', { lastRangeBackward: true } ); + setData( model, '

fo[]o

', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

f[o]o

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

f[o]o

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -80,12 +81,12 @@ describe( 'DataController', () => { ); it( 'extends one character backward (non-collapsed)', () => { - setData( document, '

foob[a]r

', { lastRangeBackward: true } ); + setData( model, '

foob[a]r

', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

foo[ba]r

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foo[ba]r

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -95,12 +96,12 @@ describe( 'DataController', () => { ); it( 'extends to element boundary (backward)', () => { - setData( document, '

f[]oo

' ); + setData( model, '

f[]oo

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

[f]oo

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[f]oo

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -111,12 +112,12 @@ describe( 'DataController', () => { ); it( 'shrinks backward selection (to collapsed)', () => { - setData( document, '

foo[b]ar

', { lastRangeBackward: true } ); + setData( model, '

foo[b]ar

', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection ); + modifySelection( data, doc.selection ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

foob[]ar

' ); - expect( document.selection.isBackward ).to.false; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foob[]ar

' ); + expect( doc.selection.isBackward ).to.false; } ); test( @@ -126,12 +127,12 @@ describe( 'DataController', () => { ); it( 'unicode support - combining mark backward', () => { - setData( document, '

foob̂[]ar

' ); + setData( model, '

foob̂[]ar

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

foo[b̂]ar

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foo[b̂]ar

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -141,12 +142,12 @@ describe( 'DataController', () => { ); it( 'unicode support - combining mark multiple backward', () => { - setData( document, '

foo̻̐ͩ[]bar

' ); + setData( model, '

foo̻̐ͩ[]bar

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

fo[o̻̐ͩ]bar

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

fo[o̻̐ͩ]bar

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -162,12 +163,12 @@ describe( 'DataController', () => { ); it( 'unicode support - surrogate pairs backward', () => { - setData( document, '

\uD83D\uDCA9[]

' ); + setData( model, '

\uD83D\uDCA9[]

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

[\uD83D\uDCA9]

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[\uD83D\uDCA9]

' ); + expect( doc.selection.isBackward ).to.true; } ); } ); @@ -179,12 +180,12 @@ describe( 'DataController', () => { ); it( 'extends over boundary of empty elements (backward)', () => { - setData( document, '

[]

' ); + setData( model, '

[]

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

[

]

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[

]

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -194,12 +195,12 @@ describe( 'DataController', () => { ); it( 'extends over boundary of non-empty elements (backward)', () => { - setData( document, '

a

[]bcd

' ); + setData( model, '

a

[]bcd

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

a[

]bcd

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

a[

]bcd

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -209,12 +210,12 @@ describe( 'DataController', () => { ); it( 'extends over character after boundary (backward)', () => { - setData( document, '

abc[

]d

', { lastRangeBackward: true } ); + setData( model, '

abc[

]d

', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

ab[c

]d

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

ab[c

]d

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -243,30 +244,30 @@ describe( 'DataController', () => { ); it( 'shrinks over boundary of empty elements', () => { - setData( document, '

[

]

', { lastRangeBackward: true } ); + setData( model, '

[

]

', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection ); + modifySelection( data, doc.selection ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

[]

' ); - expect( document.selection.isBackward ).to.false; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[]

' ); + expect( doc.selection.isBackward ).to.false; } ); it( 'shrinks over boundary of empty elements (backward)', () => { - setData( document, '

[

]

' ); + setData( model, '

[

]

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

[]

' ); - expect( document.selection.isBackward ).to.false; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[]

' ); + expect( doc.selection.isBackward ).to.false; } ); it( 'shrinks over boundary of non-empty elements', () => { - setData( document, '

a[

]b

', { lastRangeBackward: true } ); + setData( model, '

a[

]b

', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection ); + modifySelection( data, doc.selection ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

a

[]b

' ); - expect( document.selection.isBackward ).to.false; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

a

[]b

' ); + expect( doc.selection.isBackward ).to.false; } ); test( @@ -277,20 +278,20 @@ describe( 'DataController', () => { ); it( 'updates selection attributes', () => { - setData( document, '

<$text bold="true">foo[b]

' ); + setData( model, '

<$text bold="true">foo[b]

' ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

<$text bold="true">foo[]b

' ); - expect( document.selection.getAttribute( 'bold' ) ).to.equal( true ); + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

<$text bold="true">foo[]b

' ); + expect( doc.selection.getAttribute( 'bold' ) ).to.equal( true ); } ); } ); describe( 'beyond element – skipping incorrect positions', () => { beforeEach( () => { - document.schema.registerItem( 'quote' ); - document.schema.allow( { name: 'quote', inside: '$root' } ); - document.schema.allow( { name: '$block', inside: 'quote' } ); + model.schema.registerItem( 'quote' ); + model.schema.allow( { name: 'quote', inside: '$root' } ); + model.schema.allow( { name: '$block', inside: 'quote' } ); } ); test( @@ -336,13 +337,13 @@ describe( 'DataController', () => { describe( 'unit=codePoint', () => { it( 'does nothing on empty content', () => { - document.schema.allow( { name: '$text', inside: '$root' } ); + model.schema.allow( { name: '$text', inside: '$root' } ); - setData( document, '' ); + setData( model, '' ); - modifySelection( dataController, document.selection, { unit: 'codePoint' } ); + modifySelection( data, doc.selection, { unit: 'codePoint' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '[]' ); + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '[]' ); } ); test( @@ -360,12 +361,12 @@ describe( 'DataController', () => { ); it( 'extends one user-perceived character backward - latin letters', () => { - setData( document, '

fo[]o

' ); + setData( model, '

fo[]o

' ); - modifySelection( dataController, document.selection, { unit: 'codePoint', direction: 'backward' } ); + modifySelection( data, doc.selection, { unit: 'codePoint', direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

f[o]o

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

f[o]o

' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -376,15 +377,15 @@ describe( 'DataController', () => { ); it( 'unicode support - combining mark backward', () => { - setData( document, '

foob̂[]ar

' ); + setData( model, '

foob̂[]ar

' ); // Creating new instance of selection instead of operation on module:engine/model/document~Document#selection. // Document's selection will throw errors in some test cases (which are correct cases, but only for // non-document selections). - const testSelection = Selection.createFromSelection( document.selection ); - modifySelection( dataController, testSelection, { unit: 'codePoint', direction: 'backward' } ); + const testSelection = Selection.createFromSelection( doc.selection ); + modifySelection( data, testSelection, { unit: 'codePoint', direction: 'backward' } ); - expect( stringify( document.getRoot(), testSelection ) ).to.equal( '

foob[̂]ar

' ); + expect( stringify( doc.getRoot(), testSelection ) ).to.equal( '

foob[̂]ar

' ); expect( testSelection.isBackward ).to.true; } ); @@ -403,25 +404,25 @@ describe( 'DataController', () => { ); it( 'unicode support surrogate pairs backward', () => { - setData( document, '

\uD83D\uDCA9[]

' ); + setData( model, '

\uD83D\uDCA9[]

' ); - modifySelection( dataController, document.selection, { unit: 'codePoint', direction: 'backward' } ); + modifySelection( data, doc.selection, { unit: 'codePoint', direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '

[\uD83D\uDCA9]

' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[\uD83D\uDCA9]

' ); + expect( doc.selection.isBackward ).to.true; } ); } ); describe( 'objects handling', () => { beforeEach( () => { - document.schema.registerItem( 'obj' ); - document.schema.allow( { name: 'obj', inside: '$root' } ); - document.schema.allow( { name: '$text', inside: 'obj' } ); - document.schema.objects.add( 'obj' ); - - document.schema.registerItem( 'inlineObj', '$inline' ); - document.schema.allow( { name: '$text', inside: 'inlineObj' } ); - document.schema.objects.add( 'inlineObj' ); + model.schema.registerItem( 'obj' ); + model.schema.allow( { name: 'obj', inside: '$root' } ); + model.schema.allow( { name: '$text', inside: 'obj' } ); + model.schema.objects.add( 'obj' ); + + model.schema.registerItem( 'inlineObj', '$inline' ); + model.schema.allow( { name: '$text', inside: 'inlineObj' } ); + model.schema.objects.add( 'inlineObj' ); } ); test( @@ -444,12 +445,12 @@ describe( 'DataController', () => { ); it( 'extends over object elements - backward', () => { - setData( document, '[]', { lastRangeBackward: true } ); + setData( model, '[]', { lastRangeBackward: true } ); - modifySelection( dataController, document.selection, { direction: 'backward' } ); + modifySelection( data, doc.selection, { direction: 'backward' } ); - expect( stringify( document.getRoot(), document.selection ) ).to.equal( '[]' ); - expect( document.selection.isBackward ).to.true; + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '[]' ); + expect( doc.selection.isBackward ).to.true; } ); test( @@ -481,16 +482,16 @@ describe( 'DataController', () => { describe( 'limits handling', () => { beforeEach( () => { - document.schema.registerItem( 'inlineLimit' ); - document.schema.allow( { name: 'inlineLimit', inside: '$block' } ); - document.schema.allow( { name: '$text', inside: 'inlineLimit' } ); + model.schema.registerItem( 'inlineLimit' ); + model.schema.allow( { name: 'inlineLimit', inside: '$block' } ); + model.schema.allow( { name: '$text', inside: 'inlineLimit' } ); - document.schema.registerItem( 'blockLimit' ); - document.schema.allow( { name: 'blockLimit', inside: '$root' } ); - document.schema.allow( { name: 'p', inside: 'blockLimit' } ); + model.schema.registerItem( 'blockLimit' ); + model.schema.allow( { name: 'blockLimit', inside: '$root' } ); + model.schema.allow( { name: 'p', inside: 'blockLimit' } ); - document.schema.limits.add( 'inlineLimit' ); - document.schema.limits.add( 'blockLimit' ); + model.schema.limits.add( 'inlineLimit' ); + model.schema.limits.add( 'blockLimit' ); } ); test( @@ -542,15 +543,15 @@ describe( 'DataController', () => { input = input.normalize(); output = output.normalize(); - setData( document, input ); + setData( model, input ); // Creating new instance of selection instead of operation on module:engine/model/document~Document#selection. // Document's selection will throw errors in some test cases (which are correct cases, but only for // non-document selections). - const testSelection = Selection.createFromSelection( document.selection ); - modifySelection( dataController, testSelection, options ); + const testSelection = Selection.createFromSelection( doc.selection ); + modifySelection( data, testSelection, options ); - expect( stringify( document.getRoot(), testSelection ) ).to.equal( output ); + expect( stringify( doc.getRoot(), testSelection ) ).to.equal( output ); } ); } } ); From 76c5852a448d5af5ec19f1cdd1caa86bcdfb6385 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 8 Dec 2017 12:28:34 +0100 Subject: [PATCH 125/724] Aligned DeltaReplayer with engine changes. --- src/dev-utils/deltareplayer.js | 17 ++++----- tests/dev-utils/deltareplayer.js | 63 ++++++++++++++++---------------- 2 files changed, 40 insertions(+), 40 deletions(-) diff --git a/src/dev-utils/deltareplayer.js b/src/dev-utils/deltareplayer.js index 8369c241c..a35f37c6f 100644 --- a/src/dev-utils/deltareplayer.js +++ b/src/dev-utils/deltareplayer.js @@ -16,12 +16,12 @@ import DeltaFactory from '../model/delta/deltafactory'; */ export default class DeltaReplayer { /** - * @param {module:engine/model/document~Document} document Document to replay deltas on. + * @param {module:engine/model/model~Model} model Data model. * @param {String} logSeparator Separator between deltas. * @param {String} stringifiedDeltas Deltas to replay. */ - constructor( document, logSeparator, stringifiedDeltas ) { - this._document = document; + constructor( model, logSeparator, stringifiedDeltas ) { + this._model = model; this._logSeparator = logSeparator; this.setStringifiedDeltas( stringifiedDeltas ); } @@ -118,23 +118,22 @@ export default class DeltaReplayer { * @returns {Promise.} */ applyNextDelta() { - const document = this._document; + const model = this._model; return new Promise( res => { - document.enqueueChanges( () => { + model.enqueueChange( writer => { const jsonDelta = this._deltasToReplay.shift(); if ( !jsonDelta ) { return res( true ); } - const delta = DeltaFactory.fromJSON( jsonDelta, this._document ); + const delta = DeltaFactory.fromJSON( jsonDelta, model.document ); - const batch = document.batch(); - batch.addDelta( delta ); + writer.batch.addDelta( delta ); for ( const operation of delta.operations ) { - document.applyOperation( operation ); + model.applyOperation( operation ); } res( false ); diff --git a/tests/dev-utils/deltareplayer.js b/tests/dev-utils/deltareplayer.js index bd22358e7..a0977b355 100644 --- a/tests/dev-utils/deltareplayer.js +++ b/tests/dev-utils/deltareplayer.js @@ -4,23 +4,23 @@ */ import DeltaReplayer from '../../src/dev-utils/deltareplayer'; -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; describe( 'DeltaReplayer', () => { describe( 'constructor()', () => { it( 'should be able to initialize replayer without deltas', () => { - const doc = getDocument(); + const model = getModel(); const stringifiedDeltas = ''; - const deltaReplayer = new DeltaReplayer( doc, '---', stringifiedDeltas ); + const deltaReplayer = new DeltaReplayer( model, '---', stringifiedDeltas ); expect( deltaReplayer.getDeltasToReplay() ).to.deep.equal( [] ); } ); it( 'should be able to initialize replayer with deltas', () => { - const doc = getDocument(); + const model = getModel(); const delta = getFirstDelta(); - const deltaReplayer = new DeltaReplayer( doc, '---', JSON.stringify( delta ) ); + const deltaReplayer = new DeltaReplayer( model, '---', JSON.stringify( delta ) ); expect( deltaReplayer.getDeltasToReplay() ).to.deep.equal( [ delta ] ); } ); @@ -28,10 +28,10 @@ describe( 'DeltaReplayer', () => { describe( 'applyNextDelta()', () => { it( 'should remove first delta from stack', () => { - const doc = getDocument(); + const model = getModel(); const delta = getFirstDelta(); - const deltaReplayer = new DeltaReplayer( doc, '---', JSON.stringify( delta ) ); + const deltaReplayer = new DeltaReplayer( model, '---', JSON.stringify( delta ) ); return deltaReplayer.applyNextDelta().then( isFinished => { expect( deltaReplayer.getDeltasToReplay() ).to.deep.equal( [] ); @@ -40,19 +40,19 @@ describe( 'DeltaReplayer', () => { } ); it( 'should apply first delta on the document', () => { - const doc = getDocument(); + const model = getModel(); const delta = getFirstDelta(); - const deltaReplayer = new DeltaReplayer( doc, '---', JSON.stringify( delta ) ); + const deltaReplayer = new DeltaReplayer( model, '---', JSON.stringify( delta ) ); return deltaReplayer.applyNextDelta().then( () => { - expect( Array.from( doc.getRoot().getChildren() ).length ).to.equal( 1 ); + expect( Array.from( model.document.getRoot().getChildren() ).length ).to.equal( 1 ); } ); } ); it( 'should resolve with true if 0 deltas are provided', () => { - const doc = getDocument(); - const deltaReplayer = new DeltaReplayer( doc, '---', '' ); + const model = getModel(); + const deltaReplayer = new DeltaReplayer( model, '---', '' ); return deltaReplayer.applyNextDelta().then( isFinished => { expect( isFinished ).to.equal( true ); @@ -62,16 +62,16 @@ describe( 'DeltaReplayer', () => { describe( 'applyAllDeltas()', () => { it( 'should apply all deltas on the document', () => { - const doc = getDocument(); + const model = getModel(); const stringifiedDeltas = [ getFirstDelta(), getSecondDelta() ] .map( d => JSON.stringify( d ) ) .join( '---' ); - const deltaReplayer = new DeltaReplayer( doc, '---', stringifiedDeltas ); + const deltaReplayer = new DeltaReplayer( model, '---', stringifiedDeltas ); return deltaReplayer.applyAllDeltas().then( () => { - expect( Array.from( doc.getRoot().getChildren() ).length ).to.equal( 2 ); + expect( Array.from( model.document.getRoot().getChildren() ).length ).to.equal( 2 ); expect( deltaReplayer.getDeltasToReplay().length ).to.equal( 0 ); } ); } ); @@ -79,31 +79,31 @@ describe( 'DeltaReplayer', () => { describe( 'applyDeltas()', () => { it( 'should apply certain number of deltas on the document', () => { - const doc = getDocument(); + const model = getModel(); const stringifiedDeltas = [ getFirstDelta(), getSecondDelta() ] .map( d => JSON.stringify( d ) ) .join( '---' ); - const deltaReplayer = new DeltaReplayer( doc, '---', stringifiedDeltas ); + const deltaReplayer = new DeltaReplayer( model, '---', stringifiedDeltas ); return deltaReplayer.applyDeltas( 1 ).then( () => { - expect( Array.from( doc.getRoot().getChildren() ).length ).to.equal( 1 ); + expect( Array.from( model.document.getRoot().getChildren() ).length ).to.equal( 1 ); expect( deltaReplayer.getDeltasToReplay().length ).to.equal( 1 ); } ); } ); it( 'should not throw an error if the number of deltas is lower than number of expected deltas to replay', () => { - const doc = getDocument(); + const model = getModel(); const stringifiedDeltas = [ getFirstDelta(), getSecondDelta() ] .map( d => JSON.stringify( d ) ) .join( '---' ); - const deltaReplayer = new DeltaReplayer( doc, '---', stringifiedDeltas ); + const deltaReplayer = new DeltaReplayer( model, '---', stringifiedDeltas ); return deltaReplayer.applyDeltas( 3 ).then( () => { - expect( Array.from( doc.getRoot().getChildren() ).length ).to.equal( 2 ); + expect( Array.from( model.document.getRoot().getChildren() ).length ).to.equal( 2 ); expect( deltaReplayer.getDeltasToReplay().length ).to.equal( 0 ); } ); } ); @@ -111,13 +111,13 @@ describe( 'DeltaReplayer', () => { describe( 'play()', () => { it( 'should play deltas with time interval', () => { - const doc = getDocument(); + const model = getModel(); const stringifiedDeltas = [ getFirstDelta(), getSecondDelta() ] .map( d => JSON.stringify( d ) ) .join( '---' ); - const deltaReplayer = new DeltaReplayer( doc, '---', stringifiedDeltas ); + const deltaReplayer = new DeltaReplayer( model, '---', stringifiedDeltas ); return deltaReplayer.play( 0 ).then( () => { expect( deltaReplayer.getDeltasToReplay().length ).to.equal( 0 ); @@ -125,15 +125,15 @@ describe( 'DeltaReplayer', () => { } ); it( 'should work with default time interval', () => { - const doc = getDocument(); + const model = getModel(); - const deltaReplayer = new DeltaReplayer( doc, '---', '' ); + const deltaReplayer = new DeltaReplayer( model, '---', '' ); return deltaReplayer.play(); } ); it( 'should correctly handle errors coming from the engine', () => { - const doc = getDocument(); + const model = getModel(); const invalidDelta = getSecondDelta(); invalidDelta.operations[ 0 ].baseVersion = 3; @@ -142,7 +142,7 @@ describe( 'DeltaReplayer', () => { .map( d => JSON.stringify( d ) ) .join( '---' ); - const deltaReplayer = new DeltaReplayer( doc, '---', stringifiedDeltas ); + const deltaReplayer = new DeltaReplayer( model, '---', stringifiedDeltas ); return deltaReplayer.play( 1 ) .then( () => { @@ -154,11 +154,12 @@ describe( 'DeltaReplayer', () => { } ); } ); -function getDocument() { - const doc = new Document(); - doc.createRoot( 'main' ); +function getModel() { + const model = new Model(); - return doc; + model.document.createRoot(); + + return model; } function getFirstDelta() { From 0e13e7dbc90e71429686257a1cad6cf85bf8aafc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sat, 9 Dec 2017 10:44:36 +0100 Subject: [PATCH 126/724] Aligned Deltas with engine changes. --- tests/model/delta/attributedelta.js | 9 ++++---- tests/model/delta/delta.js | 7 ++++--- tests/model/delta/deltafactory.js | 9 ++++---- tests/model/delta/insertdelta.js | 6 ++++-- tests/model/delta/markerdelta.js | 6 ++++-- tests/model/delta/mergedelta.js | 6 ++++-- tests/model/delta/movedelta.js | 6 ++++-- tests/model/delta/renamedelta.js | 23 +++++++++++---------- tests/model/delta/splitdelta.js | 6 ++++-- tests/model/delta/transform/_utils/utils.js | 7 ++++--- tests/model/delta/transform/transform.js | 6 ++++-- tests/model/delta/unwrapdelta.js | 6 ++++-- tests/model/delta/wrapdelta.js | 6 ++++-- 13 files changed, 62 insertions(+), 41 deletions(-) diff --git a/tests/model/delta/attributedelta.js b/tests/model/delta/attributedelta.js index d1eb4a88f..2144e51e7 100644 --- a/tests/model/delta/attributedelta.js +++ b/tests/model/delta/attributedelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Range from '../../../src/model/range'; import Position from '../../../src/model/position'; import AttributeDelta from '../../../src/model/delta/attributedelta'; @@ -12,11 +12,12 @@ import NoOperation from '../../../src/model/operation/nooperation'; import { jsonParseStringify } from '../../../tests/model/_utils/utils'; describe( 'AttributeDelta', () => { - let doc, root, delta; + let root, delta; beforeEach( () => { - doc = new Document(); - root = doc.createRoot(); + const model = new Model(); + + root = model.document.createRoot(); delta = new AttributeDelta(); } ); diff --git a/tests/model/delta/delta.js b/tests/model/delta/delta.js index 3f7899374..69e2fdb8c 100644 --- a/tests/model/delta/delta.js +++ b/tests/model/delta/delta.js @@ -14,7 +14,7 @@ import ReinsertOperation from '../../../src/model/operation/reinsertoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import RootAttributeOperation from '../../../src/model/operation/rootattributeoperation'; import DeltaFactory from '../../../src/model/delta/deltafactory'; -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import Range from '../../../src/model/range'; import { jsonParseStringify } from '../../../tests/model/_utils/utils'; @@ -148,9 +148,10 @@ describe( 'Delta', () => { } ); beforeEach( () => { - delta = new FooDelta(); + const model = new Model(); - doc = new Document(); + delta = new FooDelta(); + doc = model.document; root = doc.createRoot(); } ); diff --git a/tests/model/delta/deltafactory.js b/tests/model/delta/deltafactory.js index b02d33bff..ea76a6583 100644 --- a/tests/model/delta/deltafactory.js +++ b/tests/model/delta/deltafactory.js @@ -18,7 +18,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import DeltaFactory from '../../../src/model/delta/deltafactory'; -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import Range from '../../../src/model/range'; import { jsonParseStringify } from '../../../tests/model/_utils/utils'; @@ -44,15 +44,16 @@ describe( 'DeltaFactory', () => { } ); beforeEach( () => { - delta = new FooDelta(); + const model = new Model(); - doc = new Document(); + delta = new FooDelta(); + doc = model.document; root = doc.createRoot(); } ); it( 'should throw error for unregistered delta', () => { expect( () => { - DeltaFactory.fromJSON( jsonParseStringify( new BarDelta() ), {} ); + DeltaFactory.fromJSON( jsonParseStringify( new BarDelta() ), doc ); } ).to.throw( CKEditorError, /^delta-fromjson-no-deserializer/ ); } ); diff --git a/tests/model/delta/insertdelta.js b/tests/model/delta/insertdelta.js index 9ee9467cf..5a7aeed4a 100644 --- a/tests/model/delta/insertdelta.js +++ b/tests/model/delta/insertdelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Element from '../../../src/model/element'; import Position from '../../../src/model/position'; @@ -17,7 +17,9 @@ describe( 'InsertDelta', () => { let insertDelta, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); insertDelta = new InsertDelta(); } ); diff --git a/tests/model/delta/markerdelta.js b/tests/model/delta/markerdelta.js index 87673a073..6995714bc 100644 --- a/tests/model/delta/markerdelta.js +++ b/tests/model/delta/markerdelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Range from '../../../src/model/range'; import MarkerDelta from '../../../src/model/delta/markerdelta'; @@ -13,7 +13,9 @@ describe( 'MarkerDelta', () => { let markerDelta, doc, root, range; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); range = Range.createIn( root ); markerDelta = new MarkerDelta(); diff --git a/tests/model/delta/mergedelta.js b/tests/model/delta/mergedelta.js index 96c123a3c..8940df10f 100644 --- a/tests/model/delta/mergedelta.js +++ b/tests/model/delta/mergedelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import MergeDelta from '../../../src/model/delta/mergedelta'; @@ -17,7 +17,9 @@ describe( 'MergeDelta', () => { let mergeDelta, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); mergeDelta = new MergeDelta(); } ); diff --git a/tests/model/delta/movedelta.js b/tests/model/delta/movedelta.js index f90c6b412..aa9fe48d7 100644 --- a/tests/model/delta/movedelta.js +++ b/tests/model/delta/movedelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import MoveDelta from '../../../src/model/delta/movedelta'; @@ -13,7 +13,9 @@ describe( 'MoveDelta', () => { let moveDelta, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); moveDelta = new MoveDelta(); } ); diff --git a/tests/model/delta/renamedelta.js b/tests/model/delta/renamedelta.js index 991bd214b..f12e0d4f4 100644 --- a/tests/model/delta/renamedelta.js +++ b/tests/model/delta/renamedelta.js @@ -3,17 +3,18 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; import RenameDelta from '../../../src/model/delta/renamedelta'; describe( 'RenameDelta', () => { - let renameDelta, doc, root; + let renameDelta, model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); renameDelta = new RenameDelta(); } ); @@ -40,18 +41,18 @@ describe( 'RenameDelta', () => { it( 'should return correct RenameDelta', () => { root.appendChildren( new Element( 'p', null, new Text( 'abc' ) ) ); - const batch = doc.batch(); + model.change( writer => { + writer.rename( root.getChild( 0 ), 'h' ); - batch.rename( root.getChild( 0 ), 'h' ); + const reversed = writer.batch.deltas[ 0 ].getReversed(); - const reversed = batch.deltas[ 0 ].getReversed(); + reversed.operations.forEach( operation => { + model.applyOperation( operation ); + } ); - reversed.operations.forEach( operation => { - doc.applyOperation( operation ); + expect( root.maxOffset ).to.equal( 1 ); + expect( root.getChild( 0 ) ).to.have.property( 'name', 'p' ); } ); - - expect( root.maxOffset ).to.equal( 1 ); - expect( root.getChild( 0 ) ).to.have.property( 'name', 'p' ); } ); } ); diff --git a/tests/model/delta/splitdelta.js b/tests/model/delta/splitdelta.js index 2503d1cc3..c7d7f6a1f 100644 --- a/tests/model/delta/splitdelta.js +++ b/tests/model/delta/splitdelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import Element from '../../../src/model/element'; @@ -19,7 +19,9 @@ describe( 'SplitDelta', () => { let splitDelta, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); splitDelta = new SplitDelta(); } ); diff --git a/tests/model/delta/transform/_utils/utils.js b/tests/model/delta/transform/_utils/utils.js index aa7a56316..b20146e42 100644 --- a/tests/model/delta/transform/_utils/utils.js +++ b/tests/model/delta/transform/_utils/utils.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../../../src/model/document'; +import Model from '../../../../../src/model/model'; import Element from '../../../../../src/model/element'; import Text from '../../../../../src/model/text'; @@ -216,12 +216,13 @@ export function expectOperation( op, params ) { export function applyDelta( delta, document ) { for ( const op of delta.operations ) { - document.applyOperation( op ); + document.model.applyOperation( op ); } } export function getFilledDocument() { - const doc = new Document(); + const model = new Model(); + const doc = model.document; const root = doc.createRoot(); root.insertChildren( 0, [ diff --git a/tests/model/delta/transform/transform.js b/tests/model/delta/transform/transform.js index 7aa253236..d111e109c 100644 --- a/tests/model/delta/transform/transform.js +++ b/tests/model/delta/transform/transform.js @@ -7,7 +7,7 @@ import transformations from '../../../../src/model/delta/basic-transformations'; import deltaTransform from '../../../../src/model/delta/transform'; const transformDeltaSets = deltaTransform.transformDeltaSets; -import Document from '../../../../src/model/document'; +import Model from '../../../../src/model/model'; import Element from '../../../../src/model/element'; import Text from '../../../../src/model/text'; import Position from '../../../../src/model/position'; @@ -39,7 +39,9 @@ describe( 'transform', () => { let doc, root, baseVersion; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); root.appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) ); diff --git a/tests/model/delta/unwrapdelta.js b/tests/model/delta/unwrapdelta.js index 6cdeca743..6ec74eada 100644 --- a/tests/model/delta/unwrapdelta.js +++ b/tests/model/delta/unwrapdelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import UnwrapDelta from '../../../src/model/delta/unwrapdelta'; @@ -17,7 +17,9 @@ describe( 'UnwrapDelta', () => { let unwrapDelta, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); unwrapDelta = new UnwrapDelta(); } ); diff --git a/tests/model/delta/wrapdelta.js b/tests/model/delta/wrapdelta.js index 2315f692a..a71e76623 100644 --- a/tests/model/delta/wrapdelta.js +++ b/tests/model/delta/wrapdelta.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Position from '../../../src/model/position'; import Element from '../../../src/model/element'; @@ -18,7 +18,9 @@ describe( 'WrapDelta', () => { let wrapDelta, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); wrapDelta = new WrapDelta(); } ); From ded76f6ceed02dc1b1ec1130477d27ed47c76c64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sun, 10 Dec 2017 19:41:34 +0100 Subject: [PATCH 127/724] Typo. --- tests/model/_utils/utils.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/model/_utils/utils.js b/tests/model/_utils/utils.js index 62e1ec76d..7dcecc300 100644 --- a/tests/model/_utils/utils.js +++ b/tests/model/_utils/utils.js @@ -39,7 +39,7 @@ export function getNodesAndText( range ) { } /** - * Returns object JSON representation. It pases an object by JSON.stringify and JSON.parse functions. + * Returns object JSON representation. It passes an object by JSON.stringify and JSON.parse functions. * * @param {Object|Array} object */ From 44683883758c4b595e02fe5916a447fed98b5e5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sun, 10 Dec 2017 19:42:51 +0100 Subject: [PATCH 128/724] Aligned Document tests with engine changes. --- tests/model/document/change-event.js | 24 +++--- tests/model/document/document.js | 121 +++++++-------------------- 2 files changed, 41 insertions(+), 104 deletions(-) diff --git a/tests/model/document/change-event.js b/tests/model/document/change-event.js index c537f34aa..3cce73089 100644 --- a/tests/model/document/change-event.js +++ b/tests/model/document/change-event.js @@ -3,6 +3,7 @@ * For licensing, see LICENSE.md. */ +import Model from '../../../src/model/model'; import Document from '../../../src/model/document'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; @@ -15,10 +16,11 @@ import RemoveOperation from '../../../src/model/operation/removeoperation'; import { wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'Document change event', () => { - let doc, root, graveyard, types, changes; + let model, doc, root, graveyard, types, changes; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = new Document( model ); root = doc.createRoot(); graveyard = doc.graveyard; @@ -32,7 +34,7 @@ describe( 'Document change event', () => { } ); it( 'should be fired when text is inserted', () => { - doc.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), 'foo', doc.version ) ) ); + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), 'foo', doc.version ) ) ); expect( changes ).to.have.length( 1 ); expect( types[ 0 ] ).to.equal( 'insert' ); @@ -41,7 +43,7 @@ describe( 'Document change event', () => { it( 'should be fired when element is inserted', () => { const element = new Element( 'p' ); - doc.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), element, doc.version ) ) ); + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), element, doc.version ) ) ); expect( changes ).to.have.length( 1 ); expect( types[ 0 ] ).to.equal( 'insert' ); @@ -50,7 +52,7 @@ describe( 'Document change event', () => { it( 'should be fired when nodes are inserted', () => { const element = new Element( 'p' ); - doc.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), [ element, 'foo' ], doc.version ) ) ); + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), [ element, 'foo' ], doc.version ) ) ); expect( changes ).to.have.length( 1 ); expect( types[ 0 ] ).to.equal( 'insert' ); @@ -65,7 +67,7 @@ describe( 'Document change event', () => { root.insertChildren( 0, [ p1, p2 ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 0, 0 ] ), 3, @@ -84,10 +86,10 @@ describe( 'Document change event', () => { root.insertChildren( 0, new Text( 'foo' ) ); const removeOperation = new RemoveOperation( new Position( root, [ 0 ] ), 3, new Position( doc.graveyard, [ 0 ] ), doc.version ); - doc.applyOperation( wrapInDelta( removeOperation ) ); + model.applyOperation( wrapInDelta( removeOperation ) ); const reinsertOperation = removeOperation.getReversed(); - doc.applyOperation( wrapInDelta( reinsertOperation ) ); + model.applyOperation( wrapInDelta( reinsertOperation ) ); expect( changes ).to.have.length( 2 ); @@ -103,7 +105,7 @@ describe( 'Document change event', () => { it( 'should be fired when attribute is inserted', () => { root.insertChildren( 0, new Text( 'foo' ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( Range.createFromParentsAndOffsets( root, 0, root, 3 ), 'key', @@ -125,7 +127,7 @@ describe( 'Document change event', () => { const elem = new Element( 'p', { key: 'old' } ); root.insertChildren( 0, elem ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( Range.createFromParentsAndOffsets( root, 0, elem, 0 ), 'key', @@ -147,7 +149,7 @@ describe( 'Document change event', () => { const elem = new Element( 'p', { key: 'old' } ); root.insertChildren( 0, elem ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( Range.createFromParentsAndOffsets( root, 0, elem, 0 ), 'key', diff --git a/tests/model/document/document.js b/tests/model/document/document.js index a698870c8..b274b8d17 100644 --- a/tests/model/document/document.js +++ b/tests/model/document/document.js @@ -3,8 +3,8 @@ * For licensing, see LICENSE.md. */ +import Model from '../../../src/model/model'; import Document from '../../../src/model/document'; -import Schema from '../../../src/model/schema'; import RootElement from '../../../src/model/rootelement'; import Batch from '../../../src/model/batch'; import Delta from '../../../src/model/delta/delta'; @@ -17,21 +17,27 @@ import { jsonParseStringify } from '../../../tests/model/_utils/utils'; import { setData, getData } from '../../../src/dev-utils/model'; describe( 'Document', () => { - let doc; + let model, doc; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = new Document( model ); + + // Normally Model is the one who creates Document instance and keeps it as reference. + // We have to be sure that Model uses the right Document instance. + model.document = doc; } ); describe( 'constructor()', () => { it( 'should create Document with no data, empty graveyard and selection set to default range', () => { + const doc = new Document( model ); + + expect( doc ).to.have.property( 'model' ).to.equal( model ); expect( doc ).to.have.property( 'roots' ).that.is.instanceof( Map ); expect( doc.roots.size ).to.equal( 1 ); expect( doc.graveyard ).to.be.instanceof( RootElement ); expect( doc.graveyard.maxOffset ).to.equal( 0 ); expect( count( doc.selection.getRanges() ) ).to.equal( 1 ); - - expect( doc.schema ).to.be.instanceof( Schema ); } ); } ); @@ -109,7 +115,7 @@ describe( 'Document', () => { } ); } ); - describe( 'applyOperation()', () => { + describe.skip( 'applyOperation()', () => { it( 'should increase document version, execute operation and fire event with proper data ' + 'when operation is a document operation', () => { const changeCallback = sinon.spy(); @@ -130,7 +136,7 @@ describe( 'Document', () => { batch.addDelta( delta ); doc.on( 'change', changeCallback ); - doc.applyOperation( operation ); + model.applyOperation( operation ); expect( doc.version ).to.equal( 1 ); expect( doc.history._deltas.length ).to.equal( 1 ); @@ -163,7 +169,7 @@ describe( 'Document', () => { batch.addDelta( delta ); doc.on( 'change', changeCallback ); - doc.applyOperation( operation ); + model.applyOperation( operation ); expect( doc.version ).to.equal( 0 ); expect( doc.history._deltas.length ).to.equal( 0 ); @@ -179,84 +185,12 @@ describe( 'Document', () => { expect( () => { - doc.applyOperation( operation ); + model.applyOperation( operation ); } ).to.throw( CKEditorError, /^model-document-applyOperation-wrong-version/ ); } ); } ); - describe( 'batch()', () => { - it( 'should create a new batch with the document property', () => { - const batch = doc.batch(); - - expect( batch ).to.be.instanceof( Batch ); - expect( batch ).to.have.property( 'document' ).that.equals( doc ); - } ); - - it( 'should set given batch type', () => { - const batch = doc.batch( 'ignore' ); - - expect( batch ).to.have.property( 'type' ).that.equals( 'ignore' ); - } ); - } ); - - describe( 'enqueue()', () => { - it( 'should be executed immediately and fire changesDone event', () => { - const order = []; - - doc.on( 'changesDone', () => order.push( 'done' ) ); - - doc.enqueueChanges( () => order.push( 'enqueue1' ) ); - - expect( order ).to.have.length( 2 ); - expect( order[ 0 ] ).to.equal( 'enqueue1' ); - expect( order[ 1 ] ).to.equal( 'done' ); - } ); - - it( 'should fire done every time queue is empty', () => { - const order = []; - - doc.on( 'changesDone', () => order.push( 'done' ) ); - - doc.enqueueChanges( () => order.push( 'enqueue1' ) ); - doc.enqueueChanges( () => order.push( 'enqueue2' ) ); - - expect( order ).to.have.length( 4 ); - expect( order[ 0 ] ).to.equal( 'enqueue1' ); - expect( order[ 1 ] ).to.equal( 'done' ); - expect( order[ 2 ] ).to.equal( 'enqueue2' ); - expect( order[ 3 ] ).to.equal( 'done' ); - } ); - - it( 'should put callbacks in the proper order', () => { - const order = []; - - doc.on( 'changesDone', () => order.push( 'done' ) ); - - doc.enqueueChanges( () => { - order.push( 'enqueue1 start' ); - doc.enqueueChanges( () => { - order.push( 'enqueue2 start' ); - doc.enqueueChanges( () => order.push( 'enqueue4' ) ); - order.push( 'enqueue2 end' ); - } ); - - doc.enqueueChanges( () => order.push( 'enqueue3' ) ); - - order.push( 'enqueue1 end' ); - } ); - - expect( order ).to.have.length( 7 ); - expect( order[ 0 ] ).to.equal( 'enqueue1 start' ); - expect( order[ 1 ] ).to.equal( 'enqueue1 end' ); - expect( order[ 2 ] ).to.equal( 'enqueue2 start' ); - expect( order[ 3 ] ).to.equal( 'enqueue2 end' ); - expect( order[ 4 ] ).to.equal( 'enqueue3' ); - expect( order[ 5 ] ).to.equal( 'enqueue4' ); - expect( order[ 6 ] ).to.equal( 'done' ); - } ); - } ); - describe( 'selection', () => { it( 'should get updated attributes whenever attribute operation is applied', () => { sinon.spy( doc.selection, '_updateAttributes' ); @@ -313,18 +247,18 @@ describe( 'Document', () => { let selection; beforeEach( () => { - doc.schema.registerItem( 'paragraph', '$block' ); + model.schema.registerItem( 'paragraph', '$block' ); - doc.schema.registerItem( 'emptyBlock' ); - doc.schema.allow( { name: 'emptyBlock', inside: '$root' } ); + model.schema.registerItem( 'emptyBlock' ); + model.schema.allow( { name: 'emptyBlock', inside: '$root' } ); - doc.schema.registerItem( 'widget' ); - doc.schema.allow( { name: 'widget', inside: '$root' } ); - doc.schema.objects.add( 'widget' ); + model.schema.registerItem( 'widget' ); + model.schema.allow( { name: 'widget', inside: '$root' } ); + model.schema.objects.add( 'widget' ); - doc.schema.registerItem( 'blockWidget', '$block' ); - doc.schema.allow( { name: 'blockWidget', inside: '$root' } ); - doc.schema.objects.add( 'blockWidget' ); + model.schema.registerItem( 'blockWidget', '$block' ); + model.schema.allow( { name: 'blockWidget', inside: '$root' } ); + model.schema.objects.add( 'blockWidget' ); doc.createRoot(); selection = doc.selection; @@ -524,14 +458,14 @@ describe( 'Document', () => { function test( testName, data, direction, expected ) { it( testName, () => { - setData( doc, data ); + setData( model, data ); const range = doc.getNearestSelectionRange( selection.anchor, direction ); if ( expected === null ) { expect( range ).to.be.null; } else { selection.setRanges( [ range ] ); - expect( getData( doc ) ).to.equal( expected ); + expect( getData( model ) ).to.equal( expected ); } } ); } @@ -589,7 +523,8 @@ describe( 'Document', () => { } ); } ); - it( 'should be correctly converted to json', () => { + // @TODO: What for is this test? + it.skip( 'should be correctly converted to json', () => { expect( jsonParseStringify( doc ).selection ).to.equal( '[engine.model.DocumentSelection]' ); } ); } ); From 98d6506bb11683b45a1d0094dae1f8122c94f8ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sun, 10 Dec 2017 19:43:44 +0100 Subject: [PATCH 129/724] Aligned view tests with engine changes. --- .../whitespace-handling-integration.js | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/tests/view/domconverter/whitespace-handling-integration.js b/tests/view/domconverter/whitespace-handling-integration.js index 3fab4283d..46b0b4520 100644 --- a/tests/view/domconverter/whitespace-handling-integration.js +++ b/tests/view/domconverter/whitespace-handling-integration.js @@ -28,7 +28,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'new line at the end of the content is ignored', () => { editor.setData( '

foo

\n' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -37,7 +37,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'whitespaces at the end of the content are ignored', () => { editor.setData( '

foo

\n\r\n \t' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -47,7 +47,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'nbsp at the end of the content is not ignored', () => { editor.setData( '

foo

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -56,7 +56,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'new line at the beginning of the content is ignored', () => { editor.setData( '\n

foo

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -65,7 +65,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'whitespaces at the beginning of the content are ignored', () => { editor.setData( '\n\n \t

foo

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -75,7 +75,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'nbsp at the beginning of the content is not ignored', () => { editor.setData( '

foo

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -84,7 +84,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'new line between blocks is ignored', () => { editor.setData( '

foo

\n

bar

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foobar' ); expect( editor.getData() ).to.equal( '

foo

bar

' ); @@ -93,7 +93,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'whitespaces between blocks are ignored', () => { editor.setData( '

foo

\n\n \t

bar

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foobar' ); expect( editor.getData() ).to.equal( '

foo

bar

' ); @@ -103,7 +103,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'nbsp between blocks is not ignored', () => { editor.setData( '

foo

 

bar

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foobar' ); expect( editor.getData() ).to.equal( '

foo

bar

' ); @@ -112,7 +112,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'new lines inside blocks are ignored', () => { editor.setData( '

\nfoo\n

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -121,7 +121,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'whitespaces inside blocks are ignored', () => { editor.setData( '

\n\n \tfoo\n\n \t

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foo' ); expect( editor.getData() ).to.equal( '

foo

' ); @@ -130,7 +130,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'nbsp inside blocks are not ignored', () => { editor.setData( '

 foo 

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( ' foo ' ); expect( editor.getData() ).to.equal( '

 foo 

' ); @@ -139,7 +139,7 @@ describe( 'DomConverter – whitespace handling – integration', () => { it( 'all whitespaces together are ignored', () => { editor.setData( '\n

foo\n\r\n \t

\n

bar

' ); - expect( getData( editor.document, { withoutSelection: true } ) ) + expect( getData( editor.model, { withoutSelection: true } ) ) .to.equal( 'foobar' ); expect( editor.getData() ).to.equal( '

foo

bar

' ); From 849fa3aa278bad48457d53f11a569c667ea82efd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sun, 10 Dec 2017 19:44:14 +0100 Subject: [PATCH 130/724] Aligned operation tests with engine changes. --- src/model/operation/markeroperation.js | 2 +- tests/model/documentselection.js | 156 ++++++++++-------- tests/model/liveposition.js | 6 +- tests/model/liverange.js | 107 +++++++----- tests/model/markercollection.js | 23 +-- tests/model/node.js | 6 +- tests/model/operation/attributeoperation.js | 47 +++--- tests/model/operation/detachoperation.js | 23 +-- tests/model/operation/insertoperation.js | 32 ++-- tests/model/operation/markeroperation.js | 83 +++++----- tests/model/operation/moveoperation.js | 34 ++-- tests/model/operation/nooperation.js | 9 +- tests/model/operation/operationfactory.js | 8 +- tests/model/operation/reinsertoperation.js | 16 +- tests/model/operation/removeoperation.js | 25 +-- tests/model/operation/renameoperation.js | 26 ++- .../model/operation/rootattributeoperation.js | 32 ++-- tests/model/operation/transform.js | 6 +- tests/model/operation/utils.js | 13 +- 19 files changed, 359 insertions(+), 295 deletions(-) diff --git a/src/model/operation/markeroperation.js b/src/model/operation/markeroperation.js index 4c610ccd1..20fdb4412 100644 --- a/src/model/operation/markeroperation.js +++ b/src/model/operation/markeroperation.js @@ -146,7 +146,7 @@ export default class MarkerOperation extends Operation { json.name, json.oldRange ? Range.fromJSON( json.oldRange, document ) : null, json.newRange ? Range.fromJSON( json.newRange, document ) : null, - document.markers, + document.model.markers, json.baseVersion ); } diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 4a8d490fc..3bba50f30 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -3,7 +3,8 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; +import Batch from '../../src/model/batch'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; import Range from '../../src/model/range'; @@ -26,13 +27,14 @@ import log from '@ckeditor/ckeditor5-utils/src/log'; testUtils.createSinonSandbox(); describe( 'DocumentSelection', () => { - let doc, root, selection, liveRange, range; + let model, doc, root, selection, liveRange, range; const fooStoreAttrKey = DocumentSelection._getStoreAttributeKey( 'foo' ); const abcStoreAttrKey = DocumentSelection._getStoreAttributeKey( 'abc' ); beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); root.appendChildren( [ new Element( 'p' ), @@ -44,17 +46,17 @@ describe( 'DocumentSelection', () => { new Element( 'p', [], new Text( 'foobar' ) ) ] ); selection = doc.selection; - doc.schema.registerItem( 'p', '$block' ); + model.schema.registerItem( 'p', '$block' ); - doc.schema.registerItem( 'widget' ); - doc.schema.objects.add( 'widget' ); + model.schema.registerItem( 'widget' ); + model.schema.objects.add( 'widget' ); liveRange = new LiveRange( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ); range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 2, 2 ] ) ); } ); afterEach( () => { - doc.destroy(); + model.destroy(); liveRange.detach(); } ); @@ -69,7 +71,8 @@ describe( 'DocumentSelection', () => { } ); it( 'should be set to the beginning of the doc if there is no editable element', () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); root.insertChildren( 0, new Text( 'foobar' ) ); selection = doc.selection; @@ -84,14 +87,15 @@ describe( 'DocumentSelection', () => { } ); it( 'should skip element when you can not put selection', () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); root.insertChildren( 0, [ new Element( 'img' ), new Element( 'p', [], new Text( 'foobar' ) ) ] ); - doc.schema.registerItem( 'img' ); - doc.schema.registerItem( 'p', '$block' ); + model.schema.registerItem( 'img' ); + model.schema.registerItem( 'p', '$block' ); selection = doc.selection; const ranges = Array.from( selection.getRanges() ); @@ -356,16 +360,16 @@ describe( 'DocumentSelection', () => { // See #630. it( 'should refresh attributes – integration test for #630', () => { - doc.schema.allow( { name: '$text', inside: '$root' } ); + model.schema.allow( { name: '$text', inside: '$root' } ); - setData( doc, 'f<$text italic="true">[o<$text bold="true">ob]ar' ); + setData( model, 'f<$text italic="true">[o<$text bold="true">ob]ar' ); selection.setRanges( [ Range.createFromPositionAndShift( selection.getLastRange().end, 0 ) ] ); expect( selection.getAttribute( 'bold' ) ).to.equal( true ); expect( selection.hasAttribute( 'italic' ) ).to.equal( false ); - expect( getData( doc ) ) + expect( getData( model ) ) .to.equal( 'f<$text italic="true">o<$text bold="true">ob[]ar' ); } ); } ); @@ -433,7 +437,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0, 1 ] ), 'xyz', @@ -453,7 +457,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 1, 0 ] ), 'xyz', @@ -475,7 +479,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 0, 0 ] ), 2, @@ -496,7 +500,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 2 ] ), 2, @@ -517,7 +521,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 1, 0 ] ), 2, @@ -538,7 +542,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 1, 3 ] ), 2, @@ -559,7 +563,7 @@ describe( 'DocumentSelection', () => { expect( data.directChange ).to.be.false; } ); - const batch = doc.batch(); + const batch = new Batch(); const splitDelta = new SplitDelta(); const insertOperation = new InsertOperation( @@ -580,8 +584,8 @@ describe( 'DocumentSelection', () => { splitDelta.addOperation( insertOperation ); splitDelta.addOperation( moveOperation ); - doc.applyOperation( insertOperation ); - doc.applyOperation( moveOperation ); + model.applyOperation( insertOperation ); + model.applyOperation( moveOperation ); const range = selection.getFirstRange(); @@ -601,7 +605,7 @@ describe( 'DocumentSelection', () => { expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] ); } ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), 'foo', @@ -621,7 +625,7 @@ describe( 'DocumentSelection', () => { const spyAttribute = sinon.spy(); selection.on( 'change:attribute', spyAttribute ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), 'foo', @@ -642,7 +646,7 @@ describe( 'DocumentSelection', () => { const spyAttribute = sinon.spy(); selection.on( 'change:attribute', spyAttribute ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), 'foo', @@ -661,7 +665,7 @@ describe( 'DocumentSelection', () => { it( 'fix selection range if it ends up in graveyard #1', () => { selection.setCollapsedAt( new Position( root, [ 1, 3 ] ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RemoveOperation( new Position( root, [ 1, 2 ] ), 2, @@ -676,7 +680,7 @@ describe( 'DocumentSelection', () => { it( 'fix selection range if it ends up in graveyard #2', () => { selection.setRanges( [ new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 4 ] ) ) ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RemoveOperation( new Position( root, [ 1, 2 ] ), 2, @@ -691,7 +695,7 @@ describe( 'DocumentSelection', () => { it( 'fix selection range if it ends up in graveyard #3', () => { selection.setRanges( [ new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ) ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RemoveOperation( new Position( root, [ 1 ] ), 2, @@ -704,7 +708,7 @@ describe( 'DocumentSelection', () => { } ); it( 'fix selection range if it ends up in graveyard #4 - whole content removed', () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RemoveOperation( new Position( root, [ 0 ] ), 3, @@ -715,7 +719,7 @@ describe( 'DocumentSelection', () => { expect( selection.getFirstPosition().path ).to.deep.equal( [ 0 ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), new Element( 'p' ), @@ -937,50 +941,50 @@ describe( 'DocumentSelection', () => { // #986 describe( 'are not inherited from the inside of object elements', () => { beforeEach( () => { - doc.schema.registerItem( 'image' ); - doc.schema.allow( { name: 'image', inside: '$root' } ); - doc.schema.allow( { name: 'image', inside: '$block' } ); - doc.schema.allow( { name: '$inline', inside: 'image' } ); - doc.schema.objects.add( 'image' ); - - doc.schema.registerItem( 'caption' ); - doc.schema.allow( { name: '$inline', inside: 'caption' } ); - doc.schema.allow( { name: 'caption', inside: 'image' } ); - doc.schema.allow( { name: '$text', attributes: 'bold', inside: 'caption' } ); + model.schema.registerItem( 'image' ); + model.schema.allow( { name: 'image', inside: '$root' } ); + model.schema.allow( { name: 'image', inside: '$block' } ); + model.schema.allow( { name: '$inline', inside: 'image' } ); + model.schema.objects.add( 'image' ); + + model.schema.registerItem( 'caption' ); + model.schema.allow( { name: '$inline', inside: 'caption' } ); + model.schema.allow( { name: 'caption', inside: 'image' } ); + model.schema.allow( { name: '$text', attributes: 'bold', inside: 'caption' } ); } ); it( 'ignores attributes inside an object if selection contains that object', () => { - setData( doc, '

[<$text bold="true">Caption for the image.]

' ); + setData( model, '

[<$text bold="true">Caption for the image.]

' ); expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => { - setData( doc, '

[<$text bold="true">Caption for the image.]

' ); + setData( model, '

[<$text bold="true">Caption for the image.]

' ); expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); it( 'ignores attributes inside an object if selection contains that object (block level)', () => { - setData( doc, '

foo

[<$text bold="true">Caption for the image.]

foo

' ); + setData( model, '

foo

[<$text bold="true">Caption for the image.]

foo

' ); expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); it( 'reads attributes from text even if the selection contains an object', () => { - setData( doc, '

x<$text bold="true">[barfoo]

' ); + setData( model, '

x<$text bold="true">[barfoo]

' ); expect( selection.getAttribute( 'bold' ) ).to.equal( true ); } ); it( 'reads attributes when the entire selection inside an object', () => { - setData( doc, '

<$text bold="true">[bar]

' ); + setData( model, '

<$text bold="true">[bar]

' ); expect( selection.getAttribute( 'bold' ) ).to.equal( true ); } ); it( 'stops reading attributes if selection starts with an object', () => { - setData( doc, '

[<$text bold="true">bar]

' ); + setData( model, '

[<$text bold="true">bar]

' ); expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); @@ -1012,7 +1016,9 @@ describe( 'DocumentSelection', () => { batchTypes.set( batch, batch.type ); } ); - doc.batch().insertText( 'x', rangeInEmptyP.start ); + model.change( writer => { + writer.insertText( 'x', rangeInEmptyP.start ); + } ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; @@ -1024,7 +1030,9 @@ describe( 'DocumentSelection', () => { selection.setRanges( [ rangeInEmptyP ] ); selection.setAttribute( 'foo', 'bar' ); - doc.batch().move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start ); + model.change( writer => { + writer.move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start ); + } ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; } ); @@ -1036,8 +1044,10 @@ describe( 'DocumentSelection', () => { emptyP.setAttribute( fooStoreAttrKey, 'bar' ); emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); - // {} - doc.batch().merge( Position.createAfter( emptyP ) ); + model.change( writer => { + // {} + writer.merge( Position.createAfter( emptyP ) ); + } ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element. @@ -1048,35 +1058,39 @@ describe( 'DocumentSelection', () => { selection.setRanges( [ rangeInFullP ] ); - doc.batch().insertText( 'x', rangeInEmptyP.start ); + model.change( writer => { + writer.insertText( 'x', rangeInEmptyP.start ); + } ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; } ); it( 'are removed only once in case of multi-op deltas', () => { + let spy; const emptyP2 = new Element( 'p', null, 'x' ); root.appendChildren( emptyP2 ); emptyP.setAttribute( fooStoreAttrKey, 'bar' ); emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); - const batch = doc.batch(); - const spy = sinon.spy( batch, 'removeAttribute' ); + model.change( writer => { + spy = sinon.spy( writer, 'removeAttribute' ); - // {} - batch.merge( Position.createAfter( emptyP ) ); + // {} + writer.merge( Position.createAfter( emptyP ) ); + } ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; expect( spy.calledOnce ).to.be.true; } ); - it( 'uses document enqueue changes to clear attributes', () => { + it( 'uses model change to clear attributes', () => { selection.setRanges( [ rangeInEmptyP ] ); selection.setAttribute( 'foo', 'bar' ); - doc.enqueueChanges( () => { - doc.batch().insertText( 'x', rangeInEmptyP.start ); + model.change( writer => { + writer.insertText( 'x', rangeInEmptyP.start ); // `emptyP` still has the attribute, because attribute clearing is in enqueued block. expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; @@ -1096,8 +1110,10 @@ describe( 'DocumentSelection', () => { expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; - // {} - doc.batch().merge( Position.createAfter( emptyP ) ); + model.change( writer => { + // {} + writer.merge( Position.createAfter( emptyP ) ); + } ); expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element. @@ -1107,12 +1123,14 @@ describe( 'DocumentSelection', () => { selection.setRanges( [ rangeInEmptyP ] ); selection.setAttribute( 'foo', 'bar' ); - sinon.spy( doc, 'enqueueChanges' ); + model.enqueueChange( 'transparent', writer => { + sinon.spy( model, 'enqueueChange' ); - doc.batch( 'transparent' ).insertText( 'x', rangeInEmptyP.start ); + writer.insertText( 'x', rangeInEmptyP.start ); - expect( doc.enqueueChanges.called ).to.be.false; - expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); + expect( model.enqueueChange.called ).to.be.false; + expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); + } ); } ); // Rename and some other deltas don't specify range in doc#change event. @@ -1121,11 +1139,13 @@ describe( 'DocumentSelection', () => { selection.setRanges( [ rangeInEmptyP ] ); selection.setAttribute( 'foo', 'bar' ); - sinon.spy( doc, 'enqueueChanges' ); + sinon.spy( model, 'enqueueChange' ); - doc.batch().rename( emptyP, 'pnew' ); + model.change( writer => { + writer.rename( emptyP, 'pnew' ); + } ); - expect( doc.enqueueChanges.called ).to.be.false; + expect( model.enqueueChange.called ).to.be.false; expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); } ); } ); diff --git a/tests/model/liveposition.js b/tests/model/liveposition.js index 67d4b4f4d..1a77b7bbb 100644 --- a/tests/model/liveposition.js +++ b/tests/model/liveposition.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DocumentFragment from '../../src/model/documentfragment'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; @@ -16,7 +16,9 @@ describe( 'LivePosition', () => { let doc, root, ul, p, li1, li2; before( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); li1 = new Element( 'li', [], new Text( 'abcdef' ) ); diff --git a/tests/model/liverange.js b/tests/model/liverange.js index 15fac530b..14c3c11d7 100644 --- a/tests/model/liverange.js +++ b/tests/model/liverange.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import Element from '../../src/model/element'; import Position from '../../src/model/position'; import LiveRange from '../../src/model/liverange'; @@ -12,10 +12,11 @@ import Text from '../../src/model/text'; import { stringify, setData } from '../../src/dev-utils/model'; describe( 'LiveRange', () => { - let doc, root, ul, p; + let model, doc, root, ul, p; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); const lis = [ @@ -429,11 +430,11 @@ describe( 'LiveRange', () => { let live; beforeEach( () => { - doc.schema.registerItem( 'p', '$block' ); - doc.schema.registerItem( 'w' ); + model.schema.registerItem( 'p', '$block' ); + model.schema.registerItem( 'w' ); - doc.schema.allow( { name: 'p', inside: 'w' } ); - doc.schema.allow( { name: 'w', inside: '$root' } ); + model.schema.allow( { name: 'p', inside: 'w' } ); + model.schema.allow( { name: 'w', inside: '$root' } ); } ); afterEach( () => { @@ -441,67 +442,79 @@ describe( 'LiveRange', () => { } ); it( 'is inside the wrapped range', () => { - setData( doc, '

x

[a]

x

' ); + setData( model, '

x

[a]

x

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - // [

a

] - doc.batch().wrap( new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) ), 'w' ); + model.change( writer => { + // [

a

] + writer.wrap( new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) ), 'w' ); + } ); expect( stringify( root, live ) ).to.equal( '

x

[a]

x

' ); } ); it( 'its start is intersecting with the wrapped range', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - // [

ab

] - doc.batch().wrap( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'w' ); + model.change( writer => { + // [

ab

] + writer.wrap( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'w' ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); it( 'its end is intersecting with the wrapped range', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - // [

cd

] - doc.batch().wrap( new Range( new Position( root, [ 2 ] ), new Position( root, [ 3 ] ) ), 'w' ); + model.change( writer => { + // [

cd

] + writer.wrap( new Range( new Position( root, [ 2 ] ), new Position( root, [ 3 ] ) ), 'w' ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); it( 'its start is intersecting with the wrapped range (multilpe elements)', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - // [

ab

x

] - doc.batch().wrap( new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), 'w' ); + model.change( writer => { + // [

ab

x

] + writer.wrap( new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), 'w' ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); it( 'its end is intersecting with the wrapped range (multiple elements)', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - // [

x

cd

] - doc.batch().wrap( new Range( new Position( root, [ 1 ] ), new Position( root, [ 3 ] ) ), 'w' ); + model.change( writer => { + // [

x

cd

] + writer.wrap( new Range( new Position( root, [ 1 ] ), new Position( root, [ 3 ] ) ), 'w' ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); it( 'contains element to wrap', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - // [

x

] - doc.batch().wrap( new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) ), 'w' ); + model.change( writer => { + // [

x

] + writer.wrap( new Range( new Position( root, [ 1 ] ), new Position( root, [ 2 ] ) ), 'w' ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); @@ -513,11 +526,11 @@ describe( 'LiveRange', () => { let live; beforeEach( () => { - doc.schema.registerItem( 'p', '$block' ); - doc.schema.registerItem( 'w' ); + model.schema.registerItem( 'p', '$block' ); + model.schema.registerItem( 'w' ); - doc.schema.allow( { name: 'p', inside: 'w' } ); - doc.schema.allow( { name: 'w', inside: '$root' } ); + model.schema.allow( { name: 'p', inside: 'w' } ); + model.schema.allow( { name: 'w', inside: '$root' } ); } ); afterEach( () => { @@ -525,61 +538,73 @@ describe( 'LiveRange', () => { } ); it( 'is inside the wrapper to remove', () => { - setData( doc, '

x

[a]

x

' ); + setData( model, '

x

[a]

x

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - doc.batch().unwrap( root.getChild( 1 ) ); + model.change( writer => { + writer.unwrap( root.getChild( 1 ) ); + } ); expect( stringify( root, live ) ).to.equal( '

x

[a]

x

' ); } ); it( 'its start is intersecting with the wrapper to remove', () => { - setData( doc, '

a[b

c]d

' ); + setData( model, '

a[b

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - doc.batch().unwrap( root.getChild( 0 ) ); + model.change( writer => { + writer.unwrap( root.getChild( 0 ) ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

c]d

' ); } ); it( 'its end is intersecting with the wrapper to remove', () => { - setData( doc, '

a[b

c]d

' ); + setData( model, '

a[b

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - doc.batch().unwrap( root.getChild( 1 ) ); + model.change( writer => { + writer.unwrap( root.getChild( 1 ) ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

c]d

' ); } ); it( 'its start is intersecting with the wrapper to remove (multiple elements)', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - doc.batch().unwrap( root.getChild( 0 ) ); + model.change( writer => { + writer.unwrap( root.getChild( 0 ) ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); it( 'its end is intersecting with the wrapper to remove (multiple elements)', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - doc.batch().unwrap( root.getChild( 1 ) ); + model.change( writer => { + writer.unwrap( root.getChild( 1 ) ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); it( 'contains wrapped element', () => { - setData( doc, '

a[b

x

c]d

' ); + setData( model, '

a[b

x

c]d

' ); live = new LiveRange( doc.selection.getFirstPosition(), doc.selection.getLastPosition() ); - doc.batch().unwrap( root.getChild( 1 ) ); + model.change( writer => { + writer.unwrap( root.getChild( 1 ) ); + } ); expect( stringify( root, live ) ).to.equal( '

a[b

x

c]d

' ); } ); diff --git a/tests/model/markercollection.js b/tests/model/markercollection.js index a047813b5..0c1ed943d 100644 --- a/tests/model/markercollection.js +++ b/tests/model/markercollection.js @@ -7,14 +7,16 @@ import MarkerCollection from '../../src/model/markercollection'; import Position from '../../src/model/position'; import Range from '../../src/model/range'; import Text from '../../src/model/text'; -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'MarkerCollection', () => { let markers, range, range2, doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; markers = new MarkerCollection(); root = doc.createRoot(); @@ -207,10 +209,11 @@ describe( 'MarkerCollection', () => { } ); describe( 'Marker', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); } ); @@ -218,14 +221,14 @@ describe( 'Marker', () => { root.appendChildren( new Text( 'foo' ) ); const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); - const marker = doc.markers.set( 'name', range ); + const marker = model.markers.set( 'name', range ); expect( marker.getRange().isEqual( range ) ).to.be.true; expect( marker.getStart().isEqual( range.start ) ).to.be.true; expect( marker.getEnd().isEqual( range.end ) ).to.be.true; - doc.enqueueChanges( () => { - doc.batch().insertText( 'abc', root ); + model.change( writer => { + writer.insertText( 'abc', root ); } ); const updatedRange = Range.createFromParentsAndOffsets( root, 4, root, 5 ); @@ -237,9 +240,9 @@ describe( 'Marker', () => { it( 'should throw when using the API if marker was removed from markers collection', () => { const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); - const marker = doc.markers.set( 'name', range ); + const marker = model.markers.set( 'name', range ); - doc.markers.remove( 'name' ); + model.markers.remove( 'name' ); expect( () => { marker.getRange(); @@ -256,7 +259,7 @@ describe( 'Marker', () => { it( 'should delegate events from live range', () => { const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); - const marker = doc.markers.set( 'name', range ); + const marker = model.markers.set( 'name', range ); const eventRange = sinon.spy(); const eventContent = sinon.spy(); diff --git a/tests/model/node.js b/tests/model/node.js index d7c3430c8..eb718a998 100644 --- a/tests/model/node.js +++ b/tests/model/node.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DocumentFragment from '../../src/model/documentfragment'; import Node from '../../src/model/node'; import Element from '../../src/model/element'; @@ -17,6 +17,8 @@ describe( 'Node', () => { textBA, textR, img; beforeEach( () => { + const model = new Model(); + node = new Node(); one = new Element( 'one' ); @@ -26,7 +28,7 @@ describe( 'Node', () => { textR = two.getChild( 2 ); three = new Element( 'three' ); - doc = new Document(); + doc = model.document; root = doc.createRoot(); root.appendChildren( [ one, two, three ] ); } ); diff --git a/tests/model/operation/attributeoperation.js b/tests/model/operation/attributeoperation.js index 24e41fadf..e6aa85fb1 100644 --- a/tests/model/operation/attributeoperation.js +++ b/tests/model/operation/attributeoperation.js @@ -3,7 +3,8 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; +import DocumentFragment from '../../../src/model/documentfragment'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; import AttributeOperation from '../../../src/model/operation/attributeoperation'; @@ -14,10 +15,11 @@ import count from '@ckeditor/ckeditor5-utils/src/count'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'AttributeOperation', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); } ); @@ -73,8 +75,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should return false when attribute is applied on detached items', () => { - const docFrag = doc.batch().createDocumentFragment(); - doc.batch().appendText( 'abc', null, docFrag ); + const docFrag = new DocumentFragment( [ new Text( 'abc' ) ] ); const op = new AttributeOperation( Range.createIn( docFrag ), @@ -91,7 +92,7 @@ describe( 'AttributeOperation', () => { it( 'should insert attribute to the set of nodes', () => { root.insertChildren( 0, new Text( 'bar' ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), 'isNew', @@ -112,7 +113,7 @@ describe( 'AttributeOperation', () => { it( 'should add attribute to the existing attributes', () => { root.insertChildren( 0, new Text( 'x', { foo: true, bar: true } ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'isNew', @@ -133,7 +134,7 @@ describe( 'AttributeOperation', () => { it( 'should change attribute to the set of nodes', () => { root.insertChildren( 0, new Text( 'bar', { isNew: false } ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), 'isNew', @@ -154,7 +155,7 @@ describe( 'AttributeOperation', () => { it( 'should change attribute in the middle of existing attributes', () => { root.insertChildren( 0, new Text( 'x', { foo: true, x: 1, bar: true } ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'x', @@ -175,7 +176,7 @@ describe( 'AttributeOperation', () => { it( 'should remove attribute', () => { root.insertChildren( 0, new Text( 'x', { foo: true, x: true, bar: true } ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'x', @@ -196,7 +197,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, new Text( 'x', { foo: [ 'bar', 'xyz' ] } ) ); expect( () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'foo', @@ -234,8 +235,8 @@ describe( 'AttributeOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 3 ); @@ -248,7 +249,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, [ eleA, eleB ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 1, 2 ] ) ), 'foo', @@ -269,7 +270,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, [ eleA, eleB ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 1, 0 ] ) ), 'foo', @@ -295,8 +296,8 @@ describe( 'AttributeOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 3 ); @@ -317,8 +318,8 @@ describe( 'AttributeOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 3 ); @@ -330,7 +331,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, new Text( 'x' ) ); expect( () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'foo', @@ -346,7 +347,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, new Text( 'x', { x: 1 } ) ); expect( () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'x', @@ -384,7 +385,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, new Text( 'abc', attrA ) ); root.insertChildren( 1, new Text( 'xyz', attrB ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 1 ] ), new Position( root, [ 3 ] ) ), 'foo', @@ -402,7 +403,7 @@ describe( 'AttributeOperation', () => { root.insertChildren( 0, new Text( 'x', { foo: true } ) ); expect( () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'foo', diff --git a/tests/model/operation/detachoperation.js b/tests/model/operation/detachoperation.js index f62f666de..36be9094b 100644 --- a/tests/model/operation/detachoperation.js +++ b/tests/model/operation/detachoperation.js @@ -3,22 +3,22 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import DetachOperation from '../../../src/model/operation/detachoperation'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import Position from '../../../src/model/position'; +import DocumentFragment from '../../../src/model/documentfragment'; +import Element from '../../../src/model/element'; describe( 'DetachOperation', () => { - let doc, batch, docFrag, element; + let model, doc, docFrag, element; beforeEach( () => { - doc = new Document(); - batch = doc.batch(); - - docFrag = batch.createDocumentFragment(); - element = batch.createElement( 'element' ); - batch.append( element, docFrag ); + model = new Model(); + doc = model.document; + element = new Element( 'element' ); + docFrag = new DocumentFragment( [ element ] ); } ); it( 'should have type equal to detach', () => { @@ -30,15 +30,16 @@ describe( 'DetachOperation', () => { it( 'should remove given element from parent', () => { const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); - doc.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( op ) ); expect( docFrag.childCount ).to.equal( 0 ); } ); it( 'should throw when is executed on element from document', () => { const root = doc.createRoot(); - const element = batch.createElement( 'element' ); - batch.append( element, root ); + const element = new Element( 'element' ); + + root.appendChildren( [ element ] ); const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); diff --git a/tests/model/operation/insertoperation.js b/tests/model/operation/insertoperation.js index c0c04844f..2331ecb9a 100644 --- a/tests/model/operation/insertoperation.js +++ b/tests/model/operation/insertoperation.js @@ -3,9 +3,10 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import NodeList from '../../../src/model/nodelist'; import Element from '../../../src/model/element'; +import DocumentFragment from '../../../src/model/documentfragment'; import InsertOperation from '../../../src/model/operation/insertoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import Position from '../../../src/model/position'; @@ -13,10 +14,11 @@ import Text from '../../../src/model/text'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'InsertOperation', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); } ); @@ -31,7 +33,7 @@ describe( 'InsertOperation', () => { } ); it( 'should insert text node', () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), new Text( 'x' ), @@ -45,7 +47,7 @@ describe( 'InsertOperation', () => { } ); it( 'should insert element', () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), new Element( 'p' ), @@ -59,7 +61,7 @@ describe( 'InsertOperation', () => { } ); it( 'should insert set of nodes', () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), [ 'bar', new Element( 'p' ), 'foo' ], @@ -78,7 +80,7 @@ describe( 'InsertOperation', () => { it( 'should insert between existing nodes', () => { root.insertChildren( 0, new Text( 'xy' ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 1 ] ), 'bar', @@ -92,7 +94,7 @@ describe( 'InsertOperation', () => { } ); it( 'should insert text', () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new InsertOperation( new Position( root, [ 0 ] ), [ 'foo', new Text( 'x' ), 'bar' ], @@ -130,11 +132,11 @@ describe( 'InsertOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); expect( doc.version ).to.equal( 1 ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 0 ); @@ -149,11 +151,11 @@ describe( 'InsertOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); expect( doc.version ).to.equal( 1 ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 0 ); @@ -190,11 +192,11 @@ describe( 'InsertOperation', () => { const element = new Element( 'p', { key: 'value' } ); const op = new InsertOperation( new Position( root, [ 0 ] ), element, doc.version ); - doc.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( op ) ); const text = new Text( 'text' ); const op2 = new InsertOperation( new Position( root, [ 0, 0 ] ), text, doc.version ); - doc.applyOperation( wrapInDelta( op2 ) ); + model.applyOperation( wrapInDelta( op2 ) ); expect( op.nodes.getNode( 0 ) ).not.to.equal( element ); expect( op.nodes.getNode( 0 ).name ).to.equal( 'p' ); @@ -218,7 +220,7 @@ describe( 'InsertOperation', () => { } ); it( 'should return false when element is inserted to document fragment', () => { - const docFrag = doc.batch().createDocumentFragment(); + const docFrag = new DocumentFragment(); const op = new InsertOperation( new Position( docFrag, [ 0 ] ), diff --git a/tests/model/operation/markeroperation.js b/tests/model/operation/markeroperation.js index 1434b858e..9565a286a 100644 --- a/tests/model/operation/markeroperation.js +++ b/tests/model/operation/markeroperation.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Text from '../../../src/model/text'; import Range from '../../../src/model/range'; import MarkerOperation from '../../../src/model/operation/markeroperation'; @@ -14,22 +14,23 @@ function matchRange( range ) { } describe( 'MarkerOperation', () => { - let doc, root, range; + let model, doc, root, range; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); root.appendChildren( new Text( 'foo' ) ); range = Range.createFromParentsAndOffsets( root, 0, root, 0 ); } ); it( 'should have property type equal to "marker"', () => { - const op = new MarkerOperation( 'name', null, range, doc.markers, 0 ); + const op = new MarkerOperation( 'name', null, range, model.markers, 0 ); expect( op.type ).to.equal( 'marker' ); } ); it( 'should add marker to document marker collection', () => { - sinon.spy( doc.markers, 'set' ); + sinon.spy( model.markers, 'set' ); sinon.spy( doc, 'fire' ); doc.on( 'change', ( evt, type, changes ) => { @@ -38,42 +39,42 @@ describe( 'MarkerOperation', () => { expect( changes.type ).to.equal( 'set' ); } ); - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', null, range, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', null, range, model.markers, doc.version ) ) ); expect( doc.version ).to.equal( 1 ); - expect( doc.markers.set.calledWith( 'name', matchRange( range ) ) ); - expect( doc.markers.get( 'name' ).getRange().isEqual( range ) ).to.be.true; + expect( model.markers.set.calledWith( 'name', matchRange( range ) ) ); + expect( model.markers.get( 'name' ).getRange().isEqual( range ) ).to.be.true; expect( doc.fire.called ).to.be.true; } ); it( 'should update marker in document marker collection', () => { - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', null, range, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', null, range, model.markers, doc.version ) ) ); const range2 = Range.createFromParentsAndOffsets( root, 0, root, 3 ); - sinon.spy( doc.markers, 'set' ); + sinon.spy( model.markers, 'set' ); sinon.spy( doc, 'fire' ); - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', range, range2, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', range, range2, model.markers, doc.version ) ) ); expect( doc.version ).to.equal( 2 ); - expect( doc.markers.set.calledWith( 'name', matchRange( range2 ) ) ); - expect( doc.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + expect( model.markers.set.calledWith( 'name', matchRange( range2 ) ) ); + expect( model.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; expect( doc.fire.called ).to.be.true; } ); it( 'should remove marker from document marker collection', () => { - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', null, range, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', null, range, model.markers, doc.version ) ) ); - sinon.spy( doc.markers, 'remove' ); + sinon.spy( model.markers, 'remove' ); sinon.spy( doc, 'fire' ); doc.on( 'change', ( evt, type, changes ) => { @@ -82,19 +83,19 @@ describe( 'MarkerOperation', () => { expect( changes.type ).to.equal( 'remove' ); } ); - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', range, null, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', range, null, model.markers, doc.version ) ) ); expect( doc.version ).to.equal( 2 ); - expect( doc.markers.remove.calledWith( 'name' ) ); - expect( doc.markers.get( 'name' ) ).to.be.null; + expect( model.markers.remove.calledWith( 'name' ) ); + expect( model.markers.get( 'name' ) ).to.be.null; expect( doc.fire.called ).to.be.true; } ); it( 'should fire document change event but not document markers remove event if removing non-existing range', () => { sinon.spy( doc, 'fire' ); - sinon.spy( doc.markers, 'fire' ); + sinon.spy( model.markers, 'fire' ); doc.on( 'change', ( evt, type, changes ) => { expect( type ).to.equal( 'marker' ); @@ -102,19 +103,19 @@ describe( 'MarkerOperation', () => { expect( changes.type ).to.equal( 'remove' ); } ); - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', null, null, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', null, null, model.markers, doc.version ) ) ); expect( doc.fire.calledWith( 'change', 'marker' ) ).to.be.true; - expect( doc.markers.fire.notCalled ).to.be.true; + expect( model.markers.fire.notCalled ).to.be.true; } ); it( 'should fire document change event but not document markers set event if newRange is same as current marker range', () => { - doc.markers.set( 'name', range ); + model.markers.set( 'name', range ); sinon.spy( doc, 'fire' ); - sinon.spy( doc.markers, 'fire' ); + sinon.spy( model.markers, 'fire' ); doc.on( 'change', ( evt, type, changes ) => { expect( type ).to.equal( 'marker' ); @@ -122,21 +123,21 @@ describe( 'MarkerOperation', () => { expect( changes.type ).to.equal( 'set' ); } ); - doc.applyOperation( wrapInDelta( - new MarkerOperation( 'name', range, range, doc.markers, doc.version ) + model.applyOperation( wrapInDelta( + new MarkerOperation( 'name', range, range, model.markers, doc.version ) ) ); expect( doc.fire.calledWith( 'change', 'marker' ) ).to.be.true; - expect( doc.markers.fire.notCalled ).to.be.true; + expect( model.markers.fire.notCalled ).to.be.true; } ); it( 'should return MarkerOperation with swapped ranges as reverse operation', () => { const range2 = Range.createFromParentsAndOffsets( root, 0, root, 3 ); - const op1 = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); + const op1 = new MarkerOperation( 'name', null, range, model.markers, doc.version ); const reversed1 = op1.getReversed(); - const op2 = new MarkerOperation( 'name', range, range2, doc.markers, doc.version ); + const op2 = new MarkerOperation( 'name', range, range2, model.markers, doc.version ); const reversed2 = op2.getReversed(); expect( reversed1 ).to.be.an.instanceof( MarkerOperation ); @@ -154,7 +155,7 @@ describe( 'MarkerOperation', () => { } ); it( 'should create a MarkerOperation with the same parameters when cloned', () => { - const op = new MarkerOperation( 'name', null, range, doc.markers, 0 ); + const op = new MarkerOperation( 'name', null, range, model.markers, 0 ); const clone = op.clone(); expect( clone ).to.be.an.instanceof( MarkerOperation ); @@ -163,19 +164,19 @@ describe( 'MarkerOperation', () => { describe( 'isDocumentOperation', () => { it( 'should return true when new marker range is added to the document', () => { - const op = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); + const op = new MarkerOperation( 'name', null, range, model.markers, doc.version ); expect( op.isDocumentOperation ).to.true; } ); it( 'should return false when marker range is removed from the document', () => { - const op = new MarkerOperation( 'name', range, null, doc.markers, doc.version ); + const op = new MarkerOperation( 'name', range, null, model.markers, doc.version ); expect( op.isDocumentOperation ).to.true; } ); it( 'should return true when non-existing marker range is removed from the document', () => { - const op = new MarkerOperation( 'name', null, null, doc.markers, doc.version ); + const op = new MarkerOperation( 'name', null, null, model.markers, doc.version ); expect( op.isDocumentOperation ).to.true; } ); @@ -183,7 +184,7 @@ describe( 'MarkerOperation', () => { describe( 'toJSON', () => { it( 'should create proper serialized object', () => { - const op = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); + const op = new MarkerOperation( 'name', null, range, model.markers, doc.version ); const serialized = jsonParseStringify( op ); expect( serialized ).to.deep.equal( { @@ -198,7 +199,7 @@ describe( 'MarkerOperation', () => { describe( 'fromJSON', () => { it( 'should create proper MarkerOperation from json object #1', () => { - const op = new MarkerOperation( 'name', null, range, doc.markers, doc.version ); + const op = new MarkerOperation( 'name', null, range, model.markers, doc.version ); const serialized = jsonParseStringify( op ); const deserialized = MarkerOperation.fromJSON( serialized, doc ); @@ -208,7 +209,7 @@ describe( 'MarkerOperation', () => { it( 'should create proper MarkerOperation from json object #2', () => { // Gotta love 100% CC. - const op = new MarkerOperation( 'name', range, null, doc.markers, doc.version ); + const op = new MarkerOperation( 'name', range, null, model.markers, doc.version ); const serialized = jsonParseStringify( op ); const deserialized = MarkerOperation.fromJSON( serialized, doc ); diff --git a/tests/model/operation/moveoperation.js b/tests/model/operation/moveoperation.js index d45c49ba7..dbf602db9 100644 --- a/tests/model/operation/moveoperation.js +++ b/tests/model/operation/moveoperation.js @@ -3,19 +3,21 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import MoveOperation from '../../../src/model/operation/moveoperation'; import Position from '../../../src/model/position'; +import DocumentFragment from '../../../src/model/documentfragment'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'MoveOperation', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); } ); @@ -47,7 +49,7 @@ describe( 'MoveOperation', () => { root.insertChildren( 0, [ p1, p2 ] ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 0, 0 ] ), 1, @@ -68,7 +70,7 @@ describe( 'MoveOperation', () => { it( 'should move position of children in one node backward', () => { root.insertChildren( 0, new Text( 'xbarx' ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 2 ] ), 2, @@ -85,7 +87,7 @@ describe( 'MoveOperation', () => { it( 'should move position of children in one node forward', () => { root.insertChildren( 0, new Text( 'xbarx' ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new MoveOperation( new Position( root, [ 1 ] ), 2, @@ -132,7 +134,7 @@ describe( 'MoveOperation', () => { doc.version ); - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); expect( doc.version ).to.equal( 1 ); expect( root.maxOffset ).to.equal( 2 ); @@ -140,7 +142,7 @@ describe( 'MoveOperation', () => { expect( p2.maxOffset ).to.equal( 1 ); expect( p2.getChild( 0 ).name ).to.equal( 'x' ); - doc.applyOperation( wrapInDelta( operation.getReversed() ) ); + model.applyOperation( wrapInDelta( operation.getReversed() ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 2 ); @@ -159,7 +161,7 @@ describe( 'MoveOperation', () => { doc.version ); - expect( () => doc.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-nodes-do-not-exist/ ); + expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-nodes-do-not-exist/ ); } ); it( 'should throw an error if target or source parent-element specified by position does not exist', () => { @@ -176,7 +178,7 @@ describe( 'MoveOperation', () => { root.removeChildren( 1 ); - expect( () => doc.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-position-invalid/ ); + expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-position-invalid/ ); } ); it( 'should throw an error if operation tries to move a range between the beginning and the end of that range', () => { @@ -189,7 +191,7 @@ describe( 'MoveOperation', () => { doc.version ); - expect( () => doc.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-range-into-itself/ ); + expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-range-into-itself/ ); } ); it( 'should throw an error if operation tries to move a range into a sub-tree of a node that is in that range', () => { @@ -203,7 +205,7 @@ describe( 'MoveOperation', () => { doc.version ); - expect( () => doc.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-node-into-itself/ ); + expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-node-into-itself/ ); } ); it( 'should not throw an error if operation move a range into a sibling', () => { @@ -219,7 +221,7 @@ describe( 'MoveOperation', () => { expect( () => { - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); } ).not.to.throw(); @@ -242,7 +244,7 @@ describe( 'MoveOperation', () => { expect( () => { - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); } ).not.to.throw(); } ); @@ -280,9 +282,7 @@ describe( 'MoveOperation', () => { } ); it( 'should return false when operation is executed on detached items', () => { - const docFrag = doc.batch().createDocumentFragment(); - - doc.batch().appendText( 'abc', null, docFrag ); + const docFrag = new DocumentFragment( [ new Text( 'abc' ) ] ); const op = new MoveOperation( new Position( docFrag, [ 0 ] ), diff --git a/tests/model/operation/nooperation.js b/tests/model/operation/nooperation.js index 6c7763319..c92045865 100644 --- a/tests/model/operation/nooperation.js +++ b/tests/model/operation/nooperation.js @@ -3,20 +3,21 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import NoOperation from '../../../src/model/operation/nooperation'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'NoOperation', () => { - let noop, doc; + let model, noop, doc; beforeEach( () => { noop = new NoOperation( 0 ); - doc = new Document(); + model = new Model(); + doc = model.document; } ); it( 'should not throw an error when applied', () => { - expect( () => doc.applyOperation( wrapInDelta( noop ) ) ).to.not.throw( Error ); + expect( () => model.applyOperation( wrapInDelta( noop ) ) ).to.not.throw( Error ); } ); it( 'should return empty object when executed', () => { diff --git a/tests/model/operation/operationfactory.js b/tests/model/operation/operationfactory.js index ca23002b0..c6ee5cb95 100644 --- a/tests/model/operation/operationfactory.js +++ b/tests/model/operation/operationfactory.js @@ -3,22 +3,22 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import NoOperation from '../../../src/model/operation/nooperation'; import OperationFactory from '../../../src/model/operation/operationfactory'; describe( 'OperationFactory', () => { - let doc; + let model; beforeEach( () => { - doc = new Document(); + model = new Model(); } ); it( 'should create operation from JSON', () => { const operation = OperationFactory.fromJSON( { __className: 'engine.model.operation.NoOperation', baseVersion: 0 - }, doc ); + }, model.doc ); expect( operation ).to.instanceof( NoOperation ); expect( operation.baseVersion ).to.equal( 0 ); diff --git a/tests/model/operation/reinsertoperation.js b/tests/model/operation/reinsertoperation.js index 4040ceb42..f22b634e6 100644 --- a/tests/model/operation/reinsertoperation.js +++ b/tests/model/operation/reinsertoperation.js @@ -3,21 +3,23 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import ReinsertOperation from '../../../src/model/operation/reinsertoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import MoveOperation from '../../../src/model/operation/moveoperation'; import Position from '../../../src/model/position'; +import DocumentFragment from '../../../src/model/documentfragment'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'ReinsertOperation', () => { - let doc, root, graveyard, operation, graveyardPosition, rootPosition; + let model, doc, root, graveyard, operation, graveyardPosition, rootPosition; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); graveyard = doc.graveyard; @@ -87,13 +89,13 @@ describe( 'ReinsertOperation', () => { graveyard.insertChildren( 0, new Text( 'xx' ) ); - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); expect( doc.version ).to.equal( 1 ); expect( root.maxOffset ).to.equal( 2 ); expect( graveyard.maxOffset ).to.equal( 0 ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 0 ); @@ -105,7 +107,7 @@ describe( 'ReinsertOperation', () => { } ); it( 'should throw when target position is not in the document', () => { - const docFrag = doc.batch().createDocumentFragment(); + const docFrag = new DocumentFragment(); operation = new ReinsertOperation( graveyardPosition, @@ -120,7 +122,7 @@ describe( 'ReinsertOperation', () => { } ); it( 'should throw when source position is not in the document', () => { - const docFrag = doc.batch().createDocumentFragment(); + const docFrag = new DocumentFragment(); operation = new ReinsertOperation( Position.createAt( docFrag ), diff --git a/tests/model/operation/removeoperation.js b/tests/model/operation/removeoperation.js index 33b755b7d..38cc1e8c5 100644 --- a/tests/model/operation/removeoperation.js +++ b/tests/model/operation/removeoperation.js @@ -3,21 +3,23 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import ReinsertOperation from '../../../src/model/operation/reinsertoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import MoveOperation from '../../../src/model/operation/moveoperation'; import Position from '../../../src/model/position'; -import Text from '../../../src/model/text'; +import DocumentFragment from '../../../src/model/documentfragment'; import Element from '../../../src/model/element'; +import Text from '../../../src/model/text'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'RemoveOperation', () => { - let doc, root, graveyard; + let model, doc, root, graveyard; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); graveyard = doc.graveyard; } ); @@ -58,7 +60,7 @@ describe( 'RemoveOperation', () => { it( 'should be able to remove set of nodes and append them to graveyard root', () => { root.insertChildren( 0, new Text( 'fozbar' ) ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RemoveOperation( new Position( root, [ 2 ] ), 2, @@ -115,12 +117,12 @@ describe( 'RemoveOperation', () => { root.insertChildren( 0, new Text( 'bar' ) ); - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); expect( doc.version ).to.equal( 1 ); expect( root.maxOffset ).to.equal( 0 ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.maxOffset ).to.equal( 3 ); @@ -133,7 +135,7 @@ describe( 'RemoveOperation', () => { const position = new Position( doc.graveyard, [ 2 ] ); const operation = new RemoveOperation( position, 1, new Position( doc.graveyard, [ 0 ] ), 0 ); - doc.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( operation ) ); expect( doc.graveyard.childCount ).to.equal( 3 ); expect( doc.graveyard.getChild( 0 ).name ).to.equal( 'z' ); @@ -142,11 +144,10 @@ describe( 'RemoveOperation', () => { } ); it( 'should throw when is executed on detached item', () => { - const batch = doc.batch(); - const docFrag = batch.createDocumentFragment(); - const item = batch.createElement( 'foo' ); + const docFrag = new DocumentFragment(); + const item = new Element( 'foo' ); - batch.append( item, docFrag ); + docFrag.appendChildren( [ item ] ); const op = new RemoveOperation( new Position( docFrag, [ 0 ] ), diff --git a/tests/model/operation/renameoperation.js b/tests/model/operation/renameoperation.js index 669f829b9..c901d914c 100644 --- a/tests/model/operation/renameoperation.js +++ b/tests/model/operation/renameoperation.js @@ -3,7 +3,8 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; +import DocumentFragment from '../../../src/model/documentfragment'; import Element from '../../../src/model/element'; import RenameOperation from '../../../src/model/operation/renameoperation'; import Position from '../../../src/model/position'; @@ -14,10 +15,11 @@ describe( 'RenameOperation', () => { const oldName = 'oldName'; const newName = 'newName'; - let doc, root, element, position; + let model, doc, root, element, position; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); element = new Element( oldName ); @@ -35,7 +37,7 @@ describe( 'RenameOperation', () => { it( 'should change name of given element', () => { const op = new RenameOperation( position, oldName, newName, doc.version ); - doc.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( op ) ); expect( element.name ).to.equal( newName ); } ); @@ -55,8 +57,8 @@ describe( 'RenameOperation', () => { const op = new RenameOperation( position, oldName, newName, doc.version ); const reverse = op.getReversed(); - doc.applyOperation( wrapInDelta( op ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( element.name ).to.equal( oldName ); @@ -66,7 +68,7 @@ describe( 'RenameOperation', () => { const op = new RenameOperation( Position.createAt( root, 'end' ), oldName, newName, doc.version ); expect( () => { - doc.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( op ) ); } ).to.throw( CKEditorError, /rename-operation-wrong-position/ ); } ); @@ -74,7 +76,7 @@ describe( 'RenameOperation', () => { const op = new RenameOperation( position, 'foo', newName, doc.version ); expect( () => { - doc.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( op ) ); } ).to.throw( CKEditorError, /rename-operation-wrong-name/ ); } ); @@ -96,7 +98,7 @@ describe( 'RenameOperation', () => { const op = new RenameOperation( position, oldName, oldName, doc.version ); expect( () => { - doc.applyOperation( wrapInDelta( op ) ); + model.applyOperation( wrapInDelta( op ) ); } ).to.not.throw(); } ); @@ -108,11 +110,7 @@ describe( 'RenameOperation', () => { } ); it( 'should be false when target item is not in the document', () => { - const batch = doc.batch(); - const docFrag = batch.createDocumentFragment(); - - batch.appendElement( 'element', null, docFrag ); - + const docFrag = new DocumentFragment( [ new Element( 'element' ) ] ); const op = new RenameOperation( Position.createAt( docFrag ), oldName, newName, doc.version ); expect( op.isDocumentOperation ).to.false; diff --git a/tests/model/operation/rootattributeoperation.js b/tests/model/operation/rootattributeoperation.js index c7e43519d..509f9756c 100644 --- a/tests/model/operation/rootattributeoperation.js +++ b/tests/model/operation/rootattributeoperation.js @@ -3,16 +3,18 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; +import Element from '../../../src/model/element'; import RootAttributeOperation from '../../../src/model/operation/rootattributeoperation'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'RootAttributeOperation', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); } ); @@ -68,7 +70,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should be false when root is not in the document', () => { - const element = doc.batch().createElement( 'element' ); + const element = new Element( 'element' ); const operation = new RootAttributeOperation( element, @@ -83,7 +85,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should add attribute on the root element', () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RootAttributeOperation( root, 'isNew', @@ -100,7 +102,7 @@ describe( 'RootAttributeOperation', () => { it( 'should change attribute on the root element', () => { root.setAttribute( 'isNew', false ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RootAttributeOperation( root, 'isNew', @@ -117,7 +119,7 @@ describe( 'RootAttributeOperation', () => { it( 'should remove attribute from the root element', () => { root.setAttribute( 'x', true ); - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RootAttributeOperation( root, 'x', @@ -154,8 +156,8 @@ describe( 'RootAttributeOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.hasAttribute( 'x' ) ).to.be.false; @@ -174,8 +176,8 @@ describe( 'RootAttributeOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.getAttribute( 'isNew' ) ).to.be.false; @@ -194,8 +196,8 @@ describe( 'RootAttributeOperation', () => { const reverse = operation.getReversed(); - doc.applyOperation( wrapInDelta( operation ) ); - doc.applyOperation( wrapInDelta( reverse ) ); + model.applyOperation( wrapInDelta( operation ) ); + model.applyOperation( wrapInDelta( reverse ) ); expect( doc.version ).to.equal( 2 ); expect( root.getAttribute( 'foo' ) ).to.be.true; @@ -203,7 +205,7 @@ describe( 'RootAttributeOperation', () => { it( 'should throw an error when one try to remove and the attribute does not exists', () => { expect( () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RootAttributeOperation( root, 'foo', @@ -219,7 +221,7 @@ describe( 'RootAttributeOperation', () => { root.setAttribute( 'x', 1 ); expect( () => { - doc.applyOperation( wrapInDelta( + model.applyOperation( wrapInDelta( new RootAttributeOperation( root, 'x', diff --git a/tests/model/operation/transform.js b/tests/model/operation/transform.js index a53a1671e..b78a17c13 100644 --- a/tests/model/operation/transform.js +++ b/tests/model/operation/transform.js @@ -5,7 +5,7 @@ import transform from '../../../src/model/operation/transform'; -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import RootElement from '../../../src/model/rootelement'; import Node from '../../../src/model/node'; import Position from '../../../src/model/position'; @@ -24,7 +24,9 @@ describe( 'transform', () => { let doc, root, op, nodeA, nodeB, expected, baseVersion; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); nodeA = new Node(); diff --git a/tests/model/operation/utils.js b/tests/model/operation/utils.js index fa30e86e7..29b9658c4 100644 --- a/tests/model/operation/utils.js +++ b/tests/model/operation/utils.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import DocumentFragment from '../../../src/model/documentfragment'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; @@ -15,12 +15,13 @@ import { getData } from '../../../src/dev-utils/model'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; -let doc, root; +let model, doc, root; -describe( 'writer utils', () => { +describe( 'Operation utils', () => { beforeEach( () => { - doc = new Document(); - doc.schema.allow( { name: '$text', inside: '$root' } ); + model = new Model(); + doc = model.document; + model.schema.allow( { name: '$text', inside: '$root' } ); root = doc.createRoot(); @@ -204,5 +205,5 @@ describe( 'normalizeNodes', () => { } ); function expectData( html ) { - expect( getData( doc, { withoutSelection: true } ) ).to.equal( html ); + expect( getData( model, { withoutSelection: true } ) ).to.equal( html ); } From b60affb36c41ae681635f0262520012f6888a456 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sun, 10 Dec 2017 22:28:36 +0100 Subject: [PATCH 131/724] Added destroy method to Model class. --- src/model/model.js | 8 ++++++++ tests/model/model.js | 22 ++++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/src/model/model.js b/src/model/model.js index 4685b9406..909894425 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -87,6 +87,14 @@ export default class Model { applyOperation( operation ) { return operation._execute(); } + + /** + * Removes all events listeners set by model instance and destroy Document. + */ + destroy() { + this.document.destroy(); + this.stopListening(); + } } mix( Model, ObservableMixin ); diff --git a/tests/model/model.js b/tests/model/model.js index 5002e5e86..c20bd26dc 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -304,4 +304,26 @@ describe( 'Model', () => { } ); } ); } ); + + describe( 'destroy()', () => { + it( 'should destroy document', () => { + sinon.spy( model.document, 'destroy' ); + + model.destroy(); + + sinon.assert.calledOnce( model.document.destroy ); + } ); + + it( 'should stop listening', () => { + const spy = sinon.spy(); + + model.on( 'event', spy ); + + model.destroy(); + + model.fire( 'event' ); + + sinon.assert.notCalled( spy ); + } ); + } ); } ); From f20145dbf1eba5bae24074ac9f0aa5c839a47f40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sun, 10 Dec 2017 22:29:00 +0100 Subject: [PATCH 132/724] Aligned DocumentSelection tests with engine changes. --- src/model/documentselection.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index d7c44b64e..925eb6336 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -98,7 +98,7 @@ export default class DocumentSelection extends Selection { if ( batch && batch.type !== 'transparent' ) { // Whenever element which had selection's attributes stored in it stops being empty, // the attributes need to be removed. - clearAttributesStoredInElement( changes, this._model ); + clearAttributesStoredInElement( changes, this._model, batch ); } } ); } @@ -730,7 +730,7 @@ function getAttrsIfCharacter( node ) { } // Removes selection attributes from element which is not empty anymore. -function clearAttributesStoredInElement( changes, model ) { +function clearAttributesStoredInElement( changes, model, batch ) { const changeParent = changes.range && changes.range.start.parent; // `changes.range` is not set in case of rename, root and marker operations. @@ -739,7 +739,7 @@ function clearAttributesStoredInElement( changes, model ) { return; } - model.change( writer => { + model.enqueueChange( batch, writer => { const storedAttributes = Array.from( changeParent.getAttributeKeys() ).filter( key => key.startsWith( storePrefix ) ); for ( const key of storedAttributes ) { From 4b67d1218ffd79d9c3bd0018a1f98f310b506b35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 01:09:30 +0100 Subject: [PATCH 133/724] Fixed failing Model test. --- tests/model/model.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tests/model/model.js b/tests/model/model.js index c20bd26dc..12db5cc6a 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -4,6 +4,7 @@ */ import Model from '../../src/model/model'; +import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; describe( 'Model', () => { let model; @@ -315,13 +316,14 @@ describe( 'Model', () => { } ); it( 'should stop listening', () => { + const emitter = Object.create( EmitterMixin ); const spy = sinon.spy(); - model.on( 'event', spy ); + model.listenTo( emitter, 'event', spy ); model.destroy(); - model.fire( 'event' ); + emitter.fire( 'event' ); sinon.assert.notCalled( spy ); } ); From 04caf1c48b77d1bb02ee898eb1c4ff977c967444 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 01:24:05 +0100 Subject: [PATCH 134/724] Aligned schema tests with engine changes. --- tests/model/schema/schema.js | 154 +++++++++++++++++++---------------- 1 file changed, 85 insertions(+), 69 deletions(-) diff --git a/tests/model/schema/schema.js b/tests/model/schema/schema.js index 9f89ca0a5..f4682a5e0 100644 --- a/tests/model/schema/schema.js +++ b/tests/model/schema/schema.js @@ -4,7 +4,7 @@ */ import { default as Schema, SchemaItem } from '../../../src/model/schema'; -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; import DocumentFragment from '../../../src/model/documentfragment'; @@ -302,7 +302,8 @@ describe( 'Schema', () => { let doc, root; beforeEach( () => { - doc = new Document(); + const model = new Model(); + doc = model.document; root = doc.createRoot( 'div' ); root.insertChildren( 0, [ @@ -464,7 +465,8 @@ describe( 'Schema', () => { } ); it( 'should normalize model position to an array of strings', () => { - const doc = new Document(); + const model = new Model(); + const doc = model.document; const root = doc.createRoot(); root.insertChildren( 0, [ @@ -494,13 +496,14 @@ describe( 'Schema', () => { describe( 'checkAttributeInSelection()', () => { const attribute = 'bold'; - let doc, schema; + let model, doc, schema; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; doc.createRoot(); - schema = doc.schema; + schema = model.schema; schema.registerItem( 'p', '$block' ); schema.registerItem( 'h1', '$block' ); @@ -521,15 +524,15 @@ describe( 'Schema', () => { describe( 'when selection is collapsed', () => { it( 'should return true if characters with the attribute can be placed at caret position', () => { - setData( doc, '

f[]oo

' ); + setData( model, '

f[]oo

' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true; } ); it( 'should return false if characters with the attribute cannot be placed at caret position', () => { - setData( doc, '

[]

' ); + setData( model, '

[]

' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false; - setData( doc, '[]' ); + setData( model, '[]' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false; } ); } ); @@ -537,39 +540,39 @@ describe( 'Schema', () => { describe( 'when selection is not collapsed', () => { it( 'should return true if there is at least one node in selection that can have the attribute', () => { // Simple selection on a few characters. - setData( doc, '

[foo]

' ); + setData( model, '

[foo]

' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true; // Selection spans over characters but also include nodes that can't have attribute. - setData( doc, '

fo[ob]ar

' ); + setData( model, '

fo[ob]ar

' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true; // Selection on whole root content. Characters in P can have an attribute so it's valid. - setData( doc, '[

foobar

]' ); + setData( model, '[

foobar

]' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true; // Selection on empty P. P can have the attribute. - setData( doc, '[

]' ); + setData( model, '[

]' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.true; } ); it( 'should return false if there are no nodes in selection that can have the attribute', () => { // Selection on DIV which can't have bold text. - setData( doc, '[

]' ); + setData( model, '[

]' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false; // Selection on two images which can't be bold. - setData( doc, '

foo[]bar

' ); + setData( model, '

foo[]bar

' ); expect( schema.checkAttributeInSelection( doc.selection, attribute ) ).to.be.false; } ); it( 'should return true when checking element with required attribute', () => { - setData( doc, '[
]' ); + setData( model, '[
]' ); expect( schema.checkAttributeInSelection( doc.selection, 'title' ) ).to.be.true; } ); it( 'should return true when checking element when attribute is already present', () => { - setData( doc, '[
]' ); + setData( model, '[
]' ); expect( schema.checkAttributeInSelection( doc.selection, 'title' ) ).to.be.true; } ); } ); @@ -577,11 +580,12 @@ describe( 'Schema', () => { describe( 'getValidRanges()', () => { const attribute = 'bold'; - let doc, root, schema, ranges; + let model, doc, root, schema, ranges; beforeEach( () => { - doc = new Document(); - schema = doc.schema; + model = new Model(); + doc = model.document; + schema = model.schema; root = doc.createRoot(); schema.registerItem( 'p', '$block' ); @@ -591,7 +595,7 @@ describe( 'Schema', () => { schema.allow( { name: '$text', attributes: 'bold', inside: 'p' } ); schema.allow( { name: 'p', attributes: 'bold', inside: '$root' } ); - setData( doc, '

foobar

' ); + setData( model, '

foobar

' ); ranges = [ Range.createOn( root.getChild( 0 ) ) ]; } ); @@ -612,7 +616,7 @@ describe( 'Schema', () => { schema.allow( { name: 'img', attributes: 'bold', inside: 'p' } ); schema.allow( { name: '$text', inside: 'img' } ); - setData( doc, '[

fooxxxbar

]' ); + setData( model, '[

fooxxxbar

]' ); const validRanges = schema.getValidRanges( doc.selection.getRanges(), attribute ); const sel = new Selection(); @@ -625,7 +629,7 @@ describe( 'Schema', () => { schema.allow( { name: '$text', inside: 'img' } ); schema.allow( { name: '$text', attributes: 'bold', inside: 'img' } ); - setData( doc, '[

fooxxxbar

]' ); + setData( model, '[

fooxxxbar

]' ); const validRanges = schema.getValidRanges( doc.selection.getRanges(), attribute ); const sel = new Selection(); @@ -635,7 +639,7 @@ describe( 'Schema', () => { } ); it( 'should not leak beyond the given ranges', () => { - setData( doc, '

[foobar]x[barfoo]

' ); + setData( model, '

[foobar]x[barfoo]

' ); const validRanges = schema.getValidRanges( doc.selection.getRanges(), attribute ); const sel = new Selection(); @@ -647,7 +651,7 @@ describe( 'Schema', () => { it( 'should correctly handle a range which ends in a disallowed position', () => { schema.allow( { name: '$text', inside: 'img' } ); - setData( doc, '

[foobar]bom

' ); + setData( model, '

[foobar]bom

' ); const validRanges = schema.getValidRanges( doc.selection.getRanges(), attribute ); const sel = new Selection(); @@ -658,7 +662,7 @@ describe( 'Schema', () => { it( 'should split range into two ranges and omit disallowed element', () => { // Disallow bold on img. - doc.schema.disallow( { name: 'img', attributes: 'bold', inside: 'p' } ); + model.schema.disallow( { name: 'img', attributes: 'bold', inside: 'p' } ); const result = schema.getValidRanges( ranges, attribute ); @@ -671,11 +675,12 @@ describe( 'Schema', () => { } ); describe( 'getLimitElement()', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); - schema = doc.schema; + model = new Model(); + doc = model.document; + schema = model.schema; root = doc.createRoot(); schema.registerItem( 'div', '$block' ); @@ -696,7 +701,7 @@ describe( 'Schema', () => { it( 'always returns $root element if any other limit was not defined', () => { schema.limits.clear(); - setData( doc, '
foo[]bar
' ); + setData( model, '
foo[]bar
' ); expect( schema.getLimitElement( doc.selection ) ).to.equal( root ); } ); @@ -704,7 +709,7 @@ describe( 'Schema', () => { schema.limits.add( 'article' ); schema.limits.add( 'section' ); - setData( doc, '
foo[]bar
' ); + setData( model, '
foo[]bar
' ); const article = root.getNodeByPath( [ 0, 0, 0 ] ); @@ -715,7 +720,7 @@ describe( 'Schema', () => { schema.limits.add( 'article' ); schema.limits.add( 'section' ); - setData( doc, '
[foo
bar]
' ); + setData( model, '
[foo
bar]
' ); const section = root.getNodeByPath( [ 0, 0 ] ); @@ -728,7 +733,7 @@ describe( 'Schema', () => { schema.limits.add( 'div' ); setData( - doc, + model, '
' + '
' + '
' + @@ -751,7 +756,7 @@ describe( 'Schema', () => { schema.limits.clear(); setData( - doc, + model, '
' + '
' + '
' + @@ -767,12 +772,13 @@ describe( 'Schema', () => { } ); describe( 'removeDisallowedAttributes()', () => { - let doc, root; + let model, doc, root; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); - schema = doc.schema; + schema = model.schema; schema.registerItem( 'paragraph', '$block' ); schema.registerItem( 'div', '$block' ); @@ -794,18 +800,19 @@ describe( 'Schema', () => { it( 'should filter out disallowed attributes from given nodes', () => { const root = doc.getRoot(); - const batch = doc.batch(); root.appendChildren( [ text, image ] ); - schema.removeDisallowedAttributes( [ text, image ], '$root', batch ); + model.change( writer => { + schema.removeDisallowedAttributes( [ text, image ], '$root', writer ); - expect( Array.from( text.getAttributeKeys() ) ).to.deep.equal( [ 'a' ] ); - expect( Array.from( image.getAttributeKeys() ) ).to.deep.equal( [ 'b' ] ); + expect( Array.from( text.getAttributeKeys() ) ).to.deep.equal( [ 'a' ] ); + expect( Array.from( image.getAttributeKeys() ) ).to.deep.equal( [ 'b' ] ); - expect( batch.deltas ).to.length( 2 ); - expect( batch.deltas[ 0 ] ).to.instanceof( AttributeDelta ); - expect( batch.deltas[ 1 ] ).to.instanceof( AttributeDelta ); + expect( writer.batch.deltas ).to.length( 2 ); + expect( writer.batch.deltas[ 0 ] ).to.instanceof( AttributeDelta ); + expect( writer.batch.deltas[ 1 ] ).to.instanceof( AttributeDelta ); + } ); } ); } ); @@ -827,31 +834,32 @@ describe( 'Schema', () => { div = new Element( 'div', [], [ paragraph, bar, imageInDiv ] ); } ); - it( 'should filter out disallowed attributes from child nodes (batch)', () => { + it( 'should filter out disallowed attributes from child nodes', () => { const root = doc.getRoot(); - const batch = doc.batch(); root.appendChildren( [ div ] ); - schema.removeDisallowedAttributes( [ div ], '$root', batch ); - - expect( batch.deltas ).to.length( 4 ); - expect( batch.deltas[ 0 ] ).to.instanceof( AttributeDelta ); - expect( batch.deltas[ 1 ] ).to.instanceof( AttributeDelta ); - expect( batch.deltas[ 2 ] ).to.instanceof( AttributeDelta ); - expect( batch.deltas[ 3 ] ).to.instanceof( AttributeDelta ); - - expect( getData( doc, { withoutSelection: true } ) ) - .to.equal( - '
' + - '' + - '<$text b="1">foo' + - '' + - '' + - '<$text a="1">bar' + - '' + - '
' - ); + model.change( writer => { + schema.removeDisallowedAttributes( [ div ], '$root', writer ); + + expect( writer.batch.deltas ).to.length( 4 ); + expect( writer.batch.deltas[ 0 ] ).to.instanceof( AttributeDelta ); + expect( writer.batch.deltas[ 1 ] ).to.instanceof( AttributeDelta ); + expect( writer.batch.deltas[ 2 ] ).to.instanceof( AttributeDelta ); + expect( writer.batch.deltas[ 3 ] ).to.instanceof( AttributeDelta ); + + expect( getData( model, { withoutSelection: true } ) ) + .to.equal( + '
' + + '' + + '<$text b="1">foo' + + '' + + '' + + '<$text a="1">bar' + + '' + + '
' + ); + } ); } ); } ); @@ -870,21 +878,27 @@ describe( 'Schema', () => { } ); it( 'should accept iterable as nodes', () => { - schema.removeDisallowedAttributes( frag.getChildren(), '$root', doc.batch() ); + model.change( writer => { + schema.removeDisallowedAttributes( frag.getChildren(), '$root', writer ); + } ); expect( stringify( frag ) ) .to.equal( '<$text a="1">foo<$text b="1">barbiz' ); } ); it( 'should accept Position as inside', () => { - schema.removeDisallowedAttributes( frag.getChildren(), Position.createAt( root ), doc.batch() ); + model.change( writer => { + schema.removeDisallowedAttributes( frag.getChildren(), Position.createAt( root ), writer ); + } ); expect( stringify( frag ) ) .to.equal( '<$text a="1">foo<$text b="1">barbiz' ); } ); it( 'should accept Node as inside', () => { - schema.removeDisallowedAttributes( frag.getChildren(), [ root ], doc.batch() ); + model.change( writer => { + schema.removeDisallowedAttributes( frag.getChildren(), [ root ], writer ); + } ); expect( stringify( frag ) ) .to.equal( '<$text a="1">foo<$text b="1">barbiz' ); @@ -897,7 +911,9 @@ describe( 'Schema', () => { const image = new Element( 'image', { a: 1, b: 1 } ); - schema.removeDisallowedAttributes( [ image ], '$root', doc.batch() ); + model.change( writer => { + schema.removeDisallowedAttributes( [ image ], '$root', writer ); + } ); expect( Array.from( image.getAttributeKeys() ) ).to.deep.equal( [ 'a', 'b' ] ); } ); From 847153a1f7efd56ad804555a86b004f84c36a84b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 11:19:41 +0100 Subject: [PATCH 135/724] Aligned tests with engine changes. --- tests/model/position.js | 11 ++-- tests/model/range.js | 6 +- tests/model/rootelement.js | 9 ++- tests/model/selection.js | 109 +++++++++++++++++++------------------ tests/model/textproxy.js | 7 ++- 5 files changed, 76 insertions(+), 66 deletions(-) diff --git a/tests/model/position.js b/tests/model/position.js index 1b5a23eb5..ecbbe9772 100644 --- a/tests/model/position.js +++ b/tests/model/position.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DocumentFragment from '../../src/model/documentfragment'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; @@ -30,8 +30,9 @@ describe( 'Position', () => { // |- a Before: [ 1, 1, 1 ] After: [ 1, 1, 2 ] // |- r Before: [ 1, 1, 2 ] After: [ 1, 1, 3 ] before( () => { - doc = new Document(); + const model = new Model(); + doc = model.document; root = doc.createRoot(); otherRoot = doc.createRoot( '$root', 'otherRoot' ); @@ -861,7 +862,8 @@ describe( 'Position', () => { } ); it( 'for two the same positions returns the parent element #2', () => { - const doc = new Document(); + const model = new Model(); + const doc = model.document; const root = doc.createRoot(); const p = new Element( 'p', null, 'foobar' ); @@ -889,7 +891,8 @@ describe( 'Position', () => { // Checks if by mistake someone didn't use getCommonPath() + getNodeByPath(). it( 'works if position is located before an element', () => { - const doc = new Document(); + const model = new Model(); + const doc = model.document; const root = doc.createRoot(); const p = new Element( 'p', null, new Element( 'a' ) ); diff --git a/tests/model/range.js b/tests/model/range.js index adf1bb9c2..e9d5f0f5f 100644 --- a/tests/model/range.js +++ b/tests/model/range.js @@ -7,7 +7,7 @@ import Range from '../../src/model/range'; import Position from '../../src/model/position'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import TreeWalker from '../../src/model/treewalker'; import MergeDelta from '../../src/model/delta/mergedelta'; import MoveOperation from '../../src/model/operation/moveoperation'; @@ -31,7 +31,9 @@ describe( 'Range', () => { let doc, range, start, end, root, otherRoot; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); otherRoot = doc.createRoot( '$root', 'otherRoot' ); diff --git a/tests/model/rootelement.js b/tests/model/rootelement.js index 19211f9ac..383f6850f 100644 --- a/tests/model/rootelement.js +++ b/tests/model/rootelement.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import Element from '../../src/model/element'; import RootElement from '../../src/model/rootelement'; import count from '@ckeditor/ckeditor5-utils/src/count'; @@ -11,7 +11,8 @@ import count from '@ckeditor/ckeditor5-utils/src/count'; describe( 'RootElement', () => { describe( 'constructor()', () => { it( 'should create root element without attributes', () => { - const doc = new Document(); + const model = new Model(); + const doc = model.document; const root = new RootElement( doc ); expect( root ).to.be.an.instanceof( Element ); @@ -25,7 +26,9 @@ describe( 'RootElement', () => { let root; before( () => { - const doc = new Document(); + const model = new Model(); + const doc = model.document; + root = new RootElement( doc, '$root' ); } ); diff --git a/tests/model/selection.js b/tests/model/selection.js index ad7b2f399..b6ebbcdde 100644 --- a/tests/model/selection.js +++ b/tests/model/selection.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; import Range from '../../src/model/range'; @@ -19,10 +19,11 @@ import Schema from '../../src/model/schema'; testUtils.createSinonSandbox(); describe( 'Selection', () => { - let doc, root, selection, liveRange, range, range1, range2, range3; + let model, doc, root, selection, liveRange, range, range1, range2, range3; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); root.appendChildren( [ new Element( 'p' ), @@ -44,7 +45,7 @@ describe( 'Selection', () => { } ); afterEach( () => { - doc.destroy(); + model.destroy(); liveRange.detach(); } ); @@ -894,14 +895,14 @@ describe( 'Selection', () => { } ); it( 'should return selected element', () => { - const { selection, model } = parse( '

foo

[

bar

]

baz

', schema, doc.batch() ); + const { selection, model } = parse( '

foo

[

bar

]

baz

', schema ); const p = model.getChild( 1 ); expect( selection.getSelectedElement() ).to.equal( p ); } ); it( 'should return null if there is more than one range', () => { - const { selection } = parse( '[

foo

][

bar

]

baz

', schema, doc.batch() ); + const { selection } = parse( '[

foo

][

bar

]

baz

', schema ); expect( selection.getSelectedElement() ).to.be.null; } ); @@ -911,13 +912,13 @@ describe( 'Selection', () => { } ); it( 'should return null if selection is not over single element #1', () => { - const { selection } = parse( '

foo

[

bar

baz}

', schema, doc.batch() ); + const { selection } = parse( '

foo

[

bar

baz}

', schema ); expect( selection.getSelectedElement() ).to.be.null; } ); it( 'should return null if selection is not over single element #2', () => { - const { selection } = parse( '

{bar}

', schema, doc.batch() ); + const { selection } = parse( '

{bar}

', schema ); expect( selection.getSelectedElement() ).to.be.null; } ); @@ -925,37 +926,37 @@ describe( 'Selection', () => { describe( 'getSelectedBlocks()', () => { beforeEach( () => { - doc.schema.registerItem( 'p', '$block' ); - doc.schema.registerItem( 'h', '$block' ); + model.schema.registerItem( 'p', '$block' ); + model.schema.registerItem( 'h', '$block' ); - doc.schema.registerItem( 'blockquote' ); - doc.schema.allow( { name: 'blockquote', inside: '$root' } ); - doc.schema.allow( { name: '$block', inside: 'blockquote' } ); + model.schema.registerItem( 'blockquote' ); + model.schema.allow( { name: 'blockquote', inside: '$root' } ); + model.schema.allow( { name: '$block', inside: 'blockquote' } ); - doc.schema.registerItem( 'image' ); - doc.schema.allow( { name: 'image', inside: '$root' } ); - doc.schema.allow( { name: 'image', inside: '$block' } ); - doc.schema.allow( { name: '$text', inside: 'image' } ); + model.schema.registerItem( 'image' ); + model.schema.allow( { name: 'image', inside: '$root' } ); + model.schema.allow( { name: 'image', inside: '$block' } ); + model.schema.allow( { name: '$text', inside: 'image' } ); // Special block which can contain another blocks. - doc.schema.registerItem( 'nestedBlock', '$block' ); - doc.schema.allow( { name: 'nestedBlock', inside: '$block' } ); + model.schema.registerItem( 'nestedBlock', '$block' ); + model.schema.allow( { name: 'nestedBlock', inside: '$block' } ); } ); it( 'returns an iterator', () => { - setData( doc, '

a

[]b

c

' ); + setData( model, '

a

[]b

c

' ); expect( doc.selection.getSelectedBlocks().next ).to.be.a( 'function' ); } ); it( 'returns block for a collapsed selection', () => { - setData( doc, '

a

[]b

c

' ); + setData( model, '

a

[]b

c

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] ); } ); it( 'returns block for a collapsed selection (empty block)', () => { - setData( doc, '

a

[]

c

' ); + setData( model, '

a

[]

c

' ); const blocks = Array.from( doc.selection.getSelectedBlocks() ); @@ -964,67 +965,67 @@ describe( 'Selection', () => { } ); it( 'returns block for a non collapsed selection', () => { - setData( doc, '

a

[b]

c

' ); + setData( model, '

a

[b]

c

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] ); } ); it( 'returns two blocks for a non collapsed selection', () => { - setData( doc, '

a

[b

c]

d

' ); + setData( model, '

a

[b

c]

d

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'c' ] ); } ); it( 'returns two blocks for a non collapsed selection (starts at block end)', () => { - setData( doc, '

a

b[

c]

d

' ); + setData( model, '

a

b[

c]

d

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'c' ] ); } ); it( 'returns proper block for a multi-range selection', () => { - setData( doc, '

a

[b

c]

d

[e]

' ); + setData( model, '

a

[b

c]

d

[e]

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b', 'c', 'e' ] ); } ); it( 'does not return a block twice if two ranges are anchored in it', () => { - setData( doc, '

[a]b[c]

' ); + setData( model, '

[a]b[c]

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'abc' ] ); } ); it( 'returns only blocks', () => { - setData( doc, '

[a

b

c]

' ); + setData( model, '

[a

b

c]

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'c' ] ); } ); it( 'gets deeper into the tree', () => { - setData( doc, '

[a

b

c

d]

' ); + setData( model, '

[a

b

c

d]

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b', 'c', 'd' ] ); } ); it( 'gets deeper into the tree (end deeper)', () => { - setData( doc, '

[a

b]

c

d

' ); + setData( model, '

[a

b]

c

d

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b' ] ); } ); it( 'gets deeper into the tree (start deeper)', () => { - setData( doc, '

a

b

[c

d]

' ); + setData( model, '

a

b

[c

d]

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'c', 'd' ] ); } ); it( 'returns an empty array if none of the selected elements is a block', () => { - setData( doc, '

a

[ab]

b

' ); + setData( model, '

a

[ab]

b

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.be.empty; } ); it( 'returns an empty array if the selected element is not a block', () => { - setData( doc, '

a

[]a

b

' ); + setData( model, '

a

[]a

b

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.be.empty; } ); @@ -1032,7 +1033,7 @@ describe( 'Selection', () => { // Super edge case – should not happen (blocks should never be nested), // but since the code handles it already it's worth testing. it( 'returns only the lowest block if blocks are nested', () => { - setData( doc, 'a[]b' ); + setData( model, 'a[]b' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] ); } ); @@ -1040,7 +1041,7 @@ describe( 'Selection', () => { // Like above but trickier. it( 'returns only the lowest block if blocks are nested', () => { setData( - doc, + model, 'a[b' + 'cd]' ); @@ -1051,26 +1052,26 @@ describe( 'Selection', () => { it( 'returns nothing if directly in a root', () => { doc.createRoot( 'p', 'inlineOnlyRoot' ); - setData( doc, 'a[b]c', { rootName: 'inlineOnlyRoot' } ); + setData( model, 'a[b]c', { rootName: 'inlineOnlyRoot' } ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.be.empty; } ); describe( '#984', () => { it( 'does not return the last block if none of its content is selected', () => { - setData( doc, '

[a

b

]c

' ); + setData( model, '

[a

b

]c

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b' ] ); } ); it( 'returns only the first block for a non collapsed selection if only end of selection is touching a block', () => { - setData( doc, '

a

b[

]c

d

' ); + setData( model, '

a

b[

]c

d

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'b' ] ); } ); it( 'does not return the last block if none of its content is selected (nested case)', () => { - setData( doc, '

[a

]b' ); + setData( model, '

[a

]b' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a' ] ); } ); @@ -1078,20 +1079,20 @@ describe( 'Selection', () => { // Like a super edge case, we can live with this behavior as I don't even know what we could expect here // since only the innermost block is considerd a block to return (so the b... needs to be ignored). it( 'does not return the last block if none of its content is selected (nested case, wrapper with a content)', () => { - setData( doc, '

[a

b]c' ); + setData( model, '

[a

b]c' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a' ] ); } ); it( 'returns the last block if at least one of its child nodes is selected', () => { - setData( doc, '

[a

b

]c

' ); + setData( model, '

[a

b

]c

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b', 'c' ] ); } ); // I needed these last 2 cases to justify the use of isTouching() instead of simple `offset == 0` check. it( 'returns the last block if at least one of its child nodes is selected (end in an inline element)', () => { - setData( doc, '

[a

b

x]c

' ); + setData( model, '

[a

b

x]c

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b', 'c' ] ); } ); @@ -1100,7 +1101,7 @@ describe( 'Selection', () => { 'does not return the last block if at least one of its child nodes is selected ' + '(end in an inline element, no content selected)', () => { - setData( doc, '

[a

b

]xc

' ); + setData( model, '

[a

b

]xc

' ); expect( toText( doc.selection.getSelectedBlocks() ) ).to.deep.equal( [ 'a', 'b' ] ); } @@ -1309,24 +1310,24 @@ describe( 'Selection', () => { describe( 'containsEntireContent()', () => { beforeEach( () => { - doc.schema.registerItem( 'p', '$block' ); - doc.schema.allow( { name: 'p', inside: '$root' } ); + model.schema.registerItem( 'p', '$block' ); + model.schema.allow( { name: 'p', inside: '$root' } ); } ); it( 'returns true if the entire content in $root is selected', () => { - setData( doc, '

[Foo

Bom

Bar]

' ); + setData( model, '

[Foo

Bom

Bar]

' ); expect( doc.selection.containsEntireContent() ).to.equal( true ); } ); it( 'returns false when only a fragment of the content in $root is selected', () => { - setData( doc, '

Fo[o

Bom

Bar]

' ); + setData( model, '

Fo[o

Bom

Bar]

' ); expect( doc.selection.containsEntireContent() ).to.equal( false ); } ); it( 'returns true if the entire content in specified element is selected', () => { - setData( doc, '

Foo

[Bom]

Bar

' ); + setData( model, '

Foo

[Bom]

Bar

' ); const root = doc.getRoot(); const secondParagraph = root.getNodeByPath( [ 1 ] ); @@ -1335,7 +1336,7 @@ describe( 'Selection', () => { } ); it( 'returns false if the entire content in specified element is not selected', () => { - setData( doc, '

Foo

[Bom

B]ar

' ); + setData( model, '

Foo

[Bom

B]ar

' ); const root = doc.getRoot(); const secondParagraph = root.getNodeByPath( [ 1 ] ); @@ -1344,22 +1345,22 @@ describe( 'Selection', () => { } ); it( 'returns false when the entire content except an empty element is selected', () => { - doc.schema.registerItem( 'img', '$inline' ); - doc.schema.allow( { name: 'img', inside: 'p' } ); + model.schema.registerItem( 'img', '$inline' ); + model.schema.allow( { name: 'img', inside: 'p' } ); - setData( doc, '

[Foo]

' ); + setData( model, '

[Foo]

' ); expect( doc.selection.containsEntireContent() ).to.equal( false ); } ); it( 'returns true if the content is empty', () => { - setData( doc, '[]' ); + setData( model, '[]' ); expect( doc.selection.containsEntireContent() ).to.equal( true ); } ); it( 'returns false if empty selection is at the end of non-empty content', () => { - setData( doc, '

Foo bar bom.

[]' ); + setData( model, '

Foo bar bom.

[]' ); expect( doc.selection.containsEntireContent() ).to.equal( false ); } ); diff --git a/tests/model/textproxy.js b/tests/model/textproxy.js index 55ea4821f..faf3c18fc 100644 --- a/tests/model/textproxy.js +++ b/tests/model/textproxy.js @@ -6,14 +6,15 @@ import Element from '../../src/model/element'; import Text from '../../src/model/text'; import TextProxy from '../../src/model/textproxy'; -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'TextProxy', () => { - let doc, element, textProxy, root, textProxyNoParent, text, textNoParent; + let model, doc, element, textProxy, root, textProxyNoParent, text, textNoParent; beforeEach( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); element = new Element( 'div' ); root.insertChildren( 0, element ); From 68f36093de3a07e19a3dd2112391ac8dd3f636b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 14:58:31 +0100 Subject: [PATCH 136/724] Aligned tests with engine changes. --- tests/model/treewalker.js | 7 ++++--- tests/model/utils-tests/utils.js | 6 ++++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/tests/model/treewalker.js b/tests/model/treewalker.js index 90fad3bd4..937f0dd16 100644 --- a/tests/model/treewalker.js +++ b/tests/model/treewalker.js @@ -3,7 +3,7 @@ * For licensing, see LICENSE.md. */ -import Document from '../../src/model/document'; +import Model from '../../src/model/model'; import DocumentFragment from '../../src/model/documentfragment'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; @@ -13,11 +13,12 @@ import Range from '../../src/model/range'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'TreeWalker', () => { - let doc, root, img1, paragraph, ba, r, img2, x, + let model, doc, root, img1, paragraph, ba, r, img2, x, rootBeginning, rootEnding; before( () => { - doc = new Document(); + model = new Model(); + doc = model.document; root = doc.createRoot(); // root diff --git a/tests/model/utils-tests/utils.js b/tests/model/utils-tests/utils.js index 0b2ed916d..85995f9f0 100644 --- a/tests/model/utils-tests/utils.js +++ b/tests/model/utils-tests/utils.js @@ -11,7 +11,7 @@ import { getText, createRangeOnElementOnly } from '../../../tests/model/_utils/utils'; -import Document from '../../../src/model/document'; +import Model from '../../../src/model/model'; import Range from '../../../src/model/range'; import Element from '../../../src/model/element'; import Text from '../../../src/model/text'; @@ -24,7 +24,9 @@ describe( 'getNodesAndText', () => { let doc, root, div, p; beforeEach( () => { - doc = new Document(); + const model = new Model(); + + doc = model.document; root = doc.createRoot(); div = new Element( 'div', [], new Text( 'foobar' ) ); From caba101cf3709c9f2dd1e93736e312ff59c6b278 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 14:58:49 +0100 Subject: [PATCH 137/724] Increased model CC. --- src/model/document.js | 25 +---- tests/model/document/document.js | 162 ++++++++++++++++--------------- tests/model/documentselection.js | 9 +- 3 files changed, 88 insertions(+), 108 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index bcfafd7c1..6b681e962 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -185,30 +185,6 @@ export default class Document { this.stopListening(); } - /** - * Enqueues document changes. Any changes to be done on document (mostly using {@link #batch} - * should be placed in the queued callback. If no other plugin is changing document at the moment, the callback will be - * called immediately. Otherwise it will wait for all previously queued changes to finish happening. This way - * queued callback will not interrupt other callbacks. - * - * When all queued changes are done {@link #event:changesDone} event is fired. - * - * @fires changesDone - * @param {Function} callback Callback to enqueue. - */ - enqueueChanges( callback ) { - this._pendingChanges.push( callback ); - - if ( this._pendingChanges.length == 1 ) { - while ( this._pendingChanges.length ) { - this._pendingChanges[ 0 ](); - this._pendingChanges.shift(); - } - - this.fire( 'changesDone' ); - } - } - /** * Returns top-level root by its name. * @@ -334,6 +310,7 @@ export default class Document { // Due to circular references we need to remove parent reference. json.selection = '[engine.model.DocumentSelection]'; + json.model = '[engine.model.Model]'; return json; } diff --git a/tests/model/document/document.js b/tests/model/document/document.js index b274b8d17..0599acd3e 100644 --- a/tests/model/document/document.js +++ b/tests/model/document/document.js @@ -41,81 +41,7 @@ describe( 'Document', () => { } ); } ); - describe( 'getRootNames()', () => { - it( 'should return empty iterator if no roots exist', () => { - expect( count( doc.getRootNames() ) ).to.equal( 0 ); - } ); - - it( 'should return an iterator of all roots without the graveyard', () => { - doc.createRoot( '$root', 'a' ); - doc.createRoot( '$root', 'b' ); - - expect( Array.from( doc.getRootNames() ) ).to.deep.equal( [ 'a', 'b' ] ); - } ); - } ); - - describe( 'createRoot()', () => { - it( 'should create a new RootElement with default element and root names, add it to roots map and return it', () => { - const root = doc.createRoot(); - - expect( doc.roots.size ).to.equal( 2 ); - expect( root ).to.be.instanceof( RootElement ); - expect( root.maxOffset ).to.equal( 0 ); - expect( root ).to.have.property( 'name', '$root' ); - expect( root ).to.have.property( 'rootName', 'main' ); - } ); - - it( 'should create a new RootElement with custom element and root names, add it to roots map and return it', () => { - const root = doc.createRoot( 'customElementName', 'customRootName' ); - - expect( doc.roots.size ).to.equal( 2 ); - expect( root ).to.be.instanceof( RootElement ); - expect( root.maxOffset ).to.equal( 0 ); - expect( root ).to.have.property( 'name', 'customElementName' ); - expect( root ).to.have.property( 'rootName', 'customRootName' ); - } ); - - it( 'should throw an error when trying to create a second root with the same name', () => { - doc.createRoot( '$root', 'rootName' ); - - expect( - () => { - doc.createRoot( '$root', 'rootName' ); - } - ).to.throw( CKEditorError, /model-document-createRoot-name-exists/ ); - } ); - } ); - - describe( 'getRoot()', () => { - it( 'should return a RootElement previously created with given name', () => { - const newRoot = doc.createRoot(); - const getRoot = doc.getRoot(); - - expect( getRoot ).to.equal( newRoot ); - } ); - - it( 'should throw an error when trying to get non-existent root', () => { - expect( - () => { - doc.getRoot( 'root' ); - } - ).to.throw( CKEditorError, /model-document-getRoot-root-not-exist/ ); - } ); - } ); - - describe( 'hasRoot()', () => { - it( 'should return true when Document has RootElement with given name', () => { - doc.createRoot(); - - expect( doc.hasRoot( 'main' ) ).to.be.true; - } ); - - it( 'should return false when Document does not have RootElement with given name', () => { - expect( doc.hasRoot( 'noroot' ) ).to.be.false; - } ); - } ); - - describe.skip( 'applyOperation()', () => { + describe( 'model#applyOperation listener', () => { it( 'should increase document version, execute operation and fire event with proper data ' + 'when operation is a document operation', () => { const changeCallback = sinon.spy(); @@ -180,7 +106,9 @@ describe( 'Document', () => { it( 'should throw an error on the operation base version and the document version is different', () => { const operation = { - baseVersion: 1 + baseVersion: 1, + isDocumentOperation: true, + _execute: () => {} }; expect( @@ -191,6 +119,80 @@ describe( 'Document', () => { } ); } ); + describe( 'getRootNames()', () => { + it( 'should return empty iterator if no roots exist', () => { + expect( count( doc.getRootNames() ) ).to.equal( 0 ); + } ); + + it( 'should return an iterator of all roots without the graveyard', () => { + doc.createRoot( '$root', 'a' ); + doc.createRoot( '$root', 'b' ); + + expect( Array.from( doc.getRootNames() ) ).to.deep.equal( [ 'a', 'b' ] ); + } ); + } ); + + describe( 'createRoot()', () => { + it( 'should create a new RootElement with default element and root names, add it to roots map and return it', () => { + const root = doc.createRoot(); + + expect( doc.roots.size ).to.equal( 2 ); + expect( root ).to.be.instanceof( RootElement ); + expect( root.maxOffset ).to.equal( 0 ); + expect( root ).to.have.property( 'name', '$root' ); + expect( root ).to.have.property( 'rootName', 'main' ); + } ); + + it( 'should create a new RootElement with custom element and root names, add it to roots map and return it', () => { + const root = doc.createRoot( 'customElementName', 'customRootName' ); + + expect( doc.roots.size ).to.equal( 2 ); + expect( root ).to.be.instanceof( RootElement ); + expect( root.maxOffset ).to.equal( 0 ); + expect( root ).to.have.property( 'name', 'customElementName' ); + expect( root ).to.have.property( 'rootName', 'customRootName' ); + } ); + + it( 'should throw an error when trying to create a second root with the same name', () => { + doc.createRoot( '$root', 'rootName' ); + + expect( + () => { + doc.createRoot( '$root', 'rootName' ); + } + ).to.throw( CKEditorError, /model-document-createRoot-name-exists/ ); + } ); + } ); + + describe( 'getRoot()', () => { + it( 'should return a RootElement previously created with given name', () => { + const newRoot = doc.createRoot(); + const getRoot = doc.getRoot(); + + expect( getRoot ).to.equal( newRoot ); + } ); + + it( 'should throw an error when trying to get non-existent root', () => { + expect( + () => { + doc.getRoot( 'root' ); + } + ).to.throw( CKEditorError, /model-document-getRoot-root-not-exist/ ); + } ); + } ); + + describe( 'hasRoot()', () => { + it( 'should return true when Document has RootElement with given name', () => { + doc.createRoot(); + + expect( doc.hasRoot( 'main' ) ).to.be.true; + } ); + + it( 'should return false when Document does not have RootElement with given name', () => { + expect( doc.hasRoot( 'noroot' ) ).to.be.false; + } ); + } ); + describe( 'selection', () => { it( 'should get updated attributes whenever attribute operation is applied', () => { sinon.spy( doc.selection, '_updateAttributes' ); @@ -523,8 +525,10 @@ describe( 'Document', () => { } ); } ); - // @TODO: What for is this test? - it.skip( 'should be correctly converted to json', () => { - expect( jsonParseStringify( doc ).selection ).to.equal( '[engine.model.DocumentSelection]' ); + it( 'should be correctly converted to json', () => { + const serialized = jsonParseStringify( doc ); + + expect( serialized.selection ).to.equal( '[engine.model.DocumentSelection]' ); + expect( serialized.model ).to.equal( '[engine.model.Model]' ); } ); } ); diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 3bba50f30..278469786 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -1066,7 +1066,7 @@ describe( 'DocumentSelection', () => { } ); it( 'are removed only once in case of multi-op deltas', () => { - let spy; + let batch; const emptyP2 = new Element( 'p', null, 'x' ); root.appendChildren( emptyP2 ); @@ -1074,15 +1074,14 @@ describe( 'DocumentSelection', () => { emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); model.change( writer => { - spy = sinon.spy( writer, 'removeAttribute' ); - + batch = writer.batch; // {} writer.merge( Position.createAfter( emptyP ) ); } ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; - - expect( spy.calledOnce ).to.be.true; + // Attribute delta is only one. + expect( Array.from( batch.deltas, delta => delta.type ) ).to.deep.equal( [ 'merge', 'attribute' ] ); } ); it( 'uses model change to clear attributes', () => { From 75c0db5cd78f1cc7791b632df9623512267200a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 15:04:38 +0100 Subject: [PATCH 138/724] Fixed failing ticket test. --- tests/tickets/699.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/tickets/699.js b/tests/tickets/699.js index 3ffac4ef6..51d58b666 100644 --- a/tests/tickets/699.js +++ b/tests/tickets/699.js @@ -33,7 +33,7 @@ describe( 'Bug ckeditor5-engine#699', () => { .then( editor => { editor.setData( '

foo

' ); - expect( getModelData( editor.document ) ).to.equal( '[]foo' ); + expect( getModelData( editor.model ) ).to.equal( '[]foo' ); expect( getViewData( editor.editing.view ) ).to.equal( '[]

foo

' ); return editor.destroy(); @@ -42,7 +42,7 @@ describe( 'Bug ckeditor5-engine#699', () => { } ); function WidgetPlugin( editor ) { - const schema = editor.document.schema; + const schema = editor.model.schema; schema.registerItem( 'widget' ); schema.allow( { name: 'widget', inside: '$root' } ); From ba42189dbdc09c76de41a3e193745f928c71c2ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 11 Dec 2017 15:06:23 +0100 Subject: [PATCH 139/724] Temporarily skipped EngineDebug test. --- tests/dev-utils/enableenginedebug.js | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index a1a1c11bc..bf029c7f6 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -52,7 +52,7 @@ testUtils.createSinonSandbox(); /* global document */ -describe( 'enableEngineDebug', () => { +describe.skip( 'enableEngineDebug', () => { afterEach( () => { disableEngineDebug(); } ); @@ -72,7 +72,7 @@ describe( 'enableEngineDebug', () => { } ); } ); -describe( 'disableEngineDebug', () => { +describe.skip( 'disableEngineDebug', () => { it( 'restores modified stubs', () => { expect( ModelPosition.prototype.log ).to.equal( undefined, 'Initial value (model/position)' ); expect( ModelElement.prototype.printTree ).to.equal( undefined, 'Initial value (model/element)' ); @@ -101,7 +101,7 @@ describe( 'disableEngineDebug', () => { } ); } ); -describe( 'debug tools', () => { +describe.skip( 'debug tools', () => { let DebugPlugin, log, error; class TestEditor extends StandardEditor { @@ -1063,7 +1063,11 @@ describe( 'debug tools', () => { const firstResultWithoutHistory = result[ 0 ].clone(); delete firstResultWithoutHistory.history; - result = deltaTransform.transform( result[ 0 ], deltaC, { isStrong: true, document, wasAffected: new Map() } ); + result = deltaTransform.transform( result[ 0 ], deltaC, { + isStrong: true, + document, + wasAffected: new Map() + } ); expect( result[ 0 ].history ).not.to.be.undefined; expect( result[ 0 ].history.length ).to.equal( 2 ); @@ -1098,7 +1102,11 @@ describe( 'debug tools', () => { deltaC.addOperation( opC ); let original = deltaTransform.transform( deltaA, deltaB, { document, wasAffected: new Map() } ); - original = deltaTransform.transform( original[ 0 ], deltaC, { isStrong: true, document, wasAffected: new Map() } )[ 0 ]; + original = deltaTransform.transform( original[ 0 ], deltaC, { + isStrong: true, + document, + wasAffected: new Map() + } )[ 0 ]; const history = original.history; From 135a06388657e4c4aab92a66e100b8a706c63f60 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 11 Dec 2017 16:36:22 +0100 Subject: [PATCH 140/724] Added a 50ms timeout after focus before rendering. --- src/view/observer/focusobserver.js | 3 ++- tests/view/observer/focusobserver.js | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/view/observer/focusobserver.js b/src/view/observer/focusobserver.js index e2fd03fcb..f985d1d6b 100644 --- a/src/view/observer/focusobserver.js +++ b/src/view/observer/focusobserver.js @@ -35,7 +35,8 @@ export default class FocusObserver extends DomEventObserver { // We need to wait until `SelectionObserver` handle the event and then render. Otherwise rendering will // overwrite new DOM selection with selection from the view. // See https://github.com/ckeditor/ckeditor5-engine/issues/795 for more details. - this._renderTimeoutId = setTimeout( () => document.render(), 0 ); + // Long timeout is needed to solve #676 and https://github.com/ckeditor/ckeditor5-engine/issues/1157 issues. + this._renderTimeoutId = setTimeout( () => document.render(), 50 ); } ); document.on( 'blur', ( evt, data ) => { diff --git a/tests/view/observer/focusobserver.js b/tests/view/observer/focusobserver.js index f452a7533..5289f67fd 100644 --- a/tests/view/observer/focusobserver.js +++ b/tests/view/observer/focusobserver.js @@ -115,13 +115,13 @@ describe( 'FocusObserver', () => { expect( viewDocument.isFocused ).to.be.true; } ); - it( 'should delay rendering to the next iteration of event loop', () => { + it( 'should delay rendering by 50ms', () => { const renderSpy = sinon.spy( viewDocument, 'render' ); const clock = sinon.useFakeTimers(); observer.onDomEvent( { type: 'focus', target: domMain } ); sinon.assert.notCalled( renderSpy ); - clock.tick( 0 ); + clock.tick( 50 ); sinon.assert.called( renderSpy ); clock.restore(); @@ -134,7 +134,7 @@ describe( 'FocusObserver', () => { observer.onDomEvent( { type: 'focus', target: domMain } ); sinon.assert.notCalled( renderSpy ); observer.destroy(); - clock.tick( 0 ); + clock.tick( 50 ); sinon.assert.notCalled( renderSpy ); clock.restore(); From ea950292cc67b19bdb4e688581a7dc6657d3768a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Mon, 11 Dec 2017 17:22:56 +0100 Subject: [PATCH 141/724] Other: Unify ViewElement converters for attribute and element. --- src/conversion/attributeconverters.js | 66 +++++---------------------- src/conversion/elementconverters.js | 46 ++++--------------- src/conversion/utils.js | 54 ++++++++++++++++++++++ src/view/element.js | 30 ++++++++++++ 4 files changed, 105 insertions(+), 91 deletions(-) create mode 100644 src/conversion/utils.js diff --git a/src/conversion/attributeconverters.js b/src/conversion/attributeconverters.js index 41eb1de1b..4144c8d0b 100644 --- a/src/conversion/attributeconverters.js +++ b/src/conversion/attributeconverters.js @@ -5,74 +5,30 @@ import AttributeElement from '../view/attributeelement'; import buildModelConverter from './buildmodelconverter'; -import buildViewConverter from './buildviewconverter'; +import { defineConverter, parseDefinition } from './utils'; -export function viewToModelAttribute( attributeName, attributeValue, view, dispatchers ) { - const viewDefinitions = view.from ? view.from : [ view ]; +export function modelAttributeToView( attributeName, definition, dispatchers ) { + const { model: attributeValue, viewDefinition } = parseDefinition( definition ); - for ( const viewDefinition of viewDefinitions ) { - const element = viewDefinition.name; - const classes = viewDefinition.class; - const styles = viewDefinition.style; - - const pattern = { name: element }; - - if ( classes ) { - pattern.class = classes; - } - - if ( styles ) { - pattern.style = styles; - } - - buildViewConverter() - .for( ...dispatchers ) - .from( pattern ) - .toAttribute( () => ( { - key: attributeName, - value: attributeValue - } ) ); - } -} - -export function modelAttributeToView( attributeName, attributeValue, view, dispatchers ) { buildModelConverter() .for( ...dispatchers ) .fromAttribute( attributeName ) .toElement( value => { - // TODO: string vs numeric values if ( value != attributeValue ) { return; } - const viewDefinition = view.to ? view.to : view; - // TODO: AttributeElement.fromDefinition() ? - - const classes = viewDefinition.class; - const styles = viewDefinition.style; - - const attributes = {}; - - // TODO: AttributeElement does no accept Array - if ( classes ) { - attributes.class = Array.isArray( classes ) ? classes.join( ' ' ) : classes; - } - - // TODO: Attribute element does not accept Object - if ( styles ) { - attributes.style = typeof styles === 'string' ? styles : toStylesString( styles ); - } - - return new AttributeElement( viewDefinition.name, attributes ); + return AttributeElement.fromViewDefinition( viewDefinition ); } ); } -function toStylesString( stylesObject ) { - const styles = []; +export function viewToModelAttribute( attributeName, definition, dispatchers ) { + const { model: attributeValue, viewDefinitions } = parseDefinition( definition ); - for ( const key in stylesObject ) { - styles.push( key + ':' + stylesObject[ key ] ); - } + const converter = defineConverter( dispatchers, viewDefinitions ); - return styles.join( ';' ); + converter.toAttribute( () => ( { + key: attributeName, + value: attributeValue + } ) ); } diff --git a/src/conversion/elementconverters.js b/src/conversion/elementconverters.js index 627139e42..84659a4da 100644 --- a/src/conversion/elementconverters.js +++ b/src/conversion/elementconverters.js @@ -4,49 +4,23 @@ */ import buildModelConverter from './buildmodelconverter'; -import buildViewConverter from './buildviewconverter'; import ViewContainerElement from '../view/containerelement'; -export function modelElementToView( modelElement, view, dispatchers ) { - const viewDefinition = view.to ? view.to : view; +import { defineConverter, parseDefinition } from './utils'; - const attributes = {}; +export function modelElementToView( definition, dispatchers ) { + const { model: modelElement, viewDefinition } = parseDefinition( definition ); - if ( viewDefinition.class ) { - attributes.class = viewDefinition.class; - } - - if ( viewDefinition.style ) { - attributes.style = viewDefinition.style; - } - - if ( viewDefinition.attribute ) { - attributes.attribute = viewDefinition.attribute; - } - - buildModelConverter().for( ...dispatchers ) + buildModelConverter() + .for( ...dispatchers ) .fromElement( modelElement ) - .toElement( () => { - // TODO: create method from definition - return new ViewContainerElement( viewDefinition.name, attributes ); - } ); + .toElement( () => ViewContainerElement.fromViewDefinition( viewDefinition ) ); } -export function viewToModelElement( element, view, dispatchers ) { - // TODO: support multiple definitions - // { name: option.view.name } - - const viewDefinitions = view.from ? view.from : [ view ]; - - const converter = buildViewConverter().for( ...dispatchers ); - - for ( const viewDefinition of viewDefinitions ) { - converter.from( viewDefinition ); +export function viewToModelElement( definition, dispatchers ) { + const { model: modelElement, viewDefinitions } = parseDefinition( definition ); - if ( viewDefinition.priority ) { - converter.withPriority( viewDefinition.priority ); - } - } + const converter = defineConverter( dispatchers, viewDefinitions ); - converter.toElement( element ); + converter.toElement( modelElement ); } diff --git a/src/conversion/utils.js b/src/conversion/utils.js new file mode 100644 index 000000000..aed81beff --- /dev/null +++ b/src/conversion/utils.js @@ -0,0 +1,54 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import buildViewConverter from './buildviewconverter'; + +export function parseDefinition( definition ) { + const model = definition.model; + const view = definition.view; + const viewDefinition = typeof view == 'string' ? { name: view } : view; + + const viewDefinitions = definition.acceptsAlso ? definition.acceptsAlso : []; + + viewDefinitions.push( viewDefinition ); + + return { model, viewDefinition, viewDefinitions }; +} + +export function definitionToPattern( viewDefinition ) { + const name = viewDefinition.name; + const classes = viewDefinition.class; + const styles = viewDefinition.style; + const attributes = viewDefinition.attribute; + + const pattern = { name }; + + if ( classes ) { + pattern.class = classes; + } + + if ( styles ) { + pattern.style = styles; + } + + if ( attributes ) { + pattern.attribute = attributes; + } + + return pattern; +} + +export function defineConverter( dispatchers, viewDefinitions ) { + const converter = buildViewConverter().for( ...dispatchers ); + + for ( const viewDefinition of viewDefinitions ) { + converter.from( definitionToPattern( viewDefinition ) ); + + if ( viewDefinition.priority ) { + converter.withPriority( viewDefinition.priority ); + } + } + return converter; +} diff --git a/src/view/element.js b/src/view/element.js index c1dc76fec..1469053f3 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -712,6 +712,36 @@ export default class Element extends Node { ( attributes == '' ? '' : ` ${ attributes }` ); } + static fromViewDefinition( viewDefinition ) { + const attributes = {}; + + const classes = viewDefinition.class; + + if ( viewDefinition.class ) { + attributes.class = Array.isArray( classes ) ? classes.join( ' ' ) : classes; + } + + if ( viewDefinition.style ) { + attributes.style = toStylesString( viewDefinition.style ); + } + + if ( viewDefinition.attribute ) { + attributes.attribute = viewDefinition.attribute; + } + + return new this( viewDefinition.name, attributes ); + + function toStylesString( stylesObject ) { + const styles = []; + + for ( const key in stylesObject ) { + styles.push( key + ':' + stylesObject[ key ] ); + } + + return styles.join( ';' ); + } + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * From 1e28cba56a97e299c232e868f5062e8224dd578f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Mon, 11 Dec 2017 17:41:10 +0100 Subject: [PATCH 142/724] Other: Rename ViewElementDefinition attributes to plural names. --- src/conversion/attributeconverters.js | 5 +++++ src/conversion/utils.js | 6 +++--- src/view/element.js | 26 ++++++++++++++++++-------- src/view/viewelementdefinition.jsdoc | 6 +++--- 4 files changed, 29 insertions(+), 14 deletions(-) diff --git a/src/conversion/attributeconverters.js b/src/conversion/attributeconverters.js index 4144c8d0b..98ee70684 100644 --- a/src/conversion/attributeconverters.js +++ b/src/conversion/attributeconverters.js @@ -7,6 +7,11 @@ import AttributeElement from '../view/attributeelement'; import buildModelConverter from './buildmodelconverter'; import { defineConverter, parseDefinition } from './utils'; +/** + * @param {String} attributeName + * @param {module:engine/view/viewelementdefinition~ViewElementDefinition} definition + * @param dispatchers + */ export function modelAttributeToView( attributeName, definition, dispatchers ) { const { model: attributeValue, viewDefinition } = parseDefinition( definition ); diff --git a/src/conversion/utils.js b/src/conversion/utils.js index aed81beff..3b093ae8e 100644 --- a/src/conversion/utils.js +++ b/src/conversion/utils.js @@ -19,9 +19,9 @@ export function parseDefinition( definition ) { export function definitionToPattern( viewDefinition ) { const name = viewDefinition.name; - const classes = viewDefinition.class; - const styles = viewDefinition.style; - const attributes = viewDefinition.attribute; + const classes = viewDefinition.classes; + const styles = viewDefinition.styles; + const attributes = viewDefinition.attributes; const pattern = { name }; diff --git a/src/view/element.js b/src/view/element.js index 1469053f3..4eeba6900 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -712,24 +712,34 @@ export default class Element extends Node { ( attributes == '' ? '' : ` ${ attributes }` ); } - static fromViewDefinition( viewDefinition ) { + /** + * Creates element instance from provided viewElementDefinition. + * + * @param {module:engine/view/viewelementdefinition~ViewElementDefinition} viewElementDefinition + * @returns {Element} + */ + static fromViewDefinition( viewElementDefinition ) { const attributes = {}; - const classes = viewDefinition.class; + const classes = viewElementDefinition.classes; - if ( viewDefinition.class ) { + if ( classes ) { attributes.class = Array.isArray( classes ) ? classes.join( ' ' ) : classes; } - if ( viewDefinition.style ) { - attributes.style = toStylesString( viewDefinition.style ); + const stylesObject = viewElementDefinition.styles; + + if ( stylesObject ) { + attributes.style = toStylesString( stylesObject ); } - if ( viewDefinition.attribute ) { - attributes.attribute = viewDefinition.attribute; + const attributesObject = viewElementDefinition.attributes; + + if ( attributesObject ) { + attributes.attribute = attributesObject; } - return new this( viewDefinition.name, attributes ); + return new this( viewElementDefinition.name, attributes ); function toStylesString( stylesObject ) { const styles = []; diff --git a/src/view/viewelementdefinition.jsdoc b/src/view/viewelementdefinition.jsdoc index db076ad10..9a3f41109 100644 --- a/src/view/viewelementdefinition.jsdoc +++ b/src/view/viewelementdefinition.jsdoc @@ -13,10 +13,10 @@ * @typedef {Object} module:engine/view/viewelementdefinition~ViewElementDefinition * * @property {String} name View element attribute name. - * @property {String|Array.} [class] Class name or array of class names to match. Each name can be + * @property {String|Array.} [classes] Class name or array of class names to match. Each name can be * provided in a form of string. - * @property {Object} [style] Object with key-value pairs representing styles to match. Each object key + * @property {Object} [styles] Object with key-value pairs representing styles to match. Each object key * represents style name. Value under that key must be a string. - * @property {Object} [attribute] Object with key-value pairs representing attributes to match. Each object key + * @property {Object} [attributes] Object with key-value pairs representing attributes to match. Each object key * represents attribute name. Value under that key must be a string. */ From 61ea4261ff2e4224718f0caeaa0787fe07294843 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Mon, 11 Dec 2017 18:18:52 +0100 Subject: [PATCH 143/724] Tests: Add tests for Element.fromViewDefinition() method. --- src/view/element.js | 4 +++- tests/view/element.js | 54 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 1 deletion(-) diff --git a/src/view/element.js b/src/view/element.js index 4eeba6900..7ea1f4175 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -736,7 +736,9 @@ export default class Element extends Node { const attributesObject = viewElementDefinition.attributes; if ( attributesObject ) { - attributes.attribute = attributesObject; + for ( const key in attributesObject ) { + attributes[ key ] = attributesObject[ key ]; + } } return new this( viewElementDefinition.name, attributes ); diff --git a/tests/view/element.js b/tests/view/element.js index 06dafd038..a1efdc120 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -1028,4 +1028,58 @@ describe( 'Element', () => { ); } ); } ); + + describe( 'fromViewDefinition()', () => { + it( 'should create element from definition without any attributes', () => { + const el = Element.fromViewDefinition( { name: 'p' } ); + + expect( el ).to.be.an.instanceof( Node ); + expect( el ).to.have.property( 'name' ).that.equals( 'p' ); + expect( el ).to.have.property( 'parent' ).that.is.null; + expect( count( el.getAttributeKeys() ) ).to.equal( 0 ); + } ); + + it( 'should create element from definition with attributes as plain object', () => { + const el = Element.fromViewDefinition( { name: 'p', attributes: { foo: 'bar' } } ); + + expect( el ).to.have.property( 'name' ).that.equals( 'p' ); + expect( count( el.getAttributeKeys() ) ).to.equal( 1 ); + expect( el.getAttribute( 'foo' ) ).to.equal( 'bar' ); + } ); + + it( 'should create element from definition with classes as single string', () => { + const el = Element.fromViewDefinition( { name: 'p', attributes: { id: 'test' }, classes: 'foo-bar' } ); + + expect( el._attrs.has( 'class' ) ).to.be.false; + expect( el._attrs.has( 'id' ) ).to.be.true; + expect( el._classes.has( 'foo-bar' ) ).to.be.true; + } ); + + it( 'should create element from definition with classes set as array', () => { + const el = Element.fromViewDefinition( { name: 'p', attributes: { id: 'test' }, classes: [ 'one', 'two', 'three' ] } ); + + expect( el._attrs.has( 'class' ) ).to.be.false; + expect( el._attrs.has( 'id' ) ).to.be.true; + expect( el._classes.has( 'one' ) ).to.be.true; + expect( el._classes.has( 'two' ) ).to.be.true; + expect( el._classes.has( 'three' ) ).to.be.true; + } ); + + it( 'should create element from definition with styles object', () => { + const el = Element.fromViewDefinition( { + name: 'p', + attributes: { id: 'test' }, + styles: { one: 'style1', two: 'style2', three: 'url(http://ckeditor.com)' } + } ); + + expect( el._attrs.has( 'style' ) ).to.be.false; + expect( el._attrs.has( 'id' ) ).to.be.true; + expect( el._styles.has( 'one' ) ).to.be.true; + expect( el._styles.get( 'one' ) ).to.equal( 'style1' ); + expect( el._styles.has( 'two' ) ).to.be.true; + expect( el._styles.get( 'two' ) ).to.equal( 'style2' ); + expect( el._styles.has( 'three' ) ).to.be.true; + expect( el._styles.get( 'three' ) ).to.equal( 'url(http://ckeditor.com)' ); + } ); + } ); } ); From b2f1044734d50503a14c535a3802ea84091296e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 12 Dec 2017 11:11:25 +0100 Subject: [PATCH 144/724] Tests: Add tests for new conversion helpers. --- src/conversion/attributeconverters.js | 2 +- tests/conversion/attributeconverters.js | 296 ++++++++++++++++++++++++ tests/conversion/elementconverters.js | 279 ++++++++++++++++++++++ 3 files changed, 576 insertions(+), 1 deletion(-) create mode 100644 tests/conversion/attributeconverters.js create mode 100644 tests/conversion/elementconverters.js diff --git a/src/conversion/attributeconverters.js b/src/conversion/attributeconverters.js index 98ee70684..32dccb603 100644 --- a/src/conversion/attributeconverters.js +++ b/src/conversion/attributeconverters.js @@ -9,7 +9,7 @@ import { defineConverter, parseDefinition } from './utils'; /** * @param {String} attributeName - * @param {module:engine/view/viewelementdefinition~ViewElementDefinition} definition + * @param {} definition Converter definition * @param dispatchers */ export function modelAttributeToView( attributeName, definition, dispatchers ) { diff --git a/tests/conversion/attributeconverters.js b/tests/conversion/attributeconverters.js new file mode 100644 index 000000000..db9de6558 --- /dev/null +++ b/tests/conversion/attributeconverters.js @@ -0,0 +1,296 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import ModelDocument from '../../src/model/document'; +import ModelElement from '../../src/model/element'; +import ModelText from '../../src/model/text'; +import ModelRange from '../../src/model/range'; + +import ViewDocument from '../../src/view/document'; +import ViewElement from '../../src/view/element'; +import ViewAttributeElement from '../../src/view/attributeelement'; +import ViewText from '../../src/view/text'; + +import Mapper from '../../src/conversion/mapper'; +import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; + +import { + insertText, + remove +} from '../../src/conversion/model-to-view-converters'; + +import { modelAttributeToView, viewToModelAttribute } from '../../src/conversion/attributeconverters'; +import { convertText } from '../../src/conversion/view-to-model-converters'; +import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; +import ModelSchema from '../../src/model/schema'; +import ModelWalker from '../../src/model/treewalker'; +import ModelTextProxy from '../../src/model/textproxy'; + +function viewAttributesToString( item ) { + let result = ''; + + for ( const key of item.getAttributeKeys() ) { + const value = item.getAttribute( key ); + + if ( value ) { + result += ' ' + key + '="' + value + '"'; + } + } + + return result; +} + +function modelToString( item ) { + let result = ''; + + if ( item instanceof ModelTextProxy ) { + const attributes = modelAttributesToString( item ); + + result = attributes ? '<$text' + attributes + '>' + item.data + '' : item.data; + } else { + const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } ); + + for ( const value of walker ) { + result += modelToString( value.item ); + } + + if ( item instanceof ModelElement ) { + const attributes = modelAttributesToString( item ); + + result = '<' + item.name + attributes + '>' + result + ''; + } + } + + return result; +} + +function modelAttributesToString( item ) { + let result = ''; + + for ( const attr of item.getAttributes() ) { + result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"'; + } + + return result; +} + +function viewToString( item ) { + let result = ''; + + if ( item instanceof ViewText ) { + result = item.data; + } else { + // ViewElement or ViewDocumentFragment. + for ( const child of item.getChildren() ) { + result += viewToString( child ); + } + + if ( item instanceof ViewElement ) { + result = '<' + item.name + viewAttributesToString( item ) + '>' + result + ''; + } + } + + return result; +} + +describe( 'Attribute converter', () => { + let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, batch; + + beforeEach( () => { + modelDoc = new ModelDocument(); + modelRoot = modelDoc.createRoot( 'root', 'root' ); + + batch = modelDoc.batch(); + + viewDoc = new ViewDocument(); + viewRoot = viewDoc.createRoot( 'div' ); + viewSelection = viewDoc.selection; + + mapper = new Mapper(); + mapper.bindElements( modelRoot, viewRoot ); + + dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); + + dispatcher.on( 'insert:$text', insertText() ); + dispatcher.on( 'remove', remove() ); + } ); + + afterEach( () => { + viewDoc.destroy(); + } ); + + function testConversion( definition, expectedConversion ) { + modelAttributeToView( 'foo', definition, [ dispatcher ] ); + + const modelElement = new ModelText( 'foo', { foo: 'bar' } ); + modelRoot.appendChildren( modelElement ); + + dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); + + expect( viewToString( viewRoot ) ).to.equal( expectedConversion ); + + batch.removeAttribute( 'bold', modelRoot ); + + dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'foo', 'bar', null ); + + expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); + } + + describe( 'model attribute to view element conversion', () => { + it( 'using passed view element name', () => { + testConversion( { model: 'bar', view: 'strong' }, '
foo
' ); + } ); + + it( 'using passed view element object', () => { + testConversion( { model: 'bar', view: { name: 'strong' } }, '
foo
' ); + } ); + + it( 'using passed view element object with styles object', () => { + testConversion( { + model: 'bar', + view: { name: 'span', styles: { 'font-weight': 'bold' } } + }, '
foo
' ); + } ); + + it( 'using passed view element object with class string', () => { + testConversion( { model: 'bar', view: { name: 'span', classes: 'foo' } }, '
foo
' ); + } ); + + it( 'using passed view element object with class array', () => { + testConversion( { + model: 'bar', + view: { name: 'span', classes: [ 'foo', 'foo-bar' ] } + }, '
foo
' ); + } ); + + it( 'using passed view element object with attributes', () => { + testConversion( { + model: 'bar', + view: { name: 'span', attributes: { 'data-foo': 'bar' } } + }, '
foo
' ); + } ); + + it( 'should do nothing for undefined value', () => { + modelAttributeToView( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); + + const modelElement = new ModelText( 'foo', { foo: 'baz' } ); + modelRoot.appendChildren( modelElement ); + + dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); + + expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); + } ); + } ); + describe( 'view element to model attribute conversion', () => { + let dispatcher, schema, additionalData, batch; + + const modelDocument = new ModelDocument(); + + beforeEach( () => { + batch = modelDocument.batch(); + + // `additionalData` parameter for `.convert` calls. + additionalData = { context: [ '$root' ] }; + + schema = new ModelSchema(); + + schema.registerItem( 'div', '$block' ); + + schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } ); + schema.allow( { name: '$text', inside: '$root' } ); + + dispatcher = new ViewConversionDispatcher( { schema } ); + dispatcher.on( 'text', convertText() ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { + model: 'bar', + view: 'strong', + acceptsAlso: [ + { name: 'span', classes: [ 'foo', 'bar' ] }, + { name: 'span', attributes: { 'data-foo': 'bar' } } + ] + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelAttribute( 'foo', { model: 'baz', view: 'strong' }, [ dispatcher ] ); + viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + } ); +} ); diff --git a/tests/conversion/elementconverters.js b/tests/conversion/elementconverters.js new file mode 100644 index 000000000..314164943 --- /dev/null +++ b/tests/conversion/elementconverters.js @@ -0,0 +1,279 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import ModelDocument from '../../src/model/document'; +import ModelElement from '../../src/model/element'; +import ModelText from '../../src/model/text'; +import ModelRange from '../../src/model/range'; + +import ViewDocument from '../../src/view/document'; +import ViewElement from '../../src/view/element'; +import ViewText from '../../src/view/text'; + +import Mapper from '../../src/conversion/mapper'; +import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; + +import { + insertText, + remove +} from '../../src/conversion/model-to-view-converters'; + +import { modelElementToView, viewToModelElement } from '../../src/conversion/elementconverters'; +import { convertText } from '../../src/conversion/view-to-model-converters'; +import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; +import ModelSchema from '../../src/model/schema'; +import ModelWalker from '../../src/model/treewalker'; +import ModelTextProxy from '../../src/model/textproxy'; + +function viewAttributesToString( item ) { + let result = ''; + + for ( const key of item.getAttributeKeys() ) { + const value = item.getAttribute( key ); + + if ( value ) { + result += ' ' + key + '="' + value + '"'; + } + } + + return result; +} + +function modelToString( item ) { + let result = ''; + + if ( item instanceof ModelTextProxy ) { + const attributes = modelAttributesToString( item ); + + result = attributes ? '<$text' + attributes + '>' + item.data + '' : item.data; + } else { + const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } ); + + for ( const value of walker ) { + result += modelToString( value.item ); + } + + if ( item instanceof ModelElement ) { + const attributes = modelAttributesToString( item ); + + result = '<' + item.name + attributes + '>' + result + ''; + } + } + + return result; +} + +function modelAttributesToString( item ) { + let result = ''; + + for ( const attr of item.getAttributes() ) { + result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"'; + } + + return result; +} + +function viewToString( item ) { + let result = ''; + + if ( item instanceof ViewText ) { + result = item.data; + } else { + // ViewElement or ViewDocumentFragment. + for ( const child of item.getChildren() ) { + result += viewToString( child ); + } + + if ( item instanceof ViewElement ) { + result = '<' + item.name + viewAttributesToString( item ) + '>' + result + ''; + } + } + + return result; +} + +describe( 'Element converter', () => { + let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection; + + beforeEach( () => { + modelDoc = new ModelDocument(); + modelRoot = modelDoc.createRoot( 'root', 'root' ); + + viewDoc = new ViewDocument(); + viewRoot = viewDoc.createRoot( 'div' ); + viewSelection = viewDoc.selection; + + mapper = new Mapper(); + mapper.bindElements( modelRoot, viewRoot ); + + dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); + + dispatcher.on( 'insert:$text', insertText() ); + dispatcher.on( 'remove', remove() ); + } ); + + afterEach( () => { + viewDoc.destroy(); + } ); + + function testModelConversion( definition, expectedResult ) { + modelElementToView( definition, [ dispatcher ] ); + + const modelElement = new ModelElement( 'foo', null, new ModelText( 'bar' ) ); + modelRoot.appendChildren( modelElement ); + + dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); + + expect( viewToString( viewRoot ) ).to.equal( '
' + expectedResult + '
' ); + } + + describe( 'model element to view element conversion', () => { + it( 'using passed view element name', () => { + testModelConversion( { model: 'foo', view: 'strong' }, 'bar' ); + } ); + + it( 'using passed view element object', () => { + testModelConversion( { model: 'foo', view: { name: 'strong' } }, 'bar' ); + } ); + + it( 'using passed view element object with styles object', () => { + testModelConversion( { + model: 'foo', + view: { name: 'span', styles: { 'font-weight': 'bold' } } + }, 'bar' ); + } ); + + it( 'using passed view element object with class string', () => { + testModelConversion( { model: 'foo', view: { name: 'span', classes: 'foo' } }, 'bar' ); + } ); + + it( 'using passed view element object with class array', () => { + testModelConversion( { + model: 'foo', + view: { name: 'span', classes: [ 'foo', 'foo-bar' ] } + }, 'bar' ); + } ); + + it( 'using passed view element object with attributes', () => { + testModelConversion( { + model: 'foo', + view: { name: 'span', attributes: { 'data-foo': 'bar' } } + }, 'bar' ); + } ); + } ); + + describe( 'view element to model element conversion', () => { + let dispatcher, schema, additionalData, batch; + + const modelDocument = new ModelDocument(); + + beforeEach( () => { + batch = modelDocument.batch(); + + // `additionalData` parameter for `.convert` calls. + additionalData = { context: [ '$root' ] }; + + schema = new ModelSchema(); + + schema.registerItem( 'div', '$block' ); + schema.registerItem( 'bar', '$block' ); + schema.registerItem( 'baz', '$block' ); + + schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } ); + schema.allow( { name: '$text', inside: '$inline' } ); + + dispatcher = new ViewConversionDispatcher( { schema } ); + dispatcher.on( 'text', convertText() ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'bar', view: 'strong' }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { + model: 'bar', + view: 'strong', + acceptsAlso: [ + { name: 'span', classes: [ 'foo', 'bar' ] }, + { name: 'span', attributes: { 'data-foo': 'bar' } } + ] + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToModelElement( { model: 'baz', view: 'strong' }, [ dispatcher ] ); + viewToModelElement( { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + } ); +} ); From a54727d0e37a0350dffed0cc07b67c34f77554ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 12 Dec 2017 11:18:13 +0100 Subject: [PATCH 145/724] Other: Rename AttributeElement conversion helpers. --- ...rters.js => attributeelementconverters.js} | 4 +-- ...rters.js => attributeelementconverters.js} | 30 +++++++++++-------- 2 files changed, 20 insertions(+), 14 deletions(-) rename src/conversion/{attributeconverters.js => attributeelementconverters.js} (84%) rename tests/conversion/{attributeconverters.js => attributeelementconverters.js} (87%) diff --git a/src/conversion/attributeconverters.js b/src/conversion/attributeelementconverters.js similarity index 84% rename from src/conversion/attributeconverters.js rename to src/conversion/attributeelementconverters.js index 32dccb603..ec6555169 100644 --- a/src/conversion/attributeconverters.js +++ b/src/conversion/attributeelementconverters.js @@ -12,7 +12,7 @@ import { defineConverter, parseDefinition } from './utils'; * @param {} definition Converter definition * @param dispatchers */ -export function modelAttributeToView( attributeName, definition, dispatchers ) { +export function attributeElementToViewConverter( attributeName, definition, dispatchers ) { const { model: attributeValue, viewDefinition } = parseDefinition( definition ); buildModelConverter() @@ -27,7 +27,7 @@ export function modelAttributeToView( attributeName, definition, dispatchers ) { } ); } -export function viewToModelAttribute( attributeName, definition, dispatchers ) { +export function viewToAttributeElementConverter( attributeName, definition, dispatchers ) { const { model: attributeValue, viewDefinitions } = parseDefinition( definition ); const converter = defineConverter( dispatchers, viewDefinitions ); diff --git a/tests/conversion/attributeconverters.js b/tests/conversion/attributeelementconverters.js similarity index 87% rename from tests/conversion/attributeconverters.js rename to tests/conversion/attributeelementconverters.js index db9de6558..44eaaf4b4 100644 --- a/tests/conversion/attributeconverters.js +++ b/tests/conversion/attributeelementconverters.js @@ -21,7 +21,7 @@ import { remove } from '../../src/conversion/model-to-view-converters'; -import { modelAttributeToView, viewToModelAttribute } from '../../src/conversion/attributeconverters'; +import { attributeElementToViewConverter, viewToAttributeElementConverter } from '../../src/conversion/attributeelementconverters'; import { convertText } from '../../src/conversion/view-to-model-converters'; import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; import ModelSchema from '../../src/model/schema'; @@ -122,7 +122,7 @@ describe( 'Attribute converter', () => { } ); function testConversion( definition, expectedConversion ) { - modelAttributeToView( 'foo', definition, [ dispatcher ] ); + attributeElementToViewConverter( 'foo', definition, [ dispatcher ] ); const modelElement = new ModelText( 'foo', { foo: 'bar' } ); modelRoot.appendChildren( modelElement ); @@ -173,7 +173,7 @@ describe( 'Attribute converter', () => { } ); it( 'should do nothing for undefined value', () => { - modelAttributeToView( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); + attributeElementToViewConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); const modelElement = new ModelText( 'foo', { foo: 'baz' } ); modelRoot.appendChildren( modelElement ); @@ -206,7 +206,7 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData @@ -216,7 +216,7 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData @@ -226,7 +226,7 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData @@ -236,7 +236,7 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData @@ -246,7 +246,10 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { + model: 'bar', + view: { name: 'span', styles: { 'font-weight': 'bold' } } + }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData @@ -256,7 +259,10 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { + model: 'bar', + view: { name: 'span', attributes: { 'data-foo': 'bar' } } + }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData @@ -266,7 +272,7 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { + viewToAttributeElementConverter( 'foo', { model: 'bar', view: 'strong', acceptsAlso: [ @@ -283,8 +289,8 @@ describe( 'Attribute converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelAttribute( 'foo', { model: 'baz', view: 'strong' }, [ dispatcher ] ); - viewToModelAttribute( 'foo', { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'baz', view: 'strong' }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData From d7141cc80b8776a1bf0e4b90204f62fd3ef10521 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Tue, 12 Dec 2017 11:21:58 +0100 Subject: [PATCH 146/724] Other: Rename ContainerElement conversion helpers. --- ...rters.js => containerelementconverters.js} | 4 ++-- ...rters.js => containerelementconverters.js} | 22 +++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) rename src/conversion/{elementconverters.js => containerelementconverters.js} (84%) rename tests/conversion/{elementconverters.js => containerelementconverters.js} (88%) diff --git a/src/conversion/elementconverters.js b/src/conversion/containerelementconverters.js similarity index 84% rename from src/conversion/elementconverters.js rename to src/conversion/containerelementconverters.js index 84659a4da..16490b942 100644 --- a/src/conversion/elementconverters.js +++ b/src/conversion/containerelementconverters.js @@ -8,7 +8,7 @@ import ViewContainerElement from '../view/containerelement'; import { defineConverter, parseDefinition } from './utils'; -export function modelElementToView( definition, dispatchers ) { +export function containerElementToView( definition, dispatchers ) { const { model: modelElement, viewDefinition } = parseDefinition( definition ); buildModelConverter() @@ -17,7 +17,7 @@ export function modelElementToView( definition, dispatchers ) { .toElement( () => ViewContainerElement.fromViewDefinition( viewDefinition ) ); } -export function viewToModelElement( definition, dispatchers ) { +export function viewToContainerElement( definition, dispatchers ) { const { model: modelElement, viewDefinitions } = parseDefinition( definition ); const converter = defineConverter( dispatchers, viewDefinitions ); diff --git a/tests/conversion/elementconverters.js b/tests/conversion/containerelementconverters.js similarity index 88% rename from tests/conversion/elementconverters.js rename to tests/conversion/containerelementconverters.js index 314164943..83a69b65b 100644 --- a/tests/conversion/elementconverters.js +++ b/tests/conversion/containerelementconverters.js @@ -20,7 +20,7 @@ import { remove } from '../../src/conversion/model-to-view-converters'; -import { modelElementToView, viewToModelElement } from '../../src/conversion/elementconverters'; +import { containerElementToView, viewToContainerElement } from '../../src/conversion/containerelementconverters'; import { convertText } from '../../src/conversion/view-to-model-converters'; import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; import ModelSchema from '../../src/model/schema'; @@ -119,7 +119,7 @@ describe( 'Element converter', () => { } ); function testModelConversion( definition, expectedResult ) { - modelElementToView( definition, [ dispatcher ] ); + containerElementToView( definition, [ dispatcher ] ); const modelElement = new ModelElement( 'foo', null, new ModelText( 'bar' ) ); modelRoot.appendChildren( modelElement ); @@ -189,7 +189,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'bar', view: 'strong' }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: 'strong' }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData @@ -199,7 +199,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData @@ -209,7 +209,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData @@ -219,7 +219,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData @@ -229,7 +229,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData @@ -239,7 +239,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData @@ -249,7 +249,7 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { + viewToContainerElement( { model: 'bar', view: 'strong', acceptsAlso: [ @@ -266,8 +266,8 @@ describe( 'Element converter', () => { } ); it( 'should convert from view element to model attribute', () => { - viewToModelElement( { model: 'baz', view: 'strong' }, [ dispatcher ] ); - viewToModelElement( { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); + viewToContainerElement( { model: 'baz', view: 'strong' }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); const conversionResult = dispatcher.convert( new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData From 6d60c714a50affa4250ac9efbb87a8b3b40deeb7 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Tue, 12 Dec 2017 18:04:43 +0100 Subject: [PATCH 147/724] Docs for model, document, writer and batch. --- src/model/batch.js | 22 +++----- src/model/document.js | 14 ++--- src/model/model.js | 125 +++++++++++++++++++++++++++++++++++++++++- src/model/model.jsdoc | 8 --- src/model/writer.js | 28 ++++++---- 5 files changed, 154 insertions(+), 43 deletions(-) delete mode 100644 src/model/model.jsdoc diff --git a/src/model/batch.js b/src/model/batch.js index 07b4e7196..d31a40984 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -10,25 +10,21 @@ /** * `Batch` instance groups model changes ({@link module:engine/model/delta/delta~Delta deltas}). All deltas grouped in a single `Batch` * can be reverted together, so you can think about `Batch` as of a single undo step. If you want to extend given undo step you - * can call another method on the same `Batch` object. If you want to create a separate undo step you can create a new `Batch`. + * can add more changes to the batch using {@link module:engine/model~model#enqueueChange}: * - * For example to create two separate undo steps you can call: - * - * doc.batch().insert( 'foo', firstPosition ); - * doc.batch().insert( 'bar', secondPosition ); - * - * To create a single undo step: - * - * const batch = doc.batch(); - * batch.insert( 'foo', firstPosition ); - * batch.insert( 'bar', secondPosition ); + * model.enqueueChange( batch, writer => { + * writer.insertText( 'foo', paragraph, 'end' ); + * } ); * + * @see module:engine/model~model#enqueueChange + * @see module:engine/model~model#change */ export default class Batch { /** - * Creates `Batch` instance. Not recommended to use directly, use {@link module:engine/model~model#change} or - * {@link module:engine/model~model#enqueueChanges} instead. + * Creates `Batch` instance. * + * @see module:engine/model~model#enqueueChange + * @see module:engine/model~model#change * @param {'transparent'|'default'} [type='default'] Type of the batch. */ constructor( type = 'default' ) { diff --git a/src/model/document.js b/src/model/document.js index 6b681e962..b46598356 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -31,14 +31,6 @@ const graveyardName = '$graveyard'; * {@link module:engine/model/document~Document#roots root elements}, for example if the editor have multiple editable areas, * each area will be represented by the separate root. * - * All changes in the document are done by {@link module:engine/model/operation/operation~Operation operations}. To create operations in - * a simple way, use the {@link module:engine/model/batch~Batch} API, for example: - * - * const batch = doc.batch(); - * batch.insert( node, position ); - * batch.split( otherPosition ); - * - * @see module:engine/model/document~Document#batch * @mixes module:utils/emittermixin~EmitterMixin */ export default class Document { @@ -47,6 +39,12 @@ export default class Document { * the {@link #graveyard graveyard root}). */ constructor( model ) { + /** + * {@link module:engine/model/model~Model} the document is part of. + * + * @readonly + * @member {module:engine/model/model~Model} + */ this.model = model; /** diff --git a/src/model/model.js b/src/model/model.js index 909894425..95d1deedf 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -15,21 +15,38 @@ import MarkerCollection from './markercollection'; import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; +/** + * Editors data model class. Model defines all data: either nodes users see in editable roots, grouped as the + * {@link #document}, and all detached nodes, used to data manipulation. All of them are + * created and modified by the {@link module:engine/model/model~Writer}, which can be get using + * {@link #change} or {@link #enqueueChange} methods. + */ export default class Model { constructor() { + /** + * All callbacks added by {@link #change} or {@link #enqueueChange} methods waiting to be executed. + * + * @private + * @type {Array.} + */ this._pendingChanges = []; + /** + * Editors document model. + * + * @member {module:engine/model/document~Document} + */ this.document = new Document( this ); /** - * Schema for this document. + * Schema for editors model. * * @member {module:engine/model/schema~Schema} */ this.schema = new Schema(); /** - * Document's markers' collection. + * Models markers' collection. * * @readonly * @member {module:engine/model/markercollection~MarkerCollection} @@ -39,6 +56,43 @@ export default class Model { this.decorate( 'applyOperation' ); } + /** + * Change method is the primary way of changing the model. You should use it to modify any node, including detached + * nodes, not added to the {@link #document}. + * + * model.change( writer => { + * writer.insertText( 'foo', paragraph, 'end' ); + * } ); + * + * All changes inside the change block use the same {@link module:engine/model/batch~Batch} so share the same + * undo step. + * + * model.change( writer => { + * writer.insertText( 'foo', paragraph, 'end' ); // foo + * + * model.change( writer => { + * writer.insertText( 'bar', paragraph, 'end' ); // foobar + * } ); + * + * writer.insertText( 'bom', paragraph, 'end' ); // foobarbom + * } ); + * + * Change block is executed imminently. + * + * You can also return a value from the change block. + * + * const img = model.change( writer => { + * return writer.createElement( 'img' ); + * } ); + * + * When the outermost block is done the {@link #event:change} event is fired. + * + * @see #enqueueChange + * @fires event:change + * @fires event:changesDone + * @param {Function} callback Callback function which may modify the model. + * @returns {*} Value returned by the callback + */ change( callback ) { if ( this._pendingChanges.length === 0 ) { this._pendingChanges.push( { batch: new Batch(), callback } ); @@ -49,6 +103,39 @@ export default class Model { } } + /** + * `enqueueChange` method is very similar to the {@link #change change method}, with two major differences. + * + * First, the callback of the `enqueueChange` is executed when all other changes are done. It might be executed + * imminently if it is not nested in any other change block, but if it is nested in another change it will be delayed + * and executed after the outermost block. If will be also executed after all previous `enqueueChange` blocks. + * + * model.change( writer => { + * console.log( 1 ); + * + * model.enqueueChange( writer => { + * console.log( 3 ); + * } ); + * + * console.log( 2 ); + * } ); + * + * Second, it let you define the {@link module:engine/model/batch~Batch} to which you want to add your changes. + * By default it creates a new batch, note that in the sample above `change` and `enqueueChange` blocks use a different + * batch (and different {@link module:engine/model/writer~Writer} since each of them operates on the separate batch). + * + * Using `enqueueChange` block you can also add some changes to the batch you used before. + * + * model.enqueueChange( batch, writer => { + * writer.insertText( 'foo', paragraph, 'end' ); + * } ); + * + * @fires event:change + * @fires event:changesDone + * @param {[]} batchOrType Batch or batch type should be used in the callback. + * If not defined new batch will be created. + * @param {Function} callback Callback function which may modify the model. + */ enqueueChange( batchOrType, callback ) { if ( typeof batchOrType === 'string' ) { batchOrType = new Batch( batchOrType ); @@ -64,6 +151,13 @@ export default class Model { } } + /** + * Common part of {@link #change} and {@link #enqueueChange} which calls callbacks and returns array of values + * returned by these callbacks. + * + * @private + * @returns {Array.<*>} Array of values returned by callbacks. + */ _runPendingChanges() { const ret = []; @@ -84,6 +178,14 @@ export default class Model { return ret; } + /** + * {@link #decorate Decorated} function to apply {@link module:engine/model/operation/operation~Operation operations} + * on the model. + * + * @param {module:engine/model/operation/operation~Operation} operation Operation to apply + * @returns {Object} Object with additional information about the applied changes. It properties depends on the + * operation type. + */ applyOperation( operation ) { return operation._execute(); } @@ -95,6 +197,25 @@ export default class Model { this.document.destroy(); this.stopListening(); } + + /** + * Fires after leaving each {@link #enqueueChange} block or outermost {@link #change} block. + * Have the same parameters as {@link module:engine/model/document~Document#change}. + * + * @event change + */ + + /** + * Fires when all queued model changes are done. + * + * @see #change + * @see #enqueueChange + * @event changesDone + */ + + /** + * @event applyOperation + */ } mix( Model, ObservableMixin ); diff --git a/src/model/model.jsdoc b/src/model/model.jsdoc deleted file mode 100644 index 54abe7c86..000000000 --- a/src/model/model.jsdoc +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -/** - * @module engine/model/model - */ diff --git a/src/model/writer.js b/src/model/writer.js index d609c6bb2..d3d8e4960 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -41,24 +41,28 @@ import toMap from '@ckeditor/ckeditor5-utils/src/tomap'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** - * `Batch` instance groups document changes ({@link module:engine/model/delta/delta~Delta deltas}). All deltas grouped in a single `Batch` - * can be reverted together, so you can think about `Batch` as of a single undo step. If you want to extend given undo step you - * can call another method on the same `Batch` object. If you want to create a separate undo step you can create a new `Batch`. + * Model writer it the proper way of modifying model. It should be used whenever you wants to create node, modify + * child nodes, attributes or text. To get writer use {@link module:engine/model~model#change} or + * {@link @see module:engine/model~model#enqueueChange}. * - * For example to create two separate undo steps you can call: + * model.change( writer => { + * writer.insertText( 'foo', paragraph, 'end' ); + * } ); * - * doc.batch().insert( 'foo', firstPosition ); - * doc.batch().insert( 'bar', secondPosition ); - * - * To create a single undo step: - * - * const batch = doc.batch(); - * writer.insert( 'foo', firstPosition ); - * writer.insert( 'bar', secondPosition ); + * Note that writer can be passed to a nested function but you should never store and use it outside the `change` or + * `enqueueChange` block. * + * @see module:engine/model~model#change + * @see module:engine/model~model#enqueueChange */ export default class Writer { /** + * Writer class constructor. + * + * It is not recommended to use it directly, use {@link module:engine/model~model#change} or + * {@link module:engine/model~model#enqueueChanges} instead. + * + * @protected * @param {module:engine/model~Model} model * @param {module:engine/model/batch~Batch} batch */ From cde21de31bf021011cc62bcd58a88accc71ce9a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 9 Nov 2017 17:46:49 +0100 Subject: [PATCH 148/724] Fix: Don't register LiveRange as listeningTo in `DocumentSelection._prepareRange()`. --- src/model/documentselection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 925eb6336..4556f7e4f 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -339,7 +339,7 @@ export default class DocumentSelection extends Selection { const liveRange = LiveRange.createFromRange( range ); - this.listenTo( liveRange, 'change:range', ( evt, oldRange, data ) => { + liveRange.on( 'change:range', ( evt, oldRange, data ) => { // If `LiveRange` is in whole moved to the graveyard, fix that range. if ( liveRange.root == this._document.graveyard ) { this._fixGraveyardSelection( liveRange, data.sourcePosition ); From ef23b8c1f4c49207a138f225de50eeaae23a27eb Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 11 Dec 2017 16:36:22 +0100 Subject: [PATCH 149/724] Added a 50ms timeout after focus before rendering. --- src/view/observer/focusobserver.js | 3 ++- tests/view/observer/focusobserver.js | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/view/observer/focusobserver.js b/src/view/observer/focusobserver.js index e2fd03fcb..f985d1d6b 100644 --- a/src/view/observer/focusobserver.js +++ b/src/view/observer/focusobserver.js @@ -35,7 +35,8 @@ export default class FocusObserver extends DomEventObserver { // We need to wait until `SelectionObserver` handle the event and then render. Otherwise rendering will // overwrite new DOM selection with selection from the view. // See https://github.com/ckeditor/ckeditor5-engine/issues/795 for more details. - this._renderTimeoutId = setTimeout( () => document.render(), 0 ); + // Long timeout is needed to solve #676 and https://github.com/ckeditor/ckeditor5-engine/issues/1157 issues. + this._renderTimeoutId = setTimeout( () => document.render(), 50 ); } ); document.on( 'blur', ( evt, data ) => { diff --git a/tests/view/observer/focusobserver.js b/tests/view/observer/focusobserver.js index f452a7533..5289f67fd 100644 --- a/tests/view/observer/focusobserver.js +++ b/tests/view/observer/focusobserver.js @@ -115,13 +115,13 @@ describe( 'FocusObserver', () => { expect( viewDocument.isFocused ).to.be.true; } ); - it( 'should delay rendering to the next iteration of event loop', () => { + it( 'should delay rendering by 50ms', () => { const renderSpy = sinon.spy( viewDocument, 'render' ); const clock = sinon.useFakeTimers(); observer.onDomEvent( { type: 'focus', target: domMain } ); sinon.assert.notCalled( renderSpy ); - clock.tick( 0 ); + clock.tick( 50 ); sinon.assert.called( renderSpy ); clock.restore(); @@ -134,7 +134,7 @@ describe( 'FocusObserver', () => { observer.onDomEvent( { type: 'focus', target: domMain } ); sinon.assert.notCalled( renderSpy ); observer.destroy(); - clock.tick( 0 ); + clock.tick( 50 ); sinon.assert.notCalled( renderSpy ); clock.restore(); From 3a7a8208b6a4f53e2d4cea0b48e57ff14c71a119 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 18:15:38 +0100 Subject: [PATCH 150/724] Imporved docs. --- src/dev-utils/model.js | 1 - src/model/document.js | 2 +- src/model/writer.js | 12 ++++++------ 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 3c5f146cb..8b23da198 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -68,7 +68,6 @@ getData._stringify = stringify; /** * Sets the contents of the {@link module:engine/model/document~Document Document} provided as HTML-like string. - * It uses {@link module:engine/model/document~Document#enqueueChanges enqueueChanges} method. * * **Note:** Remember to register elements in {@link module:engine/model/document~Document#schema document's schema} before inserting them. * diff --git a/src/model/document.js b/src/model/document.js index b46598356..4b6475394 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -400,7 +400,7 @@ export default class Document { */ /** - * Fired when all queued document changes are done. See {@link #enqueueChanges}. + * Fired when all queued document changes are done. See {@link module:engine/model/model~Model#change}. * * @event changesDone */ diff --git a/src/model/writer.js b/src/model/writer.js index d3d8e4960..2f8565281 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -52,23 +52,23 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * Note that writer can be passed to a nested function but you should never store and use it outside the `change` or * `enqueueChange` block. * - * @see module:engine/model~model#change - * @see module:engine/model~model#enqueueChange + * @see module:engine/model/model~model#change + * @see module:engine/model/model~model#enqueueChange */ export default class Writer { /** * Writer class constructor. * - * It is not recommended to use it directly, use {@link module:engine/model~model#change} or - * {@link module:engine/model~model#enqueueChanges} instead. + * It is not recommended to use it directly, use {@link module:engine/model/model~Model#change} or + * {@link module:engine/model/model~Model#enqueueChanges} instead. * * @protected - * @param {module:engine/model~Model} model + * @param {module:engine/model/model~Model} model * @param {module:engine/model/batch~Batch} batch */ constructor( model, batch ) { /** - * @type {module:engine/model~Model} + * @type {module:engine/model/model~Model} */ this.model = model; From d663a139218912a5c7f2632b570083e640f09a64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 18:28:49 +0100 Subject: [PATCH 151/724] Fixed incorrect document reference. --- src/dev-utils/enableenginedebug.js | 2 +- src/model/schema.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index 4d593cb64..094c689b9 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -655,7 +655,7 @@ class DebugPlugin extends Plugin { constructor( editor ) { super( editor ); - const modelDocument = this.editor.document; + const modelDocument = this.editor.model.document; const viewDocument = this.editor.editing.view; modelDocument[ treeDump ] = []; diff --git a/src/model/schema.js b/src/model/schema.js index 149ff37e2..22d113ddb 100644 --- a/src/model/schema.js +++ b/src/model/schema.js @@ -23,7 +23,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * * For instance, if a feature wants to define that an attribute bold is allowed on the text it needs to register this rule like this: * - * editor.document.schema.allow( '$text', 'bold' ); + * editor.model.schema.allow( '$text', 'bold' ); * * Note: items prefixed with `$` are special group of items. By default, `Schema` defines three special items: * @@ -152,7 +152,7 @@ export default class Schema { * if ( schema.check( query ) ) { ... } * * // Check whether bold and italic text can be placed at caret position. - * let caretPos = editor.document.selection.getFirstPosition(); + * let caretPos = editor.model.document.selection.getFirstPosition(); * let query = { * name: '$text', * attributes: [ 'bold', 'italic' ], From b19b1fefb6ac9a021102104a1aa083f058468f07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 18:40:47 +0100 Subject: [PATCH 152/724] Changed incorrect markers collection reference. --- tests/model/operation/transform.js | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/tests/model/operation/transform.js b/tests/model/operation/transform.js index b78a17c13..5e66af7e8 100644 --- a/tests/model/operation/transform.js +++ b/tests/model/operation/transform.js @@ -21,11 +21,10 @@ import RenameOperation from '../../../src/model/operation/renameoperation'; import NoOperation from '../../../src/model/operation/nooperation'; describe( 'transform', () => { - let doc, root, op, nodeA, nodeB, expected, baseVersion; + let model, doc, root, op, nodeA, nodeB, expected, baseVersion; beforeEach( () => { - const model = new Model(); - + model = new Model(); doc = model.document; root = doc.createRoot(); @@ -476,7 +475,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'no position update', () => { const newRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 4 ] ) ); - const transformBy = new MarkerOperation( 'name', null, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', null, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -1200,7 +1199,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'no operation update', () => { const newRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 8 ] ) ); - const transformBy = new MarkerOperation( 'name', null, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', null, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -1680,7 +1679,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'no position update', () => { const newRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 8 ] ) ); - const transformBy = new MarkerOperation( 'name', null, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', null, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -2887,7 +2886,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'no position update', () => { const newRange = new Range( new Position( root, [ 2, 2, 3 ] ), new Position( root, [ 2, 2, 8 ] ) ); - const transformBy = new MarkerOperation( 'name', null, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', null, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -3026,7 +3025,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'no position update', () => { const newRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 8 ] ) ); - const transformBy = new MarkerOperation( 'name', null, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', null, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -3150,7 +3149,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'no operation update', () => { const newRange = new Range( new Position( root, [ 0, 2, 0 ] ), new Position( root, [ 0, 2, 8 ] ) ); - const transformBy = new MarkerOperation( 'name', null, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', null, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -3319,7 +3318,7 @@ describe( 'transform', () => { beforeEach( () => { oldRange = Range.createFromParentsAndOffsets( root, 1, root, 4 ); newRange = Range.createFromParentsAndOffsets( root, 10, root, 12 ); - op = new MarkerOperation( 'name', oldRange, newRange, doc.markers, baseVersion ); + op = new MarkerOperation( 'name', oldRange, newRange, model.markers, baseVersion ); expected = { name: 'name', @@ -3469,7 +3468,7 @@ describe( 'transform', () => { describe( 'by MarkerOperation', () => { it( 'different marker name: no operation update', () => { - const transformBy = new MarkerOperation( 'otherName', oldRange, newRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'otherName', oldRange, newRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -3479,7 +3478,7 @@ describe( 'transform', () => { it( 'same marker name and is important: convert to NoOperation', () => { const anotherRange = Range.createFromParentsAndOffsets( root, 2, root, 2 ); - const transformBy = new MarkerOperation( 'name', oldRange, anotherRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', oldRange, anotherRange, model.markers, baseVersion ); const transOp = transform( op, transformBy ); @@ -3492,7 +3491,7 @@ describe( 'transform', () => { it( 'same marker name and is less important: update oldRange parameter', () => { const anotherRange = Range.createFromParentsAndOffsets( root, 2, root, 2 ); - const transformBy = new MarkerOperation( 'name', oldRange, anotherRange, doc.markers, baseVersion ); + const transformBy = new MarkerOperation( 'name', oldRange, anotherRange, model.markers, baseVersion ); const transOp = transform( op, transformBy, { isStrong: true } ); From cf9e0846826bbb13d1703f12ebd4937f8dae7052 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 18:41:53 +0100 Subject: [PATCH 153/724] Fixed typo in Model tests. --- tests/model/model.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/model/model.js b/tests/model/model.js index 12db5cc6a..c984749b1 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -60,7 +60,7 @@ describe( 'Model', () => { } } ); - it( 'should execute enqueueChanges immediately if its the first block', () => { + it( 'should execute enqueueChange immediately if its the first block', () => { model.enqueueChange( () => { changes += 'A'; @@ -80,7 +80,7 @@ describe( 'Model', () => { } } ); - it( 'should be possible to enqueueChanges immediately if its the first block', () => { + it( 'should be possible to enqueueChange immediately if its the first block', () => { model.enqueueChange( () => { changes += 'A'; @@ -96,7 +96,7 @@ describe( 'Model', () => { } } ); - it( 'should be possible to nest change in enqueueChanges', () => { + it( 'should be possible to nest change in enqueueChange', () => { model.enqueueChange( () => { changes += 'A'; @@ -118,7 +118,7 @@ describe( 'Model', () => { } } ); - it( 'should be possible to nest enqueueChanges in enqueueChanges', () => { + it( 'should be possible to nest enqueueChange in enqueueChange', () => { model.enqueueChange( () => { changes += 'A'; @@ -136,7 +136,7 @@ describe( 'Model', () => { } } ); - it( 'should be possible to nest enqueueChanges in changes', () => { + it( 'should be possible to nest enqueueChange in changes', () => { const ret = model.change( () => { changes += 'A'; @@ -158,7 +158,7 @@ describe( 'Model', () => { } } ); - it( 'should be possible to nest enqueueChanges in enqueueChanges event', () => { + it( 'should be possible to nest enqueueChange in enqueueChange event', () => { model.once( 'change', () => { model.enqueueChange( () => { changes += 'C'; @@ -178,7 +178,7 @@ describe( 'Model', () => { expect( changes ).to.equal( 'ABCD' ); } ); - it( 'should be possible to nest enqueueChanges in changes event', () => { + it( 'should be possible to nest enqueueChange in changes event', () => { model.once( 'change', () => { model.enqueueChange( () => { changes += 'C'; @@ -198,7 +198,7 @@ describe( 'Model', () => { expect( changes ).to.equal( 'ABCD' ); } ); - it( 'should be possible to nest changes in enqueueChanges event', () => { + it( 'should be possible to nest changes in enqueueChange event', () => { model.once( 'change', () => { model.change( () => { changes += 'B'; From 2ae88be96ba806868671d69de8ec0606c184635c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 18:48:51 +0100 Subject: [PATCH 154/724] Increased Model class CC. --- tests/model/model.js | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/tests/model/model.js b/tests/model/model.js index c984749b1..d2f737cba 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -306,6 +306,21 @@ describe( 'Model', () => { } ); } ); + describe( 'applyOperation', () => { + it( 'should execute provided operation end return the result of operation', () => { + const returnValue = { foo: 'bar' }; + + const operation = { + _execute: sinon.stub().returns( returnValue ) + }; + + model.applyOperation( operation ); + + sinon.assert.calledOnce( operation._execute ); + expect( model.applyOperation( operation ) ).to.equal( returnValue ); + } ); + } ); + describe( 'destroy()', () => { it( 'should destroy document', () => { sinon.spy( model.document, 'destroy' ); From 85b8de5af73cf53ba4f952e779c35b2a1696e469 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 20:58:54 +0100 Subject: [PATCH 155/724] Improved docs. --- src/conversion/modelconversiondispatcher.js | 4 ++-- src/dev-utils/model.js | 2 +- src/model/documentfragment.js | 8 ++++---- src/model/documentselection.js | 2 +- src/model/node.js | 2 +- src/model/text.js | 2 +- src/model/textproxy.js | 2 +- src/model/writer.js | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/conversion/modelconversiondispatcher.js b/src/conversion/modelconversiondispatcher.js index f2a1ef973..b5762a371 100644 --- a/src/conversion/modelconversiondispatcher.js +++ b/src/conversion/modelconversiondispatcher.js @@ -110,7 +110,7 @@ export default class ModelConversionDispatcher { /** * Creates a `ModelConversionDispatcher` that operates using passed API. * - * @param {module:engine/model/document~Document} model Data model. + * @param {module:engine/model/model~Model} model Data model. * @param {Object} [conversionApi] Interface passed by dispatcher to the events callbacks. */ constructor( model, conversionApi = {} ) { @@ -118,7 +118,7 @@ export default class ModelConversionDispatcher { * Data model instance bound with this dispatcher. * * @private - * @member {module:engine/model/document~Document} + * @member {module:engine/model/model~Model} */ this._model = model; diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 8b23da198..4bd78a492 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -69,7 +69,7 @@ getData._stringify = stringify; /** * Sets the contents of the {@link module:engine/model/document~Document Document} provided as HTML-like string. * - * **Note:** Remember to register elements in {@link module:engine/model/document~Document#schema document's schema} before inserting them. + * **Note:** Remember to register elements in {@link module:engine/model/model~Model#schema model's schema} before inserting them. * * **Note:** To create {@link module:engine/model/text~Text text} node witch containing attributes use: * diff --git a/src/model/documentfragment.js b/src/model/documentfragment.js index 0a2e44329..39ca40cb7 100644 --- a/src/model/documentfragment.js +++ b/src/model/documentfragment.js @@ -17,8 +17,8 @@ import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable'; * can be seen as siblings. In other words, it is a detached part of model tree, without a root. * * DocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection - * will be set to the {@link module:engine/model/document~Document#markers document markers} by a - * {@linkTODO module:engine/model/writer~writer.insert} function. + * will be set to the {@link module:engine/model/model~Model#markers model markers} by a + * {@link module:engine/model/writer~Writer#insert} function. */ export default class DocumentFragment { /** @@ -30,10 +30,10 @@ export default class DocumentFragment { constructor( children ) { /** * DocumentFragment static markers map. This is a list of names and {@link module:engine/model/range~Range ranges} - * which will be set as Markers to {@link module:engine/model/document~Document#markers document markers collection} + * which will be set as Markers to {@link module:engine/model/model~Model#markers model markers collection} * when DocumentFragment will be inserted to the document. * - * @member {Map} module:engine/model/documentfragment~DocumentFragment#markers + * @member {Map} module:engine/model/documentfragment~DocumentFragment#markers */ this.markers = new Map(); diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 4556f7e4f..055d0e6f4 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -52,7 +52,7 @@ export default class DocumentSelection extends Selection { * Creates an empty live selection for given {@link module:engine/model/document~Document}. * * @param {module:engine/model/document~Document} document Document which owns this selection. - * @param {module:engine/model/model~Model} model + * @param {module:engine/model/model~Model} model Data model. */ constructor( document, model ) { super(); diff --git a/src/model/node.js b/src/model/node.js index fa472a5a5..b10fa868d 100644 --- a/src/model/node.js +++ b/src/model/node.js @@ -17,7 +17,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * * **Note:** If a node is detached from the model tree, you can manipulate it using it's API. * However, it is **very important** that nodes already attached to model tree should be only changed through - * {@link module:engine/model/document~Document#batch Batch API}. + * {@link module:engine/model/writer~Writer Writer API}. * * Changes done by `Node` methods, like {@link module:engine/model/element~Element#insertChildren insertChildren} or * {@link module:engine/model/node~Node#setAttribute setAttribute} diff --git a/src/model/text.js b/src/model/text.js index de2895b42..28cc0680b 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -15,7 +15,7 @@ import Node from './node'; * **Important:** see {@link module:engine/model/node~Node} to read about restrictions using `Text` and `Node` API. * * **Note:** keep in mind that `Text` instances might indirectly got removed from model tree when model is changed. - * This happens when {@linkTODO module:engine/model/writer~writer model writer} is used to change model and the text node is merged with + * This happens when {@link module:engine/model/writer~Writer model writer} is used to change model and the text node is merged with * another text node. Then, both text nodes are removed and a new text node is inserted into the model. Because of * this behavior, keeping references to `Text` is not recommended. Instead, consider creating * {@link module:engine/model/liveposition~LivePosition live position} placed before the text node. diff --git a/src/model/textproxy.js b/src/model/textproxy.js index 763aa0d90..a30d3c52a 100644 --- a/src/model/textproxy.js +++ b/src/model/textproxy.js @@ -28,7 +28,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * parameter of methods. * * **Note:** `TextProxy` is a readonly interface. If you want to perform changes on model data represented by a `TextProxy` - * use {@linkTODO module:engine/model/writer~writer model writer API}. + * use {@link module:engine/model/writer~Writer model writer API}. * * **Note:** `TextProxy` instances are created on the fly, basing on the current state of model. Because of this, it is * highly unrecommended to store references to `TextProxy` instances. `TextProxy` instances are not refreshed when diff --git a/src/model/writer.js b/src/model/writer.js index 2f8565281..408c303ac 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -710,7 +710,7 @@ export default class Writer { * * If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance * is passed), `range` parameter may be omitted. In this case marker will not be updated in - * {@link module:engine/model/document~Document#markers document marker collection}. However the marker will be added to + * {@link module:engine/model/model~Model#markers document marker collection}. However the marker will be added to * the document history. This may be important for other features, like undo. From document history point of view, it will * look like the marker was created and added to the document at the moment when it is set using this method. * From f41f4ef59d7363cde7671bd27a8406a0500745af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 21:13:07 +0100 Subject: [PATCH 156/724] Aligned manual tests with engine chamges. --- tests/manual/highlight.js | 21 ++++++++------------- tests/manual/markers.js | 26 +++++++++++++------------- tests/manual/nestededitable.js | 7 +++---- tests/manual/tickets/1088/1.js | 2 +- tests/manual/tickets/462/1.js | 4 ++-- tests/manual/tickets/475/1.js | 9 ++++----- tests/manual/tickets/603/1.js | 2 +- tests/manual/tickets/880/1.js | 2 +- 8 files changed, 33 insertions(+), 40 deletions(-) diff --git a/tests/manual/highlight.js b/tests/manual/highlight.js index e9b766cf4..b10b2f1ef 100644 --- a/tests/manual/highlight.js +++ b/tests/manual/highlight.js @@ -32,8 +32,7 @@ class FancyWidget extends Plugin { init() { const editor = this.editor; - const doc = editor.document; - const schema = doc.schema; + const schema = editor.model.schema; const data = editor.data; const editing = editor.editing; @@ -101,9 +100,9 @@ ClassicEditor.create( global.document.querySelector( '#editor' ), { } ); document.getElementById( 'remove-markers' ).addEventListener( 'mousedown', evt => { - const markers = editor.document.markers; + const markers = editor.model.markers; - editor.document.enqueueChanges( () => { + editor.model.change( () => { for ( const marker of markers ) { markers.remove( marker ); } @@ -117,18 +116,14 @@ ClassicEditor.create( global.document.querySelector( '#editor' ), { } ); function addMarker( editor, color ) { - const model = editor.document; - - editor.document.enqueueChanges( () => { - const range = ModelRange.createFromRange( model.selection.getFirstRange() ); - model.markers.set( 'marker:' + color, range ); + editor.model.change( () => { + const range = ModelRange.createFromRange( editor.model.document.selection.getFirstRange() ); + editor.model.markers.set( 'marker:' + color, range ); } ); } function removeMarker( editor, color ) { - const model = editor.document; - - editor.document.enqueueChanges( () => { - model.markers.remove( 'marker:' + color ); + editor.model.change( () => { + editor.model.markers.remove( 'marker:' + color ); } ); } diff --git a/tests/manual/markers.js b/tests/manual/markers.js index eef7f3f71..499e4090a 100644 --- a/tests/manual/markers.js +++ b/tests/manual/markers.js @@ -30,7 +30,7 @@ ClassicEditor } ) .then( editor => { window.editor = editor; - model = window.editor.editing.model; + model = editor.model; buildModelConverter().for( editor.editing.modelToView ) .fromMarker( 'highlight' ) @@ -73,8 +73,8 @@ ClassicEditor moveSelectionByOffset( 1 ); } ); - model.enqueueChanges( () => { - const root = model.getRoot(); + model.change( () => { + const root = model.document.getRoot(); const range = new Range( new Position( root, [ 0, 10 ] ), new Position( root, [ 0, 16 ] ) ); const name = 'highlight:yellow:' + uid(); @@ -91,8 +91,8 @@ function uid() { } function addHighlight( color ) { - model.enqueueChanges( () => { - const range = Range.createFromRange( model.selection.getFirstRange() ); + model.change( () => { + const range = Range.createFromRange( model.document.selection.getFirstRange() ); const name = 'highlight:' + color + ':' + uid(); markerNames.push( name ); @@ -101,8 +101,8 @@ function addHighlight( color ) { } function removeHighlight() { - model.enqueueChanges( () => { - const pos = model.selection.getFirstPosition(); + model.change( () => { + const pos = model.document.selection.getFirstPosition(); for ( let i = 0; i < markerNames.length; i++ ) { const name = markerNames[ i ]; @@ -120,22 +120,22 @@ function removeHighlight() { } function moveSelectionToStart() { - const range = model.selection.getFirstRange(); + const range = model.document.selection.getFirstRange(); if ( range.isFlat ) { - model.enqueueChanges( () => { - model.batch().move( range, new Position( model.getRoot(), [ 0, 0 ] ) ); + model.change( writer => { + writer.move( range, new Position( model.document.getRoot(), [ 0, 0 ] ) ); } ); } } function moveSelectionByOffset( offset ) { - const range = model.selection.getFirstRange(); + const range = model.document.selection.getFirstRange(); const pos = offset < 0 ? range.start : range.end; if ( range.isFlat ) { - model.enqueueChanges( () => { - model.batch().move( range, pos.getShiftedBy( offset ) ); + model.change( writer => { + writer.move( range, pos.getShiftedBy( offset ) ); } ); } } diff --git a/tests/manual/nestededitable.js b/tests/manual/nestededitable.js index e31910e65..42c6fb6b5 100644 --- a/tests/manual/nestededitable.js +++ b/tests/manual/nestededitable.js @@ -23,11 +23,10 @@ import './nestededitable.css'; class NestedEditable extends Plugin { init() { const editor = this.editor; - const document = editor.document; const editing = editor.editing; const viewDocument = editing.view; const data = editor.data; - const schema = document.schema; + const schema = editor.model.schema; schema.registerItem( 'figure' ); schema.registerItem( 'figcaption' ); @@ -75,7 +74,7 @@ ClassicEditor toolbar: [ 'undo', 'redo' ] } ) .then( editor => { - editor.document.on( 'changesDone', () => { + editor.model.document.on( 'changesDone', () => { printModelContents( editor ); } ); @@ -87,5 +86,5 @@ ClassicEditor const modelDiv = global.document.querySelector( '#model' ); function printModelContents( editor ) { - modelDiv.innerText = getData( editor.document ); + modelDiv.innerText = getData( editor.model ); } diff --git a/tests/manual/tickets/1088/1.js b/tests/manual/tickets/1088/1.js index 3f556bd21..fb850d9b3 100644 --- a/tests/manual/tickets/1088/1.js +++ b/tests/manual/tickets/1088/1.js @@ -19,7 +19,7 @@ ClassicEditor .then( editor => { window.editor = editor; - const schema = editor.document.schema; + const schema = editor.model.schema; schema.disallow( { name: '$text', attributes: [ 'linkHref', 'italic' ], inside: 'heading1' } ); schema.disallow( { name: '$text', attributes: [ 'italic' ], inside: 'heading2' } ); diff --git a/tests/manual/tickets/462/1.js b/tests/manual/tickets/462/1.js index c3026154b..bce3009c2 100644 --- a/tests/manual/tickets/462/1.js +++ b/tests/manual/tickets/462/1.js @@ -27,8 +27,8 @@ ClassicEditor const selectionExists = domSelection && domSelection.anchorNode; console.log( editor.editing.view.getDomRoot().innerHTML.replace( /\u200b/g, '@' ) ); - console.log( 'selection.hasAttribute( italic ):', editor.document.selection.hasAttribute( 'italic' ) ); - console.log( 'selection.hasAttribute( bold ):', editor.document.selection.hasAttribute( 'bold' ) ); + console.log( 'selection.hasAttribute( italic ):', editor.model.document.selection.hasAttribute( 'italic' ) ); + console.log( 'selection.hasAttribute( bold ):', editor.model.document.selection.hasAttribute( 'bold' ) ); console.log( 'selection anchor\'s parentNode:', selectionExists ? domSelection.anchorNode.parentNode : 'no DOM selection' ); }, 2000 ); } ) diff --git a/tests/manual/tickets/475/1.js b/tests/manual/tickets/475/1.js index f5c090c73..a2fa37c51 100644 --- a/tests/manual/tickets/475/1.js +++ b/tests/manual/tickets/475/1.js @@ -31,7 +31,7 @@ class Link extends Plugin { const editing = editor.editing; // Allow bold attribute on all inline nodes. - editor.document.schema.allow( { name: '$inline', attributes: [ 'link' ] } ); + editor.model.schema.allow( { name: '$inline', attributes: [ 'link' ] } ); // Build converter from model to view for data and editing pipelines. buildModelConverter().for( data.modelToView, editing.modelToView ) @@ -49,7 +49,7 @@ const urlRegex = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._+~#=]{2,256}\.[a-z]{2,6}\b( class AutoLinker extends Plugin { init() { - this.editor.document.on( 'change', ( event, type, changes, batch ) => { + this.editor.model.document.on( 'change', ( event, type, changes, batch ) => { if ( type != 'insert' ) { return; } @@ -73,14 +73,13 @@ class AutoLinker extends Plugin { return; } - const doc = this.editor.document; const url = matchedUrl[ 0 ]; const offset = _getLastPathPart( currentValue.nextPosition.path ) + matchedUrl.index; const livePos = LivePosition.createFromParentAndOffset( currentValue.item.parent, offset ); - doc.enqueueChanges( () => { + this.editor.model.enqueueChange( batch, writer => { const urlRange = Range.createFromPositionAndShift( livePos, url.length ); - batch.setAttribute( 'link', url, urlRange ); + writer.setAttribute( 'link', url, urlRange ); } ); } } ); diff --git a/tests/manual/tickets/603/1.js b/tests/manual/tickets/603/1.js index 01624c6dd..fbe8616e8 100644 --- a/tests/manual/tickets/603/1.js +++ b/tests/manual/tickets/603/1.js @@ -21,7 +21,7 @@ ClassicEditor .then( editor => { window.editor = editor; - const sel = editor.document.selection; + const sel = editor.model.document.selection; sel.on( 'change', ( evt, data ) => { const date = new Date(); diff --git a/tests/manual/tickets/880/1.js b/tests/manual/tickets/880/1.js index 5ce3d7429..f706a4921 100644 --- a/tests/manual/tickets/880/1.js +++ b/tests/manual/tickets/880/1.js @@ -19,7 +19,7 @@ ClassicEditor window.editor = editor; editor.editing.view.on( 'selectionChange', () => { - editor.document.enqueueChanges( () => { + editor.model.change( () => { } ); console.log( 'selectionChange', ( new Date() ).getTime() ); } ); From e966841cf3dbaf04e332cf6c43d288860391d8fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 12 Dec 2017 21:46:00 +0100 Subject: [PATCH 157/724] Fixed invalid docs. --- src/model/batch.js | 10 +++++----- src/model/delta/attributedelta.js | 2 +- src/model/delta/insertdelta.js | 2 +- src/model/delta/markerdelta.js | 4 ++-- src/model/delta/mergedelta.js | 2 +- src/model/delta/movedelta.js | 2 +- src/model/delta/removedelta.js | 2 +- src/model/delta/renamedelta.js | 2 +- src/model/delta/rootattributedelta.js | 2 +- src/model/delta/splitdelta.js | 2 +- src/model/delta/unwrapdelta.js | 2 +- src/model/delta/weakinsertdelta.js | 2 +- src/model/delta/wrapdelta.js | 2 +- src/model/model.js | 26 ++++++++++++++------------ src/model/node.js | 4 ++-- src/model/operation/operation.js | 2 +- src/model/operation/transform.js | 2 +- src/model/writer.js | 18 +++++++++--------- 18 files changed, 45 insertions(+), 43 deletions(-) diff --git a/src/model/batch.js b/src/model/batch.js index d31a40984..23ffdca59 100644 --- a/src/model/batch.js +++ b/src/model/batch.js @@ -10,21 +10,21 @@ /** * `Batch` instance groups model changes ({@link module:engine/model/delta/delta~Delta deltas}). All deltas grouped in a single `Batch` * can be reverted together, so you can think about `Batch` as of a single undo step. If you want to extend given undo step you - * can add more changes to the batch using {@link module:engine/model~model#enqueueChange}: + * can add more changes to the batch using {@link module:engine/model/model~Model#enqueueChange}: * * model.enqueueChange( batch, writer => { * writer.insertText( 'foo', paragraph, 'end' ); * } ); * - * @see module:engine/model~model#enqueueChange - * @see module:engine/model~model#change + * @see module:engine/model/model~Model#enqueueChange + * @see module:engine/model/model~Model#change */ export default class Batch { /** * Creates `Batch` instance. * - * @see module:engine/model~model#enqueueChange - * @see module:engine/model~model#change + * @see module:engine/model/model~Model#enqueueChange + * @see module:engine/model/model~Model#change * @param {'transparent'|'default'} [type='default'] Type of the batch. */ constructor( type = 'default' ) { diff --git a/src/model/delta/attributedelta.js b/src/model/delta/attributedelta.js index 2be997eef..7ce712124 100644 --- a/src/model/delta/attributedelta.js +++ b/src/model/delta/attributedelta.js @@ -14,7 +14,7 @@ import Range from '../range'; /** * To provide specific OT behavior and better collisions solving, methods to change attributes - * ({@link module:engine/model/batch~Batch#setAttribute} and {@link module:engine/model/batch~Batch#removeAttribute}) + * ({@link module:engine/model/writer~Writer#setAttribute} and {@link module:engine/model/writer~Writer#removeAttribute}) * use `AttributeDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/insertdelta.js b/src/model/delta/insertdelta.js index 370dd1e60..16c00c6c5 100644 --- a/src/model/delta/insertdelta.js +++ b/src/model/delta/insertdelta.js @@ -12,7 +12,7 @@ import RemoveDelta from './removedelta'; import DeltaFactory from './deltafactory'; /** - * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#insert Batch#insert} method + * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#insert Batch#insert} method * uses the `InsertDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/markerdelta.js b/src/model/delta/markerdelta.js index 32bc8a25d..80d63fa06 100644 --- a/src/model/delta/markerdelta.js +++ b/src/model/delta/markerdelta.js @@ -11,8 +11,8 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; /** - * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#setMarker Batch#setMarker} - * and {@link module:engine/model/batch~Batch#removeMarker Batch#removeMarker} methods use the `MarkerDelta` class which inherits + * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#setMarker Batch#setMarker} + * and {@link module:engine/model/writer~Writer#removeMarker Batch#removeMarker} methods use the `MarkerDelta` class which inherits * from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/mergedelta.js b/src/model/delta/mergedelta.js index 5cd83b5eb..d13de4cee 100644 --- a/src/model/delta/mergedelta.js +++ b/src/model/delta/mergedelta.js @@ -12,7 +12,7 @@ import DeltaFactory from './deltafactory'; import SplitDelta from './splitdelta'; /** - * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#merge} method + * To provide specific OT behavior and better collisions solving, {@link module:engine/model/writer~Writer#merge} method * uses the `MergeDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/movedelta.js b/src/model/delta/movedelta.js index 4a34ce2aa..5f704ee94 100644 --- a/src/model/delta/movedelta.js +++ b/src/model/delta/movedelta.js @@ -11,7 +11,7 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; /** - * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#move} method + * To provide specific OT behavior and better collisions solving, {@link module:engine/model/writer~Writer#move} method * uses the `MoveDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/removedelta.js b/src/model/delta/removedelta.js index 8756f717f..29294946f 100644 --- a/src/model/delta/removedelta.js +++ b/src/model/delta/removedelta.js @@ -11,7 +11,7 @@ import MoveDelta from './movedelta'; import DeltaFactory from './deltafactory'; /** - * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#remove} method + * To provide specific OT behavior and better collisions solving, {@link module:engine/model/writer~Writer#remove} method * uses the `RemoveDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/renamedelta.js b/src/model/delta/renamedelta.js index d39780726..7d0e1215a 100644 --- a/src/model/delta/renamedelta.js +++ b/src/model/delta/renamedelta.js @@ -11,7 +11,7 @@ import Delta from './delta'; import DeltaFactory from './deltafactory'; /** - * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#rename Batch#rename} method + * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#rename Batch#rename} method * uses the `RenameDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/rootattributedelta.js b/src/model/delta/rootattributedelta.js index 004fc2b2d..95bee02ea 100644 --- a/src/model/delta/rootattributedelta.js +++ b/src/model/delta/rootattributedelta.js @@ -12,7 +12,7 @@ import DeltaFactory from './deltafactory'; /** * To provide specific OT behavior and better collisions solving, methods to change attributes - * ({@link module:engine/model/batch~Batch#setAttribute} and {@link module:engine/model/batch~Batch#removeAttribute}) + * ({@link module:engine/model/writer~Writer#setAttribute} and {@link module:engine/model/writer~Writer#removeAttribute}) * use `RootAttributeDelta` class which inherits from the `Delta` class and may * overwrite some methods. * diff --git a/src/model/delta/splitdelta.js b/src/model/delta/splitdelta.js index fdc042cd0..0994491e1 100644 --- a/src/model/delta/splitdelta.js +++ b/src/model/delta/splitdelta.js @@ -13,7 +13,7 @@ import MoveOperation from '../operation/moveoperation'; import MergeDelta from '../delta/mergedelta'; /** - * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#split} method + * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#split} method * uses `SplitDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/unwrapdelta.js b/src/model/delta/unwrapdelta.js index 23f7aadf9..56e73e2a1 100644 --- a/src/model/delta/unwrapdelta.js +++ b/src/model/delta/unwrapdelta.js @@ -12,7 +12,7 @@ import DeltaFactory from './deltafactory'; import WrapDelta from './wrapdelta'; /** - * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#merge} method + * To provide specific OT behavior and better collisions solving, {@link module:engine/model/writer~Writer#merge} method * uses the `UnwrapDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/weakinsertdelta.js b/src/model/delta/weakinsertdelta.js index 8c63b5187..d4baa0495 100644 --- a/src/model/delta/weakinsertdelta.js +++ b/src/model/delta/weakinsertdelta.js @@ -11,7 +11,7 @@ import InsertDelta from './insertdelta'; import DeltaFactory from './deltafactory'; /** - * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/batch~Batch#insert} method + * To provide specific OT behavior and better collisions solving, the {@link module:engine/model/writer~Writer#insert} method * uses the `WeakInsertDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/delta/wrapdelta.js b/src/model/delta/wrapdelta.js index 391a9a4f8..d657cebfc 100644 --- a/src/model/delta/wrapdelta.js +++ b/src/model/delta/wrapdelta.js @@ -13,7 +13,7 @@ import UnwrapDelta from './unwrapdelta'; import Range from '../range'; /** - * To provide specific OT behavior and better collisions solving, {@link module:engine/model/batch~Batch#merge} method + * To provide specific OT behavior and better collisions solving, {@link module:engine/model/writer~Writer#merge} method * uses the `WrapDelta` class which inherits from the `Delta` class and may overwrite some methods. * * @extends module:engine/model/delta/delta~Delta diff --git a/src/model/model.js b/src/model/model.js index 95d1deedf..16f07fdb2 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -17,14 +17,15 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix'; /** * Editors data model class. Model defines all data: either nodes users see in editable roots, grouped as the - * {@link #document}, and all detached nodes, used to data manipulation. All of them are - * created and modified by the {@link module:engine/model/model~Writer}, which can be get using - * {@link #change} or {@link #enqueueChange} methods. + * {@link module:engine/model/model~Model#document}, and all detached nodes, used to data manipulation. All of them are + * created and modified by the {@link module:engine/model/writer~Writer}, which can be get using + * {@link module:engine/model/model~Model#change} or {@link module:engine/model/model~Model#enqueueChange} methods. */ export default class Model { constructor() { /** - * All callbacks added by {@link #change} or {@link #enqueueChange} methods waiting to be executed. + * All callbacks added by {@link module:engine/model/model~Model#change} or + * {@link module:engine/model/model~Model#enqueueChange} methods waiting to be executed. * * @private * @type {Array.} @@ -58,7 +59,7 @@ export default class Model { /** * Change method is the primary way of changing the model. You should use it to modify any node, including detached - * nodes, not added to the {@link #document}. + * nodes, not added to the {@link module:engine/model/model~Model#document}. * * model.change( writer => { * writer.insertText( 'foo', paragraph, 'end' ); @@ -132,7 +133,7 @@ export default class Model { * * @fires event:change * @fires event:changesDone - * @param {[]} batchOrType Batch or batch type should be used in the callback. + * @param {module:engine/model/batch~Batch|String} batchOrType Batch or batch type should be used in the callback. * If not defined new batch will be created. * @param {Function} callback Callback function which may modify the model. */ @@ -152,8 +153,8 @@ export default class Model { } /** - * Common part of {@link #change} and {@link #enqueueChange} which calls callbacks and returns array of values - * returned by these callbacks. + * Common part of {@link module:engine/model/model~Model#change} and {@link module:engine/model/model~Model#enqueueChange} + * which calls callbacks and returns array of values returned by these callbacks. * * @private * @returns {Array.<*>} Array of values returned by callbacks. @@ -179,8 +180,8 @@ export default class Model { } /** - * {@link #decorate Decorated} function to apply {@link module:engine/model/operation/operation~Operation operations} - * on the model. + * {@link module:utils/observablemixin~ObservableMixin#decorate Decorated} function to apply + * {@link module:engine/model/operation/operation~Operation operations} on the model. * * @param {module:engine/model/operation/operation~Operation} operation Operation to apply * @returns {Object} Object with additional information about the applied changes. It properties depends on the @@ -199,8 +200,9 @@ export default class Model { } /** - * Fires after leaving each {@link #enqueueChange} block or outermost {@link #change} block. - * Have the same parameters as {@link module:engine/model/document~Document#change}. + * Fires after leaving each {@link module:engine/model/model~Model#enqueueChange} block or outermost + * {@link module:engine/model/model~Model#change} block. + * Have the same parameters as {@link module:engine/model/model~Model#change}. * * @event change */ diff --git a/src/model/node.js b/src/model/node.js index b10fa868d..b90d99070 100644 --- a/src/model/node.js +++ b/src/model/node.js @@ -30,9 +30,9 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * 3. Change `Node` that was already added to the model using `Batch` API. * * Similarly, you cannot use `Batch` API on a node that has not been added to the model tree, with the exception - * of {@link module:engine/model/batch~Batch#insert inserting} that node to the model tree. + * of {@link module:engine/model/writer~Writer#insert inserting} that node to the model tree. * - * Be aware that using {@link module:engine/model/batch~Batch#remove remove from Batch API} does not allow to use `Node` API because + * Be aware that using {@link module:engine/model/writer~Writer#remove remove from Batch API} does not allow to use `Node` API because * the information about `Node` is still kept in model document. * * In case of {@link module:engine/model/element~Element element node}, adding and removing children also counts as changing a node and diff --git a/src/model/operation/operation.js b/src/model/operation/operation.js index 43dc7fa79..acbcb3f7f 100644 --- a/src/model/operation/operation.js +++ b/src/model/operation/operation.js @@ -22,7 +22,7 @@ export default class Operation { constructor( baseVersion ) { /** * {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to - * {@link module:engine/model/document~Document#applyOperation apply} operation with different base version than the + * {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the * {@link module:engine/model/document~Document#version document version} the * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown. * diff --git a/src/model/operation/transform.js b/src/model/operation/transform.js index 13cc541ef..c2cc31cc8 100644 --- a/src/model/operation/transform.js +++ b/src/model/operation/transform.js @@ -34,7 +34,7 @@ import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays'; * * Whenever the {@link module:engine/model/document~Document document} * has different {@link module:engine/model/document~Document#version} - * than the operation you want to {@link module:engine/model/document~Document#applyOperation apply}, you need to transform that + * than the operation you want to {@link module:engine/model/model~Model#applyOperation apply}, you need to transform that * operation by all operations which were already applied to the {@link module:engine/model/document~Document document} and have greater * {@link module:engine/model/document~Document#version} than the operation being applied. Transform them in the same order as those * operations which were applied. This way all modifications done to the Tree Data Model will be reflected diff --git a/src/model/writer.js b/src/model/writer.js index 408c303ac..02033e64d 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -42,8 +42,8 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Model writer it the proper way of modifying model. It should be used whenever you wants to create node, modify - * child nodes, attributes or text. To get writer use {@link module:engine/model~model#change} or - * {@link @see module:engine/model~model#enqueueChange}. + * child nodes, attributes or text. To get writer use {@link module:engine/model/model~Model#change} or + * {@link @see module:engine/model/model~Model#enqueueChange}. * * model.change( writer => { * writer.insertText( 'foo', paragraph, 'end' ); @@ -52,15 +52,15 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * Note that writer can be passed to a nested function but you should never store and use it outside the `change` or * `enqueueChange` block. * - * @see module:engine/model/model~model#change - * @see module:engine/model/model~model#enqueueChange + * @see module:engine/model/model~Model#change + * @see module:engine/model/model~Model#enqueueChange */ export default class Writer { /** * Writer class constructor. * * It is not recommended to use it directly, use {@link module:engine/model/model~Model#change} or - * {@link module:engine/model/model~Model#enqueueChanges} instead. + * {@link module:engine/model/model~Model#enqueueChange} instead. * * @protected * @param {module:engine/model/model~Model} model @@ -141,7 +141,7 @@ export default class Writer { * Note that if the item already has parent it will be removed from the previous parent. * * If you want to move {@link module:engine/model/range~Range range} instead of an - * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. + * {@link module:engine/model/item~Item item} use {@link module:engine/model/writer~Writer#move move}. * * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} * item Item or document fragment to insert. @@ -259,7 +259,7 @@ export default class Writer { * Note that if the item already has parent it will be removed from the previous parent. * * If you want to move {@link module:engine/model/range~Range range} instead of an - * {@link module:engine/model/item~Item item} use {@link module:engine/model/batch~Batch#move move}. + * {@link module:engine/model/item~Item item} use {@link module:engine/model/writer~Writer#move move}. * * @param {module:engine/model/item~Item|module:engine/model/documentfragment~DocumentFragment} * item Item or document fragment to insert. @@ -396,7 +396,7 @@ export default class Writer { * Note that items can be moved only within the same tree. It means that you can move items within the same root * (element or document fragment) or between {@link module:engine/model/document~Document#roots documents roots}, * but you can not move items from document fragment to the document or from one detached element to another. Use - * {@link module:engine/model/batch~Batch#insert} in such cases. + * {@link module:engine/model/writer~Writer#insert} in such cases. * * @param {module:engine/model/range~Range} range Source range. * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition @@ -427,7 +427,7 @@ export default class Writer { if ( !isSameTree( range.root, position.root ) ) { /** * Range is going to be moved within not the same document. Please use - * {@link module:engine/model/batch~Batch#insert insert} instead. + * {@link module:engine/model/writer~Writer#insert insert} instead. * * @error writer-move-different-document */ From 8bc19cc3490d5475554ddbc909059107441642dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Wed, 13 Dec 2017 14:04:38 +0100 Subject: [PATCH 158/724] Aligned EngineDebug with engine changes. --- src/dev-utils/enableenginedebug.js | 23 +++--- tests/dev-utils/enableenginedebug.js | 109 ++++++++++++++------------- 2 files changed, 70 insertions(+), 62 deletions(-) diff --git a/src/dev-utils/enableenginedebug.js b/src/dev-utils/enableenginedebug.js index 094c689b9..5788c396d 100644 --- a/src/dev-utils/enableenginedebug.js +++ b/src/dev-utils/enableenginedebug.js @@ -37,6 +37,7 @@ import SplitDelta from '../model/delta/splitdelta'; import UnwrapDelta from '../model/delta/unwrapdelta'; import WrapDelta from '../model/delta/wrapdelta'; import deltaTransform from '../model/delta/transform'; +import Model from '../model/model'; import ModelDocument from '../model/document'; import ModelDocumentFragment from '../model/documentfragment'; import ModelRootElement from '../model/rootelement'; @@ -565,9 +566,9 @@ function enableLoggingTools() { } function enableReplayerTools() { - const _modelDocumentApplyOperation = ModelDocument.prototype.applyOperation; + const _modelApplyOperation = Model.prototype.applyOperation; - sandbox.mock( ModelDocument.prototype, 'applyOperation', function( operation ) { + sandbox.mock( Model.prototype, 'applyOperation', function( operation ) { if ( !this._lastDelta ) { this._appliedDeltas = []; } else if ( this._lastDelta !== operation.delta ) { @@ -576,10 +577,10 @@ function enableReplayerTools() { this._lastDelta = operation.delta; - _modelDocumentApplyOperation.call( this, operation ); + return _modelApplyOperation.call( this, operation ); } ); - sandbox.mock( ModelDocument.prototype, 'getAppliedDeltas', function() { + sandbox.mock( Model.prototype, 'getAppliedDeltas', function() { // No deltas has been applied yet, return empty string. if ( !this._lastDelta ) { return ''; @@ -590,15 +591,15 @@ function enableReplayerTools() { return appliedDeltas.map( JSON.stringify ).join( LOG_SEPARATOR ); } ); - sandbox.mock( ModelDocument.prototype, 'createReplayer', function( stringifiedDeltas ) { + sandbox.mock( Model.prototype, 'createReplayer', function( stringifiedDeltas ) { return new DeltaReplayer( this, LOG_SEPARATOR, stringifiedDeltas ); } ); } function enableDocumentTools() { - const _modelDocumentApplyOperation = ModelDocument.prototype.applyOperation; + const _modelApplyOperation = Model.prototype.applyOperation; - sandbox.mock( ModelDocument.prototype, 'applyOperation', function( operation ) { + sandbox.mock( Model.prototype, 'applyOperation', function( operation ) { logger.log( 'Applying ' + operation ); if ( !this._operationLogs ) { @@ -607,7 +608,7 @@ function enableDocumentTools() { this._operationLogs.push( JSON.stringify( operation.toJSON() ) ); - _modelDocumentApplyOperation.call( this, operation ); + return _modelApplyOperation.call( this, operation ); } ); sandbox.mock( ModelDocument.prototype, 'log', function( version = null ) { @@ -621,9 +622,9 @@ function enableDocumentTools() { } ); sandbox.mock( Editor.prototype, 'logModel', function( version = null ) { - version = version === null ? this.document.version : version; + version = version === null ? this.model.document.version : version; - this.document.log( version ); + this.model.document.log( version ); } ); sandbox.mock( Editor.prototype, 'logView', function( version ) { @@ -631,7 +632,7 @@ function enableDocumentTools() { } ); sandbox.mock( Editor.prototype, 'logDocuments', function( version = null ) { - version = version === null ? this.document.version : version; + version = version === null ? this.model.document.version : version; this.logModel( version ); this.logView( version ); diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index bf029c7f6..22f63b675 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -35,7 +35,7 @@ import SplitDelta from '../../src/model/delta/splitdelta'; import UnwrapDelta from '../../src/model/delta/unwrapdelta'; import WrapDelta from '../../src/model/delta/wrapdelta'; import deltaTransform from '../../src/model/delta/transform'; -import ModelDocument from '../../src/model/document'; +import Model from '../../src/model/model'; import ModelDocumentFragment from '../../src/model/documentfragment'; import ViewDocument from '../../src/view/document'; @@ -52,7 +52,7 @@ testUtils.createSinonSandbox(); /* global document */ -describe.skip( 'enableEngineDebug', () => { +describe( 'enableEngineDebug', () => { afterEach( () => { disableEngineDebug(); } ); @@ -72,13 +72,13 @@ describe.skip( 'enableEngineDebug', () => { } ); } ); -describe.skip( 'disableEngineDebug', () => { +describe( 'disableEngineDebug', () => { it( 'restores modified stubs', () => { expect( ModelPosition.prototype.log ).to.equal( undefined, 'Initial value (model/position)' ); expect( ModelElement.prototype.printTree ).to.equal( undefined, 'Initial value (model/element)' ); expect( Delta.prototype.log ).to.equal( undefined, 'Initial value (model/delta/delta)' ); expect( ViewElement.prototype.printTree ).to.equal( undefined, 'Initial value (view/element)' ); - expect( ModelDocument.prototype.createReplayer ).to.equal( undefined, 'Initial value (model/document)' ); + expect( Model.prototype.createReplayer ).to.equal( undefined, 'Initial value (model/document)' ); expect( Editor.prototype.logDocuments ).to.equal( undefined, 'Initial value (core~editor/editor)' ); enableEngineDebug(); @@ -87,7 +87,7 @@ describe.skip( 'disableEngineDebug', () => { expect( ModelElement.prototype.printTree ).to.be.a( 'function', 'After enabling engine debug (model/element)' ); expect( Delta.prototype.log ).to.be.a( 'function', 'After enabling engine debug (model/delta/delta)' ); expect( ViewElement.prototype.printTree ).to.be.a( 'function', 'After enabling engine debug (view/element)' ); - expect( ModelDocument.prototype.createReplayer ).to.be.a( 'function', 'After enabling engine debug (model/document)' ); + expect( Model.prototype.createReplayer ).to.be.a( 'function', 'After enabling engine debug (model/document)' ); expect( Editor.prototype.logDocuments ).to.be.a( 'function', 'After enabling engine debug (core~editor/editor)' ); disableEngineDebug(); @@ -96,19 +96,19 @@ describe.skip( 'disableEngineDebug', () => { expect( ModelElement.prototype.printTree ).to.equal( undefined, 'After disabling engine debug (model/element)' ); expect( Delta.prototype.log ).to.equal( undefined, 'After disabling engine debug (model/delta/delta)' ); expect( ViewElement.prototype.printTree ).to.equal( undefined, 'After disabling engine debug (view/element)' ); - expect( ModelDocument.prototype.createReplayer ).to.equal( undefined, 'After disabling engine debug (model/document)' ); + expect( Model.prototype.createReplayer ).to.equal( undefined, 'After disabling engine debug (model/document)' ); expect( Editor.prototype.logDocuments ).to.equal( undefined, 'After disabling engine debug (core~editor/editor)' ); } ); } ); -describe.skip( 'debug tools', () => { +describe( 'debug tools', () => { let DebugPlugin, log, error; class TestEditor extends StandardEditor { constructor( ...args ) { super( ...args ); - this.document.createRoot( 'main' ); + this.model.document.createRoot( 'main' ); this.editing.createRoot( this.element, 'main' ); } } @@ -128,10 +128,11 @@ describe.skip( 'debug tools', () => { } ); describe( 'should provide logging tools', () => { - let modelDoc, modelRoot, modelElement, modelDocFrag; + let model, modelDoc, modelRoot, modelElement, modelDocFrag; beforeEach( () => { - modelDoc = new ModelDocument(); + model = new Model(); + modelDoc = model.document; modelRoot = modelDoc.createRoot(); modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) ); modelDocFrag = new ModelDocumentFragment( [ new ModelText( 'bar' ) ] ); @@ -627,7 +628,7 @@ describe.skip( 'debug tools', () => { const op = new InsertOperation( ModelPosition.createAt( modelRoot, 0 ), [ new ModelText( 'foo' ) ], 0 ); delta.addOperation( op ); - modelDoc.applyOperation( op ); + model.applyOperation( op ); expect( log.calledWithExactly( 'Applying InsertOperation( 0 ): #foo -> main [ 0 ]' ) ).to.be.true; } ); @@ -635,7 +636,8 @@ describe.skip( 'debug tools', () => { describe( 'should provide tree printing tools', () => { it( 'for model', () => { - const modelDoc = new ModelDocument(); + const model = new Model(); + const modelDoc = model.document; const modelRoot = modelDoc.createRoot(); modelRoot.appendChildren( [ @@ -795,26 +797,27 @@ describe.skip( 'debug tools', () => { } ); it( 'should store model and view state after each applied operation', () => { - const model = editor.document; - const modelRoot = model.getRoot(); - const view = editor.editing.view; + const model = editor.model; + const modelDoc = model.document; + const modelRoot = modelDoc.getRoot(); + const viewDoc = editor.editing.view; const insert = new InsertOperation( ModelPosition.createAt( modelRoot, 0 ), new ModelText( 'foobar' ), 0 ); model.applyOperation( wrapInDelta( insert ) ); - const graveyard = model.graveyard; + const graveyard = modelDoc.graveyard; const remove = new RemoveOperation( ModelPosition.createAt( modelRoot, 1 ), 2, ModelPosition.createAt( graveyard, 0 ), 1 ); model.applyOperation( wrapInDelta( remove ) ); log.reset(); - model.log( 0 ); + modelDoc.log( 0 ); expectLog( '<$graveyard>' + '\n
' ); - model.log( 1 ); + modelDoc.log( 1 ); expectLog( '<$graveyard>' + '\n
' + @@ -822,7 +825,7 @@ describe.skip( 'debug tools', () => { '\n
' ); - model.log( 2 ); + modelDoc.log( 2 ); expectLog( '<$graveyard>' + '\n\too' + @@ -832,7 +835,7 @@ describe.skip( 'debug tools', () => { '\n' ); - model.log(); + modelDoc.log(); expectLog( '<$graveyard>' + '\n\too' + @@ -842,74 +845,76 @@ describe.skip( 'debug tools', () => { '\n' ); - view.log( 0 ); + viewDoc.log( 0 ); expectLog( '
' ); - view.log( 1 ); + viewDoc.log( 1 ); expectLog( '
' + '\n\tfoobar' + '\n
' ); - view.log( 2 ); + viewDoc.log( 2 ); expectLog( '
' + '\n\tfbar' + '\n
' ); - sinon.spy( model, 'log' ); - sinon.spy( view, 'log' ); + sinon.spy( modelDoc, 'log' ); + sinon.spy( viewDoc, 'log' ); editor.logModel( 1 ); - expect( model.log.calledWithExactly( 1 ) ).to.be.true; + expect( modelDoc.log.calledWithExactly( 1 ), 1 ).to.be.true; editor.logView( 2 ); - expect( view.log.calledWithExactly( 2 ) ).to.be.true; + expect( viewDoc.log.calledWithExactly( 2 ), 2 ).to.be.true; - model.log.reset(); - view.log.reset(); + modelDoc.log.reset(); + viewDoc.log.reset(); editor.logModel(); - expect( model.log.calledWithExactly( 2 ) ).to.be.true; + expect( modelDoc.log.calledWithExactly( 2 ), 3 ).to.be.true; - model.log.reset(); - view.log.reset(); + modelDoc.log.reset(); + viewDoc.log.reset(); editor.logDocuments(); - expect( model.log.calledWithExactly( 2 ) ).to.be.true; - expect( view.log.calledWithExactly( 2 ) ).to.be.true; + expect( modelDoc.log.calledWithExactly( 2 ), 4 ).to.be.true; + expect( viewDoc.log.calledWithExactly( 2 ), 5 ).to.be.true; - model.log.reset(); - view.log.reset(); + modelDoc.log.reset(); + viewDoc.log.reset(); editor.logDocuments( 1 ); - expect( model.log.calledWithExactly( 1 ) ).to.be.true; - expect( view.log.calledWithExactly( 1 ) ).to.be.true; + expect( modelDoc.log.calledWithExactly( 1 ), 6 ).to.be.true; + expect( viewDoc.log.calledWithExactly( 1 ), 7 ).to.be.true; } ); it( 'should remove old states', () => { - const model = editor.document; - const modelRoot = model.getRoot(); + const model = editor.model; + const modelDoc = model.document; + const modelRoot = model.document.getRoot(); for ( let i = 0; i < 25; i++ ) { - const insert = new InsertOperation( ModelPosition.createAt( modelRoot, 0 ), new ModelText( 'foobar' ), model.version ); + const insert = new InsertOperation( ModelPosition.createAt( modelRoot, 0 ), new ModelText( 'foobar' ), modelDoc.version ); model.applyOperation( wrapInDelta( insert ) ); } - model.log( 0 ); + modelDoc.log( 0 ); expectLog( 'Tree log unavailable for given version: 0' ); } ); } ); describe( 'should provide methods for delta replayer', () => { it( 'getAppliedDeltas()', () => { - const modelDoc = new ModelDocument(); + const model = new Model(); + const modelDoc = model.document; - expect( modelDoc.getAppliedDeltas() ).to.equal( '' ); + expect( model.getAppliedDeltas() ).to.equal( '' ); const otherRoot = modelDoc.createRoot( '$root', 'otherRoot' ); const firstEle = new ModelElement( 'paragraph' ); @@ -925,16 +930,17 @@ describe.skip( 'debug tools', () => { delta.addOperation( move ); delta.addOperation( remove ); - modelDoc.applyOperation( move ); - modelDoc.applyOperation( remove ); + model.applyOperation( move ); + model.applyOperation( remove ); - const stringifiedDeltas = modelDoc.getAppliedDeltas(); + const stringifiedDeltas = model.getAppliedDeltas(); expect( stringifiedDeltas ).to.equal( JSON.stringify( delta.toJSON() ) ); } ); it( 'createReplayer()', () => { - const modelDoc = new ModelDocument(); + const model = new Model(); + const modelDoc = model.document; const otherRoot = modelDoc.createRoot( '$root', 'otherRoot' ); const firstEle = new ModelElement( 'paragraph' ); @@ -952,17 +958,18 @@ describe.skip( 'debug tools', () => { const stringifiedDeltas = JSON.stringify( delta.toJSON() ); - const deltaReplayer = modelDoc.createReplayer( stringifiedDeltas ); + const deltaReplayer = model.createReplayer( stringifiedDeltas ); expect( deltaReplayer.getDeltasToReplay() ).to.deep.equal( [ JSON.parse( stringifiedDeltas ) ] ); } ); } ); describe( 'should provide debug tools for delta transformation', () => { - let document, root, otherRoot; + let model, document, root, otherRoot; beforeEach( () => { - document = new ModelDocument(); + model = new Model(); + document = model.document; root = document.createRoot(); otherRoot = document.createRoot( 'other', 'other' ); } ); From 7381a099665b0bfdc078ee9f467bdc187e3263c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 14 Dec 2017 11:50:49 +0100 Subject: [PATCH 159/724] Other: Merge configuration defined converters into one file. --- src/conversion/attributeelementconverters.js | 39 -- .../configurationdefinedconverters.js | 140 ++++++ src/conversion/containerelementconverters.js | 26 - src/conversion/utils.js | 54 -- src/view/matcher.js | 10 +- .../conversion/attributeelementconverters.js | 302 ----------- .../configurationdefinedconverters.js | 472 ++++++++++++++++++ .../conversion/containerelementconverters.js | 279 ----------- 8 files changed, 617 insertions(+), 705 deletions(-) delete mode 100644 src/conversion/attributeelementconverters.js create mode 100644 src/conversion/configurationdefinedconverters.js delete mode 100644 src/conversion/containerelementconverters.js delete mode 100644 src/conversion/utils.js delete mode 100644 tests/conversion/attributeelementconverters.js create mode 100644 tests/conversion/configurationdefinedconverters.js delete mode 100644 tests/conversion/containerelementconverters.js diff --git a/src/conversion/attributeelementconverters.js b/src/conversion/attributeelementconverters.js deleted file mode 100644 index ec6555169..000000000 --- a/src/conversion/attributeelementconverters.js +++ /dev/null @@ -1,39 +0,0 @@ -/** - * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -import AttributeElement from '../view/attributeelement'; -import buildModelConverter from './buildmodelconverter'; -import { defineConverter, parseDefinition } from './utils'; - -/** - * @param {String} attributeName - * @param {} definition Converter definition - * @param dispatchers - */ -export function attributeElementToViewConverter( attributeName, definition, dispatchers ) { - const { model: attributeValue, viewDefinition } = parseDefinition( definition ); - - buildModelConverter() - .for( ...dispatchers ) - .fromAttribute( attributeName ) - .toElement( value => { - if ( value != attributeValue ) { - return; - } - - return AttributeElement.fromViewDefinition( viewDefinition ); - } ); -} - -export function viewToAttributeElementConverter( attributeName, definition, dispatchers ) { - const { model: attributeValue, viewDefinitions } = parseDefinition( definition ); - - const converter = defineConverter( dispatchers, viewDefinitions ); - - converter.toAttribute( () => ( { - key: attributeName, - value: attributeValue - } ) ); -} diff --git a/src/conversion/configurationdefinedconverters.js b/src/conversion/configurationdefinedconverters.js new file mode 100644 index 000000000..26286d842 --- /dev/null +++ b/src/conversion/configurationdefinedconverters.js @@ -0,0 +1,140 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/conversion/configurationdefinedconverters + */ + +import AttributeElement from '../view/attributeelement'; +import ViewContainerElement from '../view/containerelement'; + +import buildModelConverter from './buildmodelconverter'; + +export function containerElementToView( definition, dispatchers ) { + const { model: modelElement, viewDefinition } = parseConverterDefinition( definition ); + + buildModelConverter() + .for( ...dispatchers ) + .fromElement( modelElement ) + .toElement( () => ViewContainerElement.fromViewDefinition( viewDefinition ) ); +} + +export function viewToContainerElement( definition, dispatchers ) { + const { model: modelElement, viewDefinitions } = parseConverterDefinition( definition ); + + const converter = defineViewConverter( dispatchers, viewDefinitions ); + + converter.toElement( modelElement ); +} + +/** + * Helper for creating model to view converter from model's attribute. + * + * @param {String} attributeName + * @param {} definition Converter definition + * @param dispatchers + */ +export function attributeElementToViewConverter( attributeName, definition, dispatchers ) { + const { model: attributeValue, viewDefinition } = parseConverterDefinition( definition ); + + buildModelConverter() + .for( ...dispatchers ) + .fromAttribute( attributeName ) + .toElement( value => { + if ( value != attributeValue ) { + return; + } + + return AttributeElement.fromViewDefinition( viewDefinition ); + } ); +} + +/** + * + * @param attributeName + * @param definition + * @param dispatchers + */ +export function viewToAttributeElementConverter( attributeName, definition, dispatchers ) { + const { model: attributeValue, viewDefinitions } = parseConverterDefinition( definition ); + + const converter = defineViewConverter( dispatchers, viewDefinitions ); + + converter.toAttribute( () => ( { + key: attributeName, + value: attributeValue + } ) ); +} + +import buildViewConverter from './buildviewconverter'; + +// Prepares a {@link module:engine/conversion/utils~ConverterDefinition definition object} for building converters. +// +// @param {module:engine/conversion/utils~ConverterDefinition} definition An object that defines view to model and model to view conversion. +// @returns {Object} +function parseConverterDefinition( definition ) { + const model = definition.model; + const view = definition.view; + + const viewDefinition = typeof view == 'string' ? { name: view } : view; + + const viewDefinitions = definition.acceptsAlso ? definition.acceptsAlso : []; + + viewDefinitions.push( viewDefinition ); + + return { model, viewDefinition, viewDefinitions }; +} + +// Helper method for preparing a view converter from passed view definitions. +// +// @param {Array.} dispatchers +// @param {Array.} viewDefinitions +// @returns {module:engine/conversion/buildviewconverter~ViewConverterBuilder} +function defineViewConverter( dispatchers, viewDefinitions ) { + const converter = buildViewConverter().for( ...dispatchers ); + + for ( const viewDefinition of viewDefinitions ) { + converter.from( definitionToPattern( viewDefinition ) ); + + if ( viewDefinition.priority ) { + converter.withPriority( viewDefinition.priority ); + } + } + + return converter; +} + +// Converts viewDefinition to a matcher pattern. +// @param {module:engine/view/viewelementdefinition~ViewElementDefinition} viewDefinition +// @returns {module:engine/view/matcher~Pattern} +function definitionToPattern( viewDefinition ) { + const name = viewDefinition.name; + const classes = viewDefinition.classes; + const styles = viewDefinition.styles; + const attributes = viewDefinition.attributes; + + const pattern = { name }; + + if ( classes ) { + pattern.class = classes; + } + + if ( styles ) { + pattern.style = styles; + } + + if ( attributes ) { + pattern.attribute = attributes; + } + + return pattern; +} + +/** + * @typedef {Object} ConvertedDefinition + * @property {String} model + * @property {String|module:engine/view/viewelementdefinition~ViewElementDefinition} view + * @property {Array.} acceptAlso + */ diff --git a/src/conversion/containerelementconverters.js b/src/conversion/containerelementconverters.js deleted file mode 100644 index 16490b942..000000000 --- a/src/conversion/containerelementconverters.js +++ /dev/null @@ -1,26 +0,0 @@ -/** - * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -import buildModelConverter from './buildmodelconverter'; -import ViewContainerElement from '../view/containerelement'; - -import { defineConverter, parseDefinition } from './utils'; - -export function containerElementToView( definition, dispatchers ) { - const { model: modelElement, viewDefinition } = parseDefinition( definition ); - - buildModelConverter() - .for( ...dispatchers ) - .fromElement( modelElement ) - .toElement( () => ViewContainerElement.fromViewDefinition( viewDefinition ) ); -} - -export function viewToContainerElement( definition, dispatchers ) { - const { model: modelElement, viewDefinitions } = parseDefinition( definition ); - - const converter = defineConverter( dispatchers, viewDefinitions ); - - converter.toElement( modelElement ); -} diff --git a/src/conversion/utils.js b/src/conversion/utils.js deleted file mode 100644 index 3b093ae8e..000000000 --- a/src/conversion/utils.js +++ /dev/null @@ -1,54 +0,0 @@ -/** - * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -import buildViewConverter from './buildviewconverter'; - -export function parseDefinition( definition ) { - const model = definition.model; - const view = definition.view; - const viewDefinition = typeof view == 'string' ? { name: view } : view; - - const viewDefinitions = definition.acceptsAlso ? definition.acceptsAlso : []; - - viewDefinitions.push( viewDefinition ); - - return { model, viewDefinition, viewDefinitions }; -} - -export function definitionToPattern( viewDefinition ) { - const name = viewDefinition.name; - const classes = viewDefinition.classes; - const styles = viewDefinition.styles; - const attributes = viewDefinition.attributes; - - const pattern = { name }; - - if ( classes ) { - pattern.class = classes; - } - - if ( styles ) { - pattern.style = styles; - } - - if ( attributes ) { - pattern.attribute = attributes; - } - - return pattern; -} - -export function defineConverter( dispatchers, viewDefinitions ) { - const converter = buildViewConverter().for( ...dispatchers ); - - for ( const viewDefinition of viewDefinitions ) { - converter.from( definitionToPattern( viewDefinition ) ); - - if ( viewDefinition.priority ) { - converter.withPriority( viewDefinition.priority ); - } - } - return converter; -} diff --git a/src/view/matcher.js b/src/view/matcher.js index 22a76824e..2773f93e8 100644 --- a/src/view/matcher.js +++ b/src/view/matcher.js @@ -15,8 +15,8 @@ export default class Matcher { /** * Creates new instance of Matcher. * - * @param {String|RegExp|Object} [pattern] Match patterns. See {@link module:engine/view/matcher~Matcher#add add method} for - * more information. + * @param {String|RegExp|module:engine/view/matcher~Pattern} [pattern] Match patterns. + * See {@link module:engine/view/matcher~Matcher#add add method} for more information. */ constructor( ...pattern ) { this._patterns = []; @@ -88,8 +88,8 @@ export default class Matcher { * * matcher.add( 'div', { class: 'foobar' } ); * - * @param {Object|String|RegExp|Function} pattern Object describing pattern details. If string or regular expression - * is provided it will be used to match element's name. Pattern can be also provided in a form + * @param {module:engine/view/matcher~Pattern|String|RegExp|Function} pattern Object describing pattern details. + * If string or regular expression is provided it will be used to match element's name. Pattern can be also provided in a form * of a function - then this function will be called with each {@link module:engine/view/element~Element element} as a parameter. * Function's return value will be stored under `match` key of the object returned from * {@link module:engine/view/matcher~Matcher#match match} or {@link module:engine/view/matcher~Matcher#matchAll matchAll} methods. @@ -380,7 +380,7 @@ function matchStyles( patterns, element ) { } /** - * @typedef {Object} @module engine/view/matcher~Pattern + * @typedef {Object} Pattern * * @param {String|RegExp} [name] Name or regular expression to match element's name. * @param {Object} [attribute] Object with key-value pairs representing attributes to match. Each object key diff --git a/tests/conversion/attributeelementconverters.js b/tests/conversion/attributeelementconverters.js deleted file mode 100644 index 44eaaf4b4..000000000 --- a/tests/conversion/attributeelementconverters.js +++ /dev/null @@ -1,302 +0,0 @@ -/** - * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -import ModelDocument from '../../src/model/document'; -import ModelElement from '../../src/model/element'; -import ModelText from '../../src/model/text'; -import ModelRange from '../../src/model/range'; - -import ViewDocument from '../../src/view/document'; -import ViewElement from '../../src/view/element'; -import ViewAttributeElement from '../../src/view/attributeelement'; -import ViewText from '../../src/view/text'; - -import Mapper from '../../src/conversion/mapper'; -import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; - -import { - insertText, - remove -} from '../../src/conversion/model-to-view-converters'; - -import { attributeElementToViewConverter, viewToAttributeElementConverter } from '../../src/conversion/attributeelementconverters'; -import { convertText } from '../../src/conversion/view-to-model-converters'; -import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; -import ModelSchema from '../../src/model/schema'; -import ModelWalker from '../../src/model/treewalker'; -import ModelTextProxy from '../../src/model/textproxy'; - -function viewAttributesToString( item ) { - let result = ''; - - for ( const key of item.getAttributeKeys() ) { - const value = item.getAttribute( key ); - - if ( value ) { - result += ' ' + key + '="' + value + '"'; - } - } - - return result; -} - -function modelToString( item ) { - let result = ''; - - if ( item instanceof ModelTextProxy ) { - const attributes = modelAttributesToString( item ); - - result = attributes ? '<$text' + attributes + '>' + item.data + '' : item.data; - } else { - const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } ); - - for ( const value of walker ) { - result += modelToString( value.item ); - } - - if ( item instanceof ModelElement ) { - const attributes = modelAttributesToString( item ); - - result = '<' + item.name + attributes + '>' + result + ''; - } - } - - return result; -} - -function modelAttributesToString( item ) { - let result = ''; - - for ( const attr of item.getAttributes() ) { - result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"'; - } - - return result; -} - -function viewToString( item ) { - let result = ''; - - if ( item instanceof ViewText ) { - result = item.data; - } else { - // ViewElement or ViewDocumentFragment. - for ( const child of item.getChildren() ) { - result += viewToString( child ); - } - - if ( item instanceof ViewElement ) { - result = '<' + item.name + viewAttributesToString( item ) + '>' + result + ''; - } - } - - return result; -} - -describe( 'Attribute converter', () => { - let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, batch; - - beforeEach( () => { - modelDoc = new ModelDocument(); - modelRoot = modelDoc.createRoot( 'root', 'root' ); - - batch = modelDoc.batch(); - - viewDoc = new ViewDocument(); - viewRoot = viewDoc.createRoot( 'div' ); - viewSelection = viewDoc.selection; - - mapper = new Mapper(); - mapper.bindElements( modelRoot, viewRoot ); - - dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); - - dispatcher.on( 'insert:$text', insertText() ); - dispatcher.on( 'remove', remove() ); - } ); - - afterEach( () => { - viewDoc.destroy(); - } ); - - function testConversion( definition, expectedConversion ) { - attributeElementToViewConverter( 'foo', definition, [ dispatcher ] ); - - const modelElement = new ModelText( 'foo', { foo: 'bar' } ); - modelRoot.appendChildren( modelElement ); - - dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); - - expect( viewToString( viewRoot ) ).to.equal( expectedConversion ); - - batch.removeAttribute( 'bold', modelRoot ); - - dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'foo', 'bar', null ); - - expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - } - - describe( 'model attribute to view element conversion', () => { - it( 'using passed view element name', () => { - testConversion( { model: 'bar', view: 'strong' }, '
foo
' ); - } ); - - it( 'using passed view element object', () => { - testConversion( { model: 'bar', view: { name: 'strong' } }, '
foo
' ); - } ); - - it( 'using passed view element object with styles object', () => { - testConversion( { - model: 'bar', - view: { name: 'span', styles: { 'font-weight': 'bold' } } - }, '
foo
' ); - } ); - - it( 'using passed view element object with class string', () => { - testConversion( { model: 'bar', view: { name: 'span', classes: 'foo' } }, '
foo
' ); - } ); - - it( 'using passed view element object with class array', () => { - testConversion( { - model: 'bar', - view: { name: 'span', classes: [ 'foo', 'foo-bar' ] } - }, '
foo
' ); - } ); - - it( 'using passed view element object with attributes', () => { - testConversion( { - model: 'bar', - view: { name: 'span', attributes: { 'data-foo': 'bar' } } - }, '
foo
' ); - } ); - - it( 'should do nothing for undefined value', () => { - attributeElementToViewConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); - - const modelElement = new ModelText( 'foo', { foo: 'baz' } ); - modelRoot.appendChildren( modelElement ); - - dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); - - expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); - } ); - } ); - describe( 'view element to model attribute conversion', () => { - let dispatcher, schema, additionalData, batch; - - const modelDocument = new ModelDocument(); - - beforeEach( () => { - batch = modelDocument.batch(); - - // `additionalData` parameter for `.convert` calls. - additionalData = { context: [ '$root' ] }; - - schema = new ModelSchema(); - - schema.registerItem( 'div', '$block' ); - - schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } ); - schema.allow( { name: '$text', inside: '$root' } ); - - dispatcher = new ViewConversionDispatcher( { schema } ); - dispatcher.on( 'text', convertText() ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { - model: 'bar', - view: { name: 'span', styles: { 'font-weight': 'bold' } } - }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { - model: 'bar', - view: { name: 'span', attributes: { 'data-foo': 'bar' } } - }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { - model: 'bar', - view: 'strong', - acceptsAlso: [ - { name: 'span', classes: [ 'foo', 'bar' ] }, - { name: 'span', attributes: { 'data-foo': 'bar' } } - ] - }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToAttributeElementConverter( 'foo', { model: 'baz', view: 'strong' }, [ dispatcher ] ); - viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); - } ); - } ); -} ); diff --git a/tests/conversion/configurationdefinedconverters.js b/tests/conversion/configurationdefinedconverters.js new file mode 100644 index 000000000..5f30c3661 --- /dev/null +++ b/tests/conversion/configurationdefinedconverters.js @@ -0,0 +1,472 @@ +/** + * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import ModelDocument from '../../src/model/document'; +import ModelElement from '../../src/model/element'; +import ModelText from '../../src/model/text'; +import ModelRange from '../../src/model/range'; + +import ViewDocument from '../../src/view/document'; +import ViewElement from '../../src/view/element'; +import ViewAttributeElement from '../../src/view/attributeelement'; +import ViewText from '../../src/view/text'; + +import Mapper from '../../src/conversion/mapper'; +import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; + +import { insertText, remove } from '../../src/conversion/model-to-view-converters'; +import { convertText } from '../../src/conversion/view-to-model-converters'; + +import { + attributeElementToViewConverter, + viewToAttributeElementConverter, + containerElementToView, + viewToContainerElement +} from '../../src/conversion/configurationdefinedconverters'; + +import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; +import ModelSchema from '../../src/model/schema'; +import ModelWalker from '../../src/model/treewalker'; +import ModelTextProxy from '../../src/model/textproxy'; + +function viewAttributesToString( item ) { + let result = ''; + + for ( const key of item.getAttributeKeys() ) { + const value = item.getAttribute( key ); + + if ( value ) { + result += ' ' + key + '="' + value + '"'; + } + } + + return result; +} + +function modelToString( item ) { + let result = ''; + + if ( item instanceof ModelTextProxy ) { + const attributes = modelAttributesToString( item ); + + result = attributes ? '<$text' + attributes + '>' + item.data + '' : item.data; + } else { + const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } ); + + for ( const value of walker ) { + result += modelToString( value.item ); + } + + if ( item instanceof ModelElement ) { + const attributes = modelAttributesToString( item ); + + result = '<' + item.name + attributes + '>' + result + ''; + } + } + + return result; +} + +function modelAttributesToString( item ) { + let result = ''; + + for ( const attr of item.getAttributes() ) { + result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"'; + } + + return result; +} + +function viewToString( item ) { + let result = ''; + + if ( item instanceof ViewText ) { + result = item.data; + } else { + // ViewElement or ViewDocumentFragment. + for ( const child of item.getChildren() ) { + result += viewToString( child ); + } + + if ( item instanceof ViewElement ) { + result = '<' + item.name + viewAttributesToString( item ) + '>' + result + ''; + } + } + + return result; +} + +describe( 'Configuration defined converters', () => { + let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection, batch; + + beforeEach( () => { + modelDoc = new ModelDocument(); + modelRoot = modelDoc.createRoot( 'root', 'root' ); + + batch = modelDoc.batch(); + + viewDoc = new ViewDocument(); + viewRoot = viewDoc.createRoot( 'div' ); + viewSelection = viewDoc.selection; + + mapper = new Mapper(); + mapper.bindElements( modelRoot, viewRoot ); + + dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); + + dispatcher.on( 'insert:$text', insertText() ); + dispatcher.on( 'remove', remove() ); + } ); + + afterEach( () => { + viewDoc.destroy(); + } ); + + describe( 'Attribute converter', () => { + function testConversion( definition, expectedConversion ) { + attributeElementToViewConverter( 'foo', definition, [ dispatcher ] ); + + const modelElement = new ModelText( 'foo', { foo: 'bar' } ); + modelRoot.appendChildren( modelElement ); + + dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); + + expect( viewToString( viewRoot ) ).to.equal( expectedConversion ); + + batch.removeAttribute( 'bold', modelRoot ); + + dispatcher.convertAttribute( 'removeAttribute', ModelRange.createIn( modelRoot ), 'foo', 'bar', null ); + + expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); + } + + describe( 'model to view conversion', () => { + it( 'using passed view element name', () => { + testConversion( { model: 'bar', view: 'strong' }, '
foo
' ); + } ); + + it( 'using passed view element object', () => { + testConversion( { model: 'bar', view: { name: 'strong' } }, '
foo
' ); + } ); + + it( 'using passed view element object with styles object', () => { + testConversion( { + model: 'bar', + view: { name: 'span', styles: { 'font-weight': 'bold' } } + }, '
foo
' ); + } ); + + it( 'using passed view element object with class string', () => { + testConversion( { model: 'bar', view: { name: 'span', classes: 'foo' } }, '
foo
' ); + } ); + + it( 'using passed view element object with class array', () => { + testConversion( { + model: 'bar', + view: { name: 'span', classes: [ 'foo', 'foo-bar' ] } + }, '
foo
' ); + } ); + + it( 'using passed view element object with attributes', () => { + testConversion( { + model: 'bar', + view: { name: 'span', attributes: { 'data-foo': 'bar' } } + }, '
foo
' ); + } ); + + it( 'should do nothing for undefined value', () => { + attributeElementToViewConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); + + const modelElement = new ModelText( 'foo', { foo: 'baz' } ); + modelRoot.appendChildren( modelElement ); + + dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); + + expect( viewToString( viewRoot ) ).to.equal( '
foo
' ); + } ); + } ); + + describe( 'view to model conversion', () => { + let dispatcher, schema, additionalData, batch; + + const modelDocument = new ModelDocument(); + + beforeEach( () => { + batch = modelDocument.batch(); + + // `additionalData` parameter for `.convert` calls. + additionalData = { context: [ '$root' ] }; + + schema = new ModelSchema(); + + schema.registerItem( 'div', '$block' ); + + schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } ); + schema.allow( { name: '$text', inside: '$root' } ); + + dispatcher = new ViewConversionDispatcher( { schema } ); + dispatcher.on( 'text', convertText() ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { model: 'bar', view: 'strong' }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { + model: 'bar', + view: { name: 'span', classes: [ 'foo', 'bar' ] } + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { + model: 'bar', + view: { name: 'span', styles: { 'font-weight': 'bold' } } + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { + model: 'bar', + view: { name: 'span', attributes: { 'data-foo': 'bar' } } + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { + model: 'bar', + view: 'strong', + acceptsAlso: [ + { name: 'span', classes: [ 'foo', 'bar' ] }, + { name: 'span', attributes: { 'data-foo': 'bar' } } + ] + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToAttributeElementConverter( 'foo', { model: 'baz', view: 'strong' }, [ dispatcher ] ); + viewToAttributeElementConverter( 'foo', { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewAttributeElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( '<$text foo="bar">foo' ); + } ); + } ); + } ); + + describe( 'Element converter', () => { + function testModelConversion( definition, expectedResult ) { + containerElementToView( definition, [ dispatcher ] ); + + const modelElement = new ModelElement( 'foo', null, new ModelText( 'bar' ) ); + modelRoot.appendChildren( modelElement ); + + dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); + + expect( viewToString( viewRoot ) ).to.equal( '
' + expectedResult + '
' ); + } + + describe( 'model to view conversion', () => { + it( 'using passed view element name', () => { + testModelConversion( { model: 'foo', view: 'strong' }, 'bar' ); + } ); + + it( 'using passed view element object', () => { + testModelConversion( { model: 'foo', view: { name: 'strong' } }, 'bar' ); + } ); + + it( 'using passed view element object with styles object', () => { + testModelConversion( { + model: 'foo', + view: { name: 'span', styles: { 'font-weight': 'bold' } } + }, 'bar' ); + } ); + + it( 'using passed view element object with class string', () => { + testModelConversion( { model: 'foo', view: { name: 'span', classes: 'foo' } }, 'bar' ); + } ); + + it( 'using passed view element object with class array', () => { + testModelConversion( { + model: 'foo', + view: { name: 'span', classes: [ 'foo', 'foo-bar' ] } + }, 'bar' ); + } ); + + it( 'using passed view element object with attributes', () => { + testModelConversion( { + model: 'foo', + view: { name: 'span', attributes: { 'data-foo': 'bar' } } + }, 'bar' ); + } ); + } ); + + describe( 'view to model conversion', () => { + let dispatcher, schema, additionalData, batch; + + const modelDocument = new ModelDocument(); + + beforeEach( () => { + batch = modelDocument.batch(); + + // `additionalData` parameter for `.convert` calls. + additionalData = { context: [ '$root' ] }; + + schema = new ModelSchema(); + + schema.registerItem( 'div', '$block' ); + schema.registerItem( 'bar', '$block' ); + schema.registerItem( 'baz', '$block' ); + + schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } ); + schema.allow( { name: '$text', inside: '$inline' } ); + + dispatcher = new ViewConversionDispatcher( { schema } ); + dispatcher.on( 'text', convertText() ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'bar', view: 'strong' }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { + model: 'bar', + view: 'strong', + acceptsAlso: [ + { name: 'span', classes: [ 'foo', 'bar' ] }, + { name: 'span', attributes: { 'data-foo': 'bar' } } + ] + }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + + it( 'should convert from view element to model attribute', () => { + viewToContainerElement( { model: 'baz', view: 'strong' }, [ dispatcher ] ); + viewToContainerElement( { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); + + const conversionResult = dispatcher.convert( + new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData + ); + + expect( modelToString( conversionResult ) ).to.equal( 'foo' ); + } ); + } ); + } ); +} ); diff --git a/tests/conversion/containerelementconverters.js b/tests/conversion/containerelementconverters.js deleted file mode 100644 index 83a69b65b..000000000 --- a/tests/conversion/containerelementconverters.js +++ /dev/null @@ -1,279 +0,0 @@ -/** - * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -import ModelDocument from '../../src/model/document'; -import ModelElement from '../../src/model/element'; -import ModelText from '../../src/model/text'; -import ModelRange from '../../src/model/range'; - -import ViewDocument from '../../src/view/document'; -import ViewElement from '../../src/view/element'; -import ViewText from '../../src/view/text'; - -import Mapper from '../../src/conversion/mapper'; -import ModelConversionDispatcher from '../../src/conversion/modelconversiondispatcher'; - -import { - insertText, - remove -} from '../../src/conversion/model-to-view-converters'; - -import { containerElementToView, viewToContainerElement } from '../../src/conversion/containerelementconverters'; -import { convertText } from '../../src/conversion/view-to-model-converters'; -import ViewConversionDispatcher from '../../src/conversion/viewconversiondispatcher'; -import ModelSchema from '../../src/model/schema'; -import ModelWalker from '../../src/model/treewalker'; -import ModelTextProxy from '../../src/model/textproxy'; - -function viewAttributesToString( item ) { - let result = ''; - - for ( const key of item.getAttributeKeys() ) { - const value = item.getAttribute( key ); - - if ( value ) { - result += ' ' + key + '="' + value + '"'; - } - } - - return result; -} - -function modelToString( item ) { - let result = ''; - - if ( item instanceof ModelTextProxy ) { - const attributes = modelAttributesToString( item ); - - result = attributes ? '<$text' + attributes + '>' + item.data + '' : item.data; - } else { - const walker = new ModelWalker( { boundaries: ModelRange.createIn( item ), shallow: true } ); - - for ( const value of walker ) { - result += modelToString( value.item ); - } - - if ( item instanceof ModelElement ) { - const attributes = modelAttributesToString( item ); - - result = '<' + item.name + attributes + '>' + result + ''; - } - } - - return result; -} - -function modelAttributesToString( item ) { - let result = ''; - - for ( const attr of item.getAttributes() ) { - result += ' ' + attr[ 0 ] + '="' + attr[ 1 ] + '"'; - } - - return result; -} - -function viewToString( item ) { - let result = ''; - - if ( item instanceof ViewText ) { - result = item.data; - } else { - // ViewElement or ViewDocumentFragment. - for ( const child of item.getChildren() ) { - result += viewToString( child ); - } - - if ( item instanceof ViewElement ) { - result = '<' + item.name + viewAttributesToString( item ) + '>' + result + ''; - } - } - - return result; -} - -describe( 'Element converter', () => { - let dispatcher, mapper, modelDoc, modelRoot, viewDoc, viewRoot, viewSelection; - - beforeEach( () => { - modelDoc = new ModelDocument(); - modelRoot = modelDoc.createRoot( 'root', 'root' ); - - viewDoc = new ViewDocument(); - viewRoot = viewDoc.createRoot( 'div' ); - viewSelection = viewDoc.selection; - - mapper = new Mapper(); - mapper.bindElements( modelRoot, viewRoot ); - - dispatcher = new ModelConversionDispatcher( modelDoc, { mapper, viewSelection } ); - - dispatcher.on( 'insert:$text', insertText() ); - dispatcher.on( 'remove', remove() ); - } ); - - afterEach( () => { - viewDoc.destroy(); - } ); - - function testModelConversion( definition, expectedResult ) { - containerElementToView( definition, [ dispatcher ] ); - - const modelElement = new ModelElement( 'foo', null, new ModelText( 'bar' ) ); - modelRoot.appendChildren( modelElement ); - - dispatcher.convertInsertion( ModelRange.createIn( modelRoot ) ); - - expect( viewToString( viewRoot ) ).to.equal( '
' + expectedResult + '
' ); - } - - describe( 'model element to view element conversion', () => { - it( 'using passed view element name', () => { - testModelConversion( { model: 'foo', view: 'strong' }, 'bar' ); - } ); - - it( 'using passed view element object', () => { - testModelConversion( { model: 'foo', view: { name: 'strong' } }, 'bar' ); - } ); - - it( 'using passed view element object with styles object', () => { - testModelConversion( { - model: 'foo', - view: { name: 'span', styles: { 'font-weight': 'bold' } } - }, 'bar' ); - } ); - - it( 'using passed view element object with class string', () => { - testModelConversion( { model: 'foo', view: { name: 'span', classes: 'foo' } }, 'bar' ); - } ); - - it( 'using passed view element object with class array', () => { - testModelConversion( { - model: 'foo', - view: { name: 'span', classes: [ 'foo', 'foo-bar' ] } - }, 'bar' ); - } ); - - it( 'using passed view element object with attributes', () => { - testModelConversion( { - model: 'foo', - view: { name: 'span', attributes: { 'data-foo': 'bar' } } - }, 'bar' ); - } ); - } ); - - describe( 'view element to model element conversion', () => { - let dispatcher, schema, additionalData, batch; - - const modelDocument = new ModelDocument(); - - beforeEach( () => { - batch = modelDocument.batch(); - - // `additionalData` parameter for `.convert` calls. - additionalData = { context: [ '$root' ] }; - - schema = new ModelSchema(); - - schema.registerItem( 'div', '$block' ); - schema.registerItem( 'bar', '$block' ); - schema.registerItem( 'baz', '$block' ); - - schema.allow( { name: '$inline', attributes: [ 'foo' ], inside: '$root' } ); - schema.allow( { name: '$text', inside: '$inline' } ); - - dispatcher = new ViewConversionDispatcher( { schema } ); - dispatcher.on( 'text', convertText() ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'bar', view: 'strong' }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'bar', view: { name: 'strong' } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'bar', view: { name: 'span', classes: 'foo' } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'span', { class: 'foo' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'bar', view: { name: 'span', classes: [ 'foo', 'bar' ] } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'span', { class: 'foo bar' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'bar', view: { name: 'span', styles: { 'font-weight': 'bold' } } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'span', { style: 'font-weight:bold' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'bar', view: { name: 'span', attributes: { 'data-foo': 'bar' } } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { - model: 'bar', - view: 'strong', - acceptsAlso: [ - { name: 'span', classes: [ 'foo', 'bar' ] }, - { name: 'span', attributes: { 'data-foo': 'bar' } } - ] - }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'span', { 'data-foo': 'bar' }, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - - it( 'should convert from view element to model attribute', () => { - viewToContainerElement( { model: 'baz', view: 'strong' }, [ dispatcher ] ); - viewToContainerElement( { model: 'bar', view: { name: 'strong', priority: 'high' } }, [ dispatcher ] ); - - const conversionResult = dispatcher.convert( - new ViewElement( 'strong', null, new ViewText( 'foo' ) ), batch, additionalData - ); - - expect( modelToString( conversionResult ) ).to.equal( 'foo' ); - } ); - } ); -} ); From 291d88930b7451cc46e099fd72c8342b608028ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 14 Dec 2017 12:49:16 +0100 Subject: [PATCH 160/724] Docs: Update module:engine/conversion/configurationdefinedconverters documentation. --- .../configurationdefinedconverters.js | 31 +++++++++++++------ 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/src/conversion/configurationdefinedconverters.js b/src/conversion/configurationdefinedconverters.js index 26286d842..a2543432d 100644 --- a/src/conversion/configurationdefinedconverters.js +++ b/src/conversion/configurationdefinedconverters.js @@ -12,6 +12,12 @@ import ViewContainerElement from '../view/containerelement'; import buildModelConverter from './buildmodelconverter'; +/** + * Helper for creating model to view converter from model's element. + * + * @param {module:engine/conversion/configurationdefinedconverters~ConverterDefinition} definition A conversion configuration. + * @param {Array.} dispatchers + */ export function containerElementToView( definition, dispatchers ) { const { model: modelElement, viewDefinition } = parseConverterDefinition( definition ); @@ -21,10 +27,15 @@ export function containerElementToView( definition, dispatchers ) { .toElement( () => ViewContainerElement.fromViewDefinition( viewDefinition ) ); } +/** + * + * @param {module:engine/conversion/configurationdefinedconverters~ConverterDefinition} definition A conversion configuration. + * @param {Array.} dispatchers + */ export function viewToContainerElement( definition, dispatchers ) { const { model: modelElement, viewDefinitions } = parseConverterDefinition( definition ); - const converter = defineViewConverter( dispatchers, viewDefinitions ); + const converter = prepareViewConverter( dispatchers, viewDefinitions ); converter.toElement( modelElement ); } @@ -33,8 +44,8 @@ export function viewToContainerElement( definition, dispatchers ) { * Helper for creating model to view converter from model's attribute. * * @param {String} attributeName - * @param {} definition Converter definition - * @param dispatchers + * @param {module:engine/conversion/configurationdefinedconverters~ConverterDefinition} definition A conversion configuration. + * @param {Array.} dispatchers */ export function attributeElementToViewConverter( attributeName, definition, dispatchers ) { const { model: attributeValue, viewDefinition } = parseConverterDefinition( definition ); @@ -54,13 +65,13 @@ export function attributeElementToViewConverter( attributeName, definition, disp /** * * @param attributeName - * @param definition - * @param dispatchers + * @param {module:engine/conversion/configurationdefinedconverters~ConverterDefinition} definition A conversion configuration. + * @param {Array.} dispatchers */ export function viewToAttributeElementConverter( attributeName, definition, dispatchers ) { const { model: attributeValue, viewDefinitions } = parseConverterDefinition( definition ); - const converter = defineViewConverter( dispatchers, viewDefinitions ); + const converter = prepareViewConverter( dispatchers, viewDefinitions ); converter.toAttribute( () => ( { key: attributeName, @@ -70,9 +81,10 @@ export function viewToAttributeElementConverter( attributeName, definition, disp import buildViewConverter from './buildviewconverter'; -// Prepares a {@link module:engine/conversion/utils~ConverterDefinition definition object} for building converters. +// Prepares a {@link module:engine/conversion/configurationdefinedconverters~ConverterDefinition definition object} for building converters. // -// @param {module:engine/conversion/utils~ConverterDefinition} definition An object that defines view to model and model to view conversion. +// @param {module:engine/conversion/configurationdefinedconverters~ConverterDefinition} definition An object that defines view to model +// and model to view conversion. // @returns {Object} function parseConverterDefinition( definition ) { const model = definition.model; @@ -92,7 +104,7 @@ function parseConverterDefinition( definition ) { // @param {Array.} dispatchers // @param {Array.} viewDefinitions // @returns {module:engine/conversion/buildviewconverter~ViewConverterBuilder} -function defineViewConverter( dispatchers, viewDefinitions ) { +function prepareViewConverter( dispatchers, viewDefinitions ) { const converter = buildViewConverter().for( ...dispatchers ); for ( const viewDefinition of viewDefinitions ) { @@ -107,6 +119,7 @@ function defineViewConverter( dispatchers, viewDefinitions ) { } // Converts viewDefinition to a matcher pattern. +// // @param {module:engine/view/viewelementdefinition~ViewElementDefinition} viewDefinition // @returns {module:engine/view/matcher~Pattern} function definitionToPattern( viewDefinition ) { From cffce8a012bf58184e51667308c32840ee87c4de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 14 Dec 2017 13:52:26 +0100 Subject: [PATCH 161/724] Removed model from DocumentSelection params. --- src/model/document.js | 2 +- src/model/documentselection.js | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/model/document.js b/src/model/document.js index 4b6475394..4bc575476 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -74,7 +74,7 @@ export default class Document { * @readonly * @member {module:engine/model/documentselection~DocumentSelection} */ - this.selection = new DocumentSelection( this, this.model ); + this.selection = new DocumentSelection( this ); /** * List of roots that are owned and managed by this document. Use {@link #createRoot} and diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 055d0e6f4..a345d4d50 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -52,9 +52,8 @@ export default class DocumentSelection extends Selection { * Creates an empty live selection for given {@link module:engine/model/document~Document}. * * @param {module:engine/model/document~Document} document Document which owns this selection. - * @param {module:engine/model/model~Model} model Data model. */ - constructor( document, model ) { + constructor( document ) { super(); /** @@ -63,7 +62,7 @@ export default class DocumentSelection extends Selection { * @protected * @member {module:engine/model/model~Model} */ - this._model = model; + this._model = document.model; /** * Document which owns this selection. From 9bc974af43b20e2396596b4282870bc22396a816 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Thu, 14 Dec 2017 14:04:45 +0100 Subject: [PATCH 162/724] Docs for applyOperation event. --- src/model/model.js | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/src/model/model.js b/src/model/model.js index 16f07fdb2..579786440 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -200,7 +200,7 @@ export default class Model { } /** - * Fires after leaving each {@link module:engine/model/model~Model#enqueueChange} block or outermost + * Fired after leaving each {@link module:engine/model/model~Model#enqueueChange} block or outermost * {@link module:engine/model/model~Model#change} block. * Have the same parameters as {@link module:engine/model/model~Model#change}. * @@ -208,7 +208,7 @@ export default class Model { */ /** - * Fires when all queued model changes are done. + * Fired when all queued model changes are done. * * @see #change * @see #enqueueChange @@ -216,7 +216,24 @@ export default class Model { */ /** + * Fired every time any {@link module:engine/model/operation/operation~Operation operation} is applied on the model + * using {@link #applyOperation}. + * + * Note that this is an internal event for the specific use-cases. You can use it if you need to know about each operation + * applied on the document, but in most cases {@link #change} event which is fired when all changes in a + * {@link module:engine/model/batch~Batch} are applied, is a better choice. + * + * With the high priority operation is validated. + * + * With the normal priority operation is executed. After that priority you will be able to get additional + * information about the applied changes returned by {@link module:engine/model/operation/operation~Operation#_execute} + * as `evt.return`. + * + * With the low priority the {@link module:engine/model/document~Document} listen on this event and updates its version. + * * @event applyOperation + * @param {Array} args Arguments of the `applyOperation` which are an array with a single element: + * {@link module:engine/model/operation/operation~Operation operation}. */ } From a4919d9d5679bdce8e4f6e3db70912eeef6cc7bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 14 Dec 2017 16:25:39 +0100 Subject: [PATCH 163/724] Internal: Renamed document parameter to doc in DocumentSelection. --- src/model/documentselection.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index a345d4d50..e606d951c 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -51,9 +51,9 @@ export default class DocumentSelection extends Selection { /** * Creates an empty live selection for given {@link module:engine/model/document~Document}. * - * @param {module:engine/model/document~Document} document Document which owns this selection. + * @param {module:engine/model/document~Document} doc Document which owns this selection. */ - constructor( document ) { + constructor( doc ) { super(); /** @@ -62,7 +62,7 @@ export default class DocumentSelection extends Selection { * @protected * @member {module:engine/model/model~Model} */ - this._model = document.model; + this._model = doc.model; /** * Document which owns this selection. @@ -70,7 +70,7 @@ export default class DocumentSelection extends Selection { * @protected * @member {module:engine/model/document~Document} */ - this._document = document; + this._document = doc; /** * Keeps mapping of attribute name to priority with which the attribute got modified (added/changed/removed) From a04605a33be5d47a6cf0a92bceb09e33c31ec09b Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Wed, 13 Dec 2017 13:20:25 +0100 Subject: [PATCH 164/724] Changed: `view.Writer` to better handle attribute elements partial (un)wrapping and merging. --- src/view/writer.js | 61 +++++++++++++++++++++++++------------ tests/view/writer/unwrap.js | 27 ++++++++++++++++ tests/view/writer/wrap.js | 27 ++++++++++++++++ 3 files changed, 95 insertions(+), 20 deletions(-) diff --git a/src/view/writer.js b/src/view/writer.js index ffbd49b07..07aa9097a 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -391,8 +391,8 @@ export function clear( range, element ) { if ( item.is( 'element' ) && element.isSimilar( item ) ) { // Create range on this element. rangeToRemove = Range.createOn( item ); - // When range starts inside Text or TextProxy element. - } else if ( !current.nextPosition.isAfter( range.start ) && ( item.is( 'text' ) || item.is( 'textProxy' ) ) ) { + // When range starts inside Text or TextProxy element. + } else if ( !current.nextPosition.isAfter( range.start ) && item.is( 'textProxy' ) ) { // We need to check if parent of this text matches to given element. const parentElement = item.getAncestors().find( ancestor => { return ancestor.is( 'element' ) && element.isSimilar( ancestor ); @@ -480,25 +480,36 @@ export function wrap( range, attribute ) { return range; } - // Range around one element. - if ( range.end.isEqual( range.start.getShiftedBy( 1 ) ) ) { - const node = range.start.nodeAfter; - - if ( node instanceof AttributeElement && wrapAttributeElement( attribute, node ) ) { - return range; - } - } - // Range is inside single attribute and spans on all children. if ( rangeSpansOnAllChildren( range ) && wrapAttributeElement( attribute, range.start.parent ) ) { - const parent = range.start.parent.parent; - const index = range.start.parent.index; + const parent = range.start.parent; - return Range.createFromParentsAndOffsets( parent, index, parent, index + 1 ); + const end = mergeAttributes( Position.createAfter( parent ) ); + const start = mergeAttributes( Position.createBefore( parent ) ); + + return new Range( start, end ); } // Break attributes at range start and end. const { start: breakStart, end: breakEnd } = _breakAttributesRange( range, true ); + + // Range around one element. + if ( breakEnd.isEqual( breakStart.getShiftedBy( 1 ) ) ) { + const node = breakStart.nodeAfter; + + if ( node instanceof AttributeElement && wrapAttributeElement( attribute, node ) ) { + const start = mergeAttributes( breakStart ); + + if ( !start.isEqual( breakStart ) ) { + breakEnd.offset--; + } + + const end = mergeAttributes( breakEnd ); + + return new Range( start, end ); + } + } + const parentContainer = breakStart.parent; // Unwrap children located between break points. @@ -583,7 +594,7 @@ export function wrapPosition( position, attribute ) { * same parent container. * * @param {module:engine/view/range~Range} range - * @param {module:engine/view/attributeelement~AttributeElement} element + * @param {module:engine/view/attributeelement~AttributeElement} attribute */ export function unwrap( range, attribute ) { if ( !( attribute instanceof AttributeElement ) ) { @@ -602,20 +613,29 @@ export function unwrap( range, attribute ) { return range; } + // Break attributes at range start and end. + const { start: breakStart, end: breakEnd } = _breakAttributesRange( range, true ); + // Range around one element - check if AttributeElement can be unwrapped partially when it's not similar. // For example: // unwrap with:

result: - if ( range.end.isEqual( range.start.getShiftedBy( 1 ) ) ) { - const node = range.start.nodeAfter; + if ( breakEnd.isEqual( breakStart.getShiftedBy( 1 ) ) ) { + const node = breakStart.nodeAfter; // Unwrap single attribute element. if ( !attribute.isSimilar( node ) && node instanceof AttributeElement && unwrapAttributeElement( attribute, node ) ) { - return range; + const start = mergeAttributes( breakStart ); + + if ( !start.isEqual( breakStart ) ) { + breakEnd.offset--; + } + + const end = mergeAttributes( breakEnd ); + + return new Range( start, end ); } } - // Break attributes at range start and end. - const { start: breakStart, end: breakEnd } = _breakAttributesRange( range, true ); const parentContainer = breakStart.parent; // Unwrap children located between break points. @@ -628,6 +648,7 @@ export function unwrap( range, attribute ) { if ( !start.isEqual( newRange.start ) ) { newRange.end.offset--; } + const end = mergeAttributes( newRange.end ); return new Range( start, end ); diff --git a/tests/view/writer/unwrap.js b/tests/view/writer/unwrap.js index 07a2257e0..281c13945 100644 --- a/tests/view/writer/unwrap.js +++ b/tests/view/writer/unwrap.js @@ -295,6 +295,33 @@ describe( 'writer', () => { ); } ); + it( 'should partially unwrap part of a node', () => { + test( + '' + + '[foo}bar' + + '', + '', + '' + + '[foo]' + + 'bar' + + '' + ); + } ); + + it( 'should be merged after being partially unwrapped', () => { + test( + '' + + 'xyz' + + '[foo}bar' + + '', + '', + '' + + 'xyz{foo]' + + 'bar' + + '' + ); + } ); + it( 'should unwrap single node in document fragment', () => { test( '[foobar]', diff --git a/tests/view/writer/wrap.js b/tests/view/writer/wrap.js index 39f92916d..b538a9e9e 100644 --- a/tests/view/writer/wrap.js +++ b/tests/view/writer/wrap.js @@ -283,6 +283,33 @@ describe( 'writer', () => { ); } ); + it( 'should be merged with broken element', () => { + test( + '' + + '[foo}bar' + + '', + '', + '' + + '[foo]' + + 'bar' + + '' + ); + } ); + + it( 'should be merged with broken element and merged with siblings', () => { + test( + '' + + 'xyz' + + '[foo}bar' + + '', + '', + '' + + 'xyz{foo]' + + 'bar' + + '' + ); + } ); + it( 'should wrap EmptyElement', () => { test( '[]', From eb375019ce621bc52aba43913b5fa1443e756259 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Wed, 13 Dec 2017 14:18:15 +0100 Subject: [PATCH 165/724] Added: Extracted operation validation from `_execute()` method to `_validate()` method. --- src/model/operation/attributeoperation.js | 8 +- src/model/operation/detachoperation.js | 7 +- src/model/operation/insertoperation.js | 19 +++ src/model/operation/moveoperation.js | 7 +- src/model/operation/operation.js | 13 +- src/model/operation/reinsertoperation.js | 9 +- src/model/operation/removeoperation.js | 9 +- src/model/operation/renameoperation.js | 16 +- src/model/operation/rootattributeoperation.js | 10 +- tests/model/model.js | 3 +- tests/model/operation/attributeoperation.js | 133 +++++++++------- tests/model/operation/detachoperation.js | 18 ++- tests/model/operation/insertoperation.js | 10 ++ tests/model/operation/moveoperation.js | 146 ++++++++---------- tests/model/operation/reinsertoperation.js | 54 ++++--- tests/model/operation/removeoperation.js | 28 ++-- tests/model/operation/renameoperation.js | 40 ++--- .../model/operation/rootattributeoperation.js | 36 +++-- 18 files changed, 333 insertions(+), 233 deletions(-) diff --git a/src/model/operation/attributeoperation.js b/src/model/operation/attributeoperation.js index 2036e8c4e..fba69d6c7 100644 --- a/src/model/operation/attributeoperation.js +++ b/src/model/operation/attributeoperation.js @@ -114,8 +114,7 @@ export default class AttributeOperation extends Operation { /** * @inheritDoc */ - _execute() { - // Validation. + _validate() { for ( const item of this.range.getItems() ) { if ( this.oldValue !== null && !isEqual( item.getAttribute( this.key ), this.oldValue ) ) { /** @@ -147,7 +146,12 @@ export default class AttributeOperation extends Operation { ); } } + } + /** + * @inheritDoc + */ + _execute() { // If value to set is same as old value, don't do anything. if ( !isEqual( this.oldValue, this.newValue ) ) { // Execution. diff --git a/src/model/operation/detachoperation.js b/src/model/operation/detachoperation.js index a647bd0b0..4c68b1c8d 100644 --- a/src/model/operation/detachoperation.js +++ b/src/model/operation/detachoperation.js @@ -62,7 +62,7 @@ export default class DetachOperation extends Operation { /** * @inheritDoc */ - _execute() { + _validate() { if ( this.sourcePosition.root.document ) { /** * Cannot detach document node. @@ -72,7 +72,12 @@ export default class DetachOperation extends Operation { */ throw new CKEditorError( 'detach-operation-on-document-node: Cannot detach document node.' ); } + } + /** + * @inheritDoc + */ + _execute() { const nodes = _remove( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ) ); return { nodes }; diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 41442d7c8..2694fd304 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -14,6 +14,7 @@ import RemoveOperation from './removeoperation'; import { _insert, _normalizeNodes } from './utils'; import Text from '../text'; import Element from '../element'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Operation to insert one or more nodes at given position in the model. @@ -83,6 +84,24 @@ export default class InsertOperation extends Operation { return new RemoveOperation( this.position, this.nodes.maxOffset, gyPosition, this.baseVersion + 1 ); } + /** + * @inheritDoc + */ + _validate() { + const targetElement = this.position.parent; + + if ( !targetElement || targetElement.maxOffset < this.position.offset ) { + /** + * Insertion position is invalid. + * + * @error insert-operation-position-invalid + */ + throw new CKEditorError( + 'insert-operation-position-invalid: Insertion position is invalid.' + ); + } + } + /** * @inheritDoc */ diff --git a/src/model/operation/moveoperation.js b/src/model/operation/moveoperation.js index 6290823d9..13845aa9d 100644 --- a/src/model/operation/moveoperation.js +++ b/src/model/operation/moveoperation.js @@ -131,7 +131,7 @@ export default class MoveOperation extends Operation { /** * @inheritDoc */ - _execute() { + _validate() { const sourceElement = this.sourcePosition.parent; const targetElement = this.targetPosition.parent; const sourceOffset = this.sourcePosition.offset; @@ -183,7 +183,12 @@ export default class MoveOperation extends Operation { } } } + } + /** + * @inheritDoc + */ + _execute() { const range = _move( Range.createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition ); return { diff --git a/src/model/operation/operation.js b/src/model/operation/operation.js index acbcb3f7f..efc60d469 100644 --- a/src/model/operation/operation.js +++ b/src/model/operation/operation.js @@ -73,8 +73,7 @@ export default class Operation { */ /** - * Executes the operation - modifications described by the operation attributes - * will be applied to the tree model. + * Executes the operation - modifications described by the operation attributes will be applied to the tree model. * * @protected * @method #_execute @@ -83,6 +82,16 @@ export default class Operation { */ } + /** + * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws + * an error if operation is not valid. + * + * @protected + * @method #_validate + */ + _validate() { + } + /** * Custom toJSON method to solve child-parent circular dependencies. * diff --git a/src/model/operation/reinsertoperation.js b/src/model/operation/reinsertoperation.js index 34ed54572..9b06c5ed8 100644 --- a/src/model/operation/reinsertoperation.js +++ b/src/model/operation/reinsertoperation.js @@ -70,7 +70,9 @@ export default class ReinsertOperation extends MoveOperation { /** * @inheritDoc */ - _execute() { + _validate() { + super._validate(); + if ( !this.sourcePosition.root.document ) { throw new CKEditorError( 'reinsert-operation-on-detached-item: Cannot reinsert detached item.' ); } @@ -78,7 +80,12 @@ export default class ReinsertOperation extends MoveOperation { if ( !this.targetPosition.root.document ) { throw new CKEditorError( 'reinsert-operation-to-detached-parent: Cannot reinsert item to detached parent.' ); } + } + /** + * @inheritDoc + */ + _execute() { return super._execute(); } diff --git a/src/model/operation/removeoperation.js b/src/model/operation/removeoperation.js index 6142d84db..df38e68c5 100644 --- a/src/model/operation/removeoperation.js +++ b/src/model/operation/removeoperation.js @@ -52,7 +52,9 @@ export default class RemoveOperation extends MoveOperation { /** * @inheritDoc */ - _execute() { + _validate() { + super._validate(); + if ( !this.sourcePosition.root.document ) { /** * Item that is going to be removed needs to be a {@link module:engine/model/document~Document document} child. @@ -63,7 +65,12 @@ export default class RemoveOperation extends MoveOperation { */ throw new CKEditorError( 'remove-operation-on-detached-item: Cannot remove detached item.' ); } + } + /** + * @inheritDoc + */ + _execute() { return super._execute(); } diff --git a/src/model/operation/renameoperation.js b/src/model/operation/renameoperation.js index 7f7334a4f..09dfa9c4f 100644 --- a/src/model/operation/renameoperation.js +++ b/src/model/operation/renameoperation.js @@ -86,8 +86,7 @@ export default class RenameOperation extends Operation { /** * @inheritDoc */ - _execute() { - // Validation. + _validate() { const element = this.position.nodeAfter; if ( !( element instanceof Element ) ) { @@ -109,12 +108,15 @@ export default class RenameOperation extends Operation { 'rename-operation-wrong-name: Element to change has different name than operation\'s old name.' ); } + } - // If value to set is same as old value, don't do anything. - if ( element.name != this.newName ) { - // Execution. - element.name = this.newName; - } + /** + * @inheritDoc + */ + _execute() { + const element = this.position.nodeAfter; + + element.name = this.newName; return { element, oldName: this.oldName }; } diff --git a/src/model/operation/rootattributeoperation.js b/src/model/operation/rootattributeoperation.js index 606efe04e..a097d1a03 100644 --- a/src/model/operation/rootattributeoperation.js +++ b/src/model/operation/rootattributeoperation.js @@ -105,7 +105,10 @@ export default class RootAttributeOperation extends Operation { return new RootAttributeOperation( this.root, this.key, this.newValue, this.oldValue, this.baseVersion + 1 ); } - _execute() { + /** + * @inheritDoc + */ + _validate() { if ( this.oldValue !== null && this.root.getAttribute( this.key ) !== this.oldValue ) { /** * The attribute which should be removed does not exists for the given node. @@ -135,7 +138,12 @@ export default class RootAttributeOperation extends Operation { { root: this.root, key: this.key } ); } + } + /** + * @inheritDoc + */ + _execute() { if ( this.newValue !== null ) { this.root.setAttribute( this.key, this.newValue ); } else { diff --git a/tests/model/model.js b/tests/model/model.js index d2f737cba..7781c1972 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -311,7 +311,8 @@ describe( 'Model', () => { const returnValue = { foo: 'bar' }; const operation = { - _execute: sinon.stub().returns( returnValue ) + _execute: sinon.stub().returns( returnValue ), + _validate: () => true }; model.applyOperation( operation ); diff --git a/tests/model/operation/attributeoperation.js b/tests/model/operation/attributeoperation.js index e6aa85fb1..62b0d3343 100644 --- a/tests/model/operation/attributeoperation.js +++ b/tests/model/operation/attributeoperation.js @@ -173,6 +173,25 @@ describe( 'AttributeOperation', () => { expect( root.getChild( 0 ).getAttribute( 'bar' ) ).to.be.true; } ); + it( 'should work correctly if old and new value are same', () => { + root.insertChildren( 0, new Text( 'bar', { foo: 'bar' } ) ); + + model.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ), + 'foo', + 'bar', + 'bar', + doc.version + ) + ) ); + + expect( doc.version ).to.equal( 1 ); + expect( root.childCount ).to.equal( 1 ); + expect( count( root.getChild( 0 ).getAttributes() ) ).to.equal( 1 ); + expect( root.getChild( 0 ).getAttribute( 'foo' ) ).to.equal( 'bar' ); + } ); + it( 'should remove attribute', () => { root.insertChildren( 0, new Text( 'x', { foo: true, x: true, bar: true } ) ); @@ -193,20 +212,70 @@ describe( 'AttributeOperation', () => { expect( root.getChild( 0 ).hasAttribute( 'bar' ) ).to.be.true; } ); - it( 'should not throw for non-primitive attribute values', () => { - root.insertChildren( 0, new Text( 'x', { foo: [ 'bar', 'xyz' ] } ) ); + describe( '_validate()', () => { + it( 'should not throw for non-primitive attribute values', () => { + root.insertChildren( 0, new Text( 'x', { foo: [ 'bar', 'xyz' ] } ) ); - expect( () => { - model.applyOperation( wrapInDelta( - new AttributeOperation( + expect( () => { + const operation = new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), 'foo', [ 'bar', 'xyz' ], true, doc.version - ) - ) ); - } ).to.not.throw( Error ); + ); + + operation._validate(); + } ).to.not.throw( Error ); + } ); + + it( 'should throw an error when one try to remove and the attribute does not exists', () => { + root.insertChildren( 0, new Text( 'x' ) ); + + expect( () => { + const operation = new AttributeOperation( + new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), + 'foo', + true, + null, + doc.version + ); + + operation._validate(); + } ).to.throw( CKEditorError, /attribute-operation-wrong-old-value/ ); + } ); + + it( 'should throw an error when one try to insert and the attribute already exists', () => { + root.insertChildren( 0, new Text( 'x', { x: 1 } ) ); + + expect( () => { + const operation = new AttributeOperation( + new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), + 'x', + null, + 2, + doc.version + ); + + operation._validate(); + } ).to.throw( CKEditorError, /attribute-operation-attribute-exists/ ); + } ); + + it( 'should not throw when attribute value is the same', () => { + root.insertChildren( 0, new Text( 'x', { foo: true } ) ); + + expect( () => { + const operation = new AttributeOperation( + new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), + 'foo', + true, + true, + doc.version + ); + + operation._validate(); + } ).to.not.throw(); + } ); } ); it( 'should create an AttributeOperation as a reverse', () => { @@ -327,38 +396,6 @@ describe( 'AttributeOperation', () => { expect( root.getChild( 0 ).getAttribute( 'foo' ) ).to.be.true; } ); - it( 'should throw an error when one try to remove and the attribute does not exists', () => { - root.insertChildren( 0, new Text( 'x' ) ); - - expect( () => { - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), - 'foo', - true, - null, - doc.version - ) - ) ); - } ).to.throw( CKEditorError, /attribute-operation-wrong-old-value/ ); - } ); - - it( 'should throw an error when one try to insert and the attribute already exists', () => { - root.insertChildren( 0, new Text( 'x', { x: 1 } ) ); - - expect( () => { - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), - 'x', - null, - 2, - doc.version - ) - ) ); - } ).to.throw( CKEditorError, /attribute-operation-attribute-exists/ ); - } ); - it( 'should create an AttributeOperation with the same parameters when cloned', () => { const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ); const baseVersion = doc.version; @@ -399,22 +436,6 @@ describe( 'AttributeOperation', () => { expect( root.getChild( 1 ).data ).to.equal( 'bcxyz' ); } ); - it( 'should do nothing when attribute value is the same', () => { - root.insertChildren( 0, new Text( 'x', { foo: true } ) ); - - expect( () => { - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0 ] ), new Position( root, [ 1 ] ) ), - 'foo', - true, - true, - doc.version - ) - ) ); - } ).to.not.throw(); - } ); - describe( 'toJSON', () => { it( 'should create proper serialized object', () => { const range = new Range( new Position( root, [ 0 ] ), new Position( root, [ 2 ] ) ); diff --git a/tests/model/operation/detachoperation.js b/tests/model/operation/detachoperation.js index 36be9094b..494dd18f3 100644 --- a/tests/model/operation/detachoperation.js +++ b/tests/model/operation/detachoperation.js @@ -35,17 +35,19 @@ describe( 'DetachOperation', () => { expect( docFrag.childCount ).to.equal( 0 ); } ); - it( 'should throw when is executed on element from document', () => { - const root = doc.createRoot(); - const element = new Element( 'element' ); + describe( '_validate()', () => { + it( 'should throw when is executed on element from document', () => { + const root = doc.createRoot(); + const element = new Element( 'element' ); - root.appendChildren( [ element ] ); + root.appendChildren( [ element ] ); - const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); + const op = new DetachOperation( Position.createBefore( element ), 1, doc.version ); - expect( () => { - op._execute(); - } ).to.throw( CKEditorError, /^detach-operation-on-document-node/ ); + expect( () => { + op._validate(); + } ).to.throw( CKEditorError, /^detach-operation-on-document-node/ ); + } ); } ); it( 'should be not a document operation', () => { diff --git a/tests/model/operation/insertoperation.js b/tests/model/operation/insertoperation.js index 2331ecb9a..0e972fb1c 100644 --- a/tests/model/operation/insertoperation.js +++ b/tests/model/operation/insertoperation.js @@ -11,6 +11,7 @@ import InsertOperation from '../../../src/model/operation/insertoperation'; import RemoveOperation from '../../../src/model/operation/removeoperation'; import Position from '../../../src/model/position'; import Text from '../../../src/model/text'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import { jsonParseStringify, wrapInDelta } from '../../../tests/model/_utils/utils'; describe( 'InsertOperation', () => { @@ -232,6 +233,15 @@ describe( 'InsertOperation', () => { } ); } ); + describe( '_validate()', () => { + it( 'should throw an error if target position does not exist', () => { + const element = new Element( 'p' ); + const op = new InsertOperation( new Position( root, [ 4 ] ), element, doc.version ); + + expect( () => op._validate() ).to.throw( CKEditorError, /insert-operation-position-invalid/ ); + } ); + } ); + describe( 'toJSON', () => { it( 'should create proper json object', () => { const position = new Position( root, [ 0 ] ); diff --git a/tests/model/operation/moveoperation.js b/tests/model/operation/moveoperation.js index dbf602db9..4f7219240 100644 --- a/tests/model/operation/moveoperation.js +++ b/tests/model/operation/moveoperation.js @@ -151,102 +151,92 @@ describe( 'MoveOperation', () => { expect( p2.maxOffset ).to.equal( 0 ); } ); - it( 'should throw an error if number of nodes to move exceeds the number of existing nodes in given element', () => { - root.insertChildren( 0, new Text( 'xbarx' ) ); + describe( '_validate()', () => { + it( 'should throw an error if number of nodes to move exceeds the number of existing nodes in given element', () => { + root.insertChildren( 0, new Text( 'xbarx' ) ); - const operation = new MoveOperation( - new Position( root, [ 3 ] ), - 3, - new Position( root, [ 1 ] ), - doc.version - ); + const operation = new MoveOperation( + new Position( root, [ 3 ] ), + 3, + new Position( root, [ 1 ] ), + doc.version + ); - expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-nodes-do-not-exist/ ); - } ); + expect( () => operation._validate() ).to.throw( CKEditorError, /move-operation-nodes-do-not-exist/ ); + } ); - it( 'should throw an error if target or source parent-element specified by position does not exist', () => { - const p = new Element( 'p' ); - p.insertChildren( 0, new Text( 'foo' ) ); - root.insertChildren( 0, [ new Text( 'ab' ), p ] ); + it( 'should throw an error if target or source parent-element specified by position does not exist', () => { + const p = new Element( 'p' ); + p.insertChildren( 0, new Text( 'foo' ) ); + root.insertChildren( 0, [ new Text( 'ab' ), p ] ); - const operation = new MoveOperation( - new Position( root, [ 2, 0 ] ), - 3, - new Position( root, [ 1 ] ), - doc.version - ); + const operation = new MoveOperation( + new Position( root, [ 2, 0 ] ), + 3, + new Position( root, [ 1 ] ), + doc.version + ); - root.removeChildren( 1 ); + root.removeChildren( 1 ); - expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-position-invalid/ ); - } ); + expect( () => operation._validate() ).to.throw( CKEditorError, /move-operation-position-invalid/ ); + } ); - it( 'should throw an error if operation tries to move a range between the beginning and the end of that range', () => { - root.insertChildren( 0, new Text( 'xbarx' ) ); + it( 'should throw an error if operation tries to move a range between the beginning and the end of that range', () => { + root.insertChildren( 0, new Text( 'xbarx' ) ); - const operation = new MoveOperation( - new Position( root, [ 1 ] ), - 3, - new Position( root, [ 2 ] ), - doc.version - ); + const operation = new MoveOperation( + new Position( root, [ 1 ] ), + 3, + new Position( root, [ 2 ] ), + doc.version + ); - expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-range-into-itself/ ); - } ); + expect( () => operation._validate() ).to.throw( CKEditorError, /move-operation-range-into-itself/ ); + } ); - it( 'should throw an error if operation tries to move a range into a sub-tree of a node that is in that range', () => { - const p = new Element( 'p', [], [ new Element( 'p' ) ] ); - root.insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); + it( 'should throw an error if operation tries to move a range into a sub-tree of a node that is in that range', () => { + const p = new Element( 'p', [], [ new Element( 'p' ) ] ); + root.insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); - const operation = new MoveOperation( - new Position( root, [ 1 ] ), - 3, - new Position( root, [ 2, 0, 0 ] ), - doc.version - ); - - expect( () => model.applyOperation( wrapInDelta( operation ) ) ).to.throw( CKEditorError, /move-operation-node-into-itself/ ); - } ); + const operation = new MoveOperation( + new Position( root, [ 1 ] ), + 3, + new Position( root, [ 2, 0, 0 ] ), + doc.version + ); - it( 'should not throw an error if operation move a range into a sibling', () => { - const p = new Element( 'p' ); - root.insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); + expect( () => operation._validate() ).to.throw( CKEditorError, /move-operation-node-into-itself/ ); + } ); - const operation = new MoveOperation( - new Position( root, [ 1 ] ), - 1, - new Position( root, [ 2, 0 ] ), - doc.version - ); + it( 'should not throw an error if operation move a range into a sibling', () => { + const p = new Element( 'p' ); + root.insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); - expect( - () => { - model.applyOperation( wrapInDelta( operation ) ); - } - ).not.to.throw(); + const operation = new MoveOperation( + new Position( root, [ 1 ] ), + 1, + new Position( root, [ 2, 0 ] ), + doc.version + ); - expect( root.maxOffset ).to.equal( 4 ); - expect( p.maxOffset ).to.equal( 1 ); - expect( p.getChild( 0 ).data ).to.equal( 'b' ); - } ); + expect( () => operation._validate() ).not.to.throw(); + } ); - it( 'should not throw when operation paths looks like incorrect but move is between different roots', () => { - const p = new Element( 'p' ); - root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); - doc.graveyard.insertChildren( 0, new Text( 'abc' ) ); + it( 'should not throw when operation paths looks like incorrect but move is between different roots', () => { + const p = new Element( 'p' ); + root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); + doc.graveyard.insertChildren( 0, new Text( 'abc' ) ); - const operation = new MoveOperation( - new Position( doc.graveyard, [ 0 ] ), - 2, - new Position( root, [ 1, 0 ] ), - doc.version - ); + const operation = new MoveOperation( + new Position( doc.graveyard, [ 0 ] ), + 2, + new Position( root, [ 1, 0 ] ), + doc.version + ); - expect( - () => { - model.applyOperation( wrapInDelta( operation ) ); - } - ).not.to.throw(); + expect( () => operation._validate() ).not.to.throw(); + } ); } ); it( 'should create MoveOperation with the same parameters when cloned', () => { diff --git a/tests/model/operation/reinsertoperation.js b/tests/model/operation/reinsertoperation.js index f22b634e6..d4f6a4b39 100644 --- a/tests/model/operation/reinsertoperation.js +++ b/tests/model/operation/reinsertoperation.js @@ -106,34 +106,38 @@ describe( 'ReinsertOperation', () => { expect( operation.isDocumentOperation ).to.true; } ); - it( 'should throw when target position is not in the document', () => { - const docFrag = new DocumentFragment(); - - operation = new ReinsertOperation( - graveyardPosition, - 1, - Position.createAt( docFrag ), - doc.version - ); - - expect( () => { - operation._execute(); - } ).to.throw( CKEditorError, /^reinsert-operation-to-detached-parent/ ); - } ); + describe( '_validate()', () => { + it( 'should throw when target position is not in the document', () => { + const docFrag = new DocumentFragment(); + + graveyard.insertChildren( 0, new Text( 'xx' ) ); + + operation = new ReinsertOperation( + graveyardPosition, + 1, + Position.createAt( docFrag ), + doc.version + ); + + expect( () => { + operation._validate(); + } ).to.throw( CKEditorError, /^reinsert-operation-to-detached-parent/ ); + } ); - it( 'should throw when source position is not in the document', () => { - const docFrag = new DocumentFragment(); + it( 'should throw when source position is not in the document', () => { + const docFrag = new DocumentFragment( new Text( 'xx' ) ); - operation = new ReinsertOperation( - Position.createAt( docFrag ), - 1, - rootPosition, - doc.version - ); + operation = new ReinsertOperation( + Position.createAt( docFrag ), + 1, + rootPosition, + doc.version + ); - expect( () => { - operation._execute(); - } ).to.throw( CKEditorError, /^reinsert-operation-on-detached-item/ ); + expect( () => { + operation._validate(); + } ).to.throw( CKEditorError, /^reinsert-operation-on-detached-item/ ); + } ); } ); describe( 'toJSON', () => { diff --git a/tests/model/operation/removeoperation.js b/tests/model/operation/removeoperation.js index 38cc1e8c5..e077ebf47 100644 --- a/tests/model/operation/removeoperation.js +++ b/tests/model/operation/removeoperation.js @@ -143,22 +143,24 @@ describe( 'RemoveOperation', () => { expect( doc.graveyard.getChild( 2 ).name ).to.equal( 'y' ); } ); - it( 'should throw when is executed on detached item', () => { - const docFrag = new DocumentFragment(); - const item = new Element( 'foo' ); + describe( '_validate()', () => { + it( 'should throw when is executed on detached item', () => { + const docFrag = new DocumentFragment(); + const item = new Element( 'foo' ); - docFrag.appendChildren( [ item ] ); + docFrag.appendChildren( [ item ] ); - const op = new RemoveOperation( - new Position( docFrag, [ 0 ] ), - 1, - new Position( doc.graveyard, [ 0 ] ), - doc.version - ); + const op = new RemoveOperation( + new Position( docFrag, [ 0 ] ), + 1, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ); - expect( () => { - op._execute(); - } ).to.throw( CKEditorError, /^remove-operation-on-detached-item/ ); + expect( () => { + op._validate(); + } ).to.throw( CKEditorError, /^remove-operation-on-detached-item/ ); + } ); } ); it( 'should always be a document operation', () => { diff --git a/tests/model/operation/renameoperation.js b/tests/model/operation/renameoperation.js index c901d914c..179f7d70c 100644 --- a/tests/model/operation/renameoperation.js +++ b/tests/model/operation/renameoperation.js @@ -64,20 +64,30 @@ describe( 'RenameOperation', () => { expect( element.name ).to.equal( oldName ); } ); - it( 'should throw an error if position is not before an element', () => { - const op = new RenameOperation( Position.createAt( root, 'end' ), oldName, newName, doc.version ); + describe( '_validate()', () => { + it( 'should throw an error if position is not before an element', () => { + const op = new RenameOperation( Position.createAt( root, 'end' ), oldName, newName, doc.version ); - expect( () => { - model.applyOperation( wrapInDelta( op ) ); - } ).to.throw( CKEditorError, /rename-operation-wrong-position/ ); - } ); + expect( () => { + op._validate(); + } ).to.throw( CKEditorError, /rename-operation-wrong-position/ ); + } ); + + it( 'should throw an error if oldName is different than renamed element name', () => { + const op = new RenameOperation( position, 'foo', newName, doc.version ); - it( 'should throw an error if oldName is different than renamed element name', () => { - const op = new RenameOperation( position, 'foo', newName, doc.version ); + expect( () => { + op._validate(); + } ).to.throw( CKEditorError, /rename-operation-wrong-name/ ); + } ); - expect( () => { - model.applyOperation( wrapInDelta( op ) ); - } ).to.throw( CKEditorError, /rename-operation-wrong-name/ ); + it( 'should not throw when new name is the same as previous', () => { + const op = new RenameOperation( position, oldName, oldName, doc.version ); + + expect( () => { + op._validate(); + } ).to.not.throw(); + } ); } ); it( 'should create a RenameOperation with the same parameters when cloned', () => { @@ -94,14 +104,6 @@ describe( 'RenameOperation', () => { expect( clone.newName ).to.equal( newName ); } ); - it( 'should do nothing when new name is the same as previous', () => { - const op = new RenameOperation( position, oldName, oldName, doc.version ); - - expect( () => { - model.applyOperation( wrapInDelta( op ) ); - } ).to.not.throw(); - } ); - describe( 'isDocumentOperation', () => { it( 'should be true when target item is in the document', () => { const op = new RenameOperation( position, oldName, newName, doc.version ); diff --git a/tests/model/operation/rootattributeoperation.js b/tests/model/operation/rootattributeoperation.js index 509f9756c..fb01a8034 100644 --- a/tests/model/operation/rootattributeoperation.js +++ b/tests/model/operation/rootattributeoperation.js @@ -203,34 +203,36 @@ describe( 'RootAttributeOperation', () => { expect( root.getAttribute( 'foo' ) ).to.be.true; } ); - it( 'should throw an error when one try to remove and the attribute does not exists', () => { - expect( () => { - model.applyOperation( wrapInDelta( - new RootAttributeOperation( + describe( '_validate()', () => { + it( 'should throw an error when one try to remove and the attribute does not exists', () => { + expect( () => { + const op = new RootAttributeOperation( root, 'foo', true, null, doc.version - ) - ) ); - } ).to.throw( CKEditorError, /rootattribute-operation-wrong-old-value/ ); - } ); + ); + + op._validate(); + } ).to.throw( CKEditorError, /rootattribute-operation-wrong-old-value/ ); + } ); - it( 'should throw an error when one try to insert and the attribute already exists', () => { - root.setAttribute( 'x', 1 ); + it( 'should throw an error when one try to insert and the attribute already exists', () => { + root.setAttribute( 'x', 1 ); - expect( () => { - model.applyOperation( wrapInDelta( - new RootAttributeOperation( + expect( () => { + const op = new RootAttributeOperation( root, 'x', null, 2, doc.version - ) - ) ); - } ).to.throw( CKEditorError, /rootattribute-operation-attribute-exists/ ); + ); + + op._validate(); + } ).to.throw( CKEditorError, /rootattribute-operation-attribute-exists/ ); + } ); } ); it( 'should create a RootAttributeOperation with the same parameters when cloned', () => { @@ -299,7 +301,7 @@ describe( 'RootAttributeOperation', () => { expect( () => { RootAttributeOperation.fromJSON( serialized, doc ); - } ).to.throw( CKEditorError, /rootattribute-operation-fromjson-no-roo/ ); + } ).to.throw( CKEditorError, /rootattribute-operation-fromjson-no-root/ ); } ); } ); } ); From 6779e01baf2d57602d3d8c1f812d135b8d6372b8 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Wed, 13 Dec 2017 14:18:58 +0100 Subject: [PATCH 166/724] Changed: `view.TreeWalker` should always return `view.TextProxy`. --- src/view/domconverter.js | 2 +- src/view/treewalker.js | 6 +++-- tests/view/treewalker.js | 51 +++++++++++++++++++++++++++++++++++----- 3 files changed, 50 insertions(+), 9 deletions(-) diff --git a/src/view/domconverter.js b/src/view/domconverter.js index 82ca210ce..1ce7b596a 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -1036,7 +1036,7 @@ export default class DomConverter { // ViewContainerElement is found on a way to next ViewText node, so given `node` was first/last // text node in its container element. return null; - } else if ( value.item.is( 'text' ) ) { + } else if ( value.item.is( 'textProxy' ) ) { // Found a text node in the same container element. return value.item; } diff --git a/src/view/treewalker.js b/src/view/treewalker.js index 838f09280..5a22c8a12 100644 --- a/src/view/treewalker.js +++ b/src/view/treewalker.js @@ -236,7 +236,7 @@ export default class TreeWalker { return this._next(); } else { let charactersCount = node.data.length; - let item = node; + let item; // If text stick out of walker range, we need to cut it and wrap by TextProxy. if ( node == this._boundaryEndParent ) { @@ -244,6 +244,7 @@ export default class TreeWalker { item = new TextProxy( node, 0, charactersCount ); position = Position.createAfter( item ); } else { + item = new TextProxy( node, 0, node.data.length ); // If not just keep moving forward. position.offset++; } @@ -347,7 +348,7 @@ export default class TreeWalker { return this._previous(); } else { let charactersCount = node.data.length; - let item = node; + let item; // If text stick out of walker range, we need to cut it and wrap by TextProxy. if ( node == this._boundaryStartParent ) { @@ -357,6 +358,7 @@ export default class TreeWalker { charactersCount = item.data.length; position = Position.createBefore( item ); } else { + item = new TextProxy( node, 0, node.data.length ); // If not just keep moving backward. position.offset--; } diff --git a/tests/view/treewalker.js b/tests/view/treewalker.js index 84456290e..4f202e24f 100644 --- a/tests/view/treewalker.js +++ b/tests/view/treewalker.js @@ -1005,14 +1005,53 @@ describe( 'TreeWalker', () => { const b = new AttributeElement( 'b', null, bar ); const docFrag = new DocumentFragment( [ p, b ] ); - const iterator = new TreeWalker( { - startPosition: new Position( docFrag, 0 ), - ignoreElementEnd: true - } ); + const expected = [ + { + type: 'elementStart', + item: p, + previousPosition: new Position( docFrag, 0 ), + nextPosition: new Position( p, 0 ) + }, + { + type: 'text', + text: 'foo', + previousPosition: new Position( p, 0 ), + nextPosition: new Position( p, 1 ) + }, + { + type: 'elementEnd', + item: p, + previousPosition: new Position( p, 1 ), + nextPosition: new Position( docFrag, 1 ) + }, + { + type: 'elementStart', + item: b, + previousPosition: new Position( docFrag, 1 ), + nextPosition: new Position( b, 0 ) + }, + { + type: 'text', + text: 'bar', + previousPosition: new Position( b, 0 ), + nextPosition: new Position( b, 1 ) + }, + { + type: 'elementEnd', + item: b, + previousPosition: new Position( b, 1 ), + nextPosition: new Position( docFrag, 2 ) + } + ]; + + const iterator = new TreeWalker( { boundaries: Range.createIn( docFrag ) } ); + let i = 0; - const nodes = Array.from( iterator ).map( step => step.item ); + for ( const value of iterator ) { + expectValue( value, expected[ i++ ] ); + } - expect( nodes ).to.deep.equal( [ p, foo, b, bar ] ); + expect( i ).to.equal( expected.length ); } ); describe( 'skip', () => { From aba9f63016bcb65ee13b9fda93a09bc0608f26fa Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Wed, 13 Dec 2017 14:19:13 +0100 Subject: [PATCH 167/724] Added: `view.TextProxy#offsetSize` property. --- src/view/range.js | 4 +++- src/view/textproxy.js | 7 +++++++ tests/view/textproxy.js | 6 ++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/view/range.js b/src/view/range.js index 991b69340..8468e4808 100644 --- a/src/view/range.js +++ b/src/view/range.js @@ -438,7 +438,9 @@ export default class Range { * @returns {module:engine/view/range~Range} */ static createOn( item ) { - return this.createFromPositionAndShift( Position.createBefore( item ), 1 ); + const size = item.is( 'textProxy' ) ? item.offsetSize : 1; + + return this.createFromPositionAndShift( Position.createBefore( item ), size ); } /** diff --git a/src/view/textproxy.js b/src/view/textproxy.js index 5a48c235f..cb5483ece 100644 --- a/src/view/textproxy.js +++ b/src/view/textproxy.js @@ -84,6 +84,13 @@ export default class TextProxy { this.offsetInText = offsetInText; } + /** + * @inheritDoc + */ + get offsetSize() { + return this.data.length; + } + /** * Flag indicating whether `TextProxy` instance covers only part of the original {@link module:engine/view/text~Text text node} * (`true`) or the whole text node (`false`). diff --git a/tests/view/textproxy.js b/tests/view/textproxy.js index f7c44346d..5d549c15a 100644 --- a/tests/view/textproxy.js +++ b/tests/view/textproxy.js @@ -78,6 +78,12 @@ describe( 'TextProxy', () => { } ); } ); + describe( 'offsetSize', () => { + it( 'should be equal to the number of characters in text proxy', () => { + expect( textProxy.offsetSize ).to.equal( 3 ); + } ); + } ); + describe( 'getDocument', () => { it( 'should return null if any parent has not set Document', () => { expect( textProxy.document ).to.be.null; From af329a97b8256300335871bfa59d262dbfce64e7 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Wed, 13 Dec 2017 14:20:33 +0100 Subject: [PATCH 168/724] Tests: Changed marker's background color to make the test more useful. --- tests/manual/highlight.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/manual/highlight.html b/tests/manual/highlight.html index 9127190da..df65f02e5 100644 --- a/tests/manual/highlight.html +++ b/tests/manual/highlight.html @@ -1,14 +1,14 @@ +

This is an editor instance.

diff --git a/tests/manual/tickets/721/1.js b/tests/manual/tickets/721/1.js index 8e3946c69..1a5c1c7e7 100644 --- a/tests/manual/tickets/721/1.js +++ b/tests/manual/tickets/721/1.js @@ -59,7 +59,8 @@ ClassicEditor setData( editor.model, 'foo[]' + - 'bar' + 'bar' + + 'bom' ); } ) .catch( err => { diff --git a/tests/manual/tickets/721/1.md b/tests/manual/tickets/721/1.md index de8d353bf..00425e7c0 100644 --- a/tests/manual/tickets/721/1.md +++ b/tests/manual/tickets/721/1.md @@ -1,11 +1,16 @@ ## Renderer should handle nested editables [FF] ckeditor5#721 +### TC1 + 1. Put the caret in the first paragraph and type something. -1. Put the caret inside the widget (where is `bar` already). -1. Click `Undo`. +1. Put the caret inside the widget (in "bar"). +1. Click "Undo" or press Ctrl+Z (check both). **Expected**: No error in the console. +### TC2 + +Try the same TC as above but use both nested editables. See if the focus is correctly moved between them. From 3b2737e4475b805a49af0919e2f16e9ef04f8a4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Tue, 13 Feb 2018 16:35:49 +0100 Subject: [PATCH 547/724] Moved tests to a directory which indicates that this is ckeditor5#721. --- tests/manual/tickets/{721 => ckeditor5-721}/1.html | 0 tests/manual/tickets/{721 => ckeditor5-721}/1.js | 0 tests/manual/tickets/{721 => ckeditor5-721}/1.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename tests/manual/tickets/{721 => ckeditor5-721}/1.html (100%) rename tests/manual/tickets/{721 => ckeditor5-721}/1.js (100%) rename tests/manual/tickets/{721 => ckeditor5-721}/1.md (100%) diff --git a/tests/manual/tickets/721/1.html b/tests/manual/tickets/ckeditor5-721/1.html similarity index 100% rename from tests/manual/tickets/721/1.html rename to tests/manual/tickets/ckeditor5-721/1.html diff --git a/tests/manual/tickets/721/1.js b/tests/manual/tickets/ckeditor5-721/1.js similarity index 100% rename from tests/manual/tickets/721/1.js rename to tests/manual/tickets/ckeditor5-721/1.js diff --git a/tests/manual/tickets/721/1.md b/tests/manual/tickets/ckeditor5-721/1.md similarity index 100% rename from tests/manual/tickets/721/1.md rename to tests/manual/tickets/ckeditor5-721/1.md From ad65a63fa901a250d208aaff1d7056e7e2bc34c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 16:57:29 +0100 Subject: [PATCH 548/724] Using writer to set class on view element. --- src/conversion/downcast-converters.js | 11 +---- src/view/element.js | 31 +++++++------ src/view/placeholder.js | 4 +- src/view/writer.js | 6 ++- tests/conversion/downcast-converters.js | 4 +- .../downcast-selection-converters.js | 2 +- tests/conversion/viewconsumable.js | 2 +- tests/view/element.js | 44 +++++++++---------- tests/view/matcher.js | 8 ++-- 9 files changed, 57 insertions(+), 55 deletions(-) diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index 95cf71c43..5d2690167 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -386,13 +386,7 @@ function _createViewElementFromDefinition( viewElementDefinition, ViewElementCla } if ( viewElementDefinition.class ) { - const classes = viewElementDefinition.class; - - if ( typeof classes == 'string' ) { - element.addClass( classes ); - } else { - element.addClass( ...classes ); - } + element._addClass( viewElementDefinition.class ); } return element; @@ -1011,8 +1005,7 @@ export function createViewElementFromHighlightDescriptor( descriptor ) { const viewElement = new HighlightAttributeElement( 'span', descriptor.attributes ); if ( descriptor.class ) { - const cssClasses = Array.isArray( descriptor.class ) ? descriptor.class : [ descriptor.class ]; - viewElement.addClass( ...cssClasses ); + viewElement._addClass( descriptor.class ); } if ( descriptor.priority ) { diff --git a/src/view/element.js b/src/view/element.js index 841138a3f..70009d79b 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -419,20 +419,6 @@ export default class Element extends Node { return true; } - /** - * Adds specified class. - * - * element.addClass( 'foo' ); // Adds 'foo' class. - * element.addClass( 'foo', 'bar' ); // Adds 'foo' and 'bar' classes. - * - * @param {...String} className - * @fires module:engine/view/node~Node#change - */ - addClass( ...className ) { - this._fireChange( 'attributes', this ); - className.forEach( name => this._classes.add( name ) ); - } - /** * Removes specified class. * @@ -713,6 +699,23 @@ export default class Element extends Node { return this._attrs.delete( key ); } + /** + * Adds specified class. + * + * element._addClass( 'foo' ); // Adds 'foo' class. + * element._addClass( [ 'foo', 'bar' ] ); // Adds 'foo' and 'bar' classes. + * + * @protected + * @param {Array.|String} className + * @fires module:engine/view/node~Node#change + */ + _addClass( className ) { + this._fireChange( 'attributes', this ); + + className = Array.isArray( className ) ? className : [ className ]; + className.forEach( name => this._classes.add( name ) ); + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * diff --git a/src/view/placeholder.js b/src/view/placeholder.js index 3e42cb917..538b97134 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -108,14 +108,14 @@ function updateSinglePlaceholder( element, checkFunction ) { // If element is empty and editor is blurred. if ( !document.isFocused && isEmptyish ) { - element.addClass( 'ck-placeholder' ); + element._addClass( 'ck-placeholder' ); return; } // It there are no child elements and selection is not placed inside element. if ( isEmptyish && anchor && anchor.parent !== element ) { - element.addClass( 'ck-placeholder' ); + element._addClass( 'ck-placeholder' ); } else { element.removeClass( 'ck-placeholder' ); } diff --git a/src/view/writer.js b/src/view/writer.js index 563d5499e..9adad3e6a 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -190,6 +190,10 @@ export default class Writer { element._removeAttribute( key ); } + addClass( className, element ) { + element._addClass( className ); + } + /** * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside * up to a container element. @@ -1045,7 +1049,7 @@ export default class Writer { for ( const key of wrapper.getClassNames() ) { if ( !toWrap.hasClass( key ) ) { - toWrap.addClass( key ); + this.addClass( key, toWrap ); } } diff --git a/tests/conversion/downcast-converters.js b/tests/conversion/downcast-converters.js index 435de3fe5..50b37e13f 100644 --- a/tests/conversion/downcast-converters.js +++ b/tests/conversion/downcast-converters.js @@ -1303,7 +1303,9 @@ describe( 'downcast-converters', () => { const viewContainer = new ViewContainerElement( 'div' ); viewContainer.setCustomProperty( 'addHighlight', ( element, descriptor ) => { - element.addClass( descriptor.class ); + controller.view.change( writer => { + writer.addClass( descriptor.class, element ); + } ); } ); viewContainer.setCustomProperty( 'removeHighlight', element => { diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index d3caad96a..48c2c81c2 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -523,7 +523,7 @@ describe( 'downcast-selection-converters', () => { consumable.consume( selection, 'selection' ); const viewNode = conversionApi.mapper.toViewElement( node ); - viewNode.addClass( 'selected' ); + conversionApi.writer.addClass( 'selected', viewNode ); } } } ); diff --git a/tests/conversion/viewconsumable.js b/tests/conversion/viewconsumable.js index f578d7058..2bb0d0d79 100644 --- a/tests/conversion/viewconsumable.js +++ b/tests/conversion/viewconsumable.js @@ -487,7 +487,7 @@ describe( 'ViewConsumable', () => { } ); it( 'should add all classes', () => { - el.addClass( 'foo', 'bar', 'baz' ); + el._addClass( [ 'foo', 'bar', 'baz' ] ); const consumables = ViewConsumable.consumablesFromElement( el ); expect( consumables.class.length ).to.equal( 3 ); diff --git a/tests/view/element.js b/tests/view/element.js index ca9280519..8c9364aee 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -174,7 +174,7 @@ describe( 'Element', () => { it( 'should clone class attribute', () => { const el = new Element( 'p', { foo: 'bar' } ); - el.addClass( 'baz', 'qux' ); + el._addClass( [ 'baz', 'qux' ] ); const clone = el.clone( false ); expect( clone ).to.not.equal( el ); @@ -261,10 +261,10 @@ describe( 'Element', () => { const el3 = new Element( 'p' ); const el4 = new Element( 'p' ); - el1.addClass( 'foo', 'bar' ); - el2.addClass( 'bar', 'foo' ); - el3.addClass( 'baz' ); - el4.addClass( 'baz', 'bar' ); + el1._addClass( [ 'foo', 'bar' ] ); + el2._addClass( [ 'bar', 'foo' ] ); + el3._addClass( 'baz' ); + el4._addClass( [ 'baz', 'bar' ] ); expect( el1.isSimilar( el2 ) ).to.be.true; expect( el1.isSimilar( el3 ) ).to.be.false; @@ -492,7 +492,7 @@ describe( 'Element', () => { } ); it( 'should return class attribute', () => { - el.addClass( 'foo', 'bar' ); + el._addClass( [ 'foo', 'bar' ] ); expect( el.getAttribute( 'class' ) ).to.equal( 'foo bar' ); } ); @@ -524,7 +524,7 @@ describe( 'Element', () => { it( 'should return class and style attribute', () => { el._setAttribute( 'class', 'abc' ); el._setAttribute( 'style', 'width:20px;' ); - el.addClass( 'xyz' ); + el._addClass( 'xyz' ); el.setStyle( 'font-weight', 'bold' ); expect( Array.from( el.getAttributes() ) ).to.deep.equal( [ @@ -543,7 +543,7 @@ describe( 'Element', () => { it( 'should return true if element has class attribute', () => { expect( el.hasAttribute( 'class' ) ).to.be.false; - el.addClass( 'foo' ); + el._addClass( 'foo' ); expect( el.hasAttribute( 'class' ) ).to.be.true; } ); @@ -571,7 +571,7 @@ describe( 'Element', () => { } ); it( 'should return class key', () => { - el.addClass( 'foo' ); + el._addClass( 'foo' ); el._setAttribute( 'bar', true ); const expected = [ 'class', 'bar' ]; let i = 0; @@ -619,7 +619,7 @@ describe( 'Element', () => { } ); it( 'should remove class attribute', () => { - el.addClass( 'foo', 'bar' ); + el._addClass( [ 'foo', 'bar' ] ); const el2 = new Element( 'p' ); const removed1 = el._removeAttribute( 'class' ); const removed2 = el2._removeAttribute( 'class' ); @@ -654,9 +654,9 @@ describe( 'Element', () => { el = new Element( 'p' ); } ); - describe( 'addClass', () => { + describe( '_addClass()', () => { it( 'should add single class', () => { - el.addClass( 'one' ); + el._addClass( 'one' ); expect( el._classes.has( 'one' ) ).to.be.true; } ); @@ -667,11 +667,11 @@ describe( 'Element', () => { done(); } ); - el.addClass( 'one' ); + el._addClass( 'one' ); } ); it( 'should add multiple classes', () => { - el.addClass( 'one', 'two', 'three' ); + el._addClass( [ 'one', 'two', 'three' ] ); expect( el._classes.has( 'one' ) ).to.be.true; expect( el._classes.has( 'two' ) ).to.be.true; @@ -681,7 +681,7 @@ describe( 'Element', () => { describe( 'removeClass', () => { it( 'should remove single class', () => { - el.addClass( 'one', 'two', 'three' ); + el._addClass( [ 'one', 'two', 'three' ] ); el.removeClass( 'one' ); @@ -691,7 +691,7 @@ describe( 'Element', () => { } ); it( 'should fire change event with attributes type', done => { - el.addClass( 'one' ); + el._addClass( 'one' ); el.once( 'change:attributes', eventInfo => { expect( eventInfo.source ).to.equal( el ); done(); @@ -701,7 +701,7 @@ describe( 'Element', () => { } ); it( 'should remove multiple classes', () => { - el.addClass( 'one', 'two', 'three', 'four' ); + el._addClass( [ 'one', 'two', 'three', 'four' ] ); el.removeClass( 'one', 'two', 'three' ); expect( el._classes.has( 'one' ) ).to.be.false; @@ -713,7 +713,7 @@ describe( 'Element', () => { describe( 'hasClass', () => { it( 'should check if element has a class', () => { - el.addClass( 'one', 'two', 'three' ); + el._addClass( [ 'one', 'two', 'three' ] ); expect( el.hasClass( 'one' ) ).to.be.true; expect( el.hasClass( 'two' ) ).to.be.true; @@ -722,7 +722,7 @@ describe( 'Element', () => { } ); it( 'should check if element has multiple classes', () => { - el.addClass( 'one', 'two', 'three' ); + el._addClass( [ 'one', 'two', 'three' ] ); expect( el.hasClass( 'one', 'two' ) ).to.be.true; expect( el.hasClass( 'three', 'two' ) ).to.be.true; @@ -734,7 +734,7 @@ describe( 'Element', () => { describe( 'getClassNames', () => { it( 'should return iterator with all class names', () => { const names = [ 'one', 'two', 'three' ]; - el.addClass( ...names ); + el._addClass( names ); const iterator = el.getClassNames(); let i = 0; @@ -1019,7 +1019,7 @@ describe( 'Element', () => { it( 'should return classes in sorted order', () => { const el = new Element( 'fruit' ); - el.addClass( 'banana', 'lemon', 'apple' ); + el._addClass( [ 'banana', 'lemon', 'apple' ] ); expect( el.getIdentity() ).to.equal( 'fruit class="apple,banana,lemon"' ); } ); @@ -1049,7 +1049,7 @@ describe( 'Element', () => { style: 'text-align:center;border-radius:10px' } ); - el.addClass( 'three', 'two', 'one' ); + el._addClass( [ 'three', 'two', 'one' ] ); expect( el.getIdentity() ).to.equal( 'baz class="one,three,two" style="border-radius:10px;text-align:center" bar="two" foo="one"' diff --git a/tests/view/matcher.js b/tests/view/matcher.js index af62c219d..99c94449e 100644 --- a/tests/view/matcher.js +++ b/tests/view/matcher.js @@ -306,7 +306,7 @@ describe( 'Matcher', () => { }; const matcher = new Matcher( pattern ); const el = new Element( 'a' ); - el.addClass( 'foo', 'bar', 'baz' ); + el._addClass( [ 'foo', 'bar', 'baz' ] ); const result = matcher.match( el ); expect( result ).to.be.an( 'object' ); @@ -376,9 +376,9 @@ describe( 'Matcher', () => { const el2 = new Element( 'p' ); const el3 = new Element( 'p' ); - el1.addClass( 'red-foreground' ); - el2.addClass( 'red-background' ); - el3.addClass( 'blue-text' ); + el1._addClass( 'red-foreground' ); + el2._addClass( 'red-background' ); + el3._addClass( 'blue-text' ); const result = matcher.matchAll( el1, el2, el3 ); expect( result ).to.be.an( 'array' ); From d1d022c6ba30a6d4ffb7296fb6e14cea8aa791b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 17:19:43 +0100 Subject: [PATCH 549/724] Using writer to remove class from view element. --- src/view/element.js | 30 ++++++++++++++++-------------- src/view/placeholder.js | 6 +++--- src/view/writer.js | 6 +++++- tests/view/element.js | 8 ++++---- 4 files changed, 28 insertions(+), 22 deletions(-) diff --git a/src/view/element.js b/src/view/element.js index 70009d79b..956275d06 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -419,20 +419,6 @@ export default class Element extends Node { return true; } - /** - * Removes specified class. - * - * element.removeClass( 'foo' ); // Removes 'foo' class. - * element.removeClass( 'foo', 'bar' ); // Removes both 'foo' and 'bar' classes. - * - * @param {...String} className - * @fires module:engine/view/node~Node#change - */ - removeClass( ...className ) { - this._fireChange( 'attributes', this ); - className.forEach( name => this._classes.delete( name ) ); - } - /** * Returns true if class is present. * If more then one class is provided - returns true only when all classes are present. @@ -716,6 +702,22 @@ export default class Element extends Node { className.forEach( name => this._classes.add( name ) ); } + /** + * Removes specified class. + * + * element._removeClass( 'foo' ); // Removes 'foo' class. + * element._removeClass( [ 'foo', 'bar' ] ); // Removes both 'foo' and 'bar' classes. + * + * @param {Array.|String} className + * @fires module:engine/view/node~Node#change + */ + _removeClass( className ) { + this._fireChange( 'attributes', this ); + + className = Array.isArray( className ) ? className : [ className ]; + className.forEach( name => this._classes.delete( name ) ); + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * diff --git a/src/view/placeholder.js b/src/view/placeholder.js index 538b97134..80c5e61bb 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -59,7 +59,7 @@ export function attachPlaceholder( view, element, placeholderText, checkFunction export function detachPlaceholder( element ) { const document = element.document; - element.removeClass( 'ck-placeholder' ); + element._removeClass( 'ck-placeholder' ); element._removeAttribute( 'data-placeholder' ); if ( documentPlaceholders.has( document ) ) { @@ -97,7 +97,7 @@ function updateSinglePlaceholder( element, checkFunction ) { // If checkFunction is provided and returns false - remove placeholder. if ( checkFunction && !checkFunction() ) { - element.removeClass( 'ck-placeholder' ); + element._removeClass( 'ck-placeholder' ); return; } @@ -117,6 +117,6 @@ function updateSinglePlaceholder( element, checkFunction ) { if ( isEmptyish && anchor && anchor.parent !== element ) { element._addClass( 'ck-placeholder' ); } else { - element.removeClass( 'ck-placeholder' ); + element._removeClass( 'ck-placeholder' ); } } diff --git a/src/view/writer.js b/src/view/writer.js index 9adad3e6a..c17d8419f 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -194,6 +194,10 @@ export default class Writer { element._addClass( className ); } + removeClass( className, element ) { + element._removeClass( className ); + } + /** * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside * up to a container element. @@ -1109,7 +1113,7 @@ export default class Writer { } // Remove all wrapper's classes from unwrapped element. - toUnwrap.removeClass( ...wrapper.getClassNames() ); + this.removeClass( Array.from( wrapper.getClassNames() ), toUnwrap ); // Remove all wrapper's styles from unwrapped element. toUnwrap.removeStyle( ...wrapper.getStyleNames() ); diff --git a/tests/view/element.js b/tests/view/element.js index 8c9364aee..11609bc50 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -679,11 +679,11 @@ describe( 'Element', () => { } ); } ); - describe( 'removeClass', () => { + describe( '_removeClass()', () => { it( 'should remove single class', () => { el._addClass( [ 'one', 'two', 'three' ] ); - el.removeClass( 'one' ); + el._removeClass( 'one' ); expect( el._classes.has( 'one' ) ).to.be.false; expect( el._classes.has( 'two' ) ).to.be.true; @@ -697,12 +697,12 @@ describe( 'Element', () => { done(); } ); - el.removeClass( 'one' ); + el._removeClass( 'one' ); } ); it( 'should remove multiple classes', () => { el._addClass( [ 'one', 'two', 'three', 'four' ] ); - el.removeClass( 'one', 'two', 'three' ); + el._removeClass( [ 'one', 'two', 'three' ] ); expect( el._classes.has( 'one' ) ).to.be.false; expect( el._classes.has( 'two' ) ).to.be.false; From 8c8a4c5c15540bd7ebd807836be1cfc605a7bdac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 17:28:11 +0100 Subject: [PATCH 550/724] Using writer to set styles to view element. --- src/conversion/downcast-converters.js | 2 +- src/view/element.js | 55 ++++++++++++++------------- src/view/writer.js | 6 ++- tests/conversion/viewconsumable.js | 2 +- tests/view/element.js | 54 +++++++++++++------------- tests/view/matcher.js | 2 +- 6 files changed, 63 insertions(+), 58 deletions(-) diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index 5d2690167..a64bcd526 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -382,7 +382,7 @@ function _createViewElementFromDefinition( viewElementDefinition, ViewElementCla const element = new ViewElementClass( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) ); if ( viewElementDefinition.style ) { - element.setStyle( viewElementDefinition.style ); + element._setStyle( viewElementDefinition.style ); } if ( viewElementDefinition.class ) { diff --git a/src/view/element.js b/src/view/element.js index 956275d06..321ef34af 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -447,33 +447,6 @@ export default class Element extends Node { return this._classes.keys(); } - /** - * Adds style to the element. - * - * element.setStyle( 'color', 'red' ); - * element.setStyle( { - * color: 'red', - * position: 'fixed' - * } ); - * - * @param {String|Object} property Property name or object with key - value pairs. - * @param {String} [value] Value to set. This parameter is ignored if object is provided as the first parameter. - * @fires module:engine/view/node~Node#change - */ - setStyle( property, value ) { - this._fireChange( 'attributes', this ); - - if ( isPlainObject( property ) ) { - const keys = Object.keys( property ); - - for ( const key of keys ) { - this._styles.set( key, property[ key ] ); - } - } else { - this._styles.set( property, value ); - } - } - /** * Returns style value for given property. * Undefined is returned if style does not exist. @@ -718,6 +691,34 @@ export default class Element extends Node { className.forEach( name => this._classes.delete( name ) ); } + /** + * Adds style to the element. + * + * element._setStyle( 'color', 'red' ); + * element._setStyle( { + * color: 'red', + * position: 'fixed' + * } ); + * + * @protected + * @param {String|Object} property Property name or object with key - value pairs. + * @param {String} [value] Value to set. This parameter is ignored if object is provided as the first parameter. + * @fires module:engine/view/node~Node#change + */ + _setStyle( property, value ) { + this._fireChange( 'attributes', this ); + + if ( isPlainObject( property ) ) { + const keys = Object.keys( property ); + + for ( const key of keys ) { + this._styles.set( key, property[ key ] ); + } + } else { + this._styles.set( property, value ); + } + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * diff --git a/src/view/writer.js b/src/view/writer.js index c17d8419f..898954e68 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -198,6 +198,10 @@ export default class Writer { element._removeClass( className ); } + setStyle( property, value, element ) { + element._setStyle( property, value ); + } + /** * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside * up to a container element. @@ -1047,7 +1051,7 @@ export default class Writer { for ( const key of wrapper.getStyleNames() ) { if ( !toWrap.hasStyle( key ) ) { - toWrap.setStyle( key, wrapper.getStyle( key ) ); + this.setStyle( key, wrapper.getStyle( key ), toWrap ); } } diff --git a/tests/conversion/viewconsumable.js b/tests/conversion/viewconsumable.js index 2bb0d0d79..9ba4ff3c1 100644 --- a/tests/conversion/viewconsumable.js +++ b/tests/conversion/viewconsumable.js @@ -500,7 +500,7 @@ describe( 'ViewConsumable', () => { } ); it( 'should add all styles', () => { - el.setStyle( { + el._setStyle( { color: 'red', position: 'absolute' } ); diff --git a/tests/view/element.js b/tests/view/element.js index 11609bc50..5374a9e40 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -277,13 +277,13 @@ describe( 'Element', () => { const el3 = new Element( 'p' ); const el4 = new Element( 'p' ); - el1.setStyle( 'color', 'red' ); - el1.setStyle( 'top', '10px' ); - el2.setStyle( 'top', '20px' ); - el3.setStyle( 'top', '10px' ); - el3.setStyle( 'color', 'red' ); - el4.setStyle( 'color', 'blue' ); - el4.setStyle( 'top', '10px' ); + el1._setStyle( 'color', 'red' ); + el1._setStyle( 'top', '10px' ); + el2._setStyle( 'top', '20px' ); + el3._setStyle( 'top', '10px' ); + el3._setStyle( 'color', 'red' ); + el4._setStyle( 'color', 'blue' ); + el4._setStyle( 'top', '10px' ); expect( el1.isSimilar( el2 ) ).to.be.false; expect( el1.isSimilar( el3 ) ).to.be.true; @@ -472,8 +472,8 @@ describe( 'Element', () => { } ); it( 'should replace all styles', () => { - el.setStyle( 'color', 'red' ); - el.setStyle( 'top', '10px' ); + el._setStyle( 'color', 'red' ); + el._setStyle( 'top', '10px' ); el._setAttribute( 'style', 'border:none' ); expect( el.hasStyle( 'color' ) ).to.be.false; @@ -502,8 +502,8 @@ describe( 'Element', () => { } ); it( 'should return style attribute', () => { - el.setStyle( 'color', 'red' ); - el.setStyle( 'top', '10px' ); + el._setStyle( 'color', 'red' ); + el._setStyle( 'top', '10px' ); expect( el.getAttribute( 'style' ) ).to.equal( 'color:red;top:10px;' ); } ); @@ -525,7 +525,7 @@ describe( 'Element', () => { el._setAttribute( 'class', 'abc' ); el._setAttribute( 'style', 'width:20px;' ); el._addClass( 'xyz' ); - el.setStyle( 'font-weight', 'bold' ); + el._setStyle( 'font-weight', 'bold' ); expect( Array.from( el.getAttributes() ) ).to.deep.equal( [ [ 'class', 'abc xyz' ], [ 'style', 'width:20px;font-weight:bold;' ] @@ -549,7 +549,7 @@ describe( 'Element', () => { it( 'should return true if element has style attribute', () => { expect( el.hasAttribute( 'style' ) ).to.be.false; - el.setStyle( 'border', '1px solid red' ); + el._setStyle( 'border', '1px solid red' ); expect( el.hasAttribute( 'style' ) ).to.be.true; } ); } ); @@ -583,7 +583,7 @@ describe( 'Element', () => { } ); it( 'should return style key', () => { - el.setStyle( 'color', 'black' ); + el._setStyle( 'color', 'black' ); el._setAttribute( 'bar', true ); const expected = [ 'style', 'bar' ]; let i = 0; @@ -632,8 +632,8 @@ describe( 'Element', () => { } ); it( 'should remove style attribute', () => { - el.setStyle( 'color', 'red' ); - el.setStyle( 'position', 'fixed' ); + el._setStyle( 'color', 'red' ); + el._setStyle( 'position', 'fixed' ); const el2 = new Element( 'p' ); const removed1 = el._removeAttribute( 'style' ); const removed2 = el2._removeAttribute( 'style' ); @@ -752,9 +752,9 @@ describe( 'Element', () => { el = new Element( 'p' ); } ); - describe( 'setStyle', () => { + describe( '_setStyle()', () => { it( 'should set element style', () => { - el.setStyle( 'color', 'red' ); + el._setStyle( 'color', 'red' ); expect( el._styles.has( 'color' ) ).to.be.true; expect( el._styles.get( 'color' ) ).to.equal( 'red' ); @@ -766,11 +766,11 @@ describe( 'Element', () => { done(); } ); - el.setStyle( 'color', 'red' ); + el._setStyle( 'color', 'red' ); } ); it( 'should set multiple styles by providing an object', () => { - el.setStyle( { + el._setStyle( { color: 'red', position: 'fixed' } ); @@ -784,7 +784,7 @@ describe( 'Element', () => { describe( 'getStyle', () => { it( 'should get style', () => { - el.setStyle( { + el._setStyle( { color: 'red', border: '1px solid red' } ); @@ -798,7 +798,7 @@ describe( 'Element', () => { it( 'should return iterator with all style names', () => { const names = [ 'color', 'position' ]; - el.setStyle( { + el._setStyle( { color: 'red', position: 'absolute' } ); @@ -814,14 +814,14 @@ describe( 'Element', () => { describe( 'hasStyle', () => { it( 'should check if element has a style', () => { - el.setStyle( 'padding-top', '10px' ); + el._setStyle( 'padding-top', '10px' ); expect( el.hasStyle( 'padding-top' ) ).to.be.true; expect( el.hasStyle( 'padding-left' ) ).to.be.false; } ); it( 'should check if element has multiple styles', () => { - el.setStyle( { + el._setStyle( { 'padding-top': '10px', 'margin-left': '10px', 'color': '10px;' @@ -835,14 +835,14 @@ describe( 'Element', () => { describe( 'removeStyle', () => { it( 'should remove style', () => { - el.setStyle( 'padding-top', '10px' ); + el._setStyle( 'padding-top', '10px' ); el.removeStyle( 'padding-top' ); expect( el.hasStyle( 'padding-top' ) ).to.be.false; } ); it( 'should fire change event with attributes type', done => { - el.setStyle( 'color', 'red' ); + el._setStyle( 'color', 'red' ); el.once( 'change:attributes', eventInfo => { expect( eventInfo.source ).to.equal( el ); done(); @@ -852,7 +852,7 @@ describe( 'Element', () => { } ); it( 'should remove multiple styles', () => { - el.setStyle( { + el._setStyle( { 'padding-top': '10px', 'margin-top': '10px', 'color': 'red' diff --git a/tests/view/matcher.js b/tests/view/matcher.js index 99c94449e..9d222d476 100644 --- a/tests/view/matcher.js +++ b/tests/view/matcher.js @@ -328,7 +328,7 @@ describe( 'Matcher', () => { }; const matcher = new Matcher( pattern ); const el = new Element( 'a' ); - el.setStyle( { + el._setStyle( { color: 'red', position: 'relative' } ); From c4c4d3dfa9c7087bc59d43897f0093a68675321c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 18:40:50 +0100 Subject: [PATCH 551/724] Using writer to remove styles from view element. --- src/view/element.js | 31 +++++++++++++++++-------------- src/view/writer.js | 6 +++++- tests/view/element.js | 8 ++++---- 3 files changed, 26 insertions(+), 19 deletions(-) diff --git a/src/view/element.js b/src/view/element.js index 321ef34af..d5f962160 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -486,20 +486,6 @@ export default class Element extends Node { return true; } - /** - * Removes specified style. - * - * element.removeStyle( 'color' ); // Removes 'color' style. - * element.removeStyle( 'color', 'border-top' ); // Removes both 'color' and 'border-top' styles. - * - * @param {...String} property - * @fires module:engine/view/node~Node#change - */ - removeStyle( ...property ) { - this._fireChange( 'attributes', this ); - property.forEach( name => this._styles.delete( name ) ); - } - /** * Returns ancestor element that match specified pattern. * Provided patterns should be compatible with {@link module:engine/view/matcher~Matcher Matcher} as it is used internally. @@ -719,6 +705,23 @@ export default class Element extends Node { } } + /** + * Removes specified style. + * + * element._removeStyle( 'color' ); // Removes 'color' style. + * element._removeStyle( [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles. + * + * @protected + * @param {Array.|String} property + * @fires module:engine/view/node~Node#change + */ + _removeStyle( property ) { + this._fireChange( 'attributes', this ); + + property = Array.isArray( property ) ? property : [ property ]; + property.forEach( name => this._styles.delete( name ) ); + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * diff --git a/src/view/writer.js b/src/view/writer.js index 898954e68..ad206b034 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -202,6 +202,10 @@ export default class Writer { element._setStyle( property, value ); } + removeStyle( property, element ) { + element._removeStyle( property ); + } + /** * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside * up to a container element. @@ -1120,7 +1124,7 @@ export default class Writer { this.removeClass( Array.from( wrapper.getClassNames() ), toUnwrap ); // Remove all wrapper's styles from unwrapped element. - toUnwrap.removeStyle( ...wrapper.getStyleNames() ); + this.removeStyle( Array.from( wrapper.getStyleNames() ), toUnwrap ); return true; } diff --git a/tests/view/element.js b/tests/view/element.js index 5374a9e40..22b69a511 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -833,10 +833,10 @@ describe( 'Element', () => { } ); } ); - describe( 'removeStyle', () => { + describe( '_removeStyle()', () => { it( 'should remove style', () => { el._setStyle( 'padding-top', '10px' ); - el.removeStyle( 'padding-top' ); + el._removeStyle( 'padding-top' ); expect( el.hasStyle( 'padding-top' ) ).to.be.false; } ); @@ -848,7 +848,7 @@ describe( 'Element', () => { done(); } ); - el.removeStyle( 'color' ); + el._removeStyle( 'color' ); } ); it( 'should remove multiple styles', () => { @@ -857,7 +857,7 @@ describe( 'Element', () => { 'margin-top': '10px', 'color': 'red' } ); - el.removeStyle( 'padding-top', 'margin-top' ); + el._removeStyle( [ 'padding-top', 'margin-top' ] ); expect( el.hasStyle( 'padding-top' ) ).to.be.false; expect( el.hasStyle( 'margin-top' ) ).to.be.false; From 4041eb09517384220467f1904dd014ee0ddb9ecb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 18:52:04 +0100 Subject: [PATCH 552/724] Using writer to set custom properties to view element. --- src/conversion/downcast-converters.js | 2 +- src/view/editableelement.js | 2 +- src/view/element.js | 23 ++++++++++++----------- src/view/rooteditableelement.js | 2 +- src/view/writer.js | 4 ++++ tests/conversion/downcast-converters.js | 8 ++++---- tests/conversion/downcastdispatcher.js | 4 ++-- tests/view/element.js | 18 +++++++++--------- 8 files changed, 34 insertions(+), 29 deletions(-) diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index a64bcd526..a152a6d59 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -1012,7 +1012,7 @@ export function createViewElementFromHighlightDescriptor( descriptor ) { viewElement.priority = descriptor.priority; } - viewElement.setCustomProperty( 'highlightDescriptorId', descriptor.id ); + viewElement._setCustomProperty( 'highlightDescriptorId', descriptor.id ); return viewElement; } diff --git a/src/view/editableelement.js b/src/view/editableelement.js index 7bdb694eb..736316537 100644 --- a/src/view/editableelement.js +++ b/src/view/editableelement.js @@ -74,7 +74,7 @@ export default class EditableElement extends ContainerElement { throw new CKEditorError( 'view-editableelement-document-already-set: View document is already set.' ); } - this.setCustomProperty( documentSymbol, document ); + this._setCustomProperty( documentSymbol, document ); this.bind( 'isReadOnly' ).to( document ); diff --git a/src/view/element.js b/src/view/element.js index d5f962160..3dcc0488d 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -510,17 +510,6 @@ export default class Element extends Node { return null; } - /** - * Sets a custom property. Unlike attributes, custom properties are not rendered to the DOM, - * so they can be used to add special data to elements. - * - * @param {String|Symbol} key - * @param {*} value - */ - setCustomProperty( key, value ) { - this._customProperties.set( key, value ); - } - /** * Returns the custom property value for the given key. * @@ -722,6 +711,18 @@ export default class Element extends Node { property.forEach( name => this._styles.delete( name ) ); } + /** + * Sets a custom property. Unlike attributes, custom properties are not rendered to the DOM, + * so they can be used to add special data to elements. + * + * @protected + * @param {String|Symbol} key + * @param {*} value + */ + _setCustomProperty( key, value ) { + this._customProperties.set( key, value ); + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * diff --git a/src/view/rooteditableelement.js b/src/view/rooteditableelement.js index 438d7d423..20eef430c 100644 --- a/src/view/rooteditableelement.js +++ b/src/view/rooteditableelement.js @@ -53,7 +53,7 @@ export default class RootEditableElement extends EditableElement { } set rootName( rootName ) { - this.setCustomProperty( rootNameSymbol, rootName ); + this._setCustomProperty( rootNameSymbol, rootName ); } /** diff --git a/src/view/writer.js b/src/view/writer.js index ad206b034..4a4abf5de 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -206,6 +206,10 @@ export default class Writer { element._removeStyle( property ); } + setCustomProperty( key, value, element ) { + element._setCustomProperty( key, value ); + } + /** * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside * up to a container element. diff --git a/tests/conversion/downcast-converters.js b/tests/conversion/downcast-converters.js index 50b37e13f..de29d8839 100644 --- a/tests/conversion/downcast-converters.js +++ b/tests/conversion/downcast-converters.js @@ -1302,13 +1302,13 @@ describe( 'downcast-converters', () => { dispatcher.on( 'insert:div', insertElement( () => { const viewContainer = new ViewContainerElement( 'div' ); - viewContainer.setCustomProperty( 'addHighlight', ( element, descriptor ) => { + viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor ) => { controller.view.change( writer => { writer.addClass( descriptor.class, element ); } ); } ); - viewContainer.setCustomProperty( 'removeHighlight', element => { + viewContainer._setCustomProperty( 'removeHighlight', element => { controller.view.change( writer => { writer.setAttribute( 'class', '', element ); } ); @@ -1383,12 +1383,12 @@ describe( 'downcast-converters', () => { dispatcher.on( 'addMarker:marker2', highlightElement( () => null ) ); dispatcher.on( 'removeMarker:marker2', removeHighlight( () => null ) ); - viewDiv.setCustomProperty( 'addHighlight', ( element, descriptor ) => { + viewDiv._setCustomProperty( 'addHighlight', ( element, descriptor ) => { expect( descriptor.priority ).to.equal( 10 ); expect( descriptor.id ).to.equal( 'marker:foo-bar-baz' ); } ); - viewDiv.setCustomProperty( 'removeHighlight', ( element, id ) => { + viewDiv._setCustomProperty( 'removeHighlight', ( element, id ) => { expect( id ).to.equal( 'marker:foo-bar-baz' ); } ); diff --git a/tests/conversion/downcastdispatcher.js b/tests/conversion/downcastdispatcher.js index ab9b13645..bd2045ee2 100644 --- a/tests/conversion/downcastdispatcher.js +++ b/tests/conversion/downcastdispatcher.js @@ -385,8 +385,8 @@ describe( 'DowncastDispatcher', () => { const viewFigure = new ViewContainerElement( 'figure', null, viewCaption ); // Create custom highlight handler mock. - viewFigure.setCustomProperty( 'addHighlight', () => { } ); - viewFigure.setCustomProperty( 'removeHighlight', () => { } ); + viewFigure._setCustomProperty( 'addHighlight', () => { } ); + viewFigure._setCustomProperty( 'removeHighlight', () => { } ); // Create mapper mock. dispatcher.conversionApi.mapper = { diff --git a/tests/view/element.js b/tests/view/element.js index 22b69a511..8efb69567 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -198,8 +198,8 @@ describe( 'Element', () => { it( 'should clone custom properties', () => { const el = new Element( 'p' ); const symbol = Symbol( 'custom' ); - el.setCustomProperty( 'foo', 'bar' ); - el.setCustomProperty( symbol, 'baz' ); + el._setCustomProperty( 'foo', 'bar' ); + el._setCustomProperty( symbol, 'baz' ); const cloned = el.clone(); @@ -964,7 +964,7 @@ describe( 'Element', () => { describe( 'custom properties', () => { it( 'should allow to set and get custom properties', () => { const el = new Element( 'p' ); - el.setCustomProperty( 'foo', 'bar' ); + el._setCustomProperty( 'foo', 'bar' ); expect( el.getCustomProperty( 'foo' ) ).to.equal( 'bar' ); } ); @@ -972,7 +972,7 @@ describe( 'Element', () => { it( 'should allow to add symbol property', () => { const el = new Element( 'p' ); const symbol = Symbol( 'custom' ); - el.setCustomProperty( symbol, 'bar' ); + el._setCustomProperty( symbol, 'bar' ); expect( el.getCustomProperty( symbol ) ).to.equal( 'bar' ); } ); @@ -980,8 +980,8 @@ describe( 'Element', () => { it( 'should allow to remove custom property', () => { const el = new Element( 'foo' ); const symbol = Symbol( 'quix' ); - el.setCustomProperty( 'bar', 'baz' ); - el.setCustomProperty( symbol, 'test' ); + el._setCustomProperty( 'bar', 'baz' ); + el._setCustomProperty( symbol, 'test' ); expect( el.getCustomProperty( 'bar' ) ).to.equal( 'baz' ); expect( el.getCustomProperty( symbol ) ).to.equal( 'test' ); @@ -995,9 +995,9 @@ describe( 'Element', () => { it( 'should allow to iterate over custom properties', () => { const el = new Element( 'p' ); - el.setCustomProperty( 'foo', 1 ); - el.setCustomProperty( 'bar', 2 ); - el.setCustomProperty( 'baz', 3 ); + el._setCustomProperty( 'foo', 1 ); + el._setCustomProperty( 'bar', 2 ); + el._setCustomProperty( 'baz', 3 ); const properties = [ ...el.getCustomProperties() ]; From 01ce914803daddf749541968ae777708aee4de9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 18:56:02 +0100 Subject: [PATCH 553/724] Using writer to remove custom properties from view element. --- src/view/element.js | 21 +++++++++++---------- src/view/writer.js | 4 ++++ tests/view/element.js | 4 ++-- 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/src/view/element.js b/src/view/element.js index 3dcc0488d..210530b74 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -520,16 +520,6 @@ export default class Element extends Node { return this._customProperties.get( key ); } - /** - * Removes the custom property stored under the given key. - * - * @param {String|Symbol} key - * @returns {Boolean} Returns true if property was removed. - */ - removeCustomProperty( key ) { - return this._customProperties.delete( key ); - } - /** * Returns an iterator which iterates over this element's custom properties. * Iterator provides `[ key, value ]` pairs for each stored property. @@ -723,6 +713,17 @@ export default class Element extends Node { this._customProperties.set( key, value ); } + /** + * Removes the custom property stored under the given key. + * + * @protected + * @param {String|Symbol} key + * @returns {Boolean} Returns true if property was removed. + */ + _removeCustomProperty( key ) { + return this._customProperties.delete( key ); + } + /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. * diff --git a/src/view/writer.js b/src/view/writer.js index 4a4abf5de..188b733da 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -210,6 +210,10 @@ export default class Writer { element._setCustomProperty( key, value ); } + removeCustomProperty( key, element ) { + element._removeCustomProperty( key ); + } + /** * Breaks attribute nodes at provided position or at boundaries of provided range. It breaks attribute elements inside * up to a container element. diff --git a/tests/view/element.js b/tests/view/element.js index 8efb69567..b3d995b43 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -986,8 +986,8 @@ describe( 'Element', () => { expect( el.getCustomProperty( 'bar' ) ).to.equal( 'baz' ); expect( el.getCustomProperty( symbol ) ).to.equal( 'test' ); - el.removeCustomProperty( 'bar' ); - el.removeCustomProperty( symbol ); + el._removeCustomProperty( 'bar' ); + el._removeCustomProperty( symbol ); expect( el.getCustomProperty( 'bar' ) ).to.be.undefined; expect( el.getCustomProperty( symbol ) ).to.be.undefined; From cefdba4fa36bfeb4db9b2c578a32d12fc1f1c165 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 21:31:58 +0100 Subject: [PATCH 554/724] AttributeElement priority is now protected. EditableElement document is now protected. --- src/controller/editingcontroller.js | 2 +- src/conversion/downcast-converters.js | 2 +- src/dev-utils/model.js | 2 +- src/dev-utils/view.js | 4 ++-- src/view/attributeelement.js | 15 +++++++++++++-- src/view/editableelement.js | 14 +++++++++++++- src/view/writer.js | 16 +++++++++++----- tests/dev-utils/view.js | 4 ++-- tests/view/_utils/createroot.js | 2 +- tests/view/attributeelement.js | 8 ++++---- tests/view/domconverter/domconverter.js | 2 +- tests/view/editableelement.js | 20 ++++++++++---------- tests/view/node.js | 4 ++-- tests/view/position.js | 2 +- tests/view/rooteditableelement.js | 8 ++++---- tests/view/textproxy.js | 4 ++-- tests/view/view/view.js | 2 +- 17 files changed, 70 insertions(+), 41 deletions(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 56568ef2b..21f0b123d 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -157,7 +157,7 @@ export default class EditingController { const viewRoot = new RootEditableElement( root.name ); viewRoot.rootName = root.rootName; - viewRoot.document = this.view.document; + viewRoot._document = this.view.document; this.mapper.bindElements( root, viewRoot ); return viewRoot; diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index a152a6d59..561cd47e2 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -1009,7 +1009,7 @@ export function createViewElementFromHighlightDescriptor( descriptor ) { } if ( descriptor.priority ) { - viewElement.priority = descriptor.priority; + viewElement._priority = descriptor.priority; } viewElement._setCustomProperty( 'highlightDescriptorId', descriptor.id ); diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 982371699..2500e298d 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -197,7 +197,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { const viewRoot = new ViewRootEditableElement( 'div' ); // Create a temporary root element in view document. - viewRoot.document = view.document; + viewRoot._document = view.document; viewRoot.rootName = 'main'; viewDocument.roots.add( viewRoot ); diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index 60bdebacc..bb20f74b4 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -192,7 +192,7 @@ setData._parse = parse; * {@link module:engine/view/attributeelement~AttributeElement attribute elements}. * * const attribute = new AttributeElement( 'b' ); - * attribute.priority = 20; + * attribute._priority = 20; * getData( attribute, null, { showPriority: true } ); // * * @param {module:engine/view/text~Text|module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} @@ -924,7 +924,7 @@ function _convertElement( viewElement ) { if ( newElement.is( 'attributeElement' ) ) { if ( info.priority !== null ) { - newElement.priority = info.priority; + newElement._priority = info.priority; } } diff --git a/src/view/attributeelement.js b/src/view/attributeelement.js index 8e610d3de..5c0892d94 100644 --- a/src/view/attributeelement.js +++ b/src/view/attributeelement.js @@ -36,9 +36,10 @@ export default class AttributeElement extends Element { * {@link module:engine/view/element~Element#isSimilar similar}. Setting different priorities on similar * nodes may prevent merging, e.g. two `` nodes next each other shouldn't be merged. * + * @protected * @member {Number} */ - this.priority = DEFAULT_PRIORITY; + this._priority = DEFAULT_PRIORITY; /** * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed. @@ -49,6 +50,16 @@ export default class AttributeElement extends Element { this.getFillerOffset = getFillerOffset; } + /** + * Priority of this element. + * + * @readonly + * @return {Number} + */ + get priority() { + return this._priority; + } + /** * @inheritDoc */ @@ -71,7 +82,7 @@ export default class AttributeElement extends Element { const cloned = super.clone( deep ); // Clone priority too. - cloned.priority = this.priority; + cloned._priority = this._priority; return cloned; } diff --git a/src/view/editableelement.js b/src/view/editableelement.js index 736316537..8c8845953 100644 --- a/src/view/editableelement.js +++ b/src/view/editableelement.js @@ -60,11 +60,23 @@ export default class EditableElement extends ContainerElement { */ } + /** + * Returns document associated with the editable. + * + * @readonly + * @return {module:engine/view/document~Document} + */ get document() { return this.getCustomProperty( documentSymbol ); } - set document( document ) { + /** + * Sets document of this editable element. + * + * @protected + * @param {module:engine/view/document~Document} document + */ + set _document( document ) { if ( this.getCustomProperty( documentSymbol ) ) { /** * View document is already set. It can only be set once. diff --git a/src/view/writer.js b/src/view/writer.js index 188b733da..0981b8617 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -118,8 +118,14 @@ export default class Writer { * @param {Object} [attributes] Elements attributes. * @returns {module:engine/view/attributeelement~AttributeElement} Created element. */ - createAttributeElement( name, attributes ) { - return new AttributeElement( name, attributes ); + createAttributeElement( name, attributes, priority ) { + const attributeElement = new AttributeElement( name, attributes ); + + if ( priority ) { + attributeElement._priority = priority; + } + + return attributeElement; } /** @@ -149,7 +155,7 @@ export default class Writer { */ createEditableElement( name, attributes ) { const editableElement = new EditableElement( name, attributes ); - editableElement.document = this.document; + editableElement._document = this.document; return editableElement; } @@ -983,8 +989,8 @@ export default class Writer { } // Create fake element that will represent position, and will not be merged with other attributes. - const fakePosition = new AttributeElement(); - fakePosition.priority = Number.POSITIVE_INFINITY; + const fakePosition = this.createAttributeElement(); + fakePosition._priority = Number.POSITIVE_INFINITY; fakePosition.isSimilar = () => false; // Insert fake element in position location. diff --git a/tests/dev-utils/view.js b/tests/dev-utils/view.js index 8e2658a06..a9aa5051a 100644 --- a/tests/dev-utils/view.js +++ b/tests/dev-utils/view.js @@ -455,10 +455,10 @@ describe( 'view test utils', () => { it( 'should parse element priority', () => { const parsed1 = parse( '' ); const attribute1 = new AttributeElement( 'b' ); - attribute1.priority = 12; + attribute1._priority = 12; const parsed2 = parse( '' ); const attribute2 = new AttributeElement( 'b' ); - attribute2.priority = 44; + attribute2._priority = 44; parsed1.isSimilar( attribute1 ); expect( parsed1.isSimilar( attribute1 ) ).to.be.true; diff --git a/tests/view/_utils/createroot.js b/tests/view/_utils/createroot.js index cff2d8a4a..c83f0ef8e 100644 --- a/tests/view/_utils/createroot.js +++ b/tests/view/_utils/createroot.js @@ -16,7 +16,7 @@ import RootEditableElement from '../../../src/view/rooteditableelement'; export default function createRoot( doc, name = 'div', rootName = 'main' ) { const root = new RootEditableElement( name ); - root.document = doc; + root._document = doc; root.rootName = rootName; doc.roots.add( root ); diff --git a/tests/view/attributeelement.js b/tests/view/attributeelement.js index e3a4cfe49..43b112d00 100644 --- a/tests/view/attributeelement.js +++ b/tests/view/attributeelement.js @@ -51,7 +51,7 @@ describe( 'AttributeElement', () => { describe( 'clone', () => { it( 'should clone element with priority', () => { const el = new AttributeElement( 'b' ); - el.priority = 7; + el._priority = 7; const clone = el.clone(); @@ -64,17 +64,17 @@ describe( 'AttributeElement', () => { describe( 'isSimilar', () => { it( 'should return true if priorities are the same', () => { const b1 = new AttributeElement( 'b' ); - b1.priority = 7; + b1._priority = 7; const b2 = new AttributeElement( 'b' ); - b2.priority = 7; + b2._priority = 7; expect( b1.isSimilar( b2 ) ).to.be.true; } ); it( 'should return false if priorities are different', () => { const b1 = new AttributeElement( 'b' ); - b1.priority = 7; + b1._priority = 7; const b2 = new AttributeElement( 'b' ); // default priority diff --git a/tests/view/domconverter/domconverter.js b/tests/view/domconverter/domconverter.js index 5f9882c4a..21464c185 100644 --- a/tests/view/domconverter/domconverter.js +++ b/tests/view/domconverter/domconverter.js @@ -40,7 +40,7 @@ describe( 'DomConverter', () => { beforeEach( () => { viewDocument = new ViewDocument(); viewEditable = new ViewEditable( 'div' ); - viewEditable.document = viewDocument; + viewEditable._document = viewDocument; domEditable = document.createElement( 'div' ); domEditableParent = document.createElement( 'div' ); diff --git a/tests/view/editableelement.js b/tests/view/editableelement.js index 1b0e59b97..38c603dfc 100644 --- a/tests/view/editableelement.js +++ b/tests/view/editableelement.js @@ -18,7 +18,7 @@ describe( 'EditableElement', () => { } ); it( 'should allow to set document', () => { - element.document = docMock; + element._document = docMock; expect( element.document ).to.equal( docMock ); } ); @@ -28,16 +28,16 @@ describe( 'EditableElement', () => { } ); it( 'should throw if trying to set document again', () => { - element.document = docMock; + element._document = docMock; const newDoc = createDocumentMock(); expect( () => { - element.document = newDoc; + element._document = newDoc; } ).to.throw( CKEditorError, 'view-editableelement-document-already-set: View document is already set.' ); } ); it( 'should be cloned properly', () => { - element.document = docMock; + element._document = docMock; const newElement = element.clone(); expect( newElement.document ).to.equal( docMock ); @@ -51,16 +51,16 @@ describe( 'EditableElement', () => { docMock = createDocumentMock(); viewMain = new RootEditableElement( 'div' ); - viewMain.document = docMock; + viewMain._document = docMock; viewHeader = new RootEditableElement( 'h1' ); - viewHeader.document = docMock; + viewHeader._document = docMock; viewHeader.rootName = 'header'; } ); it( 'should be observable', () => { const root = new RootEditableElement( 'div' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); expect( root.isFocused ).to.be.false; @@ -114,7 +114,7 @@ describe( 'EditableElement', () => { describe( 'isReadOnly', () => { it( 'should be observable', () => { const root = new RootEditableElement( 'div' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); expect( root.isReadOnly ).to.be.false; @@ -131,7 +131,7 @@ describe( 'EditableElement', () => { it( 'should be bound to the document#isReadOnly', () => { const root = new RootEditableElement( 'div' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); root.document.isReadOnly = false; @@ -147,7 +147,7 @@ describe( 'EditableElement', () => { it( 'should return document', () => { const docMock = createDocumentMock(); const root = new RootEditableElement( 'div' ); - root.document = docMock; + root._document = docMock; expect( root.document ).to.equal( docMock ); } ); diff --git a/tests/view/node.js b/tests/view/node.js index 564e884cb..3f04cd58c 100644 --- a/tests/view/node.js +++ b/tests/view/node.js @@ -222,7 +222,7 @@ describe( 'Node', () => { it( 'should return Document attached to the parent element', () => { const docMock = createDocumentMock(); const parent = new RootEditableElement( 'div' ); - parent.document = docMock; + parent._document = docMock; const child = new Element( 'p' ); child.parent = parent; @@ -248,7 +248,7 @@ describe( 'Node', () => { it( 'should return root element', () => { const parent = new RootEditableElement( 'div' ); - parent.document = createDocumentMock(); + parent._document = createDocumentMock(); const child = new Element( 'p' ); child.parent = parent; diff --git a/tests/view/position.js b/tests/view/position.js index 3eb28fd2b..9427a32be 100644 --- a/tests/view/position.js +++ b/tests/view/position.js @@ -511,7 +511,7 @@ describe( 'Position', () => { const document = new Document(); const p = new Element( 'p' ); const editable = new EditableElement( 'div', null, p ); - editable.document = document; + editable._document = document; const position = new Position( p, 0 ); expect( position.editableElement ).to.equal( editable ); diff --git a/tests/view/rooteditableelement.js b/tests/view/rooteditableelement.js index eef7eb250..6c7767e86 100644 --- a/tests/view/rooteditableelement.js +++ b/tests/view/rooteditableelement.js @@ -13,7 +13,7 @@ describe( 'RootEditableElement', () => { describe( 'constructor()', () => { it( 'should create an element with default root name', () => { const root = new RootEditableElement( 'div' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); expect( root ).to.be.instanceof( EditableElement ); expect( root ).to.be.instanceof( ContainerElement ); @@ -27,7 +27,7 @@ describe( 'RootEditableElement', () => { it( 'should create an element with custom root name', () => { const root = new RootEditableElement( 'h1' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); root.rootName = 'header'; expect( root.rootName ).to.equal( 'header' ); @@ -83,12 +83,12 @@ describe( 'RootEditableElement', () => { it( 'should be cloned properly', () => { const root = new RootEditableElement( 'h1' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); root.rootName = 'header'; const newRoot = root.clone(); - expect( newRoot.document ).to.equal( root.document ); + expect( newRoot._document ).to.equal( root._document ); expect( newRoot.rootName ).to.equal( root.rootName ); } ); } ); diff --git a/tests/view/textproxy.js b/tests/view/textproxy.js index 69212edbd..a638f74f7 100644 --- a/tests/view/textproxy.js +++ b/tests/view/textproxy.js @@ -92,7 +92,7 @@ describe( 'TextProxy', () => { it( 'should return Document attached to the parent element', () => { const docMock = createDocumentMock(); const root = new RootEditableElement( 'div' ); - root.document = docMock; + root._document = docMock; wrapper.parent = root; @@ -109,7 +109,7 @@ describe( 'TextProxy', () => { describe( 'getRoot', () => { it( 'should return root element', () => { const root = new RootEditableElement( 'div' ); - root.document = createDocumentMock(); + root._document = createDocumentMock(); wrapper.parent = root; diff --git a/tests/view/view/view.js b/tests/view/view/view.js index 3620cb0c6..126d532e6 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -533,7 +533,7 @@ describe( 'view', () => { const viewRoot = new RootEditableElement( name ); viewRoot.rootName = rootName; - viewRoot.document = viewDoc; + viewRoot._document = viewDoc; viewDoc.roots.add( viewRoot ); return viewRoot; From d4fe28fa69fd5eb340d3000a5c8a2ec131272d4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 21:37:53 +0100 Subject: [PATCH 555/724] View writer.createUIElement() method can now initialize rendering method. --- src/view/writer.js | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/src/view/writer.js b/src/view/writer.js index 0981b8617..1693725e1 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -177,15 +177,31 @@ export default class Writer { /** * Creates new {@link module:engine/view/uielement~UIElement}. * - * writer.createUIElement( 'paragraph' ); - * writer.createUIElement( 'paragraph', { 'alignment': 'center' } ); + * writer.createUIElement( 'span' ); + * writer.createUIElement( 'span', { 'alignment': 'center' } ); + * + * Custom render function can be provided as third parameter: + * + * writer.createUIElement( 'span', null, function( domDocument ) { + * const domElement = this.toDomElement( domDocument ); + * domElement.innerHTML = 'this is ui element'; + * + * return domElement; + * } ); * * @param {String} name Name of the element. * @param {Object} [attributes] Elements attributes. + * @param {Function} [renderFunction] Custom render function. * @returns {module:engine/view/uielement~UIElement} Created element. */ - createUIElement( name, attributes ) { - return new UIElement( name, attributes ); + createUIElement( name, attributes, renderFunction ) { + const uiElement = new UIElement( name, attributes ); + + if ( renderFunction ) { + uiElement.render = renderFunction; + } + + return uiElement; } setAttribute( key, value, element ) { From 833b81ff77b46d7ef5be33c8e9861ff11f677169 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 21:59:15 +0100 Subject: [PATCH 556/724] Updated view writer's docs. --- src/conversion/downcast-converters.js | 4 +- src/view/writer.js | 79 ++++++++++++++++++++++++++- 2 files changed, 80 insertions(+), 3 deletions(-) diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index 561cd47e2..345350d44 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -855,7 +855,7 @@ export function highlightText( highlightDescriptor ) { * Converter function factory. Creates a function which applies the marker's highlight to an element inside the marker's range. * * The converter checks if an element has `addHighlight` function stored as - * {@link module:engine/view/element~Element#setCustomProperty custom property} and, if so, uses it to apply the highlight. + * {@link module:engine/view/element~Element#_setCustomProperty custom property} and, if so, uses it to apply the highlight. * In such case converter will consume all element's children, assuming that they were handled by element itself. * * When `addHighlight` custom property is not present, element is not converted in any special way. @@ -913,7 +913,7 @@ export function highlightElement( highlightDescriptor ) { * highlight descriptor. See {link module:engine/conversion/downcast-converters~highlightDescriptorToAttributeElement}. * * For elements, the converter checks if an element has `removeHighlight` function stored as - * {@link module:engine/view/element~Element#setCustomProperty custom property}. If so, it uses it to remove the highlight. + * {@link module:engine/view/element~Element#_setCustomProperty custom property}. If so, it uses it to remove the highlight. * In such case, children of that element will not be converted. * * When `removeHighlight` is not present, element is not converted in any special way. diff --git a/src/view/writer.js b/src/view/writer.js index 1693725e1..ebaca1991 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -16,6 +16,7 @@ import Range from './range'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import DocumentFragment from './documentfragment'; import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable'; +import isPlainObject from '@ckeditor/ckeditor5-utils/src/lib/lodash/isPlainObject'; import Text from './text'; import EditableElement from './editableelement'; @@ -204,36 +205,112 @@ export default class Writer { return uiElement; } + /** + * Adds or overwrite element's attribute with a specified key and value. + * + * writer.setAttribute( 'href', 'http://ckeditor.com', linkElement ); + * + * @param {String} key Attribute key. + * @param {String} value Attribute value. + * @param {module:engine/view/element~Element} element + */ setAttribute( key, value, element ) { element._setAttribute( key, value ); } + /** + * Removes attribute from the element. + * + * writer.removeAttribute( 'href', linkElement ); + * + * @param {String} key Attribute key. + * @param {module:engine/view/element~Element} element + */ removeAttribute( key, element ) { element._removeAttribute( key ); } + /** + * Adds specified class to the element. + * + * writer.addClass( 'foo', linkElement ); + * writer.addClass( [ 'foo', 'bar' ], linkElement ); + * + * @param {Array.|String} className + * @param {module:engine/view/element~Element} element + */ addClass( className, element ) { element._addClass( className ); } + /** + * Removes specified class from the element. + * + * writer.removeClass( 'foo', linkElement ); + * writer.removeClass( [ 'foo', 'bar' ], linkElement ); + * + * @param {Array.|String} className + * @param {module:engine/view/element~Element} element + */ removeClass( className, element ) { element._removeClass( className ); } + /** + * Adds style to the element. + * + * writer.setStyle( 'color', 'red', element ); + * writer.setStyle( { + * color: 'red', + * position: 'fixed' + * }, element ); + * + * @param {String|Object} property Property name or object with key - value pairs. + * @param {String} [value] Value to set. This parameter is ignored if object is provided as the first parameter. + * @param {module:engine/view/element~Element} element Element to set styles on. + */ setStyle( property, value, element ) { + if ( isPlainObject( property ) && element === undefined ) { + element = value; + } + element._setStyle( property, value ); } + /** + * Removes specified style from the element. + * + * writer.removeStyle( 'color', element ); // Removes 'color' style. + * writer.removeStyle( [ 'color', 'border-top' ], element ); // Removes both 'color' and 'border-top' styles. + * + * @param {Array.|String} property + * @param {module:engine/view/element~Element} element + */ removeStyle( property, element ) { element._removeStyle( property ); } + /** + * Sets a custom property on element. Unlike attributes, custom properties are not rendered to the DOM, + * so they can be used to add special data to elements. + * + * @param {String|Symbol} key + * @param {*} value + * @param {module:engine/view/element~Element} element + */ setCustomProperty( key, value, element ) { element._setCustomProperty( key, value ); } + /** + * Removes a custom property stored under the given key. + * + * @param {String|Symbol} key + * @param {module:engine/view/element~Element} element + * @returns {Boolean} Returns true if property was removed. + */ removeCustomProperty( key, element ) { - element._removeCustomProperty( key ); + return element._removeCustomProperty( key ); } /** From 3f110deb3c9025b9d661851ba377b3acf412b73c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 13 Feb 2018 23:27:01 +0100 Subject: [PATCH 557/724] Added tests to new methods in view writer. --- tests/view/writer/writer.js | 142 ++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) diff --git a/tests/view/writer/writer.js b/tests/view/writer/writer.js index 14b19a98d..834126cab 100644 --- a/tests/view/writer/writer.js +++ b/tests/view/writer/writer.js @@ -68,6 +68,15 @@ describe( 'Writer', () => { expect( element.name ).to.equal( 'foo' ); assertElementAttributes( element, attributes ); } ); + + it( 'should allow to pass priority', () => { + const element = writer.createAttributeElement( 'foo', attributes, 99 ); + + expect( element.is( 'attributeElement' ) ).to.be.true; + expect( element.name ).to.equal( 'foo' ); + expect( element.priority ).to.equal( 99 ); + assertElementAttributes( element, attributes ); + } ); } ); describe( 'createContainerElement()', () => { @@ -108,6 +117,139 @@ describe( 'Writer', () => { expect( element.name ).to.equal( 'foo' ); assertElementAttributes( element, attributes ); } ); + + it( 'should allow to pass custom rendering method', () => { + const renderFn = function() {}; + const element = writer.createUIElement( 'foo', attributes, renderFn ); + + expect( element.is( 'uiElement' ) ).to.be.true; + expect( element.name ).to.equal( 'foo' ); + expect( element.render ).to.equal( renderFn ); + assertElementAttributes( element, attributes ); + } ); + } ); + + describe( 'setAttribute()', () => { + it( 'should set attribute on given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.setAttribute( 'foo', 'bar', element ); + + expect( element.getAttribute( 'foo' ) ).to.equal( 'bar' ); + } ); + } ); + + describe( 'removeAttribute()', () => { + it( 'should remove attribute on given element', () => { + const element = writer.createAttributeElement( 'span', { foo: 'bar' } ); + + writer.removeAttribute( 'foo', element ); + + expect( element.getAttribute( 'foo' ) ).to.be.undefined; + } ); + } ); + + describe( 'addClass()', () => { + it( 'should add class to given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.addClass( 'foo', element ); + + expect( element.hasClass( 'foo' ) ).to.be.true; + } ); + + it( 'should add multiple classes to given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.addClass( [ 'foo', 'bar' ], element ); + + expect( element.hasClass( 'foo' ) ).to.be.true; + expect( element.hasClass( 'bar' ) ).to.be.true; + } ); + } ); + + describe( 'removeClass()', () => { + it( 'should remove class from given element', () => { + const element = writer.createAttributeElement( 'span', { class: 'foo bar' } ); + + writer.removeClass( 'foo', element ); + + expect( element.hasClass( 'foo' ) ).to.be.false; + expect( element.hasClass( 'bar' ) ).to.be.true; + } ); + + it( 'should remove multiple classes from given element', () => { + const element = writer.createAttributeElement( 'span', { class: 'foo bar' } ); + + writer.removeClass( [ 'foo', 'bar' ], element ); + + expect( element.hasClass( 'foo' ) ).to.be.false; + expect( element.hasClass( 'bar' ) ).to.be.false; + } ); + } ); + + describe( 'addStyle()', () => { + it( 'should add style to given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.setStyle( 'foo', 'bar', element ); + + expect( element.getStyle( 'foo' ) ).to.equal( 'bar' ); + } ); + + it( 'should allow to add multiple styles to given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.setStyle( { + foo: 'bar', + baz: 'quiz' + }, element ); + + expect( element.getStyle( 'foo' ) ).to.equal( 'bar' ); + expect( element.getStyle( 'baz' ) ).to.equal( 'quiz' ); + } ); + } ); + + describe( 'removeStyle()', () => { + it( 'should remove style from given element', () => { + const element = writer.createAttributeElement( 'span', { style: 'foo:bar;baz:quiz;' } ); + + writer.removeStyle( 'foo', element ); + + expect( element.hasStyle( 'foo' ) ).to.be.false; + expect( element.hasStyle( 'baz' ) ).to.be.true; + } ); + + it( 'should remove multiple styles from given element', () => { + const element = writer.createAttributeElement( 'span', { style: 'foo:bar;baz:quiz;' } ); + + writer.removeStyle( [ 'foo', 'bar' ], element ); + + expect( element.hasStyle( 'foo' ) ).to.be.false; + expect( element.hasStyle( 'baz' ) ).to.be.true; + } ); + } ); + + describe( 'setCustomProperty()', () => { + it( 'should set custom property to given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.setCustomProperty( 'foo', 'bar', element ); + + expect( element.getCustomProperty( 'foo' ) ).to.equal( 'bar' ); + } ); + } ); + + describe( 'removeCustomProperty()', () => { + it( 'should remove custom property from given element', () => { + const element = writer.createAttributeElement( 'span' ); + + writer.setCustomProperty( 'foo', 'bar', element ); + expect( element.getCustomProperty( 'foo' ) ).to.equal( 'bar' ); + + writer.removeCustomProperty( 'foo', element ); + expect( element.getCustomProperty( 'foo' ) ).to.be.undefined; + } ); } ); function assertElementAttributes( element, attributes ) { From 5b1a8bd27e847fe51769401d2b3c5847b5a49496 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 00:46:24 +0100 Subject: [PATCH 558/724] Updated placeholder to use view writer to manipulate view nodes. --- src/view/placeholder.js | 48 +++++++++++++++++++++++++-------------- src/view/view.js | 8 ++++--- tests/view/placeholder.js | 4 ++-- 3 files changed, 38 insertions(+), 22 deletions(-) diff --git a/src/view/placeholder.js b/src/view/placeholder.js index 80c5e61bb..319cf5f9b 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -30,61 +30,67 @@ export function attachPlaceholder( view, element, placeholderText, checkFunction const document = view.document; // Detach placeholder if was used before. - detachPlaceholder( element ); + detachPlaceholder( view, element ); // Single listener per document. if ( !documentPlaceholders.has( document ) ) { documentPlaceholders.set( document, new Map() ); // Attach listener just before rendering and update placeholders. - listener.listenTo( view.renderer, 'render', () => updateAllPlaceholders( document ), { priority: 'highest' } ); + listener.listenTo( view.renderer, 'render', () => updateAllPlaceholders( view ), { priority: 'highest' } ); } // Store text in element's data attribute. // This data attribute is used in CSS class to show the placeholder. - element._setAttribute( 'data-placeholder', placeholderText ); + view.change( writer => { + writer.setAttribute( 'data-placeholder', placeholderText, element ); + } ); // Store information about placeholder. documentPlaceholders.get( document ).set( element, checkFunction ); // Update right away too. - updateSinglePlaceholder( element, checkFunction ); + updateSinglePlaceholder( view, element, checkFunction ); } /** * Removes placeholder functionality from given element. * + * @param {module:engine/view/view~View} view * @param {module:engine/view/element~Element} element */ -export function detachPlaceholder( element ) { +export function detachPlaceholder( view, element ) { const document = element.document; - element._removeClass( 'ck-placeholder' ); - element._removeAttribute( 'data-placeholder' ); - if ( documentPlaceholders.has( document ) ) { documentPlaceholders.get( document ).delete( element ); } + + view.change( writer => { + writer.removeClass( 'ck-placeholder', element ); + writer.removeAttribute( 'data-placeholder', element ); + } ); } // Updates all placeholders of given document. // // @private -// @param {module:engine/view/document~Document} document -function updateAllPlaceholders( document ) { - const placeholders = documentPlaceholders.get( document ); +// @param {module:engine/view/view~View} view +function updateAllPlaceholders( view ) { + const placeholders = documentPlaceholders.get( view.document ); for ( const [ element, checkFunction ] of placeholders ) { - updateSinglePlaceholder( element, checkFunction ); + updateSinglePlaceholder( view, element, checkFunction ); } } // Updates placeholder class of given element. // // @private +// @param {module:engine/view/view~View} view // @param {module:engine/view/element~Element} element // @param {Function} checkFunction -function updateSinglePlaceholder( element, checkFunction ) { +function updateSinglePlaceholder( view, element, checkFunction ) { const document = element.document; // Element was removed from document. @@ -97,7 +103,9 @@ function updateSinglePlaceholder( element, checkFunction ) { // If checkFunction is provided and returns false - remove placeholder. if ( checkFunction && !checkFunction() ) { - element._removeClass( 'ck-placeholder' ); + view.change( writer => { + writer.removeClass( 'ck-placeholder', element ); + } ); return; } @@ -108,15 +116,21 @@ function updateSinglePlaceholder( element, checkFunction ) { // If element is empty and editor is blurred. if ( !document.isFocused && isEmptyish ) { - element._addClass( 'ck-placeholder' ); + view.change( writer => { + writer.addClass( 'ck-placeholder', element ); + } ); return; } // It there are no child elements and selection is not placed inside element. if ( isEmptyish && anchor && anchor.parent !== element ) { - element._addClass( 'ck-placeholder' ); + view.change( writer => { + writer.addClass( 'ck-placeholder', element ); + } ); } else { - element._removeClass( 'ck-placeholder' ); + view.change( writer => { + writer.removeClass( 'ck-placeholder', element ); + } ); } } diff --git a/src/view/view.js b/src/view/view.js index 08828af18..4bfcbae47 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -22,6 +22,7 @@ import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; import log from '@ckeditor/ckeditor5-utils/src/log'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; import { scrollViewportToShowTarget } from '@ckeditor/ckeditor5-utils/src/dom/scroll'; +import priorities from '@ckeditor/ckeditor5-utils/src/priorities'; import { injectUiElementHandling } from './uielement'; import { injectQuirksHandling } from './filler'; @@ -352,13 +353,14 @@ export default class View { * @private */ _render() { - this._renderingInProgress = true; + // Lock just before rendering and unlock just after. + // This way other parts of the code can listen to the `render` event and modify the view tree just before rendering. + this.renderer.once( 'render', () => ( this._renderingInProgress = true ), { priority: priorities.get( 'normal' ) + 1 } ); + this.renderer.once( 'render', () => ( this._renderingInProgress = false ), { priority: priorities.get( 'normal' ) - 1 } ); this.disableObservers(); this.renderer.render(); this.enableObservers(); - - this._renderingInProgress = false; } /** diff --git a/tests/view/placeholder.js b/tests/view/placeholder.js index 1ccf28465..c72a64298 100644 --- a/tests/view/placeholder.js +++ b/tests/view/placeholder.js @@ -78,7 +78,7 @@ describe( 'placeholder', () => { attachPlaceholder( view, element, 'foo bar baz', spy ); - sinon.assert.calledOnce( spy ); + sinon.assert.called( spy ); expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' ); expect( element.hasClass( 'ck-placeholder' ) ).to.be.false; } ); @@ -185,7 +185,7 @@ describe( 'placeholder', () => { expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' ); expect( element.hasClass( 'ck-placeholder' ) ).to.be.true; - detachPlaceholder( element ); + detachPlaceholder( view, element ); expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false; expect( element.hasClass( 'ck-placeholder' ) ).to.be.false; From 7d321b74a9ec2270b62c42927edfddc55851efc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 01:08:09 +0100 Subject: [PATCH 559/724] Using writer in highlight manual test. --- tests/manual/highlight.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/tests/manual/highlight.js b/tests/manual/highlight.js index 92c0619f3..81f819e2d 100644 --- a/tests/manual/highlight.js +++ b/tests/manual/highlight.js @@ -6,8 +6,7 @@ /* global console, window, document */ import ModelRange from '../../src/model/range'; -import ViewContainerElement from '../../src/view/containerelement'; -import ViewText from '../../src/view/text'; +import ViewPosition from '../../src/view/position'; import { upcastElementToElement, @@ -50,8 +49,10 @@ class FancyWidget extends Plugin { downcastElementToElement( { model: 'fancywidget', - view: () => { - const widgetElement = new ViewContainerElement( 'figure', { class: 'fancy-widget' }, new ViewText( 'widget' ) ); + view: ( modelItem, consumable, conversionApi ) => { + const viewWriter = conversionApi.writer; + const widgetElement = viewWriter.createContainerElement( 'figure', { class: 'fancy-widget' } ); + viewWriter.insert( ViewPosition.createAt( widgetElement ), viewWriter.createText( 'widget' ) ); return toWidget( widgetElement ); } From 2b923bb767bcbdde5ec82e9313ce9c63e5de308f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 09:18:53 +0100 Subject: [PATCH 560/724] Removed view.jsdoc file. --- src/view/view.jsdoc | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 src/view/view.jsdoc diff --git a/src/view/view.jsdoc b/src/view/view.jsdoc deleted file mode 100644 index 547357158..000000000 --- a/src/view/view.jsdoc +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -/** - * @module engine/view/view - */ From 892ad1ac875f0302bf42a796ede63381fe36d427 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 14 Feb 2018 14:30:35 +0100 Subject: [PATCH 561/724] API docs fixes. --- src/model/writer.js | 2 +- src/view/rooteditableelement.js | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/model/writer.js b/src/model/writer.js index 7fed70283..40aae8246 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -45,7 +45,7 @@ import uid from '@ckeditor/ckeditor5-utils/src/uid'; /** * Model writer it the proper way of modifying model. It should be used whenever you wants to create node, modify * child nodes, attributes or text. To get writer use {@link module:engine/model/model~Model#change} or - * {@link @see module:engine/model/model~Model#enqueueChange}. + * {@link module:engine/model/model~Model#enqueueChange}. * * model.change( writer => { * writer.insertText( 'foo', paragraph, 'end' ); diff --git a/src/view/rooteditableelement.js b/src/view/rooteditableelement.js index 438d7d423..741276800 100644 --- a/src/view/rooteditableelement.js +++ b/src/view/rooteditableelement.js @@ -12,10 +12,9 @@ import EditableElement from './editableelement'; const rootNameSymbol = Symbol( 'rootName' ); /** - * Class representing a single root in the data view. A root can be either {@link #isReadOnly editable or read-only}, but - * in both cases it is called "an editable". Roots can contain other {@link module:engine/view/editableelement~EditableElement editable - * elements} - * making them "nested editables". + * Class representing a single root in the data view. A root can be either {@link ~RootEditableElement#isReadOnly editable or read-only}, + * but in both cases it is called "an editable". Roots can contain other {@link module:engine/view/editableelement~EditableElement + * editable elements} making them "nested editables". * * @extends module:engine/view/editableelement~EditableElement */ From a576a0a4ff9e968e632a5665037b7a7828cadd4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 14:33:47 +0100 Subject: [PATCH 562/724] Get rid of view.document#change event and rednerer#render events. Created render event on view controller. Updated tests. --- src/view/observer/mutationobserver.js | 2 +- src/view/placeholder.js | 2 +- src/view/renderer.js | 8 -- src/view/view.js | 108 ++++++++++++------- tests/view/observer/focusobserver.js | 8 +- tests/view/renderer.js | 10 -- tests/view/view/view.js | 143 ++++++++++++++++++-------- 7 files changed, 176 insertions(+), 105 deletions(-) diff --git a/src/view/observer/mutationobserver.js b/src/view/observer/mutationobserver.js index f01e0b17d..aa8e1a37e 100644 --- a/src/view/observer/mutationobserver.js +++ b/src/view/observer/mutationobserver.js @@ -59,7 +59,7 @@ export default class MutationObserver extends Observer { * * @member {module:engine/view/renderer~Renderer} */ - this.renderer = view.renderer; + this.renderer = view._renderer; /** * Observed DOM elements. diff --git a/src/view/placeholder.js b/src/view/placeholder.js index 319cf5f9b..a4793098c 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -37,7 +37,7 @@ export function attachPlaceholder( view, element, placeholderText, checkFunction documentPlaceholders.set( document, new Map() ); // Attach listener just before rendering and update placeholders. - listener.listenTo( view.renderer, 'render', () => updateAllPlaceholders( view ), { priority: 'highest' } ); + listener.listenTo( view, 'render', () => updateAllPlaceholders( view ) ); } // Store text in element's data attribute. diff --git a/src/view/renderer.js b/src/view/renderer.js index 2073d3b17..fe915e44c 100644 --- a/src/view/renderer.js +++ b/src/view/renderer.js @@ -110,7 +110,6 @@ export default class Renderer { * @type {null|HTMLElement} */ this._fakeSelectionContainer = null; - this.decorate( 'render' ); } /** @@ -709,13 +708,6 @@ export default class Renderer { } } } - - /** - * Fired when {@link #render render} method is called. Actual rendering is executed as a listener to - * this event with default priority. This way other listeners can be used to run code before or after rendering. - * - * @event render - */ } mix( Renderer, ObservableMixin ); diff --git a/src/view/view.js b/src/view/view.js index 4bfcbae47..77eeeb79c 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -22,9 +22,9 @@ import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; import log from '@ckeditor/ckeditor5-utils/src/log'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; import { scrollViewportToShowTarget } from '@ckeditor/ckeditor5-utils/src/dom/scroll'; -import priorities from '@ckeditor/ckeditor5-utils/src/priorities'; import { injectUiElementHandling } from './uielement'; import { injectQuirksHandling } from './filler'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Editor's view controller class. @@ -71,11 +71,11 @@ export default class View { /** * Instance of the {@link module:engine/view/renderer~Renderer renderer}. * - * @readonly + * @protected * @member {module:engine/view/renderer~Renderer} module:engine/view/view~View#renderer */ - this.renderer = new Renderer( this.domConverter, this.document.selection ); - this.renderer.bind( 'isFocused' ).to( this.document ); + this._renderer = new Renderer( this.domConverter, this.document.selection ); + this._renderer.bind( 'isFocused' ).to( this.document ); /** * Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys. @@ -102,12 +102,15 @@ export default class View { this._ongoingChange = false; /** - * Is set to `true` when rendering view to DOM is currently in progress. + * Is set to `true` when rendering view to DOM was started. + * This is used to check whether view document can accept changes in current state. + * From the moment when rendering to DOM is stared view tree is locked to prevent changes that will not be + * reflected in the DOM. * * @private - * @member {Boolean} module:engine/view/view~View#_renderingInProgress + * @member {Boolean} module:engine/view/view~View#_renderingStarted */ - this._renderingInProgress = false; + this._renderingStarted = false; /** * Writer instance used in {@link #change change method) callbacks. @@ -127,6 +130,11 @@ export default class View { // Inject quirks handlers. injectQuirksHandling( this ); injectUiElementHandling( this ); + + // Use 'low` priority so that all listeners on 'normal` priority will be executed before. + this.on( 'render', () => { + this._render(); + }, { priority: 'low' } ); } /** @@ -148,12 +156,12 @@ export default class View { this.domRoots.set( name, domRoot ); this.domConverter.bindElements( domRoot, viewRoot ); - this.renderer.markToSync( 'children', viewRoot ); - this.renderer.domDocuments.add( domRoot.ownerDocument ); + this._renderer.markToSync( 'children', viewRoot ); + this._renderer.domDocuments.add( domRoot.ownerDocument ); - viewRoot.on( 'change:children', ( evt, node ) => this.renderer.markToSync( 'children', node ) ); - viewRoot.on( 'change:attributes', ( evt, node ) => this.renderer.markToSync( 'attributes', node ) ); - viewRoot.on( 'change:text', ( evt, node ) => this.renderer.markToSync( 'text', node ) ); + viewRoot.on( 'change:children', ( evt, node ) => this._renderer.markToSync( 'children', node ) ); + viewRoot.on( 'change:attributes', ( evt, node ) => this._renderer.markToSync( 'attributes', node ) ); + viewRoot.on( 'change:text', ( evt, node ) => this._renderer.markToSync( 'text', node ) ); for ( const observer of this._observers.values() ) { observer.observe( domRoot, name ); @@ -291,22 +299,14 @@ export default class View { * When the outermost change block is done and rendering to DOM is over it fires * {@link module:engine/view/document~Document#event:change} event. * + * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when + * change block is used after rendering to DOM has started. + * * @param {Function} callback Callback function which may modify the view. */ change( callback ) { - if ( this._renderingInProgress ) { - /** - * Warning displayed when there is an attempt to make changes in the view tree during the rendering process. - * This may cause unexpected behaviour and inconsistency between the DOM and the view. - * - * @error applying-view-changes-on-rendering - */ - log.warn( - 'applying-view-changes-on-rendering: ' + - 'Attempting to make changes in the view during rendering process. ' + - 'This may cause some unexpected behaviour and inconsistency between the DOM and the view.' - ); - } + // Check if change is performed in correct moment. + this._assertRenderingInProgress(); // If other changes are in progress wait with rendering until every ongoing change is over. if ( this._ongoingChange ) { @@ -315,23 +315,29 @@ export default class View { this._ongoingChange = true; callback( this._writer ); - this._render(); + this.fire( 'render' ); this._ongoingChange = false; - - this.document.fire( 'change' ); + this._renderingStarted = false; } } /** * Renders {@link module:engine/view/document~Document view document} to DOM. If any view changes are * currently in progress, rendering will start after all {@link #change change blocks} are processed. + * + * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when + * trying to re-render when rendering to DOM has already started. */ render() { - // Render only if no ongoing changes in progress. If there are some, view document will be rendered after all + // Check if rendering is performed in correct moment. + this._assertRenderingInProgress(); + + // Render only if no ongoing changes are in progress. If there are some, view document will be rendered after all // changes are done. This way view document will not be rendered in the middle of some changes. if ( !this._ongoingChange ) { - this._render(); + this.fire( 'render' ); + this._renderingStarted = false; } } @@ -353,21 +359,49 @@ export default class View { * @private */ _render() { - // Lock just before rendering and unlock just after. - // This way other parts of the code can listen to the `render` event and modify the view tree just before rendering. - this.renderer.once( 'render', () => ( this._renderingInProgress = true ), { priority: priorities.get( 'normal' ) + 1 } ); - this.renderer.once( 'render', () => ( this._renderingInProgress = false ), { priority: priorities.get( 'normal' ) - 1 } ); + this._renderingStarted = true; this.disableObservers(); - this.renderer.render(); + this._renderer.render(); this.enableObservers(); } /** - * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished and DOM rendering has + * Throws `applying-view-changes-on-rendering` error when trying to modify or re-render view tree when rendering is + * already started + * + * @private + */ + _assertRenderingInProgress() { + if ( this._renderingStarted ) { + /** + * There is an attempt to make changes in the view tree after the rendering process + * has started. This may cause unexpected behaviour and inconsistency between the DOM and the view. + * This may be caused by: + * * calling `view.change()` or `view.render()` methods during rendering process, + * * calling `view.change()` or `view.render()` methods in callbacks to + * {module:engine/view/document~Document#event:change view document change event) on `low` priority, after + * rendering is over for current `change` block. + * + * @error applying-view-changes-on-rendering + */ + throw new CKEditorError( + 'applying-view-changes-on-rendering: ' + + 'Attempting to make changes in the view during rendering process. ' + + 'This may cause some unexpected behaviour and inconsistency between the DOM and the view.' + ); + } + } + + /** + * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished and the DOM rendering has * been executed. * - * @event module:engine/view/document~Document#event:change + * Actual rendering is performed on 'low' priority. This means that all listeners on 'normal' and above priorities + * will be executed after changes made to view tree but before rendering to the DOM. Use `low` priority for callbacks that + * should be executed after rendering to the DOM. + * + * @event module:engine/view/view~View#event:render */ } diff --git a/tests/view/observer/focusobserver.js b/tests/view/observer/focusobserver.js index 6a0bfc4c4..06d65bdc1 100644 --- a/tests/view/observer/focusobserver.js +++ b/tests/view/observer/focusobserver.js @@ -170,9 +170,9 @@ describe( 'FocusObserver', () => { view.render(); viewDocument.on( 'selectionChange', selectionChangeSpy ); - view.renderer.on( 'render', renderSpy, { priority: 'low' } ); + view.on( 'render', renderSpy, { priority: 'low' } ); - view.renderer.on( 'render', () => { + view.on( 'render', () => { sinon.assert.callOrder( selectionChangeSpy, renderSpy ); done(); }, { priority: 'low' } ); @@ -192,9 +192,9 @@ describe( 'FocusObserver', () => { const domEditable = domRoot.childNodes[ 0 ]; viewDocument.on( 'selectionChange', selectionChangeSpy ); - view.renderer.on( 'render', renderSpy, { priority: 'low' } ); + view.on( 'render', renderSpy, { priority: 'low' } ); - view.renderer.on( 'render', () => { + view.on( 'render', () => { sinon.assert.notCalled( selectionChangeSpy ); sinon.assert.called( renderSpy ); diff --git a/tests/view/renderer.js b/tests/view/renderer.js index 74d67d7e3..d5ab6a77f 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -140,16 +140,6 @@ describe( 'Renderer', () => { domRoot.remove(); } ); - it( 'should be decorated', () => { - const spy = sinon.spy(); - - renderer.on( 'render', spy ); - - renderer.render(); - - expect( spy.calledOnce ).to.be.true; - } ); - it( 'should update attributes', () => { viewRoot._setAttribute( 'class', 'foo' ); diff --git a/tests/view/view/view.js b/tests/view/view/view.js index 126d532e6..f23a62414 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -18,6 +18,7 @@ import ViewElement from '../../../src/view/element'; import ViewPosition from '../../../src/view/position'; import { isBlockFiller, BR_FILLER } from '../../../src/view/filler'; import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'view', () => { const DEFAULT_OBSERVERS_COUNT = 5; @@ -91,7 +92,7 @@ describe( 'view', () => { expect( view.getDomRoot() ).to.equal( domDiv ); expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv ); - expect( view.renderer.markedChildren.has( viewRoot ) ).to.be.true; + expect( view._renderer.markedChildren.has( viewRoot ) ).to.be.true; domDiv.remove(); } ); @@ -106,7 +107,7 @@ describe( 'view', () => { expect( count( view.domRoots ) ).to.equal( 1 ); expect( view.getDomRoot( 'header' ) ).to.equal( domH1 ); expect( view.domConverter.mapViewToDom( viewH1 ) ).to.equal( domH1 ); - expect( view.renderer.markedChildren.has( viewH1 ) ).to.be.true; + expect( view._renderer.markedChildren.has( viewH1 ) ).to.be.true; } ); it( 'should call observe on each observer', () => { @@ -115,7 +116,7 @@ describe( 'view', () => { view = new View(); viewDocument = view.document; - view.renderer.render = sinon.spy(); + view._renderer.render = sinon.spy(); const domDiv1 = document.createElement( 'div' ); domDiv1.setAttribute( 'id', 'editor' ); @@ -141,7 +142,7 @@ describe( 'view', () => { view = new View(); viewDocument = view.document; - view.renderer.render = sinon.spy(); + view._renderer.render = sinon.spy(); } ); afterEach( () => { @@ -197,7 +198,7 @@ describe( 'view', () => { view.render(); sinon.assert.calledOnce( observerMock.disable ); - sinon.assert.calledOnce( view.renderer.render ); + sinon.assert.calledOnce( view._renderer.render ); sinon.assert.calledTwice( observerMock.enable ); } ); @@ -358,19 +359,19 @@ describe( 'view', () => { describe( 'isFocused', () => { it( 'should change renderer.isFocused too', () => { expect( viewDocument.isFocused ).to.equal( false ); - expect( view.renderer.isFocused ).to.equal( false ); + expect( view._renderer.isFocused ).to.equal( false ); viewDocument.isFocused = true; expect( viewDocument.isFocused ).to.equal( true ); - expect( view.renderer.isFocused ).to.equal( true ); + expect( view._renderer.isFocused ).to.equal( true ); } ); } ); describe( 'render()', () => { it( 'disable observers, renders and enable observers', () => { const observerMock = view.addObserver( ObserverMock ); - const renderStub = sinon.stub( view.renderer, 'render' ); + const renderStub = sinon.stub( view._renderer, 'render' ); view.render(); @@ -443,22 +444,26 @@ describe( 'view', () => { } ); describe( 'change()', () => { - it( 'should call render and fire event after the change', () => { - const renderSpy = sinon.spy(); - const changeSpy = sinon.spy(); - view.renderer.on( 'render', renderSpy ); - view.document.on( 'change', changeSpy ); + it( 'should fire render event and it should trigger rendering on low priority', () => { + const renderSpy = sinon.spy( view._renderer, 'render' ); + const beforeSpy = sinon.spy(); + const afterSpy = sinon.spy(); + + view.on( 'render', beforeSpy ); + view.on( 'render', afterSpy, { priority: 'low' } ); view.change( () => {} ); - sinon.assert.callOrder( renderSpy, changeSpy ); + sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); } ); - it( 'should render and fire change event once for nested change blocks', () => { - const renderSpy = sinon.spy(); - const changeSpy = sinon.spy(); - view.renderer.on( 'render', renderSpy ); - view.document.on( 'change', changeSpy ); + it( 'should fire render event once for nested change blocks', () => { + const renderSpy = sinon.spy( view._renderer, 'render' ); + const beforeSpy = sinon.spy(); + const afterSpy = sinon.spy(); + + view.on( 'render', beforeSpy ); + view.on( 'render', afterSpy, { priority: 'low' } ); view.change( () => { view.change( () => {} ); @@ -469,16 +474,19 @@ describe( 'view', () => { view.change( () => {} ); } ); + sinon.assert.calledOnce( beforeSpy ); sinon.assert.calledOnce( renderSpy ); - sinon.assert.calledOnce( changeSpy ); - sinon.assert.callOrder( renderSpy, changeSpy ); + sinon.assert.calledOnce( afterSpy ); + sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); } ); - it( 'should render and fire change event once even if render is called during the change', () => { - const renderSpy = sinon.spy(); - const changeSpy = sinon.spy(); - view.renderer.on( 'render', renderSpy ); - view.document.on( 'change', changeSpy ); + it( 'should fire render event once even if render is called during the change', () => { + const renderSpy = sinon.spy( view._renderer, 'render' ); + const beforeSpy = sinon.spy(); + const afterSpy = sinon.spy(); + + view.on( 'render', beforeSpy ); + view.on( 'render', afterSpy, { priority: 'low' } ); view.change( () => { view.render(); @@ -488,43 +496,90 @@ describe( 'view', () => { view.render(); } ); + sinon.assert.calledOnce( beforeSpy ); sinon.assert.calledOnce( renderSpy ); - sinon.assert.calledOnce( changeSpy ); - sinon.assert.callOrder( renderSpy, changeSpy ); + sinon.assert.calledOnce( afterSpy ); + sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); } ); - it( 'should log warning when someone tries to change view during rendering', () => { + it( 'should throw when someone tries to change view during rendering', () => { const domDiv = document.createElement( 'div' ); const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); - sinon.stub( log, 'warn' ); + let renderingCalled = false; view.attachDomRoot( domDiv ); view.change( writer => { const p = writer.createContainerElement( 'p' ); - const ui = writer.createUIElement( 'span' ); - - // This UIElement will try to modify view tree during rendering. - ui.render = function( domDocument ) { + const ui = writer.createUIElement( 'span', null, function( domDocument ) { const element = this.toDomElement( domDocument ); - view.change( () => {} ); + expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); + renderingCalled = true; return element; - }; - + } ); writer.insert( ViewPosition.createAt( p ), ui ); writer.insert( ViewPosition.createAt( viewRoot ), p ); } ); - sinon.assert.calledOnce( log.warn ); - sinon.assert.calledWithExactly( log.warn, - 'applying-view-changes-on-rendering: ' + - 'Attempting to make changes in the view during rendering process. ' + - 'This may cause some unexpected behaviour and inconsistency between the DOM and the view.' - ); + expect( renderingCalled ).to.be.true; + domDiv.remove(); + } ); + + it( 'should throw when someone tries to call render() during rendering', () => { + const domDiv = document.createElement( 'div' ); + const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); + let renderingCalled = false; + view.attachDomRoot( domDiv ); + + view.change( writer => { + const p = writer.createContainerElement( 'p' ); + const ui = writer.createUIElement( 'span', null, function( domDocument ) { + const element = this.toDomElement( domDocument ); + + expect( () => view.render() ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); + renderingCalled = true; + + return element; + } ); + writer.insert( ViewPosition.createAt( p ), ui ); + writer.insert( ViewPosition.createAt( viewRoot ), p ); + } ); + expect( renderingCalled ).to.be.true; domDiv.remove(); - log.warn.restore(); + } ); + + it( 'should throw when someone tries to call change() after rendering is finished but still in change block', () => { + view.on( 'render', () => { + expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); + }, { priority: 'low' } ); + + view.change( () => {} ); + } ); + + it( 'should throw when someone tries to call render() after rendering is finished but still in change block', () => { + view.on( 'render', () => { + expect( () => view.render() ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); + }, { priority: 'low' } ); + + view.change( () => {} ); + } ); + + it( 'should NOT throw when someone tries to call change() before rendering', () => { + view.on( 'render', () => { + expect( () => view.change( () => {} ) ).not.to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); + }, { priority: 'normal' } ); + + view.change( () => {} ); + } ); + + it( 'should NOT throw when someone tries to call render() before rendering', () => { + view.on( 'render', () => { + expect( () => view.render() ).not.to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); + }, { priority: 'normal' } ); + + view.change( () => {} ); } ); } ); } ); From 6242b7769dc2e3027cc87d038332c5191a616d03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 15:00:36 +0100 Subject: [PATCH 563/724] Added comment do DataController why we use view writer without change() block. --- src/controller/datacontroller.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index f2386760b..95f01a665 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -145,6 +145,9 @@ export default class DataController { const modelRange = ModelRange.createIn( modelElementOrFragment ); const viewDocumentFragment = new ViewDocumentFragment(); + + // Create separate ViewWriter just for data conversion purposes. + // We have no view controller and rendering do DOM in DataController so view.change() block is not used here. const viewWriter = new ViewWriter( new ViewDocument() ); this.mapper.bindElements( modelElementOrFragment, viewDocumentFragment ); From d4a8844bc877d9134ada7e192777c0ec5874292d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 15:15:29 +0100 Subject: [PATCH 564/724] Some docs changes in view writer. --- src/view/writer.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/view/writer.js b/src/view/writer.js index ebaca1991..32e48fc6b 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -112,8 +112,8 @@ export default class Writer { /** * Creates new {@link module:engine/view/attributeelement~AttributeElement}. * - * writer.createAttributeElement( 'paragraph' ); - * writer.createAttributeElement( 'paragraph', { 'alignment': 'center' } ); + * writer.createAttributeElement( 'strong' ); + * writer.createAttributeElement( 'strong', { 'alignment': 'center' } ); * * @param {String} name Name of the element. * @param {Object} [attributes] Elements attributes. @@ -146,8 +146,8 @@ export default class Writer { /** * Creates new {@link module:engine/view/editableelement~EditableElement}. * - * writer.createEditableElement( document, 'paragraph' ); - * writer.createEditableElement( document, 'paragraph', { 'alignment': 'center' } ); + * writer.createEditableElement( document, 'div' ); + * writer.createEditableElement( document, 'div', { 'alignment': 'center' } ); * * @param {module:engine/view/document~Document} document View document. * @param {String} name Name of the element. @@ -164,8 +164,8 @@ export default class Writer { /** * Creates new {@link module:engine/view/emptyelement~EmptyElement}. * - * writer.createEmptyElement( 'paragraph' ); - * writer.createEmptyElement( 'paragraph', { 'alignment': 'center' } ); + * writer.createEmptyElement( 'img' ); + * writer.createEmptyElement( 'img', { 'alignment': 'center' } ); * * @param {String} name Name of the element. * @param {Object} [attributes] Elements attributes. From ce0cca448b9993bd89836a11f8644f67c846d662 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 17:21:54 +0100 Subject: [PATCH 565/724] Moved model.change() block out of upcast dispatcher. --- src/controller/datacontroller.js | 6 +- src/conversion/upcastdispatcher.js | 86 ++++++++++++-------------- src/dev-utils/model.js | 7 ++- tests/conversion/two-way-converters.js | 15 +++-- tests/conversion/upcast-converters.js | 39 ++++++------ tests/conversion/upcastdispatcher.js | 54 ++++++++-------- 6 files changed, 101 insertions(+), 106 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 95f01a665..4c8942f30 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -87,7 +87,7 @@ export default class DataController { * @readonly * @member {module:engine/conversion/upcastdispatcher~UpcastDispatcher} */ - this.upcastDispatcher = new UpcastDispatcher( this.model, { + this.upcastDispatcher = new UpcastDispatcher( { schema: model.schema } ); @@ -227,7 +227,9 @@ export default class DataController { * @returns {module:engine/model/documentfragment~DocumentFragment} Output document fragment. */ toModel( viewElementOrFragment, context = '$root' ) { - return this.upcastDispatcher.convert( viewElementOrFragment, context ); + return this.model.change( writer => { + return this.upcastDispatcher.convert( viewElementOrFragment, writer, context ); + } ); } /** diff --git a/src/conversion/upcastdispatcher.js b/src/conversion/upcastdispatcher.js index 372e05e97..8815deaec 100644 --- a/src/conversion/upcastdispatcher.js +++ b/src/conversion/upcastdispatcher.js @@ -97,19 +97,10 @@ export default class UpcastDispatcher { * Creates a `UpcastDispatcher` that operates using passed API. * * @see module:engine/conversion/upcastdispatcher~ViewConversionApi - * @param {module:engine/model/model~Model} model Data model. * @param {Object} [conversionApi] Additional properties for interface that will be passed to events fired * by `UpcastDispatcher`. */ - constructor( model, conversionApi = {} ) { - /** - * Data model. - * - * @private - * @type {module:engine/model/model~Model} - */ - this._model = model; - + constructor( conversionApi = {} ) { /** * List of elements that will be checked after conversion process and if element in the list will be empty it * will be removed from conversion result. @@ -153,62 +144,61 @@ export default class UpcastDispatcher { * @fires documentFragment * @param {module:engine/view/documentfragment~DocumentFragment|module:engine/view/element~Element} viewItem * Part of the view to be converted. + * @param {module:engine/model/writer~Writer} writer Instance of model writer. * @param {module:engine/model/schema~SchemaContextDefinition} [context=['$root']] Elements will be converted according to this context. * @returns {module:engine/model/documentfragment~DocumentFragment} Model data that is a result of the conversion process * wrapped in `DocumentFragment`. Converted marker elements will be set as that document fragment's * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}. */ - convert( viewItem, context = [ '$root' ] ) { - return this._model.change( writer => { - this.fire( 'viewCleanup', viewItem ); + convert( viewItem, writer, context = [ '$root' ] ) { + this.fire( 'viewCleanup', viewItem ); - // Create context tree and set position in the top element. - // Items will be converted according to this position. - this._modelCursor = createContextTree( context, writer ); + // Create context tree and set position in the top element. + // Items will be converted according to this position. + this._modelCursor = createContextTree( context, writer ); - // Store writer in conversion as a conversion API - // to be sure that conversion process will use the same batch. - this.conversionApi.writer = writer; + // Store writer in conversion as a conversion API + // to be sure that conversion process will use the same batch. + this.conversionApi.writer = writer; - // Create consumable values list for conversion process. - this.conversionApi.consumable = ViewConsumable.createFrom( viewItem ); + // Create consumable values list for conversion process. + this.conversionApi.consumable = ViewConsumable.createFrom( viewItem ); - // Custom data stored by converter for conversion process. - this.conversionApi.store = {}; + // Custom data stored by converter for conversion process. + this.conversionApi.store = {}; - // Do the conversion. - const { modelRange } = this._convertItem( viewItem, this._modelCursor ); + // Do the conversion. + const { modelRange } = this._convertItem( viewItem, this._modelCursor ); - // Conversion result is always a document fragment so let's create this fragment. - const documentFragment = writer.createDocumentFragment(); + // Conversion result is always a document fragment so let's create this fragment. + const documentFragment = writer.createDocumentFragment(); - // When there is a conversion result. - if ( modelRange ) { - // Remove all empty elements that was added to #_removeIfEmpty list. - this._removeEmptyElements(); - - // Move all items that was converted to context tree to document fragment. - for ( const item of Array.from( this._modelCursor.parent.getChildren() ) ) { - writer.append( item, documentFragment ); - } + // When there is a conversion result. + if ( modelRange ) { + // Remove all empty elements that was added to #_removeIfEmpty list. + this._removeEmptyElements(); - // Extract temporary markers elements from model and set as static markers collection. - documentFragment.markers = extractMarkersFromModelFragment( documentFragment, writer ); + // Move all items that was converted to context tree to document fragment. + for ( const item of Array.from( this._modelCursor.parent.getChildren() ) ) { + writer.append( item, documentFragment ); } - // Clear context position. - this._modelCursor = null; + // Extract temporary markers elements from model and set as static markers collection. + documentFragment.markers = extractMarkersFromModelFragment( documentFragment, writer ); + } + + // Clear context position. + this._modelCursor = null; - // Clear split elements. - this._removeIfEmpty.clear(); + // Clear split elements. + this._removeIfEmpty.clear(); - // Clear conversion API. - this.conversionApi.writer = null; - this.conversionApi.store = null; + // Clear conversion API. + this.conversionApi.writer = null; + this.conversionApi.store = null; - // Return fragment as conversion result. - return documentFragment; - } ); + // Return fragment as conversion result. + return documentFragment; } /** diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 2500e298d..4321128ab 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -285,7 +285,8 @@ export function parse( data, schema, options = {} ) { } // Set up upcast dispatcher. - const upcastDispatcher = new UpcastDispatcher( new Model(), { schema, mapper } ); + const modelController = new Model(); + const upcastDispatcher = new UpcastDispatcher( { schema, mapper } ); upcastDispatcher.on( 'documentFragment', convertToModelFragment() ); upcastDispatcher.on( 'element:model-text-with-attributes', convertToModelText( true ) ); @@ -295,7 +296,9 @@ export function parse( data, schema, options = {} ) { upcastDispatcher.isDebug = true; // Convert view to model. - let model = upcastDispatcher.convert( viewDocumentFragment.root, options.context || '$root' ); + let model = modelController.change( + writer => upcastDispatcher.convert( viewDocumentFragment.root, writer, options.context || '$root' ) + ); mapper.bindElements( model, viewDocumentFragment.root ); diff --git a/tests/conversion/two-way-converters.js b/tests/conversion/two-way-converters.js index 135f2462c..b23a3cf3b 100644 --- a/tests/conversion/two-way-converters.js +++ b/tests/conversion/two-way-converters.js @@ -21,7 +21,7 @@ import { stringify as viewStringify, parse as viewParse } from '../../src/dev-ut import { stringify as modelStringify } from '../../src/dev-utils/model'; describe( 'two-way-converters', () => { - let viewDispatcher, model, schema, conversion, modelRoot, viewRoot; + let upcastDispatcher, model, schema, conversion, modelRoot, viewRoot; beforeEach( () => { model = new Model(); @@ -45,13 +45,13 @@ describe( 'two-way-converters', () => { inheritAllFrom: '$block' } ); - viewDispatcher = new UpcastDispatcher( model, { schema } ); - viewDispatcher.on( 'text', convertText() ); - viewDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); - viewDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); + upcastDispatcher = new UpcastDispatcher( { schema } ); + upcastDispatcher.on( 'text', convertText() ); + upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); + upcastDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); conversion = new Conversion(); - conversion.register( 'upcast', [ viewDispatcher ] ); + conversion.register( 'upcast', [ upcastDispatcher ] ); conversion.register( 'downcast', [ controller.downcastDispatcher ] ); } ); @@ -527,9 +527,8 @@ describe( 'two-way-converters', () => { function loadData( input ) { const parsedView = viewParse( input ); - const convertedModel = viewDispatcher.convert( parsedView ); - model.change( writer => { + const convertedModel = upcastDispatcher.convert( parsedView, writer ); writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, modelRoot.maxOffset ) ); writer.insert( convertedModel, modelRoot, 0 ); } ); diff --git a/tests/conversion/upcast-converters.js b/tests/conversion/upcast-converters.js index 77ad33bc2..d54147ed7 100644 --- a/tests/conversion/upcast-converters.js +++ b/tests/conversion/upcast-converters.js @@ -27,7 +27,7 @@ import { import { stringify } from '../../src/dev-utils/model'; describe( 'upcast-helpers', () => { - let dispatcher, model, schema, conversion; + let upcastDispatcher, model, schema, conversion; beforeEach( () => { model = new Model(); @@ -50,13 +50,13 @@ describe( 'upcast-helpers', () => { allowAttributes: [ 'bold' ] } ); - dispatcher = new UpcastDispatcher( model, { schema } ); - dispatcher.on( 'text', convertText() ); - dispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); - dispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); + upcastDispatcher = new UpcastDispatcher( { schema } ); + upcastDispatcher.on( 'text', convertText() ); + upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); + upcastDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); conversion = new Conversion(); - conversion.register( 'upcast', [ dispatcher ] ); + conversion.register( 'upcast', [ upcastDispatcher ] ); } ); describe( 'upcastElementToElement', () => { @@ -600,18 +600,18 @@ describe( 'upcast-helpers', () => { } ); function expectResult( viewToConvert, modelString, marker ) { - const model = dispatcher.convert( viewToConvert ); + const conversionResult = model.change( writer => upcastDispatcher.convert( viewToConvert, writer ) ); if ( marker ) { - expect( model.markers.has( marker.name ) ).to.be.true; + expect( conversionResult.markers.has( marker.name ) ).to.be.true; - const convertedMarker = model.markers.get( marker.name ); + const convertedMarker = conversionResult.markers.get( marker.name ); expect( convertedMarker.start.path ).to.deep.equal( marker.start ); expect( convertedMarker.end.path ).to.deep.equal( marker.end ); } - expect( stringify( model ) ).to.equal( modelString ); + expect( stringify( conversionResult ) ).to.equal( modelString ); } } ); @@ -627,7 +627,7 @@ describe( 'upcast-converters', () => { context = [ '$root' ]; - dispatcher = new UpcastDispatcher( model, { schema } ); + dispatcher = new UpcastDispatcher( { schema } ); } ); describe( 'convertText()', () => { @@ -636,7 +636,7 @@ describe( 'upcast-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText ); + const conversionResult = model.change( writer => dispatcher.convert( viewText, writer ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -658,7 +658,7 @@ describe( 'upcast-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewText, context ); + const conversionResult = model.change( writer => dispatcher.convert( viewText, writer, context ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -674,13 +674,12 @@ describe( 'upcast-converters', () => { const viewText = new ViewText( 'foobar' ); dispatcher.on( 'text', convertText() ); - - let conversionResult = dispatcher.convert( viewText, context ); + let conversionResult = model.change( writer => dispatcher.convert( viewText, writer, context ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 0 ); - conversionResult = dispatcher.convert( viewText, [ '$block' ] ); + conversionResult = model.change( writer => dispatcher.convert( viewText, writer, [ '$block' ] ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.childCount ).to.equal( 1 ); @@ -693,7 +692,7 @@ describe( 'upcast-converters', () => { dispatcher.on( 'text', convertText() ); - const conversionResult = dispatcher.convert( viewText, context ); + const conversionResult = model.change( writer => dispatcher.convert( viewText, writer, context ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelText ); @@ -714,7 +713,7 @@ describe( 'upcast-converters', () => { dispatcher.on( 'element', convertToModelFragment() ); dispatcher.on( 'documentFragment', convertToModelFragment() ); - const conversionResult = dispatcher.convert( viewFragment, context ); + const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer, context ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.maxOffset ).to.equal( 6 ); @@ -741,7 +740,7 @@ describe( 'upcast-converters', () => { } } ); - const conversionResult = dispatcher.convert( viewP, context ); + const conversionResult = model.change( writer => dispatcher.convert( viewP, writer, context ) ); expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); expect( conversionResult.getChild( 0 ) ).to.be.instanceof( ModelElement ); @@ -775,7 +774,7 @@ describe( 'upcast-converters', () => { spy(); } ); - dispatcher.convert( view ); + model.change( writer => dispatcher.convert( view, writer ) ); sinon.assert.calledTwice( spy ); } ); diff --git a/tests/conversion/upcastdispatcher.js b/tests/conversion/upcastdispatcher.js index 4f1375097..278077ef1 100644 --- a/tests/conversion/upcastdispatcher.js +++ b/tests/conversion/upcastdispatcher.js @@ -30,7 +30,7 @@ describe( 'UpcastDispatcher', () => { describe( 'constructor()', () => { it( 'should create UpcastDispatcher with passed api', () => { const apiObj = {}; - const dispatcher = new UpcastDispatcher( model, { apiObj } ); + const dispatcher = new UpcastDispatcher( { apiObj } ); expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj ); expect( dispatcher.conversionApi ).to.have.property( 'convertItem' ).that.is.instanceof( Function ); @@ -39,7 +39,7 @@ describe( 'UpcastDispatcher', () => { } ); it( 'should have properties', () => { - const dispatcher = new UpcastDispatcher( model ); + const dispatcher = new UpcastDispatcher(); expect( dispatcher._removeIfEmpty ).to.instanceof( Set ); } ); @@ -49,7 +49,7 @@ describe( 'UpcastDispatcher', () => { let dispatcher; beforeEach( () => { - dispatcher = new UpcastDispatcher( model ); + dispatcher = new UpcastDispatcher(); } ); it( 'should create api for current conversion process', () => { @@ -100,7 +100,7 @@ describe( 'UpcastDispatcher', () => { spy(); } ); - dispatcher.convert( viewElement ); + model.change( writer => dispatcher.convert( viewElement, writer ) ); // To be sure that both converters was called. sinon.assert.calledTwice( spy ); @@ -115,7 +115,7 @@ describe( 'UpcastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); const viewP = new ViewContainerElement( 'p' ); - dispatcher.convert( viewP ); + model.change( writer => dispatcher.convert( viewP, writer ) ); expect( dispatcher.fire.calledWith( 'viewCleanup', viewP ) ).to.be.true; } ); @@ -127,9 +127,11 @@ describe( 'UpcastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convert( viewText ); - dispatcher.convert( viewElement ); - dispatcher.convert( viewFragment ); + model.change( writer => { + dispatcher.convert( viewText, writer ); + dispatcher.convert( viewElement, writer ); + dispatcher.convert( viewFragment, writer ); + } ); expect( dispatcher.fire.calledWith( 'text' ) ).to.be.true; expect( dispatcher.fire.calledWith( 'element:p' ) ).to.be.true; @@ -163,7 +165,7 @@ describe( 'UpcastDispatcher', () => { data.modelRange = ModelRange.createOn( text ); } ); - const conversionResult = dispatcher.convert( viewText ); + const conversionResult = model.change( writer => dispatcher.convert( viewText, writer ) ); // Check conversion result. // Result should be wrapped in document fragment. @@ -201,7 +203,7 @@ describe( 'UpcastDispatcher', () => { } ); // Use `additionalData` parameter to check if it was passed to the event. - const conversionResult = dispatcher.convert( viewElement ); + const conversionResult = model.change( writer => dispatcher.convert( viewElement, writer ) ); // Check conversion result. // Result should be wrapped in document fragment. @@ -237,7 +239,7 @@ describe( 'UpcastDispatcher', () => { data.modelRange = ModelRange.createOn( text ); } ); - const conversionResult = dispatcher.convert( viewFragment ); + const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer ) ); // Check conversion result. expect( conversionResult ).to.be.instanceof( ModelDocumentFragment ); @@ -288,7 +290,7 @@ describe( 'UpcastDispatcher', () => { spy(); } ); - const result = dispatcher.convert( viewElement ); + const result = model.change( writer => dispatcher.convert( viewElement, writer ) ); // Empty split elements should be removed and we should have the following result: // [

]

foo

@@ -322,7 +324,7 @@ describe( 'UpcastDispatcher', () => { data.modelRange = ModelRange.createIn( data.modelCursor.parent ); } ); - const conversionResult = dispatcher.convert( viewFragment ); + const conversionResult = model.change( writer => dispatcher.convert( viewFragment, writer ) ); expect( conversionResult.markers.size ).to.equal( 2 ); @@ -335,7 +337,7 @@ describe( 'UpcastDispatcher', () => { } ); it( 'should convert according to given context', () => { - dispatcher = new UpcastDispatcher( model, { schema: model.schema } ); + dispatcher = new UpcastDispatcher( { schema: model.schema } ); const spy = sinon.spy(); const viewElement = new ViewContainerElement( 'third' ); @@ -358,12 +360,12 @@ describe( 'UpcastDispatcher', () => { } ); // Default context $root. - dispatcher.convert( viewElement ); + model.change( writer => dispatcher.convert( viewElement, writer ) ); sinon.assert.calledOnce( spy ); expect( checkChildResult ).to.false; // SchemaDefinition as context. - dispatcher.convert( viewElement, [ 'first' ] ); + model.change( writer => dispatcher.convert( viewElement, writer, [ 'first' ] ) ); sinon.assert.calledTwice( spy ); expect( checkChildResult ).to.false; @@ -374,7 +376,7 @@ describe( 'UpcastDispatcher', () => { ] ) ] ); - dispatcher.convert( viewElement, new ModelPosition( fragment, [ 0, 0, 0 ] ) ); + model.change( writer => dispatcher.convert( viewElement, writer, new ModelPosition( fragment, [ 0, 0, 0 ] ) ) ); sinon.assert.calledThrice( spy ); expect( checkChildResult ).to.true; } ); @@ -397,7 +399,7 @@ describe( 'UpcastDispatcher', () => { // Put nodes to documentFragment, this will mock root element and makes possible to create range on them. rootMock = new ModelDocumentFragment( [ modelP, modelText ] ); - dispatcher = new UpcastDispatcher( model, { schema: model.schema } ); + dispatcher = new UpcastDispatcher( { schema: model.schema } ); dispatcher.on( 'element:p', ( evt, data ) => { spyP(); @@ -456,7 +458,7 @@ describe( 'UpcastDispatcher', () => { expect( textResult.modelCursor.path ).to.deep.equal( [ 7 ] ); } ); - dispatcher.convert( new ViewDocumentFragment() ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer ) ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -471,7 +473,7 @@ describe( 'UpcastDispatcher', () => { expect( conversionApi.convertItem( viewNull, data.modelCursor ).modelRange ).to.equal( null ); } ); - dispatcher.convert( new ViewDocumentFragment() ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer ) ); expect( spy.calledOnce ).to.be.true; expect( spyNull.calledOnce ).to.be.true; @@ -485,7 +487,7 @@ describe( 'UpcastDispatcher', () => { } ); expect( () => { - dispatcher.convert( new ViewDocumentFragment() ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer ) ); } ).to.throw( CKEditorError, /^view-conversion-dispatcher-incorrect-result/ ); expect( spy.calledOnce ).to.be.true; @@ -513,7 +515,7 @@ describe( 'UpcastDispatcher', () => { expect( result.modelCursor.path ).to.deep.equal( [ 7 ] ); } ); - dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ) ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment( [ viewP, viewText ] ), writer ) ); expect( spy.calledOnce ).to.be.true; expect( spyP.calledOnce ).to.be.true; @@ -546,7 +548,7 @@ describe( 'UpcastDispatcher', () => { spy(); } ); - dispatcher.convert( new ViewDocumentFragment() ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer ) ); sinon.assert.calledOnce( spy ); } ); @@ -583,7 +585,7 @@ describe( 'UpcastDispatcher', () => { spy(); } ); - dispatcher.convert( new ViewDocumentFragment() ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer ) ); sinon.assert.calledOnce( spy ); } ); @@ -603,7 +605,7 @@ describe( 'UpcastDispatcher', () => { spy(); } ); - dispatcher.convert( new ViewDocumentFragment() ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer ) ); sinon.assert.calledOnce( spy ); } ); @@ -622,7 +624,7 @@ describe( 'UpcastDispatcher', () => { spy(); } ); - dispatcher.convert( new ViewDocumentFragment(), [ '$root', 'paragraph' ] ); + model.change( writer => dispatcher.convert( new ViewDocumentFragment(), writer, [ '$root', 'paragraph' ] ) ); sinon.assert.calledOnce( spy ); } ); } ); From 9d11c6473c0755719f6bd12f45e672fa19c57b7f Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Wed, 14 Feb 2018 17:35:50 +0100 Subject: [PATCH 566/724] Docs: View class overview. [skip ci] --- src/view/view.js | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/src/view/view.js b/src/view/view.js index 77eeeb79c..e9f451f55 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -27,17 +27,19 @@ import { injectQuirksHandling } from './filler'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** - * Editor's view controller class. - * It combines the actual tree of view elements - {@link module:engine/view/document~Document}, tree of DOM elements, - * {@link module:engine/view/domconverter~DomConverter DOM Converter}, {@link module:engine/view/renderer~Renderer renderer} and all - * {@link module:engine/view/observer/observer~Observer observers}. + * Editor's view controller class. Its main responsibility is DOM - View management for editing purposes, to provide + * abstraction over the DOM structure and events and hide all browsers quirks. * - * To modify view nodes use {@link module:engine/view/writer~Writer view writer}, which can be - * accessed by using {@link module:engine/view/view~View#change} method. + * View controller renders view document to DOM whenever view structure changes. To determine when view can be rendered, + * all changes need to be done using the {@link module:engine/view/view~View#change} method, using + * {@link module:engine/view/writer~Writer}: * - * If you want to only transform the tree of view elements to the DOM elements you can use the - * {@link module:engine/view/domconverter~DomConverter DomConverter}. + * view.change( writer => { + * writer.insert( position, writer.createText( 'foo' ) ); + * } ); * + * View controller also register {@link module:engine/view/observer/observer~Observer observers} which observes changes + * on DOM and fire events on the {@link module:engine/view/document~Document Document}. * Note that the following observers are added by the class constructor and are always available: * * * {@link module:engine/view/observer/mutationobserver~MutationObserver}, @@ -46,6 +48,11 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * * {@link module:engine/view/observer/keyobserver~KeyObserver}, * * {@link module:engine/view/observer/fakeselectionobserver~FakeSelectionObserver}. * + * This class also {@link module:engine/view/view~View#attachDomRoot bind DOM and View elements}. + * + * If you do not need full DOM - View management, and want to only transform the tree of view elements to the DOM + * elements you do not need this controller, you can use the {@link module:engine/view/domconverter~DomConverter DomConverter}. + * * @mixes module:utils/observablemixin~ObservableMixin */ export default class View { @@ -285,10 +292,10 @@ export default class View { * after all changes are applied. * * view.change( writer => { - * writer.insert( position1, writer.createText( 'foo' ); + * writer.insert( position1, writer.createText( 'foo' ) ); * * view.change( writer => { - * writer.insert( position2, writer.createText( 'bar' ); + * writer.insert( position2, writer.createText( 'bar' ) ); * } ); * * writer.remove( range ); From 27c79069cbdc9978960eb40fcfdd7e2a340ade86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 17:52:16 +0100 Subject: [PATCH 567/724] Get rid of model parameter from downcast dispatcher. --- src/controller/datacontroller.js | 2 +- src/controller/editingcontroller.js | 6 +++-- src/conversion/downcastdispatcher.js | 21 ++++++---------- src/dev-utils/model.js | 4 ++-- .../downcast-selection-converters.js | 24 +++++++++---------- tests/conversion/downcastdispatcher.js | 22 ++++++++--------- 6 files changed, 37 insertions(+), 42 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 4c8942f30..66fa77d37 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -76,7 +76,7 @@ export default class DataController { * @readonly * @member {module:engine/conversion/downcastdispatcher~DowncastDispatcher} */ - this.downcastDispatcher = new DowncastDispatcher( this.model, { + this.downcastDispatcher = new DowncastDispatcher( { mapper: this.mapper } ); this.downcastDispatcher.on( 'insert:$text', insertText(), { priority: 'lowest' } ); diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 21f0b123d..44dd22c50 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -70,16 +70,18 @@ export default class EditingController { * @readonly * @member {module:engine/conversion/downcastdispatcher~DowncastDispatcher} #downcastDispatcher */ - this.downcastDispatcher = new DowncastDispatcher( this.model, { + this.downcastDispatcher = new DowncastDispatcher( { mapper: this.mapper } ); const doc = this.model.document; + const selection = doc.selection; + const markers = this.model.markers; this.listenTo( doc, 'change', () => { this.view.change( writer => { this.downcastDispatcher.convertChanges( doc.differ, writer ); - this.downcastDispatcher.convertSelection( doc.selection, writer ); + this.downcastDispatcher.convertSelection( selection, markers, writer ); } ); }, { priority: 'low' } ); diff --git a/src/conversion/downcastdispatcher.js b/src/conversion/downcastdispatcher.js index 1f19325a1..0297ad0f9 100644 --- a/src/conversion/downcastdispatcher.js +++ b/src/conversion/downcastdispatcher.js @@ -105,18 +105,9 @@ export default class DowncastDispatcher { /** * Creates a `DowncastDispatcher` instance. * - * @param {module:engine/model/model~Model} model Data model. * @param {Object} [conversionApi] Interface passed by dispatcher to the events calls. */ - constructor( model, conversionApi = {} ) { - /** - * Data model instance bound with this dispatcher. - * - * @private - * @member {module:engine/model/model~Model} - */ - this._model = model; - + constructor( conversionApi = {} ) { /** * Interface passed by dispatcher to the events callbacks. * @@ -250,12 +241,14 @@ export default class DowncastDispatcher { * @fires addMarker * @fires attribute * @param {module:engine/model/selection~Selection} selection Selection to convert. + * @param {module:engine/model/selection~Selection} Array markers + * Array of markers containing model markers. * @param {module:engine/view/writer~Writer} writer View writer that should be used to modify view document. */ - convertSelection( selection, writer ) { + convertSelection( selection, markers, writer ) { this.conversionApi.writer = writer; - const markers = Array.from( this._model.markers.getMarkersAtPosition( selection.getFirstPosition() ) ); - const consumable = this._createSelectionConsumable( selection, markers ); + const markersAtSelection = Array.from( markers.getMarkersAtPosition( selection.getFirstPosition() ) ); + const consumable = this._createSelectionConsumable( selection, markersAtSelection ); this.fire( 'selection', { selection }, consumable, this.conversionApi ); @@ -263,7 +256,7 @@ export default class DowncastDispatcher { return; } - for ( const marker of markers ) { + for ( const marker of markersAtSelection ) { const markerRange = marker.getRange(); if ( !shouldMarkerChangeBeConverted( selection.getFirstPosition(), marker, this.conversionApi.mapper ) ) { diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 4321128ab..a66b7c87c 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -202,7 +202,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { viewDocument.roots.add( viewRoot ); // Create and setup downcast dispatcher. - const downcastDispatcher = new DowncastDispatcher( model, { mapper } ); + const downcastDispatcher = new DowncastDispatcher( { mapper } ); // Bind root elements. mapper.bindElements( node.root, viewRoot ); @@ -228,7 +228,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { // Convert model selection to view selection. if ( selection ) { - downcastDispatcher.convertSelection( selection, writer ); + downcastDispatcher.convertSelection( selection, model.markers, writer ); } // Parse view to data string. diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index 48c2c81c2..20def2bd7 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -54,7 +54,7 @@ describe( 'downcast-selection-converters', () => { highlightDescriptor = { class: 'marker', priority: 1 }; - dispatcher = new DowncastDispatcher( model, { mapper, viewSelection } ); + dispatcher = new DowncastDispatcher( { mapper, viewSelection } ); dispatcher.on( 'insert:$text', insertText() ); @@ -209,7 +209,7 @@ describe( 'downcast-selection-converters', () => { view.change( writer => { dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer ); dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -234,7 +234,7 @@ describe( 'downcast-selection-converters', () => { view.change( writer => { dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer ); dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -261,7 +261,7 @@ describe( 'downcast-selection-converters', () => { view.change( writer => { dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer ); dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -286,7 +286,7 @@ describe( 'downcast-selection-converters', () => { view.change( writer => { dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer ); dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -311,7 +311,7 @@ describe( 'downcast-selection-converters', () => { // Convert model to view. view.change( writer => { - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -336,7 +336,7 @@ describe( 'downcast-selection-converters', () => { const uiElement = new ViewUIElement( 'span' ); viewRoot.insertChildren( 1, uiElement ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -360,7 +360,7 @@ describe( 'downcast-selection-converters', () => { // Add ui element to view. const uiElement = new ViewUIElement( 'span' ); viewRoot.insertChildren( 1, uiElement, writer ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. @@ -441,7 +441,7 @@ describe( 'downcast-selection-converters', () => { writer.setSelection( modelRange ); } ); - dispatcher.convertSelection( modelDoc.selection, writer ); + dispatcher.convertSelection( modelDoc.selection, model.markers, writer ); } ); expect( viewSelection.rangeCount ).to.equal( 1 ); @@ -467,7 +467,7 @@ describe( 'downcast-selection-converters', () => { writer.setSelection( modelRange ); } ); - dispatcher.convertSelection( modelDoc.selection, writer ); + dispatcher.convertSelection( modelDoc.selection, model.markers, writer ); } ); expect( viewSelection.rangeCount ).to.equal( 1 ); @@ -483,7 +483,7 @@ describe( 'downcast-selection-converters', () => { view.change( writer => { writer.setFakeSelection( true ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); expect( viewSelection.isFake ).to.be.false; } ); @@ -594,7 +594,7 @@ describe( 'downcast-selection-converters', () => { // Convert model to view. view.change( writer => { dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer ); - dispatcher.convertSelection( docSelection, writer ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); // Stringify view and check if it is same as expected. diff --git a/tests/conversion/downcastdispatcher.js b/tests/conversion/downcastdispatcher.js index bd2045ee2..7e4866054 100644 --- a/tests/conversion/downcastdispatcher.js +++ b/tests/conversion/downcastdispatcher.js @@ -20,7 +20,7 @@ describe( 'DowncastDispatcher', () => { model = new Model(); view = new View(); doc = model.document; - dispatcher = new DowncastDispatcher( model ); + dispatcher = new DowncastDispatcher(); root = doc.createRoot(); differStub = { @@ -33,7 +33,7 @@ describe( 'DowncastDispatcher', () => { describe( 'constructor()', () => { it( 'should create DowncastDispatcher with given api', () => { const apiObj = {}; - const dispatcher = new DowncastDispatcher( model, { apiObj } ); + const dispatcher = new DowncastDispatcher( { apiObj } ); expect( dispatcher.conversionApi.apiObj ).to.equal( apiObj ); } ); @@ -264,7 +264,7 @@ describe( 'DowncastDispatcher', () => { it( 'should fire selection event', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convertSelection( doc.selection, [] ); + dispatcher.convertSelection( doc.selection, model.markers, [] ); expect( dispatcher.fire.calledWith( 'selection', @@ -284,7 +284,7 @@ describe( 'DowncastDispatcher', () => { expect( consumable.test( data.selection, 'attribute:italic' ) ).to.be.null; } ); - dispatcher.convertSelection( doc.selection, [] ); + dispatcher.convertSelection( doc.selection, model.markers, [] ); } ); it( 'should not fire attributes events for non-collapsed selection', () => { @@ -295,7 +295,7 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convertSelection( doc.selection, [] ); + dispatcher.convertSelection( doc.selection, model.markers, [] ); expect( dispatcher.fire.calledWith( 'attribute:bold' ) ).to.be.false; expect( dispatcher.fire.calledWith( 'attribute:italic' ) ).to.be.false; @@ -314,7 +314,7 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convertSelection( doc.selection, [] ); + dispatcher.convertSelection( doc.selection, model.markers, [] ); expect( dispatcher.fire.calledWith( 'attribute:bold' ) ).to.be.true; } ); @@ -337,7 +337,7 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.convertSelection( doc.selection, [] ); + dispatcher.convertSelection( doc.selection, model.markers, [] ); expect( dispatcher.fire.calledWith( 'attribute:bold' ) ).to.be.false; } ); @@ -353,7 +353,7 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); - dispatcher.convertSelection( doc.selection, markers ); + dispatcher.convertSelection( doc.selection, model.markers, markers ); expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.true; } ); @@ -366,7 +366,7 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); - dispatcher.convertSelection( doc.selection, markers ); + dispatcher.convertSelection( doc.selection, model.markers, markers ); expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.false; } ); @@ -407,7 +407,7 @@ describe( 'DowncastDispatcher', () => { const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); - dispatcher.convertSelection( doc.selection, markers ); + dispatcher.convertSelection( doc.selection, model.markers, markers ); expect( dispatcher.fire.calledWith( 'addMarker:name' ) ).to.be.false; } ); @@ -428,7 +428,7 @@ describe( 'DowncastDispatcher', () => { } ); const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); - dispatcher.convertSelection( doc.selection, markers ); + dispatcher.convertSelection( doc.selection, model.markers, markers ); expect( dispatcher.fire.calledWith( 'addMarker:foo' ) ).to.be.true; expect( dispatcher.fire.calledWith( 'addMarker:bar' ) ).to.be.false; From f63f2a1d0d411a0a10fb341087c5b270881466fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 14 Feb 2018 18:43:42 +0100 Subject: [PATCH 568/724] Passing writer to highlight methods. --- src/conversion/downcast-converters.js | 4 ++-- tests/conversion/downcast-converters.js | 12 ++++-------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index 345350d44..40e7b5d52 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -899,7 +899,7 @@ export function highlightElement( highlightDescriptor ) { consumable.consume( value.item, evt.name ); } - viewElement.getCustomProperty( 'addHighlight' )( viewElement, descriptor ); + viewElement.getCustomProperty( 'addHighlight' )( viewElement, descriptor, conversionApi.writer ); } }; } @@ -947,7 +947,7 @@ export function removeHighlight( highlightDescriptor ) { // First, iterate through all items and remove highlight from those container elements that have custom highlight handling. for ( const item of items ) { if ( item.is( 'containerElement' ) && item.getCustomProperty( 'removeHighlight' ) ) { - item.getCustomProperty( 'removeHighlight' )( item, descriptor.id ); + item.getCustomProperty( 'removeHighlight' )( item, descriptor.id, conversionApi.writer ); // If container element had custom handling, remove all it's children from further processing. for ( const descendant of ViewRange.createIn( item ) ) { diff --git a/tests/conversion/downcast-converters.js b/tests/conversion/downcast-converters.js index de29d8839..13d6e9db2 100644 --- a/tests/conversion/downcast-converters.js +++ b/tests/conversion/downcast-converters.js @@ -1302,16 +1302,12 @@ describe( 'downcast-converters', () => { dispatcher.on( 'insert:div', insertElement( () => { const viewContainer = new ViewContainerElement( 'div' ); - viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor ) => { - controller.view.change( writer => { - writer.addClass( descriptor.class, element ); - } ); + viewContainer._setCustomProperty( 'addHighlight', ( element, descriptor, writer ) => { + writer.addClass( descriptor.class, element ); } ); - viewContainer._setCustomProperty( 'removeHighlight', element => { - controller.view.change( writer => { - writer.setAttribute( 'class', '', element ); - } ); + viewContainer._setCustomProperty( 'removeHighlight', ( element, id, writer ) => { + writer.setAttribute( 'class', '', element ); } ); return viewContainer; From aa1d5595fbbbc80b5e630b960b31a4438b6d5a00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 15 Feb 2018 10:00:58 +0100 Subject: [PATCH 569/724] Remove TODOs from code. --- tests/model/utils/modifyselection.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/tests/model/utils/modifyselection.js b/tests/model/utils/modifyselection.js index e55212a25..353055901 100644 --- a/tests/model/utils/modifyselection.js +++ b/tests/model/utils/modifyselection.js @@ -486,7 +486,6 @@ describe( 'DataController utils', () => { test( 'expands selection to the word start', '

foo bar[b]az

', - // TODO: '

foo [barb]az

', '

foo [bar]baz

', { unit: 'word', direction: 'backward' } ); @@ -496,7 +495,6 @@ describe( 'DataController utils', () => { modifySelection( model, doc.selection, { unit: 'word' } ); - // TODO: expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foo[bar] baz

' ); expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foob[ar] baz

' ); expect( doc.selection.isBackward ).to.false; } ); From 8f772256341e90e054736a9c834b19a5dd1139d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 15 Feb 2018 10:09:50 +0100 Subject: [PATCH 570/724] Docs: Cleanup `modifyselection()`` documentation. --- src/model/utils/modifyselection.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/model/utils/modifyselection.js b/src/model/utils/modifyselection.js index c2eee1309..d99d25c83 100644 --- a/src/model/utils/modifyselection.js +++ b/src/model/utils/modifyselection.js @@ -33,7 +33,7 @@ const wordBoundaryCharacters = ' ,.-():\'"'; * For example `𨭎` is represented in `String` by `\uD862\uDF4E`. Both `\uD862` and `\uDF4E` do not have any meaning * outside the pair (are rendered as ? when alone). Position between them would be incorrect. In this case, selection * extension will include whole "surrogate pair". - * * `'word'` - moves selection by whole word. + * * `'word'` - moves selection by a whole word. * * **Note:** if you extend a forward selection in a backward direction you will in fact shrink it. * @@ -83,7 +83,7 @@ export default function modifySelection( model, selection, options = {} ) { // Checks whether the selection can be extended to the the walker's next value (next position). // @param {{ walker, unit, isForward, schema }} data -// @param {{ item, nextPosition, type}} value +// @param {module:engine/view/treewalker~TreeWalkerValue} value function tryExtendingTo( data, value ) { // If found text, we can certainly put the focus in it. Let's just find a correct position // based on the unit. From 3d8223a2db81701e170912a336d43a2591d47ee1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 15 Feb 2018 10:10:48 +0100 Subject: [PATCH 571/724] Changed: Expand list of suppoprted word-break characters. --- src/model/utils/modifyselection.js | 2 +- tests/model/utils/modifyselection.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/model/utils/modifyselection.js b/src/model/utils/modifyselection.js index d99d25c83..99441fdd5 100644 --- a/src/model/utils/modifyselection.js +++ b/src/model/utils/modifyselection.js @@ -13,7 +13,7 @@ import Range from '../range'; import { isInsideSurrogatePair, isInsideCombinedSymbol } from '@ckeditor/ckeditor5-utils/src/unicode'; import DocumentSelection from '../documentselection'; -const wordBoundaryCharacters = ' ,.-():\'"'; +const wordBoundaryCharacters = ' ,.?!:;"-()'; /** * Modifies the selection. Currently, the supported modifications are: diff --git a/tests/model/utils/modifyselection.js b/tests/model/utils/modifyselection.js index 353055901..75837cd5d 100644 --- a/tests/model/utils/modifyselection.js +++ b/tests/model/utils/modifyselection.js @@ -447,7 +447,7 @@ describe( 'DataController utils', () => { { unit: 'word', direction: 'backward' } ); - for ( const char of [ ' ', ',', '.', '-', '(', ',', ':', '\'', '"' ] ) { + for ( const char of ' ,.?!:;"-()'.split( '' ) ) { testStopCharacter( char ); } From 74df0ae1110a533d9d805dadcca552d82fa83f6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Thu, 15 Feb 2018 10:27:28 +0100 Subject: [PATCH 572/724] Changed: Extracted `getCorrectWordBreakPosition()` from `getCorrectPosition()` in modifyselection. --- src/model/utils/modifyselection.js | 78 +++++++++++++++++++----------- 1 file changed, 51 insertions(+), 27 deletions(-) diff --git a/src/model/utils/modifyselection.js b/src/model/utils/modifyselection.js index 99441fdd5..485a0f35a 100644 --- a/src/model/utils/modifyselection.js +++ b/src/model/utils/modifyselection.js @@ -88,6 +88,10 @@ function tryExtendingTo( data, value ) { // If found text, we can certainly put the focus in it. Let's just find a correct position // based on the unit. if ( value.type == 'text' ) { + if ( data.unit === 'word' ) { + return getCorrectWordBreakPosition( data.walker, data.isForward ); + } + return getCorrectPosition( data.walker, data.unit, data.isForward ); } @@ -125,45 +129,56 @@ function tryExtendingTo( data, value ) { // // @param {module:engine/model/treewalker~TreeWalker} walker // @param {String} unit The unit by which selection should be modified. +function getCorrectPosition( walker, unit ) { + const textNode = walker.position.textNode; + + if ( textNode ) { + const data = textNode.data; + let offset = walker.position.offset - textNode.startOffset; + + while ( isInsideSurrogatePair( data, offset ) || ( unit == 'character' && isInsideCombinedSymbol( data, offset ) ) ) { + walker.next(); + + offset = walker.position.offset - textNode.startOffset; + } + } + + return walker.position; +} + +// Finds a correct position of a word break by walking in a text node and checking whether selection can be extended to given position +// or should be extended further. +// +// @param {module:engine/model/treewalker~TreeWalker} walker // @param {Boolean} isForward Is the direction in which the selection should be modified is forward. -function getCorrectPosition( walker, unit, isForward ) { +function getCorrectWordBreakPosition( walker, isForward ) { let textNode = walker.position.textNode; if ( textNode ) { - let data = textNode.data; let offset = walker.position.offset - textNode.startOffset; - let isAtNodeBoundary = offset === ( isForward ? textNode.endOffset : 0 ); - while ( - isInsideSurrogatePair( data, offset ) || - ( unit == 'character' && isInsideCombinedSymbol( data, offset ) ) || - ( unit == 'word' && ( !( isAtNodeBoundary || isAtWordBoundary( textNode.data, offset, isForward ) ) ) ) - ) { + while ( !isAtWordBoundary( textNode.data, offset, isForward ) && !isAtNodeBoundary( textNode, offset, isForward ) ) { walker.next(); // Check of adjacent text nodes with different attributes (like BOLD). - // Example : 'foofoo []bar<$text bold="true">bar bazbaz' - // should expand to : 'foofoo [bar<$text bold="true">bar] bazbaz'. - if ( unit == 'word' && !isAtNodeBoundary ) { - const nextNode = isForward ? walker.position.nodeAfter : walker.position.nodeBefore; - - if ( nextNode ) { - // Check boundary char of an adjacent text node. - const boundaryChar = nextNode.data.charAt( isForward ? 0 : nextNode.data.length - 1 ); - - // Go to the next node if the character at the boundary of that node belongs to the same word. - if ( !wordBoundaryCharacters.includes( boundaryChar ) ) { - // If adjacent text node belongs to the same word go to it & reset values. - walker.next(); - - textNode = walker.position.textNode; - data = textNode.data; - } + // Example : 'foofoo []bar<$text bold="true">bar bazbaz' + // should expand to : 'foofoo [bar<$text bold="true">bar] bazbaz'. + const nextNode = isForward ? walker.position.nodeAfter : walker.position.nodeBefore; + + if ( nextNode ) { + // Check boundary char of an adjacent text node. + const boundaryChar = nextNode.data.charAt( isForward ? 0 : nextNode.data.length - 1 ); + + // Go to the next node if the character at the boundary of that node belongs to the same word. + if ( !wordBoundaryCharacters.includes( boundaryChar ) ) { + // If adjacent text node belongs to the same word go to it & reset values. + walker.next(); + + textNode = walker.position.textNode; } } offset = walker.position.offset - textNode.startOffset; - isAtNodeBoundary = offset === ( isForward ? textNode.endOffset : 0 ); } } @@ -183,7 +198,7 @@ function getSearchRange( start, isForward ) { // Checks if selection is on word boundary. // -// @param {module:engine/view/text~Text} textNode The text node to investigate. +// @param {String} data The text node value to investigate. // @param {Number} offset Position offset. // @param {Boolean} isForward Is the direction in which the selection should be modified is forward. function isAtWordBoundary( data, offset, isForward ) { @@ -192,3 +207,12 @@ function isAtWordBoundary( data, offset, isForward ) { return wordBoundaryCharacters.includes( data.charAt( offsetToCheck ) ); } + +// Checks if selection is on node boundary. +// +// @param {module:engine/model/text~Text} textNode The text node to investigate. +// @param {Number} offset Position offset. +// @param {Boolean} isForward Is the direction in which the selection should be modified is forward. +function isAtNodeBoundary( textNode, offset, isForward ) { + return offset === ( isForward ? textNode.endOffset : 0 ); +} From e0a0766181790fe0a63f4caa928aa49cfe5866bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 15 Feb 2018 12:00:18 +0100 Subject: [PATCH 573/724] Minor test improvements. --- tests/model/utils/modifyselection.js | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/tests/model/utils/modifyselection.js b/tests/model/utils/modifyselection.js index 75837cd5d..137ca2fee 100644 --- a/tests/model/utils/modifyselection.js +++ b/tests/model/utils/modifyselection.js @@ -459,38 +459,38 @@ describe( 'DataController utils', () => { ); it( 'extends whole word backward (non-collapsed)', () => { - setData( model, '

foo b[a]r

', { lastRangeBackward: true } ); + setData( model, '

foo ba[a]r

', { lastRangeBackward: true } ); modifySelection( model, doc.selection, { unit: 'word', direction: 'backward' } ); - expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foo [ba]r

' ); + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foo [baa]r

' ); expect( doc.selection.isBackward ).to.true; } ); test( 'extends to element boundary', - '

fo[]o

', - '

fo[o]

', + '

fo[]oo

', + '

fo[oo]

', { unit: 'word' } ); it( 'extends to element boundary (backward)', () => { - setData( model, '

f[]oo

' ); + setData( model, '

ff[]oo

' ); modifySelection( model, doc.selection, { unit: 'word', direction: 'backward' } ); - expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[f]oo

' ); + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[ff]oo

' ); expect( doc.selection.isBackward ).to.true; } ); test( - 'expands selection to the word start', + 'expands forward selection to the word start', '

foo bar[b]az

', '

foo [bar]baz

', { unit: 'word', direction: 'backward' } ); - it( 'expands backward selection to word end', () => { + it( 'expands backward selection to the word end', () => { setData( model, '

foo[b]ar baz

', { lastRangeBackward: true } ); modifySelection( model, doc.selection, { unit: 'word' } ); @@ -509,9 +509,9 @@ describe( 'DataController utils', () => { it( 'unicode support - combining mark backward', () => { setData( model, '

foob̂[]ar

' ); - modifySelection( model, doc.selection, { direction: 'backward' } ); + modifySelection( model, doc.selection, { direction: 'backward', unit: 'word' } ); - expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

foo[b̂]ar

' ); + expect( stringify( doc.getRoot(), doc.selection ) ).to.equal( '

[foob̂]ar

' ); expect( doc.selection.isBackward ).to.true; } ); From b1580a080cfea73023ae87c9e2471c10bebf4707 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 15 Feb 2018 13:08:56 +0100 Subject: [PATCH 574/724] Updated highlighting manual test. --- tests/manual/highlight.js | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/tests/manual/highlight.js b/tests/manual/highlight.js index 81f819e2d..2b26018eb 100644 --- a/tests/manual/highlight.js +++ b/tests/manual/highlight.js @@ -39,7 +39,7 @@ class FancyWidget extends Plugin { init() { const editor = this.editor; const schema = editor.model.schema; - const data = editor.data; + const conversion = editor.conversion; // Configure schema. schema.register( 'fancywidget', { @@ -47,21 +47,22 @@ class FancyWidget extends Plugin { } ); schema.extend( 'fancywidget', { allowIn: '$root' } ); - downcastElementToElement( { + conversion.for( 'editingDowncast' ).add( downcastElementToElement( { model: 'fancywidget', view: ( modelItem, consumable, conversionApi ) => { const viewWriter = conversionApi.writer; const widgetElement = viewWriter.createContainerElement( 'figure', { class: 'fancy-widget' } ); viewWriter.insert( ViewPosition.createAt( widgetElement ), viewWriter.createText( 'widget' ) ); - return toWidget( widgetElement ); + return toWidget( widgetElement, viewWriter ); } - } )( data.downcastDispatcher ); + } ) ); - upcastElementToElement( { - view: 'figure', - model: 'fancywidget' - } )( data.upcastDispatcher ); + conversion.for( 'upcast' ) + .add( upcastElementToElement( { + view: 'figure', + model: 'fancywidget' + } ) ); } } @@ -72,12 +73,12 @@ ClassicEditor.create( global.document.querySelector( '#editor' ), { .then( editor => { window.editor = editor; - downcastMarkerToHighlight( { + editor.conversion.for( 'editingDowncast' ).add( downcastMarkerToHighlight( { model: 'marker', view: data => ( { class: 'highlight-' + data.markerName.split( ':' )[ 1 ] } ) - } ); + } ) ); document.getElementById( 'add-marker-yellow' ).addEventListener( 'mousedown', evt => { addMarker( editor, 'yellow' ); From 4b33b87bfe6bf143e52724b38035fd533635cc5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 15 Feb 2018 13:17:22 +0100 Subject: [PATCH 575/724] Fixed nested editable manual test. --- tests/manual/markers.js | 4 ++-- tests/manual/nestededitable.js | 12 +++++------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/tests/manual/markers.js b/tests/manual/markers.js index fcf7da1b3..bc7f4594a 100644 --- a/tests/manual/markers.js +++ b/tests/manual/markers.js @@ -35,7 +35,7 @@ ClassicEditor window.editor = editor; model = editor.model; - downcastMarkerToHighlight( { + editor.conversion.for( 'editingDowncast' ).add( downcastMarkerToHighlight( { model: 'highlight', view: data => { const color = data.markerName.split( ':' )[ 1 ]; @@ -45,7 +45,7 @@ ClassicEditor priority: 1 }; } - } ); + } ) ); window.document.getElementById( 'add-yellow' ).addEventListener( 'mousedown', e => { e.preventDefault(); diff --git a/tests/manual/nestededitable.js b/tests/manual/nestededitable.js index 05c4cc057..08ba48b1e 100644 --- a/tests/manual/nestededitable.js +++ b/tests/manual/nestededitable.js @@ -13,7 +13,6 @@ import { downcastElementToElement } from '../../src/conversion/downcast-converters'; -import ViewEditableElement from '../../src/view/editableelement'; import { getData } from '../../src/dev-utils/model'; import global from '@ckeditor/ckeditor5-utils/src/dom/global'; @@ -30,7 +29,6 @@ class NestedEditable extends Plugin { init() { const editor = this.editor; const editing = editor.editing; - const viewDocument = editing.view; const schema = editor.model.schema; schema.register( 'figure', { @@ -60,15 +58,15 @@ class NestedEditable extends Plugin { editor.conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'figcaption', - view: () => { - const element = new ViewEditableElement( 'figcaption', { contenteditable: 'true' } ); - element.document = viewDocument; + view: ( modelItem, consumable, conversionApi ) => { + const viewWriter = conversionApi.writer; + const element = viewWriter.createEditableElement( 'figcaption', { contenteditable: 'true' } ); element.on( 'change:isFocused', ( evt, property, is ) => { if ( is ) { - element.addClass( 'focused' ); + editing.view.change( writer => writer.addClass( 'focused', element ) ); } else { - element.removeClass( 'focused' ); + editing.view.change( writer => writer.removeClass( 'focused', element ) ); } } ); From 5ac0d62ee8aceea0d01e56f1cb58b970e0c881bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 15 Feb 2018 13:39:53 +0100 Subject: [PATCH 576/724] Updated manual test for ckeditor5-721. --- tests/manual/tickets/ckeditor5-721/1.js | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/tests/manual/tickets/ckeditor5-721/1.js b/tests/manual/tickets/ckeditor5-721/1.js index 1a5c1c7e7..5c4d3b51c 100644 --- a/tests/manual/tickets/ckeditor5-721/1.js +++ b/tests/manual/tickets/ckeditor5-721/1.js @@ -12,11 +12,9 @@ import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; import { toWidget } from '@ckeditor/ckeditor5-widget/src/utils'; import Widget from '@ckeditor/ckeditor5-widget/src/widget'; -import AttributeContainer from '../../../../src/view/attributeelement'; -import ViewContainer from '../../../../src/view/containerelement'; +import ViewPosition from '../../../../src/view/position'; import { downcastElementToElement } from '../../../../src/conversion/downcast-converters'; import { setData } from '../../../../src/dev-utils/model'; -import ViewEditable from '../../../../src/view/editableelement'; ClassicEditor .create( document.querySelector( '#editor' ), { @@ -45,16 +43,19 @@ ClassicEditor editor.conversion.for( 'downcast' ) .add( downcastElementToElement( { model: 'widget', - view: () => { - const b = new AttributeContainer( 'b' ); - const div = new ViewContainer( 'div', null, b ); + view: ( modelItem, consumable, conversionApi ) => { + const writer = conversionApi.writer; + const b = writer.createAttributeElement( 'b' ); + const div = writer.createContainerElement( 'div' ); - return toWidget( div, { label: 'element label' } ); + writer.insert( ViewPosition.createAt( div ), b ); + + return toWidget( div, writer, { label: 'element label' } ); } } ) ) .add( downcastElementToElement( { model: 'nested', - view: () => new ViewEditable( 'figcaption', { contenteditable: true } ) + view: ( item, consumable, api ) => api.writer.createEditableElement( 'figcaption', { contenteditable: true } ) } ) ); setData( editor.model, From b1190885596410a790b4a23a825174dca596ad47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 15 Feb 2018 15:07:59 +0100 Subject: [PATCH 577/724] Updated fake selection manual test. --- tests/view/manual/fakeselection.js | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/tests/view/manual/fakeselection.js b/tests/view/manual/fakeselection.js index 68738afc2..315edddff 100644 --- a/tests/view/manual/fakeselection.js +++ b/tests/view/manual/fakeselection.js @@ -58,24 +58,20 @@ viewDocument.selection.on( 'change', () => { const lastPos = viewDocument.selection.getLastPosition(); if ( firstPos && lastPos && firstPos.nodeAfter == viewStrong && lastPos.nodeBefore == viewStrong ) { - viewStrong.addClass( 'selected' ); + view.change( writer => writer.addClass( 'selected', viewStrong ) ); } else { - viewStrong.removeClass( 'selected' ); + view.change( writer => writer.removeClass( 'selected', viewStrong ) ); } } ); viewDocument.on( 'focus', () => { - view.change( () => { - viewStrong.addClass( 'focused' ); - } ); + view.change( writer => writer.addClass( 'focused', viewStrong ) ); console.log( 'The document was focused.' ); } ); viewDocument.on( 'blur', () => { - view.change( () => { - viewStrong.removeClass( 'focused' ); - } ); + view.change( writer => writer.removeClass( 'focused', viewStrong ) ); console.log( 'The document was blurred.' ); } ); From 61edf032a8932f691d6c90b919a585fcd74a605a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 15 Feb 2018 15:22:13 +0100 Subject: [PATCH 578/724] Updated UIElement manual test. --- tests/view/manual/uielement.js | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/tests/view/manual/uielement.js b/tests/view/manual/uielement.js index ddb8b1981..3d99db59e 100644 --- a/tests/view/manual/uielement.js +++ b/tests/view/manual/uielement.js @@ -16,29 +16,25 @@ import Undo from '@ckeditor/ckeditor5-undo/src/undo'; import Position from '../../../src/view/position'; function createEndingUIElement( writer ) { - const element = writer.createUIElement( 'span' ); - - element.render = function( domDocument ) { + const element = writer.createUIElement( 'span', null, function( domDocument ) { const root = this.toDomElement( domDocument ); root.classList.add( 'ui-element' ); root.innerHTML = 'END OF PARAGRAPH'; return root; - }; + } ); return element; } function createMiddleUIElement( writer ) { - const element = writer.createUIElement( 'span' ); - - element.render = function( domDocument ) { + const element = writer.createUIElement( 'span', null, function( domDocument ) { const root = this.toDomElement( domDocument ); root.classList.add( 'ui-element' ); root.innerHTML = 'X'; return root; - }; + } ); return element; } From 47371daf20bde313748ea82d60cdd7a9a0d65ebc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 15 Feb 2018 16:50:32 +0100 Subject: [PATCH 579/724] Fixed docs. --- src/view/view.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/view/view.js b/src/view/view.js index e9f451f55..8a493152e 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -304,7 +304,7 @@ export default class View { * Change block is executed immediately. * * When the outermost change block is done and rendering to DOM is over it fires - * {@link module:engine/view/document~Document#event:change} event. + * {@link module:engine/view/view~View#event:render} event. * * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when * change block is used after rendering to DOM has started. From 08eb9c969057bbc5a8a39f4ac26ac8a5b440dbb9 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 16 Feb 2018 10:45:48 +0100 Subject: [PATCH 580/724] Removed unneeded code. --- src/conversion/downcastdispatcher.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/conversion/downcastdispatcher.js b/src/conversion/downcastdispatcher.js index 0297ad0f9..00c4068a7 100644 --- a/src/conversion/downcastdispatcher.js +++ b/src/conversion/downcastdispatcher.js @@ -123,8 +123,6 @@ export default class DowncastDispatcher { * @param {module:engine/view/writer~Writer} writer View writer that should be used to modify view document. */ convertChanges( differ, writer ) { - this.conversionApi.writer = writer; - // Convert changes that happened on model tree. for ( const entry of differ.getChanges() ) { if ( entry.type == 'insert' ) { From 8a07e761de42d53d6c48b5c428eda3a18f818e4d Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Fri, 16 Feb 2018 10:54:50 +0100 Subject: [PATCH 581/724] Docs: use proper writer methods. --- src/view/element.js | 2 +- src/view/writer.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/view/element.js b/src/view/element.js index 210530b74..4361a180b 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -539,7 +539,7 @@ export default class Element extends Node { * * For example: * - * const element = new ViewElement( 'foo', { + * const element = writer.createContainerElement( 'foo', { * banana: '10', * apple: '20', * style: 'color: red; border-color: white;', diff --git a/src/view/writer.js b/src/view/writer.js index 32e48fc6b..1b54e87c3 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -53,7 +53,7 @@ export default class Writer { * writer.setSelection( position ); * * // Sets collapsed range on the given item. - * const paragraph = writer.createElement( 'paragraph' ); + * const paragraph = writer.createContainerElement( 'paragraph' ); * writer.setSelection( paragraph, offset ); * * // Removes all ranges. From 1aee37051c71145270d23398ce945cac744fcc92 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 16 Feb 2018 11:25:41 +0100 Subject: [PATCH 582/724] LiveRange#change:range event will not be fired multiple times. Introduced a new callback for Model#applyOperation which listen for the selection ranges changes. --- src/model/documentselection.js | 47 ++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 14 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 4a51d86ee..dd50a8f7a 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -455,13 +455,19 @@ class LiveSelection extends Selection { // @member {Map} module:engine/model/liveselection~LiveSelection#_attributePriority this._attributePriority = new Map(); - // Add events that will ensure selection correctness. - this.on( 'change:range', ( evt, options ) => { - // If the `options.range` is specified, only the passed Range will be checked. - // It prevents to checking selection's ranges before they are updated. Read more #1281. - const ranges = options.range ? [ options.range ] : Array.from( this.getRanges() ); + // Contains data requires to fix ranges which have been moved to the graveyard + // @private + // @member {Array} module:engine/model/liveselection~LiveSelection#_fixGraveyardRangesData + this._fixGraveyardRangesData = []; + + // Flag that informs whether the selection ranges have changed. It is changed on true when `LiveRange#change:range event is fired. + // @private + // @member {Array} module:engine/model/liveselection~LiveSelection#_hasChangedRange + this._hasChangedRange = false; - for ( const range of ranges ) { + // Add events that will ensure selection correctness. + this.on( 'change:range', () => { + for ( const range of this.getRanges() ) { if ( !this._document._validateSelectionRange( range ) ) { /** * Range from {@link module:engine/model/documentselection~DocumentSelection document selection} @@ -501,6 +507,20 @@ class LiveSelection extends Selection { clearAttributesStoredInElement( operation, this._model, batch ); } }, { priority: 'low' } ); + + this.listenTo( this._model, 'applyOperation', () => { + while ( this._fixGraveyardRangesData.length ) { + const { range, sourcePosition } = this._fixGraveyardRangesData.shift(); + + this._fixGraveyardSelection( range, sourcePosition ); + } + + if ( this._hasChangedRange ) { + this._hasChangedRange = false; + + this.fire( 'change:range', { directChange: false } ); + } + }, { priority: 'lowest' } ); } get isCollapsed() { @@ -622,13 +642,15 @@ class LiveSelection extends Selection { const liveRange = LiveRange.createFromRange( range ); liveRange.on( 'change:range', ( evt, oldRange, data ) => { - // If `LiveRange` is in whole moved to the graveyard, fix that range. + this._hasChangedRange = true; + + // If `LiveRange` is in whole moved to the graveyard, save necessary data. It will be fixed on `Model#applyOperation` event. if ( liveRange.root == this._document.graveyard ) { - this._fixGraveyardSelection( liveRange, data.sourcePosition ); + this._fixGraveyardRangesData.push( { + range: liveRange, + position: data.sourcePosition + } ); } - - // Whenever a live range from selection changes, fire an event informing about that change. - this.fire( 'change:range', { directChange: false, range: liveRange } ); } ); return liveRange; @@ -894,9 +916,6 @@ class LiveSelection extends Selection { this._ranges.splice( index, 0, newRange ); } // If nearest valid selection range cannot be found - just removing the old range is fine. - - // Fire an event informing about selection change. - this.fire( 'change:range', { directChange: false } ); } } From a6ae6349cd99b4bf92d9e787d6d1fb036559c674 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 16 Feb 2018 11:30:01 +0100 Subject: [PATCH 583/724] Fixed invalid variable name. --- src/model/documentselection.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index dd50a8f7a..86ab51b51 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -510,9 +510,9 @@ class LiveSelection extends Selection { this.listenTo( this._model, 'applyOperation', () => { while ( this._fixGraveyardRangesData.length ) { - const { range, sourcePosition } = this._fixGraveyardRangesData.shift(); + const { range, position } = this._fixGraveyardRangesData.shift(); - this._fixGraveyardSelection( range, sourcePosition ); + this._fixGraveyardSelection( range, position ); } if ( this._hasChangedRange ) { From 1a1c81ac4d8ec5cd61c39216f8012fb167209507 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Fri, 16 Feb 2018 11:35:15 +0100 Subject: [PATCH 584/724] Minor changes in variable names. --- src/model/documentselection.js | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 86ab51b51..80ef4176e 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -510,9 +510,12 @@ class LiveSelection extends Selection { this.listenTo( this._model, 'applyOperation', () => { while ( this._fixGraveyardRangesData.length ) { - const { range, position } = this._fixGraveyardRangesData.shift(); + const { liveRange, sourcePosition } = this._fixGraveyardRangesData.shift(); - this._fixGraveyardSelection( range, position ); + // Checks whether the liveRange still belongs to graveyard. + if ( liveRange.root == this._document.graveyard ) { + this._fixGraveyardSelection( liveRange, sourcePosition ); + } } if ( this._hasChangedRange ) { @@ -647,8 +650,8 @@ class LiveSelection extends Selection { // If `LiveRange` is in whole moved to the graveyard, save necessary data. It will be fixed on `Model#applyOperation` event. if ( liveRange.root == this._document.graveyard ) { this._fixGraveyardRangesData.push( { - range: liveRange, - position: data.sourcePosition + liveRange, + sourcePosition: data.sourcePosition } ); } } ); From 3f8964524f9546940d02b60730b995c361460685 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 8 Feb 2018 19:40:29 +0100 Subject: [PATCH 585/724] Feature: Keep the same marker instance when marker is updated. --- src/model/markercollection.js | 122 +++++++++++++++++-------- tests/model/markercollection.js | 153 +++++++++++++++++++++++++------- 2 files changed, 209 insertions(+), 66 deletions(-) diff --git a/src/model/markercollection.js b/src/model/markercollection.js index 9e3c4aecb..a53743785 100644 --- a/src/model/markercollection.js +++ b/src/model/markercollection.js @@ -17,8 +17,7 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix'; /** * The collection of all {@link module:engine/model/markercollection~Marker markers} attached to the document. * It lets you {@link module:engine/model/markercollection~MarkerCollection#get get} markers or track them using - * {@link module:engine/model/markercollection~MarkerCollection#event:set} and - * {@link module:engine/model/markercollection~MarkerCollection#event:remove} events. + * {@link module:engine/model/markercollection~MarkerCollection#event:update} event. * * To create, change or remove makers use {@link module:engine/model/writer~Writer model writers'} methods: * {@link module:engine/model/writer~Writer#setMarker} or {@link module:engine/model/writer~Writer#removeMarker}. Since @@ -79,17 +78,16 @@ export default class MarkerCollection { * Creates and adds a {@link ~Marker marker} to the `MarkerCollection` with given name on given * {@link module:engine/model/range~Range range}. * - * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed) and the range to - * set is different, the marker in collection is removed and then new marker is added. If the range was same, nothing - * happens and `false` is returned. + * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed), the marker in + * collection is updated and {module:engine/model/markercollection~MarkerCollection#event:update} event is fired but only + * if there was a change (marker range or {@link ~Marker#managedUsingOperations} flag has changed. * * @protected - * @fires module:engine/model/markercollection~MarkerCollection#event:set - * @fires module:engine/model/markercollection~MarkerCollection#event:remove + * @fires module:engine/model/markercollection~MarkerCollection#event:update * @param {String|module:engine/model/markercollection~Marker} markerOrName Name of marker to set or marker instance to update. * @param {module:engine/model/range~Range} range Marker range. * @param {Boolean} managedUsingOperations Specifies whether the marker is managed using operations. - * @returns {module:engine/model/markercollection~Marker} `Marker` instance added to the collection. + * @returns {module:engine/model/markercollection~Marker} Added or updated `Marker` instance. */ _set( markerOrName, range, managedUsingOperations ) { const markerName = markerOrName instanceof Marker ? markerOrName.name : markerOrName; @@ -97,19 +95,30 @@ export default class MarkerCollection { if ( oldMarker ) { const oldRange = oldMarker.getRange(); + let hasChanged = false; - if ( oldRange.isEqual( range ) && managedUsingOperations === oldMarker.managedUsingOperations ) { - return oldMarker; + if ( !oldRange.isEqual( range ) ) { + oldMarker._attachLiveRange( LiveRange.createFromRange( range ) ); + hasChanged = true; } - this._remove( markerName ); + if ( !!managedUsingOperations !== oldMarker.managedUsingOperations ) { + oldMarker._managedUsingOperations = managedUsingOperations; + hasChanged = true; + } + + if ( hasChanged ) { + this.fire( 'update:' + markerName, oldMarker, oldRange, range ); + } + + return oldMarker; } const liveRange = LiveRange.createFromRange( range ); const marker = new Marker( markerName, liveRange, managedUsingOperations ); this._markers.set( markerName, marker ); - this.fire( 'set:' + markerName, marker ); + this.fire( 'update:' + markerName, marker, null, range ); return marker; } @@ -118,6 +127,7 @@ export default class MarkerCollection { * Removes given {@link ~Marker marker} or a marker with given name from the `MarkerCollection`. * * @protected + * @fires module:engine/model/markercollection~MarkerCollection#event:update * @param {String} markerOrName Marker or name of a marker to remove. * @returns {Boolean} `true` if marker was found and removed, `false` otherwise. */ @@ -127,7 +137,7 @@ export default class MarkerCollection { if ( oldMarker ) { this._markers.delete( markerName ); - this.fire( 'remove:' + markerName, oldMarker ); + this.fire( 'update:' + markerName, oldMarker, oldMarker.getRange(), null ); this._destroyMarker( oldMarker ); @@ -193,22 +203,18 @@ export default class MarkerCollection { */ _destroyMarker( marker ) { marker.stopListening(); - marker._liveRange.detach(); - marker._liveRange = null; + marker._detachLiveRange(); } /** - * Fired whenever marker is added or updated in `MarkerCollection`. + * Fired whenever marker is added, updated or removed from `MarkerCollection`. * - * @event set - * @param {module:engine/model/markercollection~Marker} The set marker. - */ - - /** - * Fired whenever marker is removed from `MarkerCollection`. - * - * @event remove - * @param {module:engine/model/markercollection~Marker} marker The removed marker. + * @event update + * @param {module:engine/model/markercollection~Marker} Updated Marker. + * @param {module:engine/model/range~Range|null} oldRange Marker range before the update. When is not defined it + * means that marker is just added. + * @param {module:engine/model/range~Range|null} newRange Marker range after update. When is not defined it + * means that marker is just removed. */ } @@ -291,6 +297,7 @@ class Marker { * * @param {String} name Marker name. * @param {module:engine/model/liverange~LiveRange} liveRange Range marked by the marker. + * @param {Boolean} managedUsingOperations Specifies whether the marker is managed using operations. */ constructor( name, liveRange, managedUsingOperations ) { /** @@ -302,25 +309,35 @@ class Marker { this.name = name; /** - * Flag indicates if the marker is managed using operations or not. See {@link ~Marker marker class description} - * to learn more about marker types. See {@link module:engine/model/writer~Writer#setMarker}. + * Flag indicates if the marker is managed using operations or not. * - * @readonly - * @type {Boolean} + * @protected + * @member {Boolean} */ - this.managedUsingOperations = managedUsingOperations; + this._managedUsingOperations = !!managedUsingOperations; /** * Range marked by the marker. * - * @protected - * @type {module:engine/model/liverange~LiveRange} + * @private + * @member {module:engine/model/liverange~LiveRange} #_liveRange */ - this._liveRange = liveRange; + this._liveRange = this._attachLiveRange( liveRange ); + } - // Delegating does not work with namespaces. Alternatively, we could delegate all events (using `*`). - this._liveRange.delegate( 'change:range' ).to( this ); - this._liveRange.delegate( 'change:content' ).to( this ); + /** + * Returns value of flag indicates if the marker is managed using operations or not. + * See {@link ~Marker marker class description} to learn more about marker types. + * See {@link module:engine/model/writer~Writer#setMarker}. + * + * @returns {Boolean} + */ + get managedUsingOperations() { + if ( !this._liveRange ) { + throw new CKEditorError( 'marker-destroyed: Cannot use a destroyed marker instance.' ); + } + + return this._managedUsingOperations; } /** @@ -369,6 +386,39 @@ class Marker { return Range.createFromRange( this._liveRange ); } + /** + * Binds new live range to marker and detach the old one if is attached. + * + * @protected + * @param {module:engine/model/liverange~LiveRange} liveRange Live range to attach + * @return {module:engine/model/liverange~LiveRange} Attached live range. + */ + _attachLiveRange( liveRange ) { + if ( this._liveRange ) { + this._detachLiveRange(); + } + + // Delegating does not work with namespaces. Alternatively, we could delegate all events (using `*`). + liveRange.delegate( 'change:range' ).to( this ); + liveRange.delegate( 'change:content' ).to( this ); + + this._liveRange = liveRange; + + return liveRange; + } + + /** + * Unbinds and destroys currently attached live range. + * + * @protected + */ + _detachLiveRange() { + this._liveRange.stopDelegating( 'change:range', this ); + this._liveRange.stopDelegating( 'change:content', this ); + this._liveRange.detach(); + this._liveRange = null; + } + /** * Fired whenever {@link ~Marker#_liveRange marker range} is changed due to changes on {@link module:engine/model/document~Document}. * This is a delegated {@link module:engine/model/liverange~LiveRange#event:change:range LiveRange change:range event}. diff --git a/tests/model/markercollection.js b/tests/model/markercollection.js index 138a39083..6ff926196 100644 --- a/tests/model/markercollection.js +++ b/tests/model/markercollection.js @@ -6,6 +6,7 @@ import MarkerCollection from '../../src/model/markercollection'; import Position from '../../src/model/position'; import Range from '../../src/model/range'; +import LiveRange from '../../src/model/liverange'; import Text from '../../src/model/text'; import Model from '../../src/model/model'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; @@ -41,7 +42,7 @@ describe( 'MarkerCollection', () => { } ); describe( '_set', () => { - it( 'should create a marker, fire set: event and return true', () => { + it( 'should create a marker and fire update:', () => { sinon.spy( markers, 'fire' ); const result = markers._set( 'name', range ); @@ -49,47 +50,71 @@ describe( 'MarkerCollection', () => { expect( result ).to.equal( marker ); expect( marker.name ).to.equal( 'name' ); + expect( marker.managedUsingOperations ).to.false; expect( marker.getRange().isEqual( range ) ).to.be.true; - expect( markers.fire.calledWithExactly( 'set:name', marker ) ).to.be.true; + sinon.assert.calledWithExactly( markers.fire, 'update:name', result, null, range ); } ); - it( 'should fire remove: event, and create a new marker if marker with given name was in the collection', () => { - const marker1 = markers._set( 'name', range ); + it( 'should create a marker marked as managed by operations', () => { + const marker = markers._set( 'name', range, true ); + + expect( marker.managedUsingOperations ).to.true; + } ); + + it( 'should update marker range and fire update: event if marker with given name was in the collection', () => { + const marker = markers._set( 'name', range ); sinon.spy( markers, 'fire' ); + sinon.spy( marker, '_detachLiveRange' ); + sinon.spy( marker, '_attachLiveRange' ); - const marker2 = markers._set( 'name', range2 ); + const result = markers._set( 'name', range2 ); - expect( markers.fire.calledWithExactly( 'remove:name', marker1 ) ).to.be.true; - expect( markers.fire.calledWithExactly( 'set:name', marker2 ) ).to.be.true; + expect( result ).to.equal( marker ); + expect( marker.getRange().isEqual( range2 ) ).to.be.true; + + sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, range2 ); + sinon.assert.calledOnce( marker._detachLiveRange ); + sinon.assert.calledOnce( marker._detachLiveRange ); + } ); - expect( marker2.name ).to.equal( 'name' ); - expect( marker2.getRange().isEqual( range2 ) ).to.be.true; + it( 'should update marker#managedUsingOperations and fire update: event if marker with given name ' + + 'was in the collection', + () => { + const marker = markers._set( 'name', range ); - expect( marker1 ).not.to.equal( marker2 ); + sinon.spy( markers, 'fire' ); + sinon.spy( marker, '_detachLiveRange' ); + sinon.spy( marker, '_attachLiveRange' ); + + const result = markers._set( 'name', range, true ); + + expect( result ).to.equal( marker ); + expect( marker.managedUsingOperations ).to.true; + expect( marker.getRange().isEqual( range ) ).to.be.true; + + sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, range ); + sinon.assert.notCalled( marker._detachLiveRange ); + sinon.assert.notCalled( marker._attachLiveRange ); } ); - it( 'should not fire event and return the same marker if given marker has a range equal to given range', () => { - const marker1 = markers._set( 'name', range ); + it( 'should not fire event if given marker has not changed', () => { + const marker = markers._set( 'name', range ); sinon.spy( markers, 'fire' ); - const marker2 = markers._set( 'name', range ); + const result = markers._set( 'name', range ); - expect( marker1 ).to.equal( marker2 ); - expect( markers.fire.notCalled ).to.be.true; + expect( marker ).to.equal( result ); + sinon.assert.notCalled( markers.fire ); } ); it( 'should accept marker instance instead of name', () => { - markers._set( 'name', range ); - const marker1 = markers.get( 'name' ); + const marker = markers._set( 'name', range ); - const result = markers._set( marker1, range2 ); - const marker2 = markers.get( 'name' ); + markers._set( marker, range2 ); - expect( result ).to.equal( marker2 ); - expect( marker2.getRange().isEqual( range2 ) ); - expect( marker1 ).not.to.equal( marker2 ); + expect( marker.getRange().isEqual( range2 ) ).to.true; } ); } ); @@ -115,7 +140,7 @@ describe( 'MarkerCollection', () => { } ); describe( '_remove', () => { - it( 'should remove marker, return true and fire remove: event', () => { + it( 'should remove marker, return true and fire update: event', () => { const marker = markers._set( 'name', range ); sinon.spy( markers, 'fire' ); @@ -123,22 +148,20 @@ describe( 'MarkerCollection', () => { const result = markers._remove( 'name' ); expect( result ).to.be.true; - expect( markers.fire.calledWithExactly( 'remove:name', marker ) ).to.be.true; expect( markers.get( 'name' ) ).to.be.null; + sinon.assert.calledWithExactly( markers.fire, 'update:name', marker, range, null ); } ); it( 'should destroy marker instance', () => { const marker = markers._set( 'name', range ); - const liveRange = marker._liveRange; sinon.spy( marker, 'stopListening' ); - sinon.spy( liveRange, 'detach' ); + sinon.spy( marker, '_detachLiveRange' ); markers._remove( 'name' ); expect( marker.stopListening.calledOnce ).to.be.true; - expect( marker._liveRange ).to.be.null; - expect( liveRange.detach.calledOnce ).to.be.true; + expect( marker._detachLiveRange.calledOnce ).to.be.true; } ); it( 'should return false if name has not been found in collection', () => { @@ -160,7 +183,7 @@ describe( 'MarkerCollection', () => { const result = markers._remove( marker ); expect( result ).to.be.true; - expect( markers.fire.calledWithExactly( 'remove:name', marker ) ).to.be.true; + expect( markers.fire.calledWithExactly( 'update:name', marker, range, null ) ).to.be.true; expect( markers.get( 'name' ) ).to.be.null; } ); } ); @@ -255,9 +278,13 @@ describe( 'Marker', () => { expect( () => { marker.getEnd(); } ).to.throw( CKEditorError, /^marker-destroyed/ ); + + expect( () => { + marker.managedUsingOperations; + } ).to.throw( CKEditorError, /^marker-destroyed/ ); } ); - it( 'should delegate events from live range', () => { + it( 'should attach live range to marker', () => { const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); const marker = model.markers._set( 'name', range ); @@ -273,4 +300,70 @@ describe( 'Marker', () => { expect( eventRange.calledOnce ).to.be.true; expect( eventContent.calledOnce ).to.be.true; } ); + + it( 'should detach live range from marker', () => { + const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); + const marker = model.markers._set( 'name', range ); + const liveRange = marker._liveRange; + + const eventRange = sinon.spy(); + const eventContent = sinon.spy(); + sinon.spy( liveRange, 'detach' ); + + marker.on( 'change:range', eventRange ); + marker.on( 'change:content', eventContent ); + + marker._detachLiveRange(); + + liveRange.fire( 'change:range', null, {} ); + liveRange.fire( 'change:content', null, {} ); + + expect( eventRange.notCalled ).to.be.true; + expect( eventContent.notCalled ).to.be.true; + expect( liveRange.detach.calledOnce ).to.true; + } ); + + it( 'should reattach live range to marker', () => { + const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); + const marker = model.markers._set( 'name', range ); + const oldLiveRange = marker._liveRange; + const newLiveRange = LiveRange.createFromParentsAndOffsets( root, 0, root, 1 ); + + const eventRange = sinon.spy(); + const eventContent = sinon.spy(); + sinon.spy( oldLiveRange, 'detach' ); + + marker.on( 'change:range', eventRange ); + marker.on( 'change:content', eventContent ); + + marker._attachLiveRange( newLiveRange ); + + oldLiveRange.fire( 'change:range', null, {} ); + oldLiveRange.fire( 'change:content', null, {} ); + + expect( eventRange.notCalled ).to.be.true; + expect( eventContent.notCalled ).to.be.true; + expect( oldLiveRange.detach.calledOnce ).to.true; + + newLiveRange.fire( 'change:range', null, {} ); + newLiveRange.fire( 'change:content', null, {} ); + + expect( eventRange.calledOnce ).to.be.true; + expect( eventContent.calledOnce ).to.be.true; + } ); + + it( 'should change managedUsingOperations flag', () => { + const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); + const marker = model.markers._set( 'name', range, false ); + + expect( marker.managedUsingOperations ).to.false; + + marker._managedUsingOperations = true; + + expect( marker.managedUsingOperations ).to.true; + + marker._managedUsingOperations = false; + + expect( marker.managedUsingOperations ).to.false; + } ); } ); From 497ee953bfa3e57f05c02232603476d0823ce3d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 8 Feb 2018 19:41:50 +0100 Subject: [PATCH 586/724] Internal: Used new MarkerCollection events. --- src/controller/editingcontroller.js | 8 ++++---- src/model/document.js | 25 ++++++++++--------------- 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 44dd22c50..fa132f62e 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -131,10 +131,10 @@ export default class EditingController { } }, { priority: 'high' } ); - // If a marker is removed through `model.Model#markers` directly (not through operation), just remove it (if - // it was not removed already). - this.listenTo( model.markers, 'remove', ( evt, marker ) => { - if ( !removedMarkers.has( marker.name ) ) { + // If an existing marker is updated through `model.Model#markers` directly (not through operation), + // just remove it (if it was not removed already). + this.listenTo( model.markers, 'update', ( evt, marker, oldRange ) => { + if ( oldRange && !removedMarkers.has( marker.name ) ) { removedMarkers.add( marker.name ); this.view.change( writer => { this.downcastDispatcher.convertMarkerRemove( marker.name, marker.getRange(), writer ); diff --git a/src/model/document.js b/src/model/document.js index 9047e8736..8378fe6ee 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -161,21 +161,16 @@ export default class Document { // Buffer marker changes. // This is not covered in buffering operations because markers may change outside of them (when they // are modified using `model.markers` collection, not through `MarkerOperation`). - this.listenTo( model.markers, 'set', ( evt, marker ) => { - // TODO: Should filter out changes of markers that are not in document. - // Whenever a new marker is added, buffer that change. - this.differ.bufferMarkerChange( marker.name, null, marker.getRange() ); - - // Whenever marker changes, buffer that. - marker.on( 'change', ( evt, oldRange ) => { - this.differ.bufferMarkerChange( marker.name, oldRange, marker.getRange() ); - } ); - } ); - - this.listenTo( model.markers, 'remove', ( evt, marker ) => { - // TODO: Should filter out changes of markers that are not in document. - // Whenever marker is removed, buffer that change. - this.differ.bufferMarkerChange( marker.name, marker.getRange(), null ); + this.listenTo( model.markers, 'update', ( evt, marker, oldRange, newRange ) => { + // Whenever marker is updated, buffer that change. + this.differ.bufferMarkerChange( marker.name, oldRange, newRange ); + + if ( !oldRange ) { + // Whenever marker changes, buffer that. + marker.on( 'change', ( evt, oldRange ) => { + this.differ.bufferMarkerChange( marker.name, oldRange, marker.getRange() ); + } ); + } } ); } From d5e468d7ccae1d1e7e1a2b6d4d92d09bb3fb2b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 8 Feb 2018 19:42:19 +0100 Subject: [PATCH 587/724] Tests: Minor Writer#setMarker() improvements. --- tests/model/writer.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/model/writer.js b/tests/model/writer.js index a411da79b..7f42f4f16 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -1995,12 +1995,12 @@ describe( 'Writer', () => { } ); it( 'should update marker in the document marker collection', () => { - setMarker( 'name', range ); + const marker = setMarker( 'name', range ); const range2 = Range.createFromParentsAndOffsets( root, 0, root, 0 ); setMarker( 'name', range2 ); - expect( model.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + expect( marker.getRange().isEqual( range2 ) ).to.be.true; } ); it( 'should accept marker instance', () => { @@ -2013,7 +2013,7 @@ describe( 'Writer', () => { const op = batch.deltas[ 1 ].operations[ 0 ]; - expect( model.markers.get( 'name' ).getRange().isEqual( range2 ) ).to.be.true; + expect( marker.getRange().isEqual( range2 ) ).to.be.true; expect( op.oldRange.isEqual( range ) ).to.be.true; expect( op.newRange.isEqual( range2 ) ).to.be.true; } ); From e04add1a3958691ccc89f25ca4ccd4401118619e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 8 Feb 2018 19:55:01 +0100 Subject: [PATCH 588/724] Internal: Used managedUsingOperations flag to check if marker update should be converted. --- src/controller/editingcontroller.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index fa132f62e..b72c893fa 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -134,10 +134,11 @@ export default class EditingController { // If an existing marker is updated through `model.Model#markers` directly (not through operation), // just remove it (if it was not removed already). this.listenTo( model.markers, 'update', ( evt, marker, oldRange ) => { - if ( oldRange && !removedMarkers.has( marker.name ) ) { + if ( oldRange && !marker.managedUsingOperations ) { removedMarkers.add( marker.name ); + this.view.change( writer => { - this.downcastDispatcher.convertMarkerRemove( marker.name, marker.getRange(), writer ); + this.downcastDispatcher.convertMarkerRemove( marker.name, oldRange, writer ); } ); } } ); From cd327fe272d4e89143f4e4114c35e9a12bcadae7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 8 Feb 2018 22:05:48 +0100 Subject: [PATCH 589/724] Docs: Minor improvements. --- src/controller/editingcontroller.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index b72c893fa..d00e80ebb 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -131,8 +131,7 @@ export default class EditingController { } }, { priority: 'high' } ); - // If an existing marker is updated through `model.Model#markers` directly (not through operation), - // just remove it (if it was not removed already). + // If an existing marker is updated through `model.Model#markers` directly (not through operation), just remove it. this.listenTo( model.markers, 'update', ( evt, marker, oldRange ) => { if ( oldRange && !marker.managedUsingOperations ) { removedMarkers.add( marker.name ); From 7dfc7257e6e567eabab3209128d1ebad46b91b27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 13 Feb 2018 08:49:42 +0100 Subject: [PATCH 590/724] Changed condition checking if marker removement should be converterd. --- src/controller/editingcontroller.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index d00e80ebb..cc336efc3 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -133,7 +133,7 @@ export default class EditingController { // If an existing marker is updated through `model.Model#markers` directly (not through operation), just remove it. this.listenTo( model.markers, 'update', ( evt, marker, oldRange ) => { - if ( oldRange && !marker.managedUsingOperations ) { + if ( oldRange && !removedMarkers.has( marker.name ) ) { removedMarkers.add( marker.name ); this.view.change( writer => { From 62d2acb11a50d9a3f53bf7d5927aabbd7a637404 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 13 Feb 2018 08:50:57 +0100 Subject: [PATCH 591/724] Minor docs improvement. --- src/model/markercollection.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/model/markercollection.js b/src/model/markercollection.js index a53743785..1d623eeaf 100644 --- a/src/model/markercollection.js +++ b/src/model/markercollection.js @@ -79,15 +79,15 @@ export default class MarkerCollection { * {@link module:engine/model/range~Range range}. * * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed), the marker in - * collection is updated and {module:engine/model/markercollection~MarkerCollection#event:update} event is fired but only - * if there was a change (marker range or {@link ~Marker#managedUsingOperations} flag has changed. + * collection is updated and {@link module:engine/model/markercollection~MarkerCollection#event:update} event is fired + * but only if there was a change (marker range or {@link ~Marker#managedUsingOperations} flag has changed. * * @protected * @fires module:engine/model/markercollection~MarkerCollection#event:update * @param {String|module:engine/model/markercollection~Marker} markerOrName Name of marker to set or marker instance to update. * @param {module:engine/model/range~Range} range Marker range. * @param {Boolean} managedUsingOperations Specifies whether the marker is managed using operations. - * @returns {module:engine/model/markercollection~Marker} Added or updated `Marker` instance. + * @returns {module:engine/model/markercollection~Marker} `Marker` instance which was added or updated. */ _set( markerOrName, range, managedUsingOperations ) { const markerName = markerOrName instanceof Marker ? markerOrName.name : markerOrName; From 776e60477eea6a7ce3ab478979d2c4109ed70189 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 13 Feb 2018 09:00:52 +0100 Subject: [PATCH 592/724] Set default value for managedUsingOperations param in MarkersCollection#_set. --- src/model/markercollection.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/model/markercollection.js b/src/model/markercollection.js index 1d623eeaf..1bc3de416 100644 --- a/src/model/markercollection.js +++ b/src/model/markercollection.js @@ -86,10 +86,10 @@ export default class MarkerCollection { * @fires module:engine/model/markercollection~MarkerCollection#event:update * @param {String|module:engine/model/markercollection~Marker} markerOrName Name of marker to set or marker instance to update. * @param {module:engine/model/range~Range} range Marker range. - * @param {Boolean} managedUsingOperations Specifies whether the marker is managed using operations. + * @param {Boolean} [managedUsingOperations=false] Specifies whether the marker is managed using operations. * @returns {module:engine/model/markercollection~Marker} `Marker` instance which was added or updated. */ - _set( markerOrName, range, managedUsingOperations ) { + _set( markerOrName, range, managedUsingOperations = false ) { const markerName = markerOrName instanceof Marker ? markerOrName.name : markerOrName; const oldMarker = this._markers.get( markerName ); @@ -102,7 +102,7 @@ export default class MarkerCollection { hasChanged = true; } - if ( !!managedUsingOperations !== oldMarker.managedUsingOperations ) { + if ( managedUsingOperations != oldMarker.managedUsingOperations ) { oldMarker._managedUsingOperations = managedUsingOperations; hasChanged = true; } @@ -314,7 +314,7 @@ class Marker { * @protected * @member {Boolean} */ - this._managedUsingOperations = !!managedUsingOperations; + this._managedUsingOperations = managedUsingOperations; /** * Range marked by the marker. From bcb9bac851c04facdfe78a465594263e8f2b2e7a Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Mon, 19 Feb 2018 10:32:00 +0100 Subject: [PATCH 593/724] Fixed docs. --- src/model/documentselection.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 80ef4176e..d359e517f 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -455,12 +455,12 @@ class LiveSelection extends Selection { // @member {Map} module:engine/model/liveselection~LiveSelection#_attributePriority this._attributePriority = new Map(); - // Contains data requires to fix ranges which have been moved to the graveyard + // Contains data required to fix ranges which have been moved to the graveyard. // @private // @member {Array} module:engine/model/liveselection~LiveSelection#_fixGraveyardRangesData this._fixGraveyardRangesData = []; - // Flag that informs whether the selection ranges have changed. It is changed on true when `LiveRange#change:range event is fired. + // Flag that informs whether the selection ranges have changed. It is changed on true when `LiveRange#change:range` event is fired. // @private // @member {Array} module:engine/model/liveselection~LiveSelection#_hasChangedRange this._hasChangedRange = false; @@ -512,7 +512,7 @@ class LiveSelection extends Selection { while ( this._fixGraveyardRangesData.length ) { const { liveRange, sourcePosition } = this._fixGraveyardRangesData.shift(); - // Checks whether the liveRange still belongs to graveyard. + // Checks whether the `liveRange` is still inside the graveyard. if ( liveRange.root == this._document.graveyard ) { this._fixGraveyardSelection( liveRange, sourcePosition ); } From 53a6e3f8aca0aea86b0a2c47514ef3d2434c5566 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Mon, 19 Feb 2018 10:32:19 +0100 Subject: [PATCH 594/724] Added test which ensures whether DocumentSelection#change:range event is fired once. --- tests/model/documentselection.js | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 61b4ed878..c19b6afa1 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -740,6 +740,33 @@ describe( 'DocumentSelection', () => { expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] ); } ); } ); + + it( '`DocumentSelection#change:range` event should be fire once even if selection contains multi-ranges', () => { + root.removeChildren( 0, root.childCount ); + root.insertChildren( 0, [ + new Element( 'p', [], new Text( 'abcdef' ) ), + new Element( 'p', [], new Text( 'foobar' ) ), + new Text( 'xyz #2' ) + ] ); + + selection._setTo( [ + Range.createIn( root.getNodeByPath( [ 0 ] ) ), + Range.createIn( root.getNodeByPath( [ 1 ] ) ) + ] ); + + spyRange = sinon.spy(); + selection.on( 'change:range', spyRange ); + + model.applyOperation( wrapInDelta( + new InsertOperation( + new Position( root, [ 0 ] ), + 'xyz #1', + doc.version + ) + ) ); + + expect( spyRange.calledOnce ).to.be.true; + } ); } ); describe( 'attributes', () => { From 8521dbe7403e659255b6368797371d90cf07593f Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Mon, 19 Feb 2018 11:08:13 +0100 Subject: [PATCH 595/724] Removed an if condition which is not necessary. Selection is being fixed after applying operation so it is always correct. --- src/model/documentselection.js | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index d359e517f..f3912aba2 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -512,10 +512,7 @@ class LiveSelection extends Selection { while ( this._fixGraveyardRangesData.length ) { const { liveRange, sourcePosition } = this._fixGraveyardRangesData.shift(); - // Checks whether the `liveRange` is still inside the graveyard. - if ( liveRange.root == this._document.graveyard ) { - this._fixGraveyardSelection( liveRange, sourcePosition ); - } + this._fixGraveyardSelection( liveRange, sourcePosition ); } if ( this._hasChangedRange ) { From 6e7948f463683b3de1e4d5bf0aeed6aaba1eefe5 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 12 Feb 2018 11:54:19 +0100 Subject: [PATCH 596/724] Tests: Using `model.Writer` instead of constructor in tests and docs of conversion utils. --- src/conversion/upcast-converters.js | 12 +++--------- tests/conversion/upcast-converters.js | 22 +++------------------- 2 files changed, 6 insertions(+), 28 deletions(-) diff --git a/src/conversion/upcast-converters.js b/src/conversion/upcast-converters.js index ce2ddd0fe..d2d767d9e 100644 --- a/src/conversion/upcast-converters.js +++ b/src/conversion/upcast-converters.js @@ -37,19 +37,13 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep'; * } ); * * upcastElementToElement( { - * view: { - * name: 'p', - * class: 'fancy' - * }, - * model: new ModelElement( 'p', { fancy: true } ) - * } ); - * - * upcastElementToElement( { * view: { * name: 'p', * class: 'heading' * }, - * model: viewElement => new ModelElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } ) + * model: ( viewElement, modelWriter ) => { + * return modelWriter.createElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } ); + * } * } ); * * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process. diff --git a/tests/conversion/upcast-converters.js b/tests/conversion/upcast-converters.js index d54147ed7..92d733274 100644 --- a/tests/conversion/upcast-converters.js +++ b/tests/conversion/upcast-converters.js @@ -101,24 +101,6 @@ describe( 'upcast-helpers', () => { expectResult( new ViewContainerElement( 'p', { class: 'fancy' } ), '' ); } ); - it( 'config.model is element instance', () => { - schema.extend( 'paragraph', { - allowAttributes: [ 'fancy' ] - } ); - - const helper = upcastElementToElement( { - view: { - name: 'p', - class: 'fancy' - }, - model: new ModelElement( 'paragraph', { fancy: true } ) - } ); - - conversion.for( 'upcast' ).add( helper ); - - expectResult( new ViewContainerElement( 'p', { class: 'fancy' } ), '' ); - } ); - it( 'config.model is a function', () => { schema.register( 'heading', { inheritAllFrom: '$block', @@ -130,7 +112,9 @@ describe( 'upcast-helpers', () => { name: 'p', class: 'heading' }, - model: viewElement => new ModelElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } ) + model: ( viewElement, modelWriter ) => { + return modelWriter.createElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } ); + } } ); conversion.for( 'upcast' ).add( helper ); From 724346882659e2aaadea592700863b39d1dce76e Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 12 Feb 2018 12:26:30 +0100 Subject: [PATCH 597/724] Changed: Removed a case in upcast converters which is not needed when converters do not handle passing element instance. --- src/conversion/upcast-converters.js | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/conversion/upcast-converters.js b/src/conversion/upcast-converters.js index d2d767d9e..22ccfe3e6 100644 --- a/src/conversion/upcast-converters.js +++ b/src/conversion/upcast-converters.js @@ -374,10 +374,8 @@ function _prepareToElementConverter( config ) { function _getModelElement( model, input, writer ) { if ( model instanceof Function ) { return model( input, writer ); - } else if ( typeof model == 'string' ) { - return writer.createElement( model ); } else { - return model; + return writer.createElement( model ); } } From e025331b2cbcfbf1cb7bd1fb5ba66693c421a54d Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 12 Feb 2018 10:36:21 +0100 Subject: [PATCH 598/724] Changed: Moved `conversion.two-way-converters` to `conversion.Conversion`. --- src/conversion/conversion.js | 389 ++++++++++++++++++ src/conversion/two-way-converters.js | 400 ------------------ tests/conversion/conversion.js | 531 ++++++++++++++++++++++++ tests/conversion/two-way-converters.js | 536 ------------------------- 4 files changed, 920 insertions(+), 936 deletions(-) delete mode 100644 src/conversion/two-way-converters.js delete mode 100644 tests/conversion/two-way-converters.js diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js index be7472256..5dcb3bfab 100644 --- a/src/conversion/conversion.js +++ b/src/conversion/conversion.js @@ -9,6 +9,18 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; +import { + downcastElementToElement, + downcastAttributeToElement, + downcastAttributeToAttribute +} from './downcast-converters'; + +import { + upcastElementToElement, + upcastElementToAttribute, + upcastAttributeToAttribute +} from './upcast-converters'; + /** * An utility class that helps organizing dispatchers and adding converters to them. */ @@ -127,6 +139,352 @@ export default class Conversion { return dispatchers; } + + /** + * Defines a conversion between the model and the view where a model element is represented as a view element (and vice versa). + * For example, model `Foo` is `

Foo

` in the view. + * + * conversion.elementToElement( { model: 'paragraph', view: 'p' } ); + * + * conversion.elementToElement( { + * model: 'fancyParagraph', + * view: { + * name: 'p', + * class: 'fancy' + * } + * } ); + * + * conversion.elementToElement( { + * model: 'paragraph', + * view: 'p', + * upcastAlso: [ + * 'div', + * { + * // Match any name. + * name: /./, + * style: { + * display: 'block' + * } + * } + * ] + * } ); + * + * conversion.elementToElement( { + * model: 'heading', + * view: 'h2', + * // Convert "headling-like" paragraphs to headings. + * upcastAlso: viewElement => { + * const fontSize = viewElement.getStyle( 'font-size' ); + * + * if ( !fontSize ) { + * return null; + * } + * + * const match = fontSize.match( /(\d+)\s*px/ ); + * + * if ( !match ) { + * return null; + * } + * + * const size = Number( match[ 1 ] ); + * + * if ( size > 26 ) { + * return { name: true, style: [ 'font-size' ] }; + * } + * + * return null; + * } + * } ); + * + * @param {Object} definition Conversion definition. + * @param {String} definition.model Name of the model element to convert. + * @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to. + * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] + * Any view element matching `upcastAlso` will also be converted to the given model element. + */ + elementToElement( definition ) { + // Set up downcast converter. + this.for( 'downcast' ).add( downcastElementToElement( definition ) ); + + // Set up upcast converter. + for ( const view of _getAllViews( definition ) ) { + const priority = view == definition.view ? 'normal' : 'high'; + + this.for( 'upcast' ).add( upcastElementToElement( { + model: definition.model, + view + }, priority ) ); + } + } + + /** + * Defines a conversion between the model and the view where a model attribute is represented as a view element (and vice versa). + * For example, model text node with data `"Foo"` and `bold` attribute is `Foo` in the view. + * + * conversion.attributeToElement( 'bold', { view: 'strong' } ); + * + * conversion.attributeToElement( 'bold', { + * view: { + * name: 'span', + * class: 'bold' + * } + * } ); + * + * conversion.attributeToElement( 'bold', { + * view: 'strong', + * upcastAlso: [ + * 'b', + * { + * name: 'span', + * class: 'bold' + * }, + * { + * name: 'span', + * style: { + * 'font-weight': 'bold' + * } + * }, + * viewElement => { + * const fontWeight = viewElement.getStyle( 'font-weight' ); + * + * if ( viewElement.is( 'span' ) && fontWeight && /\d+/.test() && Number( fontWeight ) > 500 ) { + * return { + * name: true, + * style: [ 'font-weight' ] + * }; + * } + * } + * ] + * } ); + * + * conversion.attributeToElement( 'styled', { + * model: 'dark', + * view: { + * name: 'span', + * class: [ 'styled', 'styled-dark' ] + * } + * } ); + * + * conversion.attributeToElement( 'fontSize', [ + * { + * model: 'big', + * view: { + * name: 'span', + * style: { + * 'font-size': '1.2em' + * } + * } + * }, + * { + * model: 'small', + * view: { + * name: 'span', + * style: { + * 'font-size': '0.8em' + * } + * } + * } + * ] ); + * + * conversion.attributeToElement( 'fontSize', [ + * { + * model: 'big', + * view: { + * name: 'span', + * style: { + * 'font-size': '1.2em' + * } + * }, + * upcastAlso: viewElement => { + * const fontSize = viewElement.getStyle( 'font-size' ); + * + * if ( !fontSize ) { + * return null; + * } + * + * const match = fontSize.match( /(\d+)\s*px/ ); + * + * if ( !match ) { + * return null; + * } + * + * const size = Number( match[ 1 ] ); + * + * if ( viewElement.is( 'span' ) && size > 10 ) { + * return { name: true, style: [ 'font-size' ] }; + * } + * + * return null; + * } + * }, + * { + * model: 'small', + * view: { + * name: 'span', + * style: { + * 'font-size': '0.8em' + * } + * }, + * upcastAlso: viewElement => { + * const fontSize = viewElement.getStyle( 'font-size' ); + * + * if ( !fontSize ) { + * return null; + * } + * + * const match = fontSize.match( /(\d+)\s*px/ ); + * + * if ( !match ) { + * return null; + * } + * + * const size = Number( match[ 1 ] ); + * + * if ( viewElement.is( 'span' ) && size < 10 ) { + * return { name: true, style: [ 'font-size' ] }; + * } + * + * return null; + * } + * } + * ] ); + * + * @param {String} modelAttributeKey The key of the model attribute to convert. + * @param {Object|Array.} definition Conversion definition. It is possible to provide multiple definitions in an array. + * @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasted, the item will be treated + * as a default item, that will be used when no other item matches. When upcasted, the model attribute value will be set to `true`. + * @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to. + * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] + * Any view element matching `upcastAlso` will also be converted to the given model element. + */ + attributeToElement( modelAttributeKey, definition ) { + // Set downcast (model to view conversion). + this.for( 'downcast' ).add( downcastAttributeToElement( modelAttributeKey, definition ) ); + + // Set upcast (view to model conversion). In this case, we need to re-organise the definition config. + if ( !Array.isArray( definition ) ) { + definition = [ definition ]; + } + + for ( const item of definition ) { + const model = _getModelAttributeDefinition( modelAttributeKey, item.model ); + + for ( const view of _getAllViews( item ) ) { + const priority = view == item.view ? 'normal' : 'high'; + + this.for( 'upcast' ).add( upcastElementToAttribute( { + view, + model + }, priority ) ); + } + } + } + + /** + * Defines a conversion between the model and the view where a model attribute is represented as a view attribute (and vice versa). + * For example, `` is converted to `` (same attribute name and value). + * + * conversion.attributeToAttribute( 'src' ); + * + * conversion.attributeToAttribute( 'source', { view: 'src' } ); + * + * conversion.attributeToAttribute( 'aside', { + * model: true, + * view: { + * name: 'img', + * key: 'class', + * value: 'aside half-size' + * } + * } ); + * + * conversion.attributeToAttribute( 'styled', [ + * { + * model: 'dark', + * view: { + * key: 'class', + * value: 'styled styled-dark' + * } + * }, + * { + * model: 'light', + * view: { + * key: 'class', + * value: 'styled styled-light' + * } + * } + * ] ); + * + * conversion.attributeToAttribute( 'align', [ + * { + * model: 'right', + * view: { + * key: 'class', + * value: 'align-right' + * }, + * upcastAlso: viewElement => { + * if ( viewElement.getStyle( 'text-align' ) == 'right' ) { + * return { + * style: [ 'text-align' ] + * }; + * } + * + * return null; + * } + * }, + * { + * model: 'center', + * view: { + * key: 'class', + * value: 'align-center' + * }, + * upcastAlso: { + * style: { + * 'text-align': 'center' + * } + * } + * } + * ] ); + * + * @param {String} modelAttributeKey The key of the model attribute to convert. + * @param {Object|Array.} [definition] Conversion definition. It is possible to provide multiple definitions in an array. + * If not set, the conversion helper will assume 1-to-1 conversion, that is the model attribute key and value will be same + * as the view attribute key and value. + * @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasting, + * the item will be treated as a default item, that will be used when no other item matches. When upcasting conversion, + * the model attribute value will be set to the same value as in the view. + * @param {Object} definition.view View attribute conversion details. Given object has required `key` property, + * specifying view attribute key, optional `value` property, specifying view attribute value and optional `name` + * property specifying a view element name from/on which the attribute should be converted. If `value` is not given, + * the view attribute value will be equal to model attribute value. + * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] + * Any view element matching `upcastAlso` will also be converted to the given model element. + */ + attributeToAttribute( modelAttributeKey, definition ) { + // Set up downcast converter. + this.for( 'downcast' ).add( downcastAttributeToAttribute( modelAttributeKey, definition ) ); + + // Set up upcast converter. In this case, we need to re-organise the definition config. + if ( !definition ) { + definition = { view: modelAttributeKey }; + } + + if ( !Array.isArray( definition ) ) { + definition = [ definition ]; + } + + for ( const item of definition ) { + const model = _getModelAttributeDefinition( modelAttributeKey, item.model ); + + for ( const view of _getAllViews( item ) ) { + const priority = view == item.view ? 'low' : 'normal'; + + this.for( 'upcast' ).add( upcastAttributeToAttribute( { + view, + model + }, priority ) ); + } + } + } } // Helper function for `Conversion` `.add()` method. @@ -143,3 +501,34 @@ function _addToDispatchers( dispatchers, conversionHelper ) { conversionHelper( dispatcher ); } } + +// Helper function, normalizes input data into a correct config form that can be accepted by conversion helpers. The +// correct form is either `String` or an object with `key` and `value` properties. +// +// @param {String} key Model attribute key. +// @param {*} [model] Model attribute value. +// @returns {Object} Normalized model attribute definition. +function _getModelAttributeDefinition( key, model ) { + if ( model === undefined ) { + return key; + } else { + return { + key, value: model + }; + } +} + +// Helper function that creates a joint array out of an item passed in `definition.view` and items passed in +// `definition.upcastAlso`. +// +// @param {Object} definition Conversion definition. +// @returns {Array} Array containing view definitions. +function _getAllViews( definition ) { + if ( !definition.upcastAlso ) { + return [ definition.view ]; + } else { + const upcastAlso = Array.isArray( definition.upcastAlso ) ? definition.upcastAlso : [ definition.upcastAlso ]; + + return [ definition.view ].concat( upcastAlso ); + } +} diff --git a/src/conversion/two-way-converters.js b/src/conversion/two-way-converters.js deleted file mode 100644 index 2560f22d2..000000000 --- a/src/conversion/two-way-converters.js +++ /dev/null @@ -1,400 +0,0 @@ -/** - * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -/** - * @module engine/conversion/two-way-converters - */ - -import { - downcastElementToElement, - downcastAttributeToElement, - downcastAttributeToAttribute -} from './downcast-converters'; - -import { - upcastElementToElement, - upcastElementToAttribute, - upcastAttributeToAttribute -} from './upcast-converters'; - -/** - * Defines a conversion between the model and the view where a model element is represented as a view element (and vice versa). - * For example, model `Foo` is `

Foo

` in the view. - * - * elementToElement( conversion, { model: 'paragraph', view: 'p' } ); - * - * elementToElement( conversion, { - * model: 'fancyParagraph', - * view: { - * name: 'p', - * class: 'fancy' - * } - * } ); - * - * elementToElement( conversion, { - * model: 'paragraph', - * view: 'p', - * upcastAlso: [ - * 'div', - * { - * // Match any name. - * name: /./, - * style: { - * display: 'block' - * } - * } - * ] - * } ); - * - * elementToElement( conversion, { - * model: 'heading', - * view: 'h2', - * // Convert "headling-like" paragraphs to headings. - * upcastAlso: viewElement => { - * const fontSize = viewElement.getStyle( 'font-size' ); - * - * if ( !fontSize ) { - * return null; - * } - * - * const match = fontSize.match( /(\d+)\s*px/ ); - * - * if ( !match ) { - * return null; - * } - * - * const size = Number( match[ 1 ] ); - * - * if ( size > 26 ) { - * return { name: true, style: [ 'font-size' ] }; - * } - * - * return null; - * } - * } ); - * - * @param {module:engine/conversion/conversion~Conversion} conversion Conversion class instance with registered conversion dispatchers. - * @param {Object} definition Conversion definition. - * @param {String} definition.model Name of the model element to convert. - * @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to. - * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] - * Any view element matching `upcastAlso` will also be converted to the given model element. - */ -export function elementToElement( conversion, definition ) { - // Set up downcast converter. - conversion.for( 'downcast' ).add( downcastElementToElement( definition ) ); - - // Set up upcast converter. - for ( const view of _getAllViews( definition ) ) { - const priority = view == definition.view ? 'normal' : 'high'; - - conversion.for( 'upcast' ).add( upcastElementToElement( { - model: definition.model, - view - }, priority ) ); - } -} - -/** - * Defines a conversion between the model and the view where a model attribute is represented as a view element (and vice versa). - * For example, model text node with data `"Foo"` and `bold` attribute is `Foo` in the view. - * - * attributeToElement( conversion, 'bold', { view: 'strong' } ); - * - * attributeToElement( conversion, 'bold', { - * view: { - * name: 'span', - * class: 'bold' - * } - * } ); - * - * attributeToElement( conversion, 'bold', { - * view: 'strong', - * upcastAlso: [ - * 'b', - * { - * name: 'span', - * class: 'bold' - * }, - * { - * name: 'span', - * style: { - * 'font-weight': 'bold' - * } - * }, - * viewElement => { - * const fontWeight = viewElement.getStyle( 'font-weight' ); - * - * if ( viewElement.is( 'span' ) && fontWeight && /\d+/.test() && Number( fontWeight ) > 500 ) { - * return { - * name: true, - * style: [ 'font-weight' ] - * }; - * } - * } - * ] - * } ); - * - * attributeToElement( conversion, 'styled', { - * model: 'dark', - * view: { - * name: 'span', - * class: [ 'styled', 'styled-dark' ] - * } - * } ); - * - * attributeToElement( conversion, 'fontSize', [ - * { - * model: 'big', - * view: { - * name: 'span', - * style: { - * 'font-size': '1.2em' - * } - * } - * }, - * { - * model: 'small', - * view: { - * name: 'span', - * style: { - * 'font-size': '0.8em' - * } - * } - * } - * ] ); - * - * attributeToElement( conversion, 'fontSize', [ - * { - * model: 'big', - * view: { - * name: 'span', - * style: { - * 'font-size': '1.2em' - * } - * }, - * upcastAlso: viewElement => { - * const fontSize = viewElement.getStyle( 'font-size' ); - * - * if ( !fontSize ) { - * return null; - * } - * - * const match = fontSize.match( /(\d+)\s*px/ ); - * - * if ( !match ) { - * return null; - * } - * - * const size = Number( match[ 1 ] ); - * - * if ( viewElement.is( 'span' ) && size > 10 ) { - * return { name: true, style: [ 'font-size' ] }; - * } - * - * return null; - * } - * }, - * { - * model: 'small', - * view: { - * name: 'span', - * style: { - * 'font-size': '0.8em' - * } - * }, - * upcastAlso: viewElement => { - * const fontSize = viewElement.getStyle( 'font-size' ); - * - * if ( !fontSize ) { - * return null; - * } - * - * const match = fontSize.match( /(\d+)\s*px/ ); - * - * if ( !match ) { - * return null; - * } - * - * const size = Number( match[ 1 ] ); - * - * if ( viewElement.is( 'span' ) && size < 10 ) { - * return { name: true, style: [ 'font-size' ] }; - * } - * - * return null; - * } - * } - * ] ); - * - * @param {module:engine/conversion/conversion~Conversion} conversion Conversion class instance with registered conversion dispatchers. - * @param {String} modelAttributeKey The key of the model attribute to convert. - * @param {Object|Array.} definition Conversion definition. It is possible to provide multiple definitions in an array. - * @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasted, the item will be treated - * as a default item, that will be used when no other item matches. When upcasted, the model attribute value will be set to `true`. - * @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to. - * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] - * Any view element matching `upcastAlso` will also be converted to the given model element. - */ -export function attributeToElement( conversion, modelAttributeKey, definition ) { - // Set downcast (model to view conversion). - conversion.for( 'downcast' ).add( downcastAttributeToElement( modelAttributeKey, definition ) ); - - // Set upcast (view to model conversion). In this case, we need to re-organise the definition config. - if ( !Array.isArray( definition ) ) { - definition = [ definition ]; - } - - for ( const item of definition ) { - const model = _getModelAttributeDefinition( modelAttributeKey, item.model ); - - for ( const view of _getAllViews( item ) ) { - const priority = view == item.view ? 'normal' : 'high'; - - conversion.for( 'upcast' ).add( upcastElementToAttribute( { - view, - model - }, priority ) ); - } - } -} - -/** - * Defines a conversion between the model and the view where a model attribute is represented as a view attribute (and vice versa). - * For example, `` is converted to `` (same attribute name and value). - * - * attributeToAttribute( conversion, 'src' ); - * - * attributeToAttribute( conversion, 'source', { view: 'src' } ); - * - * attributeToAttribute( conversion, 'aside', { - * model: true, - * view: { - * name: 'img', - * key: 'class', - * value: 'aside half-size' - * } - * } ); - * - * attributeToAttribute( conversion, 'styled', [ - * { - * model: 'dark', - * view: { - * key: 'class', - * value: 'styled styled-dark' - * } - * }, - * { - * model: 'light', - * view: { - * key: 'class', - * value: 'styled styled-light' - * } - * } - * ] ); - * - * attributeToAttribute( conversion, 'align', [ - * { - * model: 'right', - * view: { - * key: 'class', - * value: 'align-right' - * }, - * upcastAlso: viewElement => { - * if ( viewElement.getStyle( 'text-align' ) == 'right' ) { - * return { - * style: [ 'text-align' ] - * }; - * } - * - * return null; - * } - * }, - * { - * model: 'center', - * view: { - * key: 'class', - * value: 'align-center' - * }, - * upcastAlso: { - * style: { - * 'text-align': 'center' - * } - * } - * } - * ] ); - * - * @param {module:engine/conversion/conversion~Conversion} conversion Conversion class instance with registered conversion dispatchers. - * @param {String} modelAttributeKey The key of the model attribute to convert. - * @param {Object|Array.} [definition] Conversion definition. It is possible to provide multiple definitions in an array. - * If not set, the conversion helper will assume 1-to-1 conversion, that is the model attribute key and value will be same - * as the view attribute key and value. - * @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasting, - * the item will be treated as a default item, that will be used when no other item matches. When upcasting conversion, - * the model attribute value will be set to the same value as in the view. - * @param {Object} definition.view View attribute conversion details. Given object has required `key` property, - * specifying view attribute key, optional `value` property, specifying view attribute value and optional `name` - * property specifying a view element name from/on which the attribute should be converted. If `value` is not given, - * the view attribute value will be equal to model attribute value. - * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] - * Any view element matching `upcastAlso` will also be converted to the given model element. - */ -export function attributeToAttribute( conversion, modelAttributeKey, definition ) { - // Set up downcast converter. - conversion.for( 'downcast' ).add( downcastAttributeToAttribute( modelAttributeKey, definition ) ); - - // Set up upcast converter. In this case, we need to re-organise the definition config. - if ( !definition ) { - definition = { view: modelAttributeKey }; - } - - if ( !Array.isArray( definition ) ) { - definition = [ definition ]; - } - - for ( const item of definition ) { - const model = _getModelAttributeDefinition( modelAttributeKey, item.model ); - - for ( const view of _getAllViews( item ) ) { - const priority = view == item.view ? 'low' : 'normal'; - - conversion.for( 'upcast' ).add( upcastAttributeToAttribute( { - view, - model - }, priority ) ); - } - } -} - -// Helper function, normalizes input data into a correct config form that can be accepted by conversion helpers. The -// correct form is either `String` or an object with `key` and `value` properties. -// -// @param {String} key Model attribute key. -// @param {*} [model] Model attribute value. -// @returns {Object} Normalized model attribute definition. -function _getModelAttributeDefinition( key, model ) { - if ( model === undefined ) { - return key; - } else { - return { - key, value: model - }; - } -} - -// Helper function that creates a joint array out of an item passed in `definition.view` and items passed in -// `definition.upcastAlso`. -// -// @param {Object} definition Conversion definition. -// @returns {Array} Array containing view definitions. -function _getAllViews( definition ) { - if ( !definition.upcastAlso ) { - return [ definition.view ]; - } else { - const upcastAlso = Array.isArray( definition.upcastAlso ) ? definition.upcastAlso : [ definition.upcastAlso ]; - - return [ definition.view ].concat( upcastAlso ); - } -} diff --git a/tests/conversion/conversion.js b/tests/conversion/conversion.js index cfabea09f..2e732c0bc 100644 --- a/tests/conversion/conversion.js +++ b/tests/conversion/conversion.js @@ -6,6 +6,18 @@ import Conversion from '../../src/conversion/conversion'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; +import UpcastDispatcher from '../../src/conversion/upcastdispatcher'; + +import { convertText, convertToModelFragment } from '../../src/conversion/upcast-converters'; + +import EditingController from '../../src/controller/editingcontroller'; + +import Model from '../../src/model/model'; +import ModelRange from '../../src/model/range'; + +import { stringify as viewStringify, parse as viewParse } from '../../src/dev-utils/view'; +import { stringify as modelStringify } from '../../src/dev-utils/model'; + describe( 'Conversion', () => { let conversion, dispA, dispB; @@ -70,4 +82,523 @@ describe( 'Conversion', () => { expect( helperB.calledWithExactly( dispB ) ).to.be.true; } ); } ); + + describe( 'converters', () => { + let viewDispatcher, model, schema, conversion, modelRoot, viewRoot; + + beforeEach( () => { + model = new Model(); + const controller = new EditingController( model ); + + const modelDoc = model.document; + modelRoot = modelDoc.createRoot(); + + viewRoot = controller.view.getRoot(); + // Set name of view root the same as dom root. + // This is a mock of attaching view root to dom root. + viewRoot._name = 'div'; + + schema = model.schema; + + schema.extend( '$text', { + allowAttributes: [ 'bold' ] + } ); + + schema.register( 'paragraph', { + inheritAllFrom: '$block' + } ); + + viewDispatcher = new UpcastDispatcher( model, { schema } ); + viewDispatcher.on( 'text', convertText() ); + viewDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); + viewDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); + + conversion = new Conversion(); + conversion.register( 'upcast', [ viewDispatcher ] ); + conversion.register( 'downcast', [ controller.downcastDispatcher ] ); + } ); + + describe( 'elementToElement', () => { + it( 'config.view is a string', () => { + conversion.elementToElement( { model: 'paragraph', view: 'p' } ); + + test( '

Foo

', 'Foo' ); + } ); + + it( 'config.view is an object', () => { + schema.register( 'fancyParagraph', { + inheritAllFrom: 'paragraph' + } ); + + conversion.elementToElement( { + model: 'fancyParagraph', + view: { + name: 'p', + class: 'fancy' + } + } ); + + test( '

Foo

', 'Foo' ); + } ); + + it( 'config.view is an object with upcastAlso defined', () => { + conversion.elementToElement( { + model: 'paragraph', + view: 'p', + upcastAlso: [ + 'div', + { + // Match any name. + name: /./, + style: { + display: 'block' + } + } + ] + } ); + + test( '

Foo

', 'Foo' ); + test( '
Foo
', 'Foo', '

Foo

' ); + test( 'Foo', 'Foo', '

Foo

' ); + } ); + + it( 'upcastAlso given as a function', () => { + schema.register( 'heading', { + inheritAllFrom: '$block' + } ); + + conversion.elementToElement( { + model: 'heading', + view: 'h2', + upcastAlso: viewElement => { + const fontSize = viewElement.getStyle( 'font-size' ); + + if ( !fontSize ) { + return null; + } + + const match = fontSize.match( /(\d+)\s*px/ ); + + if ( !match ) { + return null; + } + + const size = Number( match[ 1 ] ); + + if ( size >= 26 ) { + return { name: true, style: [ 'font-size' ] }; + } + + return null; + } + } ); + + conversion.elementToElement( { + model: 'paragraph', + view: 'p' + } ); + + test( '

', '' ); + test( '

', '', '

' ); + + test( '

', '' ); + test( '

', '', '

' ); + } ); + } ); + + describe( 'attributeToElement', () => { + beforeEach( () => { + conversion.elementToElement( { model: 'paragraph', view: 'p' } ); + } ); + + it( 'config.view is a string', () => { + conversion.attributeToElement( 'bold', { view: 'strong' } ); + + test( '

Foo bar

', '<$text bold="true">Foo bar' ); + } ); + + it( 'config.view is an object', () => { + conversion.attributeToElement( 'bold', { + view: { + name: 'span', + class: 'bold' + } + } ); + + test( '

Foo bar

', '<$text bold="true">Foo bar' ); + } ); + + it( 'config.view is an object with upcastAlso defined', () => { + conversion.attributeToElement( 'bold', { + view: 'strong', + upcastAlso: [ + 'b', + { + name: 'span', + class: 'bold' + }, + { + name: 'span', + style: { + 'font-weight': 'bold' + } + }, + viewElement => { + const fontWeight = viewElement.getStyle( 'font-weight' ); + + if ( viewElement.is( 'span' ) && fontWeight && /\d+/.test( fontWeight ) && Number( fontWeight ) > 500 ) { + return { + name: true, + style: [ 'font-weight' ] + }; + } + } + ] + } ); + + test( + '

Foo

', + '<$text bold="true">Foo' + ); + + test( + '

Foo

', + '<$text bold="true">Foo', + '

Foo

' + ); + + test( + '

Foo

', + '<$text bold="true">Foo', + '

Foo

' + ); + + test( + '

Foo

', + '<$text bold="true">Foo', + '

Foo

' + ); + + test( + '

Foo

', + 'Foo', + '

Foo

' + ); + + test( + '

Foo

', + '<$text bold="true">Foo', + '

Foo

' + ); + } ); + + it( 'config.model is a string', () => { + schema.extend( '$text', { + allowAttributes: [ 'styled' ] + } ); + + conversion.attributeToElement( 'styled', { + model: 'dark', + view: { + name: 'span', + class: [ 'styled', 'styled-dark' ] + } + } ); + + test( + '

Foo bar

', + '<$text styled="dark">Foo bar' + ); + } ); + + it( 'config is an array', () => { + schema.extend( '$text', { + allowAttributes: [ 'fontSize' ] + } ); + + conversion.attributeToElement( 'fontSize', [ + { + model: 'big', + view: { + name: 'span', + style: { + 'font-size': '1.2em' + } + } + }, + { + model: 'small', + view: { + name: 'span', + style: { + 'font-size': '0.8em' + } + } + } + ] ); + + test( + '

Foo bar

', + '<$text fontSize="big">Foo bar' + ); + + test( + '

Foo bar

', + '<$text fontSize="small">Foo bar' + ); + } ); + + it( 'config is an array with upcastAlso defined', () => { + schema.extend( '$text', { + allowAttributes: [ 'fontSize' ] + } ); + + conversion.attributeToElement( 'fontSize', [ + { + model: 'big', + view: { + name: 'span', + style: { + 'font-size': '1.2em' + } + }, + upcastAlso: viewElement => { + const fontSize = viewElement.getStyle( 'font-size' ); + + if ( !fontSize ) { + return null; + } + + const match = fontSize.match( /(\d+)\s*px/ ); + + if ( !match ) { + return null; + } + + const size = Number( match[ 1 ] ); + + if ( viewElement.is( 'span' ) && size > 10 ) { + return { name: true, style: [ 'font-size' ] }; + } + + return null; + } + }, + { + model: 'small', + view: { + name: 'span', + style: { + 'font-size': '0.8em' + } + }, + upcastAlso: viewElement => { + const fontSize = viewElement.getStyle( 'font-size' ); + + if ( !fontSize ) { + return null; + } + + const match = fontSize.match( /(\d+)\s*px/ ); + + if ( !match ) { + return null; + } + + const size = Number( match[ 1 ] ); + + if ( viewElement.is( 'span' ) && size < 10 ) { + return { name: true, style: [ 'font-size' ] }; + } + + return null; + } + } + ] ); + + test( + '

Foo bar

', + '<$text fontSize="big">Foo bar' + ); + + test( + '

Foo bar

', + '<$text fontSize="big">Foo bar', + '

Foo bar

' + ); + + test( + '

Foo bar

', + '<$text fontSize="small">Foo bar' + ); + + test( + '

Foo bar

', + '<$text fontSize="small">Foo bar', + '

Foo bar

' + ); + + test( + '

Foo bar

', + 'Foo bar', + '

Foo bar

' + ); + } ); + } ); + + describe( 'attributeToAttribute', () => { + beforeEach( () => { + conversion.elementToElement( { model: 'image', view: 'img' } ); + + schema.register( 'image', { + inheritAllFrom: '$block', + } ); + } ); + + it( 'config is not set', () => { + schema.extend( 'image', { + allowAttributes: [ 'src' ] + } ); + + conversion.attributeToAttribute( 'src' ); + + test( '', '' ); + } ); + + it( 'config.view is a string', () => { + schema.extend( 'image', { + allowAttributes: [ 'source' ] + } ); + + conversion.attributeToAttribute( 'source', { view: 'src' } ); + + test( '', '' ); + } ); + + it( 'config.view is an object', () => { + schema.extend( 'image', { + allowAttributes: [ 'aside' ] + } ); + + conversion.attributeToAttribute( 'aside', { + model: true, + view: { + name: 'img', + key: 'class', + value: 'aside half-size' + } + } ); + + conversion.elementToElement( { model: 'paragraph', view: 'p' } ); + + test( '', '' ); + test( '

', '', '

' ); + } ); + + it( 'config is an array', () => { + schema.extend( 'image', { + allowAttributes: [ 'styled' ] + } ); + + conversion.attributeToAttribute( 'styled', [ + { + model: 'dark', + view: { + key: 'class', + value: 'styled styled-dark' + } + }, + { + model: 'light', + view: { + key: 'class', + value: 'styled styled-light' + } + } + ] ); + + test( '', '' ); + test( '', '' ); + } ); + + it( 'config is an array with upcastAlso defined', () => { + conversion.elementToElement( { model: 'paragraph', view: 'p' } ); + + schema.extend( 'paragraph', { + allowAttributes: [ 'align' ] + } ); + + conversion.attributeToAttribute( 'align', [ + { + model: 'right', + view: { + key: 'class', + value: 'align-right' + }, + upcastAlso: viewElement => { + if ( viewElement.getStyle( 'text-align' ) == 'right' ) { + return { + style: [ 'text-align' ] + }; + } + + return null; + } + }, + { + model: 'center', + view: { + key: 'class', + value: 'align-center' + }, + upcastAlso: { + style: { + 'text-align': 'center' + } + } + } + ] ); + + test( + '

Foo

', + 'Foo' + ); + + test( + '

Foo

', + 'Foo', + '

Foo

' + ); + + test( + '

Foo

', + 'Foo' + ); + + test( + '

Foo

', + 'Foo', + '

Foo

' + ); + } ); + } ); + + function test( input, expectedModel, expectedView = null ) { + loadData( input ); + + expect( modelStringify( model.document.getRoot() ) ).to.equal( expectedModel ); + expect( viewStringify( viewRoot, null, { ignoreRoot: true } ) ).to.equal( expectedView || input ); + } + + function loadData( input ) { + const parsedView = viewParse( input ); + + const convertedModel = viewDispatcher.convert( parsedView ); + + model.change( writer => { + writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, modelRoot.maxOffset ) ); + writer.insert( convertedModel, modelRoot, 0 ); + } ); + } + } ); } ); diff --git a/tests/conversion/two-way-converters.js b/tests/conversion/two-way-converters.js deleted file mode 100644 index b23a3cf3b..000000000 --- a/tests/conversion/two-way-converters.js +++ /dev/null @@ -1,536 +0,0 @@ -/** - * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. - * For licensing, see LICENSE.md. - */ - -import { - elementToElement, attributeToElement, attributeToAttribute -} from '../../src/conversion/two-way-converters'; - -import Conversion from '../../src/conversion/conversion'; -import UpcastDispatcher from '../../src/conversion/upcastdispatcher'; - -import { convertText, convertToModelFragment } from '../../src/conversion/upcast-converters'; - -import EditingController from '../../src/controller/editingcontroller'; - -import Model from '../../src/model/model'; -import ModelRange from '../../src/model/range'; - -import { stringify as viewStringify, parse as viewParse } from '../../src/dev-utils/view'; -import { stringify as modelStringify } from '../../src/dev-utils/model'; - -describe( 'two-way-converters', () => { - let upcastDispatcher, model, schema, conversion, modelRoot, viewRoot; - - beforeEach( () => { - model = new Model(); - const controller = new EditingController( model ); - - const modelDoc = model.document; - modelRoot = modelDoc.createRoot(); - - viewRoot = controller.view.document.getRoot(); - // Set name of view root the same as dom root. - // This is a mock of attaching view root to dom root. - viewRoot._name = 'div'; - - schema = model.schema; - - schema.extend( '$text', { - allowAttributes: [ 'bold' ] - } ); - - schema.register( 'paragraph', { - inheritAllFrom: '$block' - } ); - - upcastDispatcher = new UpcastDispatcher( { schema } ); - upcastDispatcher.on( 'text', convertText() ); - upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); - upcastDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); - - conversion = new Conversion(); - conversion.register( 'upcast', [ upcastDispatcher ] ); - conversion.register( 'downcast', [ controller.downcastDispatcher ] ); - } ); - - describe( 'elementToElement', () => { - it( 'config.view is a string', () => { - elementToElement( conversion, { model: 'paragraph', view: 'p' } ); - - test( '

Foo

', 'Foo' ); - } ); - - it( 'config.view is an object', () => { - schema.register( 'fancyParagraph', { - inheritAllFrom: 'paragraph' - } ); - - elementToElement( conversion, { - model: 'fancyParagraph', - view: { - name: 'p', - class: 'fancy' - } - } ); - - test( '

Foo

', 'Foo' ); - } ); - - it( 'config.view is an object with upcastAlso defined', () => { - elementToElement( conversion, { - model: 'paragraph', - view: 'p', - upcastAlso: [ - 'div', - { - // Match any name. - name: /./, - style: { - display: 'block' - } - } - ] - } ); - - test( '

Foo

', 'Foo' ); - test( '
Foo
', 'Foo', '

Foo

' ); - test( 'Foo', 'Foo', '

Foo

' ); - } ); - - it( 'upcastAlso given as a function', () => { - schema.register( 'heading', { - inheritAllFrom: '$block' - } ); - - elementToElement( conversion, { - model: 'heading', - view: 'h2', - upcastAlso: viewElement => { - const fontSize = viewElement.getStyle( 'font-size' ); - - if ( !fontSize ) { - return null; - } - - const match = fontSize.match( /(\d+)\s*px/ ); - - if ( !match ) { - return null; - } - - const size = Number( match[ 1 ] ); - - if ( size >= 26 ) { - return { name: true, style: [ 'font-size' ] }; - } - - return null; - } - } ); - - elementToElement( conversion, { - model: 'paragraph', - view: 'p' - } ); - - test( '

', '' ); - test( '

', '', '

' ); - - test( '

', '' ); - test( '

', '', '

' ); - } ); - } ); - - describe( 'attributeToElement', () => { - beforeEach( () => { - elementToElement( conversion, { model: 'paragraph', view: 'p' } ); - } ); - - it( 'config.view is a string', () => { - attributeToElement( conversion, 'bold', { view: 'strong' } ); - - test( '

Foo bar

', '<$text bold="true">Foo bar' ); - } ); - - it( 'config.view is an object', () => { - attributeToElement( conversion, 'bold', { - view: { - name: 'span', - class: 'bold' - } - } ); - - test( '

Foo bar

', '<$text bold="true">Foo bar' ); - } ); - - it( 'config.view is an object with upcastAlso defined', () => { - attributeToElement( conversion, 'bold', { - view: 'strong', - upcastAlso: [ - 'b', - { - name: 'span', - class: 'bold' - }, - { - name: 'span', - style: { - 'font-weight': 'bold' - } - }, - viewElement => { - const fontWeight = viewElement.getStyle( 'font-weight' ); - - if ( viewElement.is( 'span' ) && fontWeight && /\d+/.test( fontWeight ) && Number( fontWeight ) > 500 ) { - return { - name: true, - style: [ 'font-weight' ] - }; - } - } - ] - } ); - - test( - '

Foo

', - '<$text bold="true">Foo' - ); - - test( - '

Foo

', - '<$text bold="true">Foo', - '

Foo

' - ); - - test( - '

Foo

', - '<$text bold="true">Foo', - '

Foo

' - ); - - test( - '

Foo

', - '<$text bold="true">Foo', - '

Foo

' - ); - - test( - '

Foo

', - 'Foo', - '

Foo

' - ); - - test( - '

Foo

', - '<$text bold="true">Foo', - '

Foo

' - ); - } ); - - it( 'config.model is a string', () => { - schema.extend( '$text', { - allowAttributes: [ 'styled' ] - } ); - - attributeToElement( conversion, 'styled', { - model: 'dark', - view: { - name: 'span', - class: [ 'styled', 'styled-dark' ] - } - } ); - - test( '

Foo bar

', '<$text styled="dark">Foo bar' ); - } ); - - it( 'config is an array', () => { - schema.extend( '$text', { - allowAttributes: [ 'fontSize' ] - } ); - - attributeToElement( conversion, 'fontSize', [ - { - model: 'big', - view: { - name: 'span', - style: { - 'font-size': '1.2em' - } - } - }, - { - model: 'small', - view: { - name: 'span', - style: { - 'font-size': '0.8em' - } - } - } - ] ); - - test( - '

Foo bar

', - '<$text fontSize="big">Foo bar' - ); - - test( - '

Foo bar

', - '<$text fontSize="small">Foo bar' - ); - } ); - - it( 'config is an array with upcastAlso defined', () => { - schema.extend( '$text', { - allowAttributes: [ 'fontSize' ] - } ); - - attributeToElement( conversion, 'fontSize', [ - { - model: 'big', - view: { - name: 'span', - style: { - 'font-size': '1.2em' - } - }, - upcastAlso: viewElement => { - const fontSize = viewElement.getStyle( 'font-size' ); - - if ( !fontSize ) { - return null; - } - - const match = fontSize.match( /(\d+)\s*px/ ); - - if ( !match ) { - return null; - } - - const size = Number( match[ 1 ] ); - - if ( viewElement.is( 'span' ) && size > 10 ) { - return { name: true, style: [ 'font-size' ] }; - } - - return null; - } - }, - { - model: 'small', - view: { - name: 'span', - style: { - 'font-size': '0.8em' - } - }, - upcastAlso: viewElement => { - const fontSize = viewElement.getStyle( 'font-size' ); - - if ( !fontSize ) { - return null; - } - - const match = fontSize.match( /(\d+)\s*px/ ); - - if ( !match ) { - return null; - } - - const size = Number( match[ 1 ] ); - - if ( viewElement.is( 'span' ) && size < 10 ) { - return { name: true, style: [ 'font-size' ] }; - } - - return null; - } - } - ] ); - - test( - '

Foo bar

', - '<$text fontSize="big">Foo bar' - ); - - test( - '

Foo bar

', - '<$text fontSize="big">Foo bar', - '

Foo bar

' - ); - - test( - '

Foo bar

', - '<$text fontSize="small">Foo bar' - ); - - test( - '

Foo bar

', - '<$text fontSize="small">Foo bar', - '

Foo bar

' - ); - - test( - '

Foo bar

', - 'Foo bar', - '

Foo bar

' - ); - } ); - } ); - - describe( 'attributeToAttribute', () => { - beforeEach( () => { - elementToElement( conversion, { model: 'image', view: 'img' } ); - - schema.register( 'image', { - inheritAllFrom: '$block', - } ); - } ); - - it( 'config is not set', () => { - schema.extend( 'image', { - allowAttributes: [ 'src' ] - } ); - - attributeToAttribute( conversion, 'src' ); - - test( '', '' ); - } ); - - it( 'config.view is a string', () => { - schema.extend( 'image', { - allowAttributes: [ 'source' ] - } ); - - attributeToAttribute( conversion, 'source', { view: 'src' } ); - - test( '', '' ); - } ); - - it( 'config.view is an object', () => { - schema.extend( 'image', { - allowAttributes: [ 'aside' ] - } ); - - attributeToAttribute( conversion, 'aside', { - model: true, - view: { - name: 'img', - key: 'class', - value: 'aside half-size' - } - } ); - - elementToElement( conversion, { model: 'paragraph', view: 'p' } ); - - test( '', '' ); - test( '

', '', '

' ); - } ); - - it( 'config is an array', () => { - schema.extend( 'image', { - allowAttributes: [ 'styled' ] - } ); - - attributeToAttribute( conversion, 'styled', [ - { - model: 'dark', - view: { - key: 'class', - value: 'styled styled-dark' - } - }, - { - model: 'light', - view: { - key: 'class', - value: 'styled styled-light' - } - } - ] ); - - test( '', '' ); - test( '', '' ); - } ); - - it( 'config is an array with upcastAlso defined', () => { - elementToElement( conversion, { model: 'paragraph', view: 'p' } ); - - schema.extend( 'paragraph', { - allowAttributes: [ 'align' ] - } ); - - attributeToAttribute( conversion, 'align', [ - { - model: 'right', - view: { - key: 'class', - value: 'align-right' - }, - upcastAlso: viewElement => { - if ( viewElement.getStyle( 'text-align' ) == 'right' ) { - return { - style: [ 'text-align' ] - }; - } - - return null; - } - }, - { - model: 'center', - view: { - key: 'class', - value: 'align-center' - }, - upcastAlso: { - style: { - 'text-align': 'center' - } - } - } - ] ); - - test( - '

Foo

', - 'Foo' - ); - - test( - '

Foo

', - 'Foo', - '

Foo

' - ); - - test( - '

Foo

', - 'Foo' - ); - - test( - '

Foo

', - 'Foo', - '

Foo

' - ); - } ); - } ); - - function test( input, expectedModel, expectedView = null ) { - loadData( input ); - - expect( modelStringify( model.document.getRoot() ) ).to.equal( expectedModel ); - expect( viewStringify( viewRoot, null, { ignoreRoot: true } ) ).to.equal( expectedView || input ); - } - - function loadData( input ) { - const parsedView = viewParse( input ); - - model.change( writer => { - const convertedModel = upcastDispatcher.convert( parsedView, writer ); - writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, modelRoot.maxOffset ) ); - writer.insert( convertedModel, modelRoot, 0 ); - } ); - } -} ); From b501b483a1da7ce55b1d71f6bdea2fde7c8def4b Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Thu, 15 Feb 2018 14:20:21 +0100 Subject: [PATCH 599/724] Docs: Tweaks in docs. --- src/model/writer.js | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/src/model/writer.js b/src/model/writer.js index 7fed70283..52809b7c5 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -761,34 +761,32 @@ export default class Writer { } /** - * Adds or updates {@link module:engine/model/markercollection~Marker marker}. + * Adds or updates a {@link module:engine/model/markercollection~Marker marker}. Marker is a named range, which tracks + * changes in the document and updates its range automatically, when model tree changes. Still, it is possible to change the + * marker's range directly using this method. * * As the first parameter you can set marker name or instance. If none of them is provided, new marker, with a unique * name is created and returned. * - * Using this method you can change markers range or define if the marker is managed by operation or not. + * The `options.usingOperation` parameter lets you decide if the marker should be managed by operations or not. See + * {@link module:engine/model/markercollection~Marker marker class description} to learn about the difference between + * markers managed by operations and not-managed by operations. It is possible to change this option for an existing marker. + * This is useful when a marker have been created earlier and then later, it needs to be added to the document history. * - * Marker tracks changes is the document and updates the range automatically, so you need to update the range only - * when it changes directly. You do not need to update it after each document change. + * Create/update marker directly base on marker's name: * - * The option parameter let you decide if the marker should be managed by operations or not. See - * {@link module:engine/model/markercollection~Marker marker class description} to learn about the difference between - * markers managed by operation and managed directly. You can change this option for existing marker. This is - * useful if a marker have been created earlier and need to be added to the document history later. + * setMarker( markerName, range ); * * Update marker using operation: * * setMarker( marker, range, { usingOperation: true } ); - * - * Create/update marker directly base on marker's name: - * - * setMarker( markerName, range ); + * setMarker( markerName, range, { usingOperation: true } ); * * Create marker with a unique id using operation: * * setMarker( range, { usingOperation: true } ); * - * Create marker directly with a unique name: + * Create marker directly without using operations: * * setMarker( range ) * @@ -799,9 +797,9 @@ export default class Writer { * Note: For efficiency reasons, it's best to create and keep as little markers as possible. * * @see module:engine/model/markercollection~Marker - * @param {module:engine/model/markercollection~Marker|String} [markerOrName=uid()] - * Name of marker to add, Marker instance to update or range for the marker with a unique name. - * @param {module:engine/model/range~Range|Object} [range] Marker range or options. + * @param {module:engine/model/markercollection~Marker|String} [markerOrName] + * Name of a marker to create or update, or `Marker` instance to update, or range for the marker with a unique name. + * @param {module:engine/model/range~Range} [range] Marker range. * @param {Object} [options] * @param {Boolean} [options.usingOperation=false] Flag indicated whether the marker should be added by MarkerOperation. * See {@link module:engine/model/markercollection~Marker#managedUsingOperations}. From b6fcb2d2965228b55d523ffda98db4a8535a0b0f Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Fri, 16 Feb 2018 13:02:43 +0100 Subject: [PATCH 600/724] Changed: Unified converters config. Fixed: Classes and styles are properly handled in downcast converters. Docs: Fixed converters docs. Changed: Support for passing element name in `downcastAttributeToAttribute` converter. Added: Introduced `conversion.ConverterDefinition` type. Added: Added priority handling in `conversion.Conversion` converters. Changed: Cleaned low-level converters after they can receive only element creator function as a parameter. --- src/conversion/conversion.js | 426 ++++++++-------- src/conversion/downcast-converters.js | 476 ++++++++---------- src/conversion/upcast-converters.js | 58 ++- src/dev-utils/model.js | 22 +- tests/controller/datacontroller.js | 4 +- tests/conversion/conversion.js | 225 ++++----- tests/conversion/downcast-converters.js | 334 ++++++------ .../downcast-selection-converters.js | 4 +- tests/conversion/upcast-converters.js | 23 +- 9 files changed, 761 insertions(+), 811 deletions(-) diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js index 5dcb3bfab..d717ae608 100644 --- a/src/conversion/conversion.js +++ b/src/conversion/conversion.js @@ -115,37 +115,18 @@ export default class Conversion { } /** - * Returns dispatchers registered under given group name. - * - * If given group name has not been registered, - * {@link module:utils/ckeditorerror~CKEditorError conversion-for-unknown-group} error is thrown. - * - * @private - * @param {String} groupName - * @returns {Array.} - */ - _getDispatchers( groupName ) { - const dispatchers = this._dispatchersGroups.get( groupName ); - - if ( !dispatchers ) { - /** - * Trying to add a converter to an unknown dispatchers group. - * - * @error conversion-for-unknown-group - */ - throw new CKEditorError( 'conversion-for-unknown-group: Trying to add a converter to an unknown dispatchers group.' ); - } - - return dispatchers; - } - - /** - * Defines a conversion between the model and the view where a model element is represented as a view element (and vice versa). + * Sets up converters between the model and the view which convert a model element to a view element (and vice versa). * For example, model `Foo` is `

Foo

` in the view. * + * `definition.model` is a `String` with a model element name to converter from/to. + * + * // Simple conversion from `paragraph` model element to `

` view element (and vice versa). * conversion.elementToElement( { model: 'paragraph', view: 'p' } ); * + * // Override other converters by specifying converter definition with higher priority. + * conversion.elementToElement( { model: 'paragraph', view: 'div', priority: 'high' } ); + * + * // View specified as an object instead of a string. * conversion.elementToElement( { * model: 'fancyParagraph', * view: { @@ -154,13 +135,14 @@ export default class Conversion { * } * } ); * + * // Use `upcastAlso` to define other view elements that should be also converted to `paragraph` element. * conversion.elementToElement( { * model: 'paragraph', * view: 'p', * upcastAlso: [ * 'div', * { - * // Match any name. + * // Any element with `display: block` style. * name: /./, * style: { * display: 'block' @@ -169,6 +151,7 @@ export default class Conversion { * ] * } ); * + * // `upcastAlso` set as callback enables a conversion of a wide range of different view elements. * conversion.elementToElement( { * model: 'heading', * view: 'h2', @@ -196,41 +179,49 @@ export default class Conversion { * } * } ); * - * @param {Object} definition Conversion definition. - * @param {String} definition.model Name of the model element to convert. - * @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to. - * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] - * Any view element matching `upcastAlso` will also be converted to the given model element. + * @param {~ConverterDefinition} definition Converter definition. */ elementToElement( definition ) { // Set up downcast converter. this.for( 'downcast' ).add( downcastElementToElement( definition ) ); // Set up upcast converter. - for ( const view of _getAllViews( definition ) ) { - const priority = view == definition.view ? 'normal' : 'high'; - - this.for( 'upcast' ).add( upcastElementToElement( { - model: definition.model, - view - }, priority ) ); + for ( const { model, view } of _getAllUpcastDefinitions( definition ) ) { + this.for( 'upcast' ).add( + upcastElementToElement( { + model, + view, + priority: definition.priority + } ) + ); } } /** - * Defines a conversion between the model and the view where a model attribute is represented as a view element (and vice versa). + * Sets up converters between the model and the view which convert a model attribute to a view element (and vice versa). * For example, model text node with data `"Foo"` and `bold` attribute is `Foo` in the view. * - * conversion.attributeToElement( 'bold', { view: 'strong' } ); + * `definition.model` parameter specifies what model attribute should be converted from/to. It can be a `{ key, value }` object + * describing attribute key and value to convert or a `String` specifying just attribute key (then `value` is set to `true`). + * + * // Simple conversion from `bold=true` attribute to `` view element (and vice versa). + * conversion.attributeToElement( { model: 'bold', view: 'strong' } ); * - * conversion.attributeToElement( 'bold', { + * // Override other converters by specifying converter definition with higher priority. + * conversion.attributeToElement( { model: 'bold', view: 'b', priority: 'high' } ); + * + * // View specified as an object instead of a string. + * conversion.attributeToElement( { + * model: 'bold', * view: { * name: 'span', * class: 'bold' * } * } ); * - * conversion.attributeToElement( 'bold', { + * // Use `upcastAlso` to define other view elements that should be also converted to `bold` attribute. + * conversion.attributeToElement( { + * model: 'bold', * view: 'strong', * upcastAlso: [ * 'b', @@ -257,45 +248,29 @@ export default class Conversion { * ] * } ); * - * conversion.attributeToElement( 'styled', { - * model: 'dark', + * // Conversion from/to a model attribute key which value is an enum (`fontSize=big|small`). + * // `upcastAlso` set as callback enables a conversion of a wide range of different view elements. + * conversion.attributeToElement( { + * model: { + * key: 'fontSize', + * values: [ 'big', 'small' ] + * }, * view: { - * name: 'span', - * class: [ 'styled', 'styled-dark' ] - * } - * } ); - * - * conversion.attributeToElement( 'fontSize', [ - * { - * model: 'big', - * view: { + * big: { * name: 'span', * style: { * 'font-size': '1.2em' * } - * } - * }, - * { - * model: 'small', - * view: { + * }, + * small: { * name: 'span', * style: { * 'font-size': '0.8em' * } * } - * } - * ] ); - * - * conversion.attributeToElement( 'fontSize', [ - * { - * model: 'big', - * view: { - * name: 'span', - * style: { - * 'font-size': '1.2em' - * } - * }, - * upcastAlso: viewElement => { + * }, + * upcastAlso: { + * big: viewElement => { * const fontSize = viewElement.getStyle( 'font-size' ); * * if ( !fontSize ) { @@ -315,17 +290,8 @@ export default class Conversion { * } * * return null; - * } - * }, - * { - * model: 'small', - * view: { - * name: 'span', - * style: { - * 'font-size': '0.8em' - * } * }, - * upcastAlso: viewElement => { + * small: viewElement => { * const fontSize = viewElement.getStyle( 'font-size' ); * * if ( !fontSize ) { @@ -347,146 +313,192 @@ export default class Conversion { * return null; * } * } - * ] ); + * } ); * - * @param {String} modelAttributeKey The key of the model attribute to convert. - * @param {Object|Array.} definition Conversion definition. It is possible to provide multiple definitions in an array. - * @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasted, the item will be treated - * as a default item, that will be used when no other item matches. When upcasted, the model attribute value will be set to `true`. - * @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to. - * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] - * Any view element matching `upcastAlso` will also be converted to the given model element. + * @param {~ConverterDefinition} definition Converter definition. */ - attributeToElement( modelAttributeKey, definition ) { - // Set downcast (model to view conversion). - this.for( 'downcast' ).add( downcastAttributeToElement( modelAttributeKey, definition ) ); - - // Set upcast (view to model conversion). In this case, we need to re-organise the definition config. - if ( !Array.isArray( definition ) ) { - definition = [ definition ]; - } - - for ( const item of definition ) { - const model = _getModelAttributeDefinition( modelAttributeKey, item.model ); - - for ( const view of _getAllViews( item ) ) { - const priority = view == item.view ? 'normal' : 'high'; + attributeToElement( definition ) { + // Set up downcast converter. + this.for( 'downcast' ).add( downcastAttributeToElement( definition ) ); - this.for( 'upcast' ).add( upcastElementToAttribute( { + // Set up upcast converter. + for ( const { model, view } of _getAllUpcastDefinitions( definition ) ) { + this.for( 'upcast' ).add( + upcastElementToAttribute( { view, - model - }, priority ) ); - } + model, + priority: definition.priority + } ) + ); } } /** - * Defines a conversion between the model and the view where a model attribute is represented as a view attribute (and vice versa). - * For example, `` is converted to `` (same attribute name and value). - * - * conversion.attributeToAttribute( 'src' ); - * - * conversion.attributeToAttribute( 'source', { view: 'src' } ); - * - * conversion.attributeToAttribute( 'aside', { - * model: true, + * Sets up converters between the model and the view which convert a model attribute to a view attribute (and vice versa). + * For example, `` is converted to `` (same attribute key and value). + * + * `definition.model` parameter specifies what model attribute should be converted from/to. + * It can be a `{ key, values, [ name ] }` object or a `String`, which will be treated like `{ key: definition.model }`. + * `key` property is the model attribute key to convert from/to. + * `values` are the possible model attribute values. If `values` is not set, model attribute value will be the same as the + * view attribute value. + * If `name` is set, conversion will be set up only for model elements with the given name. + * + * `definition.view` parameter specifies what view attribute should be converted from/to. + * It can be a `{ key, value, [ name ] }` object or a `String`, which will be treated like `{ key: definition.view }`. + * `key` property is the view attribute key to convert from/to. + * `value` is the view attribute value to convert from/to. If `definition.value` is not set, view attribute value will be + * the same as the model attribute value. + * If `key` is `'class'`, `value` can be a `String` or an array of `String`s. + * If `key` is `'style'`, `value` is an object with key-value pairs. + * In other cases, `value` is a `String`. + * If `name` is set, conversion will be set up only for model elements with the given name. + * If `definition.model.values` is set, `definition.view` is an object which assigns values from `definition.model.values` + * to `{ key, value, [ name ] }` objects. + * + * `definition.upcastAlso` specifies which other matching view elements should be also upcast to given model configuration. + * If `definition.model.values` is set, `definition.upcastAlso` should be an object assigning values from `definition.model.values` + * to {@link module:engine/view/matcher~MatcherPattern}s or arrays of {@link module:engine/view/matcher~MatcherPattern}s. + * + * **Note:** `definition.model` and `definition.view` form should be mirrored, that is the same type of parameters should + * be given in both parameters. + * + * // Simple conversion from `source` model attribute to `src` view attribute (and vice versa). + * conversion.attributeToAttribute( { model: 'source', view: 'src' } ); + * + * // Attributes values are strictly specified. + * conversion.attributeToAttribute( { + * model: { + * name: 'image', + * key: 'aside', + * values: [ 'aside' ] + * }, * view: { - * name: 'img', - * key: 'class', - * value: 'aside half-size' + * aside: { + * name: 'img', + * key: 'class', + * value: [ 'aside', 'half-size' ] + * } * } * } ); * - * conversion.attributeToAttribute( 'styled', [ - * { - * model: 'dark', - * view: { - * key: 'class', - * value: 'styled styled-dark' - * } + * // Set style attribute. + * conversion.attributeToAttribute( { + * model: { + * name: 'image', + * key: 'aside', + * values: [ 'aside' ] * }, - * { - * model: 'light', - * view: { - * key: 'class', - * value: 'styled styled-light' + * view: { + * aside: { + * name: 'img', + * key: 'style', + * value: { + * float: 'right', + * width: '50%', + * margin: '5px' + * } * } * } - * ] ); + * } ); * - * conversion.attributeToAttribute( 'align', [ - * { - * model: 'right', - * view: { + * // Conversion from/to a model attribute key which value is an enum (`align=right|center`). + * // Use `upcastAlso` to define other view elements that should be also converted to `align=right` attribute. + * conversion.attributeToAttribute( { + * model: { + * key: 'align', + * values: [ 'right', 'center' ] + * }, + * view: { + * right: { * key: 'class', * value: 'align-right' * }, - * upcastAlso: viewElement => { - * if ( viewElement.getStyle( 'text-align' ) == 'right' ) { - * return { - * style: [ 'text-align' ] - * }; - * } - * - * return null; - * } - * }, - * { - * model: 'center', - * view: { + * center: { * key: 'class', * value: 'align-center' + * } + * }, + * upcastAlso: { + * right: { + * style: { + * 'text-align': 'right' + * } * }, - * upcastAlso: { + * center: { * style: { * 'text-align': 'center' * } * } * } - * ] ); - * - * @param {String} modelAttributeKey The key of the model attribute to convert. - * @param {Object|Array.} [definition] Conversion definition. It is possible to provide multiple definitions in an array. - * If not set, the conversion helper will assume 1-to-1 conversion, that is the model attribute key and value will be same - * as the view attribute key and value. - * @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasting, - * the item will be treated as a default item, that will be used when no other item matches. When upcasting conversion, - * the model attribute value will be set to the same value as in the view. - * @param {Object} definition.view View attribute conversion details. Given object has required `key` property, - * specifying view attribute key, optional `value` property, specifying view attribute value and optional `name` - * property specifying a view element name from/on which the attribute should be converted. If `value` is not given, - * the view attribute value will be equal to model attribute value. + * } ); + * + * @param {Object} [definition] Converter definition. + * @param {String|Object} definition.model Model attribute to convert from/to. + * @param {String|Object} definition.view View attribute to convert from/to. * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] - * Any view element matching `upcastAlso` will also be converted to the given model element. + * Any view element matching `definition.upcastAlso` will also be converted to the given model attribute. `definition.upcastAlso` + * is used only if `config.model.values` is specified. */ - attributeToAttribute( modelAttributeKey, definition ) { + attributeToAttribute( definition ) { // Set up downcast converter. - this.for( 'downcast' ).add( downcastAttributeToAttribute( modelAttributeKey, definition ) ); - - // Set up upcast converter. In this case, we need to re-organise the definition config. - if ( !definition ) { - definition = { view: modelAttributeKey }; - } + this.for( 'downcast' ).add( downcastAttributeToAttribute( definition ) ); - if ( !Array.isArray( definition ) ) { - definition = [ definition ]; + // Set up upcast converter. + for ( const { model, view } of _getAllUpcastDefinitions( definition ) ) { + this.for( 'upcast' ).add( + upcastAttributeToAttribute( { + view, + model + } ) + ); } + } - for ( const item of definition ) { - const model = _getModelAttributeDefinition( modelAttributeKey, item.model ); - - for ( const view of _getAllViews( item ) ) { - const priority = view == item.view ? 'low' : 'normal'; + /** + * Returns dispatchers registered under given group name. + * + * If given group name has not been registered, + * {@link module:utils/ckeditorerror~CKEditorError conversion-for-unknown-group} error is thrown. + * + * @private + * @param {String} groupName + * @returns {Array.} + */ + _getDispatchers( groupName ) { + const dispatchers = this._dispatchersGroups.get( groupName ); - this.for( 'upcast' ).add( upcastAttributeToAttribute( { - view, - model - }, priority ) ); - } + if ( !dispatchers ) { + /** + * Trying to add a converter to an unknown dispatchers group. + * + * @error conversion-for-unknown-group + */ + throw new CKEditorError( 'conversion-for-unknown-group: Trying to add a converter to an unknown dispatchers group.' ); } + + return dispatchers; } } +/** + * Defines how the model should be converted from/to the view. + * + * @typedef {Object} module:engine/conversion/conversion~ConverterDefinition + * + * @property {*} [model] Model conversion definition. Describes model element or model attribute to convert. This parameter differs + * for different functions that accepts `ConverterDefinition`. See the description of a function to learn how to set it. + * @property {module:engine/view/elementdefinition~ElementDefinition|Object} view Definition of a view element to convert from/to. + * If `model` describes multiple values, `view` is an object that assigns those values (`view` object keys) to view element definitions + * (`view` object values). + * @property {module:engine/view/matcher~MatcherPattern|Array.} [upcastAlso] + * Any view element matching `upcastAlso` will also be converted to model. If `model` describes multiple values, `upcastAlso` + * is an object that assigns those values (`upcastAlso` object keys) to {@link module:engine/view/matcher~MatcherPattern}s + * (`upcastAlso` object values). + * @property {module:utils/priorities~PriorityString} [priority] Conversion priority. + */ + // Helper function for `Conversion` `.add()` method. // // Calls `conversionHelper` on each dispatcher from the group specified earlier in `.for()` call, effectively @@ -502,33 +514,33 @@ function _addToDispatchers( dispatchers, conversionHelper ) { } } -// Helper function, normalizes input data into a correct config form that can be accepted by conversion helpers. The -// correct form is either `String` or an object with `key` and `value` properties. -// -// @param {String} key Model attribute key. -// @param {*} [model] Model attribute value. -// @returns {Object} Normalized model attribute definition. -function _getModelAttributeDefinition( key, model ) { - if ( model === undefined ) { - return key; - } else { - return { - key, value: model - }; - } -} - // Helper function that creates a joint array out of an item passed in `definition.view` and items passed in // `definition.upcastAlso`. // -// @param {Object} definition Conversion definition. +// @param {~ConverterDefinition} definition // @returns {Array} Array containing view definitions. -function _getAllViews( definition ) { - if ( !definition.upcastAlso ) { - return [ definition.view ]; +function* _getAllUpcastDefinitions( definition ) { + if ( definition.model.values ) { + for ( const value of definition.model.values ) { + const model = { key: definition.model.key, value }; + const view = definition.view[ value ]; + const upcastAlso = definition.upcastAlso ? definition.upcastAlso[ value ] : undefined; + + yield* _getUpcastDefinition( model, view, upcastAlso ); + } } else { - const upcastAlso = Array.isArray( definition.upcastAlso ) ? definition.upcastAlso : [ definition.upcastAlso ]; + yield* _getUpcastDefinition( definition.model, definition.view, definition.upcastAlso ); + } +} + +function* _getUpcastDefinition( model, view, upcastAlso ) { + yield { model, view }; - return [ definition.view ].concat( upcastAlso ); + if ( upcastAlso ) { + upcastAlso = Array.isArray( upcastAlso ) ? upcastAlso : [ upcastAlso ]; + + for ( const upcastAlsoItem of upcastAlso ) { + yield { model, view: upcastAlsoItem }; + } } } diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index 40e7b5d52..17c291d4f 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -7,9 +7,6 @@ import ModelRange from '../model/range'; import ModelSelection from '../model/selection'; import ModelElement from '../model/element'; -import ViewContainerElement from '../view/containerelement'; -import ViewUIElement from '../view/uielement'; -import ViewElement from '../view/element'; import ViewAttributeElement from '../view/attributeelement'; import ViewRange from '../view/range'; import DocumentSelection from '../model/documentselection'; @@ -29,7 +26,7 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep'; * * downcastElementToElement( { model: 'paragraph', view: 'p' } ); * - * downcastElementToElement( { model: 'paragraph', view: 'p' }, 'high' ); + * downcastElementToElement( { model: 'paragraph', view: 'div', priority: 'high' } ); * * downcastElementToElement( { * model: 'fancyParagraph', @@ -41,33 +38,24 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep'; * * downcastElementToElement( { * model: 'heading', - * view: ( modelItem, consumable, conversionApi ) => { - * const viewWriter = conversionApi.writer; - * - * return viewWriter.createContainerElement( 'h' + modelItem.getAttribute( 'level' ) ); - * } + * view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) ) * } ); * * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process. * * @param {Object} config Conversion configuration. * @param {String} config.model Name of the model element to convert. - * @param {String|module:engine/view/elementdefinition~ElementDefinition|Function} config.view View element name, or a - * view element definition, or a function that will be provided with all the parameters of the dispatcher's - * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert insert event}. - * It's expected that the function returns a {@link module:engine/view/containerelement~ContainerElement}. - * The view element will be used then in conversion. - * - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {module:engine/view/elementdefinition~ElementDefinition|Function} config.view View element definition or a function + * that takes model element and view writer as a parameters and returns a view container element. * @returns {Function} Conversion helper. */ -export function downcastElementToElement( config, priority = 'normal' ) { +export function downcastElementToElement( config ) { config = cloneDeep( config ); - _normalizeToElementConfig( config, ViewContainerElement ); + config.view = _normalizeToElementConfig( config.view, 'container' ); return dispatcher => { - dispatcher.on( 'insert:' + config.model, insertElement( config.view ), { priority } ); + dispatcher.on( 'insert:' + config.model, insertElement( config.view ), { priority: config.priority || 'normal' } ); }; } @@ -77,75 +65,74 @@ export function downcastElementToElement( config, priority = 'normal' ) { * This conversion results in wrapping view nodes in a view attribute element. For example, model text node with data * `"Foo"` and `bold` attribute becomes `Foo` in the view. * - * downcastAttributeToElement( 'bold', { view: 'strong' } ); + * downcastAttributeToElement( { model: 'bold', view: 'strong' } ); * - * downcastAttributeToElement( 'bold', { view: 'strong' }, 'high' ); + * downcastAttributeToElement( { model: 'bold', view: 'b', priority: 'high' } ); * - * downcastAttributeToElement( 'bold', { + * downcastAttributeToElement( { + * model: 'invert', * view: { * name: 'span', - * class: 'bold' + * class: [ 'font-light', 'bg-dark' ] * } * } ); * - * downcastAttributeToElement( 'styled', { - * model: 'dark', + * downcastAttributeToElement( { + * model: { + * key: 'fontSize', + * values: [ 'big', 'small' ] + * }, * view: { - * name: 'span', - * class: [ 'styled', 'styled-dark' ] - * } - * } ); - * - * downcastAttributeToElement( 'fontSize', [ - * { - * model: 'big', - * view: { + * big: { * name: 'span', * style: { * 'font-size': '1.2em' * } - * } - * }, - * { - * model: 'small', - * view: { + * }, + * small: { * name: 'span', * style: { * 'font-size': '0.8em' * } * } * } - * ] ); - * - * downcastAttributeToElement( 'bold', { - * view: ( modelAttributeValue, data, consumable, conversionApi ) => { - * const viewWriter = conversionApi.writer; + * } ); * - * return viewWriter( 'span', { style: 'font-weight:' + modelAttributeValue } ); + * downcastAttributeToElement( { + * model: 'bold', + * view: ( modelAttributeValue, viewWriter ) => { + * return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } ); * } * } ); * * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process. * - * @param {String} modelAttributeKey The key of the attribute to convert. - * @param {Object|Array.} config Conversion configuration. It is possible to provide multiple configurations in an array. - * @param {*} [config.model] The value of the converted model attribute for which the `view` property is defined. - * If omitted, the configuration item will be used as a "default" configuration when no other item matches the attribute value. - * @param {String|module:engine/view/elementdefinition~ElementDefinition|Function} config.view View element name, - * or a view element definition, or a function that takes model element as a parameter and returns a view attribute element. - * The view element will be used then in conversion. - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {Object} config Conversion configuration. + * @param {String|Object} config.model Key of the attribute to convert from or a `{ key, values }` object. `values` is an array + * of `String`s with possible values if the model attribute is enumerable. + * @param {module:engine/view/elementdefinition~ElementDefinition|Function|Object} config.view View element definition or a function + * that takes model attribute value and view writer as parameters and returns a view attribute element. If `config.model.values` is + * given, `config.view` should be an object assigning values from `config.model.values` to view element definitions or functions. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function downcastAttributeToElement( modelAttributeKey, config, priority = 'normal' ) { +export function downcastAttributeToElement( config ) { config = cloneDeep( config ); - _normalizeToElementConfig( config, ViewAttributeElement ); + const modelKey = config.model.key ? config.model.key : config.model; + + if ( config.model.values ) { + for ( const modelValue of config.model.values ) { + config.view[ modelValue ] = _normalizeToElementConfig( config.view[ modelValue ], 'attribute' ); + } + } else { + config.view = _normalizeToElementConfig( config.view, 'attribute' ); + } - const elementCreator = _getCreatorForArrayConfig( config ); + const elementCreator = _getFromAttributeCreator( config ); return dispatcher => { - dispatcher.on( 'attribute:' + modelAttributeKey, wrap( elementCreator ), { priority } ); + dispatcher.on( 'attribute:' + modelKey, wrap( elementCreator ), { priority: config.priority || 'normal' } ); }; } @@ -155,74 +142,75 @@ export function downcastAttributeToElement( modelAttributeKey, config, priority * This conversion results in adding an attribute on a view node, basing on an attribute from a model node. For example, * `` is converted to ``. * - * downcastAttributeToAttribute( 'src' ); - * - * downcastAttributeToAttribute( 'source', { view: 'src' } ); + * downcastAttributeToAttribute( { model: 'source', view: 'src' } ); * - * downcastAttributeToAttribute( 'source', { view: 'src' }, 'high' ); + * downcastAttributeToAttribute( { model: 'source', view: 'href', priority: 'high' } ); * - * downcastAttributeToAttribute( 'stylish', { - * view: { - * key: 'class', - * value: 'styled' - * } + * downcastAttributeToAttribute( { + * model: { + * name: 'image', + * key: 'source' + * }, + * view: 'src' * } ); * - * downcastAttributeToAttribute( 'styled', { - * model: 'dark', + * downcastAttributeToAttribute( { + * model: { + * name: 'styled', + * values: [ 'dark', 'light' ] + * }, * view: { - * key: 'class', - * value: 'styled styled-dark' - * } - * } ); - * - * downcastAttributeToAttribute( 'style', [ - * { - * model: 'dark', - * view: { + * dark: { * key: 'class', - * value: 'styled-dark' - * } - * }, - * { - * model: 'light', - * view: { + * value: [ 'styled', 'styled-dark' ] + * }, + * light: { * key: 'class', - * value: 'styled-light' + * value: [ 'styled', 'styled-light' ] * } * } - * ] ); + * } ); * - * downcastAttributeToAttribute( 'style', { - * view: attributeValue => ( { key: 'class', value: 'style-' + attributeValue } ) + * downcastAttributeToAttribute( { + * model: 'styled', + * view: modelAttributeValue => ( { key: 'class', value: 'styled-' + modelAttributeValue } ) * } ); * * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process. * - * @param {String} modelAttributeKey The key of the attribute to convert. - * @param {Object|Array.} [config] Conversion configuration. It is possible to provide multiple configurations in an array. - * If not set, the conversion helper will assume 1-to-1 conversion, that is the view attribute key and view attribute value - * will be same as model attribute key and model attribute value. - * @param {*} [config.model] The value of the converted model attribute for which the `view` property is defined. - * If `true` is provided, the configuration item will be used as a "default" configuration when no other item matches - * the attribute value. - * @param {String|Object|Function} [config.view] View attribute key, or an object with `key` and `value` properties (both `String`), - * or a function that takes model attribute value and returns an object with `key` and `value` properties (both `String`). - * If nothing is passed, the view attribute key and value will be equal to the model attribute key and value. - * If a `String` is passed, it will be used as view attribute key and view attribute value will be equal to model attribute value. - * If an object or a function returning an object is passed, its properties will be used to set view attribute key and value. - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {Object} config Conversion configuration. + * @param {String|Object} config.model Key of the attribute to convert from or a `{ key, values, [ name ] }` object describing + * the attribute key, possible values and, optionally, an element name to convert from. + * @param {String|Object|Function} config.view View attribute key, or a `{ key, value }` object or a function that takes + * model attribute value and returns a `{ key, value }` object. If `key` is `'class'`, `value` can be a `String` or an + * array of `String`s. If `key` is `'style'`, `value` is an object with key-value pairs. In other cases, `value` is a `String`. + * If `config.model.values` is set, `config.view` should be an object assigning values from `config.model.values` to + * `{ key, value }` objects or a functions. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function downcastAttributeToAttribute( modelAttributeKey, config = {}, priority = 'normal' ) { +export function downcastAttributeToAttribute( config ) { config = cloneDeep( config ); - _normalizeToAttributeConfig( modelAttributeKey, config ); + const modelKey = config.model.key ? config.model.key : config.model; + let eventName = 'attribute:' + modelKey; - const elementCreator = _getCreatorForArrayConfig( config ); + if ( config.model.name ) { + eventName += ':' + config.model.name; + } + + if ( config.model.values ) { + for ( const modelValue of config.model.values ) { + config.view[ modelValue ] = _normalizeToAttributeConfig( config.view[ modelValue ] ); + } + } else { + config.view = _normalizeToAttributeConfig( config.view ); + } + + const elementCreator = _getFromAttributeCreator( config ); return dispatcher => { - dispatcher.on( 'attribute:' + modelAttributeKey, changeAttribute( elementCreator ), { priority } ); + dispatcher.on( eventName, changeAttribute( elementCreator ), { priority: config.priority || 'normal' } ); }; } @@ -235,9 +223,7 @@ export function downcastAttributeToAttribute( modelAttributeKey, config = {}, pr * * downcastMarkerToElement( { model: 'search', view: 'marker-search' } ); * - * downcastMarkerToElement( { model: 'search', view: 'marker-search' }, 'high' ); - * - * downcastMarkerToElement( { model: 'search', view: new ViewUIElement( 'span', { data-marker: 'search' } ) } ); + * downcastMarkerToElement( { model: 'search', view: 'search-result', priority: 'high' } ); * * downcastMarkerToElement( { * model: 'search', @@ -251,8 +237,8 @@ export function downcastAttributeToAttribute( modelAttributeKey, config = {}, pr * * downcastMarkerToElement( { * model: 'search', - * view: ( data, conversionApi ) => { - * return conversionApi.writer.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } ); + * view: ( markerData, viewWriter ) => { + * return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': markerData.isOpening } ); * } * } ); * @@ -269,20 +255,19 @@ export function downcastAttributeToAttribute( modelAttributeKey, config = {}, pr * * @param {Object} config Conversion configuration. * @param {String} config.model Name of the model marker (or model marker group) to convert. - * @param {module:engine/view/elementdefinition~ElementDefinition|Function} config.view View element definition - * which will be used to build a view element for conversion or a function that takes model marker data as a parameter and - * returns view element to use in conversion. - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {module:engine/view/elementdefinition~ElementDefinition|Function} config.view View element definition or a function + * that takes model marker data as a parameter and returns view ui element. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function downcastMarkerToElement( config, priority = 'normal' ) { +export function downcastMarkerToElement( config ) { config = cloneDeep( config ); - _normalizeToElementConfig( config, ViewUIElement ); + config.view = _normalizeToElementConfig( config.view, 'ui' ); return dispatcher => { - dispatcher.on( 'addMarker:' + config.model, insertUIElement( config.view ), { priority } ); - dispatcher.on( 'removeMarker:' + config.model, removeUIElement( config.view ), { priority } ); + dispatcher.on( 'addMarker:' + config.model, insertUIElement( config.view ), { priority: config.priority || 'normal' } ); + dispatcher.on( 'removeMarker:' + config.model, removeUIElement( config.view ), { priority: config.priority || 'normal' } ); }; } @@ -307,7 +292,7 @@ export function downcastMarkerToElement( config, priority = 'normal' ) { * * downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } ); * - * downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' } }, 'high' ); + * downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' }, priority: 'high' } ); * * downcastMarkerToHighlight( { * model: 'comment', @@ -322,9 +307,8 @@ export function downcastMarkerToElement( config, priority = 'normal' ) { * } ); * * If function is passed as `config.view` parameter, it will be used to generate highlight descriptor. The function - * receives `data` and `conversionApi` objects as parameters and should return - * {@link module:engine/conversion/downcast-converters~HighlightDescriptor}. The `data` and `conversionApi` objects are passed from - * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker}. + * receives `data` object as parameter and should return a {@link module:engine/conversion/downcast-converters~HighlightDescriptor}. + * The `data` object properties are passed from {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker}. * * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process. * @@ -332,139 +316,107 @@ export function downcastMarkerToElement( config, priority = 'normal' ) { * @param {String} config.model Name of the model marker (or model marker group) to convert. * @param {module:engine/conversion/downcast-converters~HighlightDescriptor|Function} config.view Highlight descriptor * which will be used for highlighting or a function that takes model marker data as a parameter and returns a highlight descriptor. - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function downcastMarkerToHighlight( config, priority = 'normal' ) { +export function downcastMarkerToHighlight( config ) { return dispatcher => { - dispatcher.on( 'addMarker:' + config.model, highlightText( config.view ), { priority } ); - dispatcher.on( 'addMarker:' + config.model, highlightElement( config.view ), { priority } ); - dispatcher.on( 'removeMarker:' + config.model, removeHighlight( config.view ), { priority } ); + dispatcher.on( 'addMarker:' + config.model, highlightText( config.view ), { priority: config.priority || 'normal' } ); + dispatcher.on( 'addMarker:' + config.model, highlightElement( config.view ), { priority: config.priority || 'normal' } ); + dispatcher.on( 'removeMarker:' + config.model, removeHighlight( config.view ), { priority: config.priority || 'normal' } ); }; } -// Takes config and adds default parameters if they don't exist and normalizes other parameters to be used in downcast converters -// for generating a view element. +// Takes `config.view`, and if it is a {@link module:engine/view/elementdefinition~ElementDefinition}, converts it +// to a function (because lower level converters accepts only element creator functions). // -// @param {Object} config Object with conversion helper configuration. -// @param {Function} ViewElementClass View element class to use when generating view element from config. -function _normalizeToElementConfig( config, ViewElementClass ) { - // If config is given as an array, normalize each entry separately. - if ( Array.isArray( config ) ) { - for ( const configEntry of config ) { - _normalizeToElementConfig( configEntry, ViewElementClass ); - } - - return; +// @param {module:engine/view/elementdefinition~ElementDefinition|Function} view View configuration. +// @param {'container'|'attribute'|'ui'} viewElementType View element type to create. +// @returns {Function} Element creator function to use in lower level converters. +function _normalizeToElementConfig( view, viewElementType ) { + if ( typeof view == 'function' ) { + // If `view` is already a function, don't do anything. + return view; } - const view = config.view; - - // Build `.view` property. - // It is expected to be either string, element definition or creator function. - if ( typeof view == 'string' ) { - // If `.view` is a string, create a function that returns view element instance out of given `ViewElementClass`. - config.view = () => new ViewElementClass( view ); - } else if ( typeof view == 'object' ) { - // If `.view` is an object, use it to build view element instance. - const element = _createViewElementFromDefinition( view, ViewElementClass ); - config.view = () => element.clone(); - } - // `.view` can be also a function that is already valid type which don't have to be normalized. + return ( modelData, viewWriter ) => _createViewElementFromDefinition( view, viewWriter, viewElementType ); } // Creates view element instance from provided viewElementDefinition and class. // // @param {module:engine/view/elementdefinition~ElementDefinition} viewElementDefinition -// @param {Function} ViewElementClass +// @param {module:engine/view/writer~Writer} viewWriter +// @param {'container'|'attribute'|'ui'} viewElementType // @returns {module:engine/view/element~Element} -function _createViewElementFromDefinition( viewElementDefinition, ViewElementClass ) { - const element = new ViewElementClass( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) ); +function _createViewElementFromDefinition( viewElementDefinition, viewWriter, viewElementType ) { + if ( typeof viewElementDefinition == 'string' ) { + // If `viewElementDefinition` is given as a `String`, normalize it to an object with `name` property. + viewElementDefinition = { name: viewElementDefinition }; + } + + let element; + + if ( viewElementType == 'container' ) { + element = viewWriter.createContainerElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) ); + } else if ( viewElementType == 'attribute' ) { + element = viewWriter.createAttributeElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) ); + } else { + // 'ui'. + element = viewWriter.createUIElement( viewElementDefinition.name, Object.assign( {}, viewElementDefinition.attribute ) ); + } if ( viewElementDefinition.style ) { - element._setStyle( viewElementDefinition.style ); + const keys = Object.keys( viewElementDefinition.style ); + + for ( const key of keys ) { + viewWriter.setStyle( key, viewElementDefinition.style[ key ], element ); + } } if ( viewElementDefinition.class ) { - element._addClass( viewElementDefinition.class ); + const classes = viewElementDefinition.class; + + if ( typeof classes == 'string' ) { + viewWriter.addClass( classes, element ); + } else { + for ( const className of classes ) { + viewWriter.addClass( className, element ); + } + } } return element; } -// Takes config and adds default parameters if they don't exist and normalizes other parameters to be used in downcast converters -// for generating view attribute. -// -// @param {String} modelAttributeKey Model attribute key for which config is defined. -// @param {Object} [config] Config with conversion helper configuration. -function _normalizeToAttributeConfig( modelAttributeKey, config ) { - // If config is given as an array, normalize each entry separately. - if ( Array.isArray( config ) ) { - for ( const configEntry of config ) { - _normalizeToAttributeConfig( modelAttributeKey, configEntry ); - } +function _getFromAttributeCreator( config ) { + if ( config.model.values ) { + return ( modelAttributeValue, viewWriter ) => { + const view = config.view[ modelAttributeValue ]; - return; - } + if ( view ) { + return view( modelAttributeValue, viewWriter ); + } - // Build `.view` property. - // It is expected to be a creator function, that takes attribute value and model item and returns an object - // with `key` property and `value` property which are view attribute key and view attribute value. - if ( !config.view ) { - // If `.view` is not set, take both attribute name and attribute value from model. - const viewAttributeKey = modelAttributeKey; - config.view = modelAttributeValue => ( { key: viewAttributeKey, value: modelAttributeValue } ); - } else if ( typeof config.view == 'string' ) { - // If `.view` is set as a string, use it as a view attribute name. Value will be taken from model attribute value. - const viewAttributeKey = config.view; - config.view = modelAttributeValue => ( { key: viewAttributeKey, value: modelAttributeValue } ); - } else if ( typeof config.view == 'object' ) { - // If `.view` is set as an object, use set key and value. - const viewAttributeKey = config.view.key; - const viewAttributeValue = config.view.value; - config.view = () => ( { key: viewAttributeKey, value: viewAttributeValue } ); + return null; + }; + } else { + return config.view; } - // `.view` can be also already a function. } -// Takes config and creates a view element creator function that chooses an appropriate entry from the config depending on -// the value of model attribute. -// -// Supports specifying config as a single object or an array of objects. -// Supports `.view` defined as an object and as a function. +// Takes config and adds default parameters if they don't exist and normalizes other parameters to be used in downcast converters +// for generating view attribute. // -// @param {Object|Array.} config Config with conversion helper configuration. -function _getCreatorForArrayConfig( config ) { - if ( !Array.isArray( config ) ) { - config = [ config ]; +// @param {Object} view View configuration. +function _normalizeToAttributeConfig( view ) { + if ( typeof view == 'string' ) { + return modelAttributeValue => ( { key: view, value: modelAttributeValue } ); + } else if ( typeof view == 'object' ) { + return () => view; + } else { + // function. + return view; } - - // Get "default config" entry. It is the entry with `.model` property set to `true`. - // "Default" entry should be used if no other entry matched model attribute value. - const defaultConfig = config.find( configEntry => configEntry.model === undefined ); - - // Return a creator function. - return ( modelAttributeValue, data, consumable, conversionApi ) => { - // Set default config at first. It will be used if no other entry matches model attribute value. - let matchedConfigEntry = defaultConfig; - - // Creator should check all entries from the config... - for ( const configEntry of config ) { - if ( configEntry.model === modelAttributeValue ) { - // If `.model` specified in entry matches converted attribute's value, choose it. - matchedConfigEntry = configEntry; - break; - } - } - - // If there was default config or matched config... - if ( matchedConfigEntry ) { - // The entry `.view` is a function after it got normalized earlier, execute it and return the value. - return matchedConfigEntry.view( modelAttributeValue, data, consumable, conversionApi ); - } - - return null; - }; } /** @@ -495,7 +447,7 @@ function _getCreatorForArrayConfig( config ) { */ export function insertElement( elementCreator ) { return ( evt, data, consumable, conversionApi ) => { - const viewElement = elementCreator( data.item, consumable, conversionApi ); + const viewElement = elementCreator( data.item, conversionApi.writer ); if ( !viewElement ) { return; @@ -579,20 +531,13 @@ export function remove() { */ export function insertUIElement( elementCreator ) { return ( evt, data, consumable, conversionApi ) => { - let viewStartElement, viewEndElement; - // Create two view elements. One will be inserted at the beginning of marker, one at the end. // If marker is collapsed, only "opening" element will be inserted. - if ( elementCreator instanceof ViewElement ) { - viewStartElement = elementCreator.clone( true ); - viewEndElement = elementCreator.clone( true ); - } else { - data.isOpening = true; - viewStartElement = elementCreator( data, conversionApi ); + data.isOpening = true; + const viewStartElement = elementCreator( data, conversionApi.writer ); - data.isOpening = false; - viewEndElement = elementCreator( data, conversionApi ); - } + data.isOpening = false; + const viewEndElement = elementCreator( data, conversionApi.writer ); if ( !viewStartElement || !viewEndElement ) { return; @@ -639,20 +584,13 @@ export function insertUIElement( elementCreator ) { */ export function removeUIElement( elementCreator ) { return ( evt, data, conversionApi ) => { - let viewStartElement, viewEndElement; - // Create two view elements. One will be used to remove "opening element", the other for "closing element". // If marker was collapsed, only "opening" element will be removed. - if ( elementCreator instanceof ViewElement ) { - viewStartElement = elementCreator.clone( true ); - viewEndElement = elementCreator.clone( true ); - } else { - data.isOpening = true; - viewStartElement = elementCreator( data, conversionApi ); + data.isOpening = true; + const viewStartElement = elementCreator( data, conversionApi.writer ); - data.isOpening = false; - viewEndElement = elementCreator( data, conversionApi ); - } + data.isOpening = false; + const viewEndElement = elementCreator( data, conversionApi.writer ); if ( !viewStartElement || !viewEndElement ) { return; @@ -702,8 +640,7 @@ export function removeUIElement( elementCreator ) { * * @param {Function} [attributeCreator] Function returning an object with two properties: `key` and `value`, which * represents attribute key and attribute value to be set on a {@link module:engine/view/element~Element view element}. - * The function is passed all the parameters of the - * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute} event. + * The function is passed model attribute value as first parameter and additional data about the change as a second parameter. * @returns {Function} Set/change attribute converter. */ export function changeAttribute( attributeCreator ) { @@ -714,22 +651,49 @@ export function changeAttribute( attributeCreator ) { return; } - // First remove the old attribute if there was one. - const oldAttribute = attributeCreator( data.attributeOldValue, data, consumable, conversionApi ); - const mapper = conversionApi.mapper; + const viewElement = conversionApi.mapper.toViewElement( data.item ); const viewWriter = conversionApi.writer; + // First remove the old attribute if there was one. + const oldAttribute = attributeCreator( data.attributeOldValue, data ); + if ( data.attributeOldValue !== null && oldAttribute ) { - const viewElement = mapper.toViewElement( data.item ); - viewWriter.removeAttribute( oldAttribute.key, viewElement ); + if ( oldAttribute.key == 'class' ) { + const classes = Array.isArray( oldAttribute.value ) ? oldAttribute.value : [ oldAttribute.value ]; + + for ( const className of classes ) { + viewWriter.removeClass( className, viewElement ); + } + } else if ( oldAttribute.key == 'style' ) { + const keys = Object.keys( oldAttribute.value ); + + for ( const key of keys ) { + viewWriter.removeStyle( key, viewElement ); + } + } else { + viewWriter.removeAttribute( oldAttribute.key, viewElement ); + } } // Then, if conversion was successful, set the new attribute. const newAttribute = attributeCreator( data.attributeNewValue, data, consumable, conversionApi ); if ( data.attributeNewValue !== null && newAttribute ) { - const viewElement = mapper.toViewElement( data.item ); - viewWriter.setAttribute( newAttribute.key, newAttribute.value, viewElement ); + if ( newAttribute.key == 'class' ) { + const classes = Array.isArray( newAttribute.value ) ? newAttribute.value : [ newAttribute.value ]; + + for ( const className of classes ) { + viewWriter.addClass( className, viewElement ); + } + } else if ( newAttribute.key == 'style' ) { + const keys = Object.keys( newAttribute.value ); + + for ( const key of keys ) { + viewWriter.setStyle( key, newAttribute.value[ key ], viewElement ); + } + } else { + viewWriter.setAttribute( newAttribute.key, newAttribute.value, viewElement ); + } } }; } @@ -768,10 +732,10 @@ export function wrap( elementCreator ) { return ( evt, data, consumable, conversionApi ) => { // Recreate current wrapping node. It will be used to unwrap view range if the attribute value has changed // or the attribute was removed. - const oldViewElement = elementCreator( data.attributeOldValue, data, consumable, conversionApi ); + const oldViewElement = elementCreator( data.attributeOldValue, conversionApi.writer ); // Create node to wrap with. - const newViewElement = elementCreator( data.attributeNewValue, data, consumable, conversionApi ); + const newViewElement = elementCreator( data.attributeNewValue, conversionApi.writer ); if ( !oldViewElement && !newViewElement ) { return; diff --git a/src/conversion/upcast-converters.js b/src/conversion/upcast-converters.js index 22ccfe3e6..1e51104df 100644 --- a/src/conversion/upcast-converters.js +++ b/src/conversion/upcast-converters.js @@ -26,7 +26,7 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep'; * * upcastElementToElement( { view: 'p', model: 'paragraph' } ); * - * upcastElementToElement( { view: 'p', model: 'paragraph' }, 'high' ); + * upcastElementToElement( { view: 'p', model: 'paragraph', priority: 'high' } ); * * upcastElementToElement( { * view: { @@ -52,10 +52,10 @@ import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep'; * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted. * @param {String|module:engine/model/element~Element|Function} config.model Name of the model element, a model element * instance or a function that takes a view element and returns a model element. The model element will be inserted in the model. - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function upcastElementToElement( config, priority = 'normal' ) { +export function upcastElementToElement( config ) { config = cloneDeep( config ); const converter = _prepareToElementConverter( config ); @@ -64,7 +64,7 @@ export function upcastElementToElement( config, priority = 'normal' ) { const eventName = elementName ? 'element:' + elementName : 'element'; return dispatcher => { - dispatcher.on( eventName, converter, { priority } ); + dispatcher.on( eventName, converter, { priority: config.priority || 'normal' } ); }; } @@ -78,7 +78,7 @@ export function upcastElementToElement( config, priority = 'normal' ) { * * upcastElementToAttribute( { view: 'strong', model: 'bold' } ); * - * upcastElementToAttribute( { view: 'strong', model: 'bold' }, 'normal' ); + * upcastElementToAttribute( { view: 'strong', model: 'bold', priority: 'high' } ); * * upcastElementToAttribute( { * view: { @@ -130,10 +130,10 @@ export function upcastElementToElement( config, priority = 'normal' ) { * @param {String|Object} config.model Model attribute key or an object with `key` and `value` properties, describing * the model attribute. `value` property may be set as a function that takes a view element and returns the value. * If `String` is given, the model attribute value will be set to `true`. - * @param {module:utils/priorities~PriorityString} [priority='low'] Converter priority. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function upcastElementToAttribute( config, priority = 'low' ) { +export function upcastElementToAttribute( config ) { config = cloneDeep( config ); _normalizeModelAttributeConfig( config ); @@ -144,7 +144,7 @@ export function upcastElementToAttribute( config, priority = 'low' ) { const eventName = elementName ? 'element:' + elementName : 'element'; return dispatcher => { - dispatcher.on( eventName, converter, { priority } ); + dispatcher.on( eventName, converter, { priority: config.priority || 'normal' } ); }; } @@ -160,7 +160,7 @@ export function upcastElementToAttribute( config, priority = 'low' ) { * * upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source' } ); * - * upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source' }, 'normal' ); + * upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source', priority: 'normal' } ); * * upcastAttributeToAttribute( { * view: { @@ -172,7 +172,7 @@ export function upcastElementToAttribute( config, priority = 'low' ) { * * upcastAttributeToAttribute( { * view: { - * name: 'span', + * name: 'img', * key: 'class', * value: 'styled-dark' * }, @@ -209,10 +209,10 @@ export function upcastElementToAttribute( config, priority = 'low' ) { * @param {String|Object} config.model Model attribute key or an object with `key` and `value` properties, describing * the model attribute. `value` property may be set as a function that takes a view element and returns the value. * If `String` is given, the model attribute value will be same as view attribute value. - * @param {module:utils/priorities~PriorityString} [priority='low'] Converter priority. + * @param {module:utils/priorities~PriorityString} [config.priority='low'] Converter priority. * @returns {Function} Conversion helper. */ -export function upcastAttributeToAttribute( config, priority = 'low' ) { +export function upcastAttributeToAttribute( config ) { config = cloneDeep( config ); let viewKey = null; @@ -226,7 +226,7 @@ export function upcastAttributeToAttribute( config, priority = 'low' ) { const converter = _prepareToAttributeConverter( config, false ); return dispatcher => { - dispatcher.on( 'element', converter, { priority } ); + dispatcher.on( 'element', converter, { priority: config.priority || 'low' } ); }; } @@ -240,7 +240,7 @@ export function upcastAttributeToAttribute( config, priority = 'low' ) { * * upcastElementToMarker( { view: 'marker-search', model: 'search' } ); * - * upcastElementToMarker( { view: 'marker-search', model: 'search' }, 'high' ); + * upcastElementToMarker( { view: 'marker-search', model: 'search', priority: 'high' } ); * * upcastElementToMarker( { * view: 'marker-search', @@ -263,15 +263,15 @@ export function upcastAttributeToAttribute( config, priority = 'low' ) { * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted. * @param {String|Function} config.model Name of the model marker, or a function that takes a view element and returns * a model marker name. - * @param {module:utils/priorities~PriorityString} [priority='normal'] Converter priority. + * @param {module:utils/priorities~PriorityString} [config.priority='normal'] Converter priority. * @returns {Function} Conversion helper. */ -export function upcastElementToMarker( config, priority = 'normal' ) { +export function upcastElementToMarker( config ) { config = cloneDeep( config ); _normalizeToMarkerConfig( config ); - return upcastElementToElement( config, priority ); + return upcastElementToElement( config ); } // Helper function for from-view-element conversion. Checks if `config.view` directly specifies converted view element's name @@ -391,13 +391,21 @@ function _normalizeViewAttributeKeyValueConfig( config ) { } const key = config.view.key; - const value = typeof config.view.value == 'undefined' ? /[\s\S]*/ : config.view.value; + let normalized; - const normalized = { - attribute: { - [ key ]: value - } - }; + if ( key == 'class' || key == 'style' ) { + normalized = { + [ key ]: config.view.value + }; + } else { + const value = typeof config.view.value == 'undefined' ? /[\s\S]*/ : config.view.value; + + normalized = { + attribute: { + [ key ]: value + } + }; + } if ( config.view.name ) { normalized.name = config.view.name; @@ -504,10 +512,10 @@ function _setAttributeOn( modelRange, modelAttribute, conversionApi ) { function _normalizeToMarkerConfig( config ) { const oldModel = config.model; - config.model = ( viewElement, writer ) => { + config.model = ( viewElement, modelWriter ) => { const markerName = typeof oldModel == 'string' ? oldModel : oldModel( viewElement ); - return writer.createElement( '$marker', { 'data-name': markerName } ); + return modelWriter.createElement( '$marker', { 'data-name': markerName } ); }; } diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index a66b7c87c..63eae3105 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -16,24 +16,25 @@ import Model from '../model/model'; import Batch from '../model/batch'; import ModelRange from '../model/range'; import ModelPosition from '../model/position'; -import DowncastDispatcher from '../conversion/downcastdispatcher'; import ModelSelection from '../model/selection'; import ModelDocumentFragment from '../model/documentfragment'; import DocumentSelection from '../model/documentselection'; import View from '../view/view'; -import UpcastDispatcher from '../conversion/upcastdispatcher'; import ViewContainerElement from '../view/containerelement'; -import ViewAttributeElement from '../view/attributeelement'; import ViewRootEditableElement from '../view/rooteditableelement'; -import Mapper from '../conversion/mapper'; import { parse as viewParse, stringify as viewStringify } from '../../src/dev-utils/view'; + +import DowncastDispatcher from '../conversion/downcastdispatcher'; +import UpcastDispatcher from '../conversion/upcastdispatcher'; +import Mapper from '../conversion/mapper'; import { convertRangeSelection, convertCollapsedSelection, } from '../conversion/downcast-selection-converters'; import { insertText, insertElement, wrap } from '../conversion/downcast-converters'; + import isPlainObject from '@ckeditor/ckeditor5-utils/src/lib/lodash/isPlainObject'; import toMap from '@ckeditor/ckeditor5-utils/src/tomap'; @@ -208,11 +209,18 @@ export function stringify( node, selectionOrPositionOrRange = null ) { mapper.bindElements( node.root, viewRoot ); downcastDispatcher.on( 'insert:$text', insertText() ); - downcastDispatcher.on( 'attribute', wrap( ( value, data ) => { + downcastDispatcher.on( 'attribute', ( evt, data, consumable, conversionApi ) => { if ( data.item instanceof ModelSelection || data.item instanceof DocumentSelection || data.item.is( 'textProxy' ) ) { - return new ViewAttributeElement( 'model-text-with-attributes', { [ data.attributeKey ]: stringifyAttributeValue( value ) } ); + const converter = wrap( ( modelAttributeValue, viewWriter ) => { + return viewWriter.createAttributeElement( + 'model-text-with-attributes', + { [ data.attributeKey ]: stringifyAttributeValue( modelAttributeValue ) } + ); + } ); + + converter( evt, data, consumable, conversionApi ); } - } ) ); + } ); downcastDispatcher.on( 'insert', insertElement( modelItem => { // Stringify object types values for properly display as an output string. const attributes = convertAttributes( modelItem.getAttributes(), stringifyAttributeValue ); diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index 8bf553813..58807df48 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -264,7 +264,7 @@ describe( 'DataController', () => { setData( model, 'foo<$text bold="true">bar' ); downcastElementToElement( { model: 'paragraph', view: 'p' } )( data.downcastDispatcher ); - downcastAttributeToElement( 'bold', { view: 'strong' } )( data.downcastDispatcher ); + downcastAttributeToElement( { model: 'bold', view: 'strong' } )( data.downcastDispatcher ); expect( data.get() ).to.equal( '

foobar

' ); } ); @@ -277,7 +277,7 @@ describe( 'DataController', () => { setData( model, 'Bar', { rootName: 'title' } ); downcastElementToElement( { model: 'paragraph', view: 'p' } )( data.downcastDispatcher ); - downcastAttributeToElement( 'bold', { view: 'strong' } )( data.downcastDispatcher ); + downcastAttributeToElement( { model: 'bold', view: 'strong' } )( data.downcastDispatcher ); expect( data.get() ).to.equal( '

foo

' ); expect( data.get( 'main' ) ).to.equal( '

foo

' ); diff --git a/tests/conversion/conversion.js b/tests/conversion/conversion.js index 2e732c0bc..10ce09fa5 100644 --- a/tests/conversion/conversion.js +++ b/tests/conversion/conversion.js @@ -93,7 +93,7 @@ describe( 'Conversion', () => { const modelDoc = model.document; modelRoot = modelDoc.createRoot(); - viewRoot = controller.view.getRoot(); + viewRoot = controller.view.document.getRoot(); // Set name of view root the same as dom root. // This is a mock of attaching view root to dom root. viewRoot._name = 'div'; @@ -125,6 +125,14 @@ describe( 'Conversion', () => { test( '

Foo

', 'Foo' ); } ); + it( 'config.priority is defined', () => { + conversion.elementToElement( { model: 'paragraph', view: 'p' } ); + conversion.elementToElement( { model: 'paragraph', view: 'div', priority: 'high' } ); + + test( '
Foo
', 'Foo' ); + test( '

Foo

', 'Foo', '
Foo
' ); + } ); + it( 'config.view is an object', () => { schema.register( 'fancyParagraph', { inheritAllFrom: 'paragraph' @@ -148,7 +156,7 @@ describe( 'Conversion', () => { upcastAlso: [ 'div', { - // Match any name. + // Any element with `display: block` style. name: /./, style: { display: 'block' @@ -212,13 +220,22 @@ describe( 'Conversion', () => { } ); it( 'config.view is a string', () => { - conversion.attributeToElement( 'bold', { view: 'strong' } ); + conversion.attributeToElement( { model: 'bold', view: 'strong' } ); test( '

Foo bar

', '<$text bold="true">Foo bar' ); } ); + it( 'config.priority is defined', () => { + conversion.attributeToElement( { model: 'bold', view: 'strong' } ); + conversion.attributeToElement( { model: 'bold', view: 'b', priority: 'high' } ); + + test( '

Foo

', '<$text bold="true">Foo' ); + test( '

Foo

', '<$text bold="true">Foo', '

Foo

' ); + } ); + it( 'config.view is an object', () => { - conversion.attributeToElement( 'bold', { + conversion.attributeToElement( { + model: 'bold', view: { name: 'span', class: 'bold' @@ -229,7 +246,8 @@ describe( 'Conversion', () => { } ); it( 'config.view is an object with upcastAlso defined', () => { - conversion.attributeToElement( 'bold', { + conversion.attributeToElement( { + model: 'bold', view: 'strong', upcastAlso: [ 'b', @@ -292,77 +310,32 @@ describe( 'Conversion', () => { ); } ); - it( 'config.model is a string', () => { - schema.extend( '$text', { - allowAttributes: [ 'styled' ] - } ); - - conversion.attributeToElement( 'styled', { - model: 'dark', - view: { - name: 'span', - class: [ 'styled', 'styled-dark' ] - } - } ); - - test( - '

Foo bar

', - '<$text styled="dark">Foo bar' - ); - } ); - - it( 'config is an array', () => { + it( 'model attribute value is enumerable', () => { schema.extend( '$text', { allowAttributes: [ 'fontSize' ] } ); - conversion.attributeToElement( 'fontSize', [ - { - model: 'big', - view: { + conversion.attributeToElement( { + model: { + key: 'fontSize', + values: [ 'big', 'small' ] + }, + view: { + big: { name: 'span', style: { 'font-size': '1.2em' } - } - }, - { - model: 'small', - view: { + }, + small: { name: 'span', style: { 'font-size': '0.8em' } } - } - ] ); - - test( - '

Foo bar

', - '<$text fontSize="big">Foo bar' - ); - - test( - '

Foo bar

', - '<$text fontSize="small">Foo bar' - ); - } ); - - it( 'config is an array with upcastAlso defined', () => { - schema.extend( '$text', { - allowAttributes: [ 'fontSize' ] - } ); - - conversion.attributeToElement( 'fontSize', [ - { - model: 'big', - view: { - name: 'span', - style: { - 'font-size': '1.2em' - } - }, - upcastAlso: viewElement => { + }, + upcastAlso: { + big: viewElement => { const fontSize = viewElement.getStyle( 'font-size' ); if ( !fontSize ) { @@ -382,17 +355,8 @@ describe( 'Conversion', () => { } return null; - } - }, - { - model: 'small', - view: { - name: 'span', - style: { - 'font-size': '0.8em' - } }, - upcastAlso: viewElement => { + small: viewElement => { const fontSize = viewElement.getStyle( 'font-size' ); if ( !fontSize ) { @@ -414,7 +378,7 @@ describe( 'Conversion', () => { return null; } } - ] ); + } ); test( '

Foo bar

', @@ -455,70 +419,70 @@ describe( 'Conversion', () => { } ); } ); - it( 'config is not set', () => { - schema.extend( 'image', { - allowAttributes: [ 'src' ] - } ); - - conversion.attributeToAttribute( 'src' ); - - test( '', '' ); - } ); - - it( 'config.view is a string', () => { + it( 'config.view and config.model are strings', () => { schema.extend( 'image', { allowAttributes: [ 'source' ] } ); - conversion.attributeToAttribute( 'source', { view: 'src' } ); + conversion.attributeToAttribute( { model: 'source', view: 'src' } ); test( '', '' ); } ); - it( 'config.view is an object', () => { + it( 'config.view and config.model are objects', () => { schema.extend( 'image', { allowAttributes: [ 'aside' ] } ); - conversion.attributeToAttribute( 'aside', { - model: true, + conversion.attributeToAttribute( { + model: { + name: 'image', + key: 'aside', + values: [ 'aside' ] + }, view: { - name: 'img', - key: 'class', - value: 'aside half-size' + aside: { + name: 'img', + key: 'class', + value: [ 'aside', 'half-size' ] + } } } ); conversion.elementToElement( { model: 'paragraph', view: 'p' } ); - test( '', '' ); + test( '', '' ); test( '

', '', '

' ); } ); - it( 'config is an array', () => { + it( 'config.view and config.model are objects - convert to style attribute', () => { schema.extend( 'image', { - allowAttributes: [ 'styled' ] + allowAttributes: [ 'aside' ] } ); - conversion.attributeToAttribute( 'styled', [ - { - model: 'dark', - view: { - key: 'class', - value: 'styled styled-dark' - } + conversion.attributeToAttribute( { + model: { + name: 'image', + key: 'aside', + values: [ 'aside' ] }, - { - model: 'light', - view: { - key: 'class', - value: 'styled styled-light' + view: { + aside: { + name: 'img', + key: 'style', + value: { + float: 'right', + width: '50%', + margin: '5px' + } } } - ] ); + } ); + + conversion.elementToElement( { model: 'paragraph', view: 'p' } ); - test( '', '' ); - test( '', '' ); + test( '', '' ); + test( '

', '', '

' ); } ); it( 'config is an array with upcastAlso defined', () => { @@ -528,36 +492,34 @@ describe( 'Conversion', () => { allowAttributes: [ 'align' ] } ); - conversion.attributeToAttribute( 'align', [ - { - model: 'right', - view: { + conversion.attributeToAttribute( { + model: { + key: 'align', + values: [ 'right', 'center' ] + }, + view: { + right: { key: 'class', value: 'align-right' }, - upcastAlso: viewElement => { - if ( viewElement.getStyle( 'text-align' ) == 'right' ) { - return { - style: [ 'text-align' ] - }; - } - - return null; - } - }, - { - model: 'center', - view: { + center: { key: 'class', value: 'align-center' + } + }, + upcastAlso: { + right: { + style: { + 'text-align': 'right' + } }, - upcastAlso: { + center: { style: { 'text-align': 'center' } } } - ] ); + } ); test( '

Foo

', @@ -592,8 +554,11 @@ describe( 'Conversion', () => { function loadData( input ) { const parsedView = viewParse( input ); + let convertedModel; - const convertedModel = viewDispatcher.convert( parsedView ); + model.change( writer => { + convertedModel = viewDispatcher.convert( parsedView, writer ); + } ); model.change( writer => { writer.remove( ModelRange.createFromParentsAndOffsets( modelRoot, 0, modelRoot, modelRoot.maxOffset ) ); diff --git a/tests/conversion/downcast-converters.js b/tests/conversion/downcast-converters.js index 13d6e9db2..446e920a6 100644 --- a/tests/conversion/downcast-converters.js +++ b/tests/conversion/downcast-converters.js @@ -15,7 +15,6 @@ import ModelPosition from '../../src/model/position'; import ViewElement from '../../src/view/element'; import ViewContainerElement from '../../src/view/containerelement'; -import ViewAttributeElement from '../../src/view/attributeelement'; import ViewUIElement from '../../src/view/uielement'; import ViewText from '../../src/view/text'; @@ -62,7 +61,7 @@ describe( 'downcast-helpers', () => { it( 'can be overwritten using priority', () => { const helperA = downcastElementToElement( { model: 'paragraph', view: 'p' } ); - const helperB = downcastElementToElement( { model: 'paragraph', view: 'foo' }, 'high' ); + const helperB = downcastElementToElement( { model: 'paragraph', view: 'foo', priority: 'high' } ); conversion.for( 'downcast' ).add( helperA ).add( helperB ); @@ -94,7 +93,7 @@ describe( 'downcast-helpers', () => { it( 'config.view is a function', () => { const helper = downcastElementToElement( { model: 'heading', - view: modelElement => new ViewContainerElement( 'h' + modelElement.getAttribute( 'level' ) ) + view: ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'h' + modelElement.getAttribute( 'level' ) ) } ); conversion.for( 'downcast' ).add( helper ); @@ -109,7 +108,7 @@ describe( 'downcast-helpers', () => { describe( 'downcastAttributeToElement', () => { it( 'config.view is a string', () => { - const helper = downcastAttributeToElement( 'bold', { view: 'strong' } ); + const helper = downcastAttributeToElement( { model: 'bold', view: 'strong' } ); conversion.for( 'downcast' ).add( helper ); @@ -121,8 +120,8 @@ describe( 'downcast-helpers', () => { } ); it( 'can be overwritten using priority', () => { - const helperA = downcastAttributeToElement( 'bold', { view: 'strong' } ); - const helperB = downcastAttributeToElement( 'bold', { view: 'b' }, 'high' ); + const helperA = downcastAttributeToElement( { model: 'bold', view: 'strong' } ); + const helperB = downcastAttributeToElement( { model: 'bold', view: 'b', priority: 'high' } ); conversion.for( 'downcast' ).add( helperA ).add( helperB ); @@ -134,67 +133,44 @@ describe( 'downcast-helpers', () => { } ); it( 'config.view is a view element definition', () => { - const helper = downcastAttributeToElement( 'bold', { + const helper = downcastAttributeToElement( { + model: 'invert', view: { name: 'span', - class: 'bold' + class: [ 'font-light', 'bg-dark' ] } } ); conversion.for( 'downcast' ).add( helper ); model.change( writer => { - writer.insertText( 'foo', { bold: true }, modelRoot, 0 ); + writer.insertText( 'foo', { invert: true }, modelRoot, 0 ); } ); - expectResult( 'foo' ); + expectResult( 'foo' ); } ); - it( 'config.view is a view element definition, model attribute value specified', () => { - const helper = downcastAttributeToElement( 'styled', { - model: 'dark', + it( 'model attribute value is enum', () => { + const helper = downcastAttributeToElement( { + model: { + key: 'fontSize', + values: [ 'big', 'small' ] + }, view: { - name: 'span', - class: [ 'styled', 'styled-dark' ] - } - } ); - - conversion.for( 'downcast' ).add( helper ); - - model.change( writer => { - writer.insertText( 'foo', { styled: 'dark' }, modelRoot, 0 ); - } ); - - expectResult( 'foo' ); - - model.change( writer => { - writer.setAttribute( 'styled', 'xyz', modelRoot.getChild( 0 ) ); - } ); - - expectResult( 'foo' ); - } ); - - it( 'multiple config items', () => { - const helper = downcastAttributeToElement( 'fontSize', [ - { - model: 'big', - view: { + big: { name: 'span', style: { 'font-size': '1.2em' } - } - }, - { - model: 'small', - view: { + }, + small: { name: 'span', style: { 'font-size': '0.8em' } } } - ] ); + } ); conversion.for( 'downcast' ).add( helper ); @@ -218,8 +194,11 @@ describe( 'downcast-helpers', () => { } ); it( 'config.view is a function', () => { - const helper = downcastAttributeToElement( 'bold', { - view: attributeValue => new ViewAttributeElement( 'span', { style: 'font-weight:' + attributeValue } ) + const helper = downcastAttributeToElement( { + model: 'bold', + view: ( modelAttributeValue, viewWriter ) => { + return viewWriter.createAttributeElement( 'span', { style: 'font-weight:' + modelAttributeValue } ); + } } ); conversion.for( 'downcast' ).add( helper ); @@ -237,33 +216,27 @@ describe( 'downcast-helpers', () => { conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'image', view: 'img' } ) ); } ); - it( 'config not set', () => { - const helper = downcastAttributeToAttribute( 'src' ); + it( 'config.view is a string', () => { + const helper = downcastAttributeToAttribute( { model: 'source', view: 'src' } ); conversion.for( 'downcast' ).add( helper ); model.change( writer => { - writer.insertElement( 'image', { src: 'foo.jpg' }, modelRoot, 0 ); + writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 ); } ); expectResult( '' ); - } ); - - it( 'config.view is a string', () => { - const helper = downcastAttributeToAttribute( 'source', { view: 'src' } ); - - conversion.for( 'downcast' ).add( helper ); model.change( writer => { - writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 ); + writer.removeAttribute( 'source', modelRoot.getChild( 0 ) ); } ); - expectResult( '' ); + expectResult( '' ); } ); it( 'can be overwritten using priority', () => { - const helperA = downcastAttributeToAttribute( 'source', { view: 'href' } ); - const helperB = downcastAttributeToAttribute( 'source', { view: 'src' }, 'high' ); + const helperA = downcastAttributeToAttribute( { model: 'source', view: 'href' } ); + const helperB = downcastAttributeToAttribute( { model: 'source', view: 'src', priority: 'high' } ); conversion.for( 'downcast' ).add( helperA ).add( helperB ); @@ -274,83 +247,121 @@ describe( 'downcast-helpers', () => { expectResult( '' ); } ); - it( 'config.view is an object', () => { - const helper = downcastAttributeToAttribute( 'stylish', { view: { key: 'class', value: 'styled' } } ); + it( 'model element name specified', () => { + conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) ); + + const helper = downcastAttributeToAttribute( { + model: { + name: 'image', + key: 'source' + }, + view: 'src' + } ); conversion.for( 'downcast' ).add( helper ); model.change( writer => { - writer.insertElement( 'image', { stylish: true }, modelRoot, 0 ); + writer.insertElement( 'image', { source: 'foo.jpg' }, modelRoot, 0 ); } ); - expectResult( '' ); + expectResult( '' ); + + model.change( writer => { + writer.rename( modelRoot.getChild( 0 ), 'paragraph' ); + } ); + + expectResult( '

' ); } ); - it( 'config.view is an object, model attribute value specified', () => { - const helper = downcastAttributeToAttribute( 'styled', { - model: 'dark', + it( 'config.view is an object, model attribute value is enum', () => { + conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) ); + + const helper = downcastAttributeToAttribute( { + model: { + key: 'styled', + values: [ 'dark', 'light' ] + }, view: { - key: 'class', - value: 'styled-dark styled' + dark: { + key: 'class', + value: [ 'styled', 'styled-dark' ] + }, + light: { + key: 'class', + value: [ 'styled', 'styled-light' ] + } } } ); conversion.for( 'downcast' ).add( helper ); model.change( writer => { - writer.insertElement( 'image', { styled: 'dark' }, modelRoot, 0 ); + writer.insertElement( 'paragraph', { styled: 'dark' }, modelRoot, 0 ); } ); - expectResult( '' ); + expectResult( '

' ); model.change( writer => { - writer.setAttribute( 'styled', 'xyz', modelRoot.getChild( 0 ) ); + writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) ); } ); - expectResult( '' ); + expectResult( '

' ); + + model.change( writer => { + writer.removeAttribute( 'styled', modelRoot.getChild( 0 ) ); + } ); + + expectResult( '

' ); } ); - it( 'multiple config items', () => { - const helper = downcastAttributeToAttribute( 'styled', [ - { - model: 'dark', - view: { - key: 'class', - value: 'styled-dark' - } + it( 'config.view is an object, model attribute value is enum, view has style', () => { + conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'paragraph', view: 'p' } ) ); + + const helper = downcastAttributeToAttribute( { + model: { + key: 'align', + values: [ 'right', 'center' ] }, - { - model: 'light', - view: { - key: 'class', - value: 'styled-light' + view: { + right: { + key: 'style', + value: { + 'text-align': 'right' + } + }, + center: { + key: 'style', + value: { + 'text-align': 'center' + } } } - ] ); + } ); conversion.for( 'downcast' ).add( helper ); model.change( writer => { - writer.insertElement( 'image', { styled: 'dark' }, modelRoot, 0 ); + writer.insertElement( 'paragraph', { align: 'right' }, modelRoot, 0 ); } ); - expectResult( '' ); + expectResult( '

' ); model.change( writer => { - writer.setAttribute( 'styled', 'light', modelRoot.getChild( 0 ) ); + writer.setAttribute( 'align', 'center', modelRoot.getChild( 0 ) ); } ); - expectResult( '' ); + expectResult( '

' ); model.change( writer => { - writer.setAttribute( 'styled', 'xyz', modelRoot.getChild( 0 ) ); + writer.removeAttribute( 'align', modelRoot.getChild( 0 ) ); } ); - expectResult( '' ); + expectResult( '

' ); } ); it( 'config.view is a function', () => { - const helper = downcastAttributeToAttribute( 'styled', { + const helper = downcastAttributeToAttribute( { + model: 'styled', view: attributeValue => ( { key: 'class', value: 'styled-' + attributeValue } ) } ); @@ -380,7 +391,7 @@ describe( 'downcast-helpers', () => { it( 'can be overwritten using priority', () => { const helperA = downcastMarkerToElement( { model: 'search', view: 'marker-search' } ); - const helperB = downcastMarkerToElement( { model: 'search', view: 'search' }, 'high' ); + const helperB = downcastMarkerToElement( { model: 'search', view: 'search', priority: 'high' } ); conversion.for( 'downcast' ).add( helperA ).add( helperB ); @@ -416,8 +427,8 @@ describe( 'downcast-helpers', () => { it( 'config.view is a function', () => { const helper = downcastMarkerToElement( { model: 'search', - view: data => { - return new ViewUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } ); + view: ( data, viewWriter ) => { + return viewWriter.createUIElement( 'span', { 'data-marker': 'search', 'data-start': data.isOpening } ); } } ); @@ -448,7 +459,7 @@ describe( 'downcast-helpers', () => { it( 'can be overwritten using priority', () => { const helperA = downcastMarkerToHighlight( { model: 'comment', view: { class: 'comment' } } ); - const helperB = downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' } }, 'high' ); + const helperB = downcastMarkerToHighlight( { model: 'comment', view: { class: 'new-comment' }, priority: 'high' } ); conversion.for( 'downcast' ).add( helperA ).add( helperB ); @@ -508,7 +519,7 @@ describe( 'downcast-converters', () => { dispatcher.on( 'insert:paragraph', insertElement( - ( modelItem, consumable, conversionApi ) => conversionApi.writer.createContainerElement( 'p' ) + ( modelItem, viewWriter ) => viewWriter.createContainerElement( 'p' ) ) ); @@ -581,7 +592,7 @@ describe( 'downcast-converters', () => { } ); describe( 'insertElement', () => { - it( 'should convert element insertion in model to and map positions for future converting', () => { + it( 'should convert element insertion in model', () => { const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar' ) ); model.change( writer => { @@ -591,26 +602,16 @@ describe( 'downcast-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); - it( 'should take view element function generator as a parameter', () => { - const elementGenerator = ( modelItem, consumable ) => { - if ( consumable.consume( modelItem, 'attribute:nice' ) ) { - return new ViewContainerElement( 'div' ); - } - - // Test if default converter will be fired for paragraph, if `null` is returned and consumable was not consumed. - return null; - }; - - dispatcher.on( 'insert:paragraph', insertElement( elementGenerator ), { priority: 'high' } ); + it( 'should not convert if creator returned null', () => { + dispatcher.on( 'insert:div', insertElement( () => null ) ); - const niceP = new ModelElement( 'paragraph', { nice: true }, new ModelText( 'foo' ) ); - const badP = new ModelElement( 'paragraph', null, new ModelText( 'bar' ) ); + const modelElement = new ModelElement( 'div' ); model.change( writer => { - writer.insert( [ niceP, badP ], modelRootStart ); + writer.insert( modelElement, modelRootStart ); } ); - expect( viewToString( viewRoot ) ).to.equal( '
foo

bar

' ); + expect( viewToString( viewRoot ) ).to.equal( '
' ); } ); } ); @@ -646,7 +647,7 @@ describe( 'downcast-converters', () => { return { key: 'class', value }; }; - dispatcher.on( 'insert:div', insertElement( ( model, consumable, api ) => api.writer.createContainerElement( 'div' ) ) ); + dispatcher.on( 'insert:div', insertElement( ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'div' ) ) ); dispatcher.on( 'attribute:theme', changeAttribute( themeConverter ) ); const modelParagraph = new ModelElement( 'paragraph', { theme: 'nice' }, new ModelText( 'foobar' ) ); @@ -690,7 +691,7 @@ describe( 'downcast-converters', () => { describe( 'wrap', () => { it( 'should convert insert/change/remove of attribute in model into wrapping element in a view', () => { const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) ); - const creator = ( value, data, consumable, api ) => api.writer.createAttributeElement( 'b' ); + const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ); dispatcher.on( 'attribute:bold', wrap( creator ) ); @@ -710,9 +711,9 @@ describe( 'downcast-converters', () => { it( 'should convert insert/remove of attribute in model with wrapping element generating function as a parameter', () => { const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { style: 'bold' } ) ); - const elementGenerator = ( value, data, consumable, api ) => { - if ( value == 'bold' ) { - return api.writer.createAttributeElement( 'b' ); + const elementGenerator = ( modelAttributeValue, viewWriter ) => { + if ( modelAttributeValue == 'bold' ) { + return viewWriter.createAttributeElement( 'b' ); } }; @@ -738,7 +739,9 @@ describe( 'downcast-converters', () => { new ModelText( 'x' ) ] ); - const elementGenerator = ( href, data, consumable, api ) => api.writer.createAttributeElement( 'a', { href } ); + const elementGenerator = ( modelAttributeValue, viewWriter ) => { + return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } ); + }; dispatcher.on( 'attribute:link', wrap( elementGenerator ) ); @@ -758,7 +761,7 @@ describe( 'downcast-converters', () => { it( 'should support unicode', () => { const modelElement = new ModelElement( 'paragraph', null, [ 'நி', new ModelText( 'லைக்', { bold: true } ), 'கு' ] ); - const creator = ( value, data, consumable, api ) => api.writer.createAttributeElement( 'b' ); + const creator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ); dispatcher.on( 'attribute:bold', wrap( creator ) ); @@ -777,18 +780,20 @@ describe( 'downcast-converters', () => { it( 'should be possible to override wrap', () => { const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { bold: true } ) ); - const creator = ( value, data, consumable, api ) => api.writer.createAttributeElement( 'b' ); - dispatcher.on( 'attribute:bold', wrap( creator ) ); - dispatcher.on( 'attribute:bold', ( evt, data, consumable ) => { - consumable.consume( data.item, 'attribute:bold' ); - }, { priority: 'high' } ); + dispatcher.on( 'attribute:bold', wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'b' ) ) ); + + dispatcher.on( + 'attribute:bold', + wrap( ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ) ), + { priority: 'high' } + ); model.change( writer => { writer.insert( modelElement, modelRootStart ); } ); - expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); + expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); } ); it( 'should not convert and not consume if creator function returned null', () => { @@ -799,9 +804,9 @@ describe( 'downcast-converters', () => { const modelElement = new ModelElement( 'paragraph', null, new ModelText( 'foobar', { italic: true } ) ); dispatcher.on( 'attribute:italic', wrap( elementGenerator ) ); - dispatcher.on( 'attribute:italic', ( evt, data, consumable ) => { - expect( consumable.test( data.item, 'attribute:italic' ) ).to.be.true; - } ); + + const spy = sinon.spy(); + dispatcher.on( 'attribute:italic', spy ); model.change( writer => { writer.insert( modelElement, modelRootStart ); @@ -809,6 +814,7 @@ describe( 'downcast-converters', () => { expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); expect( dispatcher.fire.calledWith( 'attribute:italic:$text' ) ).to.be.true; + expect( spy.called ).to.be.true; } ); } ); @@ -829,30 +835,11 @@ describe( 'downcast-converters', () => { range = ModelRange.createFromParentsAndOffsets( modelElement, 3, modelElement, 3 ); } ); - it( 'should insert and remove ui element - element as a creator', () => { - const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } ); - - dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) ); - dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) ); + it( 'should insert and remove ui element', () => { + const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ); - model.change( writer => { - writer.setMarker( 'marker', range ); - } ); - - expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - - model.change( writer => { - writer.removeMarker( 'marker' ); - } ); - - expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); - } ); - - it( 'should insert and remove ui element - function as a creator', () => { - const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } ); - - dispatcher.on( 'addMarker:marker', insertUIElement( () => viewUi ) ); - dispatcher.on( 'removeMarker:marker', removeUIElement( () => viewUi ) ); + dispatcher.on( 'addMarker:marker', insertUIElement( creator ) ); + dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) ); model.change( writer => { writer.setMarker( 'marker', range ); @@ -868,16 +855,19 @@ describe( 'downcast-converters', () => { } ); it( 'should not convert if consumable was consumed', () => { - const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } ); - sinon.spy( dispatcher, 'fire' ); - dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) ); + dispatcher.on( 'addMarker:marker', insertUIElement( + ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ) ) + ); + dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => { consumable.consume( data.markerRange, 'addMarker:marker' ); }, { priority: 'high' } ); - dispatcher.convertMarkerAdd( 'marker', range ); + model.change( writer => { + writer.setMarker( 'marker', range ); + } ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); expect( dispatcher.fire.calledWith( 'addMarker:marker' ) ); @@ -907,10 +897,10 @@ describe( 'downcast-converters', () => { } ); it( 'should insert and remove ui element - element as a creator', () => { - const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } ); + const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ); - dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) ); - dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) ); + dispatcher.on( 'addMarker:marker', insertUIElement( creator ) ); + dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) ); model.change( writer => { writer.setMarker( 'marker', range ); @@ -927,10 +917,10 @@ describe( 'downcast-converters', () => { } ); it( 'should insert and remove ui element - function as a creator', () => { - const viewUi = data => new ViewUIElement( 'span', { 'class': data.markerName } ); + const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': data.markerName } ); - dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) ); - dispatcher.on( 'removeMarker:marker', removeUIElement( viewUi ) ); + dispatcher.on( 'addMarker:marker', insertUIElement( creator ) ); + dispatcher.on( 'removeMarker:marker', removeUIElement( creator ) ); model.change( writer => { writer.setMarker( 'marker', range ); @@ -947,12 +937,12 @@ describe( 'downcast-converters', () => { } ); it( 'should insert and remove different opening and ending element', () => { - function creator( data ) { + function creator( data, viewWriter ) { if ( data.isOpening ) { - return new ViewUIElement( 'span', { 'class': data.markerName, 'data-start': true } ); + return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-start': true } ); } - return new ViewUIElement( 'span', { 'class': data.markerName, 'data-end': true } ); + return viewWriter.createUIElement( 'span', { 'class': data.markerName, 'data-end': true } ); } dispatcher.on( 'addMarker:marker', insertUIElement( creator ) ); @@ -974,16 +964,18 @@ describe( 'downcast-converters', () => { } ); it( 'should not convert if consumable was consumed', () => { - const viewUi = new ViewUIElement( 'span', { 'class': 'marker' } ); + const creator = ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ); sinon.spy( dispatcher, 'fire' ); - dispatcher.on( 'addMarker:marker', insertUIElement( viewUi ) ); + dispatcher.on( 'addMarker:marker', insertUIElement( creator ) ); dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => { consumable.consume( data.item, 'addMarker:marker' ); }, { priority: 'high' } ); - dispatcher.convertMarkerAdd( 'marker', range ); + model.change( writer => { + writer.setMarker( 'marker', range ); + } ); expect( viewToString( viewRoot ) ).to.equal( '

foobar

' ); expect( dispatcher.fire.calledWith( 'addMarker:marker' ) ); @@ -1099,7 +1091,9 @@ describe( 'downcast-converters', () => { const modelP = new ModelElement( 'paragraph', null, new ModelText( 'foo' ) ); const modelWidget = new ModelElement( 'widget', null, modelP ); - dispatcher.on( 'insert:widget', insertElement( () => new ViewContainerElement( 'widget' ) ) ); + dispatcher.on( 'insert:widget', insertElement( + ( modelElement, viewWriter ) => viewWriter.createContainerElement( 'widget' ) ) + ); model.change( writer => { writer.insert( modelWidget, modelRootStart ); diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index 20def2bd7..706858bbc 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -58,7 +58,7 @@ describe( 'downcast-selection-converters', () => { dispatcher.on( 'insert:$text', insertText() ); - const strongCreator = ( value, data, consumable, api ) => api.writer.createAttributeElement( 'strong' ); + const strongCreator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' ); dispatcher.on( 'attribute:bold', wrap( strongCreator ) ); dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) ); @@ -502,7 +502,7 @@ describe( 'downcast-selection-converters', () => { model.schema.extend( '$text', { allowIn: 'td' } ); // "Universal" converter to convert table structure. - const containerCreator = ( item, consumable, api ) => api.writer.createContainerElement( item.name ); + const containerCreator = ( modelElement, viewWriter ) => viewWriter.createContainerElement( modelElement.name ); const tableConverter = insertElement( containerCreator ); dispatcher.on( 'insert:table', tableConverter ); dispatcher.on( 'insert:tr', tableConverter ); diff --git a/tests/conversion/upcast-converters.js b/tests/conversion/upcast-converters.js index 92d733274..a6f1379de 100644 --- a/tests/conversion/upcast-converters.js +++ b/tests/conversion/upcast-converters.js @@ -74,7 +74,7 @@ describe( 'upcast-helpers', () => { } ); const helperA = upcastElementToElement( { view: 'p', model: 'p' } ); - const helperB = upcastElementToElement( { view: 'p', model: 'paragraph' }, 'high' ); + const helperB = upcastElementToElement( { view: 'p', model: 'paragraph', priority: 'high' } ); conversion.for( 'upcast' ).add( helperA ).add( helperB ); @@ -86,18 +86,16 @@ describe( 'upcast-helpers', () => { inheritAllFrom: '$block' } ); - const helperParagraph = upcastElementToElement( { view: 'p', model: 'paragraph' } ); const helperFancy = upcastElementToElement( { view: { name: 'p', class: 'fancy' }, - model: 'fancyParagraph' - }, 'high' ); + model: 'fancyParagraph', + } ); - conversion.for( 'upcast' ).add( helperParagraph ).add( helperFancy ); + conversion.for( 'upcast' ).add( helperFancy ); - expectResult( new ViewContainerElement( 'p' ), '' ); expectResult( new ViewContainerElement( 'p', { class: 'fancy' } ), '' ); } ); @@ -160,7 +158,7 @@ describe( 'upcast-helpers', () => { it( 'should not do anything if returned model element is null', () => { const helperA = upcastElementToElement( { view: 'p', model: 'paragraph' } ); - const helperB = upcastElementToElement( { view: 'p', model: () => null }, 'high' ); + const helperB = upcastElementToElement( { view: 'p', model: () => null, priority: 'high' } ); conversion.for( 'upcast' ).add( helperA ).add( helperB ); @@ -182,7 +180,7 @@ describe( 'upcast-helpers', () => { it( 'can be overwritten using priority', () => { const helperA = upcastElementToAttribute( { view: 'strong', model: 'strong' } ); - const helperB = upcastElementToAttribute( { view: 'strong', model: 'bold' }, 'high' ); + const helperB = upcastElementToAttribute( { view: 'strong', model: 'bold', priority: 'high' } ); conversion.for( 'upcast' ).add( helperA ).add( helperB ); @@ -298,8 +296,9 @@ describe( 'upcast-helpers', () => { model: { key: 'bold', value: () => null - } - }, 'high' ); + }, + priority: 'high' + } ); conversion.for( 'upcast' ).add( helperA ).add( helperB ); @@ -355,7 +354,7 @@ describe( 'upcast-helpers', () => { } ); const helperA = upcastAttributeToAttribute( { view: { key: 'src' }, model: 'src' } ); - const helperB = upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source' }, 'normal' ); + const helperB = upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source', priority: 'normal' } ); conversion.for( 'upcast' ).add( helperA ).add( helperB ); @@ -520,7 +519,7 @@ describe( 'upcast-helpers', () => { it( 'can be overwritten using priority', () => { const helperA = upcastElementToMarker( { view: 'marker-search', model: 'search-result' } ); - const helperB = upcastElementToMarker( { view: 'marker-search', model: 'search' }, 'high' ); + const helperB = upcastElementToMarker( { view: 'marker-search', model: 'search', priority: 'high' } ); conversion.for( 'upcast' ).add( helperA ).add( helperB ); From cdd9be11d5eaaa1d36b5547b6a2757847e3fcb29 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 19 Feb 2018 14:26:20 +0100 Subject: [PATCH 601/724] Docs: Fixes in docs. --- src/conversion/conversion.js | 72 ++++++++++++++++++----------------- src/model/markercollection.js | 9 +++-- 2 files changed, 42 insertions(+), 39 deletions(-) diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js index d717ae608..d4687f0fc 100644 --- a/src/conversion/conversion.js +++ b/src/conversion/conversion.js @@ -118,8 +118,6 @@ export default class Conversion { * Sets up converters between the model and the view which convert a model element to a view element (and vice versa). * For example, model `Foo` is `

Foo

` in the view. * - * `definition.model` is a `String` with a model element name to converter from/to. - * * // Simple conversion from `paragraph` model element to `

` view element (and vice versa). * conversion.elementToElement( { model: 'paragraph', view: 'p' } ); * @@ -179,7 +177,10 @@ export default class Conversion { * } * } ); * - * @param {~ConverterDefinition} definition Converter definition. + * `definition.model` is a `String` with a model element name to converter from/to. + * See {@link module:engine/conversion/conversion~ConverterDefinition} to learn about other parameters. + * + * @param {module:engine/conversion/conversion~ConverterDefinition} definition Converter definition. */ elementToElement( definition ) { // Set up downcast converter. @@ -201,9 +202,6 @@ export default class Conversion { * Sets up converters between the model and the view which convert a model attribute to a view element (and vice versa). * For example, model text node with data `"Foo"` and `bold` attribute is `Foo` in the view. * - * `definition.model` parameter specifies what model attribute should be converted from/to. It can be a `{ key, value }` object - * describing attribute key and value to convert or a `String` specifying just attribute key (then `value` is set to `true`). - * * // Simple conversion from `bold=true` attribute to `` view element (and vice versa). * conversion.attributeToElement( { model: 'bold', view: 'strong' } ); * @@ -315,7 +313,11 @@ export default class Conversion { * } * } ); * - * @param {~ConverterDefinition} definition Converter definition. + * `definition.model` parameter specifies what model attribute should be converted from/to. It can be a `{ key, value }` object + * describing attribute key and value to convert or a `String` specifying just attribute key (then `value` is set to `true`). + * See {@link module:engine/conversion/conversion~ConverterDefinition} to learn about other parameters. + * + * @param {module:engine/conversion/conversion~ConverterDefinition} definition Converter definition. */ attributeToElement( definition ) { // Set up downcast converter. @@ -337,32 +339,6 @@ export default class Conversion { * Sets up converters between the model and the view which convert a model attribute to a view attribute (and vice versa). * For example, `` is converted to `` (same attribute key and value). * - * `definition.model` parameter specifies what model attribute should be converted from/to. - * It can be a `{ key, values, [ name ] }` object or a `String`, which will be treated like `{ key: definition.model }`. - * `key` property is the model attribute key to convert from/to. - * `values` are the possible model attribute values. If `values` is not set, model attribute value will be the same as the - * view attribute value. - * If `name` is set, conversion will be set up only for model elements with the given name. - * - * `definition.view` parameter specifies what view attribute should be converted from/to. - * It can be a `{ key, value, [ name ] }` object or a `String`, which will be treated like `{ key: definition.view }`. - * `key` property is the view attribute key to convert from/to. - * `value` is the view attribute value to convert from/to. If `definition.value` is not set, view attribute value will be - * the same as the model attribute value. - * If `key` is `'class'`, `value` can be a `String` or an array of `String`s. - * If `key` is `'style'`, `value` is an object with key-value pairs. - * In other cases, `value` is a `String`. - * If `name` is set, conversion will be set up only for model elements with the given name. - * If `definition.model.values` is set, `definition.view` is an object which assigns values from `definition.model.values` - * to `{ key, value, [ name ] }` objects. - * - * `definition.upcastAlso` specifies which other matching view elements should be also upcast to given model configuration. - * If `definition.model.values` is set, `definition.upcastAlso` should be an object assigning values from `definition.model.values` - * to {@link module:engine/view/matcher~MatcherPattern}s or arrays of {@link module:engine/view/matcher~MatcherPattern}s. - * - * **Note:** `definition.model` and `definition.view` form should be mirrored, that is the same type of parameters should - * be given in both parameters. - * * // Simple conversion from `source` model attribute to `src` view attribute (and vice versa). * conversion.attributeToAttribute( { model: 'source', view: 'src' } ); * @@ -433,7 +409,33 @@ export default class Conversion { * } * } ); * - * @param {Object} [definition] Converter definition. + * `definition.model` parameter specifies what model attribute should be converted from/to. + * It can be a `{ key, [ values ], [ name ] }` object or a `String`, which will be treated like `{ key: definition.model }`. + * `key` property is the model attribute key to convert from/to. + * `values` are the possible model attribute values. If `values` is not set, model attribute value will be the same as the + * view attribute value. + * If `name` is set, conversion will be set up only for model elements with the given name. + * + * `definition.view` parameter specifies what view attribute should be converted from/to. + * It can be a `{ key, value, [ name ] }` object or a `String`, which will be treated like `{ key: definition.view }`. + * `key` property is the view attribute key to convert from/to. + * `value` is the view attribute value to convert from/to. If `definition.value` is not set, view attribute value will be + * the same as the model attribute value. + * If `key` is `'class'`, `value` can be a `String` or an array of `String`s. + * If `key` is `'style'`, `value` is an object with key-value pairs. + * In other cases, `value` is a `String`. + * If `name` is set, conversion will be set up only for model elements with the given name. + * If `definition.model.values` is set, `definition.view` is an object which assigns values from `definition.model.values` + * to `{ key, value, [ name ] }` objects. + * + * `definition.upcastAlso` specifies which other matching view elements should be also upcast to given model configuration. + * If `definition.model.values` is set, `definition.upcastAlso` should be an object assigning values from `definition.model.values` + * to {@link module:engine/view/matcher~MatcherPattern}s or arrays of {@link module:engine/view/matcher~MatcherPattern}s. + * + * **Note:** `definition.model` and `definition.view` form should be mirrored, that is the same type of parameters should + * be given in both parameters. + * + * @param {Object} definition Converter definition. * @param {String|Object} definition.model Model attribute to convert from/to. * @param {String|Object} definition.view View attribute to convert from/to. * @param {module:engine/view/matcher~MatcherPattern|Array.} [definition.upcastAlso] @@ -517,7 +519,7 @@ function _addToDispatchers( dispatchers, conversionHelper ) { // Helper function that creates a joint array out of an item passed in `definition.view` and items passed in // `definition.upcastAlso`. // -// @param {~ConverterDefinition} definition +// @param {module:engine/conversion/conversion~ConverterDefinition} definition // @returns {Array} Array containing view definitions. function* _getAllUpcastDefinitions( definition ) { if ( definition.model.values ) { diff --git a/src/model/markercollection.js b/src/model/markercollection.js index 1bc3de416..8046a58ab 100644 --- a/src/model/markercollection.js +++ b/src/model/markercollection.js @@ -80,7 +80,8 @@ export default class MarkerCollection { * * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed), the marker in * collection is updated and {@link module:engine/model/markercollection~MarkerCollection#event:update} event is fired - * but only if there was a change (marker range or {@link ~Marker#managedUsingOperations} flag has changed. + * but only if there was a change (marker range or {@link module:engine/model/markercollection~Marker#managedUsingOperations} + * flag has changed. * * @protected * @fires module:engine/model/markercollection~MarkerCollection#event:update @@ -246,7 +247,7 @@ mix( MarkerCollection, EmitterMixin ); * Name is used to group and identify markers. Names have to be unique, but markers can be grouped by * using common prefixes, separated with `:`, for example: `user:john` or `search:3`. That's useful in term of creating * namespaces for custom elements (e.g. comments, highlights). You can use this prefixes in - * {@link module:engine/model/markercollection~MarkerCollection#event:set} listeners to listen on changes in a group of markers. + * {@link module:engine/model/markercollection~MarkerCollection#event:update} listeners to listen on changes in a group of markers. * For instance: `model.markers.on( 'set:user', callback );` will be called whenever any `user:*` markers changes. * * There are two types of markers. @@ -425,7 +426,7 @@ class Marker { * * When marker is removed from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection}, * all event listeners listening to it should be removed. It is best to do it on - * {@link module:engine/model/markercollection~MarkerCollection#event:remove MarkerCollection remove event}. + * {@link module:engine/model/markercollection~MarkerCollection#event:update MarkerCollection update event}. * * @see module:engine/model/liverange~LiveRange#event:change:range * @event change:range @@ -439,7 +440,7 @@ class Marker { * * When marker is removed from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection}, * all event listeners listening to it should be removed. It is best to do it on - * {@link module:engine/model/markercollection~MarkerCollection#event:remove MarkerCollection remove event}. + * {@link module:engine/model/markercollection~MarkerCollection#event:update MarkerCollection update event}. * * @see module:engine/model/liverange~LiveRange#event:change:content * @event change:content From 3efce10d22ff92ae8efbfcb20f0165985351161b Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 19 Feb 2018 15:10:06 +0100 Subject: [PATCH 602/724] Docs: Added more explanation in docs. --- src/conversion/conversion.js | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js index d4687f0fc..b52980674 100644 --- a/src/conversion/conversion.js +++ b/src/conversion/conversion.js @@ -170,6 +170,10 @@ export default class Conversion { * const size = Number( match[ 1 ] ); * * if ( size > 26 ) { + * // Returned value be an object with the matched properties. + * // Those properties will be "consumed" during conversion. + * // See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more. + * * return { name: true, style: [ 'font-size' ] }; * } * @@ -237,6 +241,10 @@ export default class Conversion { * const fontWeight = viewElement.getStyle( 'font-weight' ); * * if ( viewElement.is( 'span' ) && fontWeight && /\d+/.test() && Number( fontWeight ) > 500 ) { + * // Returned value be an object with the matched properties. + * // Those properties will be "consumed" during conversion. + * // See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more. + * * return { * name: true, * style: [ 'font-weight' ] @@ -284,6 +292,10 @@ export default class Conversion { * const size = Number( match[ 1 ] ); * * if ( viewElement.is( 'span' ) && size > 10 ) { + * // Returned value be an object with the matched properties. + * // Those properties will be "consumed" during conversion. + * // See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more. + * * return { name: true, style: [ 'font-size' ] }; * } * @@ -305,6 +317,10 @@ export default class Conversion { * const size = Number( match[ 1 ] ); * * if ( viewElement.is( 'span' ) && size < 10 ) { + * // Returned value be an object with the matched properties. + * // Those properties will be "consumed" during conversion. + * // See `engine.view.Matcher~MatcherPattern` and `engine.view.Matcher#match` for more. + * * return { name: true, style: [ 'font-size' ] }; * } * From 28bde7404f8066e09eb2a0d30bca41420197093f Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 19 Feb 2018 15:35:14 +0100 Subject: [PATCH 603/724] Changed: Always try to consume view element's name if a view element is upcast using conversion helpers. --- src/conversion/conversion.js | 1 - src/conversion/upcast-converters.js | 8 +++++++- tests/conversion/conversion.js | 1 - 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js index b52980674..cb6a942d8 100644 --- a/src/conversion/conversion.js +++ b/src/conversion/conversion.js @@ -141,7 +141,6 @@ export default class Conversion { * 'div', * { * // Any element with `display: block` style. - * name: /./, * style: { * display: 'block' * } diff --git a/src/conversion/upcast-converters.js b/src/conversion/upcast-converters.js index 1e51104df..06ed6a83d 100644 --- a/src/conversion/upcast-converters.js +++ b/src/conversion/upcast-converters.js @@ -307,6 +307,9 @@ function _prepareToElementConverter( config ) { return; } + // Force consuming element's name. + match.match.name = true; + // Create model element basing on config. const modelElement = _getModelElement( config.model, data.viewItem, conversionApi.writer ); @@ -437,7 +440,8 @@ function _normalizeModelAttributeConfig( config, viewAttributeKeyToCopy = null ) // // @param {String} modelAttributeKey The key of the model attribute to set on a model node. // @param {Object|Array.} config Conversion configuration. It is possible to provide multiple configurations in an array. -// @param {Boolean} consumeName If set to `true` converter will not consume element's name. +// @param {Boolean} consumeName If set to `true` converter will try to consume name. If set to `false` converter will not try to +// consume name. This flag overwrites parameter returned by `Matcher#match`. function _prepareToAttributeConverter( config, consumeName ) { const matcher = new Matcher( config.view ); @@ -460,6 +464,8 @@ function _prepareToAttributeConverter( config, consumeName ) { if ( !consumeName ) { // Do not test or consume `name` consumable. delete match.match.name; + } else { + match.match.name = true; } // Try to consume appropriate values from consumable values list. diff --git a/tests/conversion/conversion.js b/tests/conversion/conversion.js index 10ce09fa5..14988fe49 100644 --- a/tests/conversion/conversion.js +++ b/tests/conversion/conversion.js @@ -157,7 +157,6 @@ describe( 'Conversion', () => { 'div', { // Any element with `display: block` style. - name: /./, style: { display: 'block' } From f9f2cc4e9bfb45e967a1eef13c1e992a804fe1c2 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 20 Feb 2018 10:59:21 +0100 Subject: [PATCH 604/724] Changed: Moved `consumable` parameter to `conversionApi` parameter in downcast. --- src/conversion/downcast-converters.js | 47 +++++++------- .../downcast-selection-converters.js | 12 ++-- src/conversion/downcastdispatcher.js | 61 +++++++++++++------ src/conversion/modelconsumable.js | 6 +- src/dev-utils/model.js | 4 +- tests/conversion/downcast-converters.js | 16 ++--- .../downcast-selection-converters.js | 18 +++--- tests/conversion/downcastdispatcher.js | 34 +++++------ tests/manual/highlight.js | 2 +- tests/manual/nestededitable.js | 2 +- tests/manual/tickets/ckeditor5-721/1.js | 4 +- tests/view/manual/uielement.js | 2 +- 12 files changed, 115 insertions(+), 93 deletions(-) diff --git a/src/conversion/downcast-converters.js b/src/conversion/downcast-converters.js index 17c291d4f..d5d984254 100644 --- a/src/conversion/downcast-converters.js +++ b/src/conversion/downcast-converters.js @@ -431,10 +431,9 @@ function _normalizeToAttributeConfig( view ) { * * downcastDispatcher.on( * 'insert:myElem', - * insertElement( ( modelItem, consumable, conversionApi ) => { - * const writer = conversionApi.writer; - * const text = writer.createText( 'myText' ); - * const myElem = writer.createElement( 'myElem', { myAttr: 'my-' + modelItem.getAttribute( 'myAttr' ) }, text ); + * insertElement( ( modelItem, viewWriter ) => { + * const text = viewWriter.createText( 'myText' ); + * const myElem = viewWriter.createElement( 'myElem', { myAttr: 'my-' + modelItem.getAttribute( 'myAttr' ) }, text ); * * // Do something fancy with myElem using `modelItem` or other parameters. * @@ -446,14 +445,14 @@ function _normalizeToAttributeConfig( view ) { * @returns {Function} Insert element event converter. */ export function insertElement( elementCreator ) { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { const viewElement = elementCreator( data.item, conversionApi.writer ); if ( !viewElement ) { return; } - if ( !consumable.consume( data.item, 'insert' ) ) { + if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) { return; } @@ -475,8 +474,8 @@ export function insertElement( elementCreator ) { * @returns {Function} Insert text event converter. */ export function insertText() { - return ( evt, data, consumable, conversionApi ) => { - if ( !consumable.consume( data.item, 'insert' ) ) { + return ( evt, data, conversionApi ) => { + if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) { return; } @@ -530,7 +529,7 @@ export function remove() { * @returns {Function} Insert element event converter. */ export function insertUIElement( elementCreator ) { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { // Create two view elements. One will be inserted at the beginning of marker, one at the end. // If marker is collapsed, only "opening" element will be inserted. data.isOpening = true; @@ -548,13 +547,13 @@ export function insertUIElement( elementCreator ) { // Marker that is collapsed has consumable build differently that non-collapsed one. // For more information see `addMarker` event description. // If marker's range is collapsed - check if it can be consumed. - if ( markerRange.isCollapsed && !consumable.consume( markerRange, evt.name ) ) { + if ( markerRange.isCollapsed && !conversionApi.consumable.consume( markerRange, evt.name ) ) { return; } // If marker's range is not collapsed - consume all items inside. for ( const value of markerRange ) { - if ( !consumable.consume( value.item, evt.name ) ) { + if ( !conversionApi.consumable.consume( value.item, evt.name ) ) { return; } } @@ -646,8 +645,8 @@ export function removeUIElement( elementCreator ) { export function changeAttribute( attributeCreator ) { attributeCreator = attributeCreator || ( ( value, data ) => ( { value, key: data.attributeKey } ) ); - return ( evt, data, consumable, conversionApi ) => { - if ( !consumable.consume( data.item, evt.name ) ) { + return ( evt, data, conversionApi ) => { + if ( !conversionApi.consumable.consume( data.item, evt.name ) ) { return; } @@ -676,7 +675,7 @@ export function changeAttribute( attributeCreator ) { } // Then, if conversion was successful, set the new attribute. - const newAttribute = attributeCreator( data.attributeNewValue, data, consumable, conversionApi ); + const newAttribute = attributeCreator( data.attributeNewValue, data ); if ( data.attributeNewValue !== null && newAttribute ) { if ( newAttribute.key == 'class' ) { @@ -721,15 +720,15 @@ export function changeAttribute( attributeCreator ) { * The converter automatically consumes corresponding value from consumables list, stops the event (see * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}). * - * modelDispatcher.on( 'attribute:bold', wrapItem( ( attributeValue, data, consumable, conversionApi ) => { - * return conversionApi.writer.createAttributeElement( 'strong' ); + * modelDispatcher.on( 'attribute:bold', wrapItem( ( modelAttributeValue, viewWriter ) => { + * return viewWriter.createAttributeElement( 'strong' ); * } ); * * @param {Function} elementCreator Function returning a view element, which will be used for wrapping. * @returns {Function} Set/change attribute converter. */ export function wrap( elementCreator ) { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { // Recreate current wrapping node. It will be used to unwrap view range if the attribute value has changed // or the attribute was removed. const oldViewElement = elementCreator( data.attributeOldValue, conversionApi.writer ); @@ -741,7 +740,7 @@ export function wrap( elementCreator ) { return; } - if ( !consumable.consume( data.item, evt.name ) ) { + if ( !conversionApi.consumable.consume( data.item, evt.name ) ) { return; } @@ -783,7 +782,7 @@ export function wrap( elementCreator ) { * @return {Function} */ export function highlightText( highlightDescriptor ) { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { if ( data.markerRange.isCollapsed ) { return; } @@ -798,7 +797,7 @@ export function highlightText( highlightDescriptor ) { return; } - if ( !consumable.consume( data.item, evt.name ) ) { + if ( !conversionApi.consumable.consume( data.item, evt.name ) ) { return; } @@ -833,7 +832,7 @@ export function highlightText( highlightDescriptor ) { * @return {Function} */ export function highlightElement( highlightDescriptor ) { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { if ( data.markerRange.isCollapsed ) { return; } @@ -848,7 +847,7 @@ export function highlightElement( highlightDescriptor ) { return; } - if ( !consumable.test( data.item, evt.name ) ) { + if ( !conversionApi.consumable.test( data.item, evt.name ) ) { return; } @@ -856,11 +855,11 @@ export function highlightElement( highlightDescriptor ) { if ( viewElement && viewElement.getCustomProperty( 'addHighlight' ) ) { // Consume element itself. - consumable.consume( data.item, evt.name ); + conversionApi.consumable.consume( data.item, evt.name ); // Consume all children nodes. for ( const value of ModelRange.createIn( data.item ) ) { - consumable.consume( value.item, evt.name ); + conversionApi.consumable.consume( value.item, evt.name ); } viewElement.getCustomProperty( 'addHighlight' )( viewElement, descriptor, conversionApi.writer ); diff --git a/src/conversion/downcast-selection-converters.js b/src/conversion/downcast-selection-converters.js index cfbb0be1e..3559a4a7d 100644 --- a/src/conversion/downcast-selection-converters.js +++ b/src/conversion/downcast-selection-converters.js @@ -21,14 +21,14 @@ * @returns {Function} Selection converter. */ export function convertRangeSelection() { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { const selection = data.selection; if ( selection.isCollapsed ) { return; } - if ( !consumable.consume( selection, 'selection' ) ) { + if ( !conversionApi.consumable.consume( selection, 'selection' ) ) { return; } @@ -66,14 +66,14 @@ export function convertRangeSelection() { * @returns {Function} Selection converter. */ export function convertCollapsedSelection() { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { const selection = data.selection; if ( !selection.isCollapsed ) { return; } - if ( !consumable.consume( selection, 'selection' ) ) { + if ( !conversionApi.consumable.consume( selection, 'selection' ) ) { return; } @@ -111,7 +111,7 @@ export function convertCollapsedSelection() { * @returns {Function} Selection converter. */ export function clearAttributes() { - return ( evt, data, consumable, conversionApi ) => { + return ( evt, data, conversionApi ) => { const viewWriter = conversionApi.writer; const viewSelection = viewWriter.document.selection; @@ -133,5 +133,5 @@ export function clearAttributes() { * {@link module:engine/model/selection~Selection model selection} conversion. */ export function clearFakeSelection() { - return ( evt, data, consumable, conversionApi ) => conversionApi.writer.setFakeSelection( false ); + return ( evt, data, conversionApi ) => conversionApi.writer.setFakeSelection( false ); } diff --git a/src/conversion/downcastdispatcher.js b/src/conversion/downcastdispatcher.js index 00c4068a7..254b70d3f 100644 --- a/src/conversion/downcastdispatcher.js +++ b/src/conversion/downcastdispatcher.js @@ -79,9 +79,9 @@ import extend from '@ckeditor/ckeditor5-utils/src/lib/lodash/extend'; * Example of a custom converter for `DowncastDispatcher`: * * // We will convert inserting "paragraph" model element into the model. - * downcastDispatcher.on( 'insert:paragraph', ( evt, data, consumable, conversionApi ) => { + * downcastDispatcher.on( 'insert:paragraph', ( evt, data, conversionApi ) => { * // Remember to check whether the change has not been consumed yet and consume it. - * if ( consumable.consume( data.item, 'insert' ) ) { + * if ( conversionApi.consumable.consume( data.item, 'insert' ) ) { * return; * } * @@ -180,6 +180,8 @@ export default class DowncastDispatcher { this._testAndFire( `attribute:${ key }`, data, consumable ); } } + + this._clearConversionApi(); } /** @@ -194,6 +196,8 @@ export default class DowncastDispatcher { this.conversionApi.writer = writer; this.fire( 'remove:' + name, { position, length }, this.conversionApi ); + + this._clearConversionApi(); } /** @@ -228,6 +232,8 @@ export default class DowncastDispatcher { this._testAndFire( `attribute:${ key }`, data, consumable ); } + + this._clearConversionApi(); } /** @@ -239,16 +245,16 @@ export default class DowncastDispatcher { * @fires addMarker * @fires attribute * @param {module:engine/model/selection~Selection} selection Selection to convert. - * @param {module:engine/model/selection~Selection} Array markers - * Array of markers containing model markers. + * @param {Array.} markers Array of markers containing model markers. * @param {module:engine/view/writer~Writer} writer View writer that should be used to modify view document. */ convertSelection( selection, markers, writer ) { - this.conversionApi.writer = writer; const markersAtSelection = Array.from( markers.getMarkersAtPosition( selection.getFirstPosition() ) ); - const consumable = this._createSelectionConsumable( selection, markersAtSelection ); - this.fire( 'selection', { selection }, consumable, this.conversionApi ); + this.conversionApi.writer = writer; + this.conversionApi.consumable = this._createSelectionConsumable( selection, markersAtSelection ); + + this.fire( 'selection', { selection }, this.conversionApi ); if ( !selection.isCollapsed ) { return; @@ -267,8 +273,8 @@ export default class DowncastDispatcher { markerRange }; - if ( consumable.test( selection, 'addMarker:' + marker.name ) ) { - this.fire( 'addMarker:' + marker.name, data, consumable, this.conversionApi ); + if ( this.conversionApi.consumable.test( selection, 'addMarker:' + marker.name ) ) { + this.fire( 'addMarker:' + marker.name, data, this.conversionApi ); } } @@ -282,10 +288,12 @@ export default class DowncastDispatcher { }; // Do not fire event if the attribute has been consumed. - if ( consumable.test( selection, 'attribute:' + data.attributeKey ) ) { - this.fire( 'attribute:' + data.attributeKey, data, consumable, this.conversionApi ); + if ( this.conversionApi.consumable.test( selection, 'attribute:' + data.attributeKey ) ) { + this.fire( 'attribute:' + data.attributeKey, data, this.conversionApi ); } } + + this._clearConversionApi(); } /** @@ -313,28 +321,29 @@ export default class DowncastDispatcher { const consumable = new Consumable(); consumable.add( markerRange, eventName ); - this.fire( eventName, { - markerName, - markerRange - }, consumable, this.conversionApi ); + this.conversionApi.consumable = consumable; + + this.fire( eventName, { markerName, markerRange }, this.conversionApi ); return; } // Create consumable for each item in range. - const consumable = this._createConsumableForRange( markerRange, eventName ); + this.conversionApi.consumable = this._createConsumableForRange( markerRange, eventName ); // Create separate event for each node in the range. for ( const item of markerRange.getItems() ) { // Do not fire event for already consumed items. - if ( !consumable.test( item, eventName ) ) { + if ( !this.conversionApi.consumable.test( item, eventName ) ) { continue; } const data = { item, range: Range.createOn( item ), markerName, markerRange }; - this.fire( eventName, data, consumable, this.conversionApi ); + this.fire( eventName, data, this.conversionApi ); } + + this._clearConversionApi(); } /** @@ -354,6 +363,8 @@ export default class DowncastDispatcher { this.conversionApi.writer = writer; this.fire( 'removeMarker:' + markerName, { markerName, markerRange }, this.conversionApi ); + + this._clearConversionApi(); } /** @@ -440,7 +451,19 @@ export default class DowncastDispatcher { const name = data.item.name || '$text'; - this.fire( type + ':' + name, data, consumable, this.conversionApi ); + this.conversionApi.consumable = consumable; + + this.fire( type + ':' + name, data, this.conversionApi ); + } + + /** + * Clears conversion API object. + * + * @private + */ + _clearConversionApi() { + delete this.conversionApi.writer; + delete this.conversionApi.consumable; } /** diff --git a/src/conversion/modelconsumable.js b/src/conversion/modelconsumable.js index 0423705dd..3156f9b67 100644 --- a/src/conversion/modelconsumable.js +++ b/src/conversion/modelconsumable.js @@ -53,9 +53,9 @@ import TextProxy from '../model/textproxy'; * // ├─ * // └─ * // └─ foo - * modelConversionDispatcher.on( 'insert:image', ( evt, data, consumable, conversionApi ) => { + * modelConversionDispatcher.on( 'insert:image', ( evt, data, conversionApi ) => { * // First, consume the `image` element. - * consumable.consume( data.item, 'insert' ); + * conversionApi.consumable.consume( data.item, 'insert' ); * * // Just create normal image element for the view. * // Maybe it will be "decorated" later. @@ -69,7 +69,7 @@ import TextProxy from '../model/textproxy'; * // `modelCaption` insertion change is consumed from consumable values. * // It will not be converted by other converters, but it's children (probably some text) will be. * // Through mapping, converters for text will know where to insert contents of `modelCaption`. - * if ( consumable.consume( modelCaption, 'insert' ) ) { + * if ( conversionApi.consumable.consume( modelCaption, 'insert' ) ) { * const viewCaption = new ViewElement( 'figcaption' ); * * const viewImageHolder = new ViewElement( 'figure', null, [ viewImage, viewCaption ] ); diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index 63eae3105..fdaa68c2a 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -209,7 +209,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { mapper.bindElements( node.root, viewRoot ); downcastDispatcher.on( 'insert:$text', insertText() ); - downcastDispatcher.on( 'attribute', ( evt, data, consumable, conversionApi ) => { + downcastDispatcher.on( 'attribute', ( evt, data, conversionApi ) => { if ( data.item instanceof ModelSelection || data.item instanceof DocumentSelection || data.item.is( 'textProxy' ) ) { const converter = wrap( ( modelAttributeValue, viewWriter ) => { return viewWriter.createAttributeElement( @@ -218,7 +218,7 @@ export function stringify( node, selectionOrPositionOrRange = null ) { ); } ); - converter( evt, data, consumable, conversionApi ); + converter( evt, data, conversionApi ); } } ); downcastDispatcher.on( 'insert', insertElement( modelItem => { diff --git a/tests/conversion/downcast-converters.js b/tests/conversion/downcast-converters.js index 446e920a6..eb84ee126 100644 --- a/tests/conversion/downcast-converters.js +++ b/tests/conversion/downcast-converters.js @@ -579,8 +579,8 @@ describe( 'downcast-converters', () => { } ); it( 'should be possible to override it', () => { - dispatcher.on( 'insert:$text', ( evt, data, consumable ) => { - consumable.consume( data.item, 'insert' ); + dispatcher.on( 'insert:$text', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.item, 'insert' ); }, { priority: 'high' } ); model.change( writer => { @@ -675,8 +675,8 @@ describe( 'downcast-converters', () => { it( 'should be possible to override setAttribute', () => { const modelElement = new ModelElement( 'paragraph', { class: 'foo' }, new ModelText( 'foobar' ) ); - dispatcher.on( 'attribute:class', ( evt, data, consumable ) => { - consumable.consume( data.item, 'attribute:class' ); + dispatcher.on( 'attribute:class', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.item, 'attribute:class' ); }, { priority: 'high' } ); model.change( writer => { @@ -861,8 +861,8 @@ describe( 'downcast-converters', () => { ( data, viewWriter ) => viewWriter.createUIElement( 'span', { 'class': 'marker' } ) ) ); - dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => { - consumable.consume( data.markerRange, 'addMarker:marker' ); + dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.markerRange, 'addMarker:marker' ); }, { priority: 'high' } ); model.change( writer => { @@ -969,8 +969,8 @@ describe( 'downcast-converters', () => { sinon.spy( dispatcher, 'fire' ); dispatcher.on( 'addMarker:marker', insertUIElement( creator ) ); - dispatcher.on( 'addMarker:marker', ( evt, data, consumable ) => { - consumable.consume( data.item, 'addMarker:marker' ); + dispatcher.on( 'addMarker:marker', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.item, 'addMarker:marker' ); }, { priority: 'high' } ); model.change( writer => { diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index 706858bbc..b2851d336 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -152,8 +152,8 @@ describe( 'downcast-selection-converters', () => { it( 'consumes consumable values properly', () => { // Add callback that will fire before default ones. // This should prevent default callback doing anything. - dispatcher.on( 'selection', ( evt, data, consumable ) => { - expect( consumable.consume( data.selection, 'selection' ) ).to.be.true; + dispatcher.on( 'selection', ( evt, data, conversionApi ) => { + expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true; }, { priority: 'high' } ); // Similar test case as the first in this suite. @@ -371,12 +371,12 @@ describe( 'downcast-selection-converters', () => { it( 'consumes consumable values properly', () => { // Add callbacks that will fire before default ones. // This should prevent default callbacks doing anything. - dispatcher.on( 'selection', ( evt, data, consumable ) => { - expect( consumable.consume( data.selection, 'selection' ) ).to.be.true; + dispatcher.on( 'selection', ( evt, data, conversionApi ) => { + expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true; }, { priority: 'high' } ); - dispatcher.on( 'attribute:bold', ( evt, data, consumable ) => { - expect( consumable.consume( data.item, 'attribute:bold' ) ).to.be.true; + dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => { + expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true; }, { priority: 'high' } ); // Similar test case as above. @@ -509,10 +509,10 @@ describe( 'downcast-selection-converters', () => { dispatcher.on( 'insert:td', tableConverter ); // Special converter for table cells. - dispatcher.on( 'selection', ( evt, data, consumable, conversionApi ) => { + dispatcher.on( 'selection', ( evt, data, conversionApi ) => { const selection = data.selection; - if ( !consumable.test( selection, 'selection' ) || selection.isCollapsed ) { + if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) { return; } @@ -520,7 +520,7 @@ describe( 'downcast-selection-converters', () => { const node = range.start.nodeAfter; if ( node == range.end.nodeBefore && node instanceof ModelElement && node.name == 'td' ) { - consumable.consume( selection, 'selection' ); + conversionApi.consumable.consume( selection, 'selection' ); const viewNode = conversionApi.mapper.toViewElement( node ); conversionApi.writer.addClass( 'selected', viewNode ); diff --git a/tests/conversion/downcastdispatcher.js b/tests/conversion/downcastdispatcher.js index 7e4866054..9d5b31859 100644 --- a/tests/conversion/downcastdispatcher.js +++ b/tests/conversion/downcastdispatcher.js @@ -163,7 +163,7 @@ describe( 'DowncastDispatcher', () => { const loggedEvents = []; // We will check everything connected with insert event: - dispatcher.on( 'insert', ( evt, data, consumable ) => { + dispatcher.on( 'insert', ( evt, data, conversionApi ) => { // Check if the item is correct. const itemId = data.item.name ? data.item.name : '$text:' + data.item.data; // Check if the range is correct. @@ -174,11 +174,11 @@ describe( 'DowncastDispatcher', () => { // Check if the event name is correct. expect( evt.name ).to.equal( 'insert:' + ( data.item.name || '$text' ) ); // Check if model consumable is correct. - expect( consumable.consume( data.item, 'insert' ) ).to.be.true; + expect( conversionApi.consumable.consume( data.item, 'insert' ) ).to.be.true; } ); // Same here. - dispatcher.on( 'attribute', ( evt, data, consumable ) => { + dispatcher.on( 'attribute', ( evt, data, conversionApi ) => { const itemId = data.item.name ? data.item.name : '$text:' + data.item.data; const key = data.attributeKey; const value = data.attributeNewValue; @@ -187,7 +187,7 @@ describe( 'DowncastDispatcher', () => { loggedEvents.push( log ); expect( evt.name ).to.equal( 'attribute:' + key + ':' + ( data.item.name || '$text' ) ); - expect( consumable.consume( data.item, 'attribute:' + key ) ).to.be.true; + expect( conversionApi.consumable.consume( data.item, 'attribute:' + key ) ).to.be.true; } ); dispatcher.convertInsert( range ); @@ -214,9 +214,9 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.on( 'insert:image', ( evt, data, consumable ) => { - consumable.consume( data.item.getChild( 0 ), 'insert' ); - consumable.consume( data.item, 'attribute:bold' ); + dispatcher.on( 'insert:image', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.item.getChild( 0 ), 'insert' ); + conversionApi.consumable.consume( data.item, 'attribute:bold' ); } ); const range = ModelRange.createIn( root ); @@ -278,10 +278,10 @@ describe( 'DowncastDispatcher', () => { writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); - dispatcher.on( 'selection', ( evt, data, consumable ) => { - expect( consumable.test( data.selection, 'selection' ) ).to.be.true; - expect( consumable.test( data.selection, 'attribute:bold' ) ).to.be.true; - expect( consumable.test( data.selection, 'attribute:italic' ) ).to.be.null; + dispatcher.on( 'selection', ( evt, data, conversionApi ) => { + expect( conversionApi.consumable.test( data.selection, 'selection' ) ).to.be.true; + expect( conversionApi.consumable.test( data.selection, 'attribute:bold' ) ).to.be.true; + expect( conversionApi.consumable.test( data.selection, 'attribute:italic' ) ).to.be.null; } ); dispatcher.convertSelection( doc.selection, model.markers, [] ); @@ -331,8 +331,8 @@ describe( 'DowncastDispatcher', () => { writer.setAttribute( 'italic', true, ModelRange.createFromParentsAndOffsets( root, 4, root, 5 ) ); } ); - dispatcher.on( 'selection', ( evt, data, consumable ) => { - consumable.consume( data.selection, 'attribute:bold' ); + dispatcher.on( 'selection', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.selection, 'attribute:bold' ); } ); sinon.spy( dispatcher, 'fire' ); @@ -423,8 +423,8 @@ describe( 'DowncastDispatcher', () => { sinon.spy( dispatcher, 'fire' ); - dispatcher.on( 'addMarker:foo', ( evt, data, consumable ) => { - consumable.consume( data.item, 'addMarker:bar' ); + dispatcher.on( 'addMarker:foo', ( evt, data, conversionApi ) => { + conversionApi.consumable.consume( data.item, 'addMarker:bar' ); } ); const markers = Array.from( model.markers.getMarkersAtPosition( doc.selection.getFirstPosition() ) ); @@ -478,10 +478,10 @@ describe( 'DowncastDispatcher', () => { const items = []; - dispatcher.on( 'addMarker:name', ( evt, data, consumable ) => { + dispatcher.on( 'addMarker:name', ( evt, data, conversionApi ) => { expect( data.markerName ).to.equal( 'name' ); expect( data.markerRange.isEqual( range ) ).to.be.true; - expect( consumable.test( data.item, 'addMarker:name' ) ); + expect( conversionApi.consumable.test( data.item, 'addMarker:name' ) ); items.push( data.item ); } ); diff --git a/tests/manual/highlight.js b/tests/manual/highlight.js index 2b26018eb..5718633b9 100644 --- a/tests/manual/highlight.js +++ b/tests/manual/highlight.js @@ -49,7 +49,7 @@ class FancyWidget extends Plugin { conversion.for( 'editingDowncast' ).add( downcastElementToElement( { model: 'fancywidget', - view: ( modelItem, consumable, conversionApi ) => { + view: ( modelItem, conversionApi ) => { const viewWriter = conversionApi.writer; const widgetElement = viewWriter.createContainerElement( 'figure', { class: 'fancy-widget' } ); viewWriter.insert( ViewPosition.createAt( widgetElement ), viewWriter.createText( 'widget' ) ); diff --git a/tests/manual/nestededitable.js b/tests/manual/nestededitable.js index 08ba48b1e..161bfa570 100644 --- a/tests/manual/nestededitable.js +++ b/tests/manual/nestededitable.js @@ -58,7 +58,7 @@ class NestedEditable extends Plugin { editor.conversion.for( 'downcast' ).add( downcastElementToElement( { model: 'figcaption', - view: ( modelItem, consumable, conversionApi ) => { + view: ( modelItem, conversionApi ) => { const viewWriter = conversionApi.writer; const element = viewWriter.createEditableElement( 'figcaption', { contenteditable: 'true' } ); diff --git a/tests/manual/tickets/ckeditor5-721/1.js b/tests/manual/tickets/ckeditor5-721/1.js index 5c4d3b51c..e7e913374 100644 --- a/tests/manual/tickets/ckeditor5-721/1.js +++ b/tests/manual/tickets/ckeditor5-721/1.js @@ -43,7 +43,7 @@ ClassicEditor editor.conversion.for( 'downcast' ) .add( downcastElementToElement( { model: 'widget', - view: ( modelItem, consumable, conversionApi ) => { + view: ( modelItem, conversionApi ) => { const writer = conversionApi.writer; const b = writer.createAttributeElement( 'b' ); const div = writer.createContainerElement( 'div' ); @@ -55,7 +55,7 @@ ClassicEditor } ) ) .add( downcastElementToElement( { model: 'nested', - view: ( item, consumable, api ) => api.writer.createEditableElement( 'figcaption', { contenteditable: true } ) + view: ( item, api ) => api.writer.createEditableElement( 'figcaption', { contenteditable: true } ) } ) ); setData( editor.model, diff --git a/tests/view/manual/uielement.js b/tests/view/manual/uielement.js index 3d99db59e..b708b15ad 100644 --- a/tests/view/manual/uielement.js +++ b/tests/view/manual/uielement.js @@ -45,7 +45,7 @@ class UIElementTestPlugin extends Plugin { const editing = editor.editing; // Add some UIElement to each paragraph. - editing.downcastDispatcher.on( 'insert:paragraph', ( evt, data, consumable, conversionApi ) => { + editing.downcastDispatcher.on( 'insert:paragraph', ( evt, data, conversionApi ) => { const viewP = conversionApi.mapper.toViewElement( data.item ); viewP.appendChildren( createEndingUIElement( conversionApi.writer ) ); }, { priority: 'lowest' } ); From b42ab11a4ce94c0289cb1a3b76a5ed0066061e9c Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 19 Feb 2018 10:29:53 +0100 Subject: [PATCH 605/724] Changed: Corrected offests transformation in `model.Differ` when multiple change items interfere with each other. --- src/model/differ.js | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/src/model/differ.js b/src/model/differ.js index 04bf8aeda..fe9c66212 100644 --- a/src/model/differ.js +++ b/src/model/differ.js @@ -547,6 +547,8 @@ export default class Differ { * @param {Array.} changes An array containing all the changes done on that element. */ _handleChange( inc, changes ) { + inc.newHowMany = inc.howMany; + for ( const old of changes ) { const incEnd = inc.offset + inc.howMany; const oldEnd = old.offset + old.howMany; @@ -556,8 +558,8 @@ export default class Differ { if ( inc.offset <= old.offset ) { old.offset += inc.howMany; } else if ( inc.offset < oldEnd ) { - old.howMany += inc.howMany; - inc.howMany = 0; + old.howMany += inc.newHowMany; + inc.newHowMany = 0; } } @@ -608,20 +610,20 @@ export default class Differ { old.offset = inc.offset; old.howMany -= intersectionLength; - inc.howMany -= intersectionLength; + inc.newHowMany -= intersectionLength; } else { - old.howMany -= inc.howMany; - inc.howMany = 0; + old.howMany -= inc.newHowMany; + inc.newHowMany = 0; } } else { if ( inc.offset <= old.offset ) { - inc.howMany = inc.howMany - old.howMany; + inc.newHowMany -= old.howMany; old.howMany = 0; } else if ( inc.offset < oldEnd ) { const intersectionLength = oldEnd - inc.offset; old.howMany -= intersectionLength; - inc.howMany -= intersectionLength; + inc.newHowMany -= intersectionLength; } } } @@ -631,9 +633,9 @@ export default class Differ { old.offset -= inc.howMany; } else if ( inc.offset < old.offset ) { old.offset = inc.offset; - old.howMany += inc.howMany; + old.howMany += inc.newHowMany; - inc.howMany = 0; + inc.newHowMany = 0; } } @@ -656,7 +658,7 @@ export default class Differ { old.howMany = inc.offset - old.offset; - const howManyAfter = howMany - old.howMany - inc.howMany; + const howManyAfter = howMany - old.howMany - inc.newHowMany; // Add the second part of attribute change to the beginning of processed array so it won't // be processed again in this loop. @@ -695,24 +697,27 @@ export default class Differ { changes.push( attributePart ); } - inc.howMany = old.offset - inc.offset; + inc.newHowMany = old.offset - inc.offset; } else if ( inc.offset >= old.offset && inc.offset < oldEnd ) { if ( incEnd > oldEnd ) { - inc.howMany = incEnd - oldEnd; + inc.newHowMany = incEnd - oldEnd; inc.offset = oldEnd; } else { - inc.howMany = 0; + inc.newHowMany = 0; } } } if ( old.type == 'attribute' ) { if ( inc.offset >= old.offset && incEnd <= oldEnd ) { - inc.howMany = 0; + inc.newHowMany = 0; } } } } + + inc.howMany = inc.newHowMany; + delete inc.newHowMany; } /** From 808618ec67047a27c6b9265e64cdc0c435256c92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 20 Feb 2018 13:33:31 +0100 Subject: [PATCH 606/724] View render() and change() methods create new change block when called after rednering. --- src/view/view.js | 47 ++++++++++++++++++++++------------------- tests/view/view/view.js | 36 +++++++++++++++++++++++-------- 2 files changed, 52 insertions(+), 31 deletions(-) diff --git a/src/view/view.js b/src/view/view.js index 8a493152e..26a07de60 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -109,15 +109,15 @@ export default class View { this._ongoingChange = false; /** - * Is set to `true` when rendering view to DOM was started. + * Is set to `true` when rendering view to DOM is in progress. * This is used to check whether view document can accept changes in current state. * From the moment when rendering to DOM is stared view tree is locked to prevent changes that will not be * reflected in the DOM. * * @private - * @member {Boolean} module:engine/view/view~View#_renderingStarted + * @member {Boolean} module:engine/view/view~View#_renderingInProgress */ - this._renderingStarted = false; + this._renderingInProgress = false; /** * Writer instance used in {@link #change change method) callbacks. @@ -303,11 +303,11 @@ export default class View { * * Change block is executed immediately. * - * When the outermost change block is done and rendering to DOM is over it fires + * When the outermost change block is done it fires * {@link module:engine/view/view~View#event:render} event. * * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when - * change block is used after rendering to DOM has started. + * change block is used when rendering to DOM is in progress. * * @param {Function} callback Callback function which may modify the view. */ @@ -323,9 +323,6 @@ export default class View { callback( this._writer ); this.fire( 'render' ); - - this._ongoingChange = false; - this._renderingStarted = false; } } @@ -343,8 +340,7 @@ export default class View { // Render only if no ongoing changes are in progress. If there are some, view document will be rendered after all // changes are done. This way view document will not be rendered in the middle of some changes. if ( !this._ongoingChange ) { - this.fire( 'render' ); - this._renderingStarted = false; + this.change( () => {} ); } } @@ -366,11 +362,16 @@ export default class View { * @private */ _render() { - this._renderingStarted = true; + this._renderingInProgress = true; this.disableObservers(); this._renderer.render(); this.enableObservers(); + + // Current ongoing change is finished after rendering is done. + // Further render() or change() calls will create new ongoing change. + this._ongoingChange = false; + this._renderingInProgress = false; } /** @@ -380,15 +381,11 @@ export default class View { * @private */ _assertRenderingInProgress() { - if ( this._renderingStarted ) { + if ( this._renderingInProgress ) { /** - * There is an attempt to make changes in the view tree after the rendering process - * has started. This may cause unexpected behaviour and inconsistency between the DOM and the view. - * This may be caused by: - * * calling `view.change()` or `view.render()` methods during rendering process, - * * calling `view.change()` or `view.render()` methods in callbacks to - * {module:engine/view/document~Document#event:change view document change event) on `low` priority, after - * rendering is over for current `change` block. + * There is an attempt to make changes in the view tree when the rendering process is in progress. + * This may cause unexpected behaviour and inconsistency between the DOM and the view. + * This may be caused by calling `view.change()` or `view.render()` methods during rendering process. * * @error applying-view-changes-on-rendering */ @@ -401,13 +398,19 @@ export default class View { } /** - * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished and the DOM rendering has - * been executed. + * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished. * - * Actual rendering is performed on 'low' priority. This means that all listeners on 'normal' and above priorities + * Actual rendering is performed on 'low' priority. This means that all listeners on 'normal' and higher priorities * will be executed after changes made to view tree but before rendering to the DOM. Use `low` priority for callbacks that * should be executed after rendering to the DOM. * + * When listener on `normal` (or higher) priority call {@link module:engine/view/view~View#change change()} or + * {@link module:engine/view/view~View#render render()} it will be included in currently executed change block (no + * more `render` events will be fired). + * + * When listener on `low` (or lower) priority calls {@link module:engine/view/view~View#change change()} or + * {@link module:engine/view/view~View#render render()} it will create a new change block (new `render` event will be fired). + * * @event module:engine/view/view~View#event:render */ } diff --git a/tests/view/view/view.js b/tests/view/view/view.js index f23a62414..c9d74987d 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -550,20 +550,38 @@ describe( 'view', () => { domDiv.remove(); } ); - it( 'should throw when someone tries to call change() after rendering is finished but still in change block', () => { - view.on( 'render', () => { - expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); - }, { priority: 'low' } ); + it( 'should create separate render event when change() called on low priority', () => { + let called = false; + + const spy = sinon.spy( () => { + // Prevent infinite loop. + if ( !called ) { + called = true; + view.change( () => {} ); + } + } ); + + view.on( 'render', spy, { priority: 'low' } ); view.change( () => {} ); + sinon.assert.calledTwice( spy ); } ); - it( 'should throw when someone tries to call render() after rendering is finished but still in change block', () => { - view.on( 'render', () => { - expect( () => view.render() ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); - }, { priority: 'low' } ); + it( 'should create separate render event when render() called on low priority', () => { + let called = false; - view.change( () => {} ); + const spy = sinon.spy( () => { + // Prevent infinite loop. + if ( !called ) { + called = true; + view.render(); + } + } ); + + view.on( 'render', spy, { priority: 'low' } ); + + view.render(); + sinon.assert.calledTwice( spy ); } ); it( 'should NOT throw when someone tries to call change() before rendering', () => { From 21f63496a951bf3859761f0e18299c65fbe2dceb Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 20 Feb 2018 13:56:57 +0100 Subject: [PATCH 607/724] Tests: Refactored `model.Differ` tests. Tests: Added missing `model.Differ` test. --- tests/model/differ.js | 1156 ++++++++++++++++++++++++++--------------- 1 file changed, 743 insertions(+), 413 deletions(-) diff --git a/tests/model/differ.js b/tests/model/differ.js index f3ba17129..d798a4059 100644 --- a/tests/model/differ.js +++ b/tests/model/differ.js @@ -4,8 +4,6 @@ */ import Model from '../../src/model/model'; -import Document from '../../src/model/document'; -import Differ from '../../src/model/differ'; import Element from '../../src/model/element'; import Text from '../../src/model/text'; import Position from '../../src/model/position'; @@ -24,8 +22,8 @@ describe( 'Differ', () => { beforeEach( () => { model = new Model(); - doc = new Document( model ); - differ = new Differ(); + doc = model.document; + differ = doc.differ; root = doc.createRoot(); @@ -44,79 +42,93 @@ describe( 'Differ', () => { it( 'an element', () => { const position = new Position( root, [ 1 ] ); - insert( new Element( 'image' ), position ); + model.change( () => { + insert( new Element( 'image' ), position ); - expectChanges( [ - { type: 'insert', name: 'image', length: 1, position } - ] ); + expectChanges( [ + { type: 'insert', name: 'image', length: 1, position } + ] ); + } ); } ); it( 'a non-empty element with attributes', () => { const position = new Position( root, [ 1 ] ); - insert( - new Element( 'image', { src: 'foo.jpg' }, new Element( 'caption', null, new Text( 'bar' ) ) ), - position - ); + model.change( () => { + insert( + new Element( 'image', { src: 'foo.jpg' }, new Element( 'caption', null, new Text( 'bar' ) ) ), + position + ); - expectChanges( [ - { type: 'insert', name: 'image', length: 1, position } - ] ); + expectChanges( [ + { type: 'insert', name: 'image', length: 1, position } + ] ); + } ); } ); it( 'multiple elements', () => { const position = new Position( root, [ 1 ] ); - insert( [ new Element( 'image' ), new Element( 'paragraph' ) ], position ); + model.change( () => { + insert( [ new Element( 'image' ), new Element( 'paragraph' ) ], position ); - expectChanges( [ - { type: 'insert', name: 'image', length: 1, position }, - { type: 'insert', name: 'paragraph', length: 1, position: position.getShiftedBy( 1 ) } - ] ); + expectChanges( [ + { type: 'insert', name: 'image', length: 1, position }, + { type: 'insert', name: 'paragraph', length: 1, position: position.getShiftedBy( 1 ) } + ] ); + } ); } ); it( 'a character', () => { const position = new Position( root, [ 0, 2 ] ); - insert( new Text( 'x' ), position ); + model.change( () => { + insert( new Text( 'x' ), position ); - expectChanges( [ - { type: 'insert', name: '$text', length: 1, position } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 1, position } + ] ); + } ); } ); it( 'multiple characters', () => { const position = new Position( root, [ 0, 2 ] ); - insert( new Text( 'xyz' ), position ); + model.change( () => { + insert( new Text( 'xyz' ), position ); - expectChanges( [ - { type: 'insert', name: '$text', length: 3, position } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 3, position } + ] ); + } ); } ); it( 'multiple consecutive characters in multiple operations', () => { const position = new Position( root, [ 0, 2 ] ); - insert( new Text( 'xy' ), position ); - insert( new Text( 'z' ), position.getShiftedBy( 2 ) ); - insert( new Text( 'ab' ), position ); + model.change( () => { + insert( new Text( 'xy' ), position ); + insert( new Text( 'z' ), position.getShiftedBy( 2 ) ); + insert( new Text( 'ab' ), position ); - expectChanges( [ - { type: 'insert', name: '$text', length: 5, position } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 5, position } + ] ); + } ); } ); it( 'multiple non-consecutive characters in multiple operations', () => { const position = new Position( root, [ 0, 0 ] ); - insert( new Text( 'xy' ), position ); - insert( new Text( 'z' ), position.getShiftedBy( 3 ) ); + model.change( () => { + insert( new Text( 'xy' ), position ); + insert( new Text( 'z' ), position.getShiftedBy( 3 ) ); - expectChanges( [ - { type: 'insert', name: '$text', length: 2, position }, - { type: 'insert', name: '$text', length: 1, position: position.getShiftedBy( 3 ) } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position }, + { type: 'insert', name: '$text', length: 1, position: position.getShiftedBy( 3 ) } + ] ); + } ); } ); // Combined. @@ -124,30 +136,34 @@ describe( 'Differ', () => { const image = new Element( 'image' ); const position = new Position( root, [ 1 ] ); - insert( image, position ); + model.change( () => { + insert( image, position ); - const caption = new Element( 'caption' ); - insert( caption, Position.createAt( image, 0 ) ); + const caption = new Element( 'caption' ); + insert( caption, Position.createAt( image, 0 ) ); - insert( new Text( 'foo' ), Position.createAt( caption, 0 ) ); + insert( new Text( 'foo' ), Position.createAt( caption, 0 ) ); - expectChanges( [ - { type: 'insert', name: 'image', length: 1, position } - ] ); + expectChanges( [ + { type: 'insert', name: 'image', length: 1, position } + ] ); + } ); } ); it( 'node in a renamed element', () => { const text = new Text( 'xyz', { bold: true } ); const position = new Position( root, [ 0, 3 ] ); - insert( text, position ); - rename( root.getChild( 0 ), 'listItem' ); + model.change( () => { + insert( text, position ); + rename( root.getChild( 0 ), 'listItem' ); - // Note that since renamed element is removed and then re-inserted, there is no diff for text inserted inside it. - expectChanges( [ - { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }, - { type: 'insert', name: 'listItem', length: 1, position: new Position( root, [ 0 ] ) } - ] ); + // Note that since renamed element is removed and then re-inserted, there is no diff for text inserted inside it. + expectChanges( [ + { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }, + { type: 'insert', name: 'listItem', length: 1, position: new Position( root, [ 0 ] ) } + ] ); + } ); } ); it( 'node in a element with changed attribute', () => { @@ -155,23 +171,28 @@ describe( 'Differ', () => { const position = new Position( root, [ 0, 3 ] ); const range = Range.createFromParentsAndOffsets( root, 0, root.getChild( 0 ), 0 ); - insert( text, position ); - attribute( range, 'align', null, 'center' ); + model.change( () => { + insert( text, position ); + attribute( range, 'align', null, 'center' ); - // Compare to scenario above, this time there is only an attribute change on parent element, so there is also a diff for text. - expectChanges( [ - { type: 'attribute', range, attributeKey: 'align', attributeOldValue: null, attributeNewValue: 'center' }, - { type: 'insert', name: '$text', length: 3, position }, - ] ); + // Compare to scenario above, this time there is only an attribute change on parent element, + // so there is also a diff for text. + expectChanges( [ + { type: 'attribute', range, attributeKey: 'align', attributeOldValue: null, attributeNewValue: 'center' }, + { type: 'insert', name: '$text', length: 3, position }, + ] ); + } ); } ); it( 'nodes between other inserted nodes', () => { - insert( new Text( 'xx' ), new Position( root, [ 0, 1 ] ) ); - insert( new Text( 'yy' ), new Position( root, [ 0, 2 ] ) ); + model.change( () => { + insert( new Text( 'xx' ), new Position( root, [ 0, 1 ] ) ); + insert( new Text( 'yy' ), new Position( root, [ 0, 2 ] ) ); - expectChanges( [ - { type: 'insert', position: new Position( root, [ 0, 1 ] ), length: 4, name: '$text' } - ] ); + expectChanges( [ + { type: 'insert', position: new Position( root, [ 0, 1 ] ), length: 4, name: '$text' } + ] ); + } ); } ); it( 'nodes before nodes with changed attributes', () => { @@ -179,15 +200,17 @@ describe( 'Differ', () => { const range = Range.createFromParentsAndOffsets( p1, 1, p1, 3 ); const position = new Position( root, [ 0, 0 ] ); - attribute( range, 'bold', null, true ); - insert( new Text( 'xx' ), position ); + model.change( () => { + attribute( range, 'bold', null, true ); + insert( new Text( 'xx' ), position ); - const rangeAfter = Range.createFromParentsAndOffsets( p1, 3, p1, 5 ); + const rangeAfter = Range.createFromParentsAndOffsets( p1, 3, p1, 5 ); - expectChanges( [ - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAfter, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position }, + { type: 'attribute', range: rangeAfter, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true } + ] ); + } ); } ); it( 'nodes between nodes with changed attributes', () => { @@ -195,17 +218,31 @@ describe( 'Differ', () => { const range = Range.createFromParentsAndOffsets( p1, 1, p1, 3 ); const position = new Position( root, [ 0, 2 ] ); - attribute( range, 'bold', null, true ); - insert( new Text( 'xx' ), position ); - - const rangeBefore = Range.createFromParentsAndOffsets( p1, 1, p1, 2 ); - const rangeAfter = Range.createFromParentsAndOffsets( p1, 4, p1, 5 ); - - expectChanges( [ - { type: 'attribute', range: rangeBefore, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true }, - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAfter, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true } - ] ); + model.change( () => { + attribute( range, 'bold', null, true ); + insert( new Text( 'xx' ), position ); + + const rangeBefore = Range.createFromParentsAndOffsets( p1, 1, p1, 2 ); + const rangeAfter = Range.createFromParentsAndOffsets( p1, 4, p1, 5 ); + + expectChanges( [ + { + type: 'attribute', + range: rangeBefore, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + }, + { type: 'insert', name: '$text', length: 2, position }, + { + type: 'attribute', + range: rangeAfter, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + } + ] ); + } ); } ); it( 'nodes after nodes with changed attributes', () => { @@ -213,13 +250,21 @@ describe( 'Differ', () => { const range = Range.createFromParentsAndOffsets( p1, 1, p1, 3 ); const position = new Position( root, [ 0, 3 ] ); - attribute( range, 'bold', null, true ); - insert( new Text( 'xx' ), position ); - - expectChanges( [ - { type: 'attribute', range, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true }, - { type: 'insert', name: '$text', length: 2, position } - ] ); + model.change( () => { + attribute( range, 'bold', null, true ); + insert( new Text( 'xx' ), position ); + + expectChanges( [ + { + type: 'attribute', + range, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + }, + { type: 'insert', name: '$text', length: 2, position } + ] ); + } ); } ); } ); @@ -227,66 +272,78 @@ describe( 'Differ', () => { it( 'an element', () => { const position = new Position( root, [ 0 ] ); - remove( position, 1 ); + model.change( () => { + remove( position, 1 ); - expectChanges( [ - { type: 'remove', name: 'paragraph', length: 1, position } - ] ); + expectChanges( [ + { type: 'remove', name: 'paragraph', length: 1, position } + ] ); + } ); } ); it( 'multiple elements', () => { const position = new Position( root, [ 0 ] ); - remove( position, 2 ); + model.change( () => { + remove( position, 2 ); - expectChanges( [ - { type: 'remove', name: 'paragraph', length: 1, position }, - { type: 'remove', name: 'paragraph', length: 1, position } - ] ); + expectChanges( [ + { type: 'remove', name: 'paragraph', length: 1, position }, + { type: 'remove', name: 'paragraph', length: 1, position } + ] ); + } ); } ); it( 'a character', () => { const position = new Position( root, [ 0, 1 ] ); - remove( position, 1 ); + model.change( () => { + remove( position, 1 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 1, position: new Position( root, [ 0, 1 ] ) } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 1, position: new Position( root, [ 0, 1 ] ) } + ] ); + } ); } ); it( 'multiple characters', () => { const position = new Position( root, [ 0, 1 ] ); - remove( position, 2 ); + model.change( () => { + remove( position, 2 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 2, position } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 2, position } + ] ); + } ); } ); it( 'multiple consecutive characters in multiple operations', () => { const position = new Position( root, [ 0, 0 ] ); - remove( position, 1 ); - remove( position, 1 ); - remove( position, 1 ); + model.change( () => { + remove( position, 1 ); + remove( position, 1 ); + remove( position, 1 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 3, position } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 3, position } + ] ); + } ); } ); it( 'multiple non-consecutive characters in multiple operations', () => { const position = new Position( root, [ 0, 0 ] ); - remove( position, 1 ); - remove( position.getShiftedBy( 1 ), 1 ); + model.change( () => { + remove( position, 1 ); + remove( position.getShiftedBy( 1 ), 1 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 1, position }, - { type: 'remove', name: '$text', length: 1, position: position.getShiftedBy( 1 ) } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 1, position }, + { type: 'remove', name: '$text', length: 1, position: position.getShiftedBy( 1 ) } + ] ); + } ); } ); it( 'item just before inserted item', () => { @@ -294,76 +351,88 @@ describe( 'Differ', () => { const insertPosition = new Position( root, [ 0, 2 ] ); const removePosition = new Position( root, [ 0, 1 ] ); - insert( new Text( 'x' ), insertPosition ); - remove( removePosition, 1 ); + model.change( () => { + insert( new Text( 'x' ), insertPosition ); + remove( removePosition, 1 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 1, position: removePosition }, - { type: 'insert', name: '$text', length: 1, position: removePosition } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 1, position: removePosition }, + { type: 'insert', name: '$text', length: 1, position: removePosition } + ] ); + } ); } ); it( 'nodes before inserted nodes (together with some inserted nodes)', () => { const insertPosition = new Position( root, [ 0, 2 ] ); const removePosition = new Position( root, [ 0, 1 ] ); - insert( new Text( 'xyz' ), insertPosition ); - remove( removePosition, 2 ); + model.change( () => { + insert( new Text( 'xyz' ), insertPosition ); + remove( removePosition, 2 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 1, position: removePosition }, - { type: 'insert', name: '$text', length: 2, position: removePosition } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 1, position: removePosition }, + { type: 'insert', name: '$text', length: 2, position: removePosition } + ] ); + } ); } ); it( 'inserted nodes and some nodes after inserted nodes', () => { const insertPosition = new Position( root, [ 0, 2 ] ); const removePosition = new Position( root, [ 0, 3 ] ); - insert( new Text( 'xyz' ), insertPosition ); - remove( removePosition, 3 ); + model.change( () => { + insert( new Text( 'xyz' ), insertPosition ); + remove( removePosition, 3 ); - expectChanges( [ - { type: 'insert', name: '$text', length: 1, position: insertPosition }, - { type: 'remove', name: '$text', length: 1, position: removePosition } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 1, position: insertPosition }, + { type: 'remove', name: '$text', length: 1, position: removePosition } + ] ); + } ); } ); it( 'all inserted nodes', () => { const insertPosition = new Position( root, [ 0, 2 ] ); const removePosition = new Position( root, [ 0, 1 ] ); - insert( new Text( 'xy' ), insertPosition ); - remove( removePosition, 4 ); + model.change( () => { + insert( new Text( 'xy' ), insertPosition ); + remove( removePosition, 4 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 2, position: removePosition } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 2, position: removePosition } + ] ); + } ); } ); it( 'before removed nodes', () => { const removePositionA = new Position( root, [ 0, 2 ] ); const removePositionB = new Position( root, [ 0, 0 ] ); - remove( removePositionA, 1 ); - remove( removePositionB, 1 ); + model.change( () => { + remove( removePositionA, 1 ); + remove( removePositionB, 1 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 1, position: removePositionB }, - { type: 'remove', name: '$text', length: 1, position: new Position( root, [ 0, 1 ] ) } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 1, position: removePositionB }, + { type: 'remove', name: '$text', length: 1, position: new Position( root, [ 0, 1 ] ) } + ] ); + } ); } ); it( 'before and after removed nodes in one operation', () => { const removePositionA = new Position( root, [ 0, 1 ] ); const removePositionB = new Position( root, [ 0, 0 ] ); - remove( removePositionA, 1 ); - remove( removePositionB, 2 ); + model.change( () => { + remove( removePositionA, 1 ); + remove( removePositionB, 2 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 3, position: removePositionB }, - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 3, position: removePositionB }, + ] ); + } ); } ); it( 'before nodes that changed attributes', () => { @@ -372,15 +441,23 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 2, p1, 3 ); - attribute( range, 'bold', null, true ); - remove( position, 1 ); + model.change( () => { + attribute( range, 'bold', null, true ); + remove( position, 1 ); - const newRange = Range.createFromParentsAndOffsets( p1, 1, p1, 2 ); + const newRange = Range.createFromParentsAndOffsets( p1, 1, p1, 2 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 1, position }, - { type: 'attribute', range: newRange, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 1, position }, + { + type: 'attribute', + range: newRange, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + } + ] ); + } ); } ); it( 'before nodes that changed attributes together with some changed nodes', () => { @@ -389,15 +466,23 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 1, p1, 3 ); - attribute( range, 'bold', null, true ); - remove( position, 2 ); + model.change( () => { + attribute( range, 'bold', null, true ); + remove( position, 2 ); - const newRange = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); + const newRange = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); - expectChanges( [ - { type: 'remove', name: '$text', length: 2, position }, - { type: 'attribute', range: newRange, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 2, position }, + { + type: 'attribute', + range: newRange, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + } + ] ); + } ); } ); it( 'some changed nodes', () => { @@ -406,17 +491,31 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 0, p1, 3 ); - attribute( range, 'bold', null, true ); - remove( position, 1 ); - - const rangeBefore = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); - const rangeAfter = Range.createFromParentsAndOffsets( p1, 1, p1, 2 ); - - expectChanges( [ - { type: 'attribute', range: rangeBefore, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true }, - { type: 'remove', name: '$text', length: 1, position }, - { type: 'attribute', range: rangeAfter, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true } - ] ); + model.change( () => { + attribute( range, 'bold', null, true ); + remove( position, 1 ); + + const rangeBefore = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); + const rangeAfter = Range.createFromParentsAndOffsets( p1, 1, p1, 2 ); + + expectChanges( [ + { + type: 'attribute', + range: rangeBefore, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + }, + { type: 'remove', name: '$text', length: 1, position }, + { + type: 'attribute', + range: rangeAfter, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + } + ] ); + } ); } ); it( 'some changed nodes and some nodes after', () => { @@ -425,15 +524,23 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 0, p1, 2 ); - attribute( range, 'bold', null, true ); - remove( position, 2 ); + model.change( () => { + attribute( range, 'bold', null, true ); + remove( position, 2 ); - const newRange = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); + const newRange = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); - expectChanges( [ - { type: 'attribute', range: newRange, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true }, - { type: 'remove', name: '$text', length: 2, position } - ] ); + expectChanges( [ + { + type: 'attribute', + range: newRange, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + }, + { type: 'remove', name: '$text', length: 2, position } + ] ); + } ); } ); it( 'after changed nodes', () => { @@ -442,13 +549,21 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); - attribute( range, 'bold', null, true ); - remove( position, 1 ); - - expectChanges( [ - { type: 'attribute', range, attributeKey: 'bold', attributeOldValue: null, attributeNewValue: true }, - { type: 'remove', name: '$text', length: 1, position } - ] ); + model.change( () => { + attribute( range, 'bold', null, true ); + remove( position, 1 ); + + expectChanges( [ + { + type: 'attribute', + range, + attributeKey: 'bold', + attributeOldValue: null, + attributeNewValue: true + }, + { type: 'remove', name: '$text', length: 1, position } + ] ); + } ); } ); } ); @@ -460,37 +575,43 @@ describe( 'Differ', () => { const sourcePosition = new Position( root, [ 0 ] ); const targetPosition = new Position( root, [ 2 ] ); - move( sourcePosition, 1, targetPosition ); + model.change( () => { + move( sourcePosition, 1, targetPosition ); - expectChanges( [ - { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }, - { type: 'insert', name: 'paragraph', length: 1, position: new Position( root, [ 1 ] ) } - ] ); + expectChanges( [ + { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }, + { type: 'insert', name: 'paragraph', length: 1, position: new Position( root, [ 1 ] ) } + ] ); + } ); } ); it( 'an element to the same parent - target position is before source position', () => { const sourcePosition = new Position( root, [ 1 ] ); const targetPosition = new Position( root, [ 0 ] ); - move( sourcePosition, 1, targetPosition ); + model.change( () => { + move( sourcePosition, 1, targetPosition ); - expectChanges( [ - { type: 'insert', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }, - { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 2 ] ) } - ] ); + expectChanges( [ + { type: 'insert', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }, + { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 2 ] ) } + ] ); + } ); } ); it( 'multiple consecutive characters between different roots in multiple operations', () => { const sourcePosition = new Position( root, [ 0, 1 ] ); const targetPosition = new Position( root, [ 1, 0 ] ); - move( sourcePosition, 1, targetPosition ); - move( sourcePosition, 1, targetPosition.getShiftedBy( 1 ) ); + model.change( () => { + move( sourcePosition, 1, targetPosition ); + move( sourcePosition, 1, targetPosition.getShiftedBy( 1 ) ); - expectChanges( [ - { type: 'remove', name: '$text', length: 2, position: sourcePosition }, - { type: 'insert', name: '$text', length: 2, position: targetPosition } - ] ); + expectChanges( [ + { type: 'remove', name: '$text', length: 2, position: sourcePosition }, + { type: 'insert', name: '$text', length: 2, position: targetPosition } + ] ); + } ); } ); it( 'reinsert removed element', () => { @@ -499,22 +620,26 @@ describe( 'Differ', () => { const sourcePosition = new Position( doc.graveyard, [ 0 ] ); const targetPosition = new Position( root, [ 2 ] ); - move( sourcePosition, 1, targetPosition ); + model.change( () => { + move( sourcePosition, 1, targetPosition ); - expectChanges( [ - { type: 'insert', name: 'listItem', length: 1, position: targetPosition } - ] ); + expectChanges( [ + { type: 'insert', name: 'listItem', length: 1, position: targetPosition } + ] ); + } ); } ); } ); describe( 'rename', () => { it( 'an element', () => { - rename( root.getChild( 1 ), 'listItem' ); + model.change( () => { + rename( root.getChild( 1 ), 'listItem' ); - expectChanges( [ - { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 1 ] ) }, - { type: 'insert', name: 'listItem', length: 1, position: new Position( root, [ 1 ] ) } - ] ); + expectChanges( [ + { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 1 ] ) }, + { type: 'insert', name: 'listItem', length: 1, position: new Position( root, [ 1 ] ) } + ] ); + } ); } ); } ); @@ -526,61 +651,69 @@ describe( 'Differ', () => { it( 'on an element', () => { const range = Range.createFromParentsAndOffsets( root, 0, root.getChild( 0 ), 0 ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - expectChanges( [ - { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on an element - only one of many attributes changes', () => { const range = Range.createFromParentsAndOffsets( root, 0, root.getChild( 0 ), 0 ); - // Set an attribute on an element. It won't change afterwards. - attribute( range, 'otherAttr', null, true ); + model.change( () => { + // Set an attribute on an element. It won't change afterwards. + attribute( range, 'otherAttr', null, true ); + } ); - // "Flush" differ. - differ.getChanges(); - differ.reset(); + model.change( () => { + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - - expectChanges( [ - { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on a character', () => { const parent = root.getChild( 1 ); const range = Range.createFromParentsAndOffsets( parent, 1, parent, 2 ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - expectChanges( [ - { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on a character - case with same characters next to each other', () => { const parent = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( parent, 1, parent, 2 ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - expectChanges( [ - { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on multiple characters', () => { const parent = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( parent, 0, parent, 3 ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - expectChanges( [ - { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on multiple consecutive characters in multiple operations', () => { @@ -589,14 +722,16 @@ describe( 'Differ', () => { const range1 = Range.createFromParentsAndOffsets( parent, 1, parent, 2 ); const range2 = Range.createFromParentsAndOffsets( parent, 2, parent, 3 ); - attribute( range1, attributeKey, attributeOldValue, attributeNewValue ); - attribute( range2, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + attribute( range1, attributeKey, attributeOldValue, attributeNewValue ); + attribute( range2, attributeKey, attributeOldValue, attributeNewValue ); - const range = Range.createFromParentsAndOffsets( parent, 1, parent, 3 ); + const range = Range.createFromParentsAndOffsets( parent, 1, parent, 3 ); - expectChanges( [ - { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on multiple non-consecutive characters in multiple operations', () => { @@ -605,32 +740,60 @@ describe( 'Differ', () => { const range1 = Range.createFromParentsAndOffsets( parent, 0, parent, 1 ); const range2 = Range.createFromParentsAndOffsets( parent, 2, parent, 3 ); - // Note "reversed" order of ranges. Further range is changed first. - attribute( range2, attributeKey, attributeOldValue, attributeNewValue ); - attribute( range1, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + // Note "reversed" order of ranges. Further range is changed first. + attribute( range2, attributeKey, attributeOldValue, attributeNewValue ); + attribute( range1, attributeKey, attributeOldValue, attributeNewValue ); - // Note that changes has been sorted. - expectChanges( [ - { type: 'attribute', range: range1, attributeKey, attributeOldValue, attributeNewValue }, - { type: 'attribute', range: range2, attributeKey, attributeOldValue, attributeNewValue } - ] ); + // Note that changes has been sorted. + expectChanges( [ + { type: 'attribute', range: range1, attributeKey, attributeOldValue, attributeNewValue }, + { type: 'attribute', range: range2, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on range containing various nodes', () => { const range = Range.createFromParentsAndOffsets( root, 0, root, 2 ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - - const p1 = root.getChild( 0 ); - const p2 = root.getChild( 1 ); - const type = 'attribute'; - - expectChanges( [ - { type, range: Range.createFromParentsAndOffsets( root, 0, p1, 0 ), attributeKey, attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p1, 0, p1, 3 ), attributeKey, attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( root, 1, p2, 0 ), attributeKey, attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p2, 0, p2, 3 ), attributeKey, attributeOldValue, attributeNewValue } - ] ); + model.change( () => { + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + + const p1 = root.getChild( 0 ); + const p2 = root.getChild( 1 ); + const type = 'attribute'; + + expectChanges( [ + { + type, + range: Range.createFromParentsAndOffsets( root, 0, p1, 0 ), + attributeKey, + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p1, 0, p1, 3 ), + attributeKey, + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( root, 1, p2, 0 ), + attributeKey, + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p2, 0, p2, 3 ), + attributeKey, + attributeOldValue, + attributeNewValue + } + ] ); + } ); } ); it( 'remove and add attribute on text', () => { @@ -640,19 +803,45 @@ describe( 'Differ', () => { const range = Range.createFromParentsAndOffsets( p, 1, p, 3 ); - attribute( range, 'bold', true, null ); - attribute( range, 'italic', null, true ); - - const range1 = Range.createFromParentsAndOffsets( p, 1, p, 2 ); - const range2 = Range.createFromParentsAndOffsets( p, 2, p, 3 ); - - // Attribute change glueing does not work 100% correct. - expectChanges( [ - { type: 'attribute', range: range1, attributeKey: 'bold', attributeOldValue: true, attributeNewValue: null }, - { type: 'attribute', range: range1, attributeKey: 'italic', attributeOldValue: null, attributeNewValue: true }, - { type: 'attribute', range: range2, attributeKey: 'bold', attributeOldValue: true, attributeNewValue: null }, - { type: 'attribute', range: range2, attributeKey: 'italic', attributeOldValue: null, attributeNewValue: true } - ] ); + model.change( () => { + attribute( range, 'bold', true, null ); + attribute( range, 'italic', null, true ); + + const range1 = Range.createFromParentsAndOffsets( p, 1, p, 2 ); + const range2 = Range.createFromParentsAndOffsets( p, 2, p, 3 ); + + // Attribute change glueing does not work 100% correct. + expectChanges( [ + { + type: 'attribute', + range: range1, + attributeKey: 'bold', + attributeOldValue: true, + attributeNewValue: null + }, + { + type: 'attribute', + range: range1, + attributeKey: 'italic', + attributeOldValue: null, + attributeNewValue: true + }, + { + type: 'attribute', + range: range2, + attributeKey: 'bold', + attributeOldValue: true, + attributeNewValue: null + }, + { + type: 'attribute', + range: range2, + attributeKey: 'italic', + attributeOldValue: null, + attributeNewValue: true + } + ] ); + } ); } ); it( 'on some old nodes and inserted nodes', () => { @@ -661,15 +850,17 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 0, p1, 2 ); - insert( new Text( 'xx' ), position ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - const rangeBefore = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); + const rangeBefore = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); - expectChanges( [ - { type: 'attribute', range: rangeBefore, attributeKey, attributeOldValue, attributeNewValue }, - { type: 'insert', name: '$text', length: 2, position } - ] ); + expectChanges( [ + { type: 'attribute', range: rangeBefore, attributeKey, attributeOldValue, attributeNewValue }, + { type: 'insert', name: '$text', length: 2, position } + ] ); + } ); } ); it( 'only on inserted nodes', () => { @@ -678,12 +869,14 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 2, p1, 3 ); - insert( new Text( 'xxx' ), position ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + insert( new Text( 'xxx' ), position ); + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - expectChanges( [ - { type: 'insert', name: '$text', length: 3, position } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 3, position } + ] ); + } ); } ); it( 'on some inserted nodes and old nodes', () => { @@ -692,15 +885,17 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 2, p1, 4 ); - insert( new Text( 'xx' ), position ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - const rangeAfter = Range.createFromParentsAndOffsets( p1, 3, p1, 4 ); + const rangeAfter = Range.createFromParentsAndOffsets( p1, 3, p1, 4 ); - expectChanges( [ - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAfter, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position }, + { type: 'attribute', range: rangeAfter, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'over all inserted nodes and some old nodes', () => { @@ -709,17 +904,19 @@ describe( 'Differ', () => { const p1 = root.getChild( 0 ); const range = Range.createFromParentsAndOffsets( p1, 0, p1, 4 ); - insert( new Text( 'xx' ), position ); - attribute( range, attributeKey, attributeOldValue, attributeNewValue ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, attributeKey, attributeOldValue, attributeNewValue ); - const rangeBefore = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); - const rangeAfter = Range.createFromParentsAndOffsets( p1, 3, p1, 4 ); + const rangeBefore = Range.createFromParentsAndOffsets( p1, 0, p1, 1 ); + const rangeAfter = Range.createFromParentsAndOffsets( p1, 3, p1, 4 ); - expectChanges( [ - { type: 'attribute', range: rangeBefore, attributeKey, attributeOldValue, attributeNewValue }, - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAfter, attributeKey, attributeOldValue, attributeNewValue } - ] ); + expectChanges( [ + { type: 'attribute', range: rangeBefore, attributeKey, attributeOldValue, attributeNewValue }, + { type: 'insert', name: '$text', length: 2, position }, + { type: 'attribute', range: rangeAfter, attributeKey, attributeOldValue, attributeNewValue } + ] ); + } ); } ); it( 'on some not changed and some changed nodes', () => { @@ -728,20 +925,46 @@ describe( 'Differ', () => { const rangeA = Range.createFromParentsAndOffsets( p, 1, p, 3 ); const rangeB = Range.createFromParentsAndOffsets( p, 0, p, 2 ); - attribute( rangeA, 'a', null, true ); - attribute( rangeB, 'b', null, true ); - - const type = 'attribute'; - const attributeOldValue = null; - const attributeNewValue = true; - - // Attribute change glueing does not work 100% correct. - expectChanges( [ - { type, range: Range.createFromParentsAndOffsets( p, 0, p, 1 ), attributeKey: 'b', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), attributeKey: 'a', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), attributeKey: 'b', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 2, p, 3 ), attributeKey: 'a', attributeOldValue, attributeNewValue } - ] ); + model.change( () => { + attribute( rangeA, 'a', null, true ); + attribute( rangeB, 'b', null, true ); + + const type = 'attribute'; + const attributeOldValue = null; + const attributeNewValue = true; + + // Attribute change glueing does not work 100% correct. + expectChanges( [ + { + type, + range: Range.createFromParentsAndOffsets( p, 0, p, 1 ), + attributeKey: 'b', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), + attributeKey: 'a', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), + attributeKey: 'b', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 2, p, 3 ), + attributeKey: 'a', + attributeOldValue, + attributeNewValue + } + ] ); + } ); } ); it( 'on already changed nodes', () => { @@ -750,19 +973,39 @@ describe( 'Differ', () => { const rangeA = Range.createFromParentsAndOffsets( p, 0, p, 3 ); const rangeB = Range.createFromParentsAndOffsets( p, 1, p, 2 ); - attribute( rangeA, 'a', null, true ); - attribute( rangeB, 'b', null, true ); - - const type = 'attribute'; - const attributeOldValue = null; - const attributeNewValue = true; - - // Attribute change glueing does not work 100% correct. - expectChanges( [ - { type, range: Range.createFromParentsAndOffsets( p, 0, p, 2 ), attributeKey: 'a', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), attributeKey: 'b', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 2, p, 3 ), attributeKey: 'a', attributeOldValue, attributeNewValue } - ] ); + model.change( () => { + attribute( rangeA, 'a', null, true ); + attribute( rangeB, 'b', null, true ); + + const type = 'attribute'; + const attributeOldValue = null; + const attributeNewValue = true; + + // Attribute change glueing does not work 100% correct. + expectChanges( [ + { + type, + range: Range.createFromParentsAndOffsets( p, 0, p, 2 ), + attributeKey: 'a', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), + attributeKey: 'b', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 2, p, 3 ), + attributeKey: 'a', + attributeOldValue, + attributeNewValue + } + ] ); + } ); } ); it( 'on some changed and some not changed nodes', () => { @@ -771,17 +1014,31 @@ describe( 'Differ', () => { const rangeA = Range.createFromParentsAndOffsets( p, 0, p, 2 ); const rangeB = Range.createFromParentsAndOffsets( p, 1, p, 3 ); - attribute( rangeA, 'a', null, true ); - attribute( rangeB, 'b', null, true ); - - const type = 'attribute'; - const attributeOldValue = null; - const attributeNewValue = true; - - expectChanges( [ - { type, range: Range.createFromParentsAndOffsets( p, 0, p, 2 ), attributeKey: 'a', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 1, p, 3 ), attributeKey: 'b', attributeOldValue, attributeNewValue }, - ] ); + model.change( () => { + attribute( rangeA, 'a', null, true ); + attribute( rangeB, 'b', null, true ); + + const type = 'attribute'; + const attributeOldValue = null; + const attributeNewValue = true; + + expectChanges( [ + { + type, + range: Range.createFromParentsAndOffsets( p, 0, p, 2 ), + attributeKey: 'a', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 1, p, 3 ), + attributeKey: 'b', + attributeOldValue, + attributeNewValue + } + ] ); + } ); } ); it( 'over all changed nodes and some not changed nodes', () => { @@ -790,19 +1047,39 @@ describe( 'Differ', () => { const rangeA = Range.createFromParentsAndOffsets( p, 1, p, 2 ); const rangeB = Range.createFromParentsAndOffsets( p, 0, p, 3 ); - attribute( rangeA, 'a', null, true ); - attribute( rangeB, 'b', null, true ); - - const type = 'attribute'; - const attributeOldValue = null; - const attributeNewValue = true; - - // Attribute change glueing does not work 100% correct. - expectChanges( [ - { type, range: Range.createFromParentsAndOffsets( p, 0, p, 1 ), attributeKey: 'b', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), attributeKey: 'a', attributeOldValue, attributeNewValue }, - { type, range: Range.createFromParentsAndOffsets( p, 1, p, 3 ), attributeKey: 'b', attributeOldValue, attributeNewValue }, - ] ); + model.change( () => { + attribute( rangeA, 'a', null, true ); + attribute( rangeB, 'b', null, true ); + + const type = 'attribute'; + const attributeOldValue = null; + const attributeNewValue = true; + + // Attribute change glueing does not work 100% correct. + expectChanges( [ + { + type, + range: Range.createFromParentsAndOffsets( p, 0, p, 1 ), + attributeKey: 'b', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 1, p, 2 ), + attributeKey: 'a', + attributeOldValue, + attributeNewValue + }, + { + type, + range: Range.createFromParentsAndOffsets( p, 1, p, 3 ), + attributeKey: 'b', + attributeOldValue, + attributeNewValue + } + ] ); + } ); } ); } ); @@ -902,88 +1179,149 @@ describe( 'Differ', () => { } ); } ); + describe( 'other cases', () => { + // #1309. + it( 'multiple inserts and removes in one element', () => { + model.change( () => { + insert( new Text( 'x' ), new Position( root, [ 0, 2 ] ) ); + insert( new Text( 'x' ), new Position( root, [ 0, 3 ] ) ); + move( new Position( root, [ 0, 2 ] ), 1, new Position( root, [ 1, 0 ] ) ); + + expectChanges( [ + { type: 'insert', name: '$text', length: 1, position: new Position( root, [ 0, 2 ] ) }, + { type: 'insert', name: '$text', length: 1, position: new Position( root, [ 1, 0 ] ) } + ] ); + } ); + } ); + } ); + describe( 'getChanges()', () => { - let position, p1, rangeAttrChange; + let position, p1, rangeAttrChange, range; beforeEach( () => { position = new Position( root, [ 0, 1 ] ); p1 = root.getChild( 0 ); - const range = Range.createFromParentsAndOffsets( p1, 2, p1, 4 ); + range = Range.createFromParentsAndOffsets( p1, 2, p1, 4 ); rangeAttrChange = Range.createFromParentsAndOffsets( p1, 3, p1, 4 ); - - insert( new Text( 'xx' ), position ); - attribute( range, 'key', null, 'foo' ); } ); it( 'should return changes in graveyard if a flag was set up', () => { const removePosition = new Position( root, [ 1 ] ); - remove( removePosition, 1 ); - expectChanges( [ - { type: 'insert', name: 'paragraph', length: 1, position: new Position( doc.graveyard, [ 0 ] ) }, - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAttrChange, attributeKey: 'key', attributeOldValue: null, attributeNewValue: 'foo' }, - { type: 'remove', name: 'paragraph', position: removePosition, length: 1 } - ], true ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, 'key', null, 'foo' ); + + remove( removePosition, 1 ); + + expectChanges( [ + { type: 'insert', name: 'paragraph', length: 1, position: new Position( doc.graveyard, [ 0 ] ) }, + { type: 'insert', name: '$text', length: 2, position }, + { + type: 'attribute', + range: rangeAttrChange, + attributeKey: 'key', + attributeOldValue: null, + attributeNewValue: 'foo' + }, + { type: 'remove', name: 'paragraph', position: removePosition, length: 1 } + ], true ); + } ); } ); // Below tests test caching. it( 'should return same change set if was called twice in a row', () => { - const changesA = differ.getChanges(); - const changesB = differ.getChanges(); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, 'key', null, 'foo' ); - expect( changesA ).to.deep.equal( changesB ); + const changesA = differ.getChanges(); + const changesB = differ.getChanges(); + + expect( changesA ).to.deep.equal( changesB ); + } ); } ); it( 'should return same change set if was called twice in a row - graveyard changes', () => { - const removePosition = new Position( root, [ 1 ] ); - remove( removePosition, 1 ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, 'key', null, 'foo' ); + + const removePosition = new Position( root, [ 1 ] ); + remove( removePosition, 1 ); - const changesA = differ.getChanges( { includeChangesInGraveyard: true } ); - const changesB = differ.getChanges( { includeChangesInGraveyard: true } ); + const changesA = differ.getChanges( { includeChangesInGraveyard: true } ); + const changesB = differ.getChanges( { includeChangesInGraveyard: true } ); - expect( changesA ).to.deep.equal( changesB ); + expect( changesA ).to.deep.equal( changesB ); + } ); } ); it( 'should return correct changes if change happened between getChanges() calls', () => { - expectChanges( [ - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAttrChange, attributeKey: 'key', attributeOldValue: null, attributeNewValue: 'foo' } - ] ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, 'key', null, 'foo' ); + + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position }, + { + type: 'attribute', + range: rangeAttrChange, + attributeKey: 'key', + attributeOldValue: null, + attributeNewValue: 'foo' + } + ] ); - const removePosition = new Position( root, [ 1 ] ); - remove( removePosition, 1 ); + const removePosition = new Position( root, [ 1 ] ); + remove( removePosition, 1 ); - expectChanges( [ - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAttrChange, attributeKey: 'key', attributeOldValue: null, attributeNewValue: 'foo' }, - { type: 'remove', name: 'paragraph', position: removePosition, length: 1 } - ] ); + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position }, + { + type: 'attribute', + range: rangeAttrChange, + attributeKey: 'key', + attributeOldValue: null, + attributeNewValue: 'foo' + }, + { type: 'remove', name: 'paragraph', position: removePosition, length: 1 } + ] ); + } ); } ); it( 'should return correct changes if reset happened between getChanges() calls', () => { - expectChanges( [ - { type: 'insert', name: '$text', length: 2, position }, - { type: 'attribute', range: rangeAttrChange, attributeKey: 'key', attributeOldValue: null, attributeNewValue: 'foo' } - ] ); + model.change( () => { + insert( new Text( 'xx' ), position ); + attribute( range, 'key', null, 'foo' ); + + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position }, + { + type: 'attribute', + range: rangeAttrChange, + attributeKey: 'key', + attributeOldValue: null, + attributeNewValue: 'foo' + } + ] ); - differ.reset(); + differ.reset(); - const removePosition = new Position( root, [ 1 ] ); - remove( removePosition, 1 ); + const removePosition = new Position( root, [ 1 ] ); + remove( removePosition, 1 ); - expectChanges( [ - { type: 'remove', name: 'paragraph', position: removePosition, length: 1 } - ] ); + expectChanges( [ + { type: 'remove', name: 'paragraph', position: removePosition, length: 1 } + ] ); + } ); } ); } ); function insert( item, position ) { const operation = new InsertOperation( position, item, doc.version ); - differ.bufferOperation( operation ); - model.applyOperation( wrapInDelta( operation ) ); } @@ -991,32 +1329,24 @@ describe( 'Differ', () => { const targetPosition = Position.createAt( doc.graveyard, doc.graveyard.maxOffset ); const operation = new RemoveOperation( sourcePosition, howMany, targetPosition, doc.version ); - differ.bufferOperation( operation ); - model.applyOperation( wrapInDelta( operation ) ); } function move( sourcePosition, howMany, targetPosition ) { const operation = new MoveOperation( sourcePosition, howMany, targetPosition, doc.version ); - differ.bufferOperation( operation ); - model.applyOperation( wrapInDelta( operation ) ); } function rename( element, newName ) { const operation = new RenameOperation( Position.createBefore( element ), element.name, newName, doc.version ); - differ.bufferOperation( operation ); - model.applyOperation( wrapInDelta( operation ) ); } function attribute( range, key, oldValue, newValue ) { const operation = new AttributeOperation( range, key, oldValue, newValue, doc.version ); - differ.bufferOperation( operation ); - model.applyOperation( wrapInDelta( operation ) ); } From 001086386f93dcd11e1e80beefd8232bcfaabf24 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 20 Feb 2018 17:01:19 +0100 Subject: [PATCH 608/724] Changed: Removed `consumable` parameter from `conversion.DowncastDispatcher#_testAndFire`. --- src/conversion/downcastdispatcher.js | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/src/conversion/downcastdispatcher.js b/src/conversion/downcastdispatcher.js index 254b70d3f..8bbb74d80 100644 --- a/src/conversion/downcastdispatcher.js +++ b/src/conversion/downcastdispatcher.js @@ -156,7 +156,7 @@ export default class DowncastDispatcher { this.conversionApi.writer = writer; // Create a list of things that can be consumed, consisting of nodes and their attributes. - const consumable = this._createInsertConsumable( range ); + this.conversionApi.consumable = this._createInsertConsumable( range ); // Fire a separate insert event for each node and text fragment contained in the range. for ( const value of range ) { @@ -167,7 +167,7 @@ export default class DowncastDispatcher { range: itemRange }; - this._testAndFire( 'insert', data, consumable ); + this._testAndFire( 'insert', data ); // Fire a separate addAttribute event for each attribute that was set on inserted items. // This is important because most attributes converters will listen only to add/change/removeAttribute events. @@ -177,7 +177,7 @@ export default class DowncastDispatcher { data.attributeOldValue = null; data.attributeNewValue = item.getAttribute( key ); - this._testAndFire( `attribute:${ key }`, data, consumable ); + this._testAndFire( `attribute:${ key }`, data ); } } @@ -216,7 +216,7 @@ export default class DowncastDispatcher { this.conversionApi.writer = writer; // Create a list with attributes to consume. - const consumable = this._createConsumableForRange( range, `attribute:${ key }` ); + this.conversionApi.consumable = this._createConsumableForRange( range, `attribute:${ key }` ); // Create a separate attribute event for each node in the range. for ( const value of range ) { @@ -230,7 +230,7 @@ export default class DowncastDispatcher { attributeNewValue: newValue }; - this._testAndFire( `attribute:${ key }`, data, consumable ); + this._testAndFire( `attribute:${ key }`, data ); } this._clearConversionApi(); @@ -441,18 +441,15 @@ export default class DowncastDispatcher { * @fires attribute * @param {String} type Event type. * @param {Object} data Event data. - * @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume. */ - _testAndFire( type, data, consumable ) { - if ( !consumable.test( data.item, type ) ) { + _testAndFire( type, data ) { + if ( !this.conversionApi.consumable.test( data.item, type ) ) { // Do not fire event if the item was consumed. return; } const name = data.item.name || '$text'; - this.conversionApi.consumable = consumable; - this.fire( type + ':' + name, data, this.conversionApi ); } From 120003651c1013029989cab28622bae95be4d31d Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Tue, 20 Feb 2018 17:38:11 +0100 Subject: [PATCH 609/724] Test for proper order of render event listeners. --- tests/view/view/view.js | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/tests/view/view/view.js b/tests/view/view/view.js index c9d74987d..9a0abe58b 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -584,6 +584,36 @@ describe( 'view', () => { sinon.assert.calledTwice( spy ); } ); + it( 'should call second render after the first is done', () => { + let called = false; + const order = []; + + const lowSpy = sinon.spy( () => { + order.push( 'low1' ); + + // Prevent infinite loop. + if ( !called ) { + called = true; + view.render(); + } + + order.push( 'low2' ); + } ); + + const lowestSpy = sinon.spy( () => { + order.push( 'lowest' ); + } ); + + view.on( 'render', lowSpy, { priority: 'low' } ); + view.on( 'render', lowestSpy, { priority: 'lowest' } ); + + view.render(); + sinon.assert.calledTwice( lowSpy ); + sinon.assert.calledTwice( lowestSpy ); + + expect( order ).to.deep.equal( [ 'low1', 'low2', 'lowest', 'low1', 'low2', 'lowest' ] ); + } ); + it( 'should NOT throw when someone tries to call change() before rendering', () => { view.on( 'render', () => { expect( () => view.change( () => {} ) ).not.to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); From 118da777b3b9d1cdcdbcdfa0b48dea5a5a0d796a Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 20 Feb 2018 18:04:07 +0100 Subject: [PATCH 610/724] Changed: Renamed internal property from `newHowMany` to `nodesToHandle` and explained it in a comment. --- src/model/differ.js | 50 ++++++++++++++++++++++++++++++--------------- 1 file changed, 33 insertions(+), 17 deletions(-) diff --git a/src/model/differ.js b/src/model/differ.js index fe9c66212..520966fa1 100644 --- a/src/model/differ.js +++ b/src/model/differ.js @@ -547,7 +547,23 @@ export default class Differ { * @param {Array.} changes An array containing all the changes done on that element. */ _handleChange( inc, changes ) { - inc.newHowMany = inc.howMany; + // We need a helper variable that will store how many nodes are to be still handled for this change item. + // `nodesToHandle` (how many nodes still need to be handled) and `howMany` (how many nodes were affected) + // needs to be differentiated. + // + // This comes up when there are multiple changes that are affected by `inc` change item. + // + // For example: assume two insert changes: `{ offset: 2, howMany: 1 }` and `{ offset: 5, howMany: 1 }`. + // Assume that `inc` change is remove `{ offset: 2, howMany: 2, nodesToHandle: 2 }`. + // + // Then, we: + // - "forget" about first insert change (it is "eaten" by remove), + // - because of that, at the end we will want to remove only one node (`nodesToHandle = 1`), + // - but still we have to change offset of the second insert change from `5` to `3`! + // + // So, `howMany` does not change throughout items transformation and keeps information about how many nodes were affected, + // while `nodesToHandle` means how many nodes need to be handled after the change item is transformed by other changes. + inc.nodesToHandle = inc.howMany; for ( const old of changes ) { const incEnd = inc.offset + inc.howMany; @@ -558,8 +574,8 @@ export default class Differ { if ( inc.offset <= old.offset ) { old.offset += inc.howMany; } else if ( inc.offset < oldEnd ) { - old.howMany += inc.newHowMany; - inc.newHowMany = 0; + old.howMany += inc.nodesToHandle; + inc.nodesToHandle = 0; } } @@ -610,20 +626,20 @@ export default class Differ { old.offset = inc.offset; old.howMany -= intersectionLength; - inc.newHowMany -= intersectionLength; + inc.nodesToHandle -= intersectionLength; } else { - old.howMany -= inc.newHowMany; - inc.newHowMany = 0; + old.howMany -= inc.nodesToHandle; + inc.nodesToHandle = 0; } } else { if ( inc.offset <= old.offset ) { - inc.newHowMany -= old.howMany; + inc.nodesToHandle -= old.howMany; old.howMany = 0; } else if ( inc.offset < oldEnd ) { const intersectionLength = oldEnd - inc.offset; old.howMany -= intersectionLength; - inc.newHowMany -= intersectionLength; + inc.nodesToHandle -= intersectionLength; } } } @@ -633,9 +649,9 @@ export default class Differ { old.offset -= inc.howMany; } else if ( inc.offset < old.offset ) { old.offset = inc.offset; - old.howMany += inc.newHowMany; + old.howMany += inc.nodesToHandle; - inc.newHowMany = 0; + inc.nodesToHandle = 0; } } @@ -658,7 +674,7 @@ export default class Differ { old.howMany = inc.offset - old.offset; - const howManyAfter = howMany - old.howMany - inc.newHowMany; + const howManyAfter = howMany - old.howMany - inc.nodesToHandle; // Add the second part of attribute change to the beginning of processed array so it won't // be processed again in this loop. @@ -697,27 +713,27 @@ export default class Differ { changes.push( attributePart ); } - inc.newHowMany = old.offset - inc.offset; + inc.nodesToHandle = old.offset - inc.offset; } else if ( inc.offset >= old.offset && inc.offset < oldEnd ) { if ( incEnd > oldEnd ) { - inc.newHowMany = incEnd - oldEnd; + inc.nodesToHandle = incEnd - oldEnd; inc.offset = oldEnd; } else { - inc.newHowMany = 0; + inc.nodesToHandle = 0; } } } if ( old.type == 'attribute' ) { if ( inc.offset >= old.offset && incEnd <= oldEnd ) { - inc.newHowMany = 0; + inc.nodesToHandle = 0; } } } } - inc.howMany = inc.newHowMany; - delete inc.newHowMany; + inc.howMany = inc.nodesToHandle; + delete inc.nodesToHandle; } /** From 90459c5bc0f5069a6196277b69087011808f02df Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 20 Feb 2018 18:40:37 +0100 Subject: [PATCH 611/724] Fixed: Corrected how change items in `model.Differ` are dismissed if they are in inserted/removed parent. --- src/model/differ.js | 98 ++++++++++++++++++++++--------------------- tests/model/differ.js | 57 +++++++++++++++++++++++++ 2 files changed, 108 insertions(+), 47 deletions(-) diff --git a/src/model/differ.js b/src/model/differ.js index 520966fa1..a4abc0306 100644 --- a/src/model/differ.js +++ b/src/model/differ.js @@ -229,13 +229,6 @@ export default class Differ { // Check all changed elements. for ( const element of this._changesInElement.keys() ) { - // Each item in `this._changesInElement` describes changes of the _children_ of that element. - // If the element itself has been inserted we should skip all the changes in it because the element will be reconverted. - // If the element itself has been removed we should skip all the changes in it because they would be incorrect. - if ( this._isInsertedOrRemoved( element ) ) { - continue; - } - // Get changes for this element and sort them. const changes = this._changesInElement.get( element ).sort( ( a, b ) => { if ( a.offset === b.offset ) { @@ -394,46 +387,6 @@ export default class Differ { this._cachedChanges = null; } - /** - * Checks whether a given element is inserted or removed or one of its ancestors is inserted or removed. Used to - * filter out sub-changes in elements that are changed. - * - * @private - * @param {module:engine/model/element~Element} element An element to check. - * @returns {Boolean} - */ - _isInsertedOrRemoved( element ) { - let parent = element.parent; - - // Check all ancestors of given element. - while ( parent ) { - // Get the checked element's offset. - const offset = element.startOffset; - - if ( this._changesInElement.has( parent ) ) { - const changes = this._changesInElement.get( parent ); - - // If there were changes in that element's ancestor, check all of them. - for ( const change of changes ) { - // Skip attribute changes. We are interested only if the element was inserted or removed. - if ( change.type == 'attribute' ) { - continue; - } - - if ( change.offset <= offset && change.offset + change.howMany > offset ) { - return true; - } - } - } - - // Move up. - parent = parent.parent; - element = element.parent; - } - - return false; - } - /** * Saves and handles an insert change. * @@ -443,6 +396,10 @@ export default class Differ { * @param {Number} howMany */ _markInsert( parent, offset, howMany ) { + if ( this._isInInsertedElement( parent ) ) { + return; + } + const changeItem = { type: 'insert', offset, howMany, count: this._changeCount++ }; this._markChange( parent, changeItem ); @@ -457,9 +414,15 @@ export default class Differ { * @param {Number} howMany */ _markRemove( parent, offset, howMany ) { + if ( this._isInInsertedElement( parent ) ) { + return; + } + const changeItem = { type: 'remove', offset, howMany, count: this._changeCount++ }; this._markChange( parent, changeItem ); + + this._removeAllNestedChanges( parent, offset, howMany ); } /** @@ -469,6 +432,10 @@ export default class Differ { * @param {module:engine/model/item~Item} item */ _markAttribute( item ) { + if ( this._isInInsertedElement( item.parent ) ) { + return; + } + const changeItem = { type: 'attribute', offset: item.startOffset, howMany: item.offsetSize, count: this._changeCount++ }; this._markChange( item.parent, changeItem ); @@ -831,6 +798,43 @@ export default class Differ { return diffs; } + + _isInInsertedElement( element ) { + const parent = element.parent; + + if ( !parent ) { + return false; + } + + const changes = this._changesInElement.get( parent ); + const offset = element.startOffset; + + if ( changes ) { + for ( const change of changes ) { + if ( change.type == 'insert' && offset >= change.offset && offset < change.offset + change.howMany ) { + return true; + } + } + } + + return this._isInInsertedElement( parent ); + } + + _removeAllNestedChanges( parent, offset, howMany ) { + const range = Range.createFromParentsAndOffsets( parent, offset, parent, offset + howMany ); + + for ( const item of range.getItems( { shallow: true } ) ) { + if ( item.is( 'element' ) ) { + this._removeChangesInElement( item ); + this._removeAllNestedChanges( item, 0, item.maxOffset ); + } + } + } + + _removeChangesInElement( element ) { + this._elementSnapshots.delete( element ); + this._changesInElement.delete( element ); + } } // Returns an array that is a copy of passed child list with the exception that text nodes are split to one or more diff --git a/tests/model/differ.js b/tests/model/differ.js index d798a4059..69c81ffec 100644 --- a/tests/model/differ.js +++ b/tests/model/differ.js @@ -1193,6 +1193,63 @@ describe( 'Differ', () => { ] ); } ); } ); + + // ckeditor5#733. + it( 'proper filtering of changes in removed elements', () => { + // Before fix there was a buggy scenario described in ckeditor5#733. + // There was this structure: `foo[

te]xt

` + // On delete of above selection `image` and `paragraph` inside `blockQuote` are removed (it gets merged). + // However, since `image` was removed first, when checking if `paragraph` is in a removed element, + // it appeared that `blockQuote` looks like it is removed because it had the same path as the already removed ``. + // In a result, removing `paragraph` was discarded. + // The mistake was that the checking for removing was done at incorrect moment. + root.removeChildren( 0, root.childCount ); + root.appendChildren( [ + new Element( 'paragraph', null, new Text( 'foo' ) ), + new Element( 'image' ), + new Element( 'blockQuote', null, [ + new Element( 'paragraph', null, new Text( 'text' ) ) + ] ) + ] ); + + model.change( () => { + // Remove `"te"`. + remove( new Position( root, [ 2, 0, 0 ] ), 2 ); + // Remove `image` before `blockQuote`. + remove( new Position( root, [ 1 ] ), 1 ); + // Move `"xt"` to first `paragraph` (merging). + move( new Position( root, [ 1, 0, 0 ] ), 2, new Position( root, [ 0, 3 ] ) ); + // Remove `paragraph` inside `blockQuote`. + remove( new Position( root, [ 1, 0 ] ), 1 ); + + expectChanges( [ + { type: 'insert', name: '$text', length: 2, position: new Position( root, [ 0, 3 ] ) }, + { type: 'remove', name: 'image', length: 1, position: new Position( root, [ 1 ] ) }, + { type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 1, 0 ] ) } + ] ); + } ); + } ); + + it( 'proper filtering of changes in inserted elements', () => { + root.removeChildren( 0, root.childCount ); + root.appendChildren( new Element( 'image' ) ); + + const blockQuote = new Element( 'blockQuote', null, new Element( 'paragraph' ) ); + + model.change( () => { + // Insert `blockQuote` with `paragraph` after `image`. + insert( blockQuote, new Position( root, [ 1 ] ) ); + // Remove `image` from before `blockQuote`. + remove( new Position( root, [ 0 ] ), 1 ); + // Insert text into `paragraph` in `blockQuote`. + insert( new Text( 'foo' ), new Position( root, [ 0, 0, 0 ] ) ); + + expectChanges( [ + { type: 'remove', name: 'image', length: 1, position: new Position( root, [ 0 ] ) }, + { type: 'insert', name: 'blockQuote', length: 1, position: new Position( root, [ 0 ] ) } + ] ); + } ); + } ); } ); describe( 'getChanges()', () => { From 3b4bb2e6086d6d9759757bd13bc9e231421f7089 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Wed, 21 Feb 2018 10:44:40 +0100 Subject: [PATCH 612/724] Docs: Added docs to new methods. --- src/model/differ.js | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/src/model/differ.js b/src/model/differ.js index a4abc0306..b521fd78d 100644 --- a/src/model/differ.js +++ b/src/model/differ.js @@ -799,6 +799,13 @@ export default class Differ { return diffs; } + /** + * Checks whether given element or any of its parents is an element that is buffered as an inserted element. + * + * @private + * @param {module:engine/model/element~Element} element Element to check. + * @returns {Boolean} + */ _isInInsertedElement( element ) { const parent = element.parent; @@ -820,21 +827,27 @@ export default class Differ { return this._isInInsertedElement( parent ); } + /** + * Removes deeply all buffered changes that are registered in elements from range specified by `parent`, `offset` + * and `howMany`. + * + * @private + * @param {module:engine/model/element~Element} parent + * @param {Number} offset + * @param {Number} howMany + */ _removeAllNestedChanges( parent, offset, howMany ) { const range = Range.createFromParentsAndOffsets( parent, offset, parent, offset + howMany ); for ( const item of range.getItems( { shallow: true } ) ) { if ( item.is( 'element' ) ) { - this._removeChangesInElement( item ); + this._elementSnapshots.delete( item ); + this._changesInElement.delete( item ); + this._removeAllNestedChanges( item, 0, item.maxOffset ); } } } - - _removeChangesInElement( element ) { - this._elementSnapshots.delete( element ); - this._changesInElement.delete( element ); - } } // Returns an array that is a copy of passed child list with the exception that text nodes are split to one or more From ab66417852e5c9b758d6d24d7b2c1cfebb59917f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 21 Feb 2018 15:28:35 +0100 Subject: [PATCH 613/724] New change block for changes made in render event listeners. --- src/view/placeholder.js | 32 +++++++++----- src/view/view.js | 97 ++++++++++++++--------------------------- tests/view/view/view.js | 76 ++++++++++++++++++++------------ 3 files changed, 102 insertions(+), 103 deletions(-) diff --git a/src/view/placeholder.js b/src/view/placeholder.js index a4793098c..2a3da6b33 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -103,9 +103,11 @@ function updateSinglePlaceholder( view, element, checkFunction ) { // If checkFunction is provided and returns false - remove placeholder. if ( checkFunction && !checkFunction() ) { - view.change( writer => { - writer.removeClass( 'ck-placeholder', element ); - } ); + if ( element.hasClass( 'ck-placeholder' ) ) { + view.change( writer => { + writer.removeClass( 'ck-placeholder', element ); + } ); + } return; } @@ -116,21 +118,27 @@ function updateSinglePlaceholder( view, element, checkFunction ) { // If element is empty and editor is blurred. if ( !document.isFocused && isEmptyish ) { - view.change( writer => { - writer.addClass( 'ck-placeholder', element ); - } ); + if ( !element.hasClass( 'ck-placeholder' ) ) { + view.change( writer => { + writer.addClass( 'ck-placeholder', element ); + } ); + } return; } // It there are no child elements and selection is not placed inside element. if ( isEmptyish && anchor && anchor.parent !== element ) { - view.change( writer => { - writer.addClass( 'ck-placeholder', element ); - } ); + if ( !element.hasClass( 'ck-placeholder' ) ) { + view.change( writer => { + writer.addClass( 'ck-placeholder', element ); + } ); + } } else { - view.change( writer => { - writer.removeClass( 'ck-placeholder', element ); - } ); + if ( element.hasClass( 'ck-placeholder' ) ) { + view.change( writer => { + writer.removeClass( 'ck-placeholder', element ); + } ); + } } } diff --git a/src/view/view.js b/src/view/view.js index 26a07de60..f2c122630 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -24,7 +24,6 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix'; import { scrollViewportToShowTarget } from '@ckeditor/ckeditor5-utils/src/dom/scroll'; import { injectUiElementHandling } from './uielement'; import { injectQuirksHandling } from './filler'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Editor's view controller class. Its main responsibility is DOM - View management for editing purposes, to provide @@ -108,16 +107,8 @@ export default class View { */ this._ongoingChange = false; - /** - * Is set to `true` when rendering view to DOM is in progress. - * This is used to check whether view document can accept changes in current state. - * From the moment when rendering to DOM is stared view tree is locked to prevent changes that will not be - * reflected in the DOM. - * - * @private - * @member {Boolean} module:engine/view/view~View#_renderingInProgress - */ - this._renderingInProgress = false; + this._renderingEventProcessing = false; + this._callbacksWaiting = []; /** * Writer instance used in {@link #change change method) callbacks. @@ -303,26 +294,47 @@ export default class View { * * Change block is executed immediately. * - * When the outermost change block is done it fires + * When the outermost change block is done and rendering to DOM is over it fires * {@link module:engine/view/view~View#event:render} event. * * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `applying-view-changes-on-rendering` when - * change block is used when rendering to DOM is in progress. + * change block is used after rendering to DOM has started. * * @param {Function} callback Callback function which may modify the view. */ change( callback ) { - // Check if change is performed in correct moment. - this._assertRenderingInProgress(); + // When "render" event is processed all callbacks need to wait until processing of that event is complete. + // Those callbacks will be processed later and create separate "render" event. + if ( this._renderingEventProcessing ) { + this._callbacksWaiting.push( callback ); + return; + } - // If other changes are in progress wait with rendering until every ongoing change is over. + // Recursive call to view.change() method - execute listener immediately. if ( this._ongoingChange ) { callback( this._writer ); } else { + // This lock will assure that all recursive calls to view.change() will end up in same block - one "render" + // event for all nested calls. this._ongoingChange = true; - callback( this._writer ); + this._ongoingChange = false; + + // This lock will assure that all view.change() calls in listeners will wait until all callbacks are processed + // and will create separate "render" event. + this._renderingEventProcessing = true; this.fire( 'render' ); + this._renderingEventProcessing = false; + + // Call waiting callbacks that were called during `render` event. + if ( this._callbacksWaiting.length ) { + const callbacks = this._callbacksWaiting; + this._callbacksWaiting = []; + + while ( callbacks.length ) { + this.change( callbacks.shift() ); + } + } } } @@ -334,14 +346,7 @@ export default class View { * trying to re-render when rendering to DOM has already started. */ render() { - // Check if rendering is performed in correct moment. - this._assertRenderingInProgress(); - - // Render only if no ongoing changes are in progress. If there are some, view document will be rendered after all - // changes are done. This way view document will not be rendered in the middle of some changes. - if ( !this._ongoingChange ) { - this.change( () => {} ); - } + this.change( () => {} ); } /** @@ -362,55 +367,19 @@ export default class View { * @private */ _render() { - this._renderingInProgress = true; - this.disableObservers(); this._renderer.render(); this.enableObservers(); - - // Current ongoing change is finished after rendering is done. - // Further render() or change() calls will create new ongoing change. - this._ongoingChange = false; - this._renderingInProgress = false; - } - - /** - * Throws `applying-view-changes-on-rendering` error when trying to modify or re-render view tree when rendering is - * already started - * - * @private - */ - _assertRenderingInProgress() { - if ( this._renderingInProgress ) { - /** - * There is an attempt to make changes in the view tree when the rendering process is in progress. - * This may cause unexpected behaviour and inconsistency between the DOM and the view. - * This may be caused by calling `view.change()` or `view.render()` methods during rendering process. - * - * @error applying-view-changes-on-rendering - */ - throw new CKEditorError( - 'applying-view-changes-on-rendering: ' + - 'Attempting to make changes in the view during rendering process. ' + - 'This may cause some unexpected behaviour and inconsistency between the DOM and the view.' - ); - } } /** - * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished. + * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished and the DOM rendering has + * been executed. * - * Actual rendering is performed on 'low' priority. This means that all listeners on 'normal' and higher priorities + * Actual rendering is performed on 'low' priority. This means that all listeners on 'normal' and above priorities * will be executed after changes made to view tree but before rendering to the DOM. Use `low` priority for callbacks that * should be executed after rendering to the DOM. * - * When listener on `normal` (or higher) priority call {@link module:engine/view/view~View#change change()} or - * {@link module:engine/view/view~View#render render()} it will be included in currently executed change block (no - * more `render` events will be fired). - * - * When listener on `low` (or lower) priority calls {@link module:engine/view/view~View#change change()} or - * {@link module:engine/view/view~View#render render()} it will create a new change block (new `render` event will be fired). - * * @event module:engine/view/view~View#event:render */ } diff --git a/tests/view/view/view.js b/tests/view/view/view.js index 9a0abe58b..fd7839329 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -18,7 +18,6 @@ import ViewElement from '../../../src/view/element'; import ViewPosition from '../../../src/view/position'; import { isBlockFiller, BR_FILLER } from '../../../src/view/filler'; import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; -import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'view', () => { const DEFAULT_OBSERVERS_COUNT = 5; @@ -502,19 +501,22 @@ describe( 'view', () => { sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); } ); - it( 'should throw when someone tries to change view during rendering', () => { + it( 'should create separate change block if view.change() is called during "render" event', () => { const domDiv = document.createElement( 'div' ); const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); - let renderingCalled = false; view.attachDomRoot( domDiv ); + const renderingEndSpy = sinon.spy(); + view.on( 'render', renderingEndSpy, { priority: 'lowest' } ); + + const nestedChange = sinon.spy(); + view.change( writer => { const p = writer.createContainerElement( 'p' ); const ui = writer.createUIElement( 'span', null, function( domDocument ) { const element = this.toDomElement( domDocument ); - expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); - renderingCalled = true; + view.change( nestedChange ); return element; } ); @@ -522,23 +524,25 @@ describe( 'view', () => { writer.insert( ViewPosition.createAt( viewRoot ), p ); } ); - expect( renderingCalled ).to.be.true; + sinon.assert.calledTwice( renderingEndSpy ); + sinon.assert.callOrder( renderingEndSpy, nestedChange ); domDiv.remove(); } ); - it( 'should throw when someone tries to call render() during rendering', () => { + it( 'should create separate change block if view.render() is called during "render" event', () => { const domDiv = document.createElement( 'div' ); const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); - let renderingCalled = false; view.attachDomRoot( domDiv ); + const renderingEndSpy = sinon.spy(); + view.on( 'render', renderingEndSpy, { priority: 'lowest' } ); + view.change( writer => { const p = writer.createContainerElement( 'p' ); const ui = writer.createUIElement( 'span', null, function( domDocument ) { const element = this.toDomElement( domDocument ); - expect( () => view.render() ).to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); - renderingCalled = true; + view.render(); return element; } ); @@ -546,7 +550,7 @@ describe( 'view', () => { writer.insert( ViewPosition.createAt( viewRoot ), p ); } ); - expect( renderingCalled ).to.be.true; + sinon.assert.calledTwice( renderingEndSpy ); domDiv.remove(); } ); @@ -567,6 +571,23 @@ describe( 'view', () => { sinon.assert.calledTwice( spy ); } ); + it( 'should create separate render event when change() called on high priority', () => { + let called = false; + + const spy = sinon.spy( () => { + // Prevent infinite loop. + if ( !called ) { + called = true; + view.change( () => {} ); + } + } ); + + view.on( 'render', spy, { priority: 'high' } ); + + view.change( () => {} ); + sinon.assert.calledTwice( spy ); + } ); + it( 'should create separate render event when render() called on low priority', () => { let called = false; @@ -584,6 +605,23 @@ describe( 'view', () => { sinon.assert.calledTwice( spy ); } ); + it( 'should create separate render event when render() called on high priority', () => { + let called = false; + + const spy = sinon.spy( () => { + // Prevent infinite loop. + if ( !called ) { + called = true; + view.render(); + } + } ); + + view.on( 'render', spy, { priority: 'high' } ); + + view.render(); + sinon.assert.calledTwice( spy ); + } ); + it( 'should call second render after the first is done', () => { let called = false; const order = []; @@ -613,22 +651,6 @@ describe( 'view', () => { expect( order ).to.deep.equal( [ 'low1', 'low2', 'lowest', 'low1', 'low2', 'lowest' ] ); } ); - - it( 'should NOT throw when someone tries to call change() before rendering', () => { - view.on( 'render', () => { - expect( () => view.change( () => {} ) ).not.to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); - }, { priority: 'normal' } ); - - view.change( () => {} ); - } ); - - it( 'should NOT throw when someone tries to call render() before rendering', () => { - view.on( 'render', () => { - expect( () => view.render() ).not.to.throw( CKEditorError, /^applying-view-changes-on-rendering/ ); - }, { priority: 'normal' } ); - - view.change( () => {} ); - } ); } ); } ); From 03d76d1f89b94633d534172c74db622cd43a60e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 22 Feb 2018 08:40:24 +0100 Subject: [PATCH 614/724] Fix: Registered `$marker` element as an allowed `$root` and `$block` child. --- src/model/model.js | 8 +++++++ tests/conversion/upcast-converters.js | 31 +++++++++++++++++++-------- tests/model/model.js | 6 ++++++ 3 files changed, 36 insertions(+), 9 deletions(-) diff --git a/src/model/model.js b/src/model/model.js index 5655415b4..86cfb6175 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -105,6 +105,14 @@ export default class Model { isLimit: true } ); this.schema.extend( '$text', { allowIn: '$clipboardHolder' } ); + + // Element needed by `upcastElementToMarker` converter. + // This element temporarily represents marker bound during conversion process and is removed + // at the end of conversion. `UpcastDispatcher` or at least `Conversion` class looks like a better for this + // registration but both know nothing about Schema. + this.schema.register( '$marker', { + allowIn: [ '$root', '$block' ] + } ); } /** diff --git a/tests/conversion/upcast-converters.js b/tests/conversion/upcast-converters.js index a6f1379de..391d9c83d 100644 --- a/tests/conversion/upcast-converters.js +++ b/tests/conversion/upcast-converters.js @@ -35,21 +35,14 @@ describe( 'upcast-helpers', () => { schema = model.schema; schema.extend( '$text', { - allowIn: '$root' - } ); - - schema.register( '$marker', { - inheritAllFrom: '$block' + allowIn: '$root', + allowAttributes: [ 'bold' ] } ); schema.register( 'paragraph', { inheritAllFrom: '$block' } ); - schema.extend( '$text', { - allowAttributes: [ 'bold' ] - } ); - upcastDispatcher = new UpcastDispatcher( { schema } ); upcastDispatcher.on( 'text', convertText() ); upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); @@ -580,6 +573,26 @@ describe( 'upcast-helpers', () => { expectResult( frag, 'foobar', marker ); } ); + + it( 'marker is in a block element', () => { + conversion.for( 'upcast' ).add( upcastElementToElement( { model: 'paragraph', view: 'p' } ) ); + + const helper = upcastElementToMarker( { view: 'marker-search', model: 'search' } ); + + conversion.for( 'upcast' ).add( helper ); + + const element = new ViewContainerElement( 'p', null, [ + new ViewText( 'fo' ), + new ViewUIElement( 'marker-search' ), + new ViewText( 'oba' ), + new ViewUIElement( 'marker-search' ), + new ViewText( 'r' ) + ] ); + + const marker = { name: 'search', start: [ 0, 2 ], end: [ 0, 5 ] }; + + expectResult( element, 'foobar', marker ); + } ); } ); function expectResult( viewToConvert, modelString, marker ) { diff --git a/tests/model/model.js b/tests/model/model.js index 9c7d77dca..03359a31c 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -50,6 +50,12 @@ describe( 'Model', () => { expect( schema.checkChild( [ '$clipboardHolder' ], '$text' ) ).to.be.true; expect( schema.checkChild( [ '$clipboardHolder' ], '$block' ) ).to.be.true; } ); + + it( 'registers $marker to the schema', () => { + expect( schema.isRegistered( '$marker' ) ).to.be.true; + expect( schema.checkChild( [ '$root' ], '$marker' ), 1 ).to.be.true; + expect( schema.checkChild( [ '$block' ], '$marker' ), 1 ).to.be.true; + } ); } ); describe( 'change() & enqueueChange()', () => { From 2ed35b92375fd9abe74c00f7cb520c523bb9661b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 22 Feb 2018 08:41:43 +0100 Subject: [PATCH 615/724] Tests: Fixed not working manual test. --- tests/manual/highlight.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tests/manual/highlight.js b/tests/manual/highlight.js index 5718633b9..9a09cd3a3 100644 --- a/tests/manual/highlight.js +++ b/tests/manual/highlight.js @@ -49,8 +49,7 @@ class FancyWidget extends Plugin { conversion.for( 'editingDowncast' ).add( downcastElementToElement( { model: 'fancywidget', - view: ( modelItem, conversionApi ) => { - const viewWriter = conversionApi.writer; + view: ( modelItem, viewWriter ) => { const widgetElement = viewWriter.createContainerElement( 'figure', { class: 'fancy-widget' } ); viewWriter.insert( ViewPosition.createAt( widgetElement ), viewWriter.createText( 'widget' ) ); From a5b2a49107f929cd7007130a03f8045130ccdaae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 22 Feb 2018 16:40:21 +0100 Subject: [PATCH 616/724] Added postfixers to view. --- src/view/document.js | 67 ++++++++ src/view/placeholder.js | 78 +++++---- src/view/view.js | 70 ++++---- tests/view/observer/focusobserver.js | 8 +- tests/view/view/view.js | 245 ++++++++------------------- 5 files changed, 216 insertions(+), 252 deletions(-) diff --git a/src/view/document.js b/src/view/document.js index 8525f11f4..cb2d2c614 100644 --- a/src/view/document.js +++ b/src/view/document.js @@ -65,6 +65,14 @@ export default class Document { * @member {Boolean} module:engine/view/document~Document#isFocused */ this.set( 'isFocused', false ); + + /** + * Post-fixer callbacks registered to the model document. + * + * @private + * @member {Set} + */ + this._postFixers = new Set(); } /** @@ -78,6 +86,65 @@ export default class Document { getRoot( name = 'main' ) { return this.roots.get( name ); } + + /** + * TODO: update docs + * Used to register a post-fixer callback. A post-fixer mechanism guarantees that the features that listen to + * the {@link module:engine/model/model~Model#event:_change model's change event} will operate on a correct model state. + * + * An execution of a feature may lead to an incorrect document tree state. The callbacks are used to fix the document tree after + * it has changed. Post-fixers are fired just after all changes from the outermost change block were applied but + * before the {@link module:engine/model/document~Document#event:change change event} is fired. If a post-fixer callback made + * a change, it should return `true`. When this happens, all post-fixers are fired again to check if something else should + * not be fixed in the new document tree state. + * + * As a parameter, a post-fixer callback receives a {@link module:engine/model/writer~Writer writer} instance connected with the + * executed changes block. Thanks to that, all changes done by the callback will be added to the same + * {@link module:engine/model/batch~Batch batch} (and undo step) as the original changes. This makes post-fixer changes transparent + * for the user. + * + * An example of a post-fixer is a callback that checks if all the data were removed from the editor. If so, the + * callback should add an empty paragraph so that the editor is never empty: + * + * document.registerPostFixer( writer => { + * const changes = document.differ.getChanges(); + * + * // Check if the changes lead to an empty root in the editor. + * for ( const entry of changes ) { + * if ( entry.type == 'remove' && entry.position.root.isEmpty ) { + * writer.insertElement( 'paragraph', entry.position.root, 0 ); + * + * // It is fine to return early, even if multiple roots would need to be fixed. + * // All post-fixers will be fired again, so if there are more empty roots, those will be fixed, too. + * return true; + * } + * } + * } ); + * + * @param {Function} postFixer + */ + registerPostFixer( postFixer ) { + this._postFixers.add( postFixer ); + } + + /** + * Performs post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model. + * + * @protected + */ + _callPostFixers( writer ) { + let wasFixed = false; + + do { + for ( const callback of this._postFixers ) { + wasFixed = callback( writer ); + + if ( wasFixed ) { + break; + } + } + } while ( wasFixed ); + } } mix( Document, ObservableMixin ); diff --git a/src/view/placeholder.js b/src/view/placeholder.js index 2a3da6b33..fca5d987b 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -7,13 +7,8 @@ * @module engine/view/placeholder */ -import extend from '@ckeditor/ckeditor5-utils/src/lib/lodash/extend'; -import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import '../../theme/placeholder.css'; -const listener = {}; -extend( listener, EmitterMixin ); - // Each document stores information about its placeholder elements and check functions. const documentPlaceholders = new WeakMap(); @@ -29,28 +24,19 @@ const documentPlaceholders = new WeakMap(); export function attachPlaceholder( view, element, placeholderText, checkFunction ) { const document = view.document; - // Detach placeholder if was used before. - detachPlaceholder( view, element ); - // Single listener per document. if ( !documentPlaceholders.has( document ) ) { documentPlaceholders.set( document, new Map() ); - // Attach listener just before rendering and update placeholders. - listener.listenTo( view, 'render', () => updateAllPlaceholders( view ) ); + // Create view post fixer that will add placeholder where needed. + document.registerPostFixer( writer => updateAllPlaceholders( document, writer ) ); } - // Store text in element's data attribute. - // This data attribute is used in CSS class to show the placeholder. - view.change( writer => { - writer.setAttribute( 'data-placeholder', placeholderText, element ); - } ); - - // Store information about placeholder. - documentPlaceholders.get( document ).set( element, checkFunction ); + // Store information about element with placeholder. + documentPlaceholders.get( document ).set( element, { placeholderText, checkFunction } ); - // Update right away too. - updateSinglePlaceholder( view, element, checkFunction ); + // Update view right away. + view.render(); } /** @@ -76,12 +62,17 @@ export function detachPlaceholder( view, element ) { // // @private // @param {module:engine/view/view~View} view -function updateAllPlaceholders( view ) { - const placeholders = documentPlaceholders.get( view.document ); +function updateAllPlaceholders( document, writer ) { + const placeholders = documentPlaceholders.get( document ); + let changed = false; - for ( const [ element, checkFunction ] of placeholders ) { - updateSinglePlaceholder( view, element, checkFunction ); + for ( const [ element, info ] of placeholders ) { + if ( updateSinglePlaceholder( writer, element, info ) ) { + changed = true; + } } + + return changed; } // Updates placeholder class of given element. @@ -90,26 +81,34 @@ function updateAllPlaceholders( view ) { // @param {module:engine/view/view~View} view // @param {module:engine/view/element~Element} element // @param {Function} checkFunction -function updateSinglePlaceholder( view, element, checkFunction ) { +function updateSinglePlaceholder( writer, element, info ) { const document = element.document; + const text = info.placeholderText; + let changed = false; // Element was removed from document. if ( !document ) { - return; + return false; + } + + // Update data attribute if needed. + if ( element.getAttribute( 'data-placeholder' ) !== text ) { + writer.setAttribute( 'data-placeholder', text, element ); + changed = true; } const viewSelection = document.selection; const anchor = viewSelection.anchor; + const checkFunction = info.checkFunction; // If checkFunction is provided and returns false - remove placeholder. if ( checkFunction && !checkFunction() ) { if ( element.hasClass( 'ck-placeholder' ) ) { - view.change( writer => { - writer.removeClass( 'ck-placeholder', element ); - } ); + writer.removeClass( 'ck-placeholder', element ); + changed = true; } - return; + return changed; } // Element is empty for placeholder purposes when it has no children or only ui elements. @@ -119,26 +118,25 @@ function updateSinglePlaceholder( view, element, checkFunction ) { // If element is empty and editor is blurred. if ( !document.isFocused && isEmptyish ) { if ( !element.hasClass( 'ck-placeholder' ) ) { - view.change( writer => { - writer.addClass( 'ck-placeholder', element ); - } ); + writer.addClass( 'ck-placeholder', element ); + changed = true; } - return; + return changed; } // It there are no child elements and selection is not placed inside element. if ( isEmptyish && anchor && anchor.parent !== element ) { if ( !element.hasClass( 'ck-placeholder' ) ) { - view.change( writer => { - writer.addClass( 'ck-placeholder', element ); - } ); + writer.addClass( 'ck-placeholder', element ); + changed = true; } } else { if ( element.hasClass( 'ck-placeholder' ) ) { - view.change( writer => { - writer.removeClass( 'ck-placeholder', element ); - } ); + writer.removeClass( 'ck-placeholder', element ); + changed = true; } } + + return changed; } diff --git a/src/view/view.js b/src/view/view.js index f2c122630..fd1e974f8 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -24,6 +24,7 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix'; import { scrollViewportToShowTarget } from '@ckeditor/ckeditor5-utils/src/dom/scroll'; import { injectUiElementHandling } from './uielement'; import { injectQuirksHandling } from './filler'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; /** * Editor's view controller class. Its main responsibility is DOM - View management for editing purposes, to provide @@ -107,8 +108,21 @@ export default class View { */ this._ongoingChange = false; - this._renderingEventProcessing = false; - this._callbacksWaiting = []; + /** + * Used to prevent calling {@link #render} and {@link #change) during rendering view to the DOM. + * + * @private + * @member {Boolean} module:engine/view/view~View#_renderingInProgress + */ + this._renderingInProgress = false; + + /** + * Used to prevent calling {@link #render} and {@link #change) during rendering view to the DOM. + * + * @private + * @member {Boolean} module:engine/view/view~View#_renderingInProgress + */ + this._postFixersInProgress = false; /** * Writer instance used in {@link #change change method) callbacks. @@ -129,10 +143,10 @@ export default class View { injectQuirksHandling( this ); injectUiElementHandling( this ); - // Use 'low` priority so that all listeners on 'normal` priority will be executed before. + // Use 'normal' priority so that rendering is performed as first when using that priority. this.on( 'render', () => { this._render(); - }, { priority: 'low' } ); + } ); } /** @@ -303,39 +317,30 @@ export default class View { * @param {Function} callback Callback function which may modify the view. */ change( callback ) { - // When "render" event is processed all callbacks need to wait until processing of that event is complete. - // Those callbacks will be processed later and create separate "render" event. - if ( this._renderingEventProcessing ) { - this._callbacksWaiting.push( callback ); - return; + if ( this._renderingInProgress || this._postFixersInProgress ) { + // TODO: better description + throw new CKEditorError( 'incorrect-view-change' ); } // Recursive call to view.change() method - execute listener immediately. if ( this._ongoingChange ) { callback( this._writer ); - } else { - // This lock will assure that all recursive calls to view.change() will end up in same block - one "render" - // event for all nested calls. - this._ongoingChange = true; - callback( this._writer ); - this._ongoingChange = false; - - // This lock will assure that all view.change() calls in listeners will wait until all callbacks are processed - // and will create separate "render" event. - this._renderingEventProcessing = true; - this.fire( 'render' ); - this._renderingEventProcessing = false; - - // Call waiting callbacks that were called during `render` event. - if ( this._callbacksWaiting.length ) { - const callbacks = this._callbacksWaiting; - this._callbacksWaiting = []; - - while ( callbacks.length ) { - this.change( callbacks.shift() ); - } - } + + return; } + + // This lock will assure that all recursive calls to view.change() will end up in same block - one "render" + // event for all nested calls. + this._ongoingChange = true; + callback( this._writer ); + this._ongoingChange = false; + + // Execute all document post fixers after the change. + this._postFixersInProgress = true; + this.document._callPostFixers( this._writer ); + this._postFixersInProgress = false; + + this.fire( 'render' ); } /** @@ -367,12 +372,15 @@ export default class View { * @private */ _render() { + this._renderingInProgress = true; this.disableObservers(); this._renderer.render(); this.enableObservers(); + this._renderingInProgress = false; } /** + * TODO: fix description * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished and the DOM rendering has * been executed. * diff --git a/tests/view/observer/focusobserver.js b/tests/view/observer/focusobserver.js index 06d65bdc1..30b1f1379 100644 --- a/tests/view/observer/focusobserver.js +++ b/tests/view/observer/focusobserver.js @@ -170,12 +170,12 @@ describe( 'FocusObserver', () => { view.render(); viewDocument.on( 'selectionChange', selectionChangeSpy ); - view.on( 'render', renderSpy, { priority: 'low' } ); + view.on( 'render', renderSpy ); view.on( 'render', () => { sinon.assert.callOrder( selectionChangeSpy, renderSpy ); done(); - }, { priority: 'low' } ); + } ); // Mock selectionchange event after focus event. Render called by focus observer should be fired after // async selection change. @@ -192,14 +192,14 @@ describe( 'FocusObserver', () => { const domEditable = domRoot.childNodes[ 0 ]; viewDocument.on( 'selectionChange', selectionChangeSpy ); - view.on( 'render', renderSpy, { priority: 'low' } ); + view.on( 'render', renderSpy ); view.on( 'render', () => { sinon.assert.notCalled( selectionChangeSpy ); sinon.assert.called( renderSpy ); done(); - }, { priority: 'low' } ); + } ); observer.onDomEvent( { type: 'focus', target: domEditable } ); } ); diff --git a/tests/view/view/view.js b/tests/view/view/view.js index fd7839329..666f04547 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -15,7 +15,6 @@ import global from '@ckeditor/ckeditor5-utils/src/dom/global'; import ViewRange from '../../../src/view/range'; import RootEditableElement from '../../../src/view/rooteditableelement'; import ViewElement from '../../../src/view/element'; -import ViewPosition from '../../../src/view/position'; import { isBlockFiller, BR_FILLER } from '../../../src/view/filler'; import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; @@ -441,216 +440,108 @@ describe( 'view', () => { view.destroy(); domRoot.remove(); } ); + } ); - describe( 'change()', () => { - it( 'should fire render event and it should trigger rendering on low priority', () => { - const renderSpy = sinon.spy( view._renderer, 'render' ); - const beforeSpy = sinon.spy(); - const afterSpy = sinon.spy(); + describe( 'change()', () => { + it( 'should fire render event and it should trigger rendering before listeners on normal priority', () => { + const renderSpy = sinon.spy( view._renderer, 'render' ); + const eventSpy = sinon.spy(); - view.on( 'render', beforeSpy ); - view.on( 'render', afterSpy, { priority: 'low' } ); + view.on( 'render', eventSpy ); - view.change( () => {} ); + view.change( () => {} ); - sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); - } ); + sinon.assert.callOrder( renderSpy, eventSpy ); + } ); - it( 'should fire render event once for nested change blocks', () => { - const renderSpy = sinon.spy( view._renderer, 'render' ); - const beforeSpy = sinon.spy(); - const afterSpy = sinon.spy(); + it( 'should fire render event once for nested change blocks', () => { + const renderSpy = sinon.spy( view._renderer, 'render' ); + const eventSpy = sinon.spy(); - view.on( 'render', beforeSpy ); - view.on( 'render', afterSpy, { priority: 'low' } ); + view.on( 'render', eventSpy ); + view.change( () => { + view.change( () => {} ); view.change( () => { view.change( () => {} ); - view.change( () => { - view.change( () => {} ); - view.change( () => {} ); - } ); view.change( () => {} ); } ); - - sinon.assert.calledOnce( beforeSpy ); - sinon.assert.calledOnce( renderSpy ); - sinon.assert.calledOnce( afterSpy ); - sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); + view.change( () => {} ); } ); - it( 'should fire render event once even if render is called during the change', () => { - const renderSpy = sinon.spy( view._renderer, 'render' ); - const beforeSpy = sinon.spy(); - const afterSpy = sinon.spy(); + sinon.assert.calledOnce( renderSpy ); + sinon.assert.calledOnce( eventSpy ); + sinon.assert.callOrder( renderSpy, eventSpy ); + } ); - view.on( 'render', beforeSpy ); - view.on( 'render', afterSpy, { priority: 'low' } ); + it( 'should fire render event once even if render is called during the change', () => { + const renderSpy = sinon.spy( view._renderer, 'render' ); + const eventSpy = sinon.spy(); + view.on( 'render', eventSpy ); + + view.change( () => { + view.render(); view.change( () => { view.render(); - view.change( () => { - view.render(); - } ); - view.render(); } ); - - sinon.assert.calledOnce( beforeSpy ); - sinon.assert.calledOnce( renderSpy ); - sinon.assert.calledOnce( afterSpy ); - sinon.assert.callOrder( beforeSpy, renderSpy, afterSpy ); - } ); - - it( 'should create separate change block if view.change() is called during "render" event', () => { - const domDiv = document.createElement( 'div' ); - const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); - view.attachDomRoot( domDiv ); - - const renderingEndSpy = sinon.spy(); - view.on( 'render', renderingEndSpy, { priority: 'lowest' } ); - - const nestedChange = sinon.spy(); - - view.change( writer => { - const p = writer.createContainerElement( 'p' ); - const ui = writer.createUIElement( 'span', null, function( domDocument ) { - const element = this.toDomElement( domDocument ); - - view.change( nestedChange ); - - return element; - } ); - writer.insert( ViewPosition.createAt( p ), ui ); - writer.insert( ViewPosition.createAt( viewRoot ), p ); - } ); - - sinon.assert.calledTwice( renderingEndSpy ); - sinon.assert.callOrder( renderingEndSpy, nestedChange ); - domDiv.remove(); - } ); - - it( 'should create separate change block if view.render() is called during "render" event', () => { - const domDiv = document.createElement( 'div' ); - const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); - view.attachDomRoot( domDiv ); - - const renderingEndSpy = sinon.spy(); - view.on( 'render', renderingEndSpy, { priority: 'lowest' } ); - - view.change( writer => { - const p = writer.createContainerElement( 'p' ); - const ui = writer.createUIElement( 'span', null, function( domDocument ) { - const element = this.toDomElement( domDocument ); - - view.render(); - - return element; - } ); - writer.insert( ViewPosition.createAt( p ), ui ); - writer.insert( ViewPosition.createAt( viewRoot ), p ); - } ); - - sinon.assert.calledTwice( renderingEndSpy ); - domDiv.remove(); - } ); - - it( 'should create separate render event when change() called on low priority', () => { - let called = false; - - const spy = sinon.spy( () => { - // Prevent infinite loop. - if ( !called ) { - called = true; - view.change( () => {} ); - } - } ); - - view.on( 'render', spy, { priority: 'low' } ); - - view.change( () => {} ); - sinon.assert.calledTwice( spy ); + view.render(); } ); - it( 'should create separate render event when change() called on high priority', () => { - let called = false; + sinon.assert.calledOnce( renderSpy ); + sinon.assert.calledOnce( eventSpy ); + sinon.assert.callOrder( renderSpy, eventSpy ); + } ); - const spy = sinon.spy( () => { - // Prevent infinite loop. - if ( !called ) { - called = true; - view.change( () => {} ); - } - } ); + it( 'should call post fixers after change but before rendering', () => { + const postFixer1 = sinon.spy( () => false ); + const postFixer2 = sinon.spy( () => false ); + const changeSpy = sinon.spy(); + const eventSpy = sinon.spy(); - view.on( 'render', spy, { priority: 'high' } ); + viewDocument.registerPostFixer( postFixer1 ); + viewDocument.registerPostFixer( postFixer2 ); + view.on( 'render', eventSpy ); - view.change( () => {} ); - sinon.assert.calledTwice( spy ); - } ); - - it( 'should create separate render event when render() called on low priority', () => { - let called = false; + view.change( changeSpy ); - const spy = sinon.spy( () => { - // Prevent infinite loop. - if ( !called ) { - called = true; - view.render(); - } - } ); + sinon.assert.calledOnce( postFixer1 ); + sinon.assert.calledOnce( postFixer2 ); + sinon.assert.calledOnce( changeSpy ); + sinon.assert.calledOnce( eventSpy ); - view.on( 'render', spy, { priority: 'low' } ); + sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy ); + } ); - view.render(); - sinon.assert.calledTwice( spy ); - } ); + it( 'should call post fixers until all are done', () => { + let called = false; + const postFixer1 = sinon.spy(); + const postFixer2 = sinon.spy(); + const changeSpy = sinon.spy(); + const eventSpy = sinon.spy(); - it( 'should create separate render event when render() called on high priority', () => { - let called = false; + viewDocument.registerPostFixer( () => { + if ( !called ) { + called = true; + postFixer1(); - const spy = sinon.spy( () => { - // Prevent infinite loop. - if ( !called ) { - called = true; - view.render(); - } - } ); + return true; + } - view.on( 'render', spy, { priority: 'high' } ); + postFixer2(); - view.render(); - sinon.assert.calledTwice( spy ); + return false; } ); + view.on( 'render', eventSpy ); - it( 'should call second render after the first is done', () => { - let called = false; - const order = []; - - const lowSpy = sinon.spy( () => { - order.push( 'low1' ); - - // Prevent infinite loop. - if ( !called ) { - called = true; - view.render(); - } + view.change( changeSpy ); - order.push( 'low2' ); - } ); - - const lowestSpy = sinon.spy( () => { - order.push( 'lowest' ); - } ); - - view.on( 'render', lowSpy, { priority: 'low' } ); - view.on( 'render', lowestSpy, { priority: 'lowest' } ); + sinon.assert.calledOnce( postFixer1 ); + sinon.assert.calledOnce( postFixer2 ); + sinon.assert.calledOnce( changeSpy ); + sinon.assert.calledOnce( eventSpy ); - view.render(); - sinon.assert.calledTwice( lowSpy ); - sinon.assert.calledTwice( lowestSpy ); - - expect( order ).to.deep.equal( [ 'low1', 'low2', 'lowest', 'low1', 'low2', 'lowest' ] ); - } ); + sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy ); } ); } ); From a55e3ee181fefac4ffa2d36587ce38cc011b8a43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 13 Feb 2018 15:24:12 +0100 Subject: [PATCH 617/724] Tests: Set proper metod names. --- tests/model/documentselection.js | 84 ++++++++++++++++---------------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index c19b6afa1..1df3880d5 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -199,17 +199,6 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'setTo - set collapsed at', () => { - it( 'detaches all existing ranges', () => { - selection._setTo( [ range, liveRange ] ); - - const spy = testUtils.sinon.spy( LiveRange.prototype, 'detach' ); - selection._setTo( root ); - - expect( spy.calledTwice ).to.be.true; - } ); - } ); - describe( 'destroy()', () => { it( 'should unbind all events', () => { selection._setTo( [ range, liveRange ] ); @@ -229,7 +218,45 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'setFocus()', () => { + describe( 'getFirstRange()', () => { + it( 'should return default range if no ranges were added', () => { + const firstRange = selection.getFirstRange(); + + expect( firstRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) ); + expect( firstRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) ); + } ); + } ); + + describe( 'getLastRange()', () => { + it( 'should return default range if no ranges were added', () => { + const lastRange = selection.getLastRange(); + + expect( lastRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) ); + expect( lastRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) ); + } ); + } ); + + describe( 'getSelectedElement()', () => { + it( 'should return selected element', () => { + selection._setTo( liveRange ); + const p = root.getChild( 0 ); + + expect( selection.getSelectedElement() ).to.equal( p ); + } ); + } ); + + describe( '_setTo() - set collapsed at', () => { + it( 'detaches all existing ranges', () => { + selection._setTo( [ range, liveRange ] ); + + const spy = testUtils.sinon.spy( LiveRange.prototype, 'detach' ); + selection._setTo( root ); + + expect( spy.calledTwice ).to.be.true; + } ); + } ); + + describe( '_setFocus()', () => { it( 'modifies default range', () => { const startPos = selection.getFirstPosition(); const endPos = Position.createAt( root, 'end' ); @@ -262,7 +289,7 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'setTo - remove all ranges', () => { + describe( '_setTo() - remove all ranges', () => { let spy, ranges; beforeEach( () => { @@ -304,7 +331,7 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'setTo()', () => { + describe( '_setTo()', () => { it( 'should throw an error when range is invalid', () => { expect( () => { selection._setTo( [ { invalid: 'range' } ] ); @@ -364,24 +391,6 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'getFirstRange()', () => { - it( 'should return default range if no ranges were added', () => { - const firstRange = selection.getFirstRange(); - - expect( firstRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) ); - expect( firstRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) ); - } ); - } ); - - describe( 'getLastRange()', () => { - it( 'should return default range if no ranges were added', () => { - const lastRange = selection.getLastRange(); - - expect( lastRange.start.isEqual( new Position( root, [ 0, 0 ] ) ) ); - expect( lastRange.end.isEqual( new Position( root, [ 0, 0 ] ) ) ); - } ); - } ); - describe( '_isStoreAttributeKey', () => { it( 'should return true if given key is a key of an attribute stored in element by DocumentSelection', () => { expect( DocumentSelection._isStoreAttributeKey( fooStoreAttrKey ) ).to.be.true; @@ -392,15 +401,6 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'getSelectedElement()', () => { - it( 'should return selected element', () => { - selection._setTo( liveRange ); - const p = root.getChild( 0 ); - - expect( selection.getSelectedElement() ).to.equal( p ); - } ); - } ); - // DocumentSelection uses LiveRanges so here are only simple test to see if integration is // working well, without getting into complicated corner cases. describe( 'after applying an operation should get updated and fire events', () => { @@ -799,7 +799,7 @@ describe( 'DocumentSelection', () => { } ); } ); - describe( 'removeAttribute()', () => { + describe( '_removeAttribute()', () => { it( 'should remove attribute set on the text fragment', () => { selection._setTo( [ rangeInFullP ] ); selection._setAttribute( 'foo', 'bar' ); From a604c6207b5f6b732de52be5f4ee147701ecd577 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 13 Feb 2018 16:43:02 +0100 Subject: [PATCH 618/724] Introduced DocumentSelection method for overriding default gravity behaviour. --- src/model/documentselection.js | 38 +- tests/model/documentselection.js | 1106 ++++++++++++++++-------------- 2 files changed, 616 insertions(+), 528 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index f3912aba2..0dd4f22a3 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -388,6 +388,14 @@ export default class DocumentSelection { return this._selection._getStoredAttributes(); } + /** + * Temporarily and partially disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. + * @see module:engine/model/writer~Writer#overrideGravity + */ + _overrideGravity() { + this._selection.overrideGravity(); + } + /** * Generates and returns an attribute key for selection attributes store, basing on original attribute key. * @@ -465,6 +473,13 @@ class LiveSelection extends Selection { // @member {Array} module:engine/model/liveselection~LiveSelection#_hasChangedRange this._hasChangedRange = false; + // When is set as `true` then selection attributes on node before the caret won't be taken + // into consideration while updating selection attributes. + // + // @private + // @type {Boolean} + this._isGravityOverriden = false; + // Add events that will ensure selection correctness. this.on( 'change:range', () => { for ( const range of this.getRanges() ) { @@ -601,6 +616,19 @@ class LiveSelection extends Selection { } } + overrideGravity() { + this._isGravityOverriden = true; + + this.on( 'change:range', ( evt, directChange ) => { + if ( directChange ) { + this._isGravityOverriden = false; + evt.off(); + } + } ); + + this._updateAttributes(); + } + // Removes all attributes from the selection and sets attributes according to the surrounding nodes. _refreshAttributes() { this._updateAttributes( true ); @@ -851,8 +879,11 @@ class LiveSelection extends Selection { const nodeBefore = position.textNode ? position.textNode : position.nodeBefore; const nodeAfter = position.textNode ? position.textNode : position.nodeAfter; - // ...look at the node before caret and take attributes from it if it is a character node. - attrs = getAttrsIfCharacter( nodeBefore ); + // When gravity is overridden then don't take node before into consideration. + if ( !this._isGravityOverriden ) { + // ...look at the node before caret and take attributes from it if it is a character node. + attrs = getAttrsIfCharacter( nodeBefore ); + } // 3. If not, look at the node after caret... if ( !attrs ) { @@ -860,7 +891,8 @@ class LiveSelection extends Selection { } // 4. If not, try to find the first character on the left, that is in the same node. - if ( !attrs ) { + // When gravity is overridden then don't take node before into consideration. + if ( !this._isGravityOverriden && !attrs ) { let node = nodeBefore; while ( node && !attrs ) { diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 1df3880d5..1725ae3c5 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -401,720 +401,776 @@ describe( 'DocumentSelection', () => { } ); } ); - // DocumentSelection uses LiveRanges so here are only simple test to see if integration is - // working well, without getting into complicated corner cases. - describe( 'after applying an operation should get updated and fire events', () => { - let spyRange; + describe( 'attributes', () => { + let fullP, emptyP, rangeInFullP, rangeInEmptyP; beforeEach( () => { root.removeChildren( 0, root.childCount ); - root.insertChildren( 0, [ - new Element( 'p', [], new Text( 'abcdef' ) ), + root.appendChildren( [ new Element( 'p', [], new Text( 'foobar' ) ), - new Text( 'xyz' ) + new Element( 'p', [], [] ) ] ); - selection._setTo( new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 1, 4 ] ) ) ); - - spyRange = sinon.spy(); - selection.on( 'change:range', spyRange ); - } ); + fullP = root.getChild( 0 ); + emptyP = root.getChild( 1 ); - describe( 'InsertOperation', () => { - it( 'before selection', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); + rangeInFullP = new Range( new Position( root, [ 0, 4 ] ), new Position( root, [ 0, 4 ] ) ); + rangeInEmptyP = new Range( new Position( root, [ 1, 0 ] ), new Position( root, [ 1, 0 ] ) ); - model.applyOperation( wrapInDelta( - new InsertOperation( - new Position( root, [ 0, 1 ] ), - 'xyz', - doc.version - ) - ) ); + // I've lost 30 mins debugging why my tests fail and that was due to the above code reusing + // a root which wasn't empty (so the ranges didn't actually make much sense). + expect( root.childCount ).to.equal( 2 ); + } ); - const range = selection.getFirstRange(); + describe( '_setAttribute()', () => { + it( 'should set attribute', () => { + selection._setTo( [ rangeInEmptyP ] ); + selection._setAttribute( 'foo', 'bar' ); - expect( range.start.path ).to.deep.equal( [ 0, 5 ] ); - expect( range.end.path ).to.deep.equal( [ 1, 4 ] ); - expect( spyRange.calledOnce ).to.be.true; + expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); } ); + } ); - it( 'inside selection', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); - - model.applyOperation( wrapInDelta( - new InsertOperation( - new Position( root, [ 1, 0 ] ), - 'xyz', - doc.version - ) - ) ); - - const range = selection.getFirstRange(); + describe( '_removeAttribute()', () => { + it( 'should remove attribute set on the text fragment', () => { + selection._setTo( [ rangeInFullP ] ); + selection._setAttribute( 'foo', 'bar' ); + selection._removeAttribute( 'foo' ); - expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); - expect( range.end.path ).to.deep.equal( [ 1, 7 ] ); - expect( spyRange.calledOnce ).to.be.true; + expect( selection.getAttribute( 'foo' ) ).to.be.undefined; } ); } ); - describe( 'MoveOperation', () => { - it( 'move range from before a selection', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); - - model.applyOperation( wrapInDelta( - new MoveOperation( - new Position( root, [ 0, 0 ] ), - 2, - new Position( root, [ 2 ] ), - doc.version - ) - ) ); + describe( '_getStoredAttributes()', () => { + it( 'should return no values if there are no ranges in selection', () => { + const values = Array.from( selection._getStoredAttributes() ); - const range = selection.getFirstRange(); + expect( values ).to.deep.equal( [] ); + } ); + } ); - expect( range.start.path ).to.deep.equal( [ 0, 0 ] ); - expect( range.end.path ).to.deep.equal( [ 1, 4 ] ); - expect( spyRange.calledOnce ).to.be.true; + describe( 'are updated on a direct range change', () => { + beforeEach( () => { + root.insertChildren( 0, [ + new Element( 'p', { p: true } ), + new Text( 'a', { a: true } ), + new Element( 'p', { p: true } ), + new Text( 'b', { b: true } ), + new Text( 'c', { c: true } ), + new Element( 'p', [], [ + new Text( 'd', { d: true } ) + ] ), + new Element( 'p', { p: true } ), + new Text( 'e', { e: true } ) + ] ); } ); - it( 'moved into before a selection', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); + it( 'if selection is a range, should find first character in it and copy it\'s attributes', () => { + selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] ); - model.applyOperation( wrapInDelta( - new MoveOperation( - new Position( root, [ 2 ] ), - 2, - new Position( root, [ 0, 0 ] ), - doc.version - ) - ) ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] ); - const range = selection.getFirstRange(); + // Step into elements when looking for first character: + selection._setTo( [ new Range( new Position( root, [ 5 ] ), new Position( root, [ 7 ] ) ) ] ); - expect( range.start.path ).to.deep.equal( [ 0, 4 ] ); - expect( range.end.path ).to.deep.equal( [ 1, 4 ] ); - expect( spyRange.calledOnce ).to.be.true; + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] ); } ); - it( 'move range from inside of selection', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); + it( 'if selection is collapsed it should seek a character to copy that character\'s attributes', () => { + // Take styles from character before selection. + selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ) ] ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] ); - model.applyOperation( wrapInDelta( - new MoveOperation( - new Position( root, [ 1, 0 ] ), - 2, - new Position( root, [ 2 ] ), - doc.version - ) - ) ); + // If there are none, + // Take styles from character after selection. + selection._setTo( [ new Range( new Position( root, [ 3 ] ), new Position( root, [ 3 ] ) ) ] ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] ); - const range = selection.getFirstRange(); + // If there are none, + // Look from the selection position to the beginning of node looking for character to take attributes from. + selection._setTo( [ new Range( new Position( root, [ 6 ] ), new Position( root, [ 6 ] ) ) ] ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'c', true ] ] ); - expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); - expect( range.end.path ).to.deep.equal( [ 1, 2 ] ); - expect( spyRange.calledOnce ).to.be.true; + // If there are none, + // Look from the selection position to the end of node looking for character to take attributes from. + selection._setTo( [ new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) ] ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] ); + + // If there are no characters to copy attributes from, use stored attributes. + selection._setTo( [ new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 0 ] ) ) ] ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [] ); } ); - it( 'moved range intersects with selection', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); + it( 'should overwrite any previously set attributes', () => { + selection._setTo( new Position( root, [ 5, 0 ] ) ); - model.applyOperation( wrapInDelta( - new MoveOperation( - new Position( root, [ 1, 3 ] ), - 2, - new Position( root, [ 4 ] ), - doc.version - ) - ) ); + selection._setAttribute( 'x', true ); + selection._setAttribute( 'y', true ); - const range = selection.getFirstRange(); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ], [ 'x', true ], [ 'y', true ] ] ); - expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); - expect( range.end.path ).to.deep.equal( [ 5 ] ); - expect( spyRange.calledOnce ).to.be.true; - } ); + selection._setTo( new Position( root, [ 1 ] ) ); - it( 'split inside selection (do not break selection)', () => { - selection.on( 'change:range', ( evt, data ) => { - expect( data.directChange ).to.be.false; - } ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] ); + } ); - const batch = new Batch(); - const splitDelta = new SplitDelta(); + it( 'should fire change:attribute event', () => { + const spy = sinon.spy(); + selection.on( 'change:attribute', spy ); - const insertOperation = new InsertOperation( - new Position( root, [ 2 ] ), - new Element( 'p' ), - 0 - ); + selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] ); - const moveOperation = new MoveOperation( - new Position( root, [ 1, 2 ] ), - 4, - new Position( root, [ 2, 0 ] ), - 1 - ); + expect( spy.calledOnce ).to.be.true; + } ); - batch.addDelta( splitDelta ); + it( 'should not fire change:attribute event if attributes did not change', () => { + selection._setTo( new Position( root, [ 5, 0 ] ) ); - splitDelta.addOperation( insertOperation ); - splitDelta.addOperation( moveOperation ); + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] ); - model.applyOperation( insertOperation ); - model.applyOperation( moveOperation ); + const spy = sinon.spy(); + selection.on( 'change:attribute', spy ); - const range = selection.getFirstRange(); + selection._setTo( new Position( root, [ 5, 1 ] ) ); - expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); - expect( range.end.path ).to.deep.equal( [ 2, 2 ] ); - expect( spyRange.calledOnce ).to.be.true; + expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] ); + expect( spy.called ).to.be.false; } ); } ); - describe( 'AttributeOperation', () => { - it( 'changed range includes selection anchor', () => { - const spyAttribute = sinon.spy(); - selection.on( 'change:attribute', spyAttribute ); + // #986 + describe( 'are not inherited from the inside of object elements', () => { + beforeEach( () => { + model.schema.register( 'image', { + isObject: true + } ); + model.schema.extend( 'image', { allowIn: '$root' } ); + model.schema.extend( 'image', { allowIn: '$block' } ); - selection.on( 'change:attribute', ( evt, data ) => { - expect( data.directChange ).to.be.false; - expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] ); + model.schema.register( 'caption' ); + model.schema.extend( 'caption', { allowIn: 'image' } ); + model.schema.extend( '$text', { + allowIn: [ 'image', 'caption' ], + allowAttributes: 'bold' } ); + } ); - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), - 'foo', - null, - 'bar', - doc.version - ) - ) ); + it( 'ignores attributes inside an object if selection contains that object', () => { + setData( model, '

[<$text bold="true">Caption for the image.]

' ); - expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); - expect( spyAttribute.calledOnce ).to.be.true; + expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); - it( 'should not overwrite previously set attributes', () => { - selection._setAttribute( 'foo', 'xyz' ); - - const spyAttribute = sinon.spy(); - selection.on( 'change:attribute', spyAttribute ); - - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), - 'foo', - null, - 'bar', - doc.version - ) - ) ); + it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => { + setData( model, '

[<$text bold="true">Caption for the image.]

' ); - expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' ); - expect( spyAttribute.called ).to.be.false; + expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); - it( 'should not overwrite previously set attributes with same values', () => { - selection._setAttribute( 'foo', 'xyz' ); + it( 'ignores attributes inside an object if selection contains that object (block level)', () => { + setData( model, '

foo

[<$text bold="true">Caption for the image.]

foo

' ); - const spyAttribute = sinon.spy(); - selection.on( 'change:attribute', spyAttribute ); + expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); + } ); - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), - 'foo', - null, - 'xyz', - doc.version - ) - ) ); + it( 'reads attributes from text even if the selection contains an object', () => { + setData( model, '

x<$text bold="true">[barfoo]

' ); - expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' ); - expect( spyAttribute.called ).to.be.false; + expect( selection.getAttribute( 'bold' ) ).to.equal( true ); } ); - it( 'should not overwrite previously removed attributes', () => { - selection._setAttribute( 'foo', 'xyz' ); - selection._removeAttribute( 'foo' ); + it( 'reads attributes when the entire selection inside an object', () => { + setData( model, '

<$text bold="true">[bar]

' ); - const spyAttribute = sinon.spy(); - selection.on( 'change:attribute', spyAttribute ); + expect( selection.getAttribute( 'bold' ) ).to.equal( true ); + } ); - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), - 'foo', - null, - 'bar', - doc.version - ) - ) ); + it( 'stops reading attributes if selection starts with an object', () => { + setData( model, '

[<$text bold="true">bar]

' ); - expect( selection.hasAttribute( 'foo' ) ).to.be.false; - expect( spyAttribute.called ).to.be.false; + expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); } ); } ); - describe( 'RemoveOperation', () => { - it( 'fix selection range if it ends up in graveyard #1', () => { - selection._setTo( new Position( root, [ 1, 3 ] ) ); + describe( 'parent element\'s attributes', () => { + it( 'are set using a normal batch', () => { + const batchTypes = []; - model.applyOperation( wrapInDelta( - new RemoveOperation( - new Position( root, [ 1, 2 ] ), - 2, - new Position( doc.graveyard, [ 0 ] ), - doc.version - ) - ) ); + model.on( 'applyOperation', ( event, args ) => { + const operation = args[ 0 ]; + const batch = operation.delta.batch; - expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] ); - } ); + batchTypes.push( batch.type ); + } ); - it( 'fix selection range if it ends up in graveyard #2', () => { - selection._setTo( [ new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 4 ] ) ) ] ); + selection._setTo( [ rangeInEmptyP ] ); - model.applyOperation( wrapInDelta( - new RemoveOperation( - new Position( root, [ 1, 2 ] ), - 2, - new Position( doc.graveyard, [ 0 ] ), - doc.version - ) - ) ); + model.change( writer => { + writer.setSelectionAttribute( 'foo', 'bar' ); + } ); - expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] ); + expect( batchTypes ).to.deep.equal( [ 'default' ] ); + expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); } ); - it( 'fix selection range if it ends up in graveyard #3', () => { - selection._setTo( [ new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ) ] ); + it( 'are removed when any content is inserted (reuses the same batch)', () => { + // Dedupe batches by using a map (multiple change events will be fired). + const batchTypes = new Map(); - model.applyOperation( wrapInDelta( - new RemoveOperation( - new Position( root, [ 1 ] ), - 2, - new Position( doc.graveyard, [ 0 ] ), - doc.version - ) - ) ); + selection._setTo( rangeInEmptyP ); + selection._setAttribute( 'foo', 'bar' ); + selection._setAttribute( 'abc', 'bar' ); - expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 6 ] ); - } ); + model.on( 'applyOperation', ( event, args ) => { + const operation = args[ 0 ]; + const batch = operation.delta.batch; - it( 'fix selection range if it ends up in graveyard #4 - whole content removed', () => { - model.applyOperation( wrapInDelta( - new RemoveOperation( - new Position( root, [ 0 ] ), - 3, - new Position( doc.graveyard, [ 0 ] ), - doc.version - ) - ) ); + batchTypes.set( batch, batch.type ); + } ); - expect( selection.getFirstPosition().path ).to.deep.equal( [ 0 ] ); + model.change( writer => { + writer.insertText( 'x', rangeInEmptyP.start ); + } ); - model.applyOperation( wrapInDelta( - new InsertOperation( - new Position( root, [ 0 ] ), - new Element( 'p' ), - doc.version - ) - ) ); + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; - // Now it's clear that it's the default range. - expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] ); + expect( Array.from( batchTypes.values() ) ).to.deep.equal( [ 'default' ] ); } ); - } ); - - it( '`DocumentSelection#change:range` event should be fire once even if selection contains multi-ranges', () => { - root.removeChildren( 0, root.childCount ); - root.insertChildren( 0, [ - new Element( 'p', [], new Text( 'abcdef' ) ), - new Element( 'p', [], new Text( 'foobar' ) ), - new Text( 'xyz #2' ) - ] ); - selection._setTo( [ - Range.createIn( root.getNodeByPath( [ 0 ] ) ), - Range.createIn( root.getNodeByPath( [ 1 ] ) ) - ] ); + it( 'are removed when any content is moved into', () => { + selection._setTo( rangeInEmptyP ); + selection._setAttribute( 'foo', 'bar' ); - spyRange = sinon.spy(); - selection.on( 'change:range', spyRange ); + model.change( writer => { + writer.move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start ); + } ); - model.applyOperation( wrapInDelta( - new InsertOperation( - new Position( root, [ 0 ] ), - 'xyz #1', - doc.version - ) - ) ); + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + } ); - expect( spyRange.calledOnce ).to.be.true; - } ); - } ); + it( 'are removed when containing element is merged with a non-empty element', () => { + const emptyP2 = new Element( 'p', null, 'x' ); + root.appendChildren( emptyP2 ); - describe( 'attributes', () => { - let fullP, emptyP, rangeInFullP, rangeInEmptyP; + emptyP.setAttribute( fooStoreAttrKey, 'bar' ); + emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); - beforeEach( () => { - root.removeChildren( 0, root.childCount ); - root.appendChildren( [ - new Element( 'p', [], new Text( 'foobar' ) ), - new Element( 'p', [], [] ) - ] ); + model.change( writer => { + // {} + writer.merge( Position.createAfter( emptyP ) ); + } ); - fullP = root.getChild( 0 ); - emptyP = root.getChild( 1 ); + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element. + } ); - rangeInFullP = new Range( new Position( root, [ 0, 4 ] ), new Position( root, [ 0, 4 ] ) ); - rangeInEmptyP = new Range( new Position( root, [ 1, 0 ] ), new Position( root, [ 1, 0 ] ) ); + it( 'are removed even when there is no selection in it', () => { + emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - // I've lost 30 mins debugging why my tests fail and that was due to the above code reusing - // a root which wasn't empty (so the ranges didn't actually make much sense). - expect( root.childCount ).to.equal( 2 ); - } ); + selection._setTo( [ rangeInFullP ] ); - describe( '_setAttribute()', () => { - it( 'should set attribute', () => { - selection._setTo( [ rangeInEmptyP ] ); - selection._setAttribute( 'foo', 'bar' ); + model.change( writer => { + writer.insertText( 'x', rangeInEmptyP.start ); + } ); - expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; } ); - } ); - describe( '_removeAttribute()', () => { - it( 'should remove attribute set on the text fragment', () => { - selection._setTo( [ rangeInFullP ] ); - selection._setAttribute( 'foo', 'bar' ); - selection._removeAttribute( 'foo' ); + it( 'are removed only once in case of multi-op deltas', () => { + let batch; + const emptyP2 = new Element( 'p', null, 'x' ); + root.appendChildren( emptyP2 ); - expect( selection.getAttribute( 'foo' ) ).to.be.undefined; - } ); - } ); + emptyP.setAttribute( fooStoreAttrKey, 'bar' ); + emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); - describe( '_getStoredAttributes()', () => { - it( 'should return no values if there are no ranges in selection', () => { - const values = Array.from( selection._getStoredAttributes() ); + model.change( writer => { + batch = writer.batch; + // {} + writer.merge( Position.createAfter( emptyP ) ); + } ); - expect( values ).to.deep.equal( [] ); - } ); - } ); - - describe( 'are updated on a direct range change', () => { - beforeEach( () => { - root.insertChildren( 0, [ - new Element( 'p', { p: true } ), - new Text( 'a', { a: true } ), - new Element( 'p', { p: true } ), - new Text( 'b', { b: true } ), - new Text( 'c', { c: true } ), - new Element( 'p', [], [ - new Text( 'd', { d: true } ) - ] ), - new Element( 'p', { p: true } ), - new Text( 'e', { e: true } ) - ] ); + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + // Attribute delta is only one. + expect( Array.from( batch.deltas, delta => delta.type ) ).to.deep.equal( [ 'merge', 'attribute' ] ); } ); - it( 'if selection is a range, should find first character in it and copy it\'s attributes', () => { - selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] ); + it( 'uses model change to clear attributes', () => { + selection._setTo( [ rangeInEmptyP ] ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] ); + model.change( writer => { + writer.setSelectionAttribute( 'foo', 'bar' ); + writer.insertText( 'x', rangeInEmptyP.start ); - // Step into elements when looking for first character: - selection._setTo( [ new Range( new Position( root, [ 5 ] ), new Position( root, [ 7 ] ) ) ] ); + // `emptyP` still has the attribute, because attribute clearing is in enqueued block. + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; + } ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] ); + // When the dust settles, `emptyP` should not have the attribute. + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; } ); - it( 'if selection is collapsed it should seek a character to copy that character\'s attributes', () => { - // Take styles from character before selection. - selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 2 ] ) ) ] ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] ); + it( 'are not removed or merged when containing element is merged with another empty element', () => { + const emptyP2 = new Element( 'p', null ); + root.appendChildren( emptyP2 ); - // If there are none, - // Take styles from character after selection. - selection._setTo( [ new Range( new Position( root, [ 3 ] ), new Position( root, [ 3 ] ) ) ] ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'b', true ] ] ); + emptyP.setAttribute( fooStoreAttrKey, 'bar' ); + emptyP2.setAttribute( abcStoreAttrKey, 'bar' ); - // If there are none, - // Look from the selection position to the beginning of node looking for character to take attributes from. - selection._setTo( [ new Range( new Position( root, [ 6 ] ), new Position( root, [ 6 ] ) ) ] ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'c', true ] ] ); + expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; + expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; - // If there are none, - // Look from the selection position to the end of node looking for character to take attributes from. - selection._setTo( [ new Range( new Position( root, [ 0 ] ), new Position( root, [ 0 ] ) ) ] ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] ); + model.change( writer => { + // {} + writer.merge( Position.createAfter( emptyP ) ); + } ); - // If there are no characters to copy attributes from, use stored attributes. - selection._setTo( [ new Range( new Position( root, [ 0, 0 ] ), new Position( root, [ 0, 0 ] ) ) ] ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [] ); + expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); + expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element. } ); - it( 'should overwrite any previously set attributes', () => { - selection._setTo( new Position( root, [ 5, 0 ] ) ); + // Rename and some other deltas don't specify range in doc#change event. + // So let's see if there's no crash or something. + it( 'are not removed on rename', () => { + model.change( writer => { + writer.setSelection( rangeInEmptyP ); + writer.setSelectionAttribute( 'foo', 'bar' ); + } ); - selection._setAttribute( 'x', true ); - selection._setAttribute( 'y', true ); + sinon.spy( model, 'enqueueChange' ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ], [ 'x', true ], [ 'y', true ] ] ); + model.change( writer => { + writer.rename( emptyP, 'pnew' ); + } ); - selection._setTo( new Position( root, [ 1 ] ) ); + expect( model.enqueueChange.called ).to.be.false; + expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); + } ); + } ); + } ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'a', true ] ] ); + describe( '_overrideGravity()', () => { + beforeEach( () => { + model.schema.extend( '$text', { + allowIn: '$root' } ); + } ); - it( 'should fire change:attribute event', () => { - const spy = sinon.spy(); - selection.on( 'change:attribute', spy ); + it( 'should not inherit attributes from node before the caret', () => { + setData( model, '<$text bold="true" italic="true">foo[]' ); - selection._setTo( [ new Range( new Position( root, [ 2 ] ), new Position( root, [ 5 ] ) ) ] ); + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); - expect( spy.calledOnce ).to.be.true; - } ); + selection._overrideGravity(); - it( 'should not fire change:attribute event if attributes did not change', () => { - selection._setTo( new Position( root, [ 5, 0 ] ) ); + expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 ); + } ); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] ); + it( 'should inherit attributes from node after the caret', () => { + setData( model, '<$text>foo[]<$text bold="true" italic="true">bar' ); - const spy = sinon.spy(); - selection.on( 'change:attribute', spy ); + expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 ); - selection._setTo( new Position( root, [ 5, 1 ] ) ); + selection._overrideGravity(); - expect( Array.from( selection.getAttributes() ) ).to.deep.equal( [ [ 'd', true ] ] ); - expect( spy.called ).to.be.false; - } ); + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); } ); - // #986 - describe( 'are not inherited from the inside of object elements', () => { - beforeEach( () => { - model.schema.register( 'image', { - isObject: true - } ); - model.schema.extend( 'image', { allowIn: '$root' } ); - model.schema.extend( 'image', { allowIn: '$block' } ); - - model.schema.register( 'caption' ); - model.schema.extend( 'caption', { allowIn: 'image' } ); - model.schema.extend( '$text', { - allowIn: [ 'image', 'caption' ], - allowAttributes: 'bold' - } ); - } ); + it( 'should retain attributes that are set explicit', () => { + setData( model, '<$text italic="true">foo[]' ); - it( 'ignores attributes inside an object if selection contains that object', () => { - setData( model, '

[<$text bold="true">Caption for the image.]

' ); + selection._setAttribute( 'bold', true ); - expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); - } ); + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); - it( 'ignores attributes inside an object if selection contains that object (deeper structure)', () => { - setData( model, '

[<$text bold="true">Caption for the image.]

' ); + selection._overrideGravity(); - expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); - } ); + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold' ] ); + } ); - it( 'ignores attributes inside an object if selection contains that object (block level)', () => { - setData( model, '

foo

[<$text bold="true">Caption for the image.]

foo

' ); + it( 'should retain overridden until selection will not change range by a direct change', () => { + setData( model, '<$text bold="true" italic="true">foo[]<$text italic="true">bar' ); - expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); - } ); + selection._overrideGravity(); - it( 'reads attributes from text even if the selection contains an object', () => { - setData( model, '

x<$text bold="true">[barfoo]

' ); + // Changed range but not directly. + model.change( writer => writer.insertText( 'abc', new Position( root, [ 0 ] ) ) ); - expect( selection.getAttribute( 'bold' ) ).to.equal( true ); - } ); + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'italic' ] ); - it( 'reads attributes when the entire selection inside an object', () => { - setData( model, '

<$text bold="true">[bar]

' ); + // Changed range directly. + model.change( writer => writer.setSelection( new Position( root, [ 5 ] ) ) ); - expect( selection.getAttribute( 'bold' ) ).to.equal( true ); - } ); + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); + } ); + } ); - it( 'stops reading attributes if selection starts with an object', () => { - setData( model, '

[<$text bold="true">bar]

' ); + // DocumentSelection uses LiveRanges so here are only simple test to see if integration is + // working well, without getting into complicated corner cases. + describe( 'after applying an operation should get updated and fire events', () => { + let spyRange; - expect( selection.hasAttribute( 'bold' ) ).to.equal( false ); - } ); - } ); + beforeEach( () => { + root.removeChildren( 0, root.childCount ); + root.insertChildren( 0, [ + new Element( 'p', [], new Text( 'abcdef' ) ), + new Element( 'p', [], new Text( 'foobar' ) ), + new Text( 'xyz' ) + ] ); - describe( 'parent element\'s attributes', () => { - it( 'are set using a normal batch', () => { - const batchTypes = []; + selection._setTo( new Range( new Position( root, [ 0, 2 ] ), new Position( root, [ 1, 4 ] ) ) ); - model.on( 'applyOperation', ( event, args ) => { - const operation = args[ 0 ]; - const batch = operation.delta.batch; + spyRange = sinon.spy(); + selection.on( 'change:range', spyRange ); + } ); - batchTypes.push( batch.type ); + describe( 'InsertOperation', () => { + it( 'before selection', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; } ); - selection._setTo( [ rangeInEmptyP ] ); + model.applyOperation( wrapInDelta( + new InsertOperation( + new Position( root, [ 0, 1 ] ), + 'xyz', + doc.version + ) + ) ); - model.change( writer => { - writer.setSelectionAttribute( 'foo', 'bar' ); - } ); + const range = selection.getFirstRange(); - expect( batchTypes ).to.deep.equal( [ 'default' ] ); - expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); + expect( range.start.path ).to.deep.equal( [ 0, 5 ] ); + expect( range.end.path ).to.deep.equal( [ 1, 4 ] ); + expect( spyRange.calledOnce ).to.be.true; } ); - it( 'are removed when any content is inserted (reuses the same batch)', () => { - // Dedupe batches by using a map (multiple change events will be fired). - const batchTypes = new Map(); + it( 'inside selection', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; + } ); - selection._setTo( rangeInEmptyP ); - selection._setAttribute( 'foo', 'bar' ); - selection._setAttribute( 'abc', 'bar' ); + model.applyOperation( wrapInDelta( + new InsertOperation( + new Position( root, [ 1, 0 ] ), + 'xyz', + doc.version + ) + ) ); - model.on( 'applyOperation', ( event, args ) => { - const operation = args[ 0 ]; - const batch = operation.delta.batch; + const range = selection.getFirstRange(); - batchTypes.set( batch, batch.type ); - } ); + expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); + expect( range.end.path ).to.deep.equal( [ 1, 7 ] ); + expect( spyRange.calledOnce ).to.be.true; + } ); + } ); - model.change( writer => { - writer.insertText( 'x', rangeInEmptyP.start ); + describe( 'MoveOperation', () => { + it( 'move range from before a selection', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; } ); - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; - expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; + model.applyOperation( wrapInDelta( + new MoveOperation( + new Position( root, [ 0, 0 ] ), + 2, + new Position( root, [ 2 ] ), + doc.version + ) + ) ); - expect( Array.from( batchTypes.values() ) ).to.deep.equal( [ 'default' ] ); - } ); + const range = selection.getFirstRange(); - it( 'are removed when any content is moved into', () => { - selection._setTo( rangeInEmptyP ); - selection._setAttribute( 'foo', 'bar' ); + expect( range.start.path ).to.deep.equal( [ 0, 0 ] ); + expect( range.end.path ).to.deep.equal( [ 1, 4 ] ); + expect( spyRange.calledOnce ).to.be.true; + } ); - model.change( writer => { - writer.move( Range.createOn( fullP.getChild( 0 ) ), rangeInEmptyP.start ); + it( 'moved into before a selection', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; } ); - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + model.applyOperation( wrapInDelta( + new MoveOperation( + new Position( root, [ 2 ] ), + 2, + new Position( root, [ 0, 0 ] ), + doc.version + ) + ) ); + + const range = selection.getFirstRange(); + + expect( range.start.path ).to.deep.equal( [ 0, 4 ] ); + expect( range.end.path ).to.deep.equal( [ 1, 4 ] ); + expect( spyRange.calledOnce ).to.be.true; } ); - it( 'are removed when containing element is merged with a non-empty element', () => { - const emptyP2 = new Element( 'p', null, 'x' ); - root.appendChildren( emptyP2 ); + it( 'move range from inside of selection', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; + } ); - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); + model.applyOperation( wrapInDelta( + new MoveOperation( + new Position( root, [ 1, 0 ] ), + 2, + new Position( root, [ 2 ] ), + doc.version + ) + ) ); - model.change( writer => { - // {} - writer.merge( Position.createAfter( emptyP ) ); + const range = selection.getFirstRange(); + + expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); + expect( range.end.path ).to.deep.equal( [ 1, 2 ] ); + expect( spyRange.calledOnce ).to.be.true; + } ); + + it( 'moved range intersects with selection', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; } ); - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; - expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element. + model.applyOperation( wrapInDelta( + new MoveOperation( + new Position( root, [ 1, 3 ] ), + 2, + new Position( root, [ 4 ] ), + doc.version + ) + ) ); + + const range = selection.getFirstRange(); + + expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); + expect( range.end.path ).to.deep.equal( [ 5 ] ); + expect( spyRange.calledOnce ).to.be.true; } ); - it( 'are removed even when there is no selection in it', () => { - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); + it( 'split inside selection (do not break selection)', () => { + selection.on( 'change:range', ( evt, data ) => { + expect( data.directChange ).to.be.false; + } ); - selection._setTo( [ rangeInFullP ] ); + const batch = new Batch(); + const splitDelta = new SplitDelta(); - model.change( writer => { - writer.insertText( 'x', rangeInEmptyP.start ); + const insertOperation = new InsertOperation( + new Position( root, [ 2 ] ), + new Element( 'p' ), + 0 + ); + + const moveOperation = new MoveOperation( + new Position( root, [ 1, 2 ] ), + 4, + new Position( root, [ 2, 0 ] ), + 1 + ); + + batch.addDelta( splitDelta ); + + splitDelta.addOperation( insertOperation ); + splitDelta.addOperation( moveOperation ); + + model.applyOperation( insertOperation ); + model.applyOperation( moveOperation ); + + const range = selection.getFirstRange(); + + expect( range.start.path ).to.deep.equal( [ 0, 2 ] ); + expect( range.end.path ).to.deep.equal( [ 2, 2 ] ); + expect( spyRange.calledOnce ).to.be.true; + } ); + } ); + + describe( 'AttributeOperation', () => { + it( 'changed range includes selection anchor', () => { + const spyAttribute = sinon.spy(); + selection.on( 'change:attribute', spyAttribute ); + + selection.on( 'change:attribute', ( evt, data ) => { + expect( data.directChange ).to.be.false; + expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] ); } ); - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + model.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), + 'foo', + null, + 'bar', + doc.version + ) + ) ); + + expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); + expect( spyAttribute.calledOnce ).to.be.true; } ); - it( 'are removed only once in case of multi-op deltas', () => { - let batch; - const emptyP2 = new Element( 'p', null, 'x' ); - root.appendChildren( emptyP2 ); + it( 'should not overwrite previously set attributes', () => { + selection._setAttribute( 'foo', 'xyz' ); - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); + const spyAttribute = sinon.spy(); + selection.on( 'change:attribute', spyAttribute ); - model.change( writer => { - batch = writer.batch; - // {} - writer.merge( Position.createAfter( emptyP ) ); - } ); + model.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), + 'foo', + null, + 'bar', + doc.version + ) + ) ); - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; - // Attribute delta is only one. - expect( Array.from( batch.deltas, delta => delta.type ) ).to.deep.equal( [ 'merge', 'attribute' ] ); + expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' ); + expect( spyAttribute.called ).to.be.false; } ); - it( 'uses model change to clear attributes', () => { - selection._setTo( [ rangeInEmptyP ] ); + it( 'should not overwrite previously set attributes with same values', () => { + selection._setAttribute( 'foo', 'xyz' ); - model.change( writer => { - writer.setSelectionAttribute( 'foo', 'bar' ); - writer.insertText( 'x', rangeInEmptyP.start ); + const spyAttribute = sinon.spy(); + selection.on( 'change:attribute', spyAttribute ); - // `emptyP` still has the attribute, because attribute clearing is in enqueued block. - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; - } ); + model.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), + 'foo', + null, + 'xyz', + doc.version + ) + ) ); - // When the dust settles, `emptyP` should not have the attribute. - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.false; + expect( selection.getAttribute( 'foo' ) ).to.equal( 'xyz' ); + expect( spyAttribute.called ).to.be.false; } ); - it( 'are not removed or merged when containing element is merged with another empty element', () => { - const emptyP2 = new Element( 'p', null ); - root.appendChildren( emptyP2 ); + it( 'should not overwrite previously removed attributes', () => { + selection._setAttribute( 'foo', 'xyz' ); + selection._removeAttribute( 'foo' ); - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - emptyP2.setAttribute( abcStoreAttrKey, 'bar' ); + const spyAttribute = sinon.spy(); + selection.on( 'change:attribute', spyAttribute ); - expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; - expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; + model.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), + 'foo', + null, + 'bar', + doc.version + ) + ) ); - model.change( writer => { - // {} - writer.merge( Position.createAfter( emptyP ) ); - } ); + expect( selection.hasAttribute( 'foo' ) ).to.be.false; + expect( spyAttribute.called ).to.be.false; + } ); + } ); - expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); - expect( emptyP.parent ).to.equal( root ); // Just to be sure we're checking the right element. + describe( 'RemoveOperation', () => { + it( 'fix selection range if it ends up in graveyard #1', () => { + selection._setTo( new Position( root, [ 1, 3 ] ) ); + + model.applyOperation( wrapInDelta( + new RemoveOperation( + new Position( root, [ 1, 2 ] ), + 2, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ) + ) ); + + expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] ); } ); - // Rename and some other deltas don't specify range in doc#change event. - // So let's see if there's no crash or something. - it( 'are not removed on rename', () => { - model.change( writer => { - writer.setSelection( rangeInEmptyP ); - writer.setSelectionAttribute( 'foo', 'bar' ); - } ); + it( 'fix selection range if it ends up in graveyard #2', () => { + selection._setTo( [ new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 4 ] ) ) ] ); - sinon.spy( model, 'enqueueChange' ); + model.applyOperation( wrapInDelta( + new RemoveOperation( + new Position( root, [ 1, 2 ] ), + 2, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ) + ) ); - model.change( writer => { - writer.rename( emptyP, 'pnew' ); - } ); + expect( selection.getFirstPosition().path ).to.deep.equal( [ 1, 2 ] ); + } ); - expect( model.enqueueChange.called ).to.be.false; - expect( emptyP.getAttribute( fooStoreAttrKey ) ).to.equal( 'bar' ); + it( 'fix selection range if it ends up in graveyard #3', () => { + selection._setTo( [ new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 2 ] ) ) ] ); + + model.applyOperation( wrapInDelta( + new RemoveOperation( + new Position( root, [ 1 ] ), + 2, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ) + ) ); + + expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 6 ] ); } ); + + it( 'fix selection range if it ends up in graveyard #4 - whole content removed', () => { + model.applyOperation( wrapInDelta( + new RemoveOperation( + new Position( root, [ 0 ] ), + 3, + new Position( doc.graveyard, [ 0 ] ), + doc.version + ) + ) ); + + expect( selection.getFirstPosition().path ).to.deep.equal( [ 0 ] ); + + model.applyOperation( wrapInDelta( + new InsertOperation( + new Position( root, [ 0 ] ), + new Element( 'p' ), + doc.version + ) + ) ); + + // Now it's clear that it's the default range. + expect( selection.getFirstPosition().path ).to.deep.equal( [ 0, 0 ] ); + } ); + } ); + + it( '`DocumentSelection#change:range` event should be fire once even if selection contains multi-ranges', () => { + root.removeChildren( 0, root.childCount ); + root.insertChildren( 0, [ + new Element( 'p', [], new Text( 'abcdef' ) ), + new Element( 'p', [], new Text( 'foobar' ) ), + new Text( 'xyz #2' ) + ] ); + + selection._setTo( [ + Range.createIn( root.getNodeByPath( [ 0 ] ) ), + Range.createIn( root.getNodeByPath( [ 1 ] ) ) + ] ); + + spyRange = sinon.spy(); + selection.on( 'change:range', spyRange ); + + model.applyOperation( wrapInDelta( + new InsertOperation( + new Position( root, [ 0 ] ), + 'xyz #1', + doc.version + ) + ) ); + + expect( spyRange.calledOnce ).to.be.true; } ); } ); From 3726fa5b37c164221a5c3a14441f2ed9fc65ed1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Tue, 13 Feb 2018 16:44:03 +0100 Subject: [PATCH 619/724] Introduced `Writer#overrideSelectionGravity()` method. --- src/model/writer.js | 16 ++++++++++++++++ tests/model/writer.js | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) diff --git a/src/model/writer.js b/src/model/writer.js index e26561855..e5828f782 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1016,6 +1016,22 @@ export default class Writer { } } + /** + * Temporarily (until selection won't be changed directly by the user) disables default gravity behaviour that tries + * to get attributes from nodes surrounding the caret. When gravity is marked as overridden then attributes from the + * node before the caret won't be taken into consideration while updating selection attributes. + * + * For the following model fragment: + * + * <$text bold="true" linkHref="url">bar[]<$text bold="true">biz + * + * Selection attribute keys before override will be equal `[ 'bold', 'linkHref' ]` + * Selection attribute keys after override will be equal `[ 'bold' ]` + */ + overrideSelectionGravity() { + this.model.document.selection._overrideGravity(); + } + /** * @private * @param {String} key Key of the attribute to remove. diff --git a/tests/model/writer.js b/tests/model/writer.js index 7f42f4f16..e66cea067 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -2347,6 +2347,39 @@ describe( 'Writer', () => { } ); } ); + describe( 'overrideSelectionGravity()', () => { + it( 'should use DocumentSelection#_overrideGravity', () => { + const overrideGravitySpy = sinon.spy( DocumentSelection.prototype, '_overrideGravity' ); + + overrideSelectionGravity(); + + sinon.assert.calledOnce( overrideGravitySpy ); + overrideGravitySpy.restore(); + } ); + + it( 'should not get attributes from the node before the caret when gravity is overridden', () => { + const root = doc.createRoot(); + root.appendChildren( [ + new Text( 'foo', { foo: true } ), + new Text( 'bar', { foo: true, bar: true } ), + new Text( 'biz', { foo: true } ) + ] ); + + setSelection( new Position( root, [ 6 ] ) ); + + expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo', 'bar' ] ); + + overrideSelectionGravity(); + + expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo' ] ); + + // Disable override by moving selection. + setSelection( new Position( root, [ 5 ] ) ); + + expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo', 'bar' ] ); + } ); + } ); + function createText( data, attributes ) { return model.change( writer => { return writer.createText( data, attributes ); @@ -2506,4 +2539,10 @@ describe( 'Writer', () => { writer.removeSelectionAttribute( key ); } ); } + + function overrideSelectionGravity() { + model.change( writer => { + writer.overrideSelectionGravity(); + } ); + } } ); From 302b89ced0f17d07a5856fd9a811a4c03ea287c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 09:58:44 +0100 Subject: [PATCH 620/724] Introduced `Writer#restoreSelectionGravity()` method. --- src/model/documentselection.js | 22 ++++++++++++++++++- src/model/writer.js | 7 +++++++ tests/model/documentselection.js | 30 ++++++++++++++++++++++++++ tests/model/writer.js | 36 ++++++++++++++++++++++++++++++++ 4 files changed, 94 insertions(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 0dd4f22a3..8e1477081 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -139,6 +139,10 @@ export default class DocumentSelection { return this._selection.isBackward; } + get isGravityOverridden() { + return this._selection._isGravityOverriden; + } + /** * Used for the compatibility with the {@link module:engine/model/selection~Selection#isEqual} method. * @@ -391,11 +395,22 @@ export default class DocumentSelection { /** * Temporarily and partially disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. * @see module:engine/model/writer~Writer#overrideGravity + * + * @protected */ _overrideGravity() { this._selection.overrideGravity(); } + /** + * Restore overridden gravity. + * + * @protected + */ + _restoreGravity() { + this._selection.restoreGravity(); + } + /** * Generates and returns an attribute key for selection attributes store, basing on original attribute key. * @@ -476,7 +491,7 @@ class LiveSelection extends Selection { // When is set as `true` then selection attributes on node before the caret won't be taken // into consideration while updating selection attributes. // - // @private + // @protected // @type {Boolean} this._isGravityOverriden = false; @@ -629,6 +644,11 @@ class LiveSelection extends Selection { this._updateAttributes(); } + restoreGravity() { + this._isGravityOverriden = false; + this._updateAttributes(); + } + // Removes all attributes from the selection and sets attributes according to the surrounding nodes. _refreshAttributes() { this._updateAttributes( true ); diff --git a/src/model/writer.js b/src/model/writer.js index e5828f782..ff2d22da5 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1032,6 +1032,13 @@ export default class Writer { this.model.document.selection._overrideGravity(); } + /** + * Restore overridden gravity to default. + */ + restoreSelectionGravity() { + this.model.document.selection._restoreGravity(); + } + /** * @private * @param {String} key Key of the attribute to remove. diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 1725ae3c5..d232032e5 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -806,6 +806,36 @@ describe( 'DocumentSelection', () => { } ); } ); + describe( '_restoreGravity()', () => { + beforeEach( () => { + model.schema.extend( '$text', { + allowIn: '$root' + } ); + } ); + + it( 'should not revert default gravity when is overridden', () => { + setData( model, '<$text bold="true" italic="true">foo[]' ); + + selection._overrideGravity(); + + expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 ); + + selection._restoreGravity(); + + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); + } ); + + it( 'should do nothing when gravity is not overridden', () => { + setData( model, '<$text bold="true" italic="true">foo[]' ); + + expect( () => { + selection._restoreGravity(); + } ).to.not.throw(); + + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); + } ); + } ); + // DocumentSelection uses LiveRanges so here are only simple test to see if integration is // working well, without getting into complicated corner cases. describe( 'after applying an operation should get updated and fire events', () => { diff --git a/tests/model/writer.js b/tests/model/writer.js index e66cea067..ce508d728 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -2380,6 +2380,36 @@ describe( 'Writer', () => { } ); } ); + describe( 'restoreSelectionGravity()', () => { + it( 'should use DocumentSelection#_restoreGravity', () => { + const restoreGravitySpy = sinon.spy( DocumentSelection.prototype, '_restoreGravity' ); + + restoreSelectionGravity(); + + sinon.assert.calledOnce( restoreGravitySpy ); + restoreGravitySpy.restore(); + } ); + + it( 'should restore overridden gravity to default', () => { + const root = doc.createRoot(); + root.appendChildren( [ + new Text( 'foo', { foo: true } ), + new Text( 'bar', { foo: true, bar: true } ), + new Text( 'biz', { foo: true } ) + ] ); + + setSelection( new Position( root, [ 6 ] ) ); + + overrideSelectionGravity(); + + expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo' ] ); + + restoreSelectionGravity(); + + expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo', 'bar' ] ); + } ); + } ); + function createText( data, attributes ) { return model.change( writer => { return writer.createText( data, attributes ); @@ -2545,4 +2575,10 @@ describe( 'Writer', () => { writer.overrideSelectionGravity(); } ); } + + function restoreSelectionGravity() { + model.change( writer => { + writer.restoreSelectionGravity(); + } ); + } } ); From 5bb485422a146b4ddaf01aafa9751cdf343714de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 18:19:56 +0100 Subject: [PATCH 621/724] Introduced `bindTwoStepCaretToAttribute()` util. --- src/utils/bindtwostepcarettoattribute.js | 143 +++++++++++ tests/utils/bindtwostepcarettoattribute.js | 267 +++++++++++++++++++++ 2 files changed, 410 insertions(+) create mode 100644 src/utils/bindtwostepcarettoattribute.js create mode 100644 tests/utils/bindtwostepcarettoattribute.js diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js new file mode 100644 index 000000000..ba3d2810a --- /dev/null +++ b/src/utils/bindtwostepcarettoattribute.js @@ -0,0 +1,143 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/utils/bindtwostepcarettoattribute + */ + +import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; + +/** + * This helper adds two-steps caret movement behaviour for given attribute. + * + * When caret is moving by arrow keys and reach bound of text with attribute for which behaviour is enabled + * then typing does not expand this attribute. Additional arrow key press is needed to "enter" to the text + * and start typing with this attribute. The same is is for leaving this text. + * + * When behaviour is enabled for bold attribute and caret is just before the attribute element then pressing right arrow + * will move caret to the attribute element instead of moving after next character: + * + *

foo[]barbiz

`->`

foo[]foobarr

+ * + * The same is for "leaving" text: + * + *

foobar[]biz

`->`

foobar[]biz

+ * + * And when moving left: + * + *

foobar[]biz

`<-`

foobar[]biz

+ *

foo[]barbiz

`<-`

foo[]barbiz

+ * + * @param {module:core/editor/editor~Editor} editor The Editor instance. + * @param {module:utils/dom/emittermixin~Emitter} emitter The emitter to which this behavior should be added. + * @param {String} attribute Attribute for which behaviour will be added. + */ +export default function bindTwoStepCaretToAttribute( editor, emitter, attribute ) { + const model = editor.model; + const editingView = editor.editing.view; + const modelSelection = model.document.selection; + + // Creates a closure for each helper call to make possible to keep states. + ( function twoStepCaretMovementHandler( emitter, attribute ) { + // When set as `true` it means that first step has been made and default gravity was programmatically + // restored on `keydown` event and `keyup` event should not override it. + // Used only while moving left. + let isFirstStepMade = false; + + // Listen to keyboard events and handle cursor after move. + emitter.listenTo( editingView, 'keyup', ( evt, data ) => { + // Only left arrow is handled on keyup. + if ( data.keyCode != keyCodes.arrowleft ) { + return; + } + + // Current implementation works only for collapsed selection. + if ( !modelSelection.isCollapsed ) { + return; + } + + const position = modelSelection.getFirstPosition(); + + // If caret sticks to beginning or end of Text with attribute and first step has not been made yet let's make it. + if ( !isFirstStepMade && isStickToAttribute( position.nodeBefore, position.nodeAfter, attribute ) ) { + // While moving left we need to override gravity for the first step. + model.change( writer => writer.overrideSelectionGravity() ); + } + } ); + + // Listen to keyboard events and handle cursor before move. + emitter.listenTo( editingView, 'keydown', ( evt, data ) => { + const arrowRightPressed = data.keyCode == keyCodes.arrowright; + const arrowLeftPressed = data.keyCode == keyCodes.arrowleft; + + // When neither left or right arrow has been pressed then do noting. + if ( !arrowRightPressed && !arrowLeftPressed ) { + return; + } + + // Current implementation works only for collapsed selection. + if ( !modelSelection.isCollapsed ) { + return; + } + + const position = modelSelection.getFirstPosition(); + + // Moving left. + // This is a second part of moving caret to the left. When first step has been handled by `keyup` + // event (after caret movement) we need to handle second step using `keydown` event (before caret movement). + if ( arrowLeftPressed ) { + // If default gravity is not overridden then do nothing. + // It means that second step might be already made or caret does not stick to the Text with attribute. + if ( !modelSelection.isGravityOverridden ) { + return; + } + + // If caret sticks to beginning or end of Text with attribute + // it means that first step is already made and we need to make the second. + if ( isStickToAttribute( position.nodeBefore, position.nodeAfter, attribute ) ) { + // Prevent cater from being moved. + data.preventDefault(); + // Restore default gravity. + model.change( writer => writer.restoreSelectionGravity() ); + // Remember that second step has been made (needed by `keyup` listener). + isFirstStepMade = true; + } + + // Moving right. + // Here situation is easy to handle because gravity in the first step + // is consistent with default gravity and for second step is enough to override it. + } else { + // If default gravity is already overridden then do nothing. + // It means that second step has been already made. + if ( modelSelection.isGravityOverridden ) { + return; + } + + // If caret sticks to beginning or end of Text with attribute it means that first step has been made + // and we need to make a second step. + if ( isStickToAttribute( position.nodeAfter, position.nodeBefore, attribute ) ) { + // Prevent caret from being moved. + data.preventDefault(); + // And override default selection gravity. + model.change( writer => writer.overrideSelectionGravity() ); + } + } + } ); + + // Clear state every time when selection is changed directly by the user. + emitter.listenTo( modelSelection, 'change:range', ( evt, directChange ) => { + if ( directChange ) { + isFirstStepMade = false; + } + } ); + }( emitter, attribute ) ); +} + +function isStickToAttribute( nextNode, prevNode, attribute ) { + const isAttrInNext = nextNode ? nextNode.hasAttribute( attribute ) : false; + const isAttrInPrev = prevNode ? prevNode.hasAttribute( attribute ) : false; + + return isAttrInNext && !isAttrInPrev || !isAttrInNext && isAttrInPrev; +} diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js new file mode 100644 index 000000000..b6ae53030 --- /dev/null +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -0,0 +1,267 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/* global document */ + +import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; +import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor'; +import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin'; +import { upcastElementToAttribute } from '@ckeditor/ckeditor5-engine/src/conversion/upcast-converters'; + +import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; +import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata'; + +import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; + +describe( 'bindTwoStepCaretToAttribute()', () => { + let editor, model, emitter, selection, viewDoc, preventDefaultSpy; + + beforeEach( () => { + emitter = Object.create( DomEmitterMixin ); + + return VirtualTestEditor.create().then( newEditor => { + editor = newEditor; + model = editor.model; + selection = model.document.selection; + viewDoc = editor.editing.view; + preventDefaultSpy = sinon.spy(); + + editor.model.schema.extend( '$text', { + allowAttributes: [ 'a', 'b', 'c' ], + allowIn: '$root' + } ); + + editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'a', model: 'a' } ) ); + editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'b', model: 'b' } ) ); + editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'c', model: 'c' } ) ); + + bindTwoStepCaretToAttribute( editor, emitter, 'a' ); + } ); + } ); + + afterEach( () => { + return editor.destroy(); + } ); + + describe( 'moving right', () => { + it( 'should "enter" the text with attribute in two steps', () => { + setData( model, '<$text c="true">foo[]<$text a="true" b="true">bar' ); + + // Firing keyup event will simulate that caret is here as a result of right arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); + + // Gravity is not overridden, caret is at the beginning of the text but is "outside" of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); + expect( selection.isGravityOverridden ).to.false; + + // Press right key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + // Gravity is overridden, caret movement is blocked, selection at the beginning but "inside" the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.true; + sinon.assert.calledOnce( preventDefaultSpy ); + + // Press right key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + // Caret movement was not blocked this time (still once) so everything works normally. + sinon.assert.calledOnce( preventDefaultSpy ); + } ); + + it( 'should "leave" the text with attribute in two steps', () => { + setData( model, '<$text a="true" b="true">bar[]<$text c="true">foo' ); + + // Firing keyup event will simulate that caret is here as a result of right arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); + + // Gravity is not overridden, caret is at the end of the text but is "inside" of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.false; + + // Press right key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + // Gravity is overridden, caret movement is blocked, selection at the beginning but "outside" the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); + expect( selection.isGravityOverridden ).to.true; + sinon.assert.calledOnce( preventDefaultSpy ); + + // Press right key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + // Caret movement was not blocked this time (still once) so everything works normally. + sinon.assert.calledOnce( preventDefaultSpy ); + } ); + + it( 'should do nothing for not bound attribute (at the beginning)', () => { + setData( model, '[]<$text c="true">foo' ); + + // Firing keyup event will simulate that caret is here as a result of right arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); + + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + sinon.assert.notCalled( preventDefaultSpy ); + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should do nothing for not bound attribute (at the end)', () => { + setData( model, '<$text c="true">foo[]' ); + + // Firing keyup event will simulate that caret is here as a result of right arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); + + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + sinon.assert.notCalled( preventDefaultSpy ); + expect( selection.isGravityOverridden ).to.false; + } ); + } ); + + describe( 'moving left', () => { + it( 'should "enter" the text with attribute in two steps', () => { + setData( model, '<$text>foo<$text a="true" b="true">bar[]<$text c="true">biz' ); + + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Gravity is overridden, caret is at the end of the text but is "outside" of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); + expect( selection.isGravityOverridden ).to.true; + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Caret movement was blocked but now is "inside" the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.false; + sinon.assert.calledOnce( preventDefaultSpy ); + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Caret movement was not blocked this time (still once) so everything works normally. + sinon.assert.calledOnce( preventDefaultSpy ); + } ); + + it( 'should "leave" the text with attribute in two steps', () => { + setData( model, '<$text c="true">foo<$text a="true" b="true">[]bar' ); + + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Gravity is overridden, caret is at the beginning of the text and is "inside" of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.true; + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Gravity is not overridden, caret movement was blocked but now is "outside" the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); + expect( selection.isGravityOverridden ).to.false; + sinon.assert.calledOnce( preventDefaultSpy ); + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Caret movement was not blocked this time (still once) so everything works normally. + sinon.assert.calledOnce( preventDefaultSpy ); + } ); + + it( 'should do nothing for not bound attribute (at the beginning)', () => { + setData( model, '<$text c="true">[]foo' ); + + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + sinon.assert.notCalled( preventDefaultSpy ); + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should do nothing for not bound attribute (at the end)', () => { + setData( model, '<$text c="true">foo[]' ); + + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + sinon.assert.notCalled( preventDefaultSpy ); + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'mouse', () => { + it( 'should not override gravity when selection is placed at the beginning of text', () => { + setData( model, '<$text a="true">[]foo' ); + + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should not override gravity when selection is placed at the end of text', () => { + setData( model, '<$text a="true">foo[]' ); + + expect( selection.isGravityOverridden ).to.false; + } ); + } ); + } ); + + function getEventData( data ) { + data.target = document.body; + + return new DomEventData( viewDoc, data, { keyCode: data.keyCode } ); + } +} ); From cc7ff1cae57c646b25fb0a9df0252b58a6b3f23a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 18:59:17 +0100 Subject: [PATCH 622/724] Test: Added manual test for two-steps carret movement. --- tests/manual/twostepscarret.html | 36 ++++++++++++++++++++++++++++ tests/manual/twostepscarret.js | 32 +++++++++++++++++++++++++ tests/manual/twostepscarret.md | 41 ++++++++++++++++++++++++++++++++ 3 files changed, 109 insertions(+) create mode 100644 tests/manual/twostepscarret.html create mode 100644 tests/manual/twostepscarret.js create mode 100644 tests/manual/twostepscarret.md diff --git a/tests/manual/twostepscarret.html b/tests/manual/twostepscarret.html new file mode 100644 index 000000000..293449e1f --- /dev/null +++ b/tests/manual/twostepscarret.html @@ -0,0 +1,36 @@ +

+

Foo bar biz

+

Foo bar biz

+
+ +
+
+

+ - When selection is inside the link then box is green + when is outside the link then is blue. +

+
+ + diff --git a/tests/manual/twostepscarret.js b/tests/manual/twostepscarret.js new file mode 100644 index 000000000..edad58938 --- /dev/null +++ b/tests/manual/twostepscarret.js @@ -0,0 +1,32 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/* global console, document */ + +import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor'; +import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials'; +import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; +import LinkEngine from '@ckeditor/ckeditor5-link/src/linkengine'; +import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; + +import bindTwoStepCaretToAttribute from '@ckeditor/ckeditor5-engine/src/utils/bindtwostepcarettoattribute'; + +ClassicEditor + .create( document.querySelector( '#editor' ), { + plugins: [ Essentials, Paragraph, LinkEngine, Bold ], + toolbar: [ 'undo', 'redo', 'bold' ] + } ) + .then( editor => { + const selection = editor.model.document.selection; + + bindTwoStepCaretToAttribute( editor, editor, 'linkHref' ); + + selection.on( 'change', () => { + document.querySelector( '.status-box' ).classList.toggle( 'active', selection.hasAttribute( 'linkHref' ) ); + } ); + } ) + .catch( err => { + console.error( err.stack ); + } ); diff --git a/tests/manual/twostepscarret.md b/tests/manual/twostepscarret.md new file mode 100644 index 000000000..b6302b466 --- /dev/null +++ b/tests/manual/twostepscarret.md @@ -0,0 +1,41 @@ +## Two-steps caret movment [#1286](https://github.com/ckeditor/ckeditor5-engine/issues/1289) + +### Moving right +1. Put selection one character before the link +2. Move selection by one character to the right using right arrow + - selection should be outside the link +3. Press right arrow once again + - selection should be at the same position but inside the link +4. Using right arrow move selection at the end of the link + - selection should be still inside the link +5. Press right arrow once again + - selection should be at the same position but outside the link + +### Moving left +1. Put selection one character after the link +2. Move selection by one character to the left using right arrow + - selection should be outside the link (ignore the blink). +3. Press left arrow once again + - selection should be at the same position but inside the link +4. Using left arrow move selection at the beginning of the link + - selection should be still inside the link (ignore the blink). +5. Press left arrow once again + - selection should be at the same position but outside the link + +### Mouse +1. Put selection at the beginning of the link + - selection should be outside the link +2. Put selection at the end of the link + - selection should be inside the link + +### Attributes set explicit +1. Put selection one character before the end of the link +2. Move selection by one character to the right using right arrow + - selection should be inside the link +3. Turn on bold attribute (`Ctrl + B`) +3. Press right arrow once again + - selection should be at the same position but outside the link + - bold should stay enabled + +### Not bounded attribute +Just make sure that two-steps caret movement is disabled for bold text from the second paragraph. From 86f02183656c2a8e9123a06c97a30832ddffed4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 21:43:18 +0100 Subject: [PATCH 623/724] Fixed incorrect usage of change:range options. --- src/model/documentselection.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 8e1477081..4607dba70 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -634,8 +634,8 @@ class LiveSelection extends Selection { overrideGravity() { this._isGravityOverriden = true; - this.on( 'change:range', ( evt, directChange ) => { - if ( directChange ) { + this.on( 'change:range', ( evt, data ) => { + if ( data.directChange ) { this._isGravityOverriden = false; evt.off(); } From e64f34d65fa940f726df54f8b16b9a743118a251 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 21:43:57 +0100 Subject: [PATCH 624/724] Tests: Improved code coverage. --- src/utils/bindtwostepcarettoattribute.js | 4 +- tests/utils/bindtwostepcarettoattribute.js | 101 +++++++++++++++++++-- 2 files changed, 96 insertions(+), 9 deletions(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index ba3d2810a..3ce8926f0 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -127,8 +127,8 @@ export default function bindTwoStepCaretToAttribute( editor, emitter, attribute } ); // Clear state every time when selection is changed directly by the user. - emitter.listenTo( modelSelection, 'change:range', ( evt, directChange ) => { - if ( directChange ) { + emitter.listenTo( modelSelection, 'change:range', ( evt, data ) => { + if ( data.directChange ) { isFirstStepMade = false; } } ); diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index b6ae53030..54f35c74e 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -8,6 +8,8 @@ import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor'; import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin'; +import Position from '@ckeditor/ckeditor5-engine/src/model/position'; +import Range from '@ckeditor/ckeditor5-engine/src/model/range'; import { upcastElementToAttribute } from '@ckeditor/ckeditor5-engine/src/conversion/upcast-converters'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; @@ -137,6 +139,17 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; } ); + + it( 'should do nothing for non-collapsed selection', () => { + setData( model, '<$text c="true">fo[o]<$text a="true" b="true">bar' ); + + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright } ) ); + + expect( selection.isGravityOverridden ).to.false; + } ); } ); describe( 'moving left', () => { @@ -244,21 +257,95 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; } ); - it( 'mouse', () => { - it( 'should not override gravity when selection is placed at the beginning of text', () => { - setData( model, '<$text a="true">[]foo' ); + it( 'should do nothing for non-collapsed selection', () => { + setData( model, '<$text c="true">foo<$text a="true" b="true">[b]ar', { lastRangeBackward: true } ); - expect( selection.isGravityOverridden ).to.false; + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + expect( selection.isGravityOverridden ).to.false; + } ); + + // There is no need to test it while moving right, because moving right does not use additional state. + it( 'should work when external changes are made meanwhile', () => { + setData( model, '<$text>foo<$text a="true" b="true">bar[]<$text c="true">biz' ); + + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Gravity is overridden, caret is at the end of the text but is "outside" of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); + expect( selection.isGravityOverridden ).to.true; + + // External changes. + model.change( writer => { + writer.insertText( 'abc', Position.createAt( editor.model.document.getRoot() ) ); } ); - it( 'should not override gravity when selection is placed at the end of text', () => { - setData( model, '<$text a="true">foo[]' ); + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Caret movement was blocked but now is "inside" the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.false; + sinon.assert.calledOnce( preventDefaultSpy ); + } ); + + // There is no need to test it while moving right, because moving right does not use additional state. + it( 'should not block caret when while doing two steps movement and text is removed by external change', () => { + setData( model, '<$text c="true">foo<$text a="true" b="true">[]barbiz' ); - expect( selection.isGravityOverridden ).to.false; + // Firing keyup event will simulate that caret is here as a result of left arrow key press. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + // Gravity is overridden, caret is at the beginning of the text and is "inside" of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.true; + + // External changes. + model.change( writer => { + writer.remove( Range.createFromPositionAndShift( new Position( editor.model.document.getRoot(), [ 2 ] ), 5 ) ); } ); + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + // Moving left needs additional keyup event to check that everything is right. + viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + + sinon.assert.notCalled( preventDefaultSpy ); + } ); + } ); + + describe( 'mouse', () => { + it( 'should not override gravity when selection is placed at the beginning of text', () => { + setData( model, '<$text a="true">[]foo' ); + + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should not override gravity when selection is placed at the end of text', () => { + setData( model, '<$text a="true">foo[]' ); + + expect( selection.isGravityOverridden ).to.false; } ); } ); + it( 'should do nothing when key other then arrow left and right is pressed', () => { + setData( model, '<$text a="true">foo[]' ); + + expect( () => { + viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowup } ) ); + } ).to.not.throw(); + } ); + function getEventData( data ) { data.target = document.body; From 5521eba596753995c5db88443e3b4728df2be4b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 21:46:36 +0100 Subject: [PATCH 625/724] Tests: Typo. --- tests/manual/twostepscarret.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/manual/twostepscarret.md b/tests/manual/twostepscarret.md index b6302b466..45c38400a 100644 --- a/tests/manual/twostepscarret.md +++ b/tests/manual/twostepscarret.md @@ -13,7 +13,7 @@ ### Moving left 1. Put selection one character after the link -2. Move selection by one character to the left using right arrow +2. Move selection by one character to the left using left arrow - selection should be outside the link (ignore the blink). 3. Press left arrow once again - selection should be at the same position but inside the link From ab36eea98cf76312c958682e3c22f0dfbf22ad4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 22:18:28 +0100 Subject: [PATCH 626/724] Tests: Replaced link by underline in `bindTwoStepCaretToAttribute` manual test. --- package.json | 1 + tests/manual/twostepscarret.html | 34 +----------------------- tests/manual/twostepscarret.js | 14 +++------- tests/manual/twostepscarret.md | 45 ++++++++++++++++++-------------- 4 files changed, 31 insertions(+), 63 deletions(-) diff --git a/package.json b/package.json index e386cfcba..c172b8b19 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "@ckeditor/ckeditor5-enter": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-essentials": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-heading": "^1.0.0-alpha.2", + "@ckeditor/ckeditor5-link": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-list": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-typing": "^1.0.0-alpha.2", diff --git a/tests/manual/twostepscarret.html b/tests/manual/twostepscarret.html index 293449e1f..00f06fb6a 100644 --- a/tests/manual/twostepscarret.html +++ b/tests/manual/twostepscarret.html @@ -1,36 +1,4 @@
-

Foo bar biz

+

Foo bar biz

Foo bar biz

- -
-
-

- - When selection is inside the link then box is green - when is outside the link then is blue. -

-
- - diff --git a/tests/manual/twostepscarret.js b/tests/manual/twostepscarret.js index edad58938..1a6ed5815 100644 --- a/tests/manual/twostepscarret.js +++ b/tests/manual/twostepscarret.js @@ -8,24 +8,18 @@ import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor'; import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; -import LinkEngine from '@ckeditor/ckeditor5-link/src/linkengine'; +import Underline from '@ckeditor/ckeditor5-basic-styles/src/underline'; import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; import bindTwoStepCaretToAttribute from '@ckeditor/ckeditor5-engine/src/utils/bindtwostepcarettoattribute'; ClassicEditor .create( document.querySelector( '#editor' ), { - plugins: [ Essentials, Paragraph, LinkEngine, Bold ], - toolbar: [ 'undo', 'redo', 'bold' ] + plugins: [ Essentials, Paragraph, Underline, Bold ], + toolbar: [ 'undo', 'redo', '|', 'bold', 'underline' ] } ) .then( editor => { - const selection = editor.model.document.selection; - - bindTwoStepCaretToAttribute( editor, editor, 'linkHref' ); - - selection.on( 'change', () => { - document.querySelector( '.status-box' ).classList.toggle( 'active', selection.hasAttribute( 'linkHref' ) ); - } ); + bindTwoStepCaretToAttribute( editor, editor, 'underline' ); } ) .catch( err => { console.error( err.stack ); diff --git a/tests/manual/twostepscarret.md b/tests/manual/twostepscarret.md index 45c38400a..cd9a59c1f 100644 --- a/tests/manual/twostepscarret.md +++ b/tests/manual/twostepscarret.md @@ -1,41 +1,46 @@ ## Two-steps caret movment [#1286](https://github.com/ckeditor/ckeditor5-engine/issues/1289) ### Moving right -1. Put selection one character before the link +1. Put selection one character before the underline 2. Move selection by one character to the right using right arrow - - selection should be outside the link + - underline button should be not selected 3. Press right arrow once again - - selection should be at the same position but inside the link -4. Using right arrow move selection at the end of the link - - selection should be still inside the link + - selection should be at the same position + - underline button should be selected +4. Using right arrow move selection at the end of the underline + - underline button should be selected 5. Press right arrow once again - - selection should be at the same position but outside the link + - selection should be at the same position + - underline button should be not selected ### Moving left -1. Put selection one character after the link +1. Put selection one character after the underline 2. Move selection by one character to the left using left arrow - - selection should be outside the link (ignore the blink). + - underline button should be not selected 3. Press left arrow once again - - selection should be at the same position but inside the link -4. Using left arrow move selection at the beginning of the link - - selection should be still inside the link (ignore the blink). + - selection should be at the same position + - underline button should be selected +4. Using left arrow move selection at the beginning of the underline + - underline button should be selected 5. Press left arrow once again - - selection should be at the same position but outside the link + - selection should be at the same position + - underline button should be not selected ### Mouse -1. Put selection at the beginning of the link - - selection should be outside the link -2. Put selection at the end of the link - - selection should be inside the link +1. Put selection at the beginning of the underline + - underline button should be not selected +2. Put selection at the end of the underline + - underline button should be selected ### Attributes set explicit -1. Put selection one character before the end of the link +1. Put selection one character before the end of the underline 2. Move selection by one character to the right using right arrow - - selection should be inside the link + - underline button should be selected 3. Turn on bold attribute (`Ctrl + B`) 3. Press right arrow once again - - selection should be at the same position but outside the link - - bold should stay enabled + - selection should be at the same position + - underline button should be not selected + - bold button should stay selected ### Not bounded attribute Just make sure that two-steps caret movement is disabled for bold text from the second paragraph. From f4947e1712f9f97afcc6a05486a64cba79b0c8be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 22:36:55 +0100 Subject: [PATCH 627/724] Fixed invalid import paths. --- tests/utils/bindtwostepcarettoattribute.js | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index 54f35c74e..c25c92a5f 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -5,17 +5,16 @@ /* global document */ -import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; import VirtualTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/virtualtesteditor'; import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin'; -import Position from '@ckeditor/ckeditor5-engine/src/model/position'; -import Range from '@ckeditor/ckeditor5-engine/src/model/range'; -import { upcastElementToAttribute } from '@ckeditor/ckeditor5-engine/src/conversion/upcast-converters'; - +import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; +import Position from '../../src/model/position'; +import Range from '../../src/model/range'; +import DomEventData from '../../src/view/observer/domeventdata'; +import { upcastElementToAttribute } from '../../src/conversion/upcast-converters'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; -import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata'; -import { setData } from '@ckeditor/ckeditor5-engine/src/dev-utils/model'; +import { setData } from '../../src/dev-utils/model'; describe( 'bindTwoStepCaretToAttribute()', () => { let editor, model, emitter, selection, viewDoc, preventDefaultSpy; From 397d6c67d336bd1d29f00e002a66324c19376898 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 22:39:08 +0100 Subject: [PATCH 628/724] Removed unused Link from devDependencies. --- package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/package.json b/package.json index c172b8b19..e386cfcba 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,6 @@ "@ckeditor/ckeditor5-enter": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-essentials": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-heading": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-link": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-list": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.2", "@ckeditor/ckeditor5-typing": "^1.0.0-alpha.2", From df4e96304536e564aced2a0e4111f60932f73d7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Thu, 15 Feb 2018 22:44:26 +0100 Subject: [PATCH 629/724] Fixed invalid import path. --- tests/manual/twostepscarret.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/manual/twostepscarret.js b/tests/manual/twostepscarret.js index 1a6ed5815..16d9cee5a 100644 --- a/tests/manual/twostepscarret.js +++ b/tests/manual/twostepscarret.js @@ -11,7 +11,7 @@ import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; import Underline from '@ckeditor/ckeditor5-basic-styles/src/underline'; import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; -import bindTwoStepCaretToAttribute from '@ckeditor/ckeditor5-engine/src/utils/bindtwostepcarettoattribute'; +import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; ClassicEditor .create( document.querySelector( '#editor' ), { From 176d2dc1052c3c588df5b978c4855443d5d706f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 16:45:52 +0100 Subject: [PATCH 630/724] Added option that allows to control when overridden gravity should be restored. --- src/model/documentselection.js | 27 +++++++++++++++++---------- src/model/writer.js | 21 ++++++++++++++++----- tests/model/writer.js | 31 +++++++++++++++++++++++++++++-- 3 files changed, 62 insertions(+), 17 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 4607dba70..b9f1781c4 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -394,17 +394,20 @@ export default class DocumentSelection { /** * Temporarily and partially disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. - * @see module:engine/model/writer~Writer#overrideGravity * + * @see module:engine/model/writer~Writer#overrideGravity * @protected + * @param {Function} [customRestorer] A callback function that allows to control when default gravity should be restored. + * Callback takes function as a param that allow to restore the gravity. */ - _overrideGravity() { - this._selection.overrideGravity(); + _overrideGravity( customRestorer ) { + this._selection.overrideGravity( customRestorer ); } /** * Restore overridden gravity. * + * @see module:engine/model/writer~Writer#restoreSelectionGravity * @protected */ _restoreGravity() { @@ -631,15 +634,19 @@ class LiveSelection extends Selection { } } - overrideGravity() { + overrideGravity( customRestorer ) { this._isGravityOverriden = true; - this.on( 'change:range', ( evt, data ) => { - if ( data.directChange ) { - this._isGravityOverriden = false; - evt.off(); - } - } ); + if ( typeof customRestorer == 'function' ) { + customRestorer( this.restoreGravity.bind( this ) ); + } else { + this.on( 'change:range', ( evt, data ) => { + if ( data.directChange ) { + this._isGravityOverriden = false; + evt.off(); + } + } ); + } this._updateAttributes(); } diff --git a/src/model/writer.js b/src/model/writer.js index ff2d22da5..7df7edfbc 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1017,9 +1017,10 @@ export default class Writer { } /** - * Temporarily (until selection won't be changed directly by the user) disables default gravity behaviour that tries - * to get attributes from nodes surrounding the caret. When gravity is marked as overridden then attributes from the - * node before the caret won't be taken into consideration while updating selection attributes. + * Temporarily (until selection won't be changed directly by the user or using `customRestorer`) disables default + * gravity behaviour that tries to get attributes from nodes surrounding the caret. When gravity is marked + * as overridden then attributes from the node before the caret won't be taken into consideration while + * updating selection attributes. * * For the following model fragment: * @@ -1027,9 +1028,19 @@ export default class Writer { * * Selection attribute keys before override will be equal `[ 'bold', 'linkHref' ]` * Selection attribute keys after override will be equal `[ 'bold' ]` + * + * As default gravity is restored just after a direct {@link module:model/documentselection~DocumentSelection#change:range} event + * but it could be customised using `customRestorer` callback: + * + * model.change( writer => { + * writer.overrideSelectionGravity( restore => // and gravity won't be restored until `restore` callback won't be called ). + * } ); + * + * @param {Function} [customRestorer] A callback function that allows to control when default gravity should be restored. + * Callback takes function as a param that allow to restore the gravity. */ - overrideSelectionGravity() { - this.model.document.selection._overrideGravity(); + overrideSelectionGravity( customRestorer ) { + this.model.document.selection._overrideGravity( customRestorer ); } /** diff --git a/tests/model/writer.js b/tests/model/writer.js index ce508d728..b69d666b7 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -2372,11 +2372,38 @@ describe( 'Writer', () => { overrideSelectionGravity(); expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo' ] ); + expect( model.document.selection.isGravityOverridden ).to.true; // Disable override by moving selection. setSelection( new Position( root, [ 5 ] ) ); expect( Array.from( model.document.selection.getAttributeKeys() ) ).to.deep.equal( [ 'foo', 'bar' ] ); + expect( model.document.selection.isGravityOverridden ).to.false; + } ); + + it( 'should allow to use custom restorer callback', () => { + const root = doc.createRoot(); + root.appendChildren( [ new Text( 'foobar', { foo: true } ) ] ); + + setSelection( new Position( root, [ 1 ] ) ); + + overrideSelectionGravity( restore => { + let i = 0; + + model.document.selection.on( 'change:range', () => { + if ( i++ > 0 ) { + restore(); + } + } ); + } ); + + // Moving selection for the first time does not restore. + setSelection( new Position( root, [ 2 ] ) ); + expect( model.document.selection.isGravityOverridden ).to.true; + + // Second move does. + setSelection( new Position( root, [ 1 ] ) ); + expect( model.document.selection.isGravityOverridden ).to.false; } ); } ); @@ -2570,9 +2597,9 @@ describe( 'Writer', () => { } ); } - function overrideSelectionGravity() { + function overrideSelectionGravity( customRestorer ) { model.change( writer => { - writer.overrideSelectionGravity(); + writer.overrideSelectionGravity( customRestorer ); } ); } From 80caf7f187017a37b7a4a91a60a28ed5979451a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 17:33:54 +0100 Subject: [PATCH 631/724] Refactored `bindTwoStepCaretToAttribute()` while moving left. --- src/utils/bindtwostepcarettoattribute.js | 180 +++++++++++---------- tests/utils/bindtwostepcarettoattribute.js | 163 ++++++------------- 2 files changed, 145 insertions(+), 198 deletions(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index 3ce8926f0..098b9ae81 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -8,6 +8,8 @@ */ import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; +import Range from '@ckeditor/ckeditor5-engine/src/model/range'; +import first from '@ckeditor/ckeditor5-utils/src/first'; /** * This helper adds two-steps caret movement behaviour for given attribute. @@ -16,19 +18,19 @@ import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; * then typing does not expand this attribute. Additional arrow key press is needed to "enter" to the text * and start typing with this attribute. The same is is for leaving this text. * - * When behaviour is enabled for bold attribute and caret is just before the attribute element then pressing right arrow - * will move caret to the attribute element instead of moving after next character: + * When behaviour is enabled for `linkHref` attribute and caret is just before the attribute element then pressing + * right arrow will move caret inside the attribute element instead of moving after next character: * - *

foo[]barbiz

`->`

foo[]foobarr

+ *

foo{}barbiz

`->`

foo{}foobarr

* - * The same is for "leaving" text: + * The same is for "leaving" attribute element: * - *

foobar[]biz

`->`

foobar[]biz

+ *

foobar{}biz

`->`

foobar{}biz

* * And when moving left: * - *

foobar[]biz

`<-`

foobar[]biz

- *

foo[]barbiz

`<-`

foo[]barbiz

+ *

foobar{}biz

`<-`

foobar{}biz

+ *

foo{}barbiz

`<-`

foo{}barbiz

* * @param {module:core/editor/editor~Editor} editor The Editor instance. * @param {module:utils/dom/emittermixin~Emitter} emitter The emitter to which this behavior should be added. @@ -39,105 +41,109 @@ export default function bindTwoStepCaretToAttribute( editor, emitter, attribute const editingView = editor.editing.view; const modelSelection = model.document.selection; - // Creates a closure for each helper call to make possible to keep states. - ( function twoStepCaretMovementHandler( emitter, attribute ) { - // When set as `true` it means that first step has been made and default gravity was programmatically - // restored on `keydown` event and `keyup` event should not override it. - // Used only while moving left. - let isFirstStepMade = false; - - // Listen to keyboard events and handle cursor after move. - emitter.listenTo( editingView, 'keyup', ( evt, data ) => { - // Only left arrow is handled on keyup. - if ( data.keyCode != keyCodes.arrowleft ) { + // Listen to keyboard events and handle cursor before the move. + emitter.listenTo( editingView, 'keydown', ( evt, data ) => { + const arrowRightPressed = data.keyCode == keyCodes.arrowright; + const arrowLeftPressed = data.keyCode == keyCodes.arrowleft; + + // When neither left or right arrow has been pressed then do noting. + if ( !arrowRightPressed && !arrowLeftPressed ) { + return; + } + + // This implementation works only for collapsed selection. + if ( !modelSelection.isCollapsed ) { + return; + } + + const position = modelSelection.getFirstPosition(); + + // Moving right. + if ( arrowRightPressed ) { + // If gravity is already overridden then do nothing. + // It means that we already enter `foo{}barbiz` or left `foobar{}biz` text with attribute + // and gravity will be restored just after caret movement. + if ( modelSelection.isGravityOverridden ) { return; } - // Current implementation works only for collapsed selection. - if ( !modelSelection.isCollapsed ) { - return; - } - - const position = modelSelection.getFirstPosition(); - - // If caret sticks to beginning or end of Text with attribute and first step has not been made yet let's make it. - if ( !isFirstStepMade && isStickToAttribute( position.nodeBefore, position.nodeAfter, attribute ) ) { - // While moving left we need to override gravity for the first step. + // If caret sticks to the bound of Text with attribute it means that we are going to + // enter `foo{}barbiz` or leave `foobar{}biz` the text with attribute. + if ( isStickToAttribute( position.nodeAfter, position.nodeBefore, attribute ) ) { + // So we need to prevent caret from being moved. + data.preventDefault(); + // And override default selection gravity. model.change( writer => writer.overrideSelectionGravity() ); } - } ); - // Listen to keyboard events and handle cursor before move. - emitter.listenTo( editingView, 'keydown', ( evt, data ) => { - const arrowRightPressed = data.keyCode == keyCodes.arrowright; - const arrowLeftPressed = data.keyCode == keyCodes.arrowleft; + // Moving left. + } else { + // If caret sticks to the bound of Text with attribute and gravity is already overridden it means that + // we are going to enter `foobar{}biz` or leave `foo{}barbiz` text with attribute. + if ( modelSelection.isGravityOverridden && isStickToAttribute( position.nodeBefore, position.nodeAfter, attribute ) ) { + // So we need to prevent cater from being moved. + data.preventDefault(); + // And restore the gravity. + model.change( writer => writer.restoreSelectionGravity() ); - // When neither left or right arrow has been pressed then do noting. - if ( !arrowRightPressed && !arrowLeftPressed ) { return; } - // Current implementation works only for collapsed selection. - if ( !modelSelection.isCollapsed ) { - return; - } + // If we are here we need to check if caret is a one character before the text with attribute bound + // `foobarb{}iz` or `foob{}arbiz`. + const nextPosition = getPreviousPosition( position ); - const position = modelSelection.getFirstPosition(); - - // Moving left. - // This is a second part of moving caret to the left. When first step has been handled by `keyup` - // event (after caret movement) we need to handle second step using `keydown` event (before caret movement). - if ( arrowLeftPressed ) { - // If default gravity is not overridden then do nothing. - // It means that second step might be already made or caret does not stick to the Text with attribute. - if ( !modelSelection.isGravityOverridden ) { - return; - } - - // If caret sticks to beginning or end of Text with attribute - // it means that first step is already made and we need to make the second. - if ( isStickToAttribute( position.nodeBefore, position.nodeAfter, attribute ) ) { - // Prevent cater from being moved. - data.preventDefault(); - // Restore default gravity. - model.change( writer => writer.restoreSelectionGravity() ); - // Remember that second step has been made (needed by `keyup` listener). - isFirstStepMade = true; - } - - // Moving right. - // Here situation is easy to handle because gravity in the first step - // is consistent with default gravity and for second step is enough to override it. - } else { - // If default gravity is already overridden then do nothing. - // It means that second step has been already made. - if ( modelSelection.isGravityOverridden ) { - return; - } - - // If caret sticks to beginning or end of Text with attribute it means that first step has been made - // and we need to make a second step. - if ( isStickToAttribute( position.nodeAfter, position.nodeBefore, attribute ) ) { - // Prevent caret from being moved. - data.preventDefault(); - // And override default selection gravity. - model.change( writer => writer.overrideSelectionGravity() ); - } + // When there is no position it means that parent bound has been reached. + if ( !nextPosition ) { + return; } - } ); - // Clear state every time when selection is changed directly by the user. - emitter.listenTo( modelSelection, 'change:range', ( evt, data ) => { - if ( data.directChange ) { - isFirstStepMade = false; + // When caret is going stick to the bound of Text with attribute after movement then we need to override + // the gravity before the move. But we need to do it in a custom way otherwise `selection#change:range` + // event following the overriding will restore the gravity. + if ( isStickToAttribute( nextPosition.nodeBefore, nextPosition.nodeAfter, attribute ) ) { + model.change( writer => { + // So let's override the gravity. + writer.overrideSelectionGravity( restore => { + // But skip the following `change:range` event and restore the gravity on the next one. + let counter = 0; + + emitter.listenTo( modelSelection, 'change:range', ( evt, data ) => { + if ( counter++ && data.directChange ) { + restore(); + evt.off(); + } + } ); + } ); + } ); } - } ); - }( emitter, attribute ) ); + } + } ); } +// @param {module:engine/model/node~Node} nextNode Node before the position. +// @param {module:engine/model/node~Node} prevNode Node after the position. +// @param {String} attribute Attribute name. +// @returns {Boolean} `true` when position between the nodes sticks to the bound of text with given attribute. function isStickToAttribute( nextNode, prevNode, attribute ) { const isAttrInNext = nextNode ? nextNode.hasAttribute( attribute ) : false; const isAttrInPrev = prevNode ? prevNode.hasAttribute( attribute ) : false; return isAttrInNext && !isAttrInPrev || !isAttrInNext && isAttrInPrev; } + +// @param {module:engine/model/position~Position} position Initial position. +// @returns {module:engine/model/position~Position|undefined} Previous position according to initial position in range. +function getPreviousPosition( position ) { + const iterator = Range.createIn( position.parent ).getPositions( { + direction: 'backward', + singleCharacters: true, + startPosition: position + } ); + + // First position is the same as initial so we need to skip it. + first( iterator ); + + // Get position before the previous node of initial position. + return first( iterator ); +} diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index c25c92a5f..60d5ad4cb 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -50,9 +50,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should "enter" the text with attribute in two steps', () => { setData( model, '<$text c="true">foo[]<$text a="true" b="true">bar' ); - // Firing keyup event will simulate that caret is here as a result of right arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); - // Gravity is not overridden, caret is at the beginning of the text but is "outside" of the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); expect( selection.isGravityOverridden ).to.false; @@ -81,9 +78,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should "leave" the text with attribute in two steps', () => { setData( model, '<$text a="true" b="true">bar[]<$text c="true">foo' ); - // Firing keyup event will simulate that caret is here as a result of right arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); - // Gravity is not overridden, caret is at the end of the text but is "inside" of the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); expect( selection.isGravityOverridden ).to.false; @@ -112,9 +106,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the beginning)', () => { setData( model, '[]<$text c="true">foo' ); - // Firing keyup event will simulate that caret is here as a result of right arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy @@ -127,9 +118,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the end)', () => { setData( model, '<$text c="true">foo[]' ); - // Firing keyup event will simulate that caret is here as a result of right arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowright } ) ); - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy @@ -138,27 +126,30 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; } ); - - it( 'should do nothing for non-collapsed selection', () => { - setData( model, '<$text c="true">fo[o]<$text a="true" b="true">bar' ); - - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright } ) ); - - expect( selection.isGravityOverridden ).to.false; - } ); } ); describe( 'moving left', () => { it( 'should "enter" the text with attribute in two steps', () => { - setData( model, '<$text>foo<$text a="true" b="true">bar[]<$text c="true">biz' ); + setData( model, '<$text>foo<$text a="true" b="true">bar<$text c="true">b[]iz' ); - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + // Gravity is not overridden, caret is a one character after the and of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); + expect( selection.isGravityOverridden ).to.false; + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + + // Caret movement was not blocked. + sinon.assert.notCalled( preventDefaultSpy ); - // Gravity is overridden, caret is at the end of the text but is "outside" of the text. + // So we need to move caret one character left like it should be done in the real world. + // Caret should ends up at the end of text with attribute but still outside of it. + model.change( writer => writer.setSelection( new Range( new Position( model.document.getRoot(), [ 6 ] ) ) ) ); + + // Gravity is overridden. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); expect( selection.isGravityOverridden ).to.true; @@ -167,8 +158,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); // Caret movement was blocked but now is "inside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); @@ -180,18 +169,34 @@ describe( 'bindTwoStepCaretToAttribute()', () => { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); // Caret movement was not blocked this time (still once) so everything works normally. sinon.assert.calledOnce( preventDefaultSpy ); + + // And again we need to move the caret like it should be done in the real world to be shure that everything is + // like it should to be. + model.change( writer => writer.setSelection( new Range( new Position( model.document.getRoot(), [ 5 ] ) ) ) ); } ); it( 'should "leave" the text with attribute in two steps', () => { - setData( model, '<$text c="true">foo<$text a="true" b="true">[]bar' ); + setData( model, '<$text c="true">foo<$text a="true" b="true">b[]ar' ); + + // Gravity is not overridden, caret is a one character after the beginning of the text. + expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); + expect( selection.isGravityOverridden ).to.false; - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + + // Caret movement was not blocked. + sinon.assert.notCalled( preventDefaultSpy ); + + // So we need to move caret one character left like it should be done in the real world. + // Caret should ends up at the beginning of text with attribute but still inside of it. + model.change( writer => writer.setSelection( new Range( new Position( model.document.getRoot(), [ 3 ] ) ) ) ); // Gravity is overridden, caret is at the beginning of the text and is "inside" of the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); @@ -202,8 +207,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); // Gravity is not overridden, caret movement was blocked but now is "outside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); @@ -215,8 +218,6 @@ describe( 'bindTwoStepCaretToAttribute()', () => { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); // Caret movement was not blocked this time (still once) so everything works normally. sinon.assert.calledOnce( preventDefaultSpy ); @@ -225,15 +226,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the beginning)', () => { setData( model, '<$text c="true">[]foo' ); - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; @@ -242,84 +238,21 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the end)', () => { setData( model, '<$text c="true">foo[]' ); - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; } ); - it( 'should do nothing for non-collapsed selection', () => { - setData( model, '<$text c="true">foo<$text a="true" b="true">[b]ar', { lastRangeBackward: true } ); + it( 'should do nothing when caret is at the beginning of block element', () => { + setData( model, '[]foo', { lastRangeBackward: true } ); - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - - expect( selection.isGravityOverridden ).to.false; - } ); - - // There is no need to test it while moving right, because moving right does not use additional state. - it( 'should work when external changes are made meanwhile', () => { - setData( model, '<$text>foo<$text a="true" b="true">bar[]<$text c="true">biz' ); - - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - - // Gravity is overridden, caret is at the end of the text but is "outside" of the text. - expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); - expect( selection.isGravityOverridden ).to.true; - - // External changes. - model.change( writer => { - writer.insertText( 'abc', Position.createAt( editor.model.document.getRoot() ) ); - } ); - - // Press left key. - viewDoc.fire( 'keydown', getEventData( { - keyCode: keyCodes.arrowleft, - preventDefault: preventDefaultSpy - } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - - // Caret movement was blocked but now is "inside" the text. - expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); - expect( selection.isGravityOverridden ).to.false; - sinon.assert.calledOnce( preventDefaultSpy ); - } ); - - // There is no need to test it while moving right, because moving right does not use additional state. - it( 'should not block caret when while doing two steps movement and text is removed by external change', () => { - setData( model, '<$text c="true">foo<$text a="true" b="true">[]barbiz' ); - - // Firing keyup event will simulate that caret is here as a result of left arrow key press. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - - // Gravity is overridden, caret is at the beginning of the text and is "inside" of the text. - expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); - expect( selection.isGravityOverridden ).to.true; - - // External changes. - model.change( writer => { - writer.remove( Range.createFromPositionAndShift( new Position( editor.model.document.getRoot(), [ 2 ] ), 5 ) ); - } ); - - // Press left key. - viewDoc.fire( 'keydown', getEventData( { - keyCode: keyCodes.arrowleft, - preventDefault: preventDefaultSpy - } ) ); - // Moving left needs additional keyup event to check that everything is right. - viewDoc.fire( 'keyup', getEventData( { keyCode: keyCodes.arrowleft } ) ); - - sinon.assert.notCalled( preventDefaultSpy ); + expect( () => { + viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowleft } ) ); + } ).to.not.throw(); } ); } ); @@ -345,6 +278,14 @@ describe( 'bindTwoStepCaretToAttribute()', () => { } ).to.not.throw(); } ); + it( 'should do nothing for non-collapsed selection', () => { + setData( model, '<$text c="true">fo[o]<$text a="true" b="true">bar' ); + + viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright } ) ); + + expect( selection.isGravityOverridden ).to.false; + } ); + function getEventData( data ) { data.target = document.body; From f3dc190cbc8ec0828d74955008bda045e54b8c55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 17:38:16 +0100 Subject: [PATCH 632/724] Added another step to manual test. --- tests/manual/twostepscarret.html | 1 + tests/manual/twostepscarret.js | 6 ++++-- tests/manual/twostepscarret.md | 6 +++++- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/tests/manual/twostepscarret.html b/tests/manual/twostepscarret.html index 00f06fb6a..46f8315e9 100644 --- a/tests/manual/twostepscarret.html +++ b/tests/manual/twostepscarret.html @@ -1,4 +1,5 @@

Foo bar biz

+

Foo barbiz buz?

Foo bar biz

diff --git a/tests/manual/twostepscarret.js b/tests/manual/twostepscarret.js index 16d9cee5a..a25c10a3b 100644 --- a/tests/manual/twostepscarret.js +++ b/tests/manual/twostepscarret.js @@ -10,15 +10,17 @@ import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; import Underline from '@ckeditor/ckeditor5-basic-styles/src/underline'; import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; +import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic'; import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; ClassicEditor .create( document.querySelector( '#editor' ), { - plugins: [ Essentials, Paragraph, Underline, Bold ], - toolbar: [ 'undo', 'redo', '|', 'bold', 'underline' ] + plugins: [ Essentials, Paragraph, Underline, Bold, Italic ], + toolbar: [ 'undo', 'redo', '|', 'bold', 'underline', 'italic' ] } ) .then( editor => { + bindTwoStepCaretToAttribute( editor, editor, 'italic' ); bindTwoStepCaretToAttribute( editor, editor, 'underline' ); } ) .catch( err => { diff --git a/tests/manual/twostepscarret.md b/tests/manual/twostepscarret.md index cd9a59c1f..d4d7064e0 100644 --- a/tests/manual/twostepscarret.md +++ b/tests/manual/twostepscarret.md @@ -42,5 +42,9 @@ - underline button should be not selected - bold button should stay selected +### Moving from one bound attribute to another +1. Make sure that moving between underline and italic text from second paragraph works the same way as above. + + ### Not bounded attribute -Just make sure that two-steps caret movement is disabled for bold text from the second paragraph. +Just make sure that two-steps caret movement is disabled for bold text from the third paragraph. From a617aa5fc664dcf9e03d752bf4a9bf6fa7c57837 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 18:18:40 +0100 Subject: [PATCH 633/724] Changed the way of restoring gravity. --- src/model/documentselection.js | 15 ++++++--------- src/model/writer.js | 22 +++++++++------------- src/utils/bindtwostepcarettoattribute.js | 20 ++++++++++---------- tests/model/writer.js | 23 ++++++++--------------- 4 files changed, 33 insertions(+), 47 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index b9f1781c4..ac182165c 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -397,11 +397,10 @@ export default class DocumentSelection { * * @see module:engine/model/writer~Writer#overrideGravity * @protected - * @param {Function} [customRestorer] A callback function that allows to control when default gravity should be restored. - * Callback takes function as a param that allow to restore the gravity. + * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored automatically. */ - _overrideGravity( customRestorer ) { - this._selection.overrideGravity( customRestorer ); + _overrideGravity( customRestore ) { + this._selection.overrideGravity( customRestore ); } /** @@ -634,15 +633,13 @@ class LiveSelection extends Selection { } } - overrideGravity( customRestorer ) { + overrideGravity( customRestore ) { this._isGravityOverriden = true; - if ( typeof customRestorer == 'function' ) { - customRestorer( this.restoreGravity.bind( this ) ); - } else { + if ( !customRestore ) { this.on( 'change:range', ( evt, data ) => { if ( data.directChange ) { - this._isGravityOverriden = false; + this.restoreGravity(); evt.off(); } } ); diff --git a/src/model/writer.js b/src/model/writer.js index 7df7edfbc..1ffeb26b4 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1017,9 +1017,8 @@ export default class Writer { } /** - * Temporarily (until selection won't be changed directly by the user or using `customRestorer`) disables default - * gravity behaviour that tries to get attributes from nodes surrounding the caret. When gravity is marked - * as overridden then attributes from the node before the caret won't be taken into consideration while + * Disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. When gravity is + * marked as overridden then attributes from the node before the caret won't be taken into consideration while * updating selection attributes. * * For the following model fragment: @@ -1029,18 +1028,15 @@ export default class Writer { * Selection attribute keys before override will be equal `[ 'bold', 'linkHref' ]` * Selection attribute keys after override will be equal `[ 'bold' ]` * - * As default gravity is restored just after a direct {@link module:model/documentselection~DocumentSelection#change:range} event - * but it could be customised using `customRestorer` callback: + * As default gravity is automatically restored just after a direct + * {@link module:model/documentselection~DocumentSelection#change:range} event but this behaviour can be disabled + * by passing `true` flag as param. * - * model.change( writer => { - * writer.overrideSelectionGravity( restore => // and gravity won't be restored until `restore` callback won't be called ). - * } ); - * - * @param {Function} [customRestorer] A callback function that allows to control when default gravity should be restored. - * Callback takes function as a param that allow to restore the gravity. + * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored until + * {@link ~Writer#overrideSelectionGravity} will be called directly. */ - overrideSelectionGravity( customRestorer ) { - this.model.document.selection._overrideGravity( customRestorer ); + overrideSelectionGravity( customRestore ) { + this.model.document.selection._overrideGravity( customRestore ); } /** diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index 098b9ae81..e310fbcb5 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -103,17 +103,17 @@ export default function bindTwoStepCaretToAttribute( editor, emitter, attribute // event following the overriding will restore the gravity. if ( isStickToAttribute( nextPosition.nodeBefore, nextPosition.nodeAfter, attribute ) ) { model.change( writer => { + let counter = 0; + // So let's override the gravity. - writer.overrideSelectionGravity( restore => { - // But skip the following `change:range` event and restore the gravity on the next one. - let counter = 0; - - emitter.listenTo( modelSelection, 'change:range', ( evt, data ) => { - if ( counter++ && data.directChange ) { - restore(); - evt.off(); - } - } ); + writer.overrideSelectionGravity( true ); + + // But skip the following `change:range` event and restore the gravity on the next one. + emitter.listenTo( modelSelection, 'change:range', ( evt, data ) => { + if ( counter++ && data.directChange ) { + writer.restoreSelectionGravity(); + evt.off(); + } } ); } ); } diff --git a/tests/model/writer.js b/tests/model/writer.js index b69d666b7..f2490df29 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -2381,28 +2381,21 @@ describe( 'Writer', () => { expect( model.document.selection.isGravityOverridden ).to.false; } ); - it( 'should allow to use custom restorer callback', () => { + it( 'should allow to restorer gravity in a custom way', () => { const root = doc.createRoot(); root.appendChildren( [ new Text( 'foobar', { foo: true } ) ] ); setSelection( new Position( root, [ 1 ] ) ); - overrideSelectionGravity( restore => { - let i = 0; + overrideSelectionGravity( true ); - model.document.selection.on( 'change:range', () => { - if ( i++ > 0 ) { - restore(); - } - } ); - } ); - - // Moving selection for the first time does not restore. + // Moving selection does not restore gravity. setSelection( new Position( root, [ 2 ] ) ); expect( model.document.selection.isGravityOverridden ).to.true; - // Second move does. - setSelection( new Position( root, [ 1 ] ) ); + // We need to do it manually. + restoreSelectionGravity(); + expect( model.document.selection.isGravityOverridden ).to.false; } ); } ); @@ -2597,9 +2590,9 @@ describe( 'Writer', () => { } ); } - function overrideSelectionGravity( customRestorer ) { + function overrideSelectionGravity( customRestore ) { model.change( writer => { - writer.overrideSelectionGravity( customRestorer ); + writer.overrideSelectionGravity( customRestore ); } ); } From e03abbb3b64b88ca157396d72de9c3a29f0d828c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 18:30:27 +0100 Subject: [PATCH 634/724] Fixed invalid docs. --- src/model/documentselection.js | 2 +- src/model/writer.js | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index ac182165c..c2325e01d 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -395,7 +395,7 @@ export default class DocumentSelection { /** * Temporarily and partially disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. * - * @see module:engine/model/writer~Writer#overrideGravity + * @see module:engine/model/writer~Writer#overrideSelectionGravity * @protected * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored automatically. */ diff --git a/src/model/writer.js b/src/model/writer.js index 1ffeb26b4..3c890f09c 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1028,9 +1028,8 @@ export default class Writer { * Selection attribute keys before override will be equal `[ 'bold', 'linkHref' ]` * Selection attribute keys after override will be equal `[ 'bold' ]` * - * As default gravity is automatically restored just after a direct - * {@link module:model/documentselection~DocumentSelection#change:range} event but this behaviour can be disabled - * by passing `true` flag as param. + * As default gravity is automatically restored just after a direct selection change event but this behaviour + * can be disabled by passing `true` flag as param. * * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored until * {@link ~Writer#overrideSelectionGravity} will be called directly. From 342aaa7520bf63e441193e5bfcea989c58afcb07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 19:12:39 +0100 Subject: [PATCH 635/724] Aligned two-steps caret movement helper to new engine/view API. --- src/utils/bindtwostepcarettoattribute.js | 9 ++++----- tests/manual/twostepscarret.js | 7 +++++-- tests/utils/bindtwostepcarettoattribute.js | 4 ++-- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index e310fbcb5..ac691383e 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -32,17 +32,16 @@ import first from '@ckeditor/ckeditor5-utils/src/first'; *

foobar{}biz

`<-`

foobar{}biz

*

foo{}barbiz

`<-`

foo{}barbiz

* - * @param {module:core/editor/editor~Editor} editor The Editor instance. + * @param {module:engine/view/view~View} view View controller instance. + * @param {module:engine/model/model~Model} model Data model instance. * @param {module:utils/dom/emittermixin~Emitter} emitter The emitter to which this behavior should be added. * @param {String} attribute Attribute for which behaviour will be added. */ -export default function bindTwoStepCaretToAttribute( editor, emitter, attribute ) { - const model = editor.model; - const editingView = editor.editing.view; +export default function bindTwoStepCaretToAttribute( view, model, emitter, attribute ) { const modelSelection = model.document.selection; // Listen to keyboard events and handle cursor before the move. - emitter.listenTo( editingView, 'keydown', ( evt, data ) => { + emitter.listenTo( view.document, 'keydown', ( evt, data ) => { const arrowRightPressed = data.keyCode == keyCodes.arrowright; const arrowLeftPressed = data.keyCode == keyCodes.arrowleft; diff --git a/tests/manual/twostepscarret.js b/tests/manual/twostepscarret.js index a25c10a3b..de6e23315 100644 --- a/tests/manual/twostepscarret.js +++ b/tests/manual/twostepscarret.js @@ -20,8 +20,11 @@ ClassicEditor toolbar: [ 'undo', 'redo', '|', 'bold', 'underline', 'italic' ] } ) .then( editor => { - bindTwoStepCaretToAttribute( editor, editor, 'italic' ); - bindTwoStepCaretToAttribute( editor, editor, 'underline' ); + const bold = editor.plugins.get( Italic ); + const underline = editor.plugins.get( Underline ); + + bindTwoStepCaretToAttribute( editor.editing.view, editor.model, bold, 'italic' ); + bindTwoStepCaretToAttribute( editor.editing.view, editor.model, underline, 'underline' ); } ) .catch( err => { console.error( err.stack ); diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index 60d5ad4cb..c2075b630 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -26,7 +26,7 @@ describe( 'bindTwoStepCaretToAttribute()', () => { editor = newEditor; model = editor.model; selection = model.document.selection; - viewDoc = editor.editing.view; + viewDoc = editor.editing.view.document; preventDefaultSpy = sinon.spy(); editor.model.schema.extend( '$text', { @@ -38,7 +38,7 @@ describe( 'bindTwoStepCaretToAttribute()', () => { editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'b', model: 'b' } ) ); editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { view: 'c', model: 'c' } ) ); - bindTwoStepCaretToAttribute( editor, emitter, 'a' ); + bindTwoStepCaretToAttribute( editor.editing.view, editor.model, emitter, 'a' ); } ); } ); From f585ee7ae411060e9683851f2b03efac79ef16f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 16 Feb 2018 19:18:19 +0100 Subject: [PATCH 636/724] Fixed invalid import path. --- src/utils/bindtwostepcarettoattribute.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index ac691383e..6a7b6430f 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -7,8 +7,8 @@ * @module engine/utils/bindtwostepcarettoattribute */ +import Range from '../../src/model/range'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; -import Range from '@ckeditor/ckeditor5-engine/src/model/range'; import first from '@ckeditor/ckeditor5-utils/src/first'; /** From 3098bb50988ea3acb0c27ac09c58c96595b16d29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sat, 17 Feb 2018 00:37:15 +0100 Subject: [PATCH 637/724] Simpliefied the code. --- src/utils/bindtwostepcarettoattribute.js | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index 6a7b6430f..cc17e7239 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -7,9 +7,7 @@ * @module engine/utils/bindtwostepcarettoattribute */ -import Range from '../../src/model/range'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; -import first from '@ckeditor/ckeditor5-utils/src/first'; /** * This helper adds two-steps caret movement behaviour for given attribute. @@ -90,10 +88,10 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri // If we are here we need to check if caret is a one character before the text with attribute bound // `foobarb{}iz` or `foob{}arbiz`. - const nextPosition = getPreviousPosition( position ); + const nextPosition = position.getShiftedBy( -1 ); - // When there is no position it means that parent bound has been reached. - if ( !nextPosition ) { + // When position is the same it means that parent bound has been reached. + if ( !nextPosition.isBefore( position ) ) { return; } @@ -130,19 +128,3 @@ function isStickToAttribute( nextNode, prevNode, attribute ) { return isAttrInNext && !isAttrInPrev || !isAttrInNext && isAttrInPrev; } - -// @param {module:engine/model/position~Position} position Initial position. -// @returns {module:engine/model/position~Position|undefined} Previous position according to initial position in range. -function getPreviousPosition( position ) { - const iterator = Range.createIn( position.parent ).getPositions( { - direction: 'backward', - singleCharacters: true, - startPosition: position - } ); - - // First position is the same as initial so we need to skip it. - first( iterator ); - - // Get position before the previous node of initial position. - return first( iterator ); -} From b1b3abf8d700b77b96ac141bebe5a0245dea2826 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 19 Feb 2018 15:49:28 +0100 Subject: [PATCH 638/724] Improved checking if caret sticks attribute element bounds. --- src/utils/bindtwostepcarettoattribute.js | 4 +++ tests/utils/bindtwostepcarettoattribute.js | 36 +++++++++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index cc17e7239..1b58f2f22 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -126,5 +126,9 @@ function isStickToAttribute( nextNode, prevNode, attribute ) { const isAttrInNext = nextNode ? nextNode.hasAttribute( attribute ) : false; const isAttrInPrev = prevNode ? prevNode.hasAttribute( attribute ) : false; + if ( isAttrInNext && isAttrInPrev && nextNode.getAttributeKeys( attribute ) !== prevNode.getAttribute( attribute ) ) { + return true; + } + return isAttrInNext && !isAttrInPrev || !isAttrInNext && isAttrInPrev; } diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index c2075b630..def600eba 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -88,7 +88,7 @@ describe( 'bindTwoStepCaretToAttribute()', () => { preventDefault: preventDefaultSpy } ) ); - // Gravity is overridden, caret movement is blocked, selection at the beginning but "outside" the text. + // Gravity is overridden, caret movement is blocked, selection at the end but "outside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); expect( selection.isGravityOverridden ).to.true; sinon.assert.calledOnce( preventDefaultSpy ); @@ -126,6 +126,23 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; } ); + + it( 'should require two-steps movement when caret goes between text node with the same attribute but different value', () => { + setData( model, '<$text a="1">bar[]<$text a="2">foo' ); + + // Gravity is not overridden. + expect( selection.isGravityOverridden ).to.false; + + // Press right key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowright, + preventDefault: preventDefaultSpy + } ) ); + + // Gravity is overridden, caret movement is blocked. + expect( selection.isGravityOverridden ).to.true; + sinon.assert.calledOnce( preventDefaultSpy ); + } ); } ); describe( 'moving left', () => { @@ -254,6 +271,23 @@ describe( 'bindTwoStepCaretToAttribute()', () => { viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowleft } ) ); } ).to.not.throw(); } ); + + it( 'should require two-steps movement when caret goes between text node with the same attribute but different value', () => { + setData( model, '<$text a="2">foo<$text a="1">b[]ar' ); + + // Gravity is not overridden. + expect( selection.isGravityOverridden ).to.false; + + // Press left key. + viewDoc.fire( 'keydown', getEventData( { + keyCode: keyCodes.arrowleft, + preventDefault: preventDefaultSpy + } ) ); + + // Gravity is overridden, caret movement was not blocked. + sinon.assert.notCalled( preventDefaultSpy ); + expect( selection.isGravityOverridden ).to.true; + } ); } ); describe( 'mouse', () => { From 7e67629bd38b6582742fc8ae9153927e74165b0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 19 Feb 2018 17:25:23 +0100 Subject: [PATCH 639/724] Disabled two-steps movement when shift key is pressed. --- src/utils/bindtwostepcarettoattribute.js | 5 ++ tests/manual/twostepscarret.md | 1 - tests/utils/bindtwostepcarettoattribute.js | 88 ++++++++++++---------- 3 files changed, 54 insertions(+), 40 deletions(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index 1b58f2f22..936058499 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -53,6 +53,11 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri return; } + // User tries to expand selection, so two-steps movement is not necessary. + if ( data.shiftKey ) { + return; + } + const position = modelSelection.getFirstPosition(); // Moving right. diff --git a/tests/manual/twostepscarret.md b/tests/manual/twostepscarret.md index d4d7064e0..6c71b6617 100644 --- a/tests/manual/twostepscarret.md +++ b/tests/manual/twostepscarret.md @@ -45,6 +45,5 @@ ### Moving from one bound attribute to another 1. Make sure that moving between underline and italic text from second paragraph works the same way as above. - ### Not bounded attribute Just make sure that two-steps caret movement is disabled for bold text from the third paragraph. diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index def600eba..7026e8eae 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -10,7 +10,6 @@ import DomEmitterMixin from '@ckeditor/ckeditor5-utils/src/dom/emittermixin'; import bindTwoStepCaretToAttribute from '../../src/utils/bindtwostepcarettoattribute'; import Position from '../../src/model/position'; import Range from '../../src/model/range'; -import DomEventData from '../../src/view/observer/domeventdata'; import { upcastElementToAttribute } from '../../src/conversion/upcast-converters'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; @@ -55,10 +54,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; // Press right key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); // Gravity is overridden, caret movement is blocked, selection at the beginning but "inside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); @@ -66,10 +65,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.calledOnce( preventDefaultSpy ); // Press right key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was not blocked this time (still once) so everything works normally. sinon.assert.calledOnce( preventDefaultSpy ); @@ -83,10 +82,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; // Press right key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); // Gravity is overridden, caret movement is blocked, selection at the end but "outside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); @@ -94,10 +93,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.calledOnce( preventDefaultSpy ); // Press right key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was not blocked this time (still once) so everything works normally. sinon.assert.calledOnce( preventDefaultSpy ); @@ -106,10 +105,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the beginning)', () => { setData( model, '[]<$text c="true">foo' ); - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; @@ -118,10 +117,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the end)', () => { setData( model, '<$text c="true">foo[]' ); - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; @@ -134,10 +133,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; // Press right key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); // Gravity is overridden, caret movement is blocked. expect( selection.isGravityOverridden ).to.true; @@ -154,10 +153,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was not blocked. sinon.assert.notCalled( preventDefaultSpy ); @@ -171,10 +170,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.true; // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was blocked but now is "inside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'a', 'b' ] ); @@ -182,10 +181,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.calledOnce( preventDefaultSpy ); // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was not blocked this time (still once) so everything works normally. sinon.assert.calledOnce( preventDefaultSpy ); @@ -203,10 +202,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was not blocked. sinon.assert.notCalled( preventDefaultSpy ); @@ -220,10 +219,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.true; // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Gravity is not overridden, caret movement was blocked but now is "outside" the text. expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'c' ] ); @@ -231,10 +230,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { sinon.assert.calledOnce( preventDefaultSpy ); // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Caret movement was not blocked this time (still once) so everything works normally. sinon.assert.calledOnce( preventDefaultSpy ); @@ -243,10 +242,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the beginning)', () => { setData( model, '<$text c="true">[]foo' ); - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; @@ -255,10 +254,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { it( 'should do nothing for not bound attribute (at the end)', () => { setData( model, '<$text c="true">foo[]' ); - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowright, preventDefault: preventDefaultSpy - } ) ); + } ); sinon.assert.notCalled( preventDefaultSpy ); expect( selection.isGravityOverridden ).to.false; @@ -268,7 +267,7 @@ describe( 'bindTwoStepCaretToAttribute()', () => { setData( model, '[]foo', { lastRangeBackward: true } ); expect( () => { - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowleft } ) ); + fireKeyDownEvent( { keyCode: keyCodes.arrowleft } ); } ).to.not.throw(); } ); @@ -279,10 +278,10 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; // Press left key. - viewDoc.fire( 'keydown', getEventData( { + fireKeyDownEvent( { keyCode: keyCodes.arrowleft, preventDefault: preventDefaultSpy - } ) ); + } ); // Gravity is overridden, caret movement was not blocked. sinon.assert.notCalled( preventDefaultSpy ); @@ -308,21 +307,32 @@ describe( 'bindTwoStepCaretToAttribute()', () => { setData( model, '<$text a="true">foo[]' ); expect( () => { - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowup } ) ); + fireKeyDownEvent( { keyCode: keyCodes.arrowup } ); } ).to.not.throw(); } ); it( 'should do nothing for non-collapsed selection', () => { setData( model, '<$text c="true">fo[o]<$text a="true" b="true">bar' ); - viewDoc.fire( 'keydown', getEventData( { keyCode: keyCodes.arrowright } ) ); + fireKeyDownEvent( { keyCode: keyCodes.arrowright } ); + + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should do nothing when shift key is pressed', () => { + setData( model, '<$text c="true">foo<$text a="true" b="true">b[]ar' ); + + fireKeyDownEvent( { + keyCode: keyCodes.arrowleft, + shiftKey: true + } ); expect( selection.isGravityOverridden ).to.false; } ); - function getEventData( data ) { - data.target = document.body; + function fireKeyDownEvent( options ) { + const eventData = Object.assign( { domTarget: document.body }, options ); - return new DomEventData( viewDoc, data, { keyCode: data.keyCode } ); + viewDoc.fire( 'keydown', eventData ); } } ); From d44e07b1264e8058a402eff3795dc768e94840c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 23 Feb 2018 07:13:21 +0100 Subject: [PATCH 640/724] Renamed manual test file. --- tests/manual/{twostepscarret.html => two-step-caret.html} | 0 tests/manual/{twostepscarret.js => two-step-caret.js} | 0 tests/manual/{twostepscarret.md => two-step-caret.md} | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename tests/manual/{twostepscarret.html => two-step-caret.html} (100%) rename tests/manual/{twostepscarret.js => two-step-caret.js} (100%) rename tests/manual/{twostepscarret.md => two-step-caret.md} (100%) diff --git a/tests/manual/twostepscarret.html b/tests/manual/two-step-caret.html similarity index 100% rename from tests/manual/twostepscarret.html rename to tests/manual/two-step-caret.html diff --git a/tests/manual/twostepscarret.js b/tests/manual/two-step-caret.js similarity index 100% rename from tests/manual/twostepscarret.js rename to tests/manual/two-step-caret.js diff --git a/tests/manual/twostepscarret.md b/tests/manual/two-step-caret.md similarity index 100% rename from tests/manual/twostepscarret.md rename to tests/manual/two-step-caret.md From 4deb176b32a9dd49ce41bf72f88a7158309039f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 23 Feb 2018 07:43:22 +0100 Subject: [PATCH 641/724] Imporved docs. --- src/model/documentselection.js | 17 ++++++++++++++--- src/model/writer.js | 21 ++++++++++++--------- src/utils/bindtwostepcarettoattribute.js | 8 ++++---- 3 files changed, 30 insertions(+), 16 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index c2325e01d..4051261ed 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -139,6 +139,12 @@ export default class DocumentSelection { return this._selection.isBackward; } + /** + * Describes whether gravity is overridden (using {@link ~DocumentSelection#_overrideGravity}) or not. + * + * @readonly + * @return {boolean} + */ get isGravityOverridden() { return this._selection._isGravityOverriden; } @@ -393,18 +399,23 @@ export default class DocumentSelection { } /** - * Temporarily and partially disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. + * Temporarily changes the gravity of the selection from left to right. The gravity defines from which direction + * the selection inherits its attributes. If it's the default left gravity, the selection (after being moved by + * the user) inherits attributes from its left hand side. This method allows to temporarily override this behavior + * by forcing the gravity to the right. * * @see module:engine/model/writer~Writer#overrideSelectionGravity * @protected - * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored automatically. + * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored until + * {@link ~DocumentSelection#_restoreGravity} will be called directly. When `false` then gravity is restored + * after selection is moved by user. */ _overrideGravity( customRestore ) { this._selection.overrideGravity( customRestore ); } /** - * Restore overridden gravity. + * Restores {@link ~DocumentSelection#_overrideGravity overridden gravity}. * * @see module:engine/model/writer~Writer#restoreSelectionGravity * @protected diff --git a/src/model/writer.js b/src/model/writer.js index 3c890f09c..48ca28588 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1017,29 +1017,32 @@ export default class Writer { } /** - * Disables default gravity behaviour that tries to get attributes from nodes surrounding the caret. When gravity is - * marked as overridden then attributes from the node before the caret won't be taken into consideration while - * updating selection attributes. + * Temporarily changes the gravity of the selection from left to right. The gravity defines from which direction + * the selection inherits its attributes. If it's the default left gravity, the selection (after being moved by + * the user) inherits attributes from its left hand side. This method allows to temporarily override this behavior + * by forcing the gravity to the right. * * For the following model fragment: * * <$text bold="true" linkHref="url">bar[]<$text bold="true">biz * - * Selection attribute keys before override will be equal `[ 'bold', 'linkHref' ]` - * Selection attribute keys after override will be equal `[ 'bold' ]` + * Default gravity: selection will have the `bold` and `linkHref` attributes. + * Overridden gravity: selection will have `bold` attribute. * - * As default gravity is automatically restored just after a direct selection change event but this behaviour - * can be disabled by passing `true` flag as param. + * By default the selection's gravity is automatically restored just after a direct selection change (when user + * move caret) but you can pass customRestore = true in which case you will have to call + * {@link ~Writer#restoreSelectionGravity} manually. * * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored until - * {@link ~Writer#overrideSelectionGravity} will be called directly. + * {@link ~Writer#restoreSelectionGravity} will be called directly. When `false` then gravity is restored + * after selection is moved by user. */ overrideSelectionGravity( customRestore ) { this.model.document.selection._overrideGravity( customRestore ); } /** - * Restore overridden gravity to default. + * Restores overridden gravity to default. */ restoreSelectionGravity() { this.model.document.selection._restoreGravity(); diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index 936058499..a501e922f 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -71,7 +71,7 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri // If caret sticks to the bound of Text with attribute it means that we are going to // enter `foo{}barbiz` or leave `foobar{}biz` the text with attribute. - if ( isStickToAttribute( position.nodeAfter, position.nodeBefore, attribute ) ) { + if ( isAtAttributeBoundary( position.nodeAfter, position.nodeBefore, attribute ) ) { // So we need to prevent caret from being moved. data.preventDefault(); // And override default selection gravity. @@ -82,7 +82,7 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri } else { // If caret sticks to the bound of Text with attribute and gravity is already overridden it means that // we are going to enter `foobar{}biz` or leave `foo{}barbiz` text with attribute. - if ( modelSelection.isGravityOverridden && isStickToAttribute( position.nodeBefore, position.nodeAfter, attribute ) ) { + if ( modelSelection.isGravityOverridden && isAtAttributeBoundary( position.nodeBefore, position.nodeAfter, attribute ) ) { // So we need to prevent cater from being moved. data.preventDefault(); // And restore the gravity. @@ -103,7 +103,7 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri // When caret is going stick to the bound of Text with attribute after movement then we need to override // the gravity before the move. But we need to do it in a custom way otherwise `selection#change:range` // event following the overriding will restore the gravity. - if ( isStickToAttribute( nextPosition.nodeBefore, nextPosition.nodeAfter, attribute ) ) { + if ( isAtAttributeBoundary( nextPosition.nodeBefore, nextPosition.nodeAfter, attribute ) ) { model.change( writer => { let counter = 0; @@ -127,7 +127,7 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri // @param {module:engine/model/node~Node} prevNode Node after the position. // @param {String} attribute Attribute name. // @returns {Boolean} `true` when position between the nodes sticks to the bound of text with given attribute. -function isStickToAttribute( nextNode, prevNode, attribute ) { +function isAtAttributeBoundary( nextNode, prevNode, attribute ) { const isAttrInNext = nextNode ? nextNode.hasAttribute( attribute ) : false; const isAttrInPrev = prevNode ? prevNode.hasAttribute( attribute ) : false; From c56cb25007cc5f0c262284f7d55fd72fe076f942 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 23 Feb 2018 07:49:04 +0100 Subject: [PATCH 642/724] Prevented from two-steps movement when alt or ctrl key is pressed. --- src/utils/bindtwostepcarettoattribute.js | 5 +++-- tests/utils/bindtwostepcarettoattribute.js | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index a501e922f..b751eebd0 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -53,8 +53,9 @@ export default function bindTwoStepCaretToAttribute( view, model, emitter, attri return; } - // User tries to expand selection, so two-steps movement is not necessary. - if ( data.shiftKey ) { + // When user tries to expand selection or jump over the whole word or to the beginning/end then + // two-steps movement is not necessary. + if ( data.shiftKey || data.altKey || data.ctrlKey ) { return; } diff --git a/tests/utils/bindtwostepcarettoattribute.js b/tests/utils/bindtwostepcarettoattribute.js index 7026e8eae..ac435c4bd 100644 --- a/tests/utils/bindtwostepcarettoattribute.js +++ b/tests/utils/bindtwostepcarettoattribute.js @@ -330,6 +330,28 @@ describe( 'bindTwoStepCaretToAttribute()', () => { expect( selection.isGravityOverridden ).to.false; } ); + it( 'should do nothing when alt key is pressed', () => { + setData( model, '<$text c="true">foo<$text a="true" b="true">b[]ar' ); + + fireKeyDownEvent( { + keyCode: keyCodes.arrowleft, + altKey: true + } ); + + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should do nothing when ctrl key is pressed', () => { + setData( model, '<$text c="true">foo<$text a="true" b="true">b[]ar' ); + + fireKeyDownEvent( { + keyCode: keyCodes.arrowleft, + ctrlKey: true + } ); + + expect( selection.isGravityOverridden ).to.false; + } ); + function fireKeyDownEvent( options ) { const eventData = Object.assign( { domTarget: document.body }, options ); From 28618b0d9d3e83a16095d2a2bc3e173b5bd8ceb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 23 Feb 2018 08:47:41 +0100 Subject: [PATCH 643/724] Added mechanism that prevents from conflicts when selection gravity is overridden more than once. --- src/model/documentselection.js | 60 +++++++++++++++++++++----------- src/model/writer.js | 8 ++++- tests/model/documentselection.js | 31 +++++++++++++++-- 3 files changed, 75 insertions(+), 24 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 4051261ed..e5b31b106 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -142,11 +142,13 @@ export default class DocumentSelection { /** * Describes whether gravity is overridden (using {@link ~DocumentSelection#_overrideGravity}) or not. * + * Note that gravity remains overridden as long as won't be restored the same number of times as was overridden. + * * @readonly * @return {boolean} */ get isGravityOverridden() { - return this._selection._isGravityOverriden; + return this._selection.isGravityOverridden; } /** @@ -417,6 +419,8 @@ export default class DocumentSelection { /** * Restores {@link ~DocumentSelection#_overrideGravity overridden gravity}. * + * Note that gravity remains overridden as long as won't be restored the same number of times as was overridden. + * * @see module:engine/model/writer~Writer#restoreSelectionGravity * @protected */ @@ -501,12 +505,12 @@ class LiveSelection extends Selection { // @member {Array} module:engine/model/liveselection~LiveSelection#_hasChangedRange this._hasChangedRange = false; - // When is set as `true` then selection attributes on node before the caret won't be taken - // into consideration while updating selection attributes. - // - // @protected - // @type {Boolean} - this._isGravityOverriden = false; + // Each overriding gravity increase the counter and each restoring decrease it. + // Gravity is overridden when counter is greater than 0. This is to prevent conflicts when + // gravity is overridden by more than one feature at the same time. + // @private + // @type {Number} + this._overriddenGravityCounter = 0; // Add events that will ensure selection correctness. this.on( 'change:range', () => { @@ -593,6 +597,15 @@ class LiveSelection extends Selection { return this._ranges.length > 0; } + // When set to `true` then selection attributes on node before the caret won't be taken + // into consideration while updating selection attributes. + // + // @protected + // @type {Boolean} + get isGravityOverridden() { + return this._overriddenGravityCounter > 0; + } + // Unbinds all events previously bound by live selection. destroy() { for ( let i = 0; i < this._ranges.length; i++ ) { @@ -645,23 +658,28 @@ class LiveSelection extends Selection { } overrideGravity( customRestore ) { - this._isGravityOverriden = true; + this._overriddenGravityCounter++; + + if ( this._overriddenGravityCounter == 1 ) { + if ( !customRestore ) { + this.on( 'change:range', ( evt, data ) => { + if ( data.directChange ) { + this.restoreGravity(); + evt.off(); + } + } ); + } - if ( !customRestore ) { - this.on( 'change:range', ( evt, data ) => { - if ( data.directChange ) { - this.restoreGravity(); - evt.off(); - } - } ); + this._updateAttributes(); } - - this._updateAttributes(); } restoreGravity() { - this._isGravityOverriden = false; - this._updateAttributes(); + this._overriddenGravityCounter--; + + if ( !this.isGravityOverridden ) { + this._updateAttributes(); + } } // Removes all attributes from the selection and sets attributes according to the surrounding nodes. @@ -915,7 +933,7 @@ class LiveSelection extends Selection { const nodeAfter = position.textNode ? position.textNode : position.nodeAfter; // When gravity is overridden then don't take node before into consideration. - if ( !this._isGravityOverriden ) { + if ( !this.isGravityOverridden ) { // ...look at the node before caret and take attributes from it if it is a character node. attrs = getAttrsIfCharacter( nodeBefore ); } @@ -927,7 +945,7 @@ class LiveSelection extends Selection { // 4. If not, try to find the first character on the left, that is in the same node. // When gravity is overridden then don't take node before into consideration. - if ( !this._isGravityOverriden && !attrs ) { + if ( !this.isGravityOverridden && !attrs ) { let node = nodeBefore; while ( node && !attrs ) { diff --git a/src/model/writer.js b/src/model/writer.js index 48ca28588..88fb4df70 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1033,6 +1033,10 @@ export default class Writer { * move caret) but you can pass customRestore = true in which case you will have to call * {@link ~Writer#restoreSelectionGravity} manually. * + * When the selection's gravity is overridden more than once without restoring meanwhile then needs to be restored + * the same number of times as was overridden to revert default behavior. This is to prevent conflicts when + * more than one feature want independently override and restore selection's gravity. + * * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored until * {@link ~Writer#restoreSelectionGravity} will be called directly. When `false` then gravity is restored * after selection is moved by user. @@ -1042,7 +1046,9 @@ export default class Writer { } /** - * Restores overridden gravity to default. + * Restores {@link ~Writer#overrideSelectionGravity} gravity to default. + * + * Note that selection's gravity remains overridden as long as won't be restored the same number of times as was overridden. */ restoreSelectionGravity() { this.model.document.selection._restoreGravity(); diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index d232032e5..11f3bef20 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -757,6 +757,14 @@ describe( 'DocumentSelection', () => { } ); } ); + it( 'should mark gravity as overridden', () => { + expect( selection.isGravityOverridden ).to.false; + + selection._overrideGravity(); + + expect( selection.isGravityOverridden ).to.true; + } ); + it( 'should not inherit attributes from node before the caret', () => { setData( model, '<$text bold="true" italic="true">foo[]' ); @@ -813,16 +821,18 @@ describe( 'DocumentSelection', () => { } ); } ); - it( 'should not revert default gravity when is overridden', () => { + it( 'should revert default gravity when is overridden', () => { setData( model, '<$text bold="true" italic="true">foo[]' ); selection._overrideGravity(); expect( Array.from( selection.getAttributeKeys() ) ).to.length( 0 ); + expect( selection.isGravityOverridden ).to.true; selection._restoreGravity(); expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); + expect( selection.isGravityOverridden ).to.false; } ); it( 'should do nothing when gravity is not overridden', () => { @@ -832,7 +842,24 @@ describe( 'DocumentSelection', () => { selection._restoreGravity(); } ).to.not.throw(); - expect( Array.from( selection.getAttributeKeys() ) ).to.have.members( [ 'bold', 'italic' ] ); + expect( selection.isGravityOverridden ).to.false; + } ); + + it( 'should be called the same number of times as gravity is overridden to restore it', () => { + setData( model, '<$text bold="true" italic="true">foo[]' ); + + selection._overrideGravity(); + selection._overrideGravity(); + + expect( selection.isGravityOverridden ).to.true; + + selection._restoreGravity(); + + expect( selection.isGravityOverridden ).to.true; + + selection._restoreGravity(); + + expect( selection.isGravityOverridden ).to.false; } ); } ); From d3dda625067ac939655580e0ef8b50b426a94ad4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 23 Feb 2018 12:38:03 +0100 Subject: [PATCH 644/724] Updated DowncastDispatcher's insert event docs - there is no consumable passed with event. --- src/conversion/downcastdispatcher.js | 1 - 1 file changed, 1 deletion(-) diff --git a/src/conversion/downcastdispatcher.js b/src/conversion/downcastdispatcher.js index 8bbb74d80..af1c92090 100644 --- a/src/conversion/downcastdispatcher.js +++ b/src/conversion/downcastdispatcher.js @@ -476,7 +476,6 @@ export default class DowncastDispatcher { * @param {Object} data Additional information about the change. * @param {module:engine/model/item~Item} data.item Inserted item. * @param {module:engine/model/range~Range} data.range Range spanning over inserted item. - * @param {module:engine/conversion/modelconsumable~ModelConsumable} consumable Values to consume. * @param {Object} conversionApi Conversion interface to be used by callback, passed in `DowncastDispatcher` constructor. */ From 77b4506460498db57c13793440f55f2f081622d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 23 Feb 2018 14:16:20 +0100 Subject: [PATCH 645/724] Updated docs in view controller and document. --- src/view/document.js | 34 ++++++---------------------------- src/view/view.js | 27 ++++++++++++++++++++------- 2 files changed, 26 insertions(+), 35 deletions(-) diff --git a/src/view/document.js b/src/view/document.js index cb2d2c614..8987b518a 100644 --- a/src/view/document.js +++ b/src/view/document.js @@ -88,38 +88,16 @@ export default class Document { } /** - * TODO: update docs - * Used to register a post-fixer callback. A post-fixer mechanism guarantees that the features that listen to - * the {@link module:engine/model/model~Model#event:_change model's change event} will operate on a correct model state. + * Used to register a post-fixer callback. A post-fixer mechanism that allows to update view tree just before rendering + * to the DOM is started. * - * An execution of a feature may lead to an incorrect document tree state. The callbacks are used to fix the document tree after - * it has changed. Post-fixers are fired just after all changes from the outermost change block were applied but - * before the {@link module:engine/model/document~Document#event:change change event} is fired. If a post-fixer callback made + * Post-fixers are fired just after all changes from the outermost change block were applied but + * before the {@link module:engine/view/view~View#event:render render event} is fired. If a post-fixer callback made * a change, it should return `true`. When this happens, all post-fixers are fired again to check if something else should * not be fixed in the new document tree state. * - * As a parameter, a post-fixer callback receives a {@link module:engine/model/writer~Writer writer} instance connected with the - * executed changes block. Thanks to that, all changes done by the callback will be added to the same - * {@link module:engine/model/batch~Batch batch} (and undo step) as the original changes. This makes post-fixer changes transparent - * for the user. - * - * An example of a post-fixer is a callback that checks if all the data were removed from the editor. If so, the - * callback should add an empty paragraph so that the editor is never empty: - * - * document.registerPostFixer( writer => { - * const changes = document.differ.getChanges(); - * - * // Check if the changes lead to an empty root in the editor. - * for ( const entry of changes ) { - * if ( entry.type == 'remove' && entry.position.root.isEmpty ) { - * writer.insertElement( 'paragraph', entry.position.root, 0 ); - * - * // It is fine to return early, even if multiple roots would need to be fixed. - * // All post-fixers will be fired again, so if there are more empty roots, those will be fixed, too. - * return true; - * } - * } - * } ); + * As a parameter, a post-fixer callback receives a {@link module:engine/view/writer~Writer writer} instance connected with the + * executed changes block. * * @param {Function} postFixer */ diff --git a/src/view/view.js b/src/view/view.js index fd1e974f8..8cfe9c40b 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -319,7 +319,19 @@ export default class View { change( callback ) { if ( this._renderingInProgress || this._postFixersInProgress ) { // TODO: better description - throw new CKEditorError( 'incorrect-view-change' ); + /** + * Thrown when there is an attempt to make changes to the view tree when it is in incorrect state. This may + * cause some unexpected behaviour and inconsistency between the DOM and the view. + * This may be caused by: + * * calling {@link #change} or {@link #render} during rendering process, + * * calling {@link #change} or {@link #render} inside of + * {@link module:engine/view/document~Document#registerPostFixer post fixer function}. + */ + throw new CKEditorError( + 'cannot-change-view-tree: ' + + 'Attempting to make changes to the view when it is in incorrect state: rendering or post fixers are in progress. ' + + 'This may cause some unexpected behaviour and inconsistency between the DOM and the view.' + ); } // Recursive call to view.change() method - execute listener immediately. @@ -380,13 +392,14 @@ export default class View { } /** - * TODO: fix description - * Fired after a topmost {@link module:engine/view/view~View#change change block} is finished and the DOM rendering has - * been executed. + * Fired after a topmost {@link module:engine/view/view~View#change change block} and all + * {@link module:engine/view/document~Document#registerPostFixer post fixers} are executed. * - * Actual rendering is performed on 'low' priority. This means that all listeners on 'normal' and above priorities - * will be executed after changes made to view tree but before rendering to the DOM. Use `low` priority for callbacks that - * should be executed after rendering to the DOM. + * Actual rendering is performed as a first listener on 'normal' priority. + * + * view.on( 'render', () => { + * // Rendering to the DOM is complete. + * } ); * * @event module:engine/view/view~View#event:render */ From e63634aef91a1f093ed9b9800f09c56d08c4b8ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 23 Feb 2018 16:15:14 +0100 Subject: [PATCH 646/724] Added more tests to view. --- src/view/document.js | 1 + src/view/view.js | 1 - tests/view/document.js | 33 +++++++++++++++++++++++++++++++ tests/view/placeholder.js | 17 +++++++++++++++- tests/view/view/view.js | 41 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 91 insertions(+), 2 deletions(-) diff --git a/src/view/document.js b/src/view/document.js index 8987b518a..0298dc843 100644 --- a/src/view/document.js +++ b/src/view/document.js @@ -109,6 +109,7 @@ export default class Document { * Performs post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model. * * @protected + * @param {module:engine/view/writer~Writer} writer */ _callPostFixers( writer ) { let wasFixed = false; diff --git a/src/view/view.js b/src/view/view.js index 8cfe9c40b..f6904ef05 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -318,7 +318,6 @@ export default class View { */ change( callback ) { if ( this._renderingInProgress || this._postFixersInProgress ) { - // TODO: better description /** * Thrown when there is an attempt to make changes to the view tree when it is in incorrect state. This may * cause some unexpected behaviour and inconsistency between the DOM and the view. diff --git a/tests/view/document.js b/tests/view/document.js index 797e19d27..d7962ea0f 100644 --- a/tests/view/document.js +++ b/tests/view/document.js @@ -58,4 +58,37 @@ describe( 'Document', () => { expect( viewDocument.getRoot( 'not-existing' ) ).to.null; } ); } ); + + describe( 'post fixers', () => { + it( 'should add a callback that is called on _callPostFixers', () => { + const spy1 = sinon.spy(); + const spy2 = sinon.spy(); + const writerMock = {}; + + viewDocument.registerPostFixer( spy1 ); + viewDocument.registerPostFixer( spy2 ); + + sinon.assert.notCalled( spy1 ); + sinon.assert.notCalled( spy2 ); + viewDocument._callPostFixers( writerMock ); + sinon.assert.calledOnce( spy1 ); + sinon.assert.calledOnce( spy2 ); + sinon.assert.calledWithExactly( spy1, writerMock ); + sinon.assert.calledWithExactly( spy2, writerMock ); + } ); + + it( 'should call post fixer until all returns false', () => { + let calls = 0; + + const spy1 = sinon.spy( () => calls++ < 2 ); + const spy2 = sinon.spy( () => calls++ < 2 ); + + viewDocument.registerPostFixer( spy1 ); + viewDocument.registerPostFixer( spy2 ); + + viewDocument._callPostFixers(); + + expect( calls ).to.equal( 4 ); + } ); + } ); } ); diff --git a/tests/view/placeholder.js b/tests/view/placeholder.js index c72a64298..06b3f600f 100644 --- a/tests/view/placeholder.js +++ b/tests/view/placeholder.js @@ -74,12 +74,17 @@ describe( 'placeholder', () => { it( 'use check function if one is provided', () => { setData( view, '

{another div}
' ); const element = viewRoot.getChild( 0 ); - const spy = sinon.spy( () => false ); + let result = true; + const spy = sinon.spy( () => result ); attachPlaceholder( view, element, 'foo bar baz', spy ); sinon.assert.called( spy ); expect( element.getAttribute( 'data-placeholder' ) ).to.equal( 'foo bar baz' ); + expect( element.hasClass( 'ck-placeholder' ) ).to.be.true; + + result = false; + view.render(); expect( element.hasClass( 'ck-placeholder' ) ).to.be.false; } ); @@ -190,5 +195,15 @@ describe( 'placeholder', () => { expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false; expect( element.hasClass( 'ck-placeholder' ) ).to.be.false; } ); + + it( 'should not blow up when called on element without placeholder', () => { + setData( view, '
{another div}
' ); + const element = viewRoot.getChild( 0 ); + + detachPlaceholder( view, element ); + + expect( element.hasAttribute( 'data-placeholder' ) ).to.be.false; + expect( element.hasClass( 'ck-placeholder' ) ).to.be.false; + } ); } ); } ); diff --git a/tests/view/view/view.js b/tests/view/view/view.js index 666f04547..bb5369e8e 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -15,8 +15,10 @@ import global from '@ckeditor/ckeditor5-utils/src/dom/global'; import ViewRange from '../../../src/view/range'; import RootEditableElement from '../../../src/view/rooteditableelement'; import ViewElement from '../../../src/view/element'; +import ViewPosition from '../../../src/view/position'; import { isBlockFiller, BR_FILLER } from '../../../src/view/filler'; import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'view', () => { const DEFAULT_OBSERVERS_COUNT = 5; @@ -443,6 +445,45 @@ describe( 'view', () => { } ); describe( 'change()', () => { + it( 'should throw when someone tries to change view during rendering', () => { + const domDiv = document.createElement( 'div' ); + const viewRoot = createViewRoot( viewDocument, 'div', 'main' ); + let renderingCalled = false; + view.attachDomRoot( domDiv ); + + view.change( writer => { + const p = writer.createContainerElement( 'p' ); + const ui = writer.createUIElement( 'span', null, function( domDocument ) { + const element = this.toDomElement( domDocument ); + + expect( () => view.change( () => {} ) ).to.throw( CKEditorError, /^cannot-change-view-tree/ ); + renderingCalled = true; + + return element; + } ); + writer.insert( ViewPosition.createAt( p ), ui ); + writer.insert( ViewPosition.createAt( viewRoot ), p ); + } ); + + expect( renderingCalled ).to.be.true; + domDiv.remove(); + } ); + + it( 'should throw when someone tries to use change() method in post fixer', () => { + const domDiv = document.createElement( 'div' ); + createViewRoot( viewDocument, 'div', 'main' ); + view.attachDomRoot( domDiv ); + + viewDocument.registerPostFixer( () => { + expect( () => { + view.change( () => {} ); + } ).to.throw( CKEditorError, /^cannot-change-view-tree/ ); + } ); + + view.render(); + domDiv.remove(); + } ); + it( 'should fire render event and it should trigger rendering before listeners on normal priority', () => { const renderSpy = sinon.spy( view._renderer, 'render' ); const eventSpy = sinon.spy(); From 3cd9d1ffa8bd5da2ebf9659a3a45bd71e7d31dd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 23 Feb 2018 16:45:04 +0100 Subject: [PATCH 647/724] Fixed docs. --- src/view/document.js | 6 +++--- src/view/placeholder.js | 8 +++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/view/document.js b/src/view/document.js index 0298dc843..436c1b680 100644 --- a/src/view/document.js +++ b/src/view/document.js @@ -67,7 +67,7 @@ export default class Document { this.set( 'isFocused', false ); /** - * Post-fixer callbacks registered to the model document. + * Post-fixer callbacks registered to the view document. * * @private * @member {Set} @@ -88,8 +88,8 @@ export default class Document { } /** - * Used to register a post-fixer callback. A post-fixer mechanism that allows to update view tree just before rendering - * to the DOM is started. + * Used to register a post-fixer callback. A post-fixers mechanism allows to update view tree just before rendering + * to the DOM. * * Post-fixers are fired just after all changes from the outermost change block were applied but * before the {@link module:engine/view/view~View#event:render render event} is fired. If a post-fixer callback made diff --git a/src/view/placeholder.js b/src/view/placeholder.js index fca5d987b..a77a743cf 100644 --- a/src/view/placeholder.js +++ b/src/view/placeholder.js @@ -16,6 +16,7 @@ const documentPlaceholders = new WeakMap(); * Attaches placeholder to provided element and updates it's visibility. To change placeholder simply call this method * once again with new parameters. * + * @param {module:engine/view/view~View} view View controller. * @param {module:engine/view/element~Element} element Element to attach placeholder to. * @param {String} placeholderText Placeholder text to use. * @param {Function} [checkFunction] If provided it will be called before checking if placeholder should be displayed. @@ -61,7 +62,8 @@ export function detachPlaceholder( view, element ) { // Updates all placeholders of given document. // // @private -// @param {module:engine/view/view~View} view +// @param {module:engine/view/document~Document} view +// @param {module:engine/view/writer~Writer} writer function updateAllPlaceholders( document, writer ) { const placeholders = documentPlaceholders.get( document ); let changed = false; @@ -78,9 +80,9 @@ function updateAllPlaceholders( document, writer ) { // Updates placeholder class of given element. // // @private -// @param {module:engine/view/view~View} view +// @param {module:engine/view/writer~Writer} writer // @param {module:engine/view/element~Element} element -// @param {Function} checkFunction +// @param {Object} info function updateSinglePlaceholder( writer, element, info ) { const document = element.document; const text = info.placeholderText; From 73ee765c301380703b2fb42921d3106f509fef4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 26 Feb 2018 15:02:35 +0100 Subject: [PATCH 648/724] Internal: Prevented from rendering view when markers are converted. --- src/controller/editingcontroller.js | 15 +++++---- tests/tickets/1323.js | 47 +++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 8 deletions(-) create mode 100644 tests/tickets/1323.js diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index cc336efc3..6869005f9 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -9,6 +9,7 @@ import RootEditableElement from '../view/rooteditableelement'; import View from '../view/view'; +import ViewWriter from '../view/writer'; import Mapper from '../conversion/mapper'; import DowncastDispatcher from '../conversion/downcastdispatcher'; import { @@ -106,6 +107,10 @@ export default class EditingController { // `removedMarkers` keeps information which markers already has been removed to prevent removing them twice. const removedMarkers = new Set(); + // We don't want to render view in the middle of the `Model#change` block, so we need to create view writer + // manually instead of using `View#change` block. See https://github.com/ckeditor/ckeditor5-engine/issues/1323. + const viewWriter = new ViewWriter( this.view.document ); + this.listenTo( model, 'applyOperation', ( evt, args ) => { // Before operation is applied... const operation = args[ 0 ]; @@ -121,10 +126,7 @@ export default class EditingController { if ( _operationAffectsMarker( operation, marker ) ) { // And if the operation in any way modifies the marker, remove the marker from the view. removedMarkers.add( marker.name ); - this.view.change( writer => { - this.downcastDispatcher.convertMarkerRemove( marker.name, markerRange, writer ); - } ); - + this.downcastDispatcher.convertMarkerRemove( marker.name, markerRange, viewWriter ); // TODO: This stinks but this is the safest place to have this code. this.model.document.differ.bufferMarkerChange( marker.name, markerRange, markerRange ); } @@ -135,10 +137,7 @@ export default class EditingController { this.listenTo( model.markers, 'update', ( evt, marker, oldRange ) => { if ( oldRange && !removedMarkers.has( marker.name ) ) { removedMarkers.add( marker.name ); - - this.view.change( writer => { - this.downcastDispatcher.convertMarkerRemove( marker.name, oldRange, writer ); - } ); + this.downcastDispatcher.convertMarkerRemove( marker.name, oldRange, viewWriter ); } } ); diff --git a/tests/tickets/1323.js b/tests/tickets/1323.js new file mode 100644 index 000000000..803fa3fe1 --- /dev/null +++ b/tests/tickets/1323.js @@ -0,0 +1,47 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import EditingController from '../../src/controller/editingcontroller'; + +import Model from '../../src/model/model'; +import ModelText from '../../src/model/text'; +import ModelRange from '../../src/model/range'; + +import MarkerOperation from '../../src/model/operation/markeroperation'; +import { wrapInDelta } from '../model/_utils/utils'; + +describe( 'Bug ckeditor5-engine@1323', () => { + describe( 'constructor()', () => { + let model, editing, root, range; + + beforeEach( () => { + model = new Model(); + editing = new EditingController( model ); + root = model.document.createRoot(); + root.appendChildren( new ModelText( 'foo' ) ); + range = ModelRange.createFromParentsAndOffsets( root, 0, root, 0 ); + } ); + + afterEach( () => { + editing.destroy(); + } ); + + it( 'should not fire view#render event before initial model#change block is finished', () => { + const spy = sinon.spy(); + + editing.view.on( 'render', spy ); + + model.change( () => { + // Add marker. + model.applyOperation( wrapInDelta( new MarkerOperation( 'name', null, range, model.markers, 0 ) ) ); + + // Remove marker. + model.applyOperation( wrapInDelta( new MarkerOperation( 'name', range, null, model.markers, 1 ) ) ); + + sinon.assert.notCalled( spy ); + } ); + } ); + } ); +} ); From 187c8c58f7cb97e0f27d19bafd5a9f5af553f5e8 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Mon, 26 Feb 2018 17:35:19 +0100 Subject: [PATCH 649/724] Update docs. --- src/controller/editingcontroller.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 6869005f9..15e7eb55a 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -107,7 +107,7 @@ export default class EditingController { // `removedMarkers` keeps information which markers already has been removed to prevent removing them twice. const removedMarkers = new Set(); - // We don't want to render view in the middle of the `Model#change` block, so we need to create view writer + // We don't want to render view when markers are converted, so we need to create view writer // manually instead of using `View#change` block. See https://github.com/ckeditor/ckeditor5-engine/issues/1323. const viewWriter = new ViewWriter( this.view.document ); From 1e598fbd23e8f62ef7b2f01fcf7d934b05f9ff68 Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Mon, 26 Feb 2018 17:59:10 +0100 Subject: [PATCH 650/724] Docs: view#render and view.document#postFixer use cases. [skip ci] --- src/view/document.js | 4 ++++ src/view/view.js | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/src/view/document.js b/src/view/document.js index 436c1b680..4b848d31c 100644 --- a/src/view/document.js +++ b/src/view/document.js @@ -96,6 +96,10 @@ export default class Document { * a change, it should return `true`. When this happens, all post-fixers are fired again to check if something else should * not be fixed in the new document tree state. * + * View post-fixers are useful when you wants to update view structure whenever it changes, for instance add some classes + * to elements based on the view structure or selection. However, is you need DOM elements to be already updated, use + * {@link module:engine/view/view~View#event:render render event}. + * * As a parameter, a post-fixer callback receives a {@link module:engine/view/writer~Writer writer} instance connected with the * executed changes block. * diff --git a/src/view/view.js b/src/view/view.js index f6904ef05..e9281c68b 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -400,6 +400,10 @@ export default class View { * // Rendering to the DOM is complete. * } ); * + * This event is useful when you want to update interface elements after the rendering, e.g. position of the + * balloon panel. If you wants to change view structure use + * {@link module:engine/view/document~Document#registerPostFixer post fixers}. + * * @event module:engine/view/view~View#event:render */ } From 5a801fe66300b32e070ec7a94bf9a7cb7caf24b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Mon, 26 Feb 2018 17:44:33 +0100 Subject: [PATCH 651/724] Improved docs. --- src/model/documentselection.js | 6 ++--- src/model/writer.js | 26 +++++++++++---------- src/utils/bindtwostepcarettoattribute.js | 29 ++++++++++++------------ 3 files changed, 32 insertions(+), 29 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index e5b31b106..58fc7447b 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -140,12 +140,12 @@ export default class DocumentSelection { } /** - * Describes whether gravity is overridden (using {@link ~DocumentSelection#_overrideGravity}) or not. + * Describes whether the gravity is overridden (using {@link module:engine/model/writer~Writer#overrideSelectionGravity}) or not. * - * Note that gravity remains overridden as long as won't be restored the same number of times as was overridden. + * Note that the gravity remains overridden as long as will not be restored the same number of times as it was overridden. * * @readonly - * @return {boolean} + * @return {Boolean} */ get isGravityOverridden() { return this._selection.isGravityOverridden; diff --git a/src/model/writer.js b/src/model/writer.js index 88fb4df70..4df67ba58 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -1017,25 +1017,27 @@ export default class Writer { } /** - * Temporarily changes the gravity of the selection from left to right. The gravity defines from which direction - * the selection inherits its attributes. If it's the default left gravity, the selection (after being moved by - * the user) inherits attributes from its left hand side. This method allows to temporarily override this behavior - * by forcing the gravity to the right. + * Temporarily changes the {@link module:engine/model/documentselection~DocumentSelection#isGravityOverridden gravity} + * of the selection from left to right. + * + * The gravity defines from which direction the selection inherits its attributes. If it's the default left gravity, + * then the selection (after being moved by the user) inherits attributes from its left-hand side. + * This method allows to temporarily override this behavior by forcing the gravity to the right. * * For the following model fragment: * - * <$text bold="true" linkHref="url">bar[]<$text bold="true">biz + * <$text bold="true" linkHref="url">bar[]<$text bold="true">biz * - * Default gravity: selection will have the `bold` and `linkHref` attributes. - * Overridden gravity: selection will have `bold` attribute. + * * Default gravity: selection will have the `bold` and `linkHref` attributes. + * * Overridden gravity: selection will have `bold` attribute. * * By default the selection's gravity is automatically restored just after a direct selection change (when user - * move caret) but you can pass customRestore = true in which case you will have to call + * moved the caret) but you can pass `customRestore = true` in which case you will have to call * {@link ~Writer#restoreSelectionGravity} manually. * - * When the selection's gravity is overridden more than once without restoring meanwhile then needs to be restored - * the same number of times as was overridden to revert default behavior. This is to prevent conflicts when - * more than one feature want independently override and restore selection's gravity. + * When the selection's gravity is overridden more than once without being restored in the meantime then it needs + * to be restored the same number of times. This is to prevent conflicts when + * more than one feature want to independently override and restore the selection's gravity. * * @param {Boolean} [customRestore=false] When `true` then gravity won't be restored until * {@link ~Writer#restoreSelectionGravity} will be called directly. When `false` then gravity is restored @@ -1048,7 +1050,7 @@ export default class Writer { /** * Restores {@link ~Writer#overrideSelectionGravity} gravity to default. * - * Note that selection's gravity remains overridden as long as won't be restored the same number of times as was overridden. + * Note that the gravity remains overridden as long as will not be restored the same number of times as it was overridden. */ restoreSelectionGravity() { this.model.document.selection._restoreGravity(); diff --git a/src/utils/bindtwostepcarettoattribute.js b/src/utils/bindtwostepcarettoattribute.js index b751eebd0..6bacc6d02 100644 --- a/src/utils/bindtwostepcarettoattribute.js +++ b/src/utils/bindtwostepcarettoattribute.js @@ -10,30 +10,31 @@ import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; /** - * This helper adds two-steps caret movement behaviour for given attribute. + * This helper adds two-step caret movement behavior for the given attribute. * - * When caret is moving by arrow keys and reach bound of text with attribute for which behaviour is enabled - * then typing does not expand this attribute. Additional arrow key press is needed to "enter" to the text - * and start typing with this attribute. The same is is for leaving this text. + * For example, when this behavior is enabled for the `linkHref` attribute (which converts to `` element in the view) + * and the caret is just before an `` element (at a link boundary), then pressing + * the right arrow key will move caret into that ``element instead of moving it after the next character: * - * When behaviour is enabled for `linkHref` attribute and caret is just before the attribute element then pressing - * right arrow will move caret inside the attribute element instead of moving after next character: + * * With two-step caret movement: `

foo{}barbiz

` + → => `

foo{}barbiz

` + * * Without two-step caret movement: `

foo{}barbiz

` + → => `

foob{}arbiz

` * - *

foo{}barbiz

`->`

foo{}foobarr

+ * The same behavior will be changed fo "leaving" an attribute element: * - * The same is for "leaving" attribute element: - * - *

foobar{}biz

`->`

foobar{}biz

+ * * With two-step caret movement: `

foobar{}biz

` + → => `

foobar{}biz

` + * * Without two-step caret movement: `

foobar{}biz

` + → => `

foobarb{}iz

` * * And when moving left: * - *

foobar{}biz

`<-`

foobar{}biz

- *

foo{}barbiz

`<-`

foo{}barbiz

+ * * With two-step caret movement: `

foobarb{}iz

` + ← => `

foobar{}biz

` + + * ← => `

foobar{}biz

` + * * Without two-step caret movement: `

foobarb{}iz

` + ← => `

foobar{}biz

` * * @param {module:engine/view/view~View} view View controller instance. * @param {module:engine/model/model~Model} model Data model instance. - * @param {module:utils/dom/emittermixin~Emitter} emitter The emitter to which this behavior should be added. - * @param {String} attribute Attribute for which behaviour will be added. + * @param {module:utils/dom/emittermixin~Emitter} emitter The emitter to which this behavior should be added + * (e.g. a plugin instance). + * @param {String} attribute Attribute for which this behavior will be added. */ export default function bindTwoStepCaretToAttribute( view, model, emitter, attribute ) { const modelSelection = model.document.selection; From 8a68b0ea18a60b560be8e9a6caf3a3566b64ac64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Mon, 26 Feb 2018 18:26:04 +0100 Subject: [PATCH 652/724] Docs: Fixed broken links. --- src/view/view.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/view/view.js b/src/view/view.js index e9281c68b..a62a2224f 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -109,7 +109,7 @@ export default class View { this._ongoingChange = false; /** - * Used to prevent calling {@link #render} and {@link #change) during rendering view to the DOM. + * Used to prevent calling {@link #render} and {@link #change} during rendering view to the DOM. * * @private * @member {Boolean} module:engine/view/view~View#_renderingInProgress @@ -117,7 +117,7 @@ export default class View { this._renderingInProgress = false; /** - * Used to prevent calling {@link #render} and {@link #change) during rendering view to the DOM. + * Used to prevent calling {@link #render} and {@link #change} during rendering view to the DOM. * * @private * @member {Boolean} module:engine/view/view~View#_renderingInProgress From 4708d592b118207523bca390c08dade886e016ba Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Tue, 27 Feb 2018 11:52:16 +0100 Subject: [PATCH 653/724] Changed public API to protected. --- src/dev-utils/view.js | 12 +- src/model/delta/basic-transformations.js | 4 +- src/model/documentfragment.js | 25 ++- src/model/element.js | 107 ++++++------ src/model/node.js | 33 ++-- src/model/nodelist.js | 8 +- src/model/operation/rootattributeoperation.js | 4 +- src/model/operation/utils.js | 20 +-- src/model/text.js | 4 + src/model/utils/insertcontent.js | 2 +- src/view/attributeelement.js | 1 + src/view/containerelement.js | 1 + src/view/documentfragment.js | 18 +- src/view/domconverter.js | 2 +- src/view/element.js | 129 ++++++++------- src/view/emptyelement.js | 7 +- src/view/node.js | 8 +- src/view/selection.js | 12 +- src/view/text.js | 4 + src/view/uielement.js | 4 +- src/view/writer.js | 34 ++-- tests/controller/editingcontroller.js | 4 +- tests/conversion/downcast-converters.js | 12 +- .../downcast-selection-converters.js | 16 +- tests/conversion/downcastdispatcher.js | 14 +- tests/conversion/mapper.js | 4 +- tests/conversion/viewconsumable.js | 2 +- tests/dataprocessor/htmldataprocessor.js | 2 +- tests/dataprocessor/xmldataprocessor.js | 2 +- tests/dev-utils/enableenginedebug.js | 28 ++-- tests/dev-utils/model.js | 16 +- tests/dev-utils/view.js | 4 +- tests/model/delta/renamedelta.js | 2 +- tests/model/delta/transform/_utils/utils.js | 2 +- tests/model/delta/transform/splitdelta.js | 2 +- tests/model/delta/transform/transform.js | 2 +- tests/model/differ.js | 14 +- tests/model/document.js | 2 +- tests/model/documentfragment.js | 22 +-- tests/model/documentselection.js | 54 +++--- tests/model/element.js | 26 +-- tests/model/liveposition.js | 2 +- tests/model/liverange.js | 2 +- tests/model/markercollection.js | 2 +- tests/model/node.js | 38 ++--- tests/model/nodelist.js | 14 +- tests/model/operation/attributeoperation.js | 34 ++-- tests/model/operation/detachoperation.js | 2 +- tests/model/operation/insertoperation.js | 2 +- tests/model/operation/markeroperation.js | 2 +- tests/model/operation/moveoperation.js | 26 +-- tests/model/operation/reinsertoperation.js | 6 +- tests/model/operation/removeoperation.js | 8 +- tests/model/operation/renameoperation.js | 2 +- .../model/operation/rootattributeoperation.js | 12 +- tests/model/operation/utils.js | 2 +- tests/model/position.js | 6 +- tests/model/range.js | 18 +- tests/model/schema.js | 16 +- tests/model/selection.js | 4 +- tests/model/textproxy.js | 4 +- tests/model/treewalker.js | 2 +- tests/model/utils-tests/utils.js | 4 +- tests/model/utils/deletecontent.js | 12 +- tests/model/writer.js | 50 +++--- tests/tickets/1323.js | 2 +- tests/view/documentfragment.js | 64 ++++---- tests/view/domconverter/view-to-dom.js | 22 +-- tests/view/element.js | 50 +++--- tests/view/emptyelement.js | 8 +- tests/view/manual/uielement.js | 2 +- tests/view/node.js | 36 ++-- tests/view/observer/domeventobserver.js | 2 +- tests/view/observer/mutationobserver.js | 32 ++-- tests/view/observer/selectionobserver.js | 2 +- tests/view/renderer.js | 154 +++++++++--------- tests/view/selection.js | 2 +- tests/view/treewalker.js | 2 +- tests/view/uielement.js | 8 +- tests/view/view/jumpoverinlinefiller.js | 2 +- tests/view/view/jumpoveruielement.js | 28 ++-- tests/view/view/view.js | 4 +- 82 files changed, 703 insertions(+), 656 deletions(-) diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index bb20f74b4..7513d8406 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -322,10 +322,10 @@ export function parse( data, options = {} ) { // If custom root is provided - move all nodes there. if ( options.rootElement ) { const root = options.rootElement; - const nodes = view.removeChildren( 0, view.childCount ); + const nodes = view._removeChildren( 0, view.childCount ); - root.removeChildren( 0, root.childCount ); - root.appendChildren( nodes ); + root._removeChildren( 0, root.childCount ); + root._appendChildren( nodes ); view = root; } @@ -350,7 +350,7 @@ export function parse( data, options = {} ) { // If single element is returned without selection - remove it from parent and return detached element. if ( view.parent ) { - view.remove(); + view._remove(); } return view; @@ -455,7 +455,7 @@ class RangeParser { // Remove empty text nodes. if ( !text ) { - node.remove(); + node._remove(); } for ( const item of brackets ) { @@ -887,7 +887,7 @@ function _convertViewElements( rootNode ) { throw new Error( 'Parse error - cannot parse inside UIElement.' ); } - convertedElement.appendChildren( _convertViewElements( child ) ); + convertedElement._appendChildren( _convertViewElements( child ) ); } return convertedElement; diff --git a/src/model/delta/basic-transformations.js b/src/model/delta/basic-transformations.js index 0e7f74eb7..f23ea6e89 100644 --- a/src/model/delta/basic-transformations.js +++ b/src/model/delta/basic-transformations.js @@ -369,9 +369,9 @@ addTransformationCase( SplitDelta, AttributeDelta, ( a, b, context ) => { for ( const operation of b.operations ) { if ( operation.range.containsPosition( splitPosition ) || operation.range.start.isEqual( splitPosition ) ) { if ( operation.newValue !== null ) { - a._cloneOperation.nodes.getNode( 0 ).setAttribute( operation.key, operation.newValue ); + a._cloneOperation.nodes.getNode( 0 )._setAttribute( operation.key, operation.newValue ); } else { - a._cloneOperation.nodes.getNode( 0 ).removeAttribute( operation.key ); + a._cloneOperation.nodes.getNode( 0 )._removeAttribute( operation.key ); } break; diff --git a/src/model/documentfragment.js b/src/model/documentfragment.js index de3eab584..6cc5c7f39 100644 --- a/src/model/documentfragment.js +++ b/src/model/documentfragment.js @@ -25,6 +25,10 @@ export default class DocumentFragment { /** * Creates an empty `DocumentFragment`. * + * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * {@link module:engine/model/writer~Writer.createDocumentFragment} method. + * + * @protected * @param {module:engine/model/node~Node|Iterable.} [children] * Nodes to be contained inside the `DocumentFragment`. */ @@ -47,7 +51,7 @@ export default class DocumentFragment { this._children = new NodeList(); if ( children ) { - this.insertChildren( 0, children ); + this._insertChildren( 0, children ); } } @@ -217,46 +221,49 @@ export default class DocumentFragment { } /** - * {@link #insertChildren Inserts} one or more nodes at the end of this document fragment. + * {@link #_insertChildren Inserts} one or more nodes at the end of this document fragment. * + * @protected * @param {module:engine/model/item~Item|Iterable.} items Items to be inserted. */ - appendChildren( items ) { - this.insertChildren( this.childCount, items ); + _appendChildren( items ) { + this._insertChildren( this.childCount, items ); } /** * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes * to this document fragment. * + * @protected * @param {Number} index Index at which nodes should be inserted. * @param {module:engine/model/item~Item|Iterable.} items Items to be inserted. */ - insertChildren( index, items ) { + _insertChildren( index, items ) { const nodes = normalize( items ); for ( const node of nodes ) { // If node that is being added to this element is already inside another element, first remove it from the old parent. if ( node.parent !== null ) { - node.remove(); + node._remove(); } node.parent = this; } - this._children.insertNodes( index, nodes ); + this._children._insertNodes( index, nodes ); } /** * Removes one or more nodes starting at the given index * and sets {@link module:engine/model/node~Node#parent parent} of these nodes to `null`. * + * @protected * @param {Number} index Index of the first node to remove. * @param {Number} [howMany=1] Number of nodes to remove. * @returns {Array.} Array containing removed nodes. */ - removeChildren( index, howMany = 1 ) { - const nodes = this._children.removeNodes( index, howMany ); + _removeChildren( index, howMany = 1 ) { + const nodes = this._children._removeNodes( index, howMany ); for ( const node of nodes ) { node.parent = null; diff --git a/src/model/element.js b/src/model/element.js index faebdbed7..958508702 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -25,6 +25,10 @@ export default class Element extends Node { /** * Creates a model element. * + * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * {@link module:engine/model/writer~Writer.createElement} method. + * + * @protected * @param {String} name Element's name. * @param {Object} [attrs] Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values. * @param {module:engine/model/node~Node|Iterable.} [children] @@ -49,7 +53,7 @@ export default class Element extends Node { this._children = new NodeList(); if ( children ) { - this.insertChildren( 0, children ); + this._insertChildren( 0, children ); } } @@ -185,55 +189,6 @@ export default class Element extends Node { return this._children.offsetToIndex( offset ); } - /** - * {@link module:engine/model/element~Element#insertChildren Inserts} one or more nodes at the end of this element. - * - * @param {module:engine/model/item~Item|Iterable.} nodes Nodes to be inserted. - */ - appendChildren( nodes ) { - this.insertChildren( this.childCount, nodes ); - } - - /** - * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes - * to this element. - * - * @param {Number} index Index at which nodes should be inserted. - * @param {module:engine/model/item~Item|Iterable.} items Items to be inserted. - */ - insertChildren( index, items ) { - const nodes = normalize( items ); - - for ( const node of nodes ) { - // If node that is being added to this element is already inside another element, first remove it from the old parent. - if ( node.parent !== null ) { - node.remove(); - } - - node.parent = this; - } - - this._children.insertNodes( index, nodes ); - } - - /** - * Removes one or more nodes starting at the given index and sets - * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`. - * - * @param {Number} index Index of the first node to remove. - * @param {Number} [howMany=1] Number of nodes to remove. - * @returns {Array.} Array containing removed nodes. - */ - removeChildren( index, howMany = 1 ) { - const nodes = this._children.removeNodes( index, howMany ); - - for ( const node of nodes ) { - node.parent = null; - } - - return nodes; - } - /** * Returns a descendant node by its path relative to this element. * @@ -276,6 +231,58 @@ export default class Element extends Node { return json; } + /** + * {@link module:engine/model/element~Element#_insertChildren Inserts} one or more nodes at the end of this element. + * + * @protected + * @param {module:engine/model/item~Item|Iterable.} nodes Nodes to be inserted. + */ + _appendChildren( nodes ) { + this._insertChildren( this.childCount, nodes ); + } + + /** + * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes + * to this element. + * + * @protected + * @param {Number} index Index at which nodes should be inserted. + * @param {module:engine/model/item~Item|Iterable.} items Items to be inserted. + */ + _insertChildren( index, items ) { + const nodes = normalize( items ); + + for ( const node of nodes ) { + // If node that is being added to this element is already inside another element, first remove it from the old parent. + if ( node.parent !== null ) { + node._remove(); + } + + node.parent = this; + } + + this._children._insertNodes( index, nodes ); + } + + /** + * Removes one or more nodes starting at the given index and sets + * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`. + * + * @protected + * @param {Number} index Index of the first node to remove. + * @param {Number} [howMany=1] Number of nodes to remove. + * @returns {Array.} Array containing removed nodes. + */ + _removeChildren( index, howMany = 1 ) { + const nodes = this._children._removeNodes( index, howMany ); + + for ( const node of nodes ) { + node.parent = null; + } + + return nodes; + } + /** * Creates an `Element` instance from given plain object (i.e. parsed JSON string). * Converts `Element` children to proper nodes. diff --git a/src/model/node.js b/src/model/node.js index 8f44dd6e5..8f4a986e6 100644 --- a/src/model/node.js +++ b/src/model/node.js @@ -19,8 +19,8 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * However, it is **very important** that nodes already attached to model tree should be only changed through * {@link module:engine/model/writer~Writer Writer API}. * - * Changes done by `Node` methods, like {@link module:engine/model/element~Element#insertChildren insertChildren} or - * {@link module:engine/model/node~Node#setAttribute setAttribute} + * Changes done by `Node` methods, like {@link module:engine/model/element~Element#_insertChildren _insertChildren} or + * {@link module:engine/model/node~Node#_setAttribute _setAttribute} * do not generate {@link module:engine/model/operation/operation~Operation operations} * which are essential for correct editor work if you modify nodes in {@link module:engine/model/document~Document document} root. * @@ -282,13 +282,6 @@ export default class Node { return i === 0 ? null : ancestorsA[ i - 1 ]; } - /** - * Removes this node from it's parent. - */ - remove() { - this.parent.removeChildren( this.index ); - } - /** * Checks if the node has an attribute with given key. * @@ -330,39 +323,53 @@ export default class Node { return this._attrs.keys(); } + /** + * Removes this node from it's parent. + * + * @protected + */ + _remove() { + this.parent._removeChildren( this.index ); + } + /** * Sets attribute on the node. If attribute with the same key already is set, it's value is overwritten. * + * @protected * @param {String} key Key of attribute to set. * @param {*} value Attribute value. */ - setAttribute( key, value ) { + _setAttribute( key, value ) { this._attrs.set( key, value ); } /** * Removes all attributes from the node and sets given attributes. * + * @protected * @param {Object} [attrs] Attributes to set. See {@link module:utils/tomap~toMap} for a list of accepted values. */ - setAttributesTo( attrs ) { + _setAttributesTo( attrs ) { this._attrs = toMap( attrs ); } /** * Removes an attribute with given key from the node. * + * @protected * @param {String} key Key of attribute to remove. * @returns {Boolean} `true` if the attribute was set on the element, `false` otherwise. */ - removeAttribute( key ) { + _removeAttribute( key ) { return this._attrs.delete( key ); } /** * Removes all attributes from the node. + * + * @protected */ - clearAttributes() { + _clearAttributes() { this._attrs.clear(); } diff --git a/src/model/nodelist.js b/src/model/nodelist.js index e679173b4..6c481bc93 100644 --- a/src/model/nodelist.js +++ b/src/model/nodelist.js @@ -31,7 +31,7 @@ export default class NodeList { this._nodes = []; if ( nodes ) { - this.insertNodes( 0, nodes ); + this._insertNodes( 0, nodes ); } } @@ -164,10 +164,11 @@ export default class NodeList { /** * Inserts given nodes at given index. * + * @protected * @param {Number} index Index at which nodes should be inserted. * @param {Iterable.} nodes Nodes to be inserted. */ - insertNodes( index, nodes ) { + _insertNodes( index, nodes ) { // Validation. for ( const node of nodes ) { if ( !( node instanceof Node ) ) { @@ -186,11 +187,12 @@ export default class NodeList { /** * Removes one or more nodes starting at the given index. * + * @protected * @param {Number} indexStart Index of the first node to remove. * @param {Number} [howMany=1] Number of nodes to remove. * @returns {Array.} Array containing removed nodes. */ - removeNodes( indexStart, howMany = 1 ) { + _removeNodes( indexStart, howMany = 1 ) { return this._nodes.splice( indexStart, howMany ); } diff --git a/src/model/operation/rootattributeoperation.js b/src/model/operation/rootattributeoperation.js index 50e61af05..6357cb82d 100644 --- a/src/model/operation/rootattributeoperation.js +++ b/src/model/operation/rootattributeoperation.js @@ -156,9 +156,9 @@ export default class RootAttributeOperation extends Operation { */ _execute() { if ( this.newValue !== null ) { - this.root.setAttribute( this.key, this.newValue ); + this.root._setAttribute( this.key, this.newValue ); } else { - this.root.removeAttribute( this.key ); + this.root._removeAttribute( this.key ); } } diff --git a/src/model/operation/utils.js b/src/model/operation/utils.js index 30ca982ad..a48763de2 100644 --- a/src/model/operation/utils.js +++ b/src/model/operation/utils.js @@ -45,7 +45,7 @@ export function _insert( position, nodes ) { // Insert nodes at given index. After splitting we have a proper index and insertion is between nodes, // using basic `Element` API. - parent.insertChildren( index, nodes ); + parent._insertChildren( index, nodes ); // Merge text nodes, if possible. Merging is needed only at points where inserted nodes "touch" "old" nodes. _mergeNodesAtIndex( parent, index + nodes.length ); @@ -58,7 +58,7 @@ export function _insert( position, nodes ) { * Removed nodes in given range. Only {@link module:engine/model/range~Range#isFlat flat} ranges are accepted. * * @protected - * @function module:engine/model/operation/utils~utils.remove + * @function module:engine/model/operation/utils~utils._remove * @param {module:engine/model/range~Range} range Range containing nodes to remove. * @returns {Array.} */ @@ -80,7 +80,7 @@ export function _remove( range ) { _splitNodeAtPosition( range.end ); // Remove the text nodes using basic `Element` API. - const removed = parent.removeChildren( range.start.index, range.end.index - range.start.index ); + const removed = parent._removeChildren( range.start.index, range.end.index - range.start.index ); // Merge text nodes, if possible. After some nodes were removed, node before and after removed range will be // touching at the position equal to the removed range beginning. We check merging possibility there. @@ -122,7 +122,7 @@ export function _move( sourceRange, targetPosition ) { * Sets given attribute on nodes in given range. * * @protected - * @function module:engine/model/operation/utils~utils.setAttribute + * @function module:engine/model/operation/utils~utils._setAttribute * @param {module:engine/model/range~Range} range Range containing nodes that should have the attribute set. * @param {String} key Key of attribute to set. * @param {*} value Attribute value. @@ -140,9 +140,9 @@ export function _setAttribute( range, key, value ) { const node = item.is( 'textProxy' ) ? item.textNode : item; if ( value !== null ) { - node.setAttribute( key, value ); + node._setAttribute( key, value ); } else { - node.removeAttribute( key ); + node._removeAttribute( key ); } // After attributes changing it may happen that some text nodes can be merged. Try to merge with previous node. @@ -221,10 +221,10 @@ function _mergeNodesAtIndex( element, index ) { const mergedNode = new Text( nodeBefore.data + nodeAfter.data, nodeBefore.getAttributes() ); // Remove separate text nodes. - element.removeChildren( index - 1, 2 ); + element._removeChildren( index - 1, 2 ); // Insert merged text node. - element.insertChildren( index - 1, mergedNode ); + element._insertChildren( index - 1, mergedNode ); } } @@ -244,12 +244,12 @@ function _splitNodeAtPosition( position ) { const offsetDiff = position.offset - textNode.startOffset; const index = textNode.index; - element.removeChildren( index, 1 ); + element._removeChildren( index, 1 ); const firstPart = new Text( textNode.data.substr( 0, offsetDiff ), textNode.getAttributes() ); const secondPart = new Text( textNode.data.substr( offsetDiff ), textNode.getAttributes() ); - element.insertChildren( index, [ firstPart, secondPart ] ); + element._insertChildren( index, [ firstPart, secondPart ] ); } } diff --git a/src/model/text.js b/src/model/text.js index 3a09c741e..65f80b2bf 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -26,6 +26,10 @@ export default class Text extends Node { /** * Creates a text node. * + * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * {@link module:engine/model/writer~Writer.createText} method. + * + * @protected * @param {String} data Node's text. * @param {Object} [attrs] Node's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values. */ diff --git a/src/model/utils/insertcontent.js b/src/model/utils/insertcontent.js index 31bf332f3..ff990fa13 100644 --- a/src/model/utils/insertcontent.js +++ b/src/model/utils/insertcontent.js @@ -382,7 +382,7 @@ class Insertion { // cause that would lead to an infinite loop. The paragraph would be rejected in // the next _handleNode() call and we'd be here again. if ( this._getAllowedIn( paragraph, this.position.parent ) && this.schema.checkChild( paragraph, node ) ) { - paragraph.appendChildren( node ); + paragraph._appendChildren( node ); this._handleNode( paragraph, context ); } } diff --git a/src/view/attributeelement.js b/src/view/attributeelement.js index 5c0892d94..6d1665179 100644 --- a/src/view/attributeelement.js +++ b/src/view/attributeelement.js @@ -26,6 +26,7 @@ export default class AttributeElement extends Element { /** * Creates a attribute element. * + * @protected * @see module:engine/view/element~Element */ constructor( name, attrs, children ) { diff --git a/src/view/containerelement.js b/src/view/containerelement.js index b6928fe28..7520dd785 100644 --- a/src/view/containerelement.js +++ b/src/view/containerelement.js @@ -48,6 +48,7 @@ export default class ContainerElement extends Element { /** * Creates a container element. * + * @protected * @see module:engine/view/element~Element */ constructor( name, attrs, children ) { diff --git a/src/view/documentfragment.js b/src/view/documentfragment.js index 939a2d5ad..620a22f47 100644 --- a/src/view/documentfragment.js +++ b/src/view/documentfragment.js @@ -20,6 +20,10 @@ export default class DocumentFragment { /** * Creates new DocumentFragment instance. * + * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * {@link module:engine/view/writer~Writer.createDocumentFragment} method. + * + * @protected * @param {module:engine/view/node~Node|Iterable.} [children] List of nodes to be inserted into * created document fragment. */ @@ -33,7 +37,7 @@ export default class DocumentFragment { this._children = []; if ( children ) { - this.insertChildren( 0, children ); + this._insertChildren( 0, children ); } } @@ -101,14 +105,14 @@ export default class DocumentFragment { } /** - * {@link module:engine/view/documentfragment~DocumentFragment#insertChildren Insert} a child node or a list of child nodes at the end + * {@link module:engine/view/documentfragment~DocumentFragment#_insertChildren Insert} a child node or a list of child nodes at the end * and sets the parent of these nodes to this fragment. * * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. * @returns {Number} Number of appended nodes. */ - appendChildren( items ) { - return this.insertChildren( this.childCount, items ); + _appendChildren( items ) { + return this._insertChildren( this.childCount, items ); } /** @@ -148,7 +152,7 @@ export default class DocumentFragment { * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. * @returns {Number} Number of inserted nodes. */ - insertChildren( index, items ) { + _insertChildren( index, items ) { this._fireChange( 'children', this ); let count = 0; @@ -157,7 +161,7 @@ export default class DocumentFragment { for ( const node of nodes ) { // If node that is being added to this element is already inside another element, first remove it from the old parent. if ( node.parent !== null ) { - node.remove(); + node._remove(); } node.parent = this; @@ -177,7 +181,7 @@ export default class DocumentFragment { * @param {Number} [howMany=1] Number of nodes to remove. * @returns {Array.} The array of removed nodes. */ - removeChildren( index, howMany = 1 ) { + _removeChildren( index, howMany = 1 ) { this._fireChange( 'children', this ); for ( let i = index; i < index + howMany; i++ ) { diff --git a/src/view/domconverter.js b/src/view/domconverter.js index 0d20baf50..981094715 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -419,7 +419,7 @@ export default class DomConverter { if ( options.withChildren || options.withChildren === undefined ) { for ( const child of this.domChildrenToView( domNode, options ) ) { - viewElement.appendChildren( child ); + viewElement._appendChildren( child ); } } diff --git a/src/view/element.js b/src/view/element.js index 4361a180b..4afb7ef6c 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -38,6 +38,10 @@ export default class Element extends Node { * new Element( 'div', [ [ 'class', 'editor' ], [ 'contentEditable', 'true' ] ] ); // map-like iterator * new Element( 'div', mapOfAttributes ); // map * + * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * {@link module:engine/view/writer~Writer.createElement} method. + * + * @protected * @param {String} name Node name. * @param {Object|Iterable} [attrs] Collection of attributes. * @param {module:engine/view/node~Node|Iterable.} [children] @@ -71,7 +75,7 @@ export default class Element extends Node { this._children = []; if ( children ) { - this.insertChildren( 0, children ); + this._insertChildren( 0, children ); } /** @@ -185,18 +189,6 @@ export default class Element extends Node { return cloned; } - /** - * {@link module:engine/view/element~Element#insertChildren Insert} a child node or a list of child nodes at the end of this node - * and sets the parent of these nodes to this element. - * - * @fires module:engine/view/node~Node#change - * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. - * @returns {Number} Number of appended nodes. - */ - appendChildren( items ) { - return this.insertChildren( this.childCount, items ); - } - /** * Gets child at the given index. * @@ -317,55 +309,6 @@ export default class Element extends Node { return this._attrs.has( key ); } - /** - * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to - * this element. - * - * @param {Number} index Position where nodes should be inserted. - * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. - * @fires module:engine/view/node~Node#change - * @returns {Number} Number of inserted nodes. - */ - insertChildren( index, items ) { - this._fireChange( 'children', this ); - let count = 0; - - const nodes = normalize( items ); - - for ( const node of nodes ) { - // If node that is being added to this element is already inside another element, first remove it from the old parent. - if ( node.parent !== null ) { - node.remove(); - } - - node.parent = this; - - this._children.splice( index, 0, node ); - index++; - count++; - } - - return count; - } - - /** - * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`. - * - * @param {Number} index Number of the first node to remove. - * @param {Number} [howMany=1] Number of nodes to remove. - * @returns {Array.} The array of removed nodes. - * @fires module:engine/view/node~Node#change - */ - removeChildren( index, howMany = 1 ) { - this._fireChange( 'children', this ); - - for ( let i = index; i < index + howMany; i++ ) { - this._children[ i ].parent = null; - } - - return this._children.splice( index, howMany ); - } - /** * Checks if this element is similar to other element. * Both elements should have the same name and attributes to be considered as similar. Two similar elements @@ -564,6 +507,68 @@ export default class Element extends Node { ( attributes == '' ? '' : ` ${ attributes }` ); } + /** + * {@link module:engine/view/element~Element#_insertChildren Insert} a child node or a list of child nodes at the end of this node + * and sets the parent of these nodes to this element. + * + * @fires module:engine/view/node~Node#change + * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. + * @returns {Number} Number of appended nodes. + */ + _appendChildren( items ) { + return this._insertChildren( this.childCount, items ); + } + + /** + * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to + * this element. + * + * @protected + * @param {Number} index Position where nodes should be inserted. + * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. + * @fires module:engine/view/node~Node#change + * @returns {Number} Number of inserted nodes. + */ + _insertChildren( index, items ) { + this._fireChange( 'children', this ); + let count = 0; + + const nodes = normalize( items ); + + for ( const node of nodes ) { + // If node that is being added to this element is already inside another element, first remove it from the old parent. + if ( node.parent !== null ) { + node._remove(); + } + + node.parent = this; + + this._children.splice( index, 0, node ); + index++; + count++; + } + + return count; + } + + /** + * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`. + * + * @param {Number} index Number of the first node to remove. + * @param {Number} [howMany=1] Number of nodes to remove. + * @returns {Array.} The array of removed nodes. + * @fires module:engine/view/node~Node#change + */ + _removeChildren( index, howMany = 1 ) { + this._fireChange( 'children', this ); + + for ( let i = index; i < index + howMany; i++ ) { + this._children[ i ].parent = null; + } + + return this._children.splice( index, howMany ); + } + /** * Adds or overwrite attribute with a specified key and value. * diff --git a/src/view/emptyelement.js b/src/view/emptyelement.js index a214cdc97..69a07cfbd 100644 --- a/src/view/emptyelement.js +++ b/src/view/emptyelement.js @@ -21,6 +21,7 @@ export default class EmptyElement extends Element { * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed, * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden). * + * @protected * @param {String} name Node name. * @param {Object|Iterable} [attributes] Collection of attributes. */ @@ -48,11 +49,13 @@ export default class EmptyElement extends Element { } /** - * Overrides {@link module:engine/view/element~Element#insertChildren} method. + * Overrides {@link module:engine/view/element~Element#_insertChildren} method. * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent * adding any child nodes to EmptyElement. + * + * @protected */ - insertChildren( index, nodes ) { + _insertChildren( index, nodes ) { if ( nodes && ( nodes instanceof Node || Array.from( nodes ).length > 0 ) ) { /** * Cannot add children to {@link module:engine/view/emptyelement~EmptyElement}. diff --git a/src/view/node.js b/src/view/node.js index f487d3977..b7f57eeaf 100644 --- a/src/view/node.js +++ b/src/view/node.js @@ -25,7 +25,7 @@ export default class Node { */ constructor() { /** - * Parent element. Null by default. Set by {@link module:engine/view/element~Element#insertChildren}. + * Parent element. Null by default. Set by {@link module:engine/view/element~Element#_insertChildren}. * * @readonly * @member {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null} @@ -164,9 +164,11 @@ export default class Node { /** * Removes node from parent. + * + * @protected */ - remove() { - this.parent.removeChildren( this.index ); + _remove() { + this.parent._removeChildren( this.index ); } /** diff --git a/src/view/selection.js b/src/view/selection.js index 11eb78929..66cfb5741 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -408,26 +408,26 @@ export default class Selection { * * // Sets ranges from the given range. * const range = new Range( start, end ); - * selection.setTo( range, isBackwardSelection ); + * selection._setTo( range, isBackwardSelection ); * * // Sets ranges from the iterable of ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * selection.setTo( range, isBackwardSelection ); + * selection._setTo( range, isBackwardSelection ); * * // Sets ranges from the other selection. * const otherSelection = new Selection(); - * selection.setTo( otherSelection ); + * selection._setTo( otherSelection ); * * // Sets collapsed range at the given position. * const position = new Position( root, path ); - * selection.setTo( position ); + * selection._setTo( position ); * * // Sets collapsed range on the given item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, offset ); + * selection._setTo( paragraph, offset ); * * // Removes all ranges. - * selection.setTo( null ); + * selection._setTo( null ); * * @protected * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| diff --git a/src/view/text.js b/src/view/text.js index 68a3fa697..ba82edffe 100644 --- a/src/view/text.js +++ b/src/view/text.js @@ -18,6 +18,10 @@ export default class Text extends Node { /** * Creates a tree view text node. * + * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * {@link module:engine/view/writer~Writer.createText} method. + * + * @protected * @param {String} data Text. */ constructor( data ) { diff --git a/src/view/uielement.js b/src/view/uielement.js index 16d7252ce..c7c9b3e9c 100644 --- a/src/view/uielement.js +++ b/src/view/uielement.js @@ -50,11 +50,11 @@ export default class UIElement extends Element { } /** - * Overrides {@link module:engine/view/element~Element#insertChildren} method. + * Overrides {@link module:engine/view/element~Element#_insertChildren} method. * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` to prevent adding any child nodes * to UIElement. */ - insertChildren( index, nodes ) { + _insertChildren( index, nodes ) { if ( nodes && ( nodes instanceof Node || Array.from( nodes ).length > 0 ) ) { /** * Cannot add children to {@link module:engine/view/uielement~UIElement}. diff --git a/src/view/writer.js b/src/view/writer.js index 1b54e87c3..62fef1966 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -461,7 +461,7 @@ export default class Writer { if ( positionParent.is( 'attributeElement' ) && positionParent.childCount === 0 ) { const parent = positionParent.parent; const offset = positionParent.index; - positionParent.remove(); + positionParent._remove(); return this.mergeAttributes( new Position( parent, offset ) ); } @@ -482,8 +482,8 @@ export default class Writer { else if ( nodeBefore.is( 'attributeElement' ) && nodeAfter.is( 'attributeElement' ) && nodeBefore.isSimilar( nodeAfter ) ) { // Move all children nodes from node placed after selection and remove that node. const count = nodeBefore.childCount; - nodeBefore.appendChildren( nodeAfter.getChildren() ); - nodeAfter.remove(); + nodeBefore._appendChildren( nodeAfter.getChildren() ); + nodeAfter._remove(); // New position is located inside the first node, before new nodes. // Call this method recursively to merge again if needed. @@ -572,7 +572,7 @@ export default class Writer { const insertionPosition = _breakAttributes( position, true ); - const length = container.insertChildren( insertionPosition.offset, nodes ); + const length = container._insertChildren( insertionPosition.offset, nodes ); const endPosition = insertionPosition.getShiftedBy( length ); const start = this.mergeAttributes( insertionPosition ); @@ -617,7 +617,7 @@ export default class Writer { const count = breakEnd.offset - breakStart.offset; // Remove nodes in range. - const removed = parentContainer.removeChildren( breakStart.offset, count ); + const removed = parentContainer._removeChildren( breakStart.offset, count ); // Merge after removing. const mergePosition = this.mergeAttributes( breakStart ); @@ -888,9 +888,9 @@ export default class Writer { const newAttribute = attribute.clone(); // Wrap current node with new attribute; - child.remove(); - newAttribute.appendChildren( child ); - parent.insertChildren( i, newAttribute ); + child._remove(); + newAttribute._appendChildren( child ); + parent._insertChildren( i, newAttribute ); wrapPositions.push( new Position( parent, i ) ); } @@ -949,8 +949,8 @@ export default class Writer { const count = child.childCount; // Replace wrapper element with its children - child.remove(); - parent.insertChildren( i, unwrapped ); + child._remove(); + parent._insertChildren( i, unwrapped ); // Save start and end position of moved items. unwrapPositions.push( @@ -1087,7 +1087,7 @@ export default class Writer { fakePosition.isSimilar = () => false; // Insert fake element in position location. - position.parent.insertChildren( position.offset, fakePosition ); + position.parent._insertChildren( position.offset, fakePosition ); // Range around inserted fake attribute element. const wrapRange = new Range( position, position.getShiftedBy( 1 ) ); @@ -1097,7 +1097,7 @@ export default class Writer { // Remove fake element and place new position there. const newPosition = new Position( fakePosition.parent, fakePosition.index ); - fakePosition.remove(); + fakePosition._remove(); // If position is placed between text nodes - merge them and return position inside. const nodeBefore = newPosition.nodeBefore; @@ -1381,14 +1381,14 @@ function _breakAttributes( position, forceSplitText = false ) { const clonedNode = positionParent.clone(); // Insert cloned node to position's parent node. - positionParent.parent.insertChildren( offsetAfter, clonedNode ); + positionParent.parent._insertChildren( offsetAfter, clonedNode ); // Get nodes to move. const count = positionParent.childCount - positionOffset; - const nodesToMove = positionParent.removeChildren( positionOffset, count ); + const nodesToMove = positionParent._removeChildren( positionOffset, count ); // Move nodes to cloned node. - clonedNode.appendChildren( nodesToMove ); + clonedNode._appendChildren( nodesToMove ); // Create new position to work on. const newPosition = new Position( positionParent.parent, offsetAfter ); @@ -1465,7 +1465,7 @@ function breakTextNode( position ) { position.parent.data = position.parent.data.slice( 0, position.offset ); // Insert new text node after position's parent text node. - position.parent.parent.insertChildren( position.parent.index + 1, new Text( textToMove ) ); + position.parent.parent._insertChildren( position.parent.index + 1, new Text( textToMove ) ); // Return new position between two newly created text nodes. return new Position( position.parent.parent, position.parent.index + 1 ); @@ -1481,7 +1481,7 @@ function mergeTextNodes( t1, t2 ) { // Merge text data into first text node and remove second one. const nodeBeforeLength = t1.data.length; t1.data += t2.data; - t2.remove(); + t2._remove(); return new Position( t1, nodeBeforeLength ); } diff --git a/tests/controller/editingcontroller.js b/tests/controller/editingcontroller.js index b9dadb26a..2a6721ccc 100644 --- a/tests/controller/editingcontroller.js +++ b/tests/controller/editingcontroller.js @@ -100,9 +100,9 @@ describe( 'EditingController', () => { writer.setSelection( null ); } ); - modelRoot.removeChildren( 0, modelRoot.childCount ); + modelRoot._removeChildren( 0, modelRoot.childCount ); - viewRoot.removeChildren( 0, viewRoot.childCount ); + viewRoot._removeChildren( 0, viewRoot.childCount ); const modelData = new ModelDocumentFragment( parse( 'foo' + diff --git a/tests/conversion/downcast-converters.js b/tests/conversion/downcast-converters.js index eb84ee126..5eeed9935 100644 --- a/tests/conversion/downcast-converters.js +++ b/tests/conversion/downcast-converters.js @@ -1030,8 +1030,8 @@ describe( 'downcast-converters', () => { } ); it( 'should not remove view ui elements that are placed next to removed content', () => { - modelRoot.appendChildren( new ModelText( 'fozbar' ) ); - viewRoot.appendChildren( [ + modelRoot._appendChildren( new ModelText( 'fozbar' ) ); + viewRoot._appendChildren( [ new ViewText( 'foz' ), new ViewUIElement( 'span' ), new ViewText( 'bar' ) @@ -1053,8 +1053,8 @@ describe( 'downcast-converters', () => { } ); it( 'should remove correct amount of text when it is split by view ui element', () => { - modelRoot.appendChildren( new ModelText( 'fozbar' ) ); - viewRoot.appendChildren( [ + modelRoot._appendChildren( new ModelText( 'fozbar' ) ); + viewRoot._appendChildren( [ new ViewText( 'foz' ), new ViewUIElement( 'span' ), new ViewText( 'bar' ) @@ -1129,8 +1129,8 @@ describe( 'downcast-converters', () => { const viewUi2 = new ViewUIElement( 'span' ); const viewP2 = new ViewContainerElement( 'p' ); - modelRoot.appendChildren( [ modelP1, modelP2 ] ); - viewRoot.appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] ); + modelRoot._appendChildren( [ modelP1, modelP2 ] ); + viewRoot._appendChildren( [ viewP1, viewUi1, viewUi2, viewP2 ] ); controller.mapper.bindElements( modelP1, viewP1 ); controller.mapper.bindElements( modelP2, viewP2 ); diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index b2851d336..c3611052a 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -203,7 +203,7 @@ describe( 'downcast-selection-converters', () => { } ); // Remove view children manually (without firing additional conversion). - viewRoot.removeChildren( 0, viewRoot.childCount ); + viewRoot._removeChildren( 0, viewRoot.childCount ); // Convert model to view. view.change( writer => { @@ -228,7 +228,7 @@ describe( 'downcast-selection-converters', () => { } ); // Remove view children manually (without firing additional conversion). - viewRoot.removeChildren( 0, viewRoot.childCount ); + viewRoot._removeChildren( 0, viewRoot.childCount ); // Convert model to view. view.change( writer => { @@ -255,7 +255,7 @@ describe( 'downcast-selection-converters', () => { } ); // Remove view children manually (without firing additional conversion). - viewRoot.removeChildren( 0, viewRoot.childCount ); + viewRoot._removeChildren( 0, viewRoot.childCount ); // Convert model to view. view.change( writer => { @@ -280,7 +280,7 @@ describe( 'downcast-selection-converters', () => { } ); // Remove view children manually (without firing additional conversion). - viewRoot.removeChildren( 0, viewRoot.childCount ); + viewRoot._removeChildren( 0, viewRoot.childCount ); // Convert model to view. view.change( writer => { @@ -299,7 +299,7 @@ describe( 'downcast-selection-converters', () => { setModelData( model, '' ); // Add two ui elements to view. - viewRoot.appendChildren( [ + viewRoot._appendChildren( [ new ViewUIElement( 'span' ), new ViewUIElement( 'span' ) ] ); @@ -334,7 +334,7 @@ describe( 'downcast-selection-converters', () => { // Add ui element to view. const uiElement = new ViewUIElement( 'span' ); - viewRoot.insertChildren( 1, uiElement ); + viewRoot._insertChildren( 1, uiElement ); dispatcher.convertSelection( docSelection, model.markers, writer ); } ); @@ -359,7 +359,7 @@ describe( 'downcast-selection-converters', () => { // Add ui element to view. const uiElement = new ViewUIElement( 'span' ); - viewRoot.insertChildren( 1, uiElement, writer ); + viewRoot._insertChildren( 1, uiElement, writer ); dispatcher.convertSelection( docSelection, model.markers, writer ); } ); @@ -589,7 +589,7 @@ describe( 'downcast-selection-converters', () => { } ); // Remove view children manually (without firing additional conversion). - viewRoot.removeChildren( 0, viewRoot.childCount ); + viewRoot._removeChildren( 0, viewRoot.childCount ); // Convert model to view. view.change( writer => { diff --git a/tests/conversion/downcastdispatcher.js b/tests/conversion/downcastdispatcher.js index 9d5b31859..a4145c5c4 100644 --- a/tests/conversion/downcastdispatcher.js +++ b/tests/conversion/downcastdispatcher.js @@ -152,7 +152,7 @@ describe( 'DowncastDispatcher', () => { describe( 'convertInsert', () => { it( 'should fire event with correct parameters for every item in passed range', () => { - root.appendChildren( [ + root._appendChildren( [ new ModelText( 'foo', { bold: true } ), new ModelElement( 'image' ), new ModelText( 'bar' ), @@ -206,7 +206,7 @@ describe( 'DowncastDispatcher', () => { } ); it( 'should not fire events for already consumed parts of model', () => { - root.appendChildren( [ + root._appendChildren( [ new ModelElement( 'image', { src: 'foo.jpg', title: 'bar', bold: true }, [ new ModelElement( 'caption', {}, new ModelText( 'title' ) ) ] ) @@ -252,7 +252,7 @@ describe( 'DowncastDispatcher', () => { beforeEach( () => { dispatcher.off( 'selection' ); - root.appendChildren( new ModelText( 'foobar' ) ); + root._appendChildren( new ModelText( 'foobar' ) ); model.change( writer => { writer.setSelection( [ new ModelRange( new ModelPosition( root, [ 1 ] ), new ModelPosition( root, [ 3 ] ) ), @@ -373,12 +373,12 @@ describe( 'DowncastDispatcher', () => { it( 'should not fire event for marker if selection is in a element with custom highlight handling', () => { // Clear after `beforeEach`. - root.removeChildren( 0, root.childCount ); + root._removeChildren( 0, root.childCount ); const text = new ModelText( 'abc' ); const caption = new ModelElement( 'caption', null, text ); const image = new ModelElement( 'image', null, caption ); - root.appendChildren( [ image ] ); + root._appendChildren( [ image ] ); // Create view elements that will be "mapped" to model elements. const viewCaption = new ViewContainerElement( 'caption' ); @@ -441,7 +441,7 @@ describe( 'DowncastDispatcher', () => { beforeEach( () => { text = new ModelText( 'foo bar baz' ); element = new ModelElement( 'paragraph', null, [ text ] ); - root.appendChildren( [ element ] ); + root._appendChildren( [ element ] ); range = ModelRange.createFromParentsAndOffsets( element, 0, element, 4 ); } ); @@ -521,7 +521,7 @@ describe( 'DowncastDispatcher', () => { beforeEach( () => { text = new ModelText( 'foo bar baz' ); element = new ModelElement( 'paragraph', null, [ text ] ); - root.appendChildren( [ element ] ); + root._appendChildren( [ element ] ); range = ModelRange.createFromParentsAndOffsets( element, 0, element, 4 ); } ); diff --git a/tests/conversion/mapper.js b/tests/conversion/mapper.js index 0ce299efd..db3687e2b 100644 --- a/tests/conversion/mapper.js +++ b/tests/conversion/mapper.js @@ -181,7 +181,7 @@ describe( 'Mapper', () => { ] ); modelDiv = new ModelRootElement(); - modelDiv.appendChildren( [ + modelDiv._appendChildren( [ new ModelText( 'x' ), modelP, new ModelText( 'zz' ) @@ -451,7 +451,7 @@ describe( 'Mapper', () => { modelCaption = new ModelElement( 'caption', {}, new ModelText( 'foo' ) ); modelWidget = new ModelElement( 'widget', {}, [ modelImg, modelCaption ] ); modelDiv = new ModelRootElement(); - modelDiv.appendChildren( [ new ModelText( 'x' ), modelWidget, new ModelText( 'zz' ) ] ); + modelDiv._appendChildren( [ new ModelText( 'x' ), modelWidget, new ModelText( 'zz' ) ] ); viewTextX = new ViewText( 'y' ); viewTextZZ = new ViewText( 'zz' ); diff --git a/tests/conversion/viewconsumable.js b/tests/conversion/viewconsumable.js index 9ba4ff3c1..8977b68cc 100644 --- a/tests/conversion/viewconsumable.js +++ b/tests/conversion/viewconsumable.js @@ -537,7 +537,7 @@ describe( 'ViewConsumable', () => { const child1 = new ViewElement( 'p', { 'title': 'baz' }, [ text1 ] ); const child2 = new ViewElement( 'p' ); const child3 = new ViewElement( 'p', { 'style': 'top:10px;', 'class': 'qux bar' }, [ text2, child2 ] ); - el.appendChildren( [ child1, child3 ] ); + el._appendChildren( [ child1, child3 ] ); const newConsumable = ViewConsumable.createFrom( el ); diff --git a/tests/dataprocessor/htmldataprocessor.js b/tests/dataprocessor/htmldataprocessor.js index 80598edd5..8c1e695e5 100644 --- a/tests/dataprocessor/htmldataprocessor.js +++ b/tests/dataprocessor/htmldataprocessor.js @@ -97,7 +97,7 @@ describe( 'HtmlDataProcessor', () => { it( 'should return text if document fragment with single text node is passed', () => { const fragment = new ViewDocumentFragment(); - fragment.appendChildren( parse( 'foo bar' ) ); + fragment._appendChildren( parse( 'foo bar' ) ); expect( dataProcessor.toData( fragment ) ).to.equal( 'foo bar' ); } ); diff --git a/tests/dataprocessor/xmldataprocessor.js b/tests/dataprocessor/xmldataprocessor.js index f2e328e83..45262785f 100644 --- a/tests/dataprocessor/xmldataprocessor.js +++ b/tests/dataprocessor/xmldataprocessor.js @@ -89,7 +89,7 @@ describe( 'XmlDataProcessor', () => { it( 'should return text if document fragment with single text node is passed', () => { const fragment = new ViewDocumentFragment(); - fragment.appendChildren( parse( 'foo bar' ) ); + fragment._appendChildren( parse( 'foo bar' ) ); expect( dataProcessor.toData( fragment ) ).to.equal( 'foo bar' ); } ); diff --git a/tests/dev-utils/enableenginedebug.js b/tests/dev-utils/enableenginedebug.js index 2e265b09f..696c7f807 100644 --- a/tests/dev-utils/enableenginedebug.js +++ b/tests/dev-utils/enableenginedebug.js @@ -233,7 +233,7 @@ describe( 'debug tools', () => { describe( 'for operations', () => { beforeEach( () => { - modelRoot.appendChildren( [ new ModelText( 'foobar' ) ] ); + modelRoot._appendChildren( [ new ModelText( 'foobar' ) ] ); } ); it( 'AttributeOperation', () => { @@ -256,7 +256,7 @@ describe( 'debug tools', () => { it( 'DetachOperation (element)', () => { const element = new ModelElement( 'element' ); - modelRoot.insertChildren( 0, element ); + modelRoot._insertChildren( 0, element ); const op = new DetachOperation( ModelPosition.createBefore( element ), 1 ); @@ -268,7 +268,7 @@ describe( 'debug tools', () => { it( 'DetachOperation (multiple nodes)', () => { const element = new ModelElement( 'element' ); - modelRoot.insertChildren( 0, element ); + modelRoot._insertChildren( 0, element ); const op = new DetachOperation( ModelPosition.createBefore( element ), 2 ); @@ -376,7 +376,7 @@ describe( 'debug tools', () => { } ); it( 'AttributeDelta', () => { - modelRoot.appendChildren( new ModelText( 'foobar' ) ); + modelRoot._appendChildren( new ModelText( 'foobar' ) ); const delta = new AttributeDelta(); const op = new AttributeOperation( ModelRange.createIn( modelRoot ), 'key', null, { foo: 'bar' }, 0 ); @@ -427,7 +427,7 @@ describe( 'debug tools', () => { } ); it( 'MarkerDelta', () => { - modelRoot.appendChildren( new ModelText( 'foobar' ) ); + modelRoot._appendChildren( new ModelText( 'foobar' ) ); const delta = new MarkerDelta(); const op = new MarkerOperation( 'marker', null, ModelRange.createIn( modelRoot ), modelDoc.markers, 0 ); @@ -445,7 +445,7 @@ describe( 'debug tools', () => { const firstEle = new ModelElement( 'paragraph' ); const removedEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ firstEle, removedEle ] ); + otherRoot._appendChildren( [ firstEle, removedEle ] ); const graveyard = modelDoc.graveyard; const delta = new MergeDelta(); @@ -471,7 +471,7 @@ describe( 'debug tools', () => { const firstEle = new ModelElement( 'paragraph' ); const removedEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ firstEle, removedEle ] ); + otherRoot._appendChildren( [ firstEle, removedEle ] ); const delta = new MergeDelta(); const move = new MoveOperation( ModelPosition.createAt( removedEle, 0 ), 3, ModelPosition.createAt( firstEle, 0 ), 0 ); @@ -527,7 +527,7 @@ describe( 'debug tools', () => { const otherRoot = modelDoc.createRoot( 'main', 'otherRoot' ); const splitEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ splitEle ] ); + otherRoot._appendChildren( [ splitEle ] ); const delta = new SplitDelta(); const insert = new InsertOperation( ModelPosition.createAt( otherRoot, 1 ), [ new ModelElement( 'paragraph' ) ], 0 ); @@ -546,7 +546,7 @@ describe( 'debug tools', () => { const otherRoot = modelDoc.createRoot( 'main', 'otherRoot' ); const splitEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ splitEle ] ); + otherRoot._appendChildren( [ splitEle ] ); const delta = new SplitDelta(); const insert = new InsertOperation( ModelPosition.createAt( otherRoot, 1 ), [ new ModelElement( 'paragraph' ) ], 0 ); @@ -581,7 +581,7 @@ describe( 'debug tools', () => { const otherRoot = modelDoc.createRoot( 'main', 'otherRoot' ); const unwrapEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ unwrapEle ] ); + otherRoot._appendChildren( [ unwrapEle ] ); const graveyard = modelDoc.graveyard; const delta = new UnwrapDelta(); @@ -630,7 +630,7 @@ describe( 'debug tools', () => { const modelDoc = model.document; const modelRoot = modelDoc.createRoot(); - modelRoot.appendChildren( [ + modelRoot._appendChildren( [ new ModelElement( 'paragraph', { foo: 'bar' }, [ new ModelText( 'This is ' ), new ModelText( 'bold', { bold: true } ), new ModelText( '.' ) ] ), @@ -699,7 +699,7 @@ describe( 'debug tools', () => { const viewDoc = new ViewDocument(); const viewRoot = createViewRoot( viewDoc ); - viewRoot.appendChildren( [ + viewRoot._appendChildren( [ new ViewContainerElement( 'p', { foo: 'bar' }, [ new ViewText( 'This is ' ), new ViewAttributeElement( 'b', null, new ViewText( 'bold' ) ), new ViewText( '.' ) ] ), @@ -904,7 +904,7 @@ describe( 'debug tools', () => { const firstEle = new ModelElement( 'paragraph' ); const removedEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ firstEle, removedEle ] ); + otherRoot._appendChildren( [ firstEle, removedEle ] ); const delta = new MergeDelta(); const graveyard = modelDoc.graveyard; @@ -930,7 +930,7 @@ describe( 'debug tools', () => { const firstEle = new ModelElement( 'paragraph' ); const removedEle = new ModelElement( 'paragraph', null, [ new ModelText( 'foo' ) ] ); - otherRoot.appendChildren( [ firstEle, removedEle ] ); + otherRoot._appendChildren( [ firstEle, removedEle ] ); const delta = new MergeDelta(); const graveyard = modelDoc.graveyard; diff --git a/tests/dev-utils/model.js b/tests/dev-utils/model.js index a9894e742..ce630d32b 100644 --- a/tests/dev-utils/model.js +++ b/tests/dev-utils/model.js @@ -57,7 +57,7 @@ describe( 'model test utils', () => { describe( 'getData', () => { it( 'should use stringify method', () => { const stringifySpy = sandbox.spy( getData, '_stringify' ); - root.appendChildren( new Element( 'b', null, new Text( 'btext' ) ) ); + root._appendChildren( new Element( 'b', null, new Text( 'btext' ) ) ); expect( getData( model, { withoutSelection: true } ) ).to.equal( 'btext' ); sinon.assert.calledOnce( stringifySpy ); @@ -66,7 +66,7 @@ describe( 'model test utils', () => { it( 'should use stringify method with selection', () => { const stringifySpy = sandbox.spy( getData, '_stringify' ); - root.appendChildren( new Element( 'b', null, new Text( 'btext' ) ) ); + root._appendChildren( new Element( 'b', null, new Text( 'btext' ) ) ); model.change( writer => { writer.setSelection( Range.createFromParentsAndOffsets( root, 0, root, 1 ) ); } ); @@ -214,7 +214,7 @@ describe( 'model test utils', () => { } ); it( 'writes elements and texts', () => { - root.appendChildren( [ + root._appendChildren( [ new Element( 'a', null, new Text( 'atext' ) ), new Element( 'b', null, [ new Element( 'c1' ), @@ -230,7 +230,7 @@ describe( 'model test utils', () => { } ); it( 'writes element attributes', () => { - root.appendChildren( + root._appendChildren( new Element( 'a', { foo: true, bar: 1, car: false }, [ new Element( 'b', { fooBar: 'x y', barFoo: { x: 1, y: 2 } } ) ] ) @@ -244,7 +244,7 @@ describe( 'model test utils', () => { } ); it( 'writes text attributes', () => { - root.appendChildren( [ + root._appendChildren( [ new Text( 'foo', { bold: true } ), new Text( 'bar' ), new Text( 'bom', { bold: true, italic: true } ), @@ -260,7 +260,7 @@ describe( 'model test utils', () => { } ); it( 'writes unicode text', () => { - root.appendChildren( new Text( 'நிலைக்கு' ) ); + root._appendChildren( new Text( 'நிலைக்கு' ) ); expect( stringify( root ) ).to.equal( 'நிலைக்கு' ); } ); @@ -272,7 +272,7 @@ describe( 'model test utils', () => { elA = new Element( 'a' ); elB = new Element( 'b' ); - root.appendChildren( [ + root._appendChildren( [ elA, new Text( 'foo' ), new Text( 'bar', { bold: true } ), @@ -397,7 +397,7 @@ describe( 'model test utils', () => { it( 'writes selection in unicode text', () => { const root = document.createRoot( '$root', 'empty' ); - root.appendChildren( new Text( 'நிலைக்கு' ) ); + root._appendChildren( new Text( 'நிலைக்கு' ) ); model.change( writer => { writer.setSelection( Range.createFromParentsAndOffsets( root, 2, root, 6 ) ); } ); diff --git a/tests/dev-utils/view.js b/tests/dev-utils/view.js index a9aa5051a..efe9517c1 100644 --- a/tests/dev-utils/view.js +++ b/tests/dev-utils/view.js @@ -40,7 +40,7 @@ describe( 'view test utils', () => { const viewDocument = view.document; const options = { showType: false, showPriority: false, withoutSelection: true }; const root = createAttachedRoot( viewDocument, element ); - root.appendChildren( new Element( 'p' ) ); + root._appendChildren( new Element( 'p' ) ); expect( getData( view, options ) ).to.equal( '

' ); sinon.assert.calledOnce( stringifySpy ); @@ -61,7 +61,7 @@ describe( 'view test utils', () => { const viewDocument = view.document; const options = { showType: false, showPriority: false }; const root = createAttachedRoot( viewDocument, element ); - root.appendChildren( new Element( 'p' ) ); + root._appendChildren( new Element( 'p' ) ); view.change( writer => { writer.setSelection( Range.createFromParentsAndOffsets( root, 0, root, 1 ) ); diff --git a/tests/model/delta/renamedelta.js b/tests/model/delta/renamedelta.js index b998b8145..edbc99de8 100644 --- a/tests/model/delta/renamedelta.js +++ b/tests/model/delta/renamedelta.js @@ -39,7 +39,7 @@ describe( 'RenameDelta', () => { } ); it( 'should return correct RenameDelta', () => { - root.appendChildren( new Element( 'p', null, new Text( 'abc' ) ) ); + root._appendChildren( new Element( 'p', null, new Text( 'abc' ) ) ); model.change( writer => { writer.rename( root.getChild( 0 ), 'h' ); diff --git a/tests/model/delta/transform/_utils/utils.js b/tests/model/delta/transform/_utils/utils.js index 10e99687a..2b486b06a 100644 --- a/tests/model/delta/transform/_utils/utils.js +++ b/tests/model/delta/transform/_utils/utils.js @@ -225,7 +225,7 @@ export function getFilledDocument() { const doc = model.document; const root = doc.createRoot(); - root.insertChildren( 0, [ + root._insertChildren( 0, [ new Element( 'x' ), new Element( 'x' ), new Element( 'x', [], new Text( 'a' ) ), diff --git a/tests/model/delta/transform/splitdelta.js b/tests/model/delta/transform/splitdelta.js index 24b7e571c..5031c07a8 100644 --- a/tests/model/delta/transform/splitdelta.js +++ b/tests/model/delta/transform/splitdelta.js @@ -690,7 +690,7 @@ describe( 'transform', () => { } ); it( 'attribute removed from split element', () => { - splitDelta.operations[ 0 ].nodes.getNode( 0 ).setAttribute( 'key', 'oldValue' ); + splitDelta.operations[ 0 ].nodes.getNode( 0 )._setAttribute( 'key', 'oldValue' ); const attributeDelta = new AttributeDelta(); attributeDelta.addOperation( new AttributeOperation( diff --git a/tests/model/delta/transform/transform.js b/tests/model/delta/transform/transform.js index 66c5f7082..4d6096ebb 100644 --- a/tests/model/delta/transform/transform.js +++ b/tests/model/delta/transform/transform.js @@ -44,7 +44,7 @@ describe( 'transform', () => { doc = model.document; root = doc.createRoot(); - root.appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) ); + root._appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) ); baseVersion = doc.version; } ); diff --git a/tests/model/differ.js b/tests/model/differ.js index 69c81ffec..fc5fed54d 100644 --- a/tests/model/differ.js +++ b/tests/model/differ.js @@ -27,7 +27,7 @@ describe( 'Differ', () => { root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'paragraph', null, [ new Text( 'foo' ) ] ), @@ -615,7 +615,7 @@ describe( 'Differ', () => { } ); it( 'reinsert removed element', () => { - doc.graveyard.appendChildren( new Element( 'listItem' ) ); + doc.graveyard._appendChildren( new Element( 'listItem' ) ); const sourcePosition = new Position( doc.graveyard, [ 0 ] ); const targetPosition = new Position( root, [ 2 ] ); @@ -799,7 +799,7 @@ describe( 'Differ', () => { it( 'remove and add attribute on text', () => { const p = root.getChild( 1 ); - p.getChild( 0 ).setAttribute( 'bold', true ); + p.getChild( 0 )._setAttribute( 'bold', true ); const range = Range.createFromParentsAndOffsets( p, 1, p, 3 ); @@ -1203,8 +1203,8 @@ describe( 'Differ', () => { // it appeared that `blockQuote` looks like it is removed because it had the same path as the already removed ``. // In a result, removing `paragraph` was discarded. // The mistake was that the checking for removing was done at incorrect moment. - root.removeChildren( 0, root.childCount ); - root.appendChildren( [ + root._removeChildren( 0, root.childCount ); + root._appendChildren( [ new Element( 'paragraph', null, new Text( 'foo' ) ), new Element( 'image' ), new Element( 'blockQuote', null, [ @@ -1231,8 +1231,8 @@ describe( 'Differ', () => { } ); it( 'proper filtering of changes in inserted elements', () => { - root.removeChildren( 0, root.childCount ); - root.appendChildren( new Element( 'image' ) ); + root._removeChildren( 0, root.childCount ); + root._appendChildren( new Element( 'image' ) ); const blockQuote = new Element( 'blockQuote', null, new Element( 'paragraph' ) ); diff --git a/tests/model/document.js b/tests/model/document.js index ecdc4d430..8a330b1ba 100644 --- a/tests/model/document.js +++ b/tests/model/document.js @@ -343,7 +343,7 @@ describe( 'Document', () => { const spy = sinon.spy(); const root = doc.getRoot(); - root.appendChildren( new Text( 'foo' ) ); + root._appendChildren( new Text( 'foo' ) ); doc.on( 'change', spy ); diff --git a/tests/model/documentfragment.js b/tests/model/documentfragment.js index 7ae13d847..1a24afff2 100644 --- a/tests/model/documentfragment.js +++ b/tests/model/documentfragment.js @@ -125,10 +125,10 @@ describe( 'DocumentFragment', () => { } ); } ); - describe( 'insertChildren', () => { + describe( '_insertChildren', () => { it( 'should add children to the document fragment', () => { const frag = new DocumentFragment( new Text( 'xy' ) ); - frag.insertChildren( 1, new Text( 'foo' ) ); + frag._insertChildren( 1, new Text( 'foo' ) ); expect( frag.childCount ).to.equal( 2 ); expect( frag.maxOffset ).to.equal( 5 ); @@ -139,13 +139,13 @@ describe( 'DocumentFragment', () => { it( 'should accept strings and arrays', () => { const frag = new DocumentFragment(); - frag.insertChildren( 0, 'abc' ); + frag._insertChildren( 0, 'abc' ); expect( frag.childCount ).to.equal( 1 ); expect( frag.maxOffset ).to.equal( 3 ); expect( frag.getChild( 0 ) ).to.have.property( 'data' ).that.equals( 'abc' ); - frag.removeChildren( 0, 1 ); - frag.insertChildren( 0, [ new Element( 'p' ), 'abc' ] ); + frag._removeChildren( 0, 1 ); + frag._insertChildren( 0, [ new Element( 'p' ), 'abc' ] ); expect( frag.childCount ).to.equal( 2 ); expect( frag.maxOffset ).to.equal( 4 ); @@ -158,7 +158,7 @@ describe( 'DocumentFragment', () => { const text = new Text( 'abcxyz', { bold: true } ); const textProxy = new TextProxy( text, 2, 3 ); - frag.insertChildren( 0, textProxy ); + frag._insertChildren( 0, textProxy ); expect( frag.childCount ).to.equal( 1 ); expect( frag.maxOffset ).to.equal( 3 ); @@ -168,10 +168,10 @@ describe( 'DocumentFragment', () => { } ); } ); - describe( 'appendChildren', () => { + describe( '_appendChildren', () => { it( 'should add children to the end of the element', () => { const frag = new DocumentFragment( new Text( 'xy' ) ); - frag.appendChildren( new Text( 'foo' ) ); + frag._appendChildren( new Text( 'foo' ) ); expect( frag.childCount ).to.equal( 2 ); expect( frag.maxOffset ).to.equal( 5 ); @@ -180,10 +180,10 @@ describe( 'DocumentFragment', () => { } ); } ); - describe( 'removeChildren', () => { + describe( '_removeChildren', () => { it( 'should remove children from the element and return them as an array', () => { const frag = new DocumentFragment( [ new Text( 'foobar' ), new Element( 'image' ) ] ); - const removed = frag.removeChildren( 1, 1 ); + const removed = frag._removeChildren( 1, 1 ); expect( frag.childCount ).to.equal( 1 ); expect( frag.maxOffset ).to.equal( 6 ); @@ -196,7 +196,7 @@ describe( 'DocumentFragment', () => { it( 'should remove one child when second parameter is not specified', () => { const frag = new DocumentFragment( [ new Text( 'foo' ), new Element( 'image' ) ] ); - const removed = frag.removeChildren( 0 ); + const removed = frag._removeChildren( 0 ); expect( frag.childCount ).to.equal( 1 ); expect( frag.maxOffset ).to.equal( 1 ); diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 11f3bef20..3d813ea80 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -34,7 +34,7 @@ describe( 'DocumentSelection', () => { model = new Model(); doc = model.document; root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'p' ), new Element( 'p' ), new Element( 'p', [], new Text( 'foobar' ) ), @@ -73,7 +73,7 @@ describe( 'DocumentSelection', () => { model = new Model(); doc = model.document; root = doc.createRoot(); - root.insertChildren( 0, new Text( 'foobar' ) ); + root._insertChildren( 0, new Text( 'foobar' ) ); selection = doc.selection; const ranges = Array.from( selection.getRanges() ); @@ -89,7 +89,7 @@ describe( 'DocumentSelection', () => { model = new Model(); doc = model.document; root = doc.createRoot(); - root.insertChildren( 0, [ + root._insertChildren( 0, [ new Element( 'img' ), new Element( 'p', [], new Text( 'foobar' ) ) ] ); @@ -113,7 +113,7 @@ describe( 'DocumentSelection', () => { } ); it( 'should be false for the default range (object selection) ', () => { - root.insertChildren( 0, new Element( 'widget' ) ); + root._insertChildren( 0, new Element( 'widget' ) ); expect( selection.isCollapsed ).to.be.false; } ); @@ -133,7 +133,7 @@ describe( 'DocumentSelection', () => { } ); it( 'should equal the default range\'s start (object selection)', () => { - root.insertChildren( 0, new Element( 'widget' ) ); + root._insertChildren( 0, new Element( 'widget' ) ); const expectedPos = new Position( root, [ 0 ] ); @@ -155,7 +155,7 @@ describe( 'DocumentSelection', () => { } ); it( 'should equal the default range\'s end (object selection)', () => { - root.insertChildren( 0, new Element( 'widget' ) ); + root._insertChildren( 0, new Element( 'widget' ) ); const expectedPos = new Position( root, [ 1 ] ); @@ -405,8 +405,8 @@ describe( 'DocumentSelection', () => { let fullP, emptyP, rangeInFullP, rangeInEmptyP; beforeEach( () => { - root.removeChildren( 0, root.childCount ); - root.appendChildren( [ + root._removeChildren( 0, root.childCount ); + root._appendChildren( [ new Element( 'p', [], new Text( 'foobar' ) ), new Element( 'p', [], [] ) ] ); @@ -451,7 +451,7 @@ describe( 'DocumentSelection', () => { describe( 'are updated on a direct range change', () => { beforeEach( () => { - root.insertChildren( 0, [ + root._insertChildren( 0, [ new Element( 'p', { p: true } ), new Text( 'a', { a: true } ), new Element( 'p', { p: true } ), @@ -651,10 +651,10 @@ describe( 'DocumentSelection', () => { it( 'are removed when containing element is merged with a non-empty element', () => { const emptyP2 = new Element( 'p', null, 'x' ); - root.appendChildren( emptyP2 ); + root._appendChildren( emptyP2 ); - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); + emptyP._setAttribute( fooStoreAttrKey, 'bar' ); + emptyP2._setAttribute( fooStoreAttrKey, 'bar' ); model.change( writer => { // {} @@ -666,7 +666,7 @@ describe( 'DocumentSelection', () => { } ); it( 'are removed even when there is no selection in it', () => { - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); + emptyP._setAttribute( fooStoreAttrKey, 'bar' ); selection._setTo( [ rangeInFullP ] ); @@ -680,10 +680,10 @@ describe( 'DocumentSelection', () => { it( 'are removed only once in case of multi-op deltas', () => { let batch; const emptyP2 = new Element( 'p', null, 'x' ); - root.appendChildren( emptyP2 ); + root._appendChildren( emptyP2 ); - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - emptyP2.setAttribute( fooStoreAttrKey, 'bar' ); + emptyP._setAttribute( fooStoreAttrKey, 'bar' ); + emptyP2._setAttribute( fooStoreAttrKey, 'bar' ); model.change( writer => { batch = writer.batch; @@ -713,10 +713,10 @@ describe( 'DocumentSelection', () => { it( 'are not removed or merged when containing element is merged with another empty element', () => { const emptyP2 = new Element( 'p', null ); - root.appendChildren( emptyP2 ); + root._appendChildren( emptyP2 ); - emptyP.setAttribute( fooStoreAttrKey, 'bar' ); - emptyP2.setAttribute( abcStoreAttrKey, 'bar' ); + emptyP._setAttribute( fooStoreAttrKey, 'bar' ); + emptyP2._setAttribute( abcStoreAttrKey, 'bar' ); expect( emptyP.hasAttribute( fooStoreAttrKey ) ).to.be.true; expect( emptyP.hasAttribute( abcStoreAttrKey ) ).to.be.false; @@ -869,8 +869,8 @@ describe( 'DocumentSelection', () => { let spyRange; beforeEach( () => { - root.removeChildren( 0, root.childCount ); - root.insertChildren( 0, [ + root._removeChildren( 0, root.childCount ); + root._insertChildren( 0, [ new Element( 'p', [], new Text( 'abcdef' ) ), new Element( 'p', [], new Text( 'foobar' ) ), new Text( 'xyz' ) @@ -1204,8 +1204,8 @@ describe( 'DocumentSelection', () => { } ); it( '`DocumentSelection#change:range` event should be fire once even if selection contains multi-ranges', () => { - root.removeChildren( 0, root.childCount ); - root.insertChildren( 0, [ + root._removeChildren( 0, root.childCount ); + root._insertChildren( 0, [ new Element( 'p', [], new Text( 'abcdef' ) ), new Element( 'p', [], new Text( 'foobar' ) ), new Text( 'xyz #2' ) @@ -1232,8 +1232,8 @@ describe( 'DocumentSelection', () => { } ); it( 'should throw if one of ranges starts or ends inside surrogate pair', () => { - root.removeChildren( 0, root.childCount ); - root.appendChildren( '\uD83D\uDCA9' ); + root._removeChildren( 0, root.childCount ); + root._appendChildren( '\uD83D\uDCA9' ); expect( () => { doc.selection._setTo( Range.createFromParentsAndOffsets( root, 0, root, 1 ) ); @@ -1245,8 +1245,8 @@ describe( 'DocumentSelection', () => { } ); it( 'should throw if one of ranges starts or ends between base character and combining mark', () => { - root.removeChildren( 0, root.childCount ); - root.appendChildren( 'foo̻̐ͩbar' ); + root._removeChildren( 0, root.childCount ); + root._appendChildren( 'foo̻̐ͩbar' ); expect( () => { doc.selection._setTo( Range.createFromParentsAndOffsets( root, 3, root, 9 ) ); diff --git a/tests/model/element.js b/tests/model/element.js index 86859e28c..4f2f145a6 100644 --- a/tests/model/element.js +++ b/tests/model/element.js @@ -97,10 +97,10 @@ describe( 'Element', () => { } ); } ); - describe( 'insertChildren', () => { + describe( '_insertChildren', () => { it( 'should add a child to the element', () => { const element = new Element( 'elem', [], new Text( 'xy' ) ); - element.insertChildren( 1, new Text( 'foo' ) ); + element._insertChildren( 1, new Text( 'foo' ) ); expect( element.childCount ).to.equal( 2 ); expect( element.maxOffset ).to.equal( 5 ); @@ -110,7 +110,7 @@ describe( 'Element', () => { it( 'should accept arrays and strings', () => { const element = new Element( 'elem' ); - element.insertChildren( 0, [ new Element( 'image' ), 'xy', new Element( 'list' ) ] ); + element._insertChildren( 0, [ new Element( 'image' ), 'xy', new Element( 'list' ) ] ); expect( element.childCount ).to.equal( 3 ); expect( element.maxOffset ).to.equal( 4 ); @@ -121,7 +121,7 @@ describe( 'Element', () => { it( 'should accept strings', () => { const element = new Element( 'div' ); - element.insertChildren( 0, 'abc' ); + element._insertChildren( 0, 'abc' ); expect( element.childCount ).to.equal( 1 ); expect( element.maxOffset ).to.equal( 3 ); @@ -133,7 +133,7 @@ describe( 'Element', () => { const text = new Text( 'abcxyz', { bold: true } ); const textProxy = new TextProxy( text, 2, 3 ); - element.insertChildren( 0, textProxy ); + element._insertChildren( 0, textProxy ); expect( element.childCount ).to.equal( 1 ); expect( element.maxOffset ).to.equal( 3 ); @@ -143,23 +143,23 @@ describe( 'Element', () => { } ); } ); - describe( 'appendChildren', () => { - it( 'should use insertChildren to add children at the end of the element', () => { + describe( '_appendChildren', () => { + it( 'should use _insertChildren to add children at the end of the element', () => { const element = new Element( 'elem', [], new Text( 'xy' ) ); - sinon.spy( element, 'insertChildren' ); + sinon.spy( element, '_insertChildren' ); const text = new Text( 'foo' ); - element.appendChildren( text ); + element._appendChildren( text ); - expect( element.insertChildren.calledWithExactly( 0, text ) ); + expect( element._insertChildren.calledWithExactly( 0, text ) ); } ); } ); - describe( 'removeChildren', () => { + describe( '_removeChildren', () => { it( 'should remove children from the element and return them as an array', () => { const element = new Element( 'elem', [], [ new Text( 'foobar' ), new Element( 'image' ) ] ); - const removed = element.removeChildren( 1, 1 ); + const removed = element._removeChildren( 1, 1 ); expect( element.childCount ).to.equal( 1 ); expect( element.maxOffset ).to.equal( 6 ); @@ -172,7 +172,7 @@ describe( 'Element', () => { it( 'should remove one child when second parameter is not specified', () => { const element = new Element( 'element', [], [ new Text( 'foo' ), new Element( 'image' ) ] ); - const removed = element.removeChildren( 0 ); + const removed = element._removeChildren( 0 ); expect( element.childCount ).to.equal( 1 ); expect( element.maxOffset ).to.equal( 1 ); diff --git a/tests/model/liveposition.js b/tests/model/liveposition.js index 3d81bc6ec..9c59f9777 100644 --- a/tests/model/liveposition.js +++ b/tests/model/liveposition.js @@ -26,7 +26,7 @@ describe( 'LivePosition', () => { ul = new Element( 'ul', [], [ li1, li2 ] ); p = new Element( 'p', [], new Text( 'qwerty' ) ); - root.insertChildren( 0, [ p, ul ] ); + root._insertChildren( 0, [ p, ul ] ); } ); afterEach( () => { diff --git a/tests/model/liverange.js b/tests/model/liverange.js index 59cb362a0..02d3ea682 100644 --- a/tests/model/liverange.js +++ b/tests/model/liverange.js @@ -34,7 +34,7 @@ describe( 'LiveRange', () => { ul = new Element( 'ul', [], lis ); p = new Element( 'p', [], new Text( 'qwertyuiop' ) ); - root.insertChildren( 0, [ ul, p, new Text( 'xyzxyz' ) ] ); + root._insertChildren( 0, [ ul, p, new Text( 'xyzxyz' ) ] ); } ); it( 'should be an instance of Range', () => { diff --git a/tests/model/markercollection.js b/tests/model/markercollection.js index 6ff926196..5a020be73 100644 --- a/tests/model/markercollection.js +++ b/tests/model/markercollection.js @@ -241,7 +241,7 @@ describe( 'Marker', () => { } ); it( 'should provide API that returns up-to-date marker range parameters', () => { - root.appendChildren( new Text( 'foo' ) ); + root._appendChildren( new Text( 'foo' ) ); const range = Range.createFromParentsAndOffsets( root, 1, root, 2 ); const marker = model.markers._set( 'name', range ); diff --git a/tests/model/node.js b/tests/model/node.js index ba080eabb..ee0d1adea 100644 --- a/tests/model/node.js +++ b/tests/model/node.js @@ -30,7 +30,7 @@ describe( 'Node', () => { doc = model.document; root = doc.createRoot(); - root.appendChildren( [ one, two, three ] ); + root._appendChildren( [ one, two, three ] ); } ); describe( 'should have a correct property', () => { @@ -91,7 +91,7 @@ describe( 'Node', () => { // DocumentFragment does not have document property, so node's document property should be null. const docFrag = new DocumentFragment(); - docFrag.appendChildren( node ); + docFrag._appendChildren( node ); expect( node ).to.have.property( 'document' ).that.is.null; } ); } ); @@ -146,12 +146,12 @@ describe( 'Node', () => { } ); } ); - describe( 'remove()', () => { + describe( '_remove()', () => { it( 'should remove node from it\'s parent', () => { const element = new Element( 'p' ); - element.appendChildren( node ); + element._appendChildren( node ); - node.remove(); + node._remove(); expect( element.childCount ).to.equal( 0 ); expect( node.parent ).to.be.null; @@ -159,7 +159,7 @@ describe( 'Node', () => { it( 'should throw if node does not have a parent', () => { expect( () => { - node.remove(); + node._remove(); } ).to.throw; } ); } ); @@ -348,46 +348,46 @@ describe( 'Node', () => { } ); } ); - describe( 'setAttribute', () => { + describe( '_setAttribute', () => { it( 'should set given attribute on the element', () => { - node.setAttribute( 'foo', 'bar' ); + node._setAttribute( 'foo', 'bar' ); expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' ); } ); } ); - describe( 'setAttributesTo', () => { + describe( '_setAttributesTo', () => { it( 'should remove all attributes set on element and set the given ones', () => { - node.setAttribute( 'abc', 'xyz' ); - node.setAttributesTo( { foo: 'bar' } ); + node._setAttribute( 'abc', 'xyz' ); + node._setAttributesTo( { foo: 'bar' } ); expect( node.getAttribute( 'foo' ) ).to.equal( 'bar' ); expect( node.getAttribute( 'abc' ) ).to.be.undefined; } ); } ); - describe( 'removeAttribute', () => { + describe( '_removeAttribute', () => { it( 'should remove attribute set on the element and return true', () => { - node.setAttribute( 'foo', 'bar' ); - const result = node.removeAttribute( 'foo' ); + node._setAttribute( 'foo', 'bar' ); + const result = node._removeAttribute( 'foo' ); expect( node.getAttribute( 'foo' ) ).to.be.undefined; expect( result ).to.be.true; } ); it( 'should return false if element does not contain given attribute', () => { - const result = node.removeAttribute( 'foo' ); + const result = node._removeAttribute( 'foo' ); expect( result ).to.be.false; } ); } ); - describe( 'clearAttributes', () => { + describe( '_clearAttributes', () => { it( 'should remove all attributes from the element', () => { - node.setAttribute( 'foo', 'bar' ); - node.setAttribute( 'abc', 'xyz' ); + node._setAttribute( 'foo', 'bar' ); + node._setAttribute( 'abc', 'xyz' ); - node.clearAttributes(); + node._clearAttributes(); expect( node.getAttribute( 'foo' ) ).to.be.undefined; expect( node.getAttribute( 'abc' ) ).to.be.undefined; diff --git a/tests/model/nodelist.js b/tests/model/nodelist.js index f2ca2522c..5fb5114ff 100644 --- a/tests/model/nodelist.js +++ b/tests/model/nodelist.js @@ -121,14 +121,14 @@ describe( 'NodeList', () => { } ); } ); - describe( 'insertNodes', () => { + describe( '_insertNodes', () => { it( 'should insert nodes at given index', () => { const newImg = new Element( 'image' ); - nodes.insertNodes( 1, [ newImg ] ); + nodes._insertNodes( 1, [ newImg ] ); const bar = new Text( 'bar', { bold: true } ); const xyz = new Text( 'xyz' ); - nodes.insertNodes( 4, [ bar, xyz ] ); + nodes._insertNodes( 4, [ bar, xyz ] ); expect( nodes.length ).to.equal( 6 ); expect( nodes.maxOffset ).to.equal( 12 ); @@ -159,14 +159,14 @@ describe( 'NodeList', () => { it( 'should throw if not a Node is inserted', () => { expect( () => { - nodes.insertNodes( 0, [ 'foo' ] ); + nodes._insertNodes( 0, [ 'foo' ] ); } ).to.throw( CKEditorError, /nodelist-insertNodes-not-node/ ); } ); } ); - describe( 'removeNodes', () => { + describe( '_removeNodes', () => { it( 'should remove one or more nodes from given index', () => { - nodes.removeNodes( 0, 2 ); + nodes._removeNodes( 0, 2 ); expect( nodes.length ).to.equal( 1 ); expect( nodes.maxOffset ).to.equal( 1 ); @@ -177,7 +177,7 @@ describe( 'NodeList', () => { } ); it( 'should remove one node if howMany parameter was not specified', () => { - nodes.removeNodes( 1 ); + nodes._removeNodes( 1 ); expect( nodes.length ).to.equal( 2 ); expect( nodes.maxOffset ).to.equal( 2 ); diff --git a/tests/model/operation/attributeoperation.js b/tests/model/operation/attributeoperation.js index fe81083da..9cc39c7d4 100644 --- a/tests/model/operation/attributeoperation.js +++ b/tests/model/operation/attributeoperation.js @@ -61,7 +61,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should insert attribute to the set of nodes', () => { - root.insertChildren( 0, new Text( 'bar' ) ); + root._insertChildren( 0, new Text( 'bar' ) ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -82,7 +82,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should add attribute to the existing attributes', () => { - root.insertChildren( 0, new Text( 'x', { foo: true, bar: true } ) ); + root._insertChildren( 0, new Text( 'x', { foo: true, bar: true } ) ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -103,7 +103,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should change attribute to the set of nodes', () => { - root.insertChildren( 0, new Text( 'bar', { isNew: false } ) ); + root._insertChildren( 0, new Text( 'bar', { isNew: false } ) ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -124,7 +124,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should change attribute in the middle of existing attributes', () => { - root.insertChildren( 0, new Text( 'x', { foo: true, x: 1, bar: true } ) ); + root._insertChildren( 0, new Text( 'x', { foo: true, x: 1, bar: true } ) ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -145,7 +145,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should work correctly if old and new value are same', () => { - root.insertChildren( 0, new Text( 'bar', { foo: 'bar' } ) ); + root._insertChildren( 0, new Text( 'bar', { foo: 'bar' } ) ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -164,7 +164,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should remove attribute', () => { - root.insertChildren( 0, new Text( 'x', { foo: true, x: true, bar: true } ) ); + root._insertChildren( 0, new Text( 'x', { foo: true, x: true, bar: true } ) ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -185,7 +185,7 @@ describe( 'AttributeOperation', () => { describe( '_validate()', () => { it( 'should not throw for non-primitive attribute values', () => { - root.insertChildren( 0, new Text( 'x', { foo: [ 'bar', 'xyz' ] } ) ); + root._insertChildren( 0, new Text( 'x', { foo: [ 'bar', 'xyz' ] } ) ); expect( () => { const operation = new AttributeOperation( @@ -201,7 +201,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should throw an error when one try to remove and the attribute does not exists', () => { - root.insertChildren( 0, new Text( 'x' ) ); + root._insertChildren( 0, new Text( 'x' ) ); expect( () => { const operation = new AttributeOperation( @@ -217,7 +217,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should throw an error when one try to insert and the attribute already exists', () => { - root.insertChildren( 0, new Text( 'x', { x: 1 } ) ); + root._insertChildren( 0, new Text( 'x', { x: 1 } ) ); expect( () => { const operation = new AttributeOperation( @@ -233,7 +233,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should not throw when attribute value is the same', () => { - root.insertChildren( 0, new Text( 'x', { foo: true } ) ); + root._insertChildren( 0, new Text( 'x', { foo: true } ) ); expect( () => { const operation = new AttributeOperation( @@ -263,7 +263,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should undo adding attribute by applying reverse operation', () => { - root.insertChildren( 0, new Text( 'bar' ) ); + root._insertChildren( 0, new Text( 'bar' ) ); const operation = new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 3 ] ) ), @@ -287,7 +287,7 @@ describe( 'AttributeOperation', () => { const eleA = new Element( 'a', [], new Text( 'abc' ) ); const eleB = new Element( 'b', [], new Text( 'xyz' ) ); - root.insertChildren( 0, [ eleA, eleB ] ); + root._insertChildren( 0, [ eleA, eleB ] ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -308,7 +308,7 @@ describe( 'AttributeOperation', () => { const eleA = new Element( 'a', fooAttr, new Text( 'abc' ) ); const eleB = new Element( 'b', fooAttr, new Text( 'xyz' ) ); - root.insertChildren( 0, [ eleA, eleB ] ); + root._insertChildren( 0, [ eleA, eleB ] ); model.applyOperation( wrapInDelta( new AttributeOperation( @@ -324,7 +324,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should undo changing attribute by applying reverse operation', () => { - root.insertChildren( 0, new Text( 'bar', { isNew: false } ) ); + root._insertChildren( 0, new Text( 'bar', { isNew: false } ) ); const operation = new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 3 ] ) ), @@ -346,7 +346,7 @@ describe( 'AttributeOperation', () => { } ); it( 'should undo remove attribute by applying reverse operation', () => { - root.insertChildren( 0, new Text( 'bar', { foo: true } ) ); + root._insertChildren( 0, new Text( 'bar', { foo: true } ) ); const operation = new AttributeOperation( new Range( new Position( root, [ 0 ] ), new Position( root, [ 3 ] ) ), @@ -390,8 +390,8 @@ describe( 'AttributeOperation', () => { const attrA = { foo: 'a' }; const attrB = { foo: 'b' }; - root.insertChildren( 0, new Text( 'abc', attrA ) ); - root.insertChildren( 1, new Text( 'xyz', attrB ) ); + root._insertChildren( 0, new Text( 'abc', attrA ) ); + root._insertChildren( 1, new Text( 'xyz', attrB ) ); model.applyOperation( wrapInDelta( new AttributeOperation( diff --git a/tests/model/operation/detachoperation.js b/tests/model/operation/detachoperation.js index 2e2b4735b..f2d3672e9 100644 --- a/tests/model/operation/detachoperation.js +++ b/tests/model/operation/detachoperation.js @@ -40,7 +40,7 @@ describe( 'DetachOperation', () => { const root = doc.createRoot(); const element = new Element( 'element' ); - root.appendChildren( [ element ] ); + root._appendChildren( [ element ] ); const op = new DetachOperation( Position.createBefore( element ), 1 ); diff --git a/tests/model/operation/insertoperation.js b/tests/model/operation/insertoperation.js index a90f6ddbb..da7bde714 100644 --- a/tests/model/operation/insertoperation.js +++ b/tests/model/operation/insertoperation.js @@ -78,7 +78,7 @@ describe( 'InsertOperation', () => { } ); it( 'should insert between existing nodes', () => { - root.insertChildren( 0, new Text( 'xy' ) ); + root._insertChildren( 0, new Text( 'xy' ) ); model.applyOperation( wrapInDelta( new InsertOperation( diff --git a/tests/model/operation/markeroperation.js b/tests/model/operation/markeroperation.js index b14b55b69..b234d9136 100644 --- a/tests/model/operation/markeroperation.js +++ b/tests/model/operation/markeroperation.js @@ -20,7 +20,7 @@ describe( 'MarkerOperation', () => { model = new Model(); doc = model.document; root = doc.createRoot(); - root.appendChildren( new Text( 'foo' ) ); + root._appendChildren( new Text( 'foo' ) ); range = Range.createFromParentsAndOffsets( root, 0, root, 0 ); } ); diff --git a/tests/model/operation/moveoperation.js b/tests/model/operation/moveoperation.js index 8cbe9c8d6..4e7510d38 100644 --- a/tests/model/operation/moveoperation.js +++ b/tests/model/operation/moveoperation.js @@ -46,7 +46,7 @@ describe( 'MoveOperation', () => { const p1 = new Element( 'p1', [], new Element( 'x' ) ); const p2 = new Element( 'p2' ); - root.insertChildren( 0, [ p1, p2 ] ); + root._insertChildren( 0, [ p1, p2 ] ); model.applyOperation( wrapInDelta( new MoveOperation( @@ -67,7 +67,7 @@ describe( 'MoveOperation', () => { } ); it( 'should move position of children in one node backward', () => { - root.insertChildren( 0, new Text( 'xbarx' ) ); + root._insertChildren( 0, new Text( 'xbarx' ) ); model.applyOperation( wrapInDelta( new MoveOperation( @@ -84,7 +84,7 @@ describe( 'MoveOperation', () => { } ); it( 'should move position of children in one node forward', () => { - root.insertChildren( 0, new Text( 'xbarx' ) ); + root._insertChildren( 0, new Text( 'xbarx' ) ); model.applyOperation( wrapInDelta( new MoveOperation( @@ -124,7 +124,7 @@ describe( 'MoveOperation', () => { const p1 = new Element( 'p1', [], new Element( 'x' ) ); const p2 = new Element( 'p2' ); - root.insertChildren( 0, [ p1, p2 ] ); + root._insertChildren( 0, [ p1, p2 ] ); const operation = new MoveOperation( new Position( root, [ 0, 0 ] ), @@ -152,7 +152,7 @@ describe( 'MoveOperation', () => { describe( '_validate()', () => { it( 'should throw an error if number of nodes to move exceeds the number of existing nodes in given element', () => { - root.insertChildren( 0, new Text( 'xbarx' ) ); + root._insertChildren( 0, new Text( 'xbarx' ) ); const operation = new MoveOperation( new Position( root, [ 3 ] ), @@ -166,8 +166,8 @@ describe( 'MoveOperation', () => { it( 'should throw an error if target or source parent-element specified by position does not exist', () => { const p = new Element( 'p' ); - p.insertChildren( 0, new Text( 'foo' ) ); - root.insertChildren( 0, [ new Text( 'ab' ), p ] ); + p._insertChildren( 0, new Text( 'foo' ) ); + root._insertChildren( 0, [ new Text( 'ab' ), p ] ); const operation = new MoveOperation( new Position( root, [ 2, 0 ] ), @@ -176,13 +176,13 @@ describe( 'MoveOperation', () => { doc.version ); - root.removeChildren( 1 ); + root._removeChildren( 1 ); expect( () => operation._validate() ).to.throw( CKEditorError, /move-operation-position-invalid/ ); } ); it( 'should throw an error if operation tries to move a range between the beginning and the end of that range', () => { - root.insertChildren( 0, new Text( 'xbarx' ) ); + root._insertChildren( 0, new Text( 'xbarx' ) ); const operation = new MoveOperation( new Position( root, [ 1 ] ), @@ -196,7 +196,7 @@ describe( 'MoveOperation', () => { it( 'should throw an error if operation tries to move a range into a sub-tree of a node that is in that range', () => { const p = new Element( 'p', [], [ new Element( 'p' ) ] ); - root.insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); + root._insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); const operation = new MoveOperation( new Position( root, [ 1 ] ), @@ -210,7 +210,7 @@ describe( 'MoveOperation', () => { it( 'should not throw an error if operation move a range into a sibling', () => { const p = new Element( 'p' ); - root.insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); + root._insertChildren( 0, [ new Text( 'ab' ), p, new Text( 'xy' ) ] ); const operation = new MoveOperation( new Position( root, [ 1 ] ), @@ -224,8 +224,8 @@ describe( 'MoveOperation', () => { it( 'should not throw when operation paths looks like incorrect but move is between different roots', () => { const p = new Element( 'p' ); - root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); - doc.graveyard.insertChildren( 0, new Text( 'abc' ) ); + root._insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); + doc.graveyard._insertChildren( 0, new Text( 'abc' ) ); const operation = new MoveOperation( new Position( doc.graveyard, [ 0 ] ), diff --git a/tests/model/operation/reinsertoperation.js b/tests/model/operation/reinsertoperation.js index a30da3e88..88e567a8d 100644 --- a/tests/model/operation/reinsertoperation.js +++ b/tests/model/operation/reinsertoperation.js @@ -65,7 +65,7 @@ describe( 'ReinsertOperation', () => { } ); it( 'should create RemoveOperation as a reverse', () => { - graveyard.appendChildren( new Element( 'x' ) ); + graveyard._appendChildren( new Element( 'x' ) ); const reverse = operation.getReversed(); @@ -87,7 +87,7 @@ describe( 'ReinsertOperation', () => { it( 'should undo reinsert set of nodes by applying reverse operation', () => { const reverse = operation.getReversed(); - graveyard.insertChildren( 0, new Text( 'xx' ) ); + graveyard._insertChildren( 0, new Text( 'xx' ) ); model.applyOperation( wrapInDelta( operation ) ); @@ -106,7 +106,7 @@ describe( 'ReinsertOperation', () => { it( 'should throw when target position is not in the document', () => { const docFrag = new DocumentFragment(); - graveyard.insertChildren( 0, new Text( 'xx' ) ); + graveyard._insertChildren( 0, new Text( 'xx' ) ); operation = new ReinsertOperation( graveyardPosition, diff --git a/tests/model/operation/removeoperation.js b/tests/model/operation/removeoperation.js index 2177418e3..8b88ec4c9 100644 --- a/tests/model/operation/removeoperation.js +++ b/tests/model/operation/removeoperation.js @@ -58,7 +58,7 @@ describe( 'RemoveOperation', () => { } ); it( 'should be able to remove set of nodes and append them to graveyard root', () => { - root.insertChildren( 0, new Text( 'fozbar' ) ); + root._insertChildren( 0, new Text( 'fozbar' ) ); model.applyOperation( wrapInDelta( new RemoveOperation( @@ -115,7 +115,7 @@ describe( 'RemoveOperation', () => { const operation = new RemoveOperation( position, 3, new Position( doc.graveyard, [ 0 ] ), 0 ); const reverse = operation.getReversed(); - root.insertChildren( 0, new Text( 'bar' ) ); + root._insertChildren( 0, new Text( 'bar' ) ); model.applyOperation( wrapInDelta( operation ) ); @@ -130,7 +130,7 @@ describe( 'RemoveOperation', () => { } ); it( 'should properly remove a node that is already in a graveyard', () => { - doc.graveyard.appendChildren( [ new Element( 'x' ), new Element( 'y' ), new Element( 'z' ) ] ); + doc.graveyard._appendChildren( [ new Element( 'x' ), new Element( 'y' ), new Element( 'z' ) ] ); const position = new Position( doc.graveyard, [ 2 ] ); const operation = new RemoveOperation( position, 1, new Position( doc.graveyard, [ 0 ] ), 0 ); @@ -148,7 +148,7 @@ describe( 'RemoveOperation', () => { const docFrag = new DocumentFragment(); const item = new Element( 'foo' ); - docFrag.appendChildren( [ item ] ); + docFrag._appendChildren( [ item ] ); const op = new RemoveOperation( new Position( docFrag, [ 0 ] ), diff --git a/tests/model/operation/renameoperation.js b/tests/model/operation/renameoperation.js index e2266467e..d275ba744 100644 --- a/tests/model/operation/renameoperation.js +++ b/tests/model/operation/renameoperation.js @@ -22,7 +22,7 @@ describe( 'RenameOperation', () => { root = doc.createRoot(); element = new Element( oldName ); - root.appendChildren( element ); + root._appendChildren( element ); position = Position.createBefore( element ); } ); diff --git a/tests/model/operation/rootattributeoperation.js b/tests/model/operation/rootattributeoperation.js index 0cfbf2230..94ee0ac0b 100644 --- a/tests/model/operation/rootattributeoperation.js +++ b/tests/model/operation/rootattributeoperation.js @@ -73,7 +73,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should change attribute on the root element', () => { - root.setAttribute( 'isNew', false ); + root._setAttribute( 'isNew', false ); model.applyOperation( wrapInDelta( new RootAttributeOperation( @@ -90,7 +90,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should remove attribute from the root element', () => { - root.setAttribute( 'x', true ); + root._setAttribute( 'x', true ); model.applyOperation( wrapInDelta( new RootAttributeOperation( @@ -137,7 +137,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should undo changing attribute by applying reverse operation', () => { - root.setAttribute( 'isNew', false ); + root._setAttribute( 'isNew', false ); const operation = new RootAttributeOperation( root, @@ -157,7 +157,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should undo remove attribute by applying reverse operation', () => { - root.setAttribute( 'foo', true ); + root._setAttribute( 'foo', true ); const operation = new RootAttributeOperation( root, @@ -180,7 +180,7 @@ describe( 'RootAttributeOperation', () => { it( 'should throw an error when trying to change non-root element', () => { const child = new Element( 'p' ); const parent = new Element( 'p' ); - parent.appendChildren( child ); + parent._appendChildren( child ); expect( () => { const op = new RootAttributeOperation( @@ -224,7 +224,7 @@ describe( 'RootAttributeOperation', () => { } ); it( 'should throw an error when trying to add an attribute that already exists', () => { - root.setAttribute( 'x', 1 ); + root._setAttribute( 'x', 1 ); expect( () => { const op = new RootAttributeOperation( diff --git a/tests/model/operation/utils.js b/tests/model/operation/utils.js index 62676487e..cf24afb89 100644 --- a/tests/model/operation/utils.js +++ b/tests/model/operation/utils.js @@ -29,7 +29,7 @@ describe( 'Operation utils', () => { // offset: 0123456789 // data: foobarIxyz // bold: ___BBBB___ - root.appendChildren( [ + root._appendChildren( [ new Text( 'foo' ), new Text( 'bar', { bold: true } ), new Element( 'image', { src: 'img.jpg' } ), diff --git a/tests/model/position.js b/tests/model/position.js index d7b789ce7..6aee3e4f0 100644 --- a/tests/model/position.js +++ b/tests/model/position.js @@ -56,7 +56,7 @@ describe( 'Position', () => { p = new Element( 'p' ); - root.insertChildren( 0, [ p, ul ] ); + root._insertChildren( 0, [ p, ul ] ); } ); describe( 'constructor()', () => { @@ -868,7 +868,7 @@ describe( 'Position', () => { const p = new Element( 'p', null, 'foobar' ); - root.appendChildren( p ); + root._appendChildren( p ); const postion = new Position( root, [ 0, 3 ] ); //

foo^bar

@@ -897,7 +897,7 @@ describe( 'Position', () => { const p = new Element( 'p', null, new Element( 'a' ) ); - root.appendChildren( p ); + root._appendChildren( p ); const postion = new Position( root, [ 0, 0 ] ); //

^

diff --git a/tests/model/range.js b/tests/model/range.js index e83e69735..881fd7a20 100644 --- a/tests/model/range.js +++ b/tests/model/range.js @@ -160,7 +160,7 @@ describe( 'Range', () => { beforeEach( () => { p = new Element( 'p', [], new Text( 'foz' ) ); - root.insertChildren( 0, [ p ] ); + root._insertChildren( 0, [ p ] ); } ); describe( 'createIn()', () => { @@ -245,7 +245,7 @@ describe( 'Range', () => { } beforeEach( () => { - root.appendChildren( new Text( 'abcdefghijklmnopqrtuvwxyz' ) ); + root._appendChildren( new Text( 'abcdefghijklmnopqrtuvwxyz' ) ); } ); it( 'should throw if empty array is passed', () => { @@ -337,9 +337,9 @@ describe( 'Range', () => { const e1 = new Element( 'e1' ); const e2 = new Element( 'e2' ); - e1.insertChildren( 0, [ a, b ] ); - e2.insertChildren( 0, [ x, y ] ); - root.insertChildren( 0, [ e1, e2 ] ); + e1._insertChildren( 0, [ a, b ] ); + e2._insertChildren( 0, [ x, y ] ); + root._insertChildren( 0, [ e1, e2 ] ); const range = new Range( new Position( root, [ 0, 1 ] ), @@ -462,9 +462,9 @@ describe( 'Range', () => { d = new Element( 'd' ); xxx = new Text( 'xxx' ); - b.appendChildren( xxx ); + b._appendChildren( xxx ); - root.appendChildren( [ a, b, c, d ] ); + root._appendChildren( [ a, b, c, d ] ); } ); it( 'should return true if element is inside range and false when it is not inside range', () => { @@ -1214,7 +1214,7 @@ describe( 'Range', () => { describe( 'getTransformedByDeltas()', () => { beforeEach( () => { - root.appendChildren( new Text( 'foobar' ) ); + root._appendChildren( new Text( 'foobar' ) ); range = Range.createFromParentsAndOffsets( root, 2, root, 5 ); } ); @@ -1338,7 +1338,7 @@ describe( 'Range', () => { } function prepareRichRoot() { - root.insertChildren( 0, [ + root._insertChildren( 0, [ new Element( 'div', [], [ new Element( 'h', [], new Text( 'first' ) ), new Element( 'p', [], new Text( 'lorem ipsum' ) ) diff --git a/tests/model/schema.js b/tests/model/schema.js index e3957c55f..465849693 100644 --- a/tests/model/schema.js +++ b/tests/model/schema.js @@ -1501,7 +1501,7 @@ describe( 'Schema', () => { const text = new Text( 'foo', { a: 1, b: 1 } ); const image = new Element( 'image', { a: 1, b: 1 } ); - root.appendChildren( [ text, image ] ); + root._appendChildren( [ text, image ] ); model.change( writer => { schema.removeDisallowedAttributes( root.getChildren(), writer ); @@ -1548,7 +1548,7 @@ describe( 'Schema', () => { const paragraph = new Element( 'paragraph', [], [ foo, imageInParagraph ] ); const div = new Element( 'div', [], [ paragraph, bar, imageInDiv ] ); - root.appendChildren( [ div ] ); + root._appendChildren( [ div ] ); model.change( writer => { schema.removeDisallowedAttributes( root.getChildren(), writer ); @@ -1612,7 +1612,7 @@ describe( 'Schema', () => { } ); const div = new Element( 'div' ); - root1.appendChildren( div ); + root1._appendChildren( div ); const div2 = new Element( 'div' ); @@ -1626,7 +1626,7 @@ describe( 'Schema', () => { } ); const div = new Element( 'div' ); - root1.appendChildren( div ); + root1._appendChildren( div ); expect( schema.checkChild( div, div ) ).to.be.true; } ); @@ -2063,7 +2063,7 @@ describe( 'Schema', () => { it( 'does not break when trying to check registered child in a context which contains non-registered elements', () => { const foo404 = new Element( 'foo404' ); - root1.appendChildren( foo404 ); + root1._appendChildren( foo404 ); schema.register( '$root' ); schema.register( '$text', { @@ -2452,7 +2452,7 @@ describe( 'Schema', () => { // Edge case because p>p should not exist in the first place. // But it's good to know that it blocks also this. const p = new Element( 'p' ); - r1p1.appendChildren( p ); + r1p1._appendChildren( p ); expect( schema.checkChild( p, '$text' ) ).to.be.false; } ); @@ -2746,7 +2746,7 @@ describe( 'SchemaContext', () => { it( 'filters out DocumentFragment when it is a first item of context - element', () => { const p = new Element( 'paragraph' ); const docFrag = new DocumentFragment(); - docFrag.appendChildren( p ); + docFrag._appendChildren( p ); const ctx = new SchemaContext( p ); @@ -2757,7 +2757,7 @@ describe( 'SchemaContext', () => { it( 'filters out DocumentFragment when it is a first item of context - position', () => { const p = new Element( 'paragraph' ); const docFrag = new DocumentFragment(); - docFrag.appendChildren( p ); + docFrag._appendChildren( p ); const ctx = new SchemaContext( new Position( docFrag, [ 0, 0 ] ) ); diff --git a/tests/model/selection.js b/tests/model/selection.js index 74b9370d2..9f5328f10 100644 --- a/tests/model/selection.js +++ b/tests/model/selection.js @@ -25,7 +25,7 @@ describe( 'Selection', () => { model = new Model(); doc = model.document; root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'p' ), new Element( 'p' ), new Element( 'p', [], new Text( 'foobar' ) ), @@ -1112,7 +1112,7 @@ describe( 'Selection', () => { let rangeInFullP; beforeEach( () => { - root.insertChildren( 0, [ + root._insertChildren( 0, [ new Element( 'p', [], new Text( 'foobar' ) ), new Element( 'p', [], [] ) ] ); diff --git a/tests/model/textproxy.js b/tests/model/textproxy.js index 92f2e3832..ed86b888c 100644 --- a/tests/model/textproxy.js +++ b/tests/model/textproxy.js @@ -17,10 +17,10 @@ describe( 'TextProxy', () => { doc = model.document; root = doc.createRoot(); element = new Element( 'div' ); - root.insertChildren( 0, element ); + root._insertChildren( 0, element ); text = new Text( 'foobar', { foo: 'bar' } ); - element.insertChildren( 0, [ new Text( 'abc' ), text ] ); + element._insertChildren( 0, [ new Text( 'abc' ), text ] ); textProxy = new TextProxy( text, 2, 3 ); textNoParent = new Text( 'abcxyz' ); diff --git a/tests/model/treewalker.js b/tests/model/treewalker.js index 4612b4973..13a5fe9b4 100644 --- a/tests/model/treewalker.js +++ b/tests/model/treewalker.js @@ -40,7 +40,7 @@ describe( 'TreeWalker', () => { paragraph = new Element( 'p', [], [ ba, r, img2, x ] ); img1 = new Element( 'img1' ); - root.insertChildren( 0, [ img1, paragraph ] ); + root._insertChildren( 0, [ img1, paragraph ] ); rootBeginning = new Position( root, [ 0 ] ); rootEnding = new Position( root, [ 2 ] ); diff --git a/tests/model/utils-tests/utils.js b/tests/model/utils-tests/utils.js index 523b6c9c2..213beee0c 100644 --- a/tests/model/utils-tests/utils.js +++ b/tests/model/utils-tests/utils.js @@ -32,7 +32,7 @@ describe( 'getNodesAndText', () => { div = new Element( 'div', [], new Text( 'foobar' ) ); p = new Element( 'p', [], new Text( 'abcxyz' ) ); - root.insertChildren( 0, [ div, p ] ); + root._insertChildren( 0, [ div, p ] ); } ); it( 'reads two elements with text', () => { @@ -120,7 +120,7 @@ describe( 'createRangeOnElementOnly', () => { it( 'should create a range that contains only the given element', () => { const parent = new Element( 'parent' ); const element = new Element( 'elem' ); - parent.appendChildren( element ); + parent._appendChildren( element ); const range = createRangeOnElementOnly( element ); diff --git a/tests/model/utils/deletecontent.js b/tests/model/utils/deletecontent.js index 733d84ebc..78165c7e1 100644 --- a/tests/model/utils/deletecontent.js +++ b/tests/model/utils/deletecontent.js @@ -327,7 +327,7 @@ describe( 'DataController utils', () => { // xxfo[o // b]aryy - root.appendChildren( + root._appendChildren( new Element( 'pparent', null, [ 'x', new Element( 'paragraph', null, [ @@ -337,7 +337,7 @@ describe( 'DataController utils', () => { ] ) ); - root.appendChildren( + root._appendChildren( new Element( 'pparent', null, [ new Element( 'paragraph', null, [ new Element( 'pchild', null, 'bar' ), @@ -380,7 +380,7 @@ describe( 'DataController utils', () => { // We need to use the raw API due to https://github.com/ckeditor/ckeditor5-engine/issues/905. // xfooba[rb]om - root.appendChildren( + root._appendChildren( new Element( 'pparent', null, [ 'x', new Element( 'paragraph', null, [ @@ -390,7 +390,7 @@ describe( 'DataController utils', () => { ] ) ); - root.appendChildren( + root._appendChildren( new Element( 'paragraph', null, 'bom' ) ); @@ -427,11 +427,11 @@ describe( 'DataController utils', () => { // We need to use the raw API due to https://github.com/ckeditor/ckeditor5-engine/issues/905. // fo[obar] - root.appendChildren( + root._appendChildren( new Element( 'paragraph', null, 'foo' ) ); - root.appendChildren( + root._appendChildren( new Element( 'pparent', null, [ new Element( 'paragraph', null, [ new Element( 'pchild', null, 'bar' ) diff --git a/tests/model/writer.js b/tests/model/writer.js index f2490df29..7b4c7ad2b 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -1300,7 +1300,7 @@ describe( 'Writer', () => { it( 'should not add empty delta to the batch', () => { const nodeA = new Element( 'p', { a: 1 } ); const nodeB = new Element( 'p', { b: 2 } ); - root.insertChildren( 0, [ nodeA, nodeB ] ); + root._insertChildren( 0, [ nodeA, nodeB ] ); setAttribute( 'a', 1, nodeA ); @@ -1425,7 +1425,7 @@ describe( 'Writer', () => { p1 = new Element( 'p', { key1: 'value1' }, new Text( 'foo' ) ); p2 = new Element( 'p', { key2: 'value2' }, new Text( 'bar' ) ); - root.insertChildren( 0, [ p1, p2 ] ); + root._insertChildren( 0, [ p1, p2 ] ); } ); it( 'should merge foo and bar into foobar', () => { @@ -1481,10 +1481,10 @@ describe( 'Writer', () => { div = new Element( 'div', [], new Text( 'foobar' ) ); p = new Element( 'p', [], new Text( 'abcxyz' ) ); - div.insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); - div.insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); + div._insertChildren( 0, [ new Element( 'p', [], new Text( 'gggg' ) ) ] ); + div._insertChildren( 2, [ new Element( 'p', [], new Text( 'hhhh' ) ) ] ); - root.insertChildren( 0, [ div, p ] ); + root._insertChildren( 0, [ div, p ] ); range = new Range( new Position( root, [ 0, 3 ] ), new Position( root, [ 0, 7 ] ) ); } ); @@ -1669,7 +1669,7 @@ describe( 'Writer', () => { const root = doc.createRoot(); const p = new Element( 'p', null, new Text( 'abc' ) ); - root.appendChildren( p ); + root._appendChildren( p ); rename( p, 'h' ); @@ -1681,7 +1681,7 @@ describe( 'Writer', () => { const docFrag = new DocumentFragment(); const p = new Element( 'p' ); - docFrag.appendChildren( p ); + docFrag._appendChildren( p ); rename( p, 'h' ); @@ -1713,7 +1713,7 @@ describe( 'Writer', () => { p = new Element( 'p', { key: 'value' }, new Text( 'foobar' ) ); - root.insertChildren( 0, p ); + root._insertChildren( 0, p ); } ); it( 'should split foobar to foo and bar', () => { @@ -1736,7 +1736,7 @@ describe( 'Writer', () => { it( 'should split inside document fragment', () => { const docFrag = new DocumentFragment(); - docFrag.appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) ); + docFrag._appendChildren( new Element( 'p', null, new Text( 'foobar' ) ) ); split( new Position( docFrag, [ 0, 3 ] ) ); @@ -1794,7 +1794,7 @@ describe( 'Writer', () => { const div = new Element( 'div', null, p ); const section = new Element( 'section', null, div ); - root.insertChildren( 0, section ); + root._insertChildren( 0, section ); split( new Position( p, [ 3 ] ), section ); @@ -1818,8 +1818,8 @@ describe( 'Writer', () => { const div = new Element( 'div', null, p ); const section = new Element( 'section', null, div ); - root.insertChildren( 0, div ); - root.insertChildren( 1, section ); + root._insertChildren( 0, div ); + root._insertChildren( 1, section ); expect( () => { split( new Position( p, [ 3 ] ), section ); @@ -1841,7 +1841,7 @@ describe( 'Writer', () => { beforeEach( () => { root = doc.createRoot(); - root.insertChildren( 0, new Text( 'foobar' ) ); + root._insertChildren( 0, new Text( 'foobar' ) ); range = new Range( new Position( root, [ 2 ] ), new Position( root, [ 4 ] ) ); } ); @@ -1878,7 +1878,7 @@ describe( 'Writer', () => { } ); it( 'should throw if range to wrap is not flat', () => { - root.insertChildren( 1, [ new Element( 'p', [], new Text( 'xyz' ) ) ] ); + root._insertChildren( 1, [ new Element( 'p', [], new Text( 'xyz' ) ) ] ); const notFlatRange = new Range( new Position( root, [ 3 ] ), new Position( root, [ 6, 2 ] ) ); expect( () => { @@ -1896,7 +1896,7 @@ describe( 'Writer', () => { it( 'should throw if element to wrap with has children #2', () => { const p = new Element( 'p' ); - root.insertChildren( 0, p ); + root._insertChildren( 0, p ); expect( () => { wrap( range, p ); @@ -1919,7 +1919,7 @@ describe( 'Writer', () => { root = doc.createRoot(); p = new Element( 'p', [], new Text( 'xyz' ) ); - root.insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); + root._insertChildren( 0, [ new Text( 'a' ), p, new Text( 'b' ) ] ); } ); it( 'should unwrap given element', () => { @@ -1960,7 +1960,7 @@ describe( 'Writer', () => { beforeEach( () => { root = doc.createRoot(); - root.appendChildren( new Text( 'foo' ) ); + root._appendChildren( new Text( 'foo' ) ); range = Range.createIn( root ); } ); @@ -2126,7 +2126,7 @@ describe( 'Writer', () => { beforeEach( () => { root = doc.createRoot(); - root.appendChildren( new Text( 'foo' ) ); + root._appendChildren( new Text( 'foo' ) ); range = Range.createIn( root ); } ); @@ -2184,7 +2184,7 @@ describe( 'Writer', () => { model.schema.extend( 'p', { allowIn: '$root' } ); root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'p' ), new Element( 'p' ), new Element( 'p', [], new Text( 'foo' ) ) @@ -2221,7 +2221,7 @@ describe( 'Writer', () => { model.schema.extend( 'p', { allowIn: '$root' } ); root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'p' ), new Element( 'p' ), new Element( 'p', [], new Text( 'foo' ) ) @@ -2257,7 +2257,7 @@ describe( 'Writer', () => { model.schema.extend( 'p', { allowIn: '$root' } ); root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'p', [], [] ), new Element( 'p' ), new Element( 'p', [], new Text( 'foo' ) ) @@ -2302,7 +2302,7 @@ describe( 'Writer', () => { model.schema.extend( 'p', { allowIn: '$root' } ); root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Element( 'p', [], [] ), new Element( 'p' ), new Element( 'p', [], new Text( 'foo' ) ) @@ -2359,7 +2359,7 @@ describe( 'Writer', () => { it( 'should not get attributes from the node before the caret when gravity is overridden', () => { const root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Text( 'foo', { foo: true } ), new Text( 'bar', { foo: true, bar: true } ), new Text( 'biz', { foo: true } ) @@ -2383,7 +2383,7 @@ describe( 'Writer', () => { it( 'should allow to restorer gravity in a custom way', () => { const root = doc.createRoot(); - root.appendChildren( [ new Text( 'foobar', { foo: true } ) ] ); + root._appendChildren( [ new Text( 'foobar', { foo: true } ) ] ); setSelection( new Position( root, [ 1 ] ) ); @@ -2412,7 +2412,7 @@ describe( 'Writer', () => { it( 'should restore overridden gravity to default', () => { const root = doc.createRoot(); - root.appendChildren( [ + root._appendChildren( [ new Text( 'foo', { foo: true } ), new Text( 'bar', { foo: true, bar: true } ), new Text( 'biz', { foo: true } ) diff --git a/tests/tickets/1323.js b/tests/tickets/1323.js index 803fa3fe1..2415c5e7d 100644 --- a/tests/tickets/1323.js +++ b/tests/tickets/1323.js @@ -20,7 +20,7 @@ describe( 'Bug ckeditor5-engine@1323', () => { model = new Model(); editing = new EditingController( model ); root = model.document.createRoot(); - root.appendChildren( new ModelText( 'foo' ) ); + root._appendChildren( new ModelText( 'foo' ) ); range = ModelRange.createFromParentsAndOffsets( root, 0, root, 0 ); } ); diff --git a/tests/view/documentfragment.js b/tests/view/documentfragment.js index 6b3965467..49c7a253d 100644 --- a/tests/view/documentfragment.js +++ b/tests/view/documentfragment.js @@ -107,8 +107,8 @@ describe( 'DocumentFragment', () => { describe( 'insertion', () => { it( 'should insert children', () => { - const count1 = fragment.insertChildren( 0, [ el1, el3 ] ); - const count2 = fragment.insertChildren( 1, el2 ); + const count1 = fragment._insertChildren( 0, [ el1, el3 ] ); + const count2 = fragment._insertChildren( 1, el2 ); expect( fragment.childCount ).to.equal( 3 ); expect( fragment.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -119,22 +119,22 @@ describe( 'DocumentFragment', () => { } ); it( 'should accept strings', () => { - fragment.insertChildren( 0, 'abc' ); + fragment._insertChildren( 0, 'abc' ); expect( fragment.childCount ).to.equal( 1 ); expect( fragment.getChild( 0 ) ).to.have.property( 'data' ).that.equals( 'abc' ); - fragment.removeChildren( 0, 1 ); - fragment.insertChildren( 0, [ new Element( 'p' ), 'abc' ] ); + fragment._removeChildren( 0, 1 ); + fragment._insertChildren( 0, [ new Element( 'p' ), 'abc' ] ); expect( fragment.childCount ).to.equal( 2 ); expect( fragment.getChild( 1 ) ).to.have.property( 'data' ).that.equals( 'abc' ); } ); it( 'should append children', () => { - const count1 = fragment.insertChildren( 0, el1 ); - const count2 = fragment.appendChildren( el2 ); - const count3 = fragment.appendChildren( el3 ); + const count1 = fragment._insertChildren( 0, el1 ); + const count2 = fragment._appendChildren( el2 ); + const count3 = fragment._appendChildren( el3 ); expect( fragment.childCount ).to.equal( 3 ); expect( fragment.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -151,7 +151,7 @@ describe( 'DocumentFragment', () => { done(); } ); - fragment.insertChildren( 0, el1 ); + fragment._insertChildren( 0, el1 ); } ); it( 'should fire change event when appending', done => { @@ -160,7 +160,7 @@ describe( 'DocumentFragment', () => { done(); } ); - fragment.appendChildren( el1 ); + fragment._appendChildren( el1 ); } ); it( 'should accept and correctly handle text proxies', () => { @@ -168,7 +168,7 @@ describe( 'DocumentFragment', () => { const text = new Text( 'abcxyz' ); const textProxy = new TextProxy( text, 2, 3 ); - frag.insertChildren( 0, textProxy ); + frag._insertChildren( 0, textProxy ); expect( frag.childCount ).to.equal( 1 ); expect( frag.getChild( 0 ) ).to.be.instanceof( Text ); @@ -178,9 +178,9 @@ describe( 'DocumentFragment', () => { describe( 'getChildIndex', () => { it( 'should return child index', () => { - fragment.appendChildren( el1 ); - fragment.appendChildren( el2 ); - fragment.appendChildren( el3 ); + fragment._appendChildren( el1 ); + fragment._appendChildren( el2 ); + fragment._appendChildren( el3 ); expect( fragment.childCount ).to.equal( 3 ); expect( fragment.getChildIndex( el1 ) ).to.equal( 0 ); @@ -191,9 +191,9 @@ describe( 'DocumentFragment', () => { describe( 'getChildren', () => { it( 'should renturn children iterator', () => { - fragment.appendChildren( el1 ); - fragment.appendChildren( el2 ); - fragment.appendChildren( el3 ); + fragment._appendChildren( el1 ); + fragment._appendChildren( el2 ); + fragment._appendChildren( el3 ); const expected = [ el1, el2, el3 ]; let i = 0; @@ -207,14 +207,14 @@ describe( 'DocumentFragment', () => { } ); } ); - describe( 'removeChildren', () => { + describe( '_removeChildren', () => { it( 'should remove children', () => { - fragment.appendChildren( el1 ); - fragment.appendChildren( el2 ); - fragment.appendChildren( el3 ); - fragment.appendChildren( el4 ); + fragment._appendChildren( el1 ); + fragment._appendChildren( el2 ); + fragment._appendChildren( el3 ); + fragment._appendChildren( el4 ); - fragment.removeChildren( 1, 2 ); + fragment._removeChildren( 1, 2 ); expect( fragment.childCount ).to.equal( 2 ); expect( fragment.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -227,11 +227,11 @@ describe( 'DocumentFragment', () => { } ); it( 'should remove one child when second parameter is not specified', () => { - fragment.appendChildren( el1 ); - fragment.appendChildren( el2 ); - fragment.appendChildren( el3 ); + fragment._appendChildren( el1 ); + fragment._appendChildren( el2 ); + fragment._appendChildren( el3 ); - const removed = fragment.removeChildren( 1 ); + const removed = fragment._removeChildren( 1 ); expect( fragment.childCount ).to.equal( 2 ); expect( fragment.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -242,14 +242,14 @@ describe( 'DocumentFragment', () => { } ); it( 'should fire change event', done => { - fragment.appendChildren( el1 ); + fragment._appendChildren( el1 ); fragment.once( 'change:children', ( event, node ) => { expect( node ).to.equal( fragment ); done(); } ); - fragment.removeChildren( 0 ); + fragment._removeChildren( 0 ); } ); } ); } ); @@ -291,14 +291,14 @@ describe( 'DocumentFragment', () => { expect( node3.previousSibling ).to.equal( node2 ); } ); - it( 'remove() should remove node from fragment', () => { + it( '_remove() should remove node from fragment', () => { const node1 = new Node(); const node2 = new Node(); const node3 = new Node(); const fragment = new DocumentFragment( [ node1, node2, node3 ] ); - node1.remove(); - node3.remove(); + node1._remove(); + node3._remove(); expect( fragment.childCount ).to.equal( 1 ); expect( node1.parent ).to.be.null; diff --git a/tests/view/domconverter/view-to-dom.js b/tests/view/domconverter/view-to-dom.js index a10591aa8..de885f874 100644 --- a/tests/view/domconverter/view-to-dom.js +++ b/tests/view/domconverter/view-to-dom.js @@ -31,8 +31,8 @@ describe( 'DomConverter', () => { const viewText = new ViewText( 'foo' ); const viewP = new ViewElement( 'p', { class: 'foo' } ); - viewP.appendChildren( viewImg ); - viewP.appendChildren( viewText ); + viewP._appendChildren( viewImg ); + viewP._appendChildren( viewText ); const domImg = document.createElement( 'img' ); @@ -59,8 +59,8 @@ describe( 'DomConverter', () => { const viewText = new ViewText( 'foo' ); const viewP = new ViewElement( 'p', { class: 'foo' } ); - viewP.appendChildren( viewImg ); - viewP.appendChildren( viewText ); + viewP._appendChildren( viewImg ); + viewP._appendChildren( viewText ); const domP = converter.viewToDom( viewP, document, { bind: true } ); @@ -96,8 +96,8 @@ describe( 'DomConverter', () => { const viewText = new ViewText( 'foo' ); const viewP = new ViewElement( 'p', { class: 'foo' } ); - viewP.appendChildren( viewImg ); - viewP.appendChildren( viewText ); + viewP._appendChildren( viewImg ); + viewP._appendChildren( viewText ); const domImg = document.createElement( 'img' ); @@ -120,8 +120,8 @@ describe( 'DomConverter', () => { const viewText = new ViewText( 'foo' ); const viewFragment = new ViewDocumentFragment(); - viewFragment.appendChildren( viewImg ); - viewFragment.appendChildren( viewText ); + viewFragment._appendChildren( viewImg ); + viewFragment._appendChildren( viewText ); const domFragment = converter.viewToDom( viewFragment, document, { bind: true } ); @@ -139,8 +139,8 @@ describe( 'DomConverter', () => { const viewText = new ViewText( 'foo' ); const viewFragment = new ViewDocumentFragment(); - viewFragment.appendChildren( viewImg ); - viewFragment.appendChildren( viewText ); + viewFragment._appendChildren( viewImg ); + viewFragment._appendChildren( viewText ); const domImg = document.createElement( 'img' ); @@ -244,7 +244,7 @@ describe( 'DomConverter', () => { const viewElement = new ViewContainerElement( 'p' ); for ( const text of inputTexts ) { - viewElement.appendChildren( new ViewText( text.replace( /_/g, '\u00A0' ) ) ); + viewElement._appendChildren( new ViewText( text.replace( /_/g, '\u00A0' ) ) ); } const domElement = converter.viewToDom( viewElement, document ); diff --git a/tests/view/element.js b/tests/view/element.js index b3d995b43..58975812c 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -305,8 +305,8 @@ describe( 'Element', () => { describe( 'insertion', () => { it( 'should insert children', () => { - const count1 = parent.insertChildren( 0, [ el1, el3 ] ); - const count2 = parent.insertChildren( 1, el2 ); + const count1 = parent._insertChildren( 0, [ el1, el3 ] ); + const count2 = parent._insertChildren( 1, el2 ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -317,22 +317,22 @@ describe( 'Element', () => { } ); it( 'should accept strings', () => { - parent.insertChildren( 0, 'abc' ); + parent._insertChildren( 0, 'abc' ); expect( parent.childCount ).to.equal( 1 ); expect( parent.getChild( 0 ) ).to.have.property( 'data' ).that.equals( 'abc' ); - parent.removeChildren( 0, 1 ); - parent.insertChildren( 0, [ new Element( 'p' ), 'abc' ] ); + parent._removeChildren( 0, 1 ); + parent._insertChildren( 0, [ new Element( 'p' ), 'abc' ] ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 1 ) ).to.have.property( 'data' ).that.equals( 'abc' ); } ); it( 'should append children', () => { - const count1 = parent.insertChildren( 0, el1 ); - const count2 = parent.appendChildren( el2 ); - const count3 = parent.appendChildren( el3 ); + const count1 = parent._insertChildren( 0, el1 ); + const count2 = parent._appendChildren( el2 ); + const count3 = parent._appendChildren( el3 ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -348,7 +348,7 @@ describe( 'Element', () => { const text = new Text( 'abcxyz' ); const textProxy = new TextProxy( text, 2, 3 ); - element.insertChildren( 0, textProxy ); + element._insertChildren( 0, textProxy ); expect( element.childCount ).to.equal( 1 ); expect( element.getChild( 0 ) ).to.be.instanceof( Text ); @@ -358,9 +358,9 @@ describe( 'Element', () => { describe( 'getChildIndex', () => { it( 'should return child index', () => { - parent.appendChildren( el1 ); - parent.appendChildren( el2 ); - parent.appendChildren( el3 ); + parent._appendChildren( el1 ); + parent._appendChildren( el2 ); + parent._appendChildren( el3 ); expect( parent.childCount ).to.equal( 3 ); expect( parent.getChildIndex( el1 ) ).to.equal( 0 ); @@ -371,9 +371,9 @@ describe( 'Element', () => { describe( 'getChildren', () => { it( 'should renturn children iterator', () => { - parent.appendChildren( el1 ); - parent.appendChildren( el2 ); - parent.appendChildren( el3 ); + parent._appendChildren( el1 ); + parent._appendChildren( el2 ); + parent._appendChildren( el3 ); const expected = [ el1, el2, el3 ]; let i = 0; @@ -387,14 +387,14 @@ describe( 'Element', () => { } ); } ); - describe( 'removeChildren', () => { + describe( '_removeChildren', () => { it( 'should remove children', () => { - parent.appendChildren( el1 ); - parent.appendChildren( el2 ); - parent.appendChildren( el3 ); - parent.appendChildren( el4 ); + parent._appendChildren( el1 ); + parent._appendChildren( el2 ); + parent._appendChildren( el3 ); + parent._appendChildren( el4 ); - parent.removeChildren( 1, 2 ); + parent._removeChildren( 1, 2 ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); @@ -407,11 +407,11 @@ describe( 'Element', () => { } ); it( 'should remove one child when second parameter is not specified', () => { - parent.appendChildren( el1 ); - parent.appendChildren( el2 ); - parent.appendChildren( el3 ); + parent._appendChildren( el1 ); + parent._appendChildren( el2 ); + parent._appendChildren( el3 ); - const removed = parent.removeChildren( 1 ); + const removed = parent._removeChildren( 1 ); expect( parent.childCount ).to.equal( 2 ); expect( parent.getChild( 0 ) ).to.have.property( 'name' ).that.equals( 'el1' ); diff --git a/tests/view/emptyelement.js b/tests/view/emptyelement.js index 384818338..859a7d6e6 100644 --- a/tests/view/emptyelement.js +++ b/tests/view/emptyelement.js @@ -54,18 +54,18 @@ describe( 'EmptyElement', () => { } ).to.throw( CKEditorError, 'view-emptyelement-cannot-add: Cannot add child nodes to EmptyElement instance.' ); } ); - describe( 'appendChildren', () => { + describe( '_appendChildren', () => { it( 'should throw when try to append new child element', () => { expect( () => { - emptyElement.appendChildren( element ); + emptyElement._appendChildren( element ); } ).to.throw( CKEditorError, 'view-emptyelement-cannot-add: Cannot add child nodes to EmptyElement instance.' ); } ); } ); - describe( 'insertChildren', () => { + describe( '_insertChildren', () => { it( 'should throw when try to insert new child element', () => { expect( () => { - emptyElement.insertChildren( 0, element ); + emptyElement._insertChildren( 0, element ); } ).to.throw( CKEditorError, 'view-emptyelement-cannot-add: Cannot add child nodes to EmptyElement instance.' ); } ); } ); diff --git a/tests/view/manual/uielement.js b/tests/view/manual/uielement.js index b708b15ad..9171d4818 100644 --- a/tests/view/manual/uielement.js +++ b/tests/view/manual/uielement.js @@ -47,7 +47,7 @@ class UIElementTestPlugin extends Plugin { // Add some UIElement to each paragraph. editing.downcastDispatcher.on( 'insert:paragraph', ( evt, data, conversionApi ) => { const viewP = conversionApi.mapper.toViewElement( data.item ); - viewP.appendChildren( createEndingUIElement( conversionApi.writer ) ); + viewP._appendChildren( createEndingUIElement( conversionApi.writer ) ); }, { priority: 'lowest' } ); } } diff --git a/tests/view/node.js b/tests/view/node.js index 3f04cd58c..58261fa4c 100644 --- a/tests/view/node.js +++ b/tests/view/node.js @@ -100,7 +100,7 @@ describe( 'Node', () => { it( 'should return ancestors including DocumentFragment', () => { const fragment = new DocumentFragment( root ); const result = img.getAncestors(); - root.remove(); + root._remove(); expect( result.length ).to.equal( 3 ); expect( result[ 0 ] ).to.equal( fragment ); @@ -258,24 +258,24 @@ describe( 'Node', () => { } ); } ); - describe( 'remove()', () => { + describe( '_remove()', () => { it( 'should remove node from its parent', () => { const char = new Text( 'a' ); const parent = new Element( 'p', null, [ char ] ); - char.remove(); + char._remove(); expect( parent.getChildIndex( char ) ).to.equal( -1 ); } ); - it( 'uses parent.removeChildren method', () => { + it( 'uses parent._removeChildren method', () => { const char = new Text( 'a' ); const parent = new Element( 'p', null, [ char ] ); - const removeChildrenSpy = sinon.spy( parent, 'removeChildren' ); + const _removeChildrenSpy = sinon.spy( parent, '_removeChildren' ); const index = char.index; - char.remove(); - removeChildrenSpy.restore(); - sinon.assert.calledOnce( removeChildrenSpy ); - sinon.assert.calledWithExactly( removeChildrenSpy, index ); + char._remove(); + _removeChildrenSpy.restore(); + sinon.assert.calledOnce( _removeChildrenSpy ); + sinon.assert.calledWithExactly( _removeChildrenSpy, index ); } ); } ); @@ -283,7 +283,7 @@ describe( 'Node', () => { it( 'should prevent circular reference when stringifying a node', () => { const char = new Text( 'a' ); const parent = new Element( 'p', null ); - parent.appendChildren( char ); + parent._appendChildren( char ); const json = JSON.stringify( char ); const parsed = JSON.parse( json ); @@ -306,7 +306,7 @@ describe( 'Node', () => { img = new Element( 'img', { 'src': 'img.png' } ); root = new Element( 'p', { renderer: { markToSync: rootChangeSpy } } ); - root.appendChildren( [ text, img ] ); + root._appendChildren( [ text, img ] ); root.on( 'change:children', ( evt, node ) => rootChangeSpy( 'children', node ) ); root.on( 'change:attributes', ( evt, node ) => rootChangeSpy( 'attributes', node ) ); @@ -353,34 +353,34 @@ describe( 'Node', () => { } ); } ); - describe( 'insertChildren()', () => { + describe( '_insertChildren()', () => { it( 'should fire change event', () => { - root.insertChildren( 1, new Element( 'img' ) ); + root._insertChildren( 1, new Element( 'img' ) ); sinon.assert.calledOnce( rootChangeSpy ); sinon.assert.calledWith( rootChangeSpy, 'children', root ); } ); } ); - describe( 'appendChildren()', () => { + describe( '_appendChildren()', () => { it( 'should fire change event', () => { - root.appendChildren( new Element( 'img' ) ); + root._appendChildren( new Element( 'img' ) ); sinon.assert.calledOnce( rootChangeSpy ); sinon.assert.calledWith( rootChangeSpy, 'children', root ); } ); } ); - describe( 'removeChildren()', () => { + describe( '_removeChildren()', () => { it( 'should fire change event', () => { - root.removeChildren( 1, 1 ); + root._removeChildren( 1, 1 ); sinon.assert.calledOnce( rootChangeSpy ); sinon.assert.calledWith( rootChangeSpy, 'children', root ); } ); } ); - describe( 'removeChildren()', () => { + describe( '_removeChildren()', () => { it( 'should fire change event', () => { text.data = 'bar'; diff --git a/tests/view/observer/domeventobserver.js b/tests/view/observer/domeventobserver.js index 3b7f0421a..ddf05d6c7 100644 --- a/tests/view/observer/domeventobserver.js +++ b/tests/view/observer/domeventobserver.js @@ -182,7 +182,7 @@ describe( 'DomEventObserver', () => { const viewRoot = createViewRoot( viewDocument ); view.attachDomRoot( domRoot ); uiElement = createUIElement( 'p' ); - viewRoot.appendChildren( uiElement ); + viewRoot._appendChildren( uiElement ); view.render(); domEvent = new MouseEvent( 'click', { bubbles: true } ); diff --git a/tests/view/observer/mutationobserver.js b/tests/view/observer/mutationobserver.js index d7aef2bfa..735d2303e 100644 --- a/tests/view/observer/mutationobserver.js +++ b/tests/view/observer/mutationobserver.js @@ -37,7 +37,7 @@ describe( 'MutationObserver', () => { viewRoot = viewDocument.getRoot(); - viewRoot.appendChildren( parse( 'foobar' ) ); + viewRoot._appendChildren( parse( 'foobar' ) ); view.render(); } ); @@ -96,8 +96,8 @@ describe( 'MutationObserver', () => { } ); it( 'should handle unbold', () => { - viewRoot.removeChildren( 0, viewRoot.childCount ); - viewRoot.appendChildren( parse( 'foo' ) ); + viewRoot._removeChildren( 0, viewRoot.childCount ); + viewRoot._appendChildren( parse( 'foo' ) ); view.render(); const domP = domEditor.childNodes[ 0 ]; @@ -203,7 +203,7 @@ describe( 'MutationObserver', () => { createViewRoot( viewDocument, 'div', 'additional' ); view.attachDomRoot( domAdditionalEditor, 'additional' ); - viewDocument.getRoot( 'additional' ).appendChildren( + viewDocument.getRoot( 'additional' )._appendChildren( parse( 'foobar' ) ); // Render AdditionalEditor (first editor has been rendered in the beforeEach function) @@ -228,7 +228,7 @@ describe( 'MutationObserver', () => { const { view: viewContainer, selection } = parse( 'foo[]bar' ); view.change( writer => { - viewRoot.appendChildren( viewContainer ); + viewRoot._appendChildren( viewContainer ); writer.setSelection( selection ); } ); @@ -246,7 +246,7 @@ describe( 'MutationObserver', () => { const { view: viewContainer, selection } = parse( 'foo[]bar' ); view.change( writer => { - viewRoot.appendChildren( viewContainer ); + viewRoot._appendChildren( viewContainer ); writer.setSelection( selection ); } ); @@ -254,7 +254,7 @@ describe( 'MutationObserver', () => { inlineFiller.data += 'x'; view.change( () => { - viewContainer.getChild( 1 ).appendChildren( parse( 'x' ) ); + viewContainer.getChild( 1 )._appendChildren( parse( 'x' ) ); mutationObserver.flush(); } ); @@ -270,7 +270,7 @@ describe( 'MutationObserver', () => { } ); it( 'should have no block filler in mutation', () => { - viewRoot.appendChildren( parse( '' ) ); + viewRoot._appendChildren( parse( '' ) ); view.render(); @@ -289,7 +289,7 @@ describe( 'MutationObserver', () => { } ); it( 'should ignore mutation with bogus br inserted on the end of the empty paragraph', () => { - viewRoot.appendChildren( parse( '' ) ); + viewRoot._appendChildren( parse( '' ) ); view.render(); @@ -302,7 +302,7 @@ describe( 'MutationObserver', () => { } ); it( 'should ignore mutation with bogus br inserted on the end of the paragraph with text', () => { - viewRoot.appendChildren( parse( 'foo' ) ); + viewRoot._appendChildren( parse( 'foo' ) ); view.render(); @@ -315,7 +315,7 @@ describe( 'MutationObserver', () => { } ); it( 'should ignore mutation with bogus br inserted on the end of the paragraph while processing text mutations', () => { - viewRoot.appendChildren( parse( 'foo' ) ); + viewRoot._appendChildren( parse( 'foo' ) ); view.render(); @@ -332,7 +332,7 @@ describe( 'MutationObserver', () => { } ); it( 'should ignore child mutations which resulted in no changes – when element contains elements', () => { - viewRoot.appendChildren( parse( '' ) ); + viewRoot._appendChildren( parse( '' ) ); view.render(); @@ -366,7 +366,7 @@ describe( 'MutationObserver', () => { } ); it( 'should not ignore mutation with br inserted not on the end of the paragraph', () => { - viewRoot.appendChildren( parse( 'foo' ) ); + viewRoot._appendChildren( parse( 'foo' ) ); view.render(); @@ -385,7 +385,7 @@ describe( 'MutationObserver', () => { } ); it( 'should not ignore mutation inserting element different than br on the end of the empty paragraph', () => { - viewRoot.appendChildren( parse( '' ) ); + viewRoot._appendChildren( parse( '' ) ); view.render(); @@ -403,7 +403,7 @@ describe( 'MutationObserver', () => { } ); it( 'should not ignore mutation inserting element different than br on the end of the paragraph with text', () => { - viewRoot.appendChildren( parse( 'foo' ) ); + viewRoot._appendChildren( parse( 'foo' ) ); view.render(); @@ -437,7 +437,7 @@ describe( 'MutationObserver', () => { beforeEach( () => { const uiElement = createUIElement( 'div' ); - viewRoot.appendChildren( uiElement ); + viewRoot._appendChildren( uiElement ); view.render(); } ); diff --git a/tests/view/observer/selectionobserver.js b/tests/view/observer/selectionobserver.js index 86b1b59df..27bdf25d2 100644 --- a/tests/view/observer/selectionobserver.js +++ b/tests/view/observer/selectionobserver.js @@ -37,7 +37,7 @@ describe( 'SelectionObserver', () => { viewRoot = viewDocument.getRoot(); view.change( writer => { - viewRoot.appendChildren( parse( + viewRoot._appendChildren( parse( 'xxx' + 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy' ) ); diff --git a/tests/view/renderer.js b/tests/view/renderer.js index d5ab6a77f..6f8537a31 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -43,7 +43,7 @@ describe( 'Renderer', () => { const domRoot = document.createElement( 'p' ); domConverter.bindElements( domRoot, viewRoot ); - viewRoot.appendChildren( new ViewText( 'foo' ) ); + viewRoot._appendChildren( new ViewText( 'foo' ) ); renderer.markedTexts.clear(); renderer.markedAttributes.clear(); @@ -59,7 +59,7 @@ describe( 'Renderer', () => { } ); it( 'should mark children which need update', () => { - viewRoot.appendChildren( new ViewText( 'foo' ) ); + viewRoot._appendChildren( new ViewText( 'foo' ) ); renderer.markToSync( 'children', viewRoot ); @@ -70,7 +70,7 @@ describe( 'Renderer', () => { // Overwrite viewRoot with node without coresponding DOM node. viewRoot = new ViewElement( 'p' ); - viewRoot.appendChildren( new ViewText( 'foo' ) ); + viewRoot._appendChildren( new ViewText( 'foo' ) ); renderer.markToSync( 'children', viewRoot ); @@ -79,7 +79,7 @@ describe( 'Renderer', () => { it( 'should mark text which need update', () => { const viewText = new ViewText( 'foo' ); - viewRoot.appendChildren( viewText ); + viewRoot._appendChildren( viewText ); viewText.data = 'bar'; renderer.markToSync( 'text', viewText ); @@ -92,7 +92,7 @@ describe( 'Renderer', () => { // Overwrite viewRoot with node without coresponding DOM node. viewRoot = new ViewElement( 'p' ); - viewRoot.appendChildren( viewText ); + viewRoot._appendChildren( viewText ); viewText.data = 'bar'; renderer.markToSync( 'text', viewText ); @@ -166,7 +166,7 @@ describe( 'Renderer', () => { } ); it( 'should add children', () => { - viewRoot.appendChildren( new ViewText( 'foo' ) ); + viewRoot._appendChildren( new ViewText( 'foo' ) ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -178,7 +178,7 @@ describe( 'Renderer', () => { } ); it( 'should remove children', () => { - viewRoot.appendChildren( new ViewText( 'foo' ) ); + viewRoot._appendChildren( new ViewText( 'foo' ) ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -186,7 +186,7 @@ describe( 'Renderer', () => { expect( domRoot.childNodes.length ).to.equal( 1 ); expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' ); - viewRoot.removeChildren( 0, 1 ); + viewRoot._removeChildren( 0, 1 ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -198,7 +198,7 @@ describe( 'Renderer', () => { it( 'should update text', () => { const viewText = new ViewText( 'foo' ); - viewRoot.appendChildren( viewText ); + viewRoot._appendChildren( viewText ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -220,7 +220,7 @@ describe( 'Renderer', () => { it( 'should not update text parent child list changed', () => { const viewImg = new ViewElement( 'img' ); const viewText = new ViewText( 'foo' ); - viewRoot.appendChildren( [ viewImg, viewText ] ); + viewRoot._appendChildren( [ viewImg, viewText ] ); renderer.markToSync( 'children', viewRoot ); renderer.markToSync( 'text', viewText ); @@ -233,7 +233,7 @@ describe( 'Renderer', () => { it( 'should not change text if it is the same during text rendering', () => { const viewText = new ViewText( 'foo' ); - viewRoot.appendChildren( viewText ); + viewRoot._appendChildren( viewText ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -250,7 +250,7 @@ describe( 'Renderer', () => { it( 'should not change text if it is the same during children rendering', () => { const viewText = new ViewText( 'foo' ); - viewRoot.appendChildren( viewText ); + viewRoot._appendChildren( viewText ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -267,7 +267,7 @@ describe( 'Renderer', () => { it( 'should not change element if it is the same', () => { const viewImg = new ViewElement( 'img' ); - viewRoot.appendChildren( viewImg ); + viewRoot._appendChildren( viewImg ); // This should not be changed during the render. const domImg = document.createElement( 'img' ); @@ -284,14 +284,14 @@ describe( 'Renderer', () => { it( 'should change element if it is different', () => { const viewImg = new ViewElement( 'img' ); - viewRoot.appendChildren( viewImg ); + viewRoot._appendChildren( viewImg ); renderer.markToSync( 'children', viewRoot ); renderer.render(); const viewP = new ViewElement( 'p' ); - viewRoot.removeChildren( 0, 1 ); - viewRoot.appendChildren( viewP ); + viewRoot._removeChildren( 0, 1 ); + viewRoot._appendChildren( viewP ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -305,18 +305,18 @@ describe( 'Renderer', () => { const viewP = new ViewElement( 'p', null, viewFoo ); const viewDiv = new ViewElement( 'div', null, viewP ); - viewRoot.appendChildren( viewDiv ); + viewRoot._appendChildren( viewDiv ); renderer.markToSync( 'children', viewRoot ); renderer.render(); - viewDiv.removeChildren( 0, 1 ); + viewDiv._removeChildren( 0, 1 ); renderer.markToSync( 'children', viewDiv ); renderer.render(); - viewP.removeChildren( 0, 1 ); + viewP._removeChildren( 0, 1 ); - viewDiv.appendChildren( viewP ); + viewDiv._appendChildren( viewP ); renderer.markToSync( 'children', viewDiv ); renderer.render(); @@ -338,21 +338,21 @@ describe( 'Renderer', () => { const viewP = new ViewElement( 'p' ); const viewDivInner = new ViewElement( 'div', null, viewP ); const viewDivOuter = new ViewElement( 'div', null, viewDivInner ); - viewRoot.appendChildren( viewDivOuter ); + viewRoot._appendChildren( viewDivOuter ); // Render view tree to DOM. renderer.markToSync( 'children', viewRoot ); renderer.render(); // Remove div "outer" from root and render it. - viewDivOuter.remove(); + viewDivOuter._remove(); renderer.markToSync( 'children', viewRoot ); renderer.render(); // Remove p from div "child" -- div "inner" won't be marked because it is in document fragment not view root. - viewP.remove(); + viewP._remove(); // Add div "outer" back to root. - viewRoot.appendChildren( viewDivOuter ); + viewRoot._appendChildren( viewDivOuter ); renderer.markToSync( 'children', viewRoot ); // Render changes, view is: root -> div "outer" -> div "inner". @@ -377,18 +377,18 @@ describe( 'Renderer', () => { const viewP = new ViewElement( 'p', null, viewFoo ); const viewDiv = new ViewElement( 'div', null, viewP ); - viewRoot.appendChildren( viewDiv ); + viewRoot._appendChildren( viewDiv ); renderer.markToSync( 'children', viewRoot ); renderer.render(); - viewRoot.removeChildren( 0, 1 ); + viewRoot._removeChildren( 0, 1 ); renderer.markToSync( 'children', viewRoot ); - viewDiv.removeChildren( 0, 1 ); + viewDiv._removeChildren( 0, 1 ); renderer.markToSync( 'children', viewDiv ); - viewP.removeChildren( 0, 1 ); + viewP._removeChildren( 0, 1 ); renderer.markToSync( 'children', viewP ); renderer.render(); @@ -403,7 +403,7 @@ describe( 'Renderer', () => { 'foo[]bar' ); const viewRoot = new ViewElement( 'p' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -417,7 +417,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -439,7 +439,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -464,7 +464,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -523,7 +523,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[]foo' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -574,7 +574,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -624,7 +624,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -652,7 +652,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -688,7 +688,7 @@ describe( 'Renderer', () => { // Step 1:

foo"FILLER{}"

const { view: viewP, selection: newSelection } = parse( 'foo[]' ); const viewB = viewP.getChild( 1 ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -703,7 +703,7 @@ describe( 'Renderer', () => { // Step 2: Add text node. const viewText = new ViewText( 'x' ); - viewB.appendChildren( viewText ); + viewB._appendChildren( viewText ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) ); renderer.markToSync( 'children', viewB ); @@ -727,7 +727,7 @@ describe( 'Renderer', () => { it( 'should remove filler from a modified DOM in case

barfoo[]

', () => { // Step 1:

barfoo"FILLER{}"

const { view: viewP, selection: newSelection } = parse( 'barfoo[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -738,7 +738,7 @@ describe( 'Renderer', () => { expect( domP.childNodes[ 2 ].data ).to.equal( INLINE_FILLER ); // Step 2: Remove the and update the selection (

bar[]

). - viewP.removeChildren( 1 ); + viewP._removeChildren( 1 ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 1, viewP, 1 ) ); @@ -756,7 +756,7 @@ describe( 'Renderer', () => { const { view: viewFragment, selection: newSelection } = parse( 'foo[]bar' ); - viewRoot.appendChildren( viewFragment ); + viewRoot._appendChildren( viewFragment ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -773,9 +773,9 @@ describe( 'Renderer', () => { //

[]

foobar

const viewP = viewRoot.getChild( 0 ); const viewP2 = viewRoot.getChild( 1 ); - const removedChildren = viewP.removeChildren( 0, 2 ); + const removedChildren = viewP._removeChildren( 0, 2 ); - viewP2.appendChildren( removedChildren ); + viewP2._appendChildren( removedChildren ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) ); @@ -798,7 +798,7 @@ describe( 'Renderer', () => { it( 'should not break when selection is moved to a new element, when filler exists', () => { // Step 1:

bar"FILLER{}"

const { view: viewP, selection: newSelection } = parse( 'bar[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -809,10 +809,10 @@ describe( 'Renderer', () => { expect( domP.childNodes[ 1 ].childNodes[ 0 ].data ).to.equal( INLINE_FILLER ); // Step 2: Move selection to a new attribute element and remove the previous one - viewP.removeChildren( 1 ); // Remove . + viewP._removeChildren( 1 ); // Remove . const viewI = parse( '' ); - viewP.appendChildren( viewI ); + viewP._appendChildren( viewI ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewI, 0, viewI, 0 ) ); @@ -830,7 +830,7 @@ describe( 'Renderer', () => { it( 'should remove inline filler if selection is before a view element not bound to dom', () => { // Step 1:

barabc"FILLER"{}

const { view: viewP, selection: newSelection } = parse( 'barabc[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -842,7 +842,7 @@ describe( 'Renderer', () => { // Step 2: Move selection to a new attribute element. const viewAbc = parse( 'abc' ); - viewP.appendChildren( viewAbc ); + viewP._appendChildren( viewAbc ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 3, viewP, 3 ) ); @@ -859,7 +859,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -886,7 +886,7 @@ describe( 'Renderer', () => { domSelection.addRange( domRange ); const viewText = new ViewText( 'x' ); - viewP.appendChildren( viewText ); + viewP._appendChildren( viewText ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) ); renderer.markToSync( 'children', viewP ); @@ -898,7 +898,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -916,7 +916,7 @@ describe( 'Renderer', () => { // Add text node only in View

x{}

const viewText = new ViewText( 'x' ); - viewP.appendChildren( viewText ); + viewP._appendChildren( viewText ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) ); renderer.markToSync( 'children', viewP ); @@ -936,7 +936,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'x{}' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -962,7 +962,7 @@ describe( 'Renderer', () => { domRange.collapse( true ); domSelection.addRange( domRange ); - viewP.removeChildren( 0 ); + viewP._removeChildren( 0 ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewP, 0, viewP, 0 ) ); @@ -978,7 +978,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[]foo' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1014,7 +1014,7 @@ describe( 'Renderer', () => { domSelection.addRange( domRange ); const viewText = new ViewText( 'x' ); - viewB.appendChildren( viewText ); + viewB._appendChildren( viewText ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) ); renderer.markToSync( 'children', viewP ); @@ -1029,7 +1029,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[]foo' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1057,7 +1057,7 @@ describe( 'Renderer', () => { // 3. Add text node only to the view:

x{}foo

. const viewText = new ViewText( 'x' ); - viewB.appendChildren( viewText ); + viewB._appendChildren( viewText ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) ); renderer.markToSync( 'children', viewB ); @@ -1092,7 +1092,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[]foo' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1120,7 +1120,7 @@ describe( 'Renderer', () => { // 3. Add text node only to the view:

x{}foo

. const viewText = new ViewText( 'x' ); - viewB.appendChildren( viewText ); + viewB._appendChildren( viewText ); selection._setTo( ViewRange.createFromParentsAndOffsets( viewText, 1, viewText, 1 ) ); renderer.markToSync( 'text', viewText ); @@ -1143,7 +1143,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'fo{ob}ar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1181,7 +1181,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'fo{o}' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.render(); @@ -1223,7 +1223,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'fo{o}' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.render(); @@ -1252,7 +1252,7 @@ describe( 'Renderer', () => { it( 'should not add inline filler after text node', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1267,7 +1267,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1300,7 +1300,7 @@ describe( 'Renderer', () => { const { view: view, selection: newSelection } = parse( inputView ); - viewRoot.appendChildren( view ); + viewRoot._appendChildren( view ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1311,9 +1311,9 @@ describe( 'Renderer', () => { // 3. Move the inline filler parent to a newly created element. const viewLi = view.getChild( 0 ); - const viewLiIndented = view.removeChildren( 1, 1 ); // Array with one element. + const viewLiIndented = view._removeChildren( 1, 1 ); // Array with one element. const viewUl = new ViewContainerElement( 'ul', null, viewLiIndented ); - viewLi.appendChildren( viewUl ); + viewLi._appendChildren( viewUl ); // 4. Mark changed items and render the view. renderer.markToSync( 'children', view ); @@ -1361,7 +1361,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( '[foo bar]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); renderer.render(); @@ -1551,7 +1551,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo{}bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1591,7 +1591,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1630,7 +1630,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'fo{o}bar' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1669,7 +1669,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo[]' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1711,7 +1711,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo{ba}r' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1749,7 +1749,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foob{ar}baz' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1787,7 +1787,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'foo{ba}r' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); @@ -1825,7 +1825,7 @@ describe( 'Renderer', () => { const { view: viewP, selection: newSelection } = parse( 'f{oobar}baz' ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); selection._setTo( newSelection ); renderer.markToSync( 'children', viewRoot ); diff --git a/tests/view/selection.js b/tests/view/selection.js index f3a162791..c33452846 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -879,7 +879,7 @@ describe( 'Selection', () => { const selection = viewDocument.selection; const root = createViewRoot( viewDocument, 'div', 'main' ); const element = new Element( 'p' ); - root.appendChildren( element ); + root._appendChildren( element ); selection._setTo( Range.createFromParentsAndOffsets( element, 0, element, 0 ) ); diff --git a/tests/view/treewalker.js b/tests/view/treewalker.js index 0516d4866..36178569b 100644 --- a/tests/view/treewalker.js +++ b/tests/view/treewalker.js @@ -42,7 +42,7 @@ describe( 'TreeWalker', () => { paragraph = new ContainerElement( 'p', null, [ bold, charY, img2, charX ] ); img1 = new ContainerElement( 'img1' ); - root.insertChildren( 0, [ img1, paragraph ] ); + root._insertChildren( 0, [ img1, paragraph ] ); rootBeginning = new Position( root, 0 ); rootEnding = new Position( root, 2 ); diff --git a/tests/view/uielement.js b/tests/view/uielement.js index ff5491fb0..99652d07a 100644 --- a/tests/view/uielement.js +++ b/tests/view/uielement.js @@ -66,18 +66,18 @@ describe( 'UIElement', () => { } ); } ); - describe( 'appendChildren()', () => { + describe( '_appendChildren()', () => { it( 'should throw when try to append new child element', () => { expect( () => { - uiElement.appendChildren( new Element( 'i' ) ); + uiElement._appendChildren( new Element( 'i' ) ); } ).to.throw( CKEditorError, 'view-uielement-cannot-add: Cannot add child nodes to UIElement instance.' ); } ); } ); - describe( 'insertChildren()', () => { + describe( '_insertChildren()', () => { it( 'should throw when try to insert new child element', () => { expect( () => { - uiElement.insertChildren( 0, new Element( 'i' ) ); + uiElement._insertChildren( 0, new Element( 'i' ) ); } ).to.throw( CKEditorError, 'view-uielement-cannot-add: Cannot add child nodes to UIElement instance.' ); } ); } ); diff --git a/tests/view/view/jumpoverinlinefiller.js b/tests/view/view/jumpoverinlinefiller.js index 6792b0e88..e1202f996 100644 --- a/tests/view/view/jumpoverinlinefiller.js +++ b/tests/view/view/jumpoverinlinefiller.js @@ -114,7 +114,7 @@ describe( 'View', () => { // Do this both in the view and in the DOM to simulate typing and to avoid rendering (which would remove the filler). const viewB = writer.document.selection.getFirstPosition().parent; const viewTextX = parse( 'x' ); - viewB.appendChildren( viewTextX ); + viewB._appendChildren( viewTextX ); writer.setSelection( viewTextX, 1 ); const domB = view.getDomRoot( 'main' ).querySelector( 'b' ); diff --git a/tests/view/view/jumpoveruielement.js b/tests/view/view/jumpoveruielement.js index fde4aeee4..aac927f58 100644 --- a/tests/view/view/jumpoveruielement.js +++ b/tests/view/view/jumpoveruielement.js @@ -89,7 +89,7 @@ describe( 'View', () => { it( 'do nothing when another key is pressed', () => { // fooxxx{}bar const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( [ ViewRange.createFromParentsAndOffsets( bar, 0, bar, 0 ) ] ); @@ -107,7 +107,7 @@ describe( 'View', () => { it( 'jump over ui element when right arrow is pressed before ui element - directly before ui element', () => { // foo[]xxxbar const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( [ ViewRange.createFromParentsAndOffsets( p, 1, p, 1 ) ] ); @@ -127,7 +127,7 @@ describe( 'View', () => { it( 'jump over ui element when right arrow is pressed before ui element - not directly before ui element', () => { // foo{}xxxbar const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); @@ -147,7 +147,7 @@ describe( 'View', () => { it( 'jump over multiple ui elements when right arrow is pressed before ui element', () => { // foo{}xxxyyybar' const p = new ViewContainerElement( 'p', null, [ foo, ui, ui2, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); @@ -170,8 +170,8 @@ describe( 'View', () => { const div = new ViewContainerElement( 'div' ); view.change( writer => { - viewRoot.appendChildren( p ); - viewRoot.appendChildren( div ); + viewRoot._appendChildren( p ); + viewRoot._appendChildren( div ); writer.setSelection( [ ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ] ); } ); @@ -190,7 +190,7 @@ describe( 'View', () => { // foo{}xxxbar const b = new ViewAttribtueElement( 'b', null, foo ); const p = new ViewContainerElement( 'p', null, [ b, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ); @@ -211,7 +211,7 @@ describe( 'View', () => { // foo[]xxxbar const b = new ViewAttribtueElement( 'b', null, foo ); const p = new ViewContainerElement( 'p', null, [ b, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( b, 1, b, 1 ) ); @@ -242,7 +242,7 @@ describe( 'View', () => { const i = new ViewAttribtueElement( 'i', null, b ); const p = new ViewContainerElement( 'p', null, [ i, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ); @@ -272,7 +272,7 @@ describe( 'View', () => { const b2 = new ViewAttribtueElement( 'b' ); const p = new ViewContainerElement( 'p', null, [ foo, b1, ui, ui2, b2, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ); @@ -303,7 +303,7 @@ describe( 'View', () => { const b2 = new ViewAttribtueElement( 'b' ); const p = new ViewContainerElement( 'p', null, [ foo, b1, ui, ui2, b2, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 3, foo, 3 ) ); @@ -382,7 +382,7 @@ describe( 'View', () => { // fo{o}xxxbar const p = new ViewContainerElement( 'p', null, [ foo, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 2, foo, 3 ) ); @@ -410,7 +410,7 @@ describe( 'View', () => { const b = new ViewAttribtueElement( 'b', null, foo ); const i = new ViewAttribtueElement( 'i', null, b ); const p = new ViewContainerElement( 'p', null, [ i, ui, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 2, foo, 3 ) ); @@ -439,7 +439,7 @@ describe( 'View', () => { const b1 = new ViewAttribtueElement( 'b' ); const b2 = new ViewAttribtueElement( 'b' ); const p = new ViewContainerElement( 'p', null, [ foo, b1, ui, ui2, b2, bar ] ); - viewRoot.appendChildren( p ); + viewRoot._appendChildren( p ); view.change( writer => { writer.setSelection( ViewRange.createFromParentsAndOffsets( foo, 2, foo, 3 ) ); diff --git a/tests/view/view/view.js b/tests/view/view/view.js index bb5369e8e..1f6b89ab0 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -408,7 +408,7 @@ describe( 'view', () => { createRoot( 'div', 'main', viewDocument ); view.attachDomRoot( domDiv ); - viewDocument.getRoot().appendChildren( new ViewElement( 'p' ) ); + viewDocument.getRoot()._appendChildren( new ViewElement( 'p' ) ); view.render(); expect( domDiv.childNodes.length ).to.equal( 1 ); @@ -427,7 +427,7 @@ describe( 'view', () => { view.attachDomRoot( domRoot ); const viewP = new ViewElement( 'p', { class: 'foo' } ); - viewRoot.appendChildren( viewP ); + viewRoot._appendChildren( viewP ); view.render(); expect( domRoot.childNodes.length ).to.equal( 1 ); From 002370276246d1b5d3f6c81df0259bd359d6a137 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 27 Feb 2018 15:36:11 +0100 Subject: [PATCH 654/724] Fixed: Improved how `model.Differ` checks whether the operation should be buffered or not. --- src/model/differ.js | 48 +++++++++++++++++++++++++++---------------- tests/model/differ.js | 39 ++++++++++++++++++++++++++++++++++- 2 files changed, 68 insertions(+), 19 deletions(-) diff --git a/src/model/differ.js b/src/model/differ.js index b521fd78d..8e3398655 100644 --- a/src/model/differ.js +++ b/src/model/differ.js @@ -107,30 +107,54 @@ export default class Differ { */ bufferOperation( operation ) { switch ( operation.type ) { - case 'insert': + case 'insert': { + if ( this._isInInsertedElement( operation.position.parent ) ) { + return; + } + this._markInsert( operation.position.parent, operation.position.offset, operation.nodes.maxOffset ); break; + } case 'addAttribute': case 'removeAttribute': - case 'changeAttribute': + case 'changeAttribute': { for ( const item of operation.range.getItems() ) { + if ( this._isInInsertedElement( item.parent ) ) { + continue; + } + this._markAttribute( item ); } break; + } case 'remove': case 'move': - case 'reinsert': - this._markRemove( operation.sourcePosition.parent, operation.sourcePosition.offset, operation.howMany ); - this._markInsert( operation.targetPosition.parent, operation.getMovedRangeStart().offset, operation.howMany ); + case 'reinsert': { + const sourceParentInserted = this._isInInsertedElement( operation.sourcePosition.parent ); + const targetParentInserted = this._isInInsertedElement( operation.targetPosition.parent ); + + if ( !sourceParentInserted ) { + this._markRemove( operation.sourcePosition.parent, operation.sourcePosition.offset, operation.howMany ); + } + + if ( !targetParentInserted ) { + this._markInsert( operation.targetPosition.parent, operation.getMovedRangeStart().offset, operation.howMany ); + } break; - case 'rename': + } + case 'rename': { + if ( this._isInInsertedElement( operation.position.parent ) ) { + return; + } + this._markRemove( operation.position.parent, operation.position.offset, 1 ); this._markInsert( operation.position.parent, operation.position.offset, 1 ); break; + } } // Clear cache after each buffered operation as it is no longer valid. @@ -396,10 +420,6 @@ export default class Differ { * @param {Number} howMany */ _markInsert( parent, offset, howMany ) { - if ( this._isInInsertedElement( parent ) ) { - return; - } - const changeItem = { type: 'insert', offset, howMany, count: this._changeCount++ }; this._markChange( parent, changeItem ); @@ -414,10 +434,6 @@ export default class Differ { * @param {Number} howMany */ _markRemove( parent, offset, howMany ) { - if ( this._isInInsertedElement( parent ) ) { - return; - } - const changeItem = { type: 'remove', offset, howMany, count: this._changeCount++ }; this._markChange( parent, changeItem ); @@ -432,10 +448,6 @@ export default class Differ { * @param {module:engine/model/item~Item} item */ _markAttribute( item ) { - if ( this._isInInsertedElement( item.parent ) ) { - return; - } - const changeItem = { type: 'attribute', offset: item.startOffset, howMany: item.offsetSize, count: this._changeCount++ }; this._markChange( item.parent, changeItem ); diff --git a/tests/model/differ.js b/tests/model/differ.js index 69c81ffec..8a977f4a4 100644 --- a/tests/model/differ.js +++ b/tests/model/differ.js @@ -641,6 +641,18 @@ describe( 'Differ', () => { ] ); } ); } ); + + it( 'inside a new element', () => { + // Since the rename is inside a new element, it should not be listed on changes list. + model.change( () => { + insert( new Element( 'blockQuote', null, new Element( 'paragraph' ) ), new Position( root, [ 2 ] ) ); + rename( root.getChild( 2 ).getChild( 0 ), 'listItem' ); + + expectChanges( [ + { type: 'insert', name: 'blockQuote', length: 1, position: new Position( root, [ 2 ] ) } + ] ); + } ); + } ); } ); describe( 'attribute', () => { @@ -1230,7 +1242,10 @@ describe( 'Differ', () => { } ); } ); - it( 'proper filtering of changes in inserted elements', () => { + // In this scenario we create a new element, then remove something from before it to mess up with offsets, + // finally we insert some content into a new element. Since we are inserting into a new element, the + // inserted children should not be shown on changes list. + it( 'proper filtering of changes in inserted elements #1', () => { root.removeChildren( 0, root.childCount ); root.appendChildren( new Element( 'image' ) ); @@ -1250,6 +1265,26 @@ describe( 'Differ', () => { ] ); } ); } ); + + // In this scenario we create a new element, then move another element that was before the new element into + // the new element. This way we mess up with offsets and insert content into a new element in one operation. + // Since we are inserting into a new element, the insertion of moved element should not be shown on changes list. + it( 'proper filtering of changes in inserted elements #2', () => { + root.removeChildren( 0, root.childCount ); + root.appendChildren( new Element( 'image' ) ); + + model.change( () => { + // Insert `div` after `image`. + insert( new Element( 'div' ), new Position( root, [ 1 ] ) ); + // Move `image` to the new `div`. + move( new Position( root, [ 0 ] ), 1, new Position( root, [ 1, 0 ] ) ); + + expectChanges( [ + { type: 'remove', name: 'image', length: 1, position: new Position( root, [ 0 ] ) }, + { type: 'insert', name: 'div', length: 1, position: new Position( root, [ 0 ] ) } + ] ); + } ); + } ); } ); describe( 'getChanges()', () => { @@ -1410,6 +1445,8 @@ describe( 'Differ', () => { function expectChanges( expected, includeChangesInGraveyard = false ) { const changes = differ.getChanges( { includeChangesInGraveyard } ); + expect( changes.length ).to.equal( expected.length ); + for ( let i = 0; i < expected.length; i++ ) { for ( const key in expected[ i ] ) { if ( expected[ i ].hasOwnProperty( key ) ) { From ccaf36496c76b6e8efdc6cbb8418cb12641b8cf0 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 28 Feb 2018 08:01:15 +0100 Subject: [PATCH 655/724] Fixed invalid link in docs. --- src/model/documentfragment.js | 2 +- src/model/element.js | 2 +- src/model/text.js | 2 +- src/view/documentfragment.js | 3 --- src/view/element.js | 6 +++++- src/view/text.js | 2 +- 6 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/model/documentfragment.js b/src/model/documentfragment.js index 6cc5c7f39..0e2a3d5eb 100644 --- a/src/model/documentfragment.js +++ b/src/model/documentfragment.js @@ -26,7 +26,7 @@ export default class DocumentFragment { * Creates an empty `DocumentFragment`. * * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/model/writer~Writer.createDocumentFragment} method. + * {@link module:engine/model/writer~Writer#createDocumentFragment} method. * * @protected * @param {module:engine/model/node~Node|Iterable.} [children] diff --git a/src/model/element.js b/src/model/element.js index 958508702..6f07e6389 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -26,7 +26,7 @@ export default class Element extends Node { * Creates a model element. * * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/model/writer~Writer.createElement} method. + * {@link module:engine/model/writer~Writer#createElement} method. * * @protected * @param {String} name Element's name. diff --git a/src/model/text.js b/src/model/text.js index 65f80b2bf..8b1e7a03c 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -27,7 +27,7 @@ export default class Text extends Node { * Creates a text node. * * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/model/writer~Writer.createText} method. + * {@link module:engine/model/writer~Writer#createText} method. * * @protected * @param {String} data Node's text. diff --git a/src/view/documentfragment.js b/src/view/documentfragment.js index 620a22f47..3b41d5463 100644 --- a/src/view/documentfragment.js +++ b/src/view/documentfragment.js @@ -20,9 +20,6 @@ export default class DocumentFragment { /** * Creates new DocumentFragment instance. * - * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/view/writer~Writer.createDocumentFragment} method. - * * @protected * @param {module:engine/view/node~Node|Iterable.} [children] List of nodes to be inserted into * created document fragment. diff --git a/src/view/element.js b/src/view/element.js index 4afb7ef6c..a0c509184 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -39,7 +39,11 @@ export default class Element extends Node { * new Element( 'div', mapOfAttributes ); // map * * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/view/writer~Writer.createElement} method. + * {@link module:engine/view/writer~Writer#createAttributeElement} for inline element, + * {@link module:engine/view/writer~Writer#createContainerElement} for block element, + * {@link module:engine/view/writer~Writer#createEditableElement} for editable element, + * {@link module:engine/view/writer~Writer#createEmptyElement} for empty element or + * {@link module:engine/view/writer~Writer#createUIElement} for UI element. * * @protected * @param {String} name Node name. diff --git a/src/view/text.js b/src/view/text.js index ba82edffe..500e2b594 100644 --- a/src/view/text.js +++ b/src/view/text.js @@ -19,7 +19,7 @@ export default class Text extends Node { * Creates a tree view text node. * * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/view/writer~Writer.createText} method. + * {@link module:engine/view/writer~Writer#createText} method. * * @protected * @param {String} data Text. From 2462d27dee6029161853c7f0bbae8953049bd768 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Wed, 28 Feb 2018 16:00:46 +0100 Subject: [PATCH 656/724] Docs: Updated links with anchors. See ckeditor/ckeditor5#826. [skip ci] --- docs/api/engine.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/engine.md b/docs/api/engine.md index c26a500a8..03ad8c32f 100644 --- a/docs/api/engine.md +++ b/docs/api/engine.md @@ -12,7 +12,7 @@ Together with the {@link api/core core editor architecture} and the {@link api/u ## Documentation -See the introduction to the {@link framework/guides/architecture/intro#Editing-engine editing engine's architecture}. +See the introduction to the {@link framework/guides/architecture/intro#editing-engine editing engine's architecture}. You can also browse the API documentation of this package by using the module tree on the left. From 59b60eae099193b6ae13480615ba215b42a91428 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Krzto=C5=84?= Date: Wed, 28 Feb 2018 14:49:59 +0100 Subject: [PATCH 657/724] Introduced composition observer. --- src/view/document.js | 12 ++++ src/view/observer/compositionobserver.js | 79 ++++++++++++++++++++++++ src/view/renderer.js | 7 +++ src/view/view.js | 4 ++ 4 files changed, 102 insertions(+) create mode 100644 src/view/observer/compositionobserver.js diff --git a/src/view/document.js b/src/view/document.js index 4b848d31c..2b7b49af7 100644 --- a/src/view/document.js +++ b/src/view/document.js @@ -66,6 +66,18 @@ export default class Document { */ this.set( 'isFocused', false ); + /** + * True if composition is in progress inside the document. + * + * This property is updated by the {@link module:engine/view/observer/compositionobserver~CompositionObserver}. + * If the {@link module:engine/view/observer/compositionobserver~CompositionObserver} is disabled this property will not change. + * + * @readonly + * @observable + * @member {Boolean} module:engine/view/document~Document#isComposing + */ + this.set( 'isComposing', false ); + /** * Post-fixer callbacks registered to the view document. * diff --git a/src/view/observer/compositionobserver.js b/src/view/observer/compositionobserver.js new file mode 100644 index 000000000..1d863aacc --- /dev/null +++ b/src/view/observer/compositionobserver.js @@ -0,0 +1,79 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/** + * @module engine/view/observer/compositionobserver + */ + +import DomEventObserver from './domeventobserver'; + +/** + * {@link module:engine/view/document~Document#event:compositionstart Compositionstart}, + * {@link module:engine/view/document~Document#event:compositionupdate compositionupdate} and + * {@link module:engine/view/document~Document#event:compositionend compositionend} events observer. + * + * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default. + * + * @extends module:engine/view/observer/domeventobserver~DomEventObserver + */ +export default class CompositionObserver extends DomEventObserver { + constructor( view ) { + super( view ); + + this.domEventType = [ 'compositionstart', 'compositionupdate', 'compositionend' ]; + const document = this.document; + + document.on( 'compositionstart', () => { + document.isComposing = true; + } ); + + document.on( 'compositionend', () => { + document.isComposing = false; + } ); + } + + onDomEvent( domEvent ) { + this.fire( domEvent.type, domEvent ); + } +} + +/** + * Fired when composition starts inside one of the editables. + * + * Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}. + * + * Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the + * {@link module:engine/view/view~View} this event is available by default. + * + * @see module:engine/view/observer/compositionobserver~CompositionObserver + * @event module:engine/view/document~Document#event:compositionstart + * @param {module:engine/view/observer/domeventdata~DomEventData} data Event data. + */ + +/** + * Fired when composition is updated inside one of the editables. + * + * Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}. + * + * Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the + * {@link module:engine/view/view~View} this event is available by default. + * + * @see module:engine/view/observer/compositionobserver~CompositionObserver + * @event module:engine/view/document~Document#event:compositionupdate + * @param {module:engine/view/observer/domeventdata~DomEventData} data Event data. + */ + +/** + * Fired when composition ends inside one of the editables. + * + * Introduced by {@link module:engine/view/observer/compositionobserver~CompositionObserver}. + * + * Note that because {@link module:engine/view/observer/compositionobserver~CompositionObserver} is attached by the + * {@link module:engine/view/view~View} this event is available by default. + * + * @see module:engine/view/observer/compositionobserver~CompositionObserver + * @event module:engine/view/document~Document#event:compositionend + * @param {module:engine/view/observer/domeventdata~DomEventData} data Event data. + */ diff --git a/src/view/renderer.js b/src/view/renderer.js index 10e7ef4f9..b86ec5cd5 100644 --- a/src/view/renderer.js +++ b/src/view/renderer.js @@ -103,6 +103,13 @@ export default class Renderer { */ this.isFocused = false; + /** + * Indicates if composition takes places inside view document. + * + * @member {Boolean} + */ + this.isComposing = false; + /** * DOM element containing fake selection. * diff --git a/src/view/view.js b/src/view/view.js index a62a2224f..e3f74ba6a 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -17,6 +17,7 @@ import KeyObserver from './observer/keyobserver'; import FakeSelectionObserver from './observer/fakeselectionobserver'; import SelectionObserver from './observer/selectionobserver'; import FocusObserver from './observer/focusobserver'; +import CompositionObserver from './observer/compositionobserver'; import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; import log from '@ckeditor/ckeditor5-utils/src/log'; @@ -47,6 +48,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; * * {@link module:engine/view/observer/focusobserver~FocusObserver}, * * {@link module:engine/view/observer/keyobserver~KeyObserver}, * * {@link module:engine/view/observer/fakeselectionobserver~FakeSelectionObserver}. + * * {@link module:engine/view/observer/compositionobserver~CompositionObserver}. * * This class also {@link module:engine/view/view~View#attachDomRoot bind DOM and View elements}. * @@ -83,6 +85,7 @@ export default class View { */ this._renderer = new Renderer( this.domConverter, this.document.selection ); this._renderer.bind( 'isFocused' ).to( this.document ); + this._renderer.bind( 'isComposing' ).to( this.document ); /** * Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys. @@ -138,6 +141,7 @@ export default class View { this.addObserver( FocusObserver ); this.addObserver( KeyObserver ); this.addObserver( FakeSelectionObserver ); + this.addObserver( CompositionObserver ); // Inject quirks handlers. injectQuirksHandling( this ); From 248a85c78043745319c9131abd16a3b0cd71dd99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Krzto=C5=84?= Date: Wed, 28 Feb 2018 14:51:43 +0100 Subject: [PATCH 658/724] Tests: composition observer unit tests. --- tests/view/observer/compositionobserver.js | 109 +++++++++++++++++++++ tests/view/view/view.js | 16 ++- 2 files changed, 124 insertions(+), 1 deletion(-) create mode 100644 tests/view/observer/compositionobserver.js diff --git a/tests/view/observer/compositionobserver.js b/tests/view/observer/compositionobserver.js new file mode 100644 index 000000000..2a16f3968 --- /dev/null +++ b/tests/view/observer/compositionobserver.js @@ -0,0 +1,109 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/* globals document */ +import CompositionObserver from '../../../src/view/observer/compositionobserver'; +import View from '../../../src/view/view'; + +describe( 'CompositionObserver', () => { + let view, viewDocument, observer; + + beforeEach( () => { + view = new View(); + viewDocument = view.document; + observer = view.getObserver( CompositionObserver ); + } ); + + afterEach( () => { + view.destroy(); + } ); + + it( 'should define domEventType', () => { + expect( observer.domEventType ).to.deep.equal( [ 'compositionstart', 'compositionupdate', 'compositionend' ] ); + } ); + + describe( 'onDomEvent', () => { + it( 'should fire compositionstart with the right event data', () => { + const spy = sinon.spy(); + + viewDocument.on( 'compositionstart', spy ); + + observer.onDomEvent( { type: 'compositionstart', target: document.body } ); + + expect( spy.calledOnce ).to.be.true; + + const data = spy.args[ 0 ][ 1 ]; + expect( data.domTarget ).to.equal( document.body ); + } ); + + it( 'should fire compositionupdate with the right event data', () => { + const spy = sinon.spy(); + + viewDocument.on( 'compositionupdate', spy ); + + observer.onDomEvent( { type: 'compositionupdate', target: document.body } ); + + expect( spy.calledOnce ).to.be.true; + + const data = spy.args[ 0 ][ 1 ]; + expect( data.domTarget ).to.equal( document.body ); + } ); + + it( 'should fire compositionend with the right event data', () => { + const spy = sinon.spy(); + + viewDocument.on( 'compositionend', spy ); + + observer.onDomEvent( { type: 'compositionend', target: document.body } ); + + expect( spy.calledOnce ).to.be.true; + + const data = spy.args[ 0 ][ 1 ]; + expect( data.domTarget ).to.equal( document.body ); + } ); + } ); + + describe( 'handle isComposing property of the document', () => { + let domMain; + + beforeEach( () => { + domMain = document.createElement( 'div' ); + } ); + + it( 'should set isComposing to true on compositionstart', () => { + observer.onDomEvent( { type: 'compositionstart', target: domMain } ); + + expect( viewDocument.isComposing ).to.equal( true ); + } ); + + it( 'should set isComposing to false on compositionend', () => { + observer.onDomEvent( { type: 'compositionstart', target: domMain } ); + + expect( viewDocument.isComposing ).to.equal( true ); + + observer.onDomEvent( { type: 'compositionend', target: domMain } ); + + expect( viewDocument.isComposing ).to.equal( false ); + } ); + + it( 'should not change isComposing on compositionupdate during composition', () => { + observer.onDomEvent( { type: 'compositionstart', target: domMain } ); + + expect( viewDocument.isComposing ).to.equal( true ); + + observer.onDomEvent( { type: 'compositionupdate', target: domMain } ); + + expect( viewDocument.isComposing ).to.equal( true ); + } ); + + it( 'should not change isComposing on compositionupdate outside composition', () => { + expect( viewDocument.isComposing ).to.equal( false ); + + observer.onDomEvent( { type: 'compositionupdate', target: domMain } ); + + expect( viewDocument.isComposing ).to.equal( false ); + } ); + } ); +} ); diff --git a/tests/view/view/view.js b/tests/view/view/view.js index bb5369e8e..9256cc084 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -7,6 +7,7 @@ import KeyObserver from '../../../src/view/observer/keyobserver'; import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver'; import SelectionObserver from '../../../src/view/observer/selectionobserver'; import FocusObserver from '../../../src/view/observer/focusobserver'; +import CompositionObserver from '../../../src/view/observer/compositionobserver'; import createViewRoot from '../_utils/createroot'; import Observer from '../../../src/view/observer/observer'; import log from '@ckeditor/ckeditor5-utils/src/log'; @@ -21,7 +22,7 @@ import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; describe( 'view', () => { - const DEFAULT_OBSERVERS_COUNT = 5; + const DEFAULT_OBSERVERS_COUNT = 6; let domRoot, view, viewDocument, ObserverMock, instantiated, enabled, ObserverMockGlobalCount; testUtils.createSinonSandbox(); @@ -76,6 +77,7 @@ describe( 'view', () => { expect( view.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver ); expect( view.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver ); expect( view.getObserver( FakeSelectionObserver ) ).to.be.instanceof( FakeSelectionObserver ); + expect( view.getObserver( CompositionObserver ) ).to.be.instanceof( CompositionObserver ); } ); describe( 'attachDomRoot()', () => { @@ -368,6 +370,18 @@ describe( 'view', () => { } ); } ); + describe( 'isComposing', () => { + it( 'should change renderer.isComposing too', () => { + expect( viewDocument.isComposing ).to.equal( false ); + expect( view._renderer.isComposing ).to.equal( false ); + + viewDocument.isComposing = true; + + expect( viewDocument.isComposing ).to.equal( true ); + expect( view._renderer.isComposing ).to.equal( true ); + } ); + } ); + describe( 'render()', () => { it( 'disable observers, renders and enable observers', () => { const observerMock = view.addObserver( ObserverMock ); From e2cfe1ff186d2c941a8e8e563c85ef4e1e0b6cbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Krzto=C5=84?= Date: Wed, 28 Feb 2018 16:09:08 +0100 Subject: [PATCH 659/724] Tests: composition observer manual test. --- tests/view/manual/compositionobserver.html | 3 +++ tests/view/manual/compositionobserver.js | 30 ++++++++++++++++++++++ tests/view/manual/compositionobserver.md | 10 ++++++++ 3 files changed, 43 insertions(+) create mode 100644 tests/view/manual/compositionobserver.html create mode 100644 tests/view/manual/compositionobserver.js create mode 100644 tests/view/manual/compositionobserver.md diff --git a/tests/view/manual/compositionobserver.html b/tests/view/manual/compositionobserver.html new file mode 100644 index 000000000..295deed50 --- /dev/null +++ b/tests/view/manual/compositionobserver.html @@ -0,0 +1,3 @@ +
+

foo bar

+
diff --git a/tests/view/manual/compositionobserver.js b/tests/view/manual/compositionobserver.js new file mode 100644 index 000000000..d4a8392f6 --- /dev/null +++ b/tests/view/manual/compositionobserver.js @@ -0,0 +1,30 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/* globals console, window, document */ + +import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor'; +import Typing from '@ckeditor/ckeditor5-typing/src/typing'; +import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; + +ClassicEditor + .create( document.querySelector( '#editor' ), { + plugins: [ Typing, Paragraph ] + } ) + .then( editor => { + window.editor = editor; + + const view = editor.editing.view; + const viewDocument = view.document; + + viewDocument.on( 'compositionstart', ( evt, data ) => console.log( 'compositionstart', data ) ); + viewDocument.on( 'compositionupdate', ( evt, data ) => console.log( 'compositionupdate', data ) ); + viewDocument.on( 'compositionend', ( evt, data ) => console.log( 'compositionend', data ) ); + + view.focus(); + } ) + .catch( err => { + console.error( err.stack ); + } ); diff --git a/tests/view/manual/compositionobserver.md b/tests/view/manual/compositionobserver.md new file mode 100644 index 000000000..d048dd37f --- /dev/null +++ b/tests/view/manual/compositionobserver.md @@ -0,0 +1,10 @@ +* Expected initialization: `{}foo bar`. +* Check whether composition events are logged to the console with proper data: + * `compositionstart`, + * `compositionupdate`, + * `compositionend` + +**Composition events are fired while typing:** +* Hiragana, +* Spanish-ISO: accent `' + a`, +* MacOS: long `a` press (accent balloon) From 96c6a6cc1c40101cd2cdfda854bbe217641dfc6a Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 19 Feb 2018 13:41:09 +0100 Subject: [PATCH 660/724] Changed `ModelSelection#setTo` API. --- src/model/selection.js | 60 +++++++++++++++++++++++++++++++--------- tests/model/selection.js | 55 ++++++++++++++++++------------------ 2 files changed, 74 insertions(+), 41 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 32540dcc6..41bd2e944 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -9,6 +9,7 @@ import Position from './position'; import Element from './element'; +import Node from './node'; import Range from './range'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; @@ -61,10 +62,13 @@ export default class Selection { * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/element~Element| - * Iterable.|module:engine/model/range~Range} [selectable] - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * Iterable.|module:engine/model/range~Range|null} selectable + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - constructor( selectable, backwardSelectionOrOffset ) { + constructor( selectable, optionsOrPlaceOrOffset, options ) { /** * Specifies whether the last added range was added as a backward or forward range. * @@ -90,7 +94,7 @@ export default class Selection { this._attrs = new Map(); if ( selectable ) { - this.setTo( selectable, backwardSelectionOrOffset ); + this.setTo( selectable, optionsOrPlaceOrOffset, options ); } } @@ -322,36 +326,66 @@ export default class Selection { * const position = new Position( root, path ); * selection.setTo( position ); * - * // Sets range at the position of given element and optional offset. + * // Sets range at the position of given node and offset. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, offset ); * + * // Sets range inside the node. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'in' ); + * + * // Sets range on the node. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'on' ); + * * // Removes all ranges. * selection.setTo( null ); * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| - * module:engine/model/position~Position|module:engine/model/element~Element| + * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - setTo( selectable, backwardSelectionOrOffset ) { + setTo( selectable, optionsOrPlaceOrOffset, options ) { if ( selectable === null ) { this._setRanges( [] ); } else if ( selectable instanceof Selection ) { this._setRanges( selectable.getRanges(), selectable.isBackward ); - } else if ( selectable && selectable._selection instanceof Selection ) { + } else if ( selectable && typeof selectable.getRanges == 'function' ) { // We assume that the selectable is a DocumentSelection. // It can't be imported here, because it would lead to circular imports. this._setRanges( selectable.getRanges(), selectable.isBackward ); } else if ( selectable instanceof Range ) { - this._setRanges( [ selectable ], backwardSelectionOrOffset ); + this._setRanges( [ selectable ], !!optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); } else if ( selectable instanceof Position ) { this._setRanges( [ new Range( selectable ) ] ); - } else if ( selectable instanceof Element ) { - this._setRanges( [ Range.createCollapsedAt( selectable, backwardSelectionOrOffset ) ] ); + } else if ( selectable instanceof Node ) { + const backward = !!options && !!options.backward; + let range; + + if ( optionsOrPlaceOrOffset == 'in' ) { + range = Range.createIn( selectable ); + } else if ( optionsOrPlaceOrOffset == 'on' ) { + range = Range.createOn( selectable ); + } else if ( optionsOrPlaceOrOffset !== undefined ) { + range = Range.createCollapsedAt( selectable, optionsOrPlaceOrOffset ); + } else { + /** + * Required second parameter when setting selection to node. + * + * @error + */ + throw new CKEditorError( + 'model-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' ); + } + + this._setRanges( [ range ], backward ); } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. - this._setRanges( selectable, backwardSelectionOrOffset ); + this._setRanges( selectable, optionsOrPlaceOrOffset ); } else { /** * Cannot set selection to given place. diff --git a/tests/model/selection.js b/tests/model/selection.js index 74b9370d2..bc5f11845 100644 --- a/tests/model/selection.js +++ b/tests/model/selection.js @@ -64,7 +64,7 @@ describe( 'Selection', () => { } ); it( 'should be able to create a selection from the given range and isLastBackward flag', () => { - const selection = new Selection( range1, true ); + const selection = new Selection( range1, { backward: true } ); expect( selection.isBackward ).to.be.true; expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1 ] ); @@ -72,7 +72,7 @@ describe( 'Selection', () => { it( 'should be able to create a selection from the given ranges and isLastBackward flag', () => { const ranges = new Set( [ range1, range2, range3 ] ); - const selection = new Selection( ranges, true ); + const selection = new Selection( ranges, { backward: true } ); expect( selection.isBackward ).to.be.true; expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2, range3 ] ); @@ -80,7 +80,7 @@ describe( 'Selection', () => { it( 'should be able to create a selection from the other selection', () => { const ranges = [ range1, range2, range3 ]; - const otherSelection = new Selection( ranges, true ); + const otherSelection = new Selection( ranges, { backward: true } ); const selection = new Selection( otherSelection ); expect( selection.isBackward ).to.be.true; @@ -88,7 +88,7 @@ describe( 'Selection', () => { } ); it( 'should be able to create a selection at the start position of an item', () => { - const selection = new Selection( root ); + const selection = new Selection( root, 0 ); const focus = selection.focus; expect( selection ).to.have.property( 'isCollapsed', true ); @@ -173,7 +173,7 @@ describe( 'Selection', () => { describe( 'isBackward', () => { it( 'is defined by the last added range', () => { - selection.setTo( [ range ], true ); + selection.setTo( [ range ], { backward: true } ); expect( selection ).to.have.property( 'isBackward', true ); selection.setTo( liveRange ); @@ -183,7 +183,7 @@ describe( 'Selection', () => { it( 'is false when last range is collapsed', () => { const pos = Position.createAt( root, 0 ); - selection.setTo( [ new Range( pos, pos ) ], true ); + selection.setTo( pos ); expect( selection.isBackward ).to.be.false; } ); @@ -206,7 +206,7 @@ describe( 'Selection', () => { } ); it( 'should return correct focus when last added range is backward one', () => { - selection.setTo( [ r1, r2, r3 ], true ); + selection.setTo( [ r1, r2, r3 ], { backward: true } ); expect( selection.focus.isEqual( r3.start ) ).to.be.true; } ); @@ -221,7 +221,7 @@ describe( 'Selection', () => { it( 'should set selection to be same as given selection, using _setRanges method', () => { const spy = sinon.spy( selection, '_setRanges' ); - const otherSelection = new Selection( [ range1, range2 ], true ); + const otherSelection = new Selection( [ range1, range2 ], { backward: true } ); selection.setTo( otherSelection ); @@ -291,10 +291,10 @@ describe( 'Selection', () => { } ).to.throw( /model-selection-setTo-not-selectable/ ); } ); - it( 'should allow setting selection inside an element', () => { + it( 'should allow setting selection inside the element', () => { const element = new Element( 'p', null, [ new Text( 'foo' ), new Text( 'bar' ) ] ); - selection.setTo( Range.createIn( element ) ); + selection.setTo( element, 'in' ); const ranges = Array.from( selection.getRanges() ); expect( ranges.length ).to.equal( 1 ); @@ -304,13 +304,13 @@ describe( 'Selection', () => { expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); } ); - it( 'should allow setting selection on an item', () => { + it( 'should allow setting selection on the item', () => { const textNode1 = new Text( 'foo' ); const textNode2 = new Text( 'bar' ); const textNode3 = new Text( 'baz' ); const element = new Element( 'p', null, [ textNode1, textNode2, textNode3 ] ); - selection.setTo( Range.createOn( textNode2 ) ); + selection.setTo( textNode2, 'on' ); const ranges = Array.from( selection.getRanges() ); expect( ranges.length ).to.equal( 1 ); @@ -320,25 +320,24 @@ describe( 'Selection', () => { expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); } ); + // TODO - backward + // TODO - throwing + describe( 'setting selection to position or item', () => { it( 'should fire change:range', () => { const spy = sinon.spy(); selection.on( 'change:range', spy ); - selection.setTo( root ); + selection.setTo( root, 0 ); expect( spy.calledOnce ).to.be.true; } ); - it( 'should set selection at the 0 offset if second parameter not passed', () => { - selection.setTo( root ); - - expect( selection ).to.have.property( 'isCollapsed', true ); - - const focus = selection.focus; - expect( focus ).to.have.property( 'parent', root ); - expect( focus ).to.have.property( 'offset', 0 ); + it( 'should throw if second parameter is not passed', () => { + expect( () => { + selection.setTo( root ); + } ).to.throw( CKEditorError, /model-selection-setTo-required-second-parameter/ ); } ); it( 'should set selection at given offset in given parent', () => { @@ -484,7 +483,7 @@ describe( 'Selection', () => { const endPos = Position.createAt( root, 2 ); const newEndPos = Position.createAt( root, 3 ); - selection.setTo( new Range( startPos, endPos ), true ); + selection.setTo( new Range( startPos, endPos ), { backward: true } ); selection.setFocus( newEndPos ); @@ -498,7 +497,7 @@ describe( 'Selection', () => { const endPos = Position.createAt( root, 2 ); const newEndPos = Position.createAt( root, 0 ); - selection.setTo( new Range( startPos, endPos ), true ); + selection.setTo( new Range( startPos, endPos ), { backward: true } ); selection.setFocus( newEndPos ); @@ -634,7 +633,7 @@ describe( 'Selection', () => { } ); it( 'should acknowledge backward flag when setting anchor and focus', () => { - selection._setRanges( newRanges, true ); + selection._setRanges( newRanges, { backward: true } ); expect( selection.anchor.path ).to.deep.equal( [ 6, 0 ] ); expect( selection.focus.path ).to.deep.equal( [ 5, 0 ] ); } ); @@ -677,7 +676,7 @@ describe( 'Selection', () => { } ); it( 'should set anchor and focus to the end and start of the most recently added range if backward flag was used', () => { - selection._setRanges( [ liveRange, range ], true ); + selection._setRanges( [ liveRange, range ], { backward: true } ); expect( selection.anchor.path ).to.deep.equal( [ 2 ] ); expect( selection.focus.path ).to.deep.equal( [ 2, 2 ] ); @@ -766,9 +765,9 @@ describe( 'Selection', () => { } ); it( 'should return true if backward selections equal', () => { - selection.setTo( [ range1 ], true ); + selection.setTo( [ range1 ], { backward: true } ); - const otherSelection = new Selection( [ range1 ], true ); + const otherSelection = new Selection( [ range1 ], { backward: true } ); expect( selection.isEqual( otherSelection ) ).to.be.true; } ); @@ -798,7 +797,7 @@ describe( 'Selection', () => { it( 'should return false if directions do not equal', () => { selection.setTo( range1 ); - const otherSelection = new Selection( [ range1 ], true ); + const otherSelection = new Selection( [ range1 ], { backward: true } ); expect( selection.isEqual( otherSelection ) ).to.be.false; } ); From efac98c9cdbe4669e9d1640cb1faab659a874ed3 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 19 Feb 2018 14:08:29 +0100 Subject: [PATCH 661/724] Changed DocumentSelection#setTo API. --- src/model/documentselection.js | 13 ++++++++----- tests/model/documentselection.js | 2 +- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 58fc7447b..08c757d42 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -348,19 +348,22 @@ export default class DocumentSelection { /** * Sets this selection's ranges and direction to the specified location based on the given * {@link module:engine/model/selection~Selection selection}, {@link module:engine/model/position~Position position}, - * {@link module:engine/model/element~Element element}, {@link module:engine/model/position~Position position}, + * {@link module:engine/model/element~Node node}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * Should be used only within the {@link module:engine/model/writer~Writer#setSelection} method. * * @see module:engine/model/writer~Writer#setSelection * @protected * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| - * module:engine/model/position~Position|module:engine/model/element~Element| + * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - _setTo( selectable, backwardSelectionOrOffset ) { - this._selection.setTo( selectable, backwardSelectionOrOffset ); + _setTo( selectable, optionsOrPlaceOrOffset, options ) { + this._selection.setTo( selectable, optionsOrPlaceOrOffset, options ); } /** diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 11f3bef20..5e3fea79d 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -250,7 +250,7 @@ describe( 'DocumentSelection', () => { selection._setTo( [ range, liveRange ] ); const spy = testUtils.sinon.spy( LiveRange.prototype, 'detach' ); - selection._setTo( root ); + selection._setTo( root, 0 ); expect( spy.calledTwice ).to.be.true; } ); From 4edd43e41ce381e60eef3fa8ac6a03f3bc85fd22 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 19 Feb 2018 15:54:46 +0100 Subject: [PATCH 662/724] Aligned code to changes in ModelSelection#setTo method. --- .../downcast-selection-converters.js | 2 +- src/conversion/upcast-selection-converters.js | 2 +- src/dev-utils/model.js | 4 +-- src/model/documentselection.js | 4 +-- src/model/selection.js | 10 +++---- src/model/utils/deletecontent.js | 4 +-- src/model/utils/modifyselection.js | 1 + src/model/writer.js | 27 +++++++++++++------ .../downcast-selection-converters.js | 2 +- tests/dev-utils/model.js | 6 ++--- tests/model/model.js | 2 ++ tests/model/selection.js | 17 ++++++++++++ tests/model/writer.js | 8 +++--- 13 files changed, 60 insertions(+), 29 deletions(-) diff --git a/src/conversion/downcast-selection-converters.js b/src/conversion/downcast-selection-converters.js index 3559a4a7d..f1824d3ff 100644 --- a/src/conversion/downcast-selection-converters.js +++ b/src/conversion/downcast-selection-converters.js @@ -39,7 +39,7 @@ export function convertRangeSelection() { viewRanges.push( viewRange ); } - conversionApi.writer.setSelection( viewRanges, selection.isBackward ); + conversionApi.writer.setSelection( viewRanges, { backward: selection.isBackward } ); }; } diff --git a/src/conversion/upcast-selection-converters.js b/src/conversion/upcast-selection-converters.js index 5b810694c..3660e6fb5 100644 --- a/src/conversion/upcast-selection-converters.js +++ b/src/conversion/upcast-selection-converters.js @@ -37,7 +37,7 @@ export function convertSelectionChange( model, mapper ) { ranges.push( mapper.toModelRange( viewRange ) ); } - modelSelection.setTo( ranges, viewSelection.isBackward ); + modelSelection.setTo( ranges, { backward: viewSelection.isBackward } ); if ( !modelSelection.isEqual( model.document.selection ) ) { model.change( writer => { diff --git a/src/dev-utils/model.js b/src/dev-utils/model.js index fdaa68c2a..1747613ce 100644 --- a/src/dev-utils/model.js +++ b/src/dev-utils/model.js @@ -131,7 +131,7 @@ export function setData( model, data, options = {} ) { ranges.push( new ModelRange( start, end ) ); } - writer.setSelection( ranges, selection.isBackward ); + writer.setSelection( ranges, { backward: selection.isBackward } ); if ( options.selectionAttributes ) { writer.setSelectionAttribute( selection.getAttributes() ); @@ -326,7 +326,7 @@ export function parse( data, schema, options = {} ) { } // Create new selection. - selection = new ModelSelection( ranges, viewSelection.isBackward ); + selection = new ModelSelection( ranges, { backward: viewSelection.isBackward } ); // Set attributes to selection if specified. for ( const [ key, value ] of toMap( options.selectionAttributes || [] ) ) { diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 08c757d42..3740c9be4 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -634,8 +634,8 @@ class LiveSelection extends Selection { return super.getLastRange() || this._document._getDefaultRange(); } - setTo( selectable, backwardSelectionOrOffset ) { - super.setTo( selectable, backwardSelectionOrOffset ); + setTo( selectable, optionsOrPlaceOrOffset, options ) { + super.setTo( selectable, optionsOrPlaceOrOffset, options ); this._refreshAttributes(); } diff --git a/src/model/selection.js b/src/model/selection.js index 41bd2e944..08fc65626 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -36,11 +36,11 @@ export default class Selection { * * // Creates selection at the given range. * const range = new Range( start, end ); - * const selection = new Selection( range, isBackwardSelection ); + * const selection = new Selection( range, { backward } ); * * // Creates selection at the given ranges * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * const selection = new Selection( ranges, isBackwardSelection ); + * const selection = new Selection( ranges, { backward } ); * * // Creates selection from the other selection. * // Note: It doesn't copies selection attributes. @@ -306,11 +306,11 @@ export default class Selection { * * // Sets ranges from the given range. * const range = new Range( start, end ); - * selection.setTo( range, isBackwardSelection ); + * selection.setTo( range, { backward } ); * * // Sets ranges from the iterable of ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * selection.setTo( ranges, isBackwardSelection ); + * selection.setTo( ranges, { backward } ); * * // Sets ranges from the other selection. * // Note: It doesn't copies selection attributes. @@ -385,7 +385,7 @@ export default class Selection { this._setRanges( [ range ], backward ); } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. - this._setRanges( selectable, optionsOrPlaceOrOffset ); + this._setRanges( selectable, optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); } else { /** * Cannot set selection to given place. diff --git a/src/model/utils/deletecontent.js b/src/model/utils/deletecontent.js index 5b2f83f89..aadfc5297 100644 --- a/src/model/utils/deletecontent.js +++ b/src/model/utils/deletecontent.js @@ -194,9 +194,9 @@ function insertParagraph( writer, position, selection ) { writer.insert( paragraph, position ); if ( selection instanceof DocumentSelection ) { - writer.setSelection( paragraph ); + writer.setSelection( paragraph, 0 ); } else { - selection.setTo( paragraph ); + selection.setTo( paragraph, 0 ); } } diff --git a/src/model/utils/modifyselection.js b/src/model/utils/modifyselection.js index 485a0f35a..9bd3ba426 100644 --- a/src/model/utils/modifyselection.js +++ b/src/model/utils/modifyselection.js @@ -50,6 +50,7 @@ export default function modifySelection( model, selection, options = {} ) { const unit = options.unit ? options.unit : 'character'; const focus = selection.focus; + const walker = new TreeWalker( { boundaries: getSearchRange( focus, isForward ), singleCharacters: true, diff --git a/src/model/writer.js b/src/model/writer.js index 4df67ba58..68cefa449 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -902,16 +902,16 @@ export default class Writer { /** * Sets this selection's ranges and direction to the specified location based on the given * {@link module:engine/model/selection~Selection selection}, {@link module:engine/model/position~Position position}, - * {@link module:engine/model/element~Element element}, {@link module:engine/model/position~Position position}, + * {@link module:engine/model/element~Node node}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * * // Sets ranges from the given range. * const range = new Range( start, end ); - * writer.setSelection( range, isBackwardSelection ); + * writer.setSelection( range, { backward } ); * * // Sets ranges from the iterable of ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * writer.setSelection( range, isBackwardSelection ); + * writer.setSelection( range, { backward } ); * * // Sets ranges from the other selection. * const otherSelection = new Selection(); @@ -925,24 +925,35 @@ export default class Writer { * const position = new Position( root, path ); * writer.setSelection( position ); * - * // Sets collapsed range at the given offset in element. + * // Sets range at the position of given node and offset. * const paragraph = writer.createElement( 'paragraph' ); * writer.setSelection( paragraph, offset ); * + * // Sets range inside the node. + * const paragraph = writer.createElement( 'paragraph', { backward } ); + * writer.setSelection( paragraph, 'in' ); + * + * // Sets range on the node. + * const paragraph = writer.createElement( 'paragraph', { backward } ); + * writer.setSelection( paragraph, 'on' ); + * * // Removes all ranges. * writer.setSelection( null ); * * Throws `writer-incorrect-use` error when the writer is used outside the `change()` block. * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| - * module:engine/model/position~Position|module:engine/model/element~Element| + * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - setSelection( selectable, backwardSelectionOrOffset ) { + setSelection( selectable, optionsOrPlaceOrOffset, options ) { this._assertWriterUsedCorrectly(); - this.model.document.selection._setTo( selectable, backwardSelectionOrOffset ); + this.model.document.selection._setTo( selectable, optionsOrPlaceOrOffset, options ); } /** diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index b2851d336..a5aa3b478 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -574,7 +574,7 @@ describe( 'downcast-selection-converters', () => { const isBackward = selectionPaths[ 2 ] === 'backward'; model.change( writer => { - writer.setSelection( new ModelRange( startPos, endPos ), isBackward ); + writer.setSelection( new ModelRange( startPos, endPos ), { backward: isBackward } ); // And add or remove passed attributes. for ( const key in selectionAttributes ) { diff --git a/tests/dev-utils/model.js b/tests/dev-utils/model.js index a9894e742..768702c5d 100644 --- a/tests/dev-utils/model.js +++ b/tests/dev-utils/model.js @@ -283,7 +283,7 @@ describe( 'model test utils', () => { it( 'writes selection in an empty root', () => { const root = document.createRoot( '$root', 'empty' ); model.change( writer => { - writer.setSelection( root ); + writer.setSelection( root, 0 ); } ); expect( stringify( root, selection ) ).to.equal( @@ -293,7 +293,7 @@ describe( 'model test utils', () => { it( 'writes selection collapsed in an element', () => { model.change( writer => { - writer.setSelection( root ); + writer.setSelection( root, 0 ); } ); expect( stringify( root, selection ) ).to.equal( @@ -386,7 +386,7 @@ describe( 'model test utils', () => { it( 'writes selection when is backward', () => { model.change( writer => { - writer.setSelection( Range.createFromParentsAndOffsets( elA, 0, elB, 0 ), true ); + writer.setSelection( Range.createFromParentsAndOffsets( elA, 0, elB, 0 ), { backward: true } ); } ); expect( stringify( root, selection ) ).to.equal( diff --git a/tests/model/model.js b/tests/model/model.js index 03359a31c..3e4a0d1cd 100644 --- a/tests/model/model.js +++ b/tests/model/model.js @@ -476,6 +476,8 @@ describe( 'Model', () => { setData( model, 'fo[ob]ar' ); + expect( getData( model ) ).to.equal( 'fo[ob]ar' ); + model.modifySelection( model.document.selection, { direction: 'backward' } ); expect( getData( model ) ).to.equal( 'fo[o]bar' ); diff --git a/tests/model/selection.js b/tests/model/selection.js index bc5f11845..973102f52 100644 --- a/tests/model/selection.js +++ b/tests/model/selection.js @@ -320,6 +320,23 @@ describe( 'Selection', () => { expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); } ); + it( 'should allow setting backward inside on the item', () => { + const textNode1 = new Text( 'foo' ); + const textNode2 = new Text( 'bar' ); + const textNode3 = new Text( 'baz' ); + const element = new Element( 'p', null, [ textNode1, textNode2, textNode3 ] ); + + selection.setTo( textNode2, 'on', { backward: true } ); + + const ranges = Array.from( selection.getRanges() ); + expect( ranges.length ).to.equal( 1 ); + expect( ranges[ 0 ].start.parent ).to.equal( element ); + expect( ranges[ 0 ].start.offset ).to.deep.equal( 3 ); + expect( ranges[ 0 ].end.parent ).to.equal( element ); + expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); + expect( selection.isBackward ).to.equal( true ); + } ); + // TODO - backward // TODO - throwing diff --git a/tests/model/writer.js b/tests/model/writer.js index f2490df29..796dedf1c 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -2195,7 +2195,7 @@ describe( 'Writer', () => { const firstParagraph = root.getNodeByPath( [ 1 ] ); const setToSpy = sinon.spy( DocumentSelection.prototype, '_setTo' ); - setSelection( firstParagraph ); + setSelection( firstParagraph, 0 ); expect( setToSpy.calledOnce ).to.be.true; setToSpy.restore(); @@ -2204,7 +2204,7 @@ describe( 'Writer', () => { it( 'should change document selection ranges', () => { const range = new Range( new Position( root, [ 1 ] ), new Position( root, [ 2, 2 ] ) ); - setSelection( range, true ); + setSelection( range, { backward: true } ); expect( model.document.selection._ranges.length ).to.equal( 1 ); expect( model.document.selection._ranges[ 0 ].start.path ).to.deep.equal( [ 1 ] ); @@ -2566,9 +2566,9 @@ describe( 'Writer', () => { } ); } - function setSelection( selectable, backwardSelectionOrOffset ) { + function setSelection( selectable, optionsOrPlaceOrOffset, options ) { model.enqueueChange( batch, writer => { - writer.setSelection( selectable, backwardSelectionOrOffset ); + writer.setSelection( selectable, optionsOrPlaceOrOffset, options ); } ); } From e43de84d28e150a2e3be7dd45905f38cbc6770de Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 19 Feb 2018 17:09:20 +0100 Subject: [PATCH 663/724] Changed ViewSelection#setTo. --- src/model/selection.js | 2 +- src/view/selection.js | 73 +++++++++++++++++++++++++++++++---------- tests/view/selection.js | 40 +++++++++++++--------- 3 files changed, 81 insertions(+), 34 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 08fc65626..71603358c 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -376,7 +376,7 @@ export default class Selection { /** * Required second parameter when setting selection to node. * - * @error + * @error model-selection-setTo-required-second-parameter */ throw new CKEditorError( 'model-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' ); diff --git a/src/view/selection.js b/src/view/selection.js index 11eb78929..66f13a65a 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -12,8 +12,8 @@ import Range from './range'; import Position from './position'; import mix from '@ckeditor/ckeditor5-utils/src/mix'; import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin'; +import Node from './node'; import Element from './element'; -import Text from './text'; import count from '@ckeditor/ckeditor5-utils/src/count'; import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable'; @@ -55,15 +55,26 @@ export default class Selection { * const position = new Position( root, path ); * const selection = new Selection( position ); * - * // Creates selection at the start position of given element. + * // Sets collapsed range at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); - * const selection = new Selection( paragraph, offset ); + * selection.setTo( paragraph, offset ); * - * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| - * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item} [selectable] - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * // Sets range inside the item. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'in' ); + * + * // Sets range on the item. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'on' ); + * + * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| + * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - constructor( selectable, backwardSelectionOrOffset ) { + constructor( selectable, optionsOrPlaceOrOffset, options ) { /** * Stores all ranges that are selected. * @@ -97,7 +108,7 @@ export default class Selection { this._fakeSelectionLabel = ''; if ( selectable ) { - this._setTo( selectable, backwardSelectionOrOffset ); + this._setTo( selectable, optionsOrPlaceOrOffset, options ); } } @@ -422,19 +433,30 @@ export default class Selection { * const position = new Position( root, path ); * selection.setTo( position ); * - * // Sets collapsed range on the given item. + * // Sets collapsed range at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, offset ); * + * // Sets range inside the item. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'in' ); + * + * // Sets range on the item. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'on' ); + * * // Removes all ranges. * selection.setTo( null ); * * @protected * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - _setTo( selectable, backwardSelectionOrOffset ) { + _setTo( selectable, optionsOrPlaceOrOffset, options ) { if ( selectable === null ) { this._removeAllRanges(); } else if ( selectable instanceof Selection ) { @@ -442,16 +464,33 @@ export default class Selection { this._fakeSelectionLabel = selectable.fakeSelectionLabel; this._setRanges( selectable.getRanges(), selectable.isBackward ); } else if ( selectable instanceof Range ) { - this._setRanges( [ selectable ], backwardSelectionOrOffset ); + this._setRanges( [ selectable ], !!optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); } else if ( selectable instanceof Position ) { this._setRanges( [ new Range( selectable ) ] ); - } else if ( selectable instanceof Text ) { - this._setRanges( [ Range.createCollapsedAt( selectable, backwardSelectionOrOffset ) ] ); - } else if ( selectable instanceof Element ) { - this._setRanges( [ Range.createCollapsedAt( selectable, backwardSelectionOrOffset ) ] ); + } else if ( selectable instanceof Node ) { + const backward = !!options && !!options.backward; + let range; + + if ( optionsOrPlaceOrOffset == 'in' ) { + range = Range.createIn( selectable ); + } else if ( optionsOrPlaceOrOffset == 'on' ) { + range = Range.createOn( selectable ); + } else if ( optionsOrPlaceOrOffset !== undefined ) { + range = Range.createCollapsedAt( selectable, optionsOrPlaceOrOffset ); + } else { + /** + * Required second parameter when setting selection to node. + * + * @error view-selection-setTo-required-second-parameter + */ + throw new CKEditorError( + 'view-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' ); + } + + this._setRanges( [ range ], backward ); } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. - this._setRanges( selectable, backwardSelectionOrOffset ); + this._setRanges( selectable, optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); } else { /** * Cannot set selection to given place. diff --git a/tests/view/selection.js b/tests/view/selection.js index f3a162791..bbb3a4ee5 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -44,13 +44,13 @@ describe( 'Selection', () => { it( 'should be able to create a selection from the given ranges and isLastBackward flag', () => { const ranges = [ range1, range2, range3 ]; - const selection = new Selection( ranges, true ); + const selection = new Selection( ranges, { backward: true } ); expect( selection.isBackward ).to.be.true; } ); it( 'should be able to create a selection from the given range and isLastBackward flag', () => { - const selection = new Selection( range1, true ); + const selection = new Selection( range1, { backward: true } ); expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1 ] ); expect( selection.isBackward ).to.be.true; @@ -58,7 +58,7 @@ describe( 'Selection', () => { it( 'should be able to create a selection from the given iterable of ranges and isLastBackward flag', () => { const ranges = new Set( [ range1, range2, range3 ] ); - const selection = new Selection( ranges, false ); + const selection = new Selection( ranges, { backward: false } ); expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2, range3 ] ); expect( selection.isBackward ).to.be.false; @@ -85,7 +85,7 @@ describe( 'Selection', () => { } ); it( 'should be able to create a selection from the other selection', () => { - const otherSelection = new Selection( [ range2, range3 ], true ); + const otherSelection = new Selection( [ range2, range3 ], { backward: true } ); const selection = new Selection( otherSelection ); expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range2, range3 ] ); @@ -140,7 +140,7 @@ describe( 'Selection', () => { } ); it( 'should return end of single range in selection when added as backward', () => { - selection._setTo( range1, true ); + selection._setTo( range1, { backward: true } ); const anchor = selection.anchor; expect( anchor.isEqual( range1.end ) ).to.be.true; @@ -167,7 +167,7 @@ describe( 'Selection', () => { } ); it( 'should return start of single range in selection when added as backward', () => { - selection._setTo( range1, true ); + selection._setTo( range1, { backward: true } ); const focus = selection.focus; expect( focus.isEqual( range1.start ) ).to.be.true; @@ -254,7 +254,7 @@ describe( 'Selection', () => { const endPos = Position.createAt( el, 2 ); const newEndPos = Position.createAt( el, 3 ); - selection._setTo( new Range( startPos, endPos ), true ); + selection._setTo( new Range( startPos, endPos ), { backward: true } ); selection._setFocus( newEndPos ); @@ -268,7 +268,7 @@ describe( 'Selection', () => { const endPos = Position.createAt( el, 2 ); const newEndPos = Position.createAt( el, 0 ); - selection._setTo( new Range( startPos, endPos ), true ); + selection._setTo( new Range( startPos, endPos ), { backward: true } ); selection._setFocus( newEndPos ); @@ -376,7 +376,7 @@ describe( 'Selection', () => { const range1 = Range.createFromParentsAndOffsets( el, 5, el, 10 ); const range2 = Range.createFromParentsAndOffsets( el, 15, el, 16 ); - selection._setTo( range1, true ); + selection._setTo( range1, { backward: true } ); expect( selection ).to.have.property( 'isBackward', true ); selection._setTo( [ range1, range2 ] ); @@ -386,7 +386,7 @@ describe( 'Selection', () => { it( 'is false when last range is collapsed', () => { const range = Range.createFromParentsAndOffsets( el, 5, el, 5 ); - selection._setTo( range, true ); + selection._setTo( range, { backward: true } ); expect( selection.isBackward ).to.be.false; } ); @@ -478,9 +478,9 @@ describe( 'Selection', () => { } ); it( 'should return true if backward selections equal', () => { - selection._setTo( range1, true ); + selection._setTo( range1, { backward: true } ); - const otherSelection = new Selection( [ range1 ], true ); + const otherSelection = new Selection( [ range1 ], { backward: true } ); expect( selection.isEqual( otherSelection ) ).to.be.true; } ); @@ -504,7 +504,7 @@ describe( 'Selection', () => { it( 'should return false if directions do not equal', () => { selection._setTo( range1 ); - const otherSelection = new Selection( [ range1 ], true ); + const otherSelection = new Selection( [ range1 ], { backward: true } ); expect( selection.isEqual( otherSelection ) ).to.be.false; } ); @@ -569,7 +569,7 @@ describe( 'Selection', () => { it( 'should return false if directions are not equal', () => { selection._setTo( range1 ); - const otherSelection = new Selection( [ range1 ], true ); + const otherSelection = new Selection( [ range1 ], { backward: true } ); expect( selection.isSimilar( otherSelection ) ).to.be.false; } ); @@ -646,7 +646,7 @@ describe( 'Selection', () => { it( 'should set selection ranges from the given selection', () => { selection._setTo( range1 ); - const otherSelection = new Selection( [ range2, range3 ], true ); + const otherSelection = new Selection( [ range2, range3 ], { backward: true } ); selection._setTo( otherSelection ); @@ -753,7 +753,7 @@ describe( 'Selection', () => { const foo = new Text( 'foo' ); const p = new Element( 'p', null, foo ); - selection._setTo( foo ); + selection._setTo( foo, 0 ); let range = selection.getFirstRange(); expect( range.start.parent ).to.equal( foo ); @@ -768,6 +768,14 @@ describe( 'Selection', () => { expect( range.start.isEqual( range.end ) ).to.be.true; } ); + it( 'should throw an error when the second parameter is not passed and first is an item', () => { + const foo = new Text( 'foo' ); + + expect( () => { + selection._setTo( foo ); + } ).to.throw( CKEditorError, /view-selection-setTo-required-second-parameter/ ); + } ); + it( 'should collapse selection at node and flag', () => { const foo = new Text( 'foo' ); const p = new Element( 'p', null, foo ); From 92b4f43adcdedc11e7466d3a2560668b7e122af5 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 19 Feb 2018 17:32:42 +0100 Subject: [PATCH 664/724] Aligned code to changes in ViewSelection#setTo method. --- src/dev-utils/view.js | 2 +- src/view/domconverter.js | 2 +- src/view/observer/mutationobserver.js | 3 +-- src/view/selection.js | 8 +++---- src/view/writer.js | 23 ++++++++++++++----- .../conversion/upcast-selection-converters.js | 2 +- tests/view/domconverter/binding.js | 5 ++-- tests/view/domconverter/dom-to-view.js | 5 ++-- tests/view/writer/writer.js | 4 ++-- 9 files changed, 31 insertions(+), 23 deletions(-) diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index bb20f74b4..42434c9f9 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -340,7 +340,7 @@ export function parse( data, options = {} ) { // When ranges are present - return object containing view, and selection. if ( ranges.length ) { - const selection = new Selection( ranges, !!options.lastRangeBackward ); + const selection = new Selection( ranges, { backward: !!options.lastRangeBackward } ); return { view, diff --git a/src/view/domconverter.js b/src/view/domconverter.js index 0d20baf50..f6d09e882 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -486,7 +486,7 @@ export default class DomConverter { } } - return new ViewSelection( viewRanges, isBackward ); + return new ViewSelection( viewRanges, { backward: isBackward } ); } /** diff --git a/src/view/observer/mutationobserver.js b/src/view/observer/mutationobserver.js index aa8e1a37e..620acc7a0 100644 --- a/src/view/observer/mutationobserver.js +++ b/src/view/observer/mutationobserver.js @@ -239,8 +239,7 @@ export default class MutationObserver extends Observer { // Anchor and focus has to be properly mapped to view. if ( viewSelectionAnchor && viewSelectionFocus ) { - viewSelection = new ViewSelection(); - viewSelection._setTo( viewSelectionAnchor ); + viewSelection = new ViewSelection( viewSelectionAnchor ); viewSelection._setFocus( viewSelectionFocus ); } } diff --git a/src/view/selection.js b/src/view/selection.js index 66f13a65a..f597b13ee 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -41,11 +41,11 @@ export default class Selection { * * // Creates selection at the given range. * const range = new Range( start, end ); - * const selection = new Selection( range, isBackwardSelection ); + * const selection = new Selection( range, { backward } ); * * // Creates selection at the given ranges * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * const selection = new Selection( ranges, isBackwardSelection ); + * const selection = new Selection( ranges, { backward } ); * * // Creates selection from the other selection. * const otherSelection = new Selection(); @@ -61,11 +61,11 @@ export default class Selection { * * // Sets range inside the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in' ); + * selection.setTo( paragraph, 'in', { backward } ); * * // Sets range on the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on' ); + * selection.setTo( paragraph, 'on', { backward } ); * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable diff --git a/src/view/writer.js b/src/view/writer.js index 1b54e87c3..3a83d6df7 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -52,19 +52,30 @@ export default class Writer { * const position = new Position( root, path ); * writer.setSelection( position ); * - * // Sets collapsed range on the given item. - * const paragraph = writer.createContainerElement( 'paragraph' ); - * writer.setSelection( paragraph, offset ); + * // Sets collapsed range at the position of given item and offset. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, offset ); + * + * // Sets range inside the item. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'in' ); + * + * // Sets range on the item. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'on' ); * * // Removes all ranges. * writer.setSelection( null ); * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Boolean|Number|'before'|'end'|'after'} [backwardSelectionOrOffset] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Object} [options] + * @param {Boolean} [options.backward] */ - setSelection( selectable, backwardSelectionOrOffset ) { - this.document.selection._setTo( selectable, backwardSelectionOrOffset ); + setSelection( selectable, optionsOrPlaceOrOffset, options ) { + this.document.selection._setTo( selectable, optionsOrPlaceOrOffset, options ); } /** diff --git a/tests/conversion/upcast-selection-converters.js b/tests/conversion/upcast-selection-converters.js index 3b6d24840..8beb0bf52 100644 --- a/tests/conversion/upcast-selection-converters.js +++ b/tests/conversion/upcast-selection-converters.js @@ -104,7 +104,7 @@ describe( 'convertSelectionChange', () => { viewRoot.getChild( 0 ).getChild( 0 ), 1, viewRoot.getChild( 0 ).getChild( 0 ), 2 ), ViewRange.createFromParentsAndOffsets( viewRoot.getChild( 1 ).getChild( 0 ), 1, viewRoot.getChild( 1 ).getChild( 0 ), 2 ) - ], true ); + ], { backward: true } ); convertSelection( null, { newSelection: viewSelection } ); diff --git a/tests/view/domconverter/binding.js b/tests/view/domconverter/binding.js index c853ac3c8..568ac3cb8 100644 --- a/tests/view/domconverter/binding.js +++ b/tests/view/domconverter/binding.js @@ -7,7 +7,6 @@ import ViewElement from '../../../src/view/element'; import ViewSelection from '../../../src/view/selection'; -import ViewRange from '../../../src/view/range'; import DomConverter from '../../../src/view/domconverter'; import ViewDocumentFragment from '../../../src/view/documentfragment'; import { INLINE_FILLER } from '../../../src/view/filler'; @@ -270,7 +269,7 @@ describe( 'DomConverter', () => { beforeEach( () => { viewElement = new ViewElement(); domEl = document.createElement( 'div' ); - selection = new ViewSelection( ViewRange.createIn( viewElement ) ); + selection = new ViewSelection( viewElement, 'in' ); converter.bindFakeSelection( domEl, selection ); } ); @@ -283,7 +282,7 @@ describe( 'DomConverter', () => { it( 'should keep a copy of selection', () => { const selectionCopy = new ViewSelection( selection ); - selection._setTo( ViewRange.createIn( new ViewElement() ), true ); + selection._setTo( new ViewElement(), 'in', { backward: true } ); const bindSelection = converter.fakeSelectionToView( domEl ); expect( bindSelection ).to.not.equal( selection ); diff --git a/tests/view/domconverter/dom-to-view.js b/tests/view/domconverter/dom-to-view.js index 33be2282f..a30194787 100644 --- a/tests/view/domconverter/dom-to-view.js +++ b/tests/view/domconverter/dom-to-view.js @@ -6,7 +6,6 @@ /* globals document */ import ViewElement from '../../../src/view/element'; -import ViewRange from '../../../src/view/range'; import ViewSelection from '../../../src/view/selection'; import DomConverter from '../../../src/view/domconverter'; import ViewDocumentFragment from '../../../src/view/documentfragment'; @@ -859,7 +858,7 @@ describe( 'DomConverter', () => { domContainer.innerHTML = 'fake selection container'; document.body.appendChild( domContainer ); - const viewSelection = new ViewSelection( ViewRange.createIn( new ViewElement() ) ); + const viewSelection = new ViewSelection( new ViewElement(), 'in' ); converter.bindFakeSelection( domContainer, viewSelection ); const domRange = document.createRange(); @@ -880,7 +879,7 @@ describe( 'DomConverter', () => { domContainer.innerHTML = 'fake selection container'; document.body.appendChild( domContainer ); - const viewSelection = new ViewSelection( ViewRange.createIn( new ViewElement() ) ); + const viewSelection = new ViewSelection( new ViewElement(), 'in' ); converter.bindFakeSelection( domContainer, viewSelection ); const domRange = document.createRange(); diff --git a/tests/view/writer/writer.js b/tests/view/writer/writer.js index 834126cab..9a036e0e2 100644 --- a/tests/view/writer/writer.js +++ b/tests/view/writer/writer.js @@ -23,9 +23,9 @@ describe( 'Writer', () => { it( 'should use selection._setTo method internally', () => { const spy = sinon.spy( writer.document.selection, '_setTo' ); const position = ViewPosition.createAt( root ); - writer.setSelection( position, true ); + writer.setSelection( position ); - sinon.assert.calledWithExactly( spy, position, true ); + sinon.assert.calledWith( spy, position ); spy.restore(); } ); } ); From 8c64f5f934ab1c3b27f7f7ddc0ce700a3a860f08 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Thu, 22 Feb 2018 15:01:28 +0100 Subject: [PATCH 665/724] Added fake selection options to `Selection#setTo()`. --- src/view/selection.js | 73 ++++++++--------- tests/view/selection.js | 177 +++++++++++++++++----------------------- 2 files changed, 107 insertions(+), 143 deletions(-) diff --git a/src/view/selection.js b/src/view/selection.js index f597b13ee..b27cc8045 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -67,14 +67,14 @@ export default class Selection { * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward } ); * - * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| - * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable + * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| + * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} [selectable=null] * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] * @param {Boolean} [optionsOrPlaceOrOffset.backward] * @param {Object} [options] * @param {Boolean} [options.backward] */ - constructor( selectable, optionsOrPlaceOrOffset, options ) { + constructor( selectable = null, optionsOrPlaceOrOffset, options ) { /** * Stores all ranges that are selected. * @@ -107,15 +107,13 @@ export default class Selection { */ this._fakeSelectionLabel = ''; - if ( selectable ) { - this._setTo( selectable, optionsOrPlaceOrOffset, options ); - } + this._setTo( selectable, optionsOrPlaceOrOffset, options ); } /** * Returns true if selection instance is marked as `fake`. * - * @see #_setFake + * @see #_setTo * @returns {Boolean} */ get isFake() { @@ -125,7 +123,7 @@ export default class Selection { /** * Returns fake selection label. * - * @see #_setFake + * @see #_setTo * @returns {String} */ get fakeSelectionLabel() { @@ -399,18 +397,6 @@ export default class Selection { return ( nodeAfterStart instanceof Element && nodeAfterStart == nodeBeforeEnd ) ? nodeAfterStart : null; } - /** - * Removes all ranges that were added to the selection. - * - * @fires change - */ - _removeAllRanges() { - if ( this._ranges.length ) { - this._ranges = []; - this.fire( 'change' ); - } - } - /** * Sets this selection's ranges and direction to the specified location based on the given * {@link module:engine/view/selection~Selection selection}, {@link module:engine/view/position~Position position}, @@ -452,21 +438,27 @@ export default class Selection { * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection as backward. + * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. + * @param {String} [optionsOrPlaceOrOffset.label] Label for the fake selection. * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Boolean} [options.backward] Sets this selection as backward. + * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. + * @param {String} [options.label] Label for the fake selection. */ _setTo( selectable, optionsOrPlaceOrOffset, options ) { if ( selectable === null ) { - this._removeAllRanges(); + this._setRanges( [] ); + this._setFakeOptions( optionsOrPlaceOrOffset ); } else if ( selectable instanceof Selection ) { - this._isFake = selectable.isFake; - this._fakeSelectionLabel = selectable.fakeSelectionLabel; this._setRanges( selectable.getRanges(), selectable.isBackward ); + this._setFakeOptions( { fake: selectable.isFake, label: selectable.fakeSelectionLabel } ); } else if ( selectable instanceof Range ) { - this._setRanges( [ selectable ], !!optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); + this._setRanges( [ selectable ], optionsOrPlaceOrOffset && optionsOrPlaceOrOffset.backward ); + this._setFakeOptions( optionsOrPlaceOrOffset ); } else if ( selectable instanceof Position ) { this._setRanges( [ new Range( selectable ) ] ); + this._setFakeOptions( optionsOrPlaceOrOffset ); } else if ( selectable instanceof Node ) { const backward = !!options && !!options.backward; let range; @@ -488,9 +480,11 @@ export default class Selection { } this._setRanges( [ range ], backward ); + this._setFakeOptions( options ); } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. - this._setRanges( selectable, optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); + this._setRanges( selectable, optionsOrPlaceOrOffset && optionsOrPlaceOrOffset.backward ); + this._setFakeOptions( optionsOrPlaceOrOffset ); } else { /** * Cannot set selection to given place. @@ -499,6 +493,8 @@ export default class Selection { */ throw new CKEditorError( 'view-selection-setTo-not-selectable: Cannot set selection to given place.' ); } + + this.fire( 'change' ); } /** @@ -506,13 +502,12 @@ export default class Selection { * is treated like the last added range and is used to set {@link #anchor anchor} and {@link #focus focus}. * Accepts a flag describing in which way the selection is made. * - * @protected - * @fires change + * @private * @param {Iterable.} newRanges Iterable object of ranges to set. - * @param {Boolean} [isLastBackward] Flag describing if last added range was selected forward - from start to end + * @param {Boolean} [isLastBackward=false] Flag describing if last added range was selected forward - from start to end * (`false`) or backward - from end to start (`true`). Defaults to `false`. */ - _setRanges( newRanges, isLastBackward ) { + _setRanges( newRanges, isLastBackward = false ) { this._ranges = []; for ( const range of newRanges ) { @@ -520,7 +515,6 @@ export default class Selection { } this._lastRangeBackward = !!isLastBackward; - this.fire( 'change' ); } /** @@ -573,17 +567,14 @@ export default class Selection { * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM (and be * properly handled by screen readers). * - * @protected - * @fires change - * @param {Boolean} [value=true] If set to true selection will be marked as `fake`. - * @param {Object} [options] Additional options. + * @private + * @param {Object} [options] Options. + * @param {Boolean} [options.fake] If set to true selection will be marked as `fake`. * @param {String} [options.label=''] Fake selection label. */ - _setFake( value = true, options = {} ) { - this._isFake = value; - this._fakeSelectionLabel = value ? options.label || '' : ''; - - this.fire( 'change' ); + _setFakeOptions( options = {} ) { + this._isFake = !!options.fake; + this._fakeSelectionLabel = options.fake ? options.label || '' : ''; } /** diff --git a/tests/view/selection.js b/tests/view/selection.js index bbb3a4ee5..ca1c2ef2f 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -93,8 +93,7 @@ describe( 'Selection', () => { } ); it( 'should be able to create a fake selection from the other fake selection', () => { - const otherSelection = new Selection( [ range2, range3 ], true ); - otherSelection._setFake( true, { label: 'foo bar baz' } ); + const otherSelection = new Selection( [ range2, range3 ], { fake: true, label: 'foo bar baz' } ); const selection = new Selection( otherSelection ); expect( selection.isFake ).to.be.true; @@ -510,26 +509,21 @@ describe( 'Selection', () => { } ); it( 'should return false if one selection is fake', () => { - const otherSelection = new Selection(); - otherSelection._setFake( true ); + const otherSelection = new Selection( null, { fake: true } ); expect( selection.isEqual( otherSelection ) ).to.be.false; } ); it( 'should return true if both selection are fake', () => { - const otherSelection = new Selection( [ range1 ] ); - otherSelection._setFake( true ); - selection._setFake( true ); - selection._setTo( range1 ); + const otherSelection = new Selection( range1, { fake: true } ); + selection._setTo( range1, { fake: true } ); expect( selection.isEqual( otherSelection ) ).to.be.true; } ); it( 'should return false if both selection are fake but have different label', () => { - const otherSelection = new Selection( [ range1 ] ); - otherSelection._setFake( true, { label: 'foo bar baz' } ); - selection._setFake( true ); - selection._setTo( range1 ); + const otherSelection = new Selection( [ range1 ], { fake: true, label: 'foo bar baz' } ); + selection._setTo( range1, { fake: true, label: 'foo' } ); expect( selection.isEqual( otherSelection ) ).to.be.false; } ); @@ -609,38 +603,6 @@ describe( 'Selection', () => { } ); } ); - describe( '_setRanges()', () => { - it( 'should throw an error when range is invalid', () => { - expect( () => { - selection._setRanges( [ { invalid: 'range' } ] ); - } ).to.throw( CKEditorError, 'view-selection-invalid-range: Invalid Range.' ); - } ); - - it( 'should add ranges and fire change event', done => { - selection._setTo( range1 ); - - selection.once( 'change', () => { - expect( selection.rangeCount ).to.equal( 2 ); - expect( selection._ranges[ 0 ].isEqual( range2 ) ).to.be.true; - expect( selection._ranges[ 0 ] ).is.not.equal( range2 ); - expect( selection._ranges[ 1 ].isEqual( range3 ) ).to.be.true; - expect( selection._ranges[ 1 ] ).is.not.equal( range3 ); - done(); - } ); - - selection._setRanges( [ range2, range3 ] ); - } ); - - it( 'should throw when range is intersecting with already added range', () => { - const text = el.getChild( 0 ); - const range2 = Range.createFromParentsAndOffsets( text, 7, text, 15 ); - - expect( () => { - selection._setRanges( [ range1, range2 ] ); - } ).to.throw( CKEditorError, 'view-selection-range-intersects' ); - } ); - } ); - describe( '_setTo()', () => { describe( 'simple scenarios', () => { it( 'should set selection ranges from the given selection', () => { @@ -659,39 +621,27 @@ describe( 'Selection', () => { expect( selection.anchor.isEqual( range3.end ) ).to.be.true; } ); - it( 'should set selection on the given Range using _setRanges method', () => { - const spy = sinon.spy( selection, '_setRanges' ); - + it( 'should set selection on the given Range', () => { selection._setTo( range1 ); expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1 ] ); expect( selection.isBackward ).to.be.false; - expect( selection._setRanges.calledOnce ).to.be.true; - spy.restore(); } ); - it( 'should set selection on the given iterable of Ranges using _setRanges method', () => { - const spy = sinon.spy( selection, '_setRanges' ); - + it( 'should set selection on the given iterable of Ranges', () => { selection._setTo( new Set( [ range1, range2 ] ) ); expect( Array.from( selection.getRanges() ) ).to.deep.equal( [ range1, range2 ] ); expect( selection.isBackward ).to.be.false; - expect( selection._setRanges.calledOnce ).to.be.true; - spy.restore(); } ); - it( 'should set collapsed selection on the given Position using _setRanges method', () => { - const spy = sinon.spy( selection, '_setRanges' ); - + it( 'should set collapsed selection on the given Position', () => { selection._setTo( range1.start ); expect( Array.from( selection.getRanges() ).length ).to.equal( 1 ); expect( Array.from( selection.getRanges() )[ 0 ].start ).to.deep.equal( range1.start ); expect( selection.isBackward ).to.be.false; expect( selection.isCollapsed ).to.be.true; - expect( selection._setRanges.calledOnce ).to.be.true; - spy.restore(); } ); it( 'should fire change event', done => { @@ -707,9 +657,8 @@ describe( 'Selection', () => { } ); it( 'should set fake state and label', () => { - const otherSelection = new Selection(); const label = 'foo bar baz'; - otherSelection._setFake( true, { label } ); + const otherSelection = new Selection( null, { fake: true, label } ); selection._setTo( otherSelection ); expect( selection.isFake ).to.be.true; @@ -869,6 +818,71 @@ describe( 'Selection', () => { expect( fireSpy.notCalled ).to.be.true; } ); } ); + + describe( 'setting fake selection', () => { + it( 'should allow to set selection to fake', () => { + selection._setTo( range1, { fake: true } ); + + expect( selection.isFake ).to.be.true; + } ); + + it( 'should allow to set fake selection label', () => { + const label = 'foo bar baz'; + selection._setTo( range1, { fake: true, label } ); + + expect( selection.fakeSelectionLabel ).to.equal( label ); + } ); + + it( 'should not set label when set to false', () => { + const label = 'foo bar baz'; + selection._setTo( range1, { fake: false, label } ); + + expect( selection.fakeSelectionLabel ).to.equal( '' ); + } ); + + it( 'should reset label when set to false', () => { + const label = 'foo bar baz'; + selection._setTo( range1, { fake: true, label } ); + selection._setTo( range1 ); + + expect( selection.fakeSelectionLabel ).to.equal( '' ); + } ); + + it( 'should fire change event', done => { + selection.once( 'change', () => { + expect( selection.isFake ).to.be.true; + expect( selection.fakeSelectionLabel ).to.equal( 'foo bar baz' ); + + done(); + } ); + + selection._setTo( range1, { fake: true, label: 'foo bar baz' } ); + } ); + + it( 'should be possible to create an empty fake selection', () => { + selection._setTo( null, { fake: true, label: 'foo bar baz' } ); + + expect( selection.fakeSelectionLabel ).to.equal( 'foo bar baz' ); + expect( selection.isFake ).to.be.true; + } ); + } ); + + describe( 'throwing errors', () => { + it( 'should throw an error when range is invalid', () => { + expect( () => { + selection._setTo( [ { invalid: 'range' } ] ); + } ).to.throw( CKEditorError, 'view-selection-invalid-range: Invalid Range.' ); + } ); + + it( 'should throw when range is intersecting with already added range', () => { + const text = el.getChild( 0 ); + const range2 = Range.createFromParentsAndOffsets( text, 7, text, 15 ); + + expect( () => { + selection._setTo( [ range1, range2 ] ); + } ).to.throw( CKEditorError, 'view-selection-range-intersects' ); + } ); + } ); } ); describe( 'getEditableElement()', () => { @@ -901,47 +915,6 @@ describe( 'Selection', () => { } ); } ); - describe( '_setFake()', () => { - it( 'should allow to set selection to fake', () => { - selection._setFake( true ); - - expect( selection.isFake ).to.be.true; - } ); - - it( 'should allow to set fake selection label', () => { - const label = 'foo bar baz'; - selection._setFake( true, { label } ); - - expect( selection.fakeSelectionLabel ).to.equal( label ); - } ); - - it( 'should not set label when set to false', () => { - const label = 'foo bar baz'; - selection._setFake( false, { label } ); - - expect( selection.fakeSelectionLabel ).to.equal( '' ); - } ); - - it( 'should reset label when set to false', () => { - const label = 'foo bar baz'; - selection._setFake( true, { label } ); - selection._setFake( false ); - - expect( selection.fakeSelectionLabel ).to.equal( '' ); - } ); - - it( 'should fire change event', done => { - selection.once( 'change', () => { - expect( selection.isFake ).to.be.true; - expect( selection.fakeSelectionLabel ).to.equal( 'foo bar baz' ); - - done(); - } ); - - selection._setFake( true, { label: 'foo bar baz' } ); - } ); - } ); - describe( 'getSelectedElement()', () => { it( 'should return selected element', () => { const { selection, view } = parse( 'foo [bar] baz' ); From 7c1b7b78093b5d76d2c4186a1db53f0e97cdef25 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 26 Feb 2018 14:00:05 +0100 Subject: [PATCH 666/724] Improving fake selection API. --- src/controller/editingcontroller.js | 4 +- .../downcast-selection-converters.js | 8 ---- src/view/observer/fakeselectionobserver.js | 3 +- src/view/selection.js | 41 +++++++++++-------- src/view/writer.js | 40 +++++++++--------- .../downcast-selection-converters.js | 8 ++-- tests/view/manual/fakeselection.js | 3 +- tests/view/observer/fakeselectionobserver.js | 9 ++-- tests/view/writer/writer.js | 37 ++++++++--------- 9 files changed, 73 insertions(+), 80 deletions(-) diff --git a/src/controller/editingcontroller.js b/src/controller/editingcontroller.js index 15e7eb55a..115ede901 100644 --- a/src/controller/editingcontroller.js +++ b/src/controller/editingcontroller.js @@ -20,8 +20,7 @@ import { convertSelectionChange } from '../conversion/upcast-selection-converter import { convertRangeSelection, convertCollapsedSelection, - clearAttributes, - clearFakeSelection + clearAttributes } from '../conversion/downcast-selection-converters'; import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; @@ -95,7 +94,6 @@ export default class EditingController { // Attach default model selection converters. this.downcastDispatcher.on( 'selection', clearAttributes(), { priority: 'low' } ); - this.downcastDispatcher.on( 'selection', clearFakeSelection(), { priority: 'low' } ); this.downcastDispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } ); this.downcastDispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } ); diff --git a/src/conversion/downcast-selection-converters.js b/src/conversion/downcast-selection-converters.js index f1824d3ff..af62a517f 100644 --- a/src/conversion/downcast-selection-converters.js +++ b/src/conversion/downcast-selection-converters.js @@ -127,11 +127,3 @@ export function clearAttributes() { viewWriter.setSelection( null ); }; } - -/** - * Function factory, creates a converter that clears fake selection marking after the previous - * {@link module:engine/model/selection~Selection model selection} conversion. - */ -export function clearFakeSelection() { - return ( evt, data, conversionApi ) => conversionApi.writer.setFakeSelection( false ); -} diff --git a/src/view/observer/fakeselectionobserver.js b/src/view/observer/fakeselectionobserver.js index 4e3302617..6af205e8c 100644 --- a/src/view/observer/fakeselectionobserver.js +++ b/src/view/observer/fakeselectionobserver.js @@ -82,8 +82,7 @@ export default class FakeSelectionObserver extends Observer { */ _handleSelectionMove( keyCode ) { const selection = this.document.selection; - const newSelection = new ViewSelection( selection ); - newSelection._setFake( false ); + const newSelection = new ViewSelection( selection.getRanges(), { backward: selection.isBackward, fake: false } ); // Left or up arrow pressed - move selection to start. if ( keyCode == keyCodes.arrowleft || keyCode == keyCodes.arrowup ) { diff --git a/src/view/selection.js b/src/view/selection.js index b27cc8045..25da5fc69 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -69,10 +69,15 @@ export default class Selection { * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} [selectable=null] - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] - * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. + * Options otherwise. + * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection instance to be backward. + * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. + * @param {Boolean} [optionsOrPlaceOrOffset.label] Label for the fake selection. + * @param {Object} [options] Options when selectable is an `Item`. + * @param {Boolean} [options.backward] Sets this selection instance to be backward. + * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. + * @param {String} [options.label] Label for the fake selection. */ constructor( selectable = null, optionsOrPlaceOrOffset, options ) { /** @@ -437,12 +442,13 @@ export default class Selection { * @protected * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection as backward. + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. + * Options otherwise. + * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection instance to be backward. * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. - * @param {String} [optionsOrPlaceOrOffset.label] Label for the fake selection. - * @param {Object} [options] - * @param {Boolean} [options.backward] Sets this selection as backward. + * @param {Boolean} [optionsOrPlaceOrOffset.label] Label for the fake selection. + * @param {Object} [options] Options when selectable is an `Item`. + * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. * @param {String} [options.label] Label for the fake selection. */ @@ -463,20 +469,21 @@ export default class Selection { const backward = !!options && !!options.backward; let range; - if ( optionsOrPlaceOrOffset == 'in' ) { - range = Range.createIn( selectable ); - } else if ( optionsOrPlaceOrOffset == 'on' ) { - range = Range.createOn( selectable ); - } else if ( optionsOrPlaceOrOffset !== undefined ) { - range = Range.createCollapsedAt( selectable, optionsOrPlaceOrOffset ); - } else { + if ( optionsOrPlaceOrOffset === undefined ) { /** * Required second parameter when setting selection to node. * * @error view-selection-setTo-required-second-parameter */ throw new CKEditorError( - 'view-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' ); + 'view-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' + ); + } else if ( optionsOrPlaceOrOffset == 'in' ) { + range = Range.createIn( selectable ); + } else if ( optionsOrPlaceOrOffset == 'on' ) { + range = Range.createOn( selectable ); + } else { + range = Range.createCollapsedAt( selectable, optionsOrPlaceOrOffset ); } this._setRanges( [ range ], backward ); diff --git a/src/view/writer.js b/src/view/writer.js index 3a83d6df7..83b703e4b 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -36,6 +36,16 @@ export default class Writer { * {@link module:engine/view/item~Item item}, {@link module:engine/view/range~Range range}, * an iterable of {@link module:engine/view/range~Range ranges} or null. * + * This method provides option to create a fake selection. + * Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * represented in other way, for example by applying proper CSS class. + * + * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM (and be + * properly handled by screen readers). + * + * Usage: + * * // Sets ranges from the given range. * const range = new Range( start, end ); * writer.setSelection( range, isBackwardSelection ); @@ -69,10 +79,15 @@ export default class Writer { * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] - * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. + * Options otherwise. + * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection instance to be backward. + * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. + * @param {Boolean} [optionsOrPlaceOrOffset.label] Label for the fake selection. + * @param {Object} [options] Options when selectable is an `Item`. + * @param {Boolean} [options.backward] Sets this selection instance to be backward. + * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. + * @param {String} [options.label] Label for the fake selection. */ setSelection( selectable, optionsOrPlaceOrOffset, options ) { this.document.selection._setTo( selectable, optionsOrPlaceOrOffset, options ); @@ -91,23 +106,6 @@ export default class Writer { this.document.selection._setFocus( itemOrPosition, offset ); } - /** - * Sets {@link module:engine/view/selection~Selection selection's} to be marked as `fake`. A fake selection does - * not render as browser native selection over selected elements and is hidden to the user. - * This way, no native selection UI artifacts are displayed to the user and selection over elements can be - * represented in other way, for example by applying proper CSS class. - * - * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM (and be - * properly handled by screen readers). - * - * @param {Boolean} [value=true] If set to true selection will be marked as `fake`. - * @param {Object} [options] Additional options. - * @param {String} [options.label=''] Fake selection label. - */ - setFakeSelection( value, options ) { - this.document.selection._setFake( value, options ); - } - /** * Creates a new {@link module:engine/view/text~Text text node}. * diff --git a/tests/conversion/downcast-selection-converters.js b/tests/conversion/downcast-selection-converters.js index a5aa3b478..e92b3ff1c 100644 --- a/tests/conversion/downcast-selection-converters.js +++ b/tests/conversion/downcast-selection-converters.js @@ -17,7 +17,6 @@ import { convertRangeSelection, convertCollapsedSelection, clearAttributes, - clearFakeSelection } from '../../src/conversion/downcast-selection-converters'; import { @@ -475,14 +474,13 @@ describe( 'downcast-selection-converters', () => { const viewString = stringifyView( viewRoot, viewSelection, { showType: false } ); expect( viewString ).to.equal( '
f{}oobar
' ); } ); - } ); - describe( 'clearFakeSelection', () => { it( 'should clear fake selection', () => { - dispatcher.on( 'selection', clearFakeSelection() ); + const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 ); view.change( writer => { - writer.setFakeSelection( true ); + writer.setSelection( modelRange, { fake: true } ); + dispatcher.convertSelection( docSelection, model.markers, writer ); } ); expect( viewSelection.isFake ).to.be.false; diff --git a/tests/view/manual/fakeselection.js b/tests/view/manual/fakeselection.js index 315edddff..3e3facc18 100644 --- a/tests/view/manual/fakeselection.js +++ b/tests/view/manual/fakeselection.js @@ -41,8 +41,7 @@ viewDocument.on( 'mouseup', ( evt, data ) => { console.log( 'Making selection around the .' ); view.change( writer => { - writer.setSelection( ViewRange.createOn( viewStrong ) ); - writer.setFakeSelection( true, { label: 'fake selection over bar' } ); + writer.setSelection( ViewRange.createOn( viewStrong ), { fake: true, label: 'fake selection over bar' } ); } ); data.preventDefault(); diff --git a/tests/view/observer/fakeselectionobserver.js b/tests/view/observer/fakeselectionobserver.js index 315148e46..36cd7b758 100644 --- a/tests/view/observer/fakeselectionobserver.js +++ b/tests/view/observer/fakeselectionobserver.js @@ -33,7 +33,7 @@ describe( 'FakeSelectionObserver', () => { root = createViewRoot( viewDocument ); view.attachDomRoot( domRoot ); observer = view.getObserver( FakeSelectionObserver ); - viewDocument.selection._setFake(); + viewDocument.selection._setTo( null, { fake: true } ); } ); afterEach( () => { @@ -41,7 +41,7 @@ describe( 'FakeSelectionObserver', () => { } ); it( 'should do nothing if selection is not fake', () => { - viewDocument.selection._setFake( false ); + viewDocument.selection._setTo( null, { fake: true } ); return checkEventPrevention( keyCodes.arrowleft, false ); } ); @@ -200,7 +200,10 @@ describe( 'FakeSelectionObserver', () => { // // @param {Number} keyCode function changeFakeSelectionPressing( keyCode ) { - viewDocument.selection._setFake(); + viewDocument.selection._setTo( viewDocument.selection.getRanges(), { + backward: viewDocument.selection.isBackward, + fake: true + } ); const data = { keyCode, diff --git a/tests/view/writer/writer.js b/tests/view/writer/writer.js index 9a036e0e2..ea7ffcfb9 100644 --- a/tests/view/writer/writer.js +++ b/tests/view/writer/writer.js @@ -10,23 +10,33 @@ import ViewPosition from '../../../src/view/position'; import createViewRoot from '../_utils/createroot'; describe( 'Writer', () => { - let writer, attributes, root; + let writer, attributes, root, doc; before( () => { attributes = { foo: 'bar', baz: 'quz' }; - const document = new Document(); - root = createViewRoot( document ); - writer = new Writer( document ); + doc = new Document(); + root = createViewRoot( doc ); + writer = new Writer( doc ); } ); describe( 'setSelection()', () => { - it( 'should use selection._setTo method internally', () => { - const spy = sinon.spy( writer.document.selection, '_setTo' ); + it( 'should set document view selection', () => { const position = ViewPosition.createAt( root ); writer.setSelection( position ); - sinon.assert.calledWith( spy, position ); - spy.restore(); + const ranges = Array.from( doc.selection.getRanges() ); + + expect( ranges.length ).to.equal( 1 ); + expect( ranges[ 0 ].start.compareWith( position ) ).to.equal( 'same' ); + expect( ranges[ 0 ].end.compareWith( position ) ).to.equal( 'same' ); + } ); + + it( 'should be able to set fake selection', () => { + const position = ViewPosition.createAt( root ); + writer.setSelection( position, { fake: true, label: 'foo' } ); + + expect( doc.selection.isFake ).to.be.true; + expect( doc.selection.fakeSelectionLabel ).to.equal( 'foo' ); } ); } ); @@ -40,17 +50,6 @@ describe( 'Writer', () => { } ); } ); - describe( 'setFakeSelection()', () => { - it( 'should use selection._setFake method internally', () => { - const spy = sinon.spy( writer.document.selection, '_setFake' ); - const options = {}; - writer.setFakeSelection( true, options ); - - sinon.assert.calledWithExactly( spy, true, options ); - spy.restore(); - } ); - } ); - describe( 'createText()', () => { it( 'should create Text instance', () => { const text = writer.createText( 'foo bar' ); From 90b7c7d19d0126328fb9ec5a447629b705a2f519 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 26 Feb 2018 15:00:44 +0100 Subject: [PATCH 667/724] Fixed situation when selection is set to the same selection instance. --- src/view/selection.js | 5 ++ tests/view/observer/fakeselectionobserver.js | 2 +- tests/view/renderer.js | 27 +++++------ tests/view/selection.js | 50 ++++++++++---------- 4 files changed, 43 insertions(+), 41 deletions(-) diff --git a/src/view/selection.js b/src/view/selection.js index 25da5fc69..ac3321bdb 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -490,6 +490,7 @@ export default class Selection { this._setFakeOptions( options ); } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. + // Array.from() is used to prevent setting ranges to the old iterable this._setRanges( selectable, optionsOrPlaceOrOffset && optionsOrPlaceOrOffset.backward ); this._setFakeOptions( optionsOrPlaceOrOffset ); } else { @@ -515,6 +516,10 @@ export default class Selection { * (`false`) or backward - from end to start (`true`). Defaults to `false`. */ _setRanges( newRanges, isLastBackward = false ) { + // New ranges should be copied to prevent removing them by setting them to `[]` first. + // Only applies to situations when selection is set to the same selection or same selection's ranges. + newRanges = Array.from( newRanges ); + this._ranges = []; for ( const range of newRanges ) { diff --git a/tests/view/observer/fakeselectionobserver.js b/tests/view/observer/fakeselectionobserver.js index 36cd7b758..1c13b477d 100644 --- a/tests/view/observer/fakeselectionobserver.js +++ b/tests/view/observer/fakeselectionobserver.js @@ -41,7 +41,7 @@ describe( 'FakeSelectionObserver', () => { } ); it( 'should do nothing if selection is not fake', () => { - viewDocument.selection._setTo( null, { fake: true } ); + viewDocument.selection._setTo( null, { fake: false } ); return checkEventPrevention( keyCodes.arrowleft, false ); } ); diff --git a/tests/view/renderer.js b/tests/view/renderer.js index d5ab6a77f..5d9dd06be 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -122,7 +122,6 @@ describe( 'Renderer', () => { renderer.markedChildren.clear(); selection._setTo( null ); - selection._setFake( false ); selectionEditable = viewRoot; @@ -1369,7 +1368,7 @@ describe( 'Renderer', () => { it( 'should render fake selection', () => { const label = 'fake selection label'; - selection._setFake( true, { label } ); + selection._setTo( selection.getRanges(), { fake: true, label } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); @@ -1386,7 +1385,7 @@ describe( 'Renderer', () => { } ); it( 'should render   if no selection label is provided', () => { - selection._setFake( true ); + selection._setTo( selection.getRanges(), { fake: true } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); @@ -1402,10 +1401,10 @@ describe( 'Renderer', () => { } ); it( 'should remove fake selection container when selection is no longer fake', () => { - selection._setFake( true ); + selection._setTo( selection.getRanges(), { fake: true } ); renderer.render(); - selection._setFake( false ); + selection._setTo( selection.getRanges(), { fake: false } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 1 ); @@ -1421,14 +1420,14 @@ describe( 'Renderer', () => { it( 'should reuse fake selection container #1', () => { const label = 'fake selection label'; - selection._setFake( true, { label } ); + selection._setTo( selection.getRanges(), { fake: true, label } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); const container = domRoot.childNodes[ 1 ]; - selection._setFake( true, { label } ); + selection._setTo( selection.getRanges(), { fake: true, label } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); @@ -1442,19 +1441,19 @@ describe( 'Renderer', () => { } ); it( 'should reuse fake selection container #2', () => { - selection._setFake( true, { label: 'label 1' } ); + selection._setTo( selection.getRanges(), { fake: true, label: 'label 1' } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); const container = domRoot.childNodes[ 1 ]; - selection._setFake( false ); + selection._setTo( selection.getRanges(), { fake: false } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 1 ); - selection._setFake( true, { label: 'label 2' } ); + selection._setTo( selection.getRanges(), { fake: true, label: 'label 2' } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); @@ -1468,14 +1467,14 @@ describe( 'Renderer', () => { } ); it( 'should reuse fake selection container #3', () => { - selection._setFake( true, { label: 'label 1' } ); + selection._setTo( selection.getRanges(), { fake: true, label: 'label 1' } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); const container = domRoot.childNodes[ 1 ]; - selection._setFake( true, { label: 'label 2' } ); + selection._setTo( selection.getRanges(), { fake: true, label: 'label 2' } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); @@ -1489,7 +1488,7 @@ describe( 'Renderer', () => { } ); it( 'should style fake selection container properly', () => { - selection._setFake( true, { label: 'fake selection' } ); + selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); @@ -1502,7 +1501,7 @@ describe( 'Renderer', () => { } ); it( 'should bind fake selection container to view selection', () => { - selection._setFake( true, { label: 'fake selection' } ); + selection._setTo( selection.getRanges(), { fake: true, label: 'fake selection' } ); renderer.render(); expect( domRoot.childNodes.length ).to.equal( 2 ); diff --git a/tests/view/selection.js b/tests/view/selection.js index ca1c2ef2f..e9193801e 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -764,15 +764,6 @@ describe( 'Selection', () => { selection._setTo( selection.getFirstPosition() ); } ); - - it( 'should do nothing if no ranges present', () => { - const fireSpy = sinon.spy( selection, 'fire' ); - - selection._setTo( selection.getFirstPosition() ); - - fireSpy.restore(); - expect( fireSpy.notCalled ).to.be.true; - } ); } ); describe( 'setting collapsed selection to end', () => { @@ -787,15 +778,6 @@ describe( 'Selection', () => { selection._setTo( selection.getLastPosition() ); } ); - - it( 'should do nothing if no ranges present', () => { - const fireSpy = sinon.spy( selection, 'fire' ); - - selection._setTo( selection.getLastPosition() ); - - fireSpy.restore(); - expect( fireSpy.notCalled ).to.be.true; - } ); } ); describe( 'removing all ranges', () => { @@ -809,14 +791,6 @@ describe( 'Selection', () => { selection._setTo( null ); } ); - - it( 'should do nothing when no ranges are present', () => { - const fireSpy = sinon.spy( selection, 'fire' ); - selection._setTo( null ); - - fireSpy.restore(); - expect( fireSpy.notCalled ).to.be.true; - } ); } ); describe( 'setting fake selection', () => { @@ -867,6 +841,30 @@ describe( 'Selection', () => { } ); } ); + describe( 'setting selection to itself', () => { + it( 'should correctly set ranges when setting to the same selection', () => { + selection._setTo( [ range1, range2 ] ); + selection._setTo( selection ); + + const ranges = Array.from( selection.getRanges() ); + expect( ranges.length ).to.equal( 2 ); + + expect( ranges[ 0 ].isEqual( range1 ) ).to.be.true; + expect( ranges[ 1 ].isEqual( range2 ) ).to.be.true; + } ); + + it( 'should correctly set ranges when setting to the same selection\'s ranges', () => { + selection._setTo( [ range1, range2 ] ); + selection._setTo( selection.getRanges() ); + + const ranges = Array.from( selection.getRanges() ); + expect( ranges.length ).to.equal( 2 ); + + expect( ranges[ 0 ].isEqual( range1 ) ).to.be.true; + expect( ranges[ 1 ].isEqual( range2 ) ).to.be.true; + } ); + } ); + describe( 'throwing errors', () => { it( 'should throw an error when range is invalid', () => { expect( () => { From 859d99d7bb426458c0927f034caedc0556c14fbf Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 26 Feb 2018 15:18:56 +0100 Subject: [PATCH 668/724] Docs fixes. --- src/view/selection.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/view/selection.js b/src/view/selection.js index ac3321bdb..c4bd875fa 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -440,6 +440,7 @@ export default class Selection { * selection.setTo( null ); * * @protected + * @fires change * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. From 4d376d2f8b17e69de8906274e9b6520e5ff08d4a Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 26 Feb 2018 17:56:28 +0100 Subject: [PATCH 669/724] Improved CC. --- tests/model/selection.js | 8 ++++---- tests/view/selection.js | 43 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 4 deletions(-) diff --git a/tests/model/selection.js b/tests/model/selection.js index 973102f52..ac490ac9b 100644 --- a/tests/model/selection.js +++ b/tests/model/selection.js @@ -291,7 +291,7 @@ describe( 'Selection', () => { } ).to.throw( /model-selection-setTo-not-selectable/ ); } ); - it( 'should allow setting selection inside the element', () => { + it( 'should allow setting selection inside an element', () => { const element = new Element( 'p', null, [ new Text( 'foo' ), new Text( 'bar' ) ] ); selection.setTo( element, 'in' ); @@ -304,7 +304,7 @@ describe( 'Selection', () => { expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); } ); - it( 'should allow setting selection on the item', () => { + it( 'should allow setting selection on an item', () => { const textNode1 = new Text( 'foo' ); const textNode2 = new Text( 'bar' ); const textNode3 = new Text( 'baz' ); @@ -320,7 +320,7 @@ describe( 'Selection', () => { expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); } ); - it( 'should allow setting backward inside on the item', () => { + it( 'should allow setting backward selection on an item', () => { const textNode1 = new Text( 'foo' ); const textNode2 = new Text( 'bar' ); const textNode3 = new Text( 'baz' ); @@ -334,7 +334,7 @@ describe( 'Selection', () => { expect( ranges[ 0 ].start.offset ).to.deep.equal( 3 ); expect( ranges[ 0 ].end.parent ).to.equal( element ); expect( ranges[ 0 ].end.offset ).to.deep.equal( 6 ); - expect( selection.isBackward ).to.equal( true ); + expect( selection.isBackward ).to.be.true; } ); // TODO - backward diff --git a/tests/view/selection.js b/tests/view/selection.js index e9193801e..1cd37f9ca 100644 --- a/tests/view/selection.js +++ b/tests/view/selection.js @@ -881,6 +881,49 @@ describe( 'Selection', () => { } ).to.throw( CKEditorError, 'view-selection-range-intersects' ); } ); } ); + + it( 'should allow setting selection on an item', () => { + const textNode1 = new Text( 'foo' ); + const textNode2 = new Text( 'bar' ); + const textNode3 = new Text( 'baz' ); + const element = new Element( 'p', null, [ textNode1, textNode2, textNode3 ] ); + + selection._setTo( textNode2, 'on' ); + + const ranges = Array.from( selection.getRanges() ); + expect( ranges.length ).to.equal( 1 ); + expect( ranges[ 0 ].start.parent ).to.equal( element ); + expect( ranges[ 0 ].start.offset ).to.deep.equal( 1 ); + expect( ranges[ 0 ].end.parent ).to.equal( element ); + expect( ranges[ 0 ].end.offset ).to.deep.equal( 2 ); + } ); + + it( 'should allow setting selection inside an element', () => { + const element = new Element( 'p', null, [ new Text( 'foo' ), new Text( 'bar' ) ] ); + + selection._setTo( element, 'in' ); + + const ranges = Array.from( selection.getRanges() ); + expect( ranges.length ).to.equal( 1 ); + expect( ranges[ 0 ].start.parent ).to.equal( element ); + expect( ranges[ 0 ].start.offset ).to.deep.equal( 0 ); + expect( ranges[ 0 ].end.parent ).to.equal( element ); + expect( ranges[ 0 ].end.offset ).to.deep.equal( 2 ); + } ); + + it( 'should allow setting backward selection inside an element', () => { + const element = new Element( 'p', null, [ new Text( 'foo' ), new Text( 'bar' ) ] ); + + selection._setTo( element, 'in', { backward: true } ); + + const ranges = Array.from( selection.getRanges() ); + expect( ranges.length ).to.equal( 1 ); + expect( ranges[ 0 ].start.parent ).to.equal( element ); + expect( ranges[ 0 ].start.offset ).to.deep.equal( 0 ); + expect( ranges[ 0 ].end.parent ).to.equal( element ); + expect( ranges[ 0 ].end.offset ).to.deep.equal( 2 ); + expect( selection.isBackward ).to.be.true; + } ); } ); describe( 'getEditableElement()', () => { From d3b613b8ca5399a1057c92791030e2928fe244f6 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 28 Feb 2018 10:29:01 +0100 Subject: [PATCH 670/724] Docs fixes. --- src/model/selection.js | 61 +++++++++++++++------------ src/view/selection.js | 93 +++++++++++++++++++----------------------- 2 files changed, 77 insertions(+), 77 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 71603358c..8c73c8690 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -56,19 +56,26 @@ export default class Selection { * const position = new Position( root, path ); * const selection = new Selection( position ); * - * // Creates selection at the start position of given element. + * // Creates selection inside the node. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'in', { backward } ); + * + * // Creates selection on the node. + * const paragraph = writer.createElement( 'paragraph' ); + * selection.setTo( paragraph, 'on', { backward } ); + * + * // Creates selection at the start position of the given element. * const paragraph = writer.createElement( 'paragraph' ); * const selection = new Selection( paragraph, offset ); * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/element~Element| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] * @param {Object} [options] * @param {Boolean} [options.backward] */ - constructor( selectable, optionsOrPlaceOrOffset, options ) { + constructor( selectable, placeOrOffset, options ) { /** * Specifies whether the last added range was added as a backward or forward range. * @@ -94,7 +101,7 @@ export default class Selection { this._attrs = new Map(); if ( selectable ) { - this.setTo( selectable, optionsOrPlaceOrOffset, options ); + this.setTo( selectable, placeOrOffset, options ); } } @@ -304,52 +311,51 @@ export default class Selection { * {@link module:engine/model/element~Element element}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * - * // Sets ranges from the given range. + * // Sets selection to the given range. * const range = new Range( start, end ); * selection.setTo( range, { backward } ); * - * // Sets ranges from the iterable of ranges. + * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; * selection.setTo( ranges, { backward } ); * - * // Sets ranges from the other selection. + * // Sets selection to other selection. * // Note: It doesn't copies selection attributes. * const otherSelection = new Selection(); * selection.setTo( otherSelection ); * - * // Sets ranges from the given document selection's ranges. + * // Sets selection to the document selection. * // Note: It doesn't copies selection attributes. * const documentSelection = new DocumentSelection( doc ); * selection.setTo( documentSelection ); * - * // Sets range at the given position. + * // Sets collapsed selection at the given position. * const position = new Position( root, path ); * selection.setTo( position ); * - * // Sets range at the position of given node and offset. + * // Sets collapsed selection at the position of given node and offset. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, offset ); * - * // Sets range inside the node. + * // Sets selection inside the node. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in' ); + * selection.setTo( paragraph, 'in', { backward } ); * - * // Sets range on the node. + * // Sets selection on the node. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on' ); + * selection.setTo( paragraph, 'on', { backward } ); * - * // Removes all ranges. + * // Clears selection. Removes all ranges. * selection.setTo( null ); * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] * @param {Object} [options] * @param {Boolean} [options.backward] */ - setTo( selectable, optionsOrPlaceOrOffset, options ) { + setTo( selectable, placeOrOffset, options ) { if ( selectable === null ) { this._setRanges( [] ); } else if ( selectable instanceof Selection ) { @@ -359,33 +365,34 @@ export default class Selection { // It can't be imported here, because it would lead to circular imports. this._setRanges( selectable.getRanges(), selectable.isBackward ); } else if ( selectable instanceof Range ) { - this._setRanges( [ selectable ], !!optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); + this._setRanges( [ selectable ], !!placeOrOffset && !!placeOrOffset.backward ); } else if ( selectable instanceof Position ) { this._setRanges( [ new Range( selectable ) ] ); } else if ( selectable instanceof Node ) { const backward = !!options && !!options.backward; let range; - if ( optionsOrPlaceOrOffset == 'in' ) { + if ( placeOrOffset == 'in' ) { range = Range.createIn( selectable ); - } else if ( optionsOrPlaceOrOffset == 'on' ) { + } else if ( placeOrOffset == 'on' ) { range = Range.createOn( selectable ); - } else if ( optionsOrPlaceOrOffset !== undefined ) { - range = Range.createCollapsedAt( selectable, optionsOrPlaceOrOffset ); + } else if ( placeOrOffset !== undefined ) { + range = Range.createCollapsedAt( selectable, placeOrOffset ); } else { /** - * Required second parameter when setting selection to node. + * selection.setTo requires the second parameter when the first parameter is a node. * * @error model-selection-setTo-required-second-parameter */ throw new CKEditorError( - 'model-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' ); + 'model-selection-setTo-required-second-parameter: ' + + 'selection.setTo requires the second parameter when the first parameter is a node.' ); } this._setRanges( [ range ], backward ); } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. - this._setRanges( selectable, optionsOrPlaceOrOffset && !!optionsOrPlaceOrOffset.backward ); + this._setRanges( selectable, placeOrOffset && !!placeOrOffset.backward ); } else { /** * Cannot set selection to given place. diff --git a/src/view/selection.js b/src/view/selection.js index c4bd875fa..08bc3ca78 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -41,11 +41,11 @@ export default class Selection { * * // Creates selection at the given range. * const range = new Range( start, end ); - * const selection = new Selection( range, { backward } ); + * const selection = new Selection( range, { backward, fake, label } ); * * // Creates selection at the given ranges * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * const selection = new Selection( ranges, { backward } ); + * const selection = new Selection( ranges, { backward, fake, label } ); * * // Creates selection from the other selection. * const otherSelection = new Selection(); @@ -53,33 +53,29 @@ export default class Selection { * * // Creates selection at the given position. * const position = new Position( root, path ); - * const selection = new Selection( position ); + * const selection = new Selection( position, { fake, label } ); * - * // Sets collapsed range at the position of given item and offset. + * // Sets collapsed selection at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, offset ); + * selection.setTo( paragraph, offset, { fake, label } ); * - * // Sets range inside the item. + * // Sets selection inside the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in', { backward } ); + * selection.setTo( paragraph, 'in', { backward, fake, label } ); * - * // Sets range on the item. + * // Sets selection on the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on', { backward } ); + * selection.setTo( paragraph, 'on', { backward, fake, label } ); * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} [selectable=null] - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. - * Options otherwise. - * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection instance to be backward. - * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. - * @param {Boolean} [optionsOrPlaceOrOffset.label] Label for the fake selection. - * @param {Object} [options] Options when selectable is an `Item`. + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Offset or place when selectable is an `Item`. + * @param {Object} [options] * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. * @param {String} [options.label] Label for the fake selection. */ - constructor( selectable = null, optionsOrPlaceOrOffset, options ) { + constructor( selectable = null, placeOrOffset, options ) { /** * Stores all ranges that are selected. * @@ -112,7 +108,7 @@ export default class Selection { */ this._fakeSelectionLabel = ''; - this._setTo( selectable, optionsOrPlaceOrOffset, options ); + this._setTo( selectable, placeOrOffset, options ); } /** @@ -408,83 +404,80 @@ export default class Selection { * {@link module:engine/view/item~Item item}, {@link module:engine/view/range~Range range}, * an iterable of {@link module:engine/view/range~Range ranges} or null. * - * // Sets ranges from the given range. + * // Sets selection to the given range. * const range = new Range( start, end ); - * selection.setTo( range, isBackwardSelection ); + * selection.setTo( range, { backward, fake, label } ); * - * // Sets ranges from the iterable of ranges. + * // Sets selection to the ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * selection.setTo( range, isBackwardSelection ); + * selection.setTo( range, { backward, fake, label } ); * - * // Sets ranges from the other selection. + * // Sets selection to the other selection. * const otherSelection = new Selection(); * selection.setTo( otherSelection ); * - * // Sets collapsed range at the given position. + * // Sets collapsed selection at the given position. * const position = new Position( root, path ); - * selection.setTo( position ); + * selection.setTo( position, { fake, label } ); * - * // Sets collapsed range at the position of given item and offset. + * // Sets collapsed selection at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, offset ); + * selection.setTo( paragraph, offset, { fake, label } ); * - * // Sets range inside the item. + * // Sets selection inside the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in' ); + * selection.setTo( paragraph, 'in', { backward, fake, label } ); * - * // Sets range on the item. + * // Sets selection on the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on' ); + * selection.setTo( paragraph, 'on', { backward, fake, label } ); * - * // Removes all ranges. + * // Clears selection. Removes all ranges and options * selection.setTo( null ); * * @protected * @fires change * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. - * Options otherwise. - * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection instance to be backward. - * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. - * @param {Boolean} [optionsOrPlaceOrOffset.label] Label for the fake selection. - * @param {Object} [options] Options when selectable is an `Item`. + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Offset or place. + * @param {Object} [options] * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. * @param {String} [options.label] Label for the fake selection. */ - _setTo( selectable, optionsOrPlaceOrOffset, options ) { + _setTo( selectable, placeOrOffset, options ) { if ( selectable === null ) { this._setRanges( [] ); - this._setFakeOptions( optionsOrPlaceOrOffset ); + this._setFakeOptions( placeOrOffset ); } else if ( selectable instanceof Selection ) { this._setRanges( selectable.getRanges(), selectable.isBackward ); this._setFakeOptions( { fake: selectable.isFake, label: selectable.fakeSelectionLabel } ); } else if ( selectable instanceof Range ) { - this._setRanges( [ selectable ], optionsOrPlaceOrOffset && optionsOrPlaceOrOffset.backward ); - this._setFakeOptions( optionsOrPlaceOrOffset ); + this._setRanges( [ selectable ], placeOrOffset && placeOrOffset.backward ); + this._setFakeOptions( placeOrOffset ); } else if ( selectable instanceof Position ) { this._setRanges( [ new Range( selectable ) ] ); - this._setFakeOptions( optionsOrPlaceOrOffset ); + this._setFakeOptions( placeOrOffset ); } else if ( selectable instanceof Node ) { const backward = !!options && !!options.backward; let range; - if ( optionsOrPlaceOrOffset === undefined ) { + if ( placeOrOffset === undefined ) { /** - * Required second parameter when setting selection to node. + * selection.setTo requires the second parameter when the first parameter is a node. * * @error view-selection-setTo-required-second-parameter */ throw new CKEditorError( - 'view-selection-setTo-required-second-parameter: Required second parameter when setting selection to node.' + 'view-selection-setTo-required-second-parameter: ' + + 'selection.setTo requires the second parameter when the first parameter is a node.' ); - } else if ( optionsOrPlaceOrOffset == 'in' ) { + } else if ( placeOrOffset == 'in' ) { range = Range.createIn( selectable ); - } else if ( optionsOrPlaceOrOffset == 'on' ) { + } else if ( placeOrOffset == 'on' ) { range = Range.createOn( selectable ); } else { - range = Range.createCollapsedAt( selectable, optionsOrPlaceOrOffset ); + range = Range.createCollapsedAt( selectable, placeOrOffset ); } this._setRanges( [ range ], backward ); @@ -492,8 +485,8 @@ export default class Selection { } else if ( isIterable( selectable ) ) { // We assume that the selectable is an iterable of ranges. // Array.from() is used to prevent setting ranges to the old iterable - this._setRanges( selectable, optionsOrPlaceOrOffset && optionsOrPlaceOrOffset.backward ); - this._setFakeOptions( optionsOrPlaceOrOffset ); + this._setRanges( selectable, placeOrOffset && placeOrOffset.backward ); + this._setFakeOptions( placeOrOffset ); } else { /** * Cannot set selection to given place. From 2fbcceaeac843bbbb1f325eb8e3de1d43cd7f6e6 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 28 Feb 2018 10:52:32 +0100 Subject: [PATCH 671/724] Docs fixes. --- src/view/selection.js | 11 ++++++++--- src/view/writer.js | 38 +++++++++++++++++--------------------- 2 files changed, 25 insertions(+), 24 deletions(-) diff --git a/src/view/selection.js b/src/view/selection.js index 08bc3ca78..06cd2df1e 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -404,11 +404,16 @@ export default class Selection { * {@link module:engine/view/item~Item item}, {@link module:engine/view/range~Range range}, * an iterable of {@link module:engine/view/range~Range ranges} or null. * + * This method provides option to create a fake selection. + * Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * represented in other way, for example by applying proper CSS class. + * * // Sets selection to the given range. * const range = new Range( start, end ); * selection.setTo( range, { backward, fake, label } ); * - * // Sets selection to the ranges. + * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; * selection.setTo( range, { backward, fake, label } ); * @@ -432,14 +437,14 @@ export default class Selection { * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward, fake, label } ); * - * // Clears selection. Removes all ranges and options + * // Clears selection. Removes all ranges. * selection.setTo( null ); * * @protected * @fires change * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Offset or place. + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets offset or place of the selection. * @param {Object} [options] * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. diff --git a/src/view/writer.js b/src/view/writer.js index 83b703e4b..a63ec7810 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -46,51 +46,47 @@ export default class Writer { * * Usage: * - * // Sets ranges from the given range. + * // Sets selection to the given range. * const range = new Range( start, end ); - * writer.setSelection( range, isBackwardSelection ); + * writer.setSelection( range, { backward, fake, label } ); * - * // Sets ranges from the iterable of ranges. + * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * writer.setSelection( range, isBackwardSelection ); + * writer.setSelection( range, { backward, fake, label } ); * - * // Sets ranges from the other selection. + * // Sets selection to the other selection. * const otherSelection = new Selection(); * writer.setSelection( otherSelection ); * - * // Sets collapsed range at the given position. + * // Sets collapsed selection at the given position. * const position = new Position( root, path ); - * writer.setSelection( position ); + * writer.setSelection( position, { fake, label } ); * - * // Sets collapsed range at the position of given item and offset. + * // Sets collapsed selection at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, offset ); + * selection.setTo( paragraph, offset, { fake, label } ); * - * // Sets range inside the item. + * // Sets selection inside the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in' ); + * selection.setTo( paragraph, 'in', { backward, fake, label } ); * - * // Sets range on the item. + * // Sets selection on the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on' ); + * selection.setTo( paragraph, 'on', { backward, fake, label } ); * * // Removes all ranges. * writer.setSelection( null ); * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] Offset or place when selectable is an `Item`. - * Options otherwise. - * @param {Boolean} [optionsOrPlaceOrOffset.backward] Sets this selection instance to be backward. - * @param {Boolean} [optionsOrPlaceOrOffset.fake] Sets this selection instance to be marked as `fake`. - * @param {Boolean} [optionsOrPlaceOrOffset.label] Label for the fake selection. - * @param {Object} [options] Options when selectable is an `Item`. + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets offset or place of the selection. + * @param {Object} [options] * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. * @param {String} [options.label] Label for the fake selection. */ - setSelection( selectable, optionsOrPlaceOrOffset, options ) { - this.document.selection._setTo( selectable, optionsOrPlaceOrOffset, options ); + setSelection( selectable, placeOrOffset, options ) { + this.document.selection._setTo( selectable, placeOrOffset, options ); } /** From 961d520a197212faef50552a4348f77093b1b29c Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 28 Feb 2018 11:07:50 +0100 Subject: [PATCH 672/724] Docs fixes. --- src/model/selection.js | 8 ++++---- src/model/writer.js | 33 ++++++++++++++++----------------- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 8c73c8690..ec327a9ef 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -324,7 +324,7 @@ export default class Selection { * const otherSelection = new Selection(); * selection.setTo( otherSelection ); * - * // Sets selection to the document selection. + * // Sets selection to the given document selection. * // Note: It doesn't copies selection attributes. * const documentSelection = new DocumentSelection( doc ); * selection.setTo( documentSelection ); @@ -337,15 +337,15 @@ export default class Selection { * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, offset ); * - * // Sets selection inside the node. + * // Sets selection inside the given node. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'in', { backward } ); * - * // Sets selection on the node. + * // Sets selection on the given node. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward } ); * - * // Clears selection. Removes all ranges. + * // Removes all selection's ranges. * selection.setTo( null ); * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| diff --git a/src/model/writer.js b/src/model/writer.js index 68cefa449..ecaf8b4fd 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -905,39 +905,39 @@ export default class Writer { * {@link module:engine/model/element~Node node}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * - * // Sets ranges from the given range. + * // Sets selection to the given range. * const range = new Range( start, end ); * writer.setSelection( range, { backward } ); * - * // Sets ranges from the iterable of ranges. + * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; * writer.setSelection( range, { backward } ); * - * // Sets ranges from the other selection. + * // Sets selection to other selection. * const otherSelection = new Selection(); * writer.setSelection( otherSelection ); * - * // Sets ranges from the given document selection's ranges. + * // Sets selection to the given document selection. * const documentSelection = new DocumentSelection( doc ); * writer.setSelection( documentSelection ); * - * // Sets collapsed range at the given position. + * // Sets collapsed selection at the given position. * const position = new Position( root, path ); * writer.setSelection( position ); * - * // Sets range at the position of given node and offset. + * // Sets collapsed selection at the position of the given node and an offset. * const paragraph = writer.createElement( 'paragraph' ); * writer.setSelection( paragraph, offset ); * - * // Sets range inside the node. - * const paragraph = writer.createElement( 'paragraph', { backward } ); - * writer.setSelection( paragraph, 'in' ); + * // Sets selection inside the given node. + * const paragraph = writer.createElement( 'paragraph' ); + * writer.setSelection( paragraph, 'in', { backward } ); * - * // Sets range on the node. - * const paragraph = writer.createElement( 'paragraph', { backward } ); - * writer.setSelection( paragraph, 'on' ); + * // Sets selection on the given node. + * const paragraph = writer.createElement( 'paragraph' ); + * writer.setSelection( paragraph, 'on', { backward } ); * - * // Removes all ranges. + * // Removes all selection's ranges. * writer.setSelection( null ); * * Throws `writer-incorrect-use` error when the writer is used outside the `change()` block. @@ -945,15 +945,14 @@ export default class Writer { * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] * @param {Object} [options] * @param {Boolean} [options.backward] */ - setSelection( selectable, optionsOrPlaceOrOffset, options ) { + setSelection( selectable, placeOrOffset, options ) { this._assertWriterUsedCorrectly(); - this.model.document.selection._setTo( selectable, optionsOrPlaceOrOffset, options ); + this.model.document.selection._setTo( selectable, placeOrOffset, options ); } /** From 7f2cacb8a417cf6502f2fccb4724be34e3034831 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 28 Feb 2018 11:11:03 +0100 Subject: [PATCH 673/724] Docs fixes. --- src/model/selection.js | 5 +---- src/model/writer.js | 3 --- src/view/selection.js | 3 --- src/view/writer.js | 3 --- 4 files changed, 1 insertion(+), 13 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index ec327a9ef..a5bb4c68f 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -333,16 +333,13 @@ export default class Selection { * const position = new Position( root, path ); * selection.setTo( position ); * - * // Sets collapsed selection at the position of given node and offset. - * const paragraph = writer.createElement( 'paragraph' ); + * // Sets collapsed selection at the position of the given node and an offset. * selection.setTo( paragraph, offset ); * * // Sets selection inside the given node. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'in', { backward } ); * * // Sets selection on the given node. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward } ); * * // Removes all selection's ranges. diff --git a/src/model/writer.js b/src/model/writer.js index ecaf8b4fd..2b862792d 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -926,15 +926,12 @@ export default class Writer { * writer.setSelection( position ); * * // Sets collapsed selection at the position of the given node and an offset. - * const paragraph = writer.createElement( 'paragraph' ); * writer.setSelection( paragraph, offset ); * * // Sets selection inside the given node. - * const paragraph = writer.createElement( 'paragraph' ); * writer.setSelection( paragraph, 'in', { backward } ); * * // Sets selection on the given node. - * const paragraph = writer.createElement( 'paragraph' ); * writer.setSelection( paragraph, 'on', { backward } ); * * // Removes all selection's ranges. diff --git a/src/view/selection.js b/src/view/selection.js index 06cd2df1e..b9cd19fde 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -426,15 +426,12 @@ export default class Selection { * selection.setTo( position, { fake, label } ); * * // Sets collapsed selection at the position of given item and offset. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, offset, { fake, label } ); * * // Sets selection inside the item. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'in', { backward, fake, label } ); * * // Sets selection on the item. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward, fake, label } ); * * // Clears selection. Removes all ranges. diff --git a/src/view/writer.js b/src/view/writer.js index a63ec7810..b546b2710 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -63,15 +63,12 @@ export default class Writer { * writer.setSelection( position, { fake, label } ); * * // Sets collapsed selection at the position of given item and offset. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, offset, { fake, label } ); * * // Sets selection inside the item. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'in', { backward, fake, label } ); * * // Sets selection on the item. - * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward, fake, label } ); * * // Removes all ranges. From 1af17bb3ab80b8d730be2ce3ca2171355d456608 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 28 Feb 2018 11:20:52 +0100 Subject: [PATCH 674/724] Docs fixes. --- src/model/documentselection.js | 9 ++++----- src/model/selection.js | 4 ++-- src/model/writer.js | 4 ++-- src/view/selection.js | 2 +- src/view/writer.js | 2 +- 5 files changed, 10 insertions(+), 11 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 3740c9be4..c1c69cf9d 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -357,13 +357,12 @@ export default class DocumentSelection { * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Object|Number|'before'|'end'|'after'|'on'|'in'} [optionsOrPlaceOrOffset] - * @param {Boolean} [optionsOrPlaceOrOffset.backward] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Boolean} [options.backward] Sets this selection instance to be backward. */ - _setTo( selectable, optionsOrPlaceOrOffset, options ) { - this._selection.setTo( selectable, optionsOrPlaceOrOffset, options ); + _setTo( selectable, placeOrOffset, options ) { + this._selection.setTo( selectable, placeOrOffset, options ); } /** diff --git a/src/model/selection.js b/src/model/selection.js index a5bb4c68f..874ab3fbe 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -348,9 +348,9 @@ export default class Selection { * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Boolean} [options.backward] Sets this selection instance to be backward. */ setTo( selectable, placeOrOffset, options ) { if ( selectable === null ) { diff --git a/src/model/writer.js b/src/model/writer.js index 2b862792d..e38be8e7c 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -942,9 +942,9 @@ export default class Writer { * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/node~Node| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Boolean} [options.backward] Sets this selection instance to be backward. */ setSelection( selectable, placeOrOffset, options ) { this._assertWriterUsedCorrectly(); diff --git a/src/view/selection.js b/src/view/selection.js index b9cd19fde..233b5e4a5 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -441,7 +441,7 @@ export default class Selection { * @fires change * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets offset or place of the selection. + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. * @param {Object} [options] * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. diff --git a/src/view/writer.js b/src/view/writer.js index b546b2710..a41802810 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -76,7 +76,7 @@ export default class Writer { * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable - * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets offset or place of the selection. + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. * @param {Object} [options] * @param {Boolean} [options.backward] Sets this selection instance to be backward. * @param {Boolean} [options.fake] Sets this selection instance to be marked as `fake`. From d9b62bb023749b67cae75cc1066926b19754f8eb Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 1 Mar 2018 11:41:42 +0100 Subject: [PATCH 675/724] Fixed docs and order of methods in class. --- src/model/documentfragment.js | 82 +++++++++++++++++------------------ src/model/element.js | 4 +- src/model/text.js | 4 +- src/view/element.js | 4 +- src/view/text.js | 4 +- 5 files changed, 49 insertions(+), 49 deletions(-) diff --git a/src/model/documentfragment.js b/src/model/documentfragment.js index 0e2a3d5eb..f28dd17a6 100644 --- a/src/model/documentfragment.js +++ b/src/model/documentfragment.js @@ -25,8 +25,8 @@ export default class DocumentFragment { /** * Creates an empty `DocumentFragment`. * - * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/model/writer~Writer#createDocumentFragment} method. + * **Note:** Constructor of this class shouldn't be used directly in the code. + * Use the {@link module:engine/model/writer~Writer#createDocumentFragment} method instead. * * @protected * @param {module:engine/model/node~Node|Iterable.} [children] @@ -220,6 +220,45 @@ export default class DocumentFragment { return this._children.offsetToIndex( offset ); } + /** + * Converts `DocumentFragment` instance to plain object and returns it. + * Takes care of converting all of this document fragment's children. + * + * @returns {Object} `DocumentFragment` instance converted to plain object. + */ + toJSON() { + const json = []; + + for ( const node of this._children ) { + json.push( node.toJSON() ); + } + + return json; + } + + /** + * Creates a `DocumentFragment` instance from given plain object (i.e. parsed JSON string). + * Converts `DocumentFragment` children to proper nodes. + * + * @param {Object} json Plain object to be converted to `DocumentFragment`. + * @returns {module:engine/model/documentfragment~DocumentFragment} `DocumentFragment` instance created using given plain object. + */ + static fromJSON( json ) { + const children = []; + + for ( const child of json ) { + if ( child.name ) { + // If child has name property, it is an Element. + children.push( Element.fromJSON( child ) ); + } else { + // Otherwise, it is a Text node. + children.push( Text.fromJSON( child ) ); + } + } + + return new DocumentFragment( children ); + } + /** * {@link #_insertChildren Inserts} one or more nodes at the end of this document fragment. * @@ -271,45 +310,6 @@ export default class DocumentFragment { return nodes; } - - /** - * Converts `DocumentFragment` instance to plain object and returns it. - * Takes care of converting all of this document fragment's children. - * - * @returns {Object} `DocumentFragment` instance converted to plain object. - */ - toJSON() { - const json = []; - - for ( const node of this._children ) { - json.push( node.toJSON() ); - } - - return json; - } - - /** - * Creates a `DocumentFragment` instance from given plain object (i.e. parsed JSON string). - * Converts `DocumentFragment` children to proper nodes. - * - * @param {Object} json Plain object to be converted to `DocumentFragment`. - * @returns {module:engine/model/documentfragment~DocumentFragment} `DocumentFragment` instance created using given plain object. - */ - static fromJSON( json ) { - const children = []; - - for ( const child of json ) { - if ( child.name ) { - // If child has name property, it is an Element. - children.push( Element.fromJSON( child ) ); - } else { - // Otherwise, it is a Text node. - children.push( Text.fromJSON( child ) ); - } - } - - return new DocumentFragment( children ); - } } // Converts strings to Text and non-iterables to arrays. diff --git a/src/model/element.js b/src/model/element.js index 6f07e6389..fbd0cf1b5 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -25,8 +25,8 @@ export default class Element extends Node { /** * Creates a model element. * - * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/model/writer~Writer#createElement} method. + * **Note:** Constructor of this class shouldn't be used directly in the code. + * Use the {@link module:engine/model/writer~Writer#createElement} method instead. * * @protected * @param {String} name Element's name. diff --git a/src/model/text.js b/src/model/text.js index 8b1e7a03c..eb3cb8d39 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -26,8 +26,8 @@ export default class Text extends Node { /** * Creates a text node. * - * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/model/writer~Writer#createText} method. + * **Note:** Constructor of this class shouldn't be used directly in the code. + * Use the {@link module:engine/model/writer~Writer#createText} method instead. * * @protected * @param {String} data Node's text. diff --git a/src/view/element.js b/src/view/element.js index a0c509184..f67129b65 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -38,12 +38,12 @@ export default class Element extends Node { * new Element( 'div', [ [ 'class', 'editor' ], [ 'contentEditable', 'true' ] ] ); // map-like iterator * new Element( 'div', mapOfAttributes ); // map * - * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the + * **Note:** Constructor of this class shouldn't be used directly in the code. Use the * {@link module:engine/view/writer~Writer#createAttributeElement} for inline element, * {@link module:engine/view/writer~Writer#createContainerElement} for block element, * {@link module:engine/view/writer~Writer#createEditableElement} for editable element, * {@link module:engine/view/writer~Writer#createEmptyElement} for empty element or - * {@link module:engine/view/writer~Writer#createUIElement} for UI element. + * {@link module:engine/view/writer~Writer#createUIElement} for UI element instead. * * @protected * @param {String} name Node name. diff --git a/src/view/text.js b/src/view/text.js index 500e2b594..efe19cea3 100644 --- a/src/view/text.js +++ b/src/view/text.js @@ -18,8 +18,8 @@ export default class Text extends Node { /** * Creates a tree view text node. * - * **Note:** Constructor of this class shouldn't be used directly in the code. Instead of use the - * {@link module:engine/view/writer~Writer#createText} method. + * **Note:** Constructor of this class shouldn't be used directly in the code. + * Use the {@link module:engine/view/writer~Writer#createText} method instead. * * @protected * @param {String} data Text. From 6354957b03df3102bd0f50e350a4094bdbe528a8 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 1 Mar 2018 11:43:53 +0100 Subject: [PATCH 676/724] "model.Text#data" is protected now. --- src/model/text.js | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/model/text.js b/src/model/text.js index eb3cb8d39..d733659e1 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -39,9 +39,10 @@ export default class Text extends Node { /** * Text data contained in this text node. * + * @protected * @type {String} */ - this.data = data || ''; + this._data = data || ''; } /** @@ -51,6 +52,15 @@ export default class Text extends Node { return this.data.length; } + /** + * Returns a text data contained in the node. + * + * @returns {String} + */ + get data() { + return this._data; + } + /** * @inheritDoc */ From 9014fdd36352a07f4bef535859564c04444aeb1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 2 Mar 2018 14:30:39 +0100 Subject: [PATCH 677/724] Added tests checking 1267 issue. --- tests/tickets/1267.js | 75 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 tests/tickets/1267.js diff --git a/tests/tickets/1267.js b/tests/tickets/1267.js new file mode 100644 index 000000000..6f998aa71 --- /dev/null +++ b/tests/tickets/1267.js @@ -0,0 +1,75 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +/* globals document */ + +import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor'; +import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; +import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold'; +import Position from '../../src/model/position'; +import Range from '../../src/model/range'; +import { setData as setModelData, getData as getModelData } from '../../src/dev-utils/model'; + +describe( 'Bug ckeditor5-engine#1267', () => { + let element, editor, model; + + beforeEach( () => { + element = document.createElement( 'div' ); + document.body.appendChild( element ); + + return ClassicTestEditor + .create( element, { plugins: [ Paragraph, Bold ] } ) + .then( newEditor => { + editor = newEditor; + model = editor.model; + } ); + } ); + + afterEach( () => { + element.remove(); + + return editor.destroy(); + } ); + + it( 'selection should not retain attributes after external change removal', () => { + setModelData( model, + 'foo bar baz' + + 'foo <$text bold="true">bar{} baz' + ); + + // Remove second paragraph where selection is placed. + model.enqueueChange( 'transparent', writer => { + writer.remove( Range.createFromPositionAndShift( new Position( model.document.getRoot(), [ 1 ] ), 1 ) ); + } ); + + expect( getModelData( model ) ).to.equal( 'foo bar baz[]' ); + } ); + + it( 'selection should retain attributes set manually', () => { + setModelData( model, + 'foo bar baz' + + 'foo bar baz' + + '[]' + ); + + // Execute bold command when selection is inside empty paragraph. + editor.execute( 'bold' ); + expect( getModelData( model ) ).to.equal( + 'foo bar baz' + + 'foo bar baz' + + '<$text bold="true">[]' + ); + + // Remove second paragraph. + model.enqueueChange( 'transparent', writer => { + writer.remove( Range.createFromPositionAndShift( new Position( model.document.getRoot(), [ 1 ] ), 1 ) ); + } ); + + // Selection attributes set by command should stay as they were. + expect( getModelData( model ) ).to.equal( + 'foo bar baz' + + '<$text bold="true">[]' ); + } ); +} ); From 1178020e5030698ca02713acbe5a875e1279554d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 2 Mar 2018 17:53:38 +0100 Subject: [PATCH 678/724] DocumentSelection attributes update fix WIP. --- src/model/documentselection.js | 65 ++++++++++++-------------------- tests/model/documentselection.js | 13 ++----- 2 files changed, 28 insertions(+), 50 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 58fc7447b..34f007cd5 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -19,10 +19,6 @@ import toMap from '@ckeditor/ckeditor5-utils/src/tomap'; import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import log from '@ckeditor/ckeditor5-utils/src/log'; -const attrOpTypes = new Set( - [ 'addAttribute', 'removeAttribute', 'changeAttribute', 'addRootAttribute', 'removeRootAttribute', 'changeRootAttribute' ] -); - const storePrefix = 'selection:'; /** @@ -531,29 +527,13 @@ class LiveSelection extends Selection { } } ); - this.listenTo( this._model, 'applyOperation', ( evt, args ) => { - const operation = args[ 0 ]; - - if ( !operation.isDocumentOperation ) { - return; - } + this.listenTo( this._document, 'change', ( evt, batch ) => { + // Update selection's attributes. + this._updateAttributes( false ); - // Whenever attribute operation is performed on document, update selection attributes. - // This is not the most efficient way to update selection attributes, but should be okay for now. - if ( attrOpTypes.has( operation.type ) ) { - this._updateAttributes( false ); - } - - const batch = operation.delta.batch; - - // Batch may not be passed to the document#change event in some tests. - // See https://github.com/ckeditor/ckeditor5-engine/issues/1001#issuecomment-314202352 - if ( batch ) { - // Whenever element which had selection's attributes stored in it stops being empty, - // the attributes need to be removed. - clearAttributesStoredInElement( operation, this._model, batch ); - } - }, { priority: 'low' } ); + // Clear selection attributes from element if no longer empty, + clearAttributesStoredInElement( this._model, batch ); + } ); this.listenTo( this._model, 'applyOperation', () => { while ( this._fixGraveyardRangesData.length ) { @@ -1019,24 +999,27 @@ function getAttrsIfCharacter( node ) { } // Removes selection attributes from element which is not empty anymore. -function clearAttributesStoredInElement( operation, model, batch ) { - let changeParent = null; +function clearAttributesStoredInElement( model, batch ) { + // Clear attributes stored in selection; + const differ = model.document.differ; - if ( operation.type == 'insert' ) { - changeParent = operation.position.parent; - } else if ( operation.type == 'move' || operation.type == 'reinsert' || operation.type == 'remove' ) { - changeParent = operation.getMovedRangeStart().parent; - } + for ( const entry of differ.getChanges() ) { + if ( entry.type != 'insert' || !entry.position.parent ) { + continue; + } - if ( !changeParent || changeParent.isEmpty ) { - return; - } + const changeParent = entry.position.parent; + const isNoLongerEmpty = entry.length === changeParent.maxOffset; - model.enqueueChange( batch, writer => { - const storedAttributes = Array.from( changeParent.getAttributeKeys() ).filter( key => key.startsWith( storePrefix ) ); + if ( isNoLongerEmpty ) { + model.enqueueChange( batch, writer => { + const storedAttributes = Array.from( changeParent.getAttributeKeys() ) + .filter( key => key.startsWith( storePrefix ) ); - for ( const key of storedAttributes ) { - writer.removeAttribute( key, changeParent ); + for ( const key of storedAttributes ) { + writer.removeAttribute( key, changeParent ); + } + } ); } - } ); + } } diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index 11f3bef20..adc51f215 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -1056,15 +1056,10 @@ describe( 'DocumentSelection', () => { expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] ); } ); - model.applyOperation( wrapInDelta( - new AttributeOperation( - new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), - 'foo', - null, - 'bar', - doc.version - ) - ) ); + model.change( writer => { + const range = new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ); + writer.setAttribute( 'foo', 'bar', range ); + } ); expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); expect( spyAttribute.calledOnce ).to.be.true; From d18cac0b79716b85004b577eb2ff4e5dfe79294f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Sat, 3 Mar 2018 11:14:19 +0100 Subject: [PATCH 679/724] Decorate DataController#set metohd. --- src/controller/datacontroller.js | 12 ++++++++++-- tests/controller/datacontroller.js | 10 ++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 66fa77d37..d1216a411 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -99,6 +99,8 @@ export default class DataController { this.upcastDispatcher.on( 'text', convertText(), { priority: 'lowest' } ); this.upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); this.upcastDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); + + this.decorate( 'set' ); } /** @@ -176,6 +178,7 @@ export default class DataController { * This method also creates a batch with all the changes applied. If all you need is to parse data, use * the {@link #parse} method. * + * @fires set * @param {String} data Input data. * @param {String} [rootName='main'] Root name. */ @@ -184,8 +187,6 @@ export default class DataController { const modelRoot = this.model.document.getRoot( rootName ); this.model.enqueueChange( 'transparent', writer => { - // Clearing selection is a workaround for ticket #569 (LiveRange loses position after removing data from document). - // After fixing it this code should be removed. writer.setSelection( null ); writer.removeSelectionAttribute( this.model.document.selection.getAttributeKeys() ); @@ -236,6 +237,13 @@ export default class DataController { * Removes all event listeners set by the DataController. */ destroy() {} + + /** + * Event fired by decorated {@link #set} method. + * See {@link module:utils/observablemixin~ObservableMixin.decorate} for more information and samples. + * + * @event set + */ } mix( DataController, ObservableMixin ); diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index 58807df48..76feb1592 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -153,6 +153,16 @@ describe( 'DataController', () => { } ); describe( 'set()', () => { + it( 'should be decorated', () => { + const spy = sinon.spy(); + + data.on( 'set', spy ); + + data.set( 'foo bar' ); + + sinon.assert.calledWithExactly( spy, sinon.match.any, [ 'foo bar' ] ); + } ); + it( 'should set data to default main root', () => { schema.extend( '$text', { allowIn: '$root' } ); data.set( 'foo' ); From 309f01026d9b1be90ccf5215e3f5ce49a7a21e3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krzysztof=20Krzto=C5=84?= Date: Mon, 5 Mar 2018 09:18:21 +0100 Subject: [PATCH 680/724] Removed 'renderer.isComposing' unused property. --- src/view/renderer.js | 7 ------- src/view/view.js | 1 - tests/view/view/view.js | 12 ------------ 3 files changed, 20 deletions(-) diff --git a/src/view/renderer.js b/src/view/renderer.js index b86ec5cd5..10e7ef4f9 100644 --- a/src/view/renderer.js +++ b/src/view/renderer.js @@ -103,13 +103,6 @@ export default class Renderer { */ this.isFocused = false; - /** - * Indicates if composition takes places inside view document. - * - * @member {Boolean} - */ - this.isComposing = false; - /** * DOM element containing fake selection. * diff --git a/src/view/view.js b/src/view/view.js index e3f74ba6a..978615a4a 100644 --- a/src/view/view.js +++ b/src/view/view.js @@ -85,7 +85,6 @@ export default class View { */ this._renderer = new Renderer( this.domConverter, this.document.selection ); this._renderer.bind( 'isFocused' ).to( this.document ); - this._renderer.bind( 'isComposing' ).to( this.document ); /** * Roots of the DOM tree. Map on the `HTMLElement`s with roots names as keys. diff --git a/tests/view/view/view.js b/tests/view/view/view.js index 9256cc084..2bc122526 100644 --- a/tests/view/view/view.js +++ b/tests/view/view/view.js @@ -370,18 +370,6 @@ describe( 'view', () => { } ); } ); - describe( 'isComposing', () => { - it( 'should change renderer.isComposing too', () => { - expect( viewDocument.isComposing ).to.equal( false ); - expect( view._renderer.isComposing ).to.equal( false ); - - viewDocument.isComposing = true; - - expect( viewDocument.isComposing ).to.equal( true ); - expect( view._renderer.isComposing ).to.equal( true ); - } ); - } ); - describe( 'render()', () => { it( 'disable observers, renders and enable observers', () => { const observerMock = view.addObserver( ObserverMock ); From 4ab06e2803ed9beee67708dc435d283d2fe50937 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Mon, 5 Mar 2018 11:33:02 +0100 Subject: [PATCH 681/724] "_clone()" method is now protected. --- src/model/element.js | 5 +++-- src/model/node.js | 3 ++- src/model/operation/insertoperation.js | 4 ++-- src/model/text.js | 5 ++++- src/model/utils/getselectedcontent.js | 2 +- src/view/attributeelement.js | 5 +++-- src/view/element.js | 5 +++-- src/view/text.js | 3 ++- src/view/writer.js | 6 +++--- tests/model/element.js | 6 +++--- tests/model/node.js | 4 ++-- tests/model/text.js | 4 ++-- tests/view/attributeelement.js | 4 ++-- tests/view/editableelement.js | 2 +- tests/view/element.js | 24 ++++++++++++------------ tests/view/emptyelement.js | 4 ++-- tests/view/rooteditableelement.js | 2 +- tests/view/text.js | 6 +++--- tests/view/uielement.js | 4 ++-- 19 files changed, 53 insertions(+), 45 deletions(-) diff --git a/src/model/element.js b/src/model/element.js index fbd0cf1b5..431040bf0 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -159,11 +159,12 @@ export default class Element extends Node { * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element. * If clone is deep, the original element's children are also cloned. If not, then empty element is removed. * + * @protected * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`, * element will be cloned without any child. */ - clone( deep = false ) { - const children = deep ? Array.from( this._children ).map( node => node.clone( true ) ) : null; + _clone( deep = false ) { + const children = deep ? Array.from( this._children ).map( node => node._clone( true ) ) : null; return new Element( this.name, this.getAttributes(), children ); } diff --git a/src/model/node.js b/src/model/node.js index 8f4a986e6..126d15514 100644 --- a/src/model/node.js +++ b/src/model/node.js @@ -204,9 +204,10 @@ export default class Node { /** * Creates a copy of this node, that is a node with exactly same attributes, and returns it. * + * @protected * @returns {module:engine/model/node~Node} Node with same attributes as this node. */ - clone() { + _clone() { return new Node( this._attrs ); } diff --git a/src/model/operation/insertoperation.js b/src/model/operation/insertoperation.js index 8bec4f9e4..b154ece7b 100644 --- a/src/model/operation/insertoperation.js +++ b/src/model/operation/insertoperation.js @@ -63,7 +63,7 @@ export default class InsertOperation extends Operation { * @returns {module:engine/model/operation/insertoperation~InsertOperation} Clone of this operation. */ clone() { - const nodes = new NodeList( [ ...this.nodes ].map( node => node.clone( true ) ) ); + const nodes = new NodeList( [ ...this.nodes ].map( node => node._clone( true ) ) ); return new InsertOperation( this.position, nodes, this.baseVersion ); } @@ -107,7 +107,7 @@ export default class InsertOperation extends Operation { // to the operation, not modified. For example, text nodes can get merged or cropped while Elements can // get children. It is important that InsertOperation has the copy of original nodes in intact state. const originalNodes = this.nodes; - this.nodes = new NodeList( [ ...originalNodes ].map( node => node.clone( true ) ) ); + this.nodes = new NodeList( [ ...originalNodes ].map( node => node._clone( true ) ) ); _insert( this.position, originalNodes ); } diff --git a/src/model/text.js b/src/model/text.js index d733659e1..3877c3f3b 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -70,8 +70,11 @@ export default class Text extends Node { /** * Creates a copy of this text node and returns it. Created text node has same text data and attributes as original text node. + * + * @protected + * @returns {module:engine/model/text~Text} `Text` instance created using given plain object. */ - clone() { + _clone() { return new Text( this.data, this.getAttributes() ); } diff --git a/src/model/utils/getselectedcontent.js b/src/model/utils/getselectedcontent.js index 9a32523a9..bd5394e16 100644 --- a/src/model/utils/getselectedcontent.js +++ b/src/model/utils/getselectedcontent.js @@ -71,7 +71,7 @@ export default function getSelectedContent( model, selection ) { if ( item.is( 'textProxy' ) ) { writer.appendText( item.data, item.getAttributes(), frag ); } else { - writer.append( item.clone( true ), frag ); + writer.append( item._clone( true ), frag ); } } diff --git a/src/view/attributeelement.js b/src/view/attributeelement.js index 6d1665179..64f36358d 100644 --- a/src/view/attributeelement.js +++ b/src/view/attributeelement.js @@ -75,12 +75,13 @@ export default class AttributeElement extends Element { /** * Clones provided element with priority. * + * @protected * @param {Boolean} deep If set to `true` clones element and all its children recursively. When set to `false`, * element will be cloned without any children. * @returns {module:engine/view/attributeelement~AttributeElement} Clone of this element. */ - clone( deep ) { - const cloned = super.clone( deep ); + _clone( deep ) { + const cloned = super._clone( deep ); // Clone priority too. cloned._priority = this._priority; diff --git a/src/view/element.js b/src/view/element.js index f67129b65..c2e6a4095 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -161,16 +161,17 @@ export default class Element extends Node { /** * Clones provided element. * + * @protected * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`, * element will be cloned without any children. * @returns {module:engine/view/element~Element} Clone of this element. */ - clone( deep = false ) { + _clone( deep = false ) { const childrenClone = []; if ( deep ) { for ( const child of this.getChildren() ) { - childrenClone.push( child.clone( deep ) ); + childrenClone.push( child._clone( deep ) ); } } diff --git a/src/view/text.js b/src/view/text.js index efe19cea3..fb796a09f 100644 --- a/src/view/text.js +++ b/src/view/text.js @@ -41,9 +41,10 @@ export default class Text extends Node { /** * Clones this node. * + * @protected * @returns {module:engine/view/text~Text} Text node that is a clone of this node. */ - clone() { + _clone() { return new Text( this.data ); } diff --git a/src/view/writer.js b/src/view/writer.js index 62fef1966..c4d0e7ccb 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -409,7 +409,7 @@ export default class Writer { if ( position.isAtStart ) { return Position.createBefore( element ); } else if ( !position.isAtEnd ) { - const newElement = element.clone( false ); + const newElement = element._clone( false ); this.insert( Position.createAfter( element ), newElement ); @@ -885,7 +885,7 @@ export default class Writer { // Wrap text, empty elements, ui elements or attributes with higher or equal priority. if ( isText || isEmpty || isUI || ( isAttribute && shouldABeOutsideB( attribute, child ) ) ) { // Clone attribute. - const newAttribute = attribute.clone(); + const newAttribute = attribute._clone(); // Wrap current node with new attribute; child._remove(); @@ -1378,7 +1378,7 @@ function _breakAttributes( position, forceSplitText = false ) { const offsetAfter = positionParent.index + 1; // Break element. - const clonedNode = positionParent.clone(); + const clonedNode = positionParent._clone(); // Insert cloned node to position's parent node. positionParent.parent._insertChildren( offsetAfter, clonedNode ); diff --git a/tests/model/element.js b/tests/model/element.js index 4f2f145a6..b3568e279 100644 --- a/tests/model/element.js +++ b/tests/model/element.js @@ -62,13 +62,13 @@ describe( 'Element', () => { } ); } ); - describe( 'clone', () => { + describe( '_clone()', () => { it( 'should return an element with same name, attributes and same instances of children if clone was not deep', () => { const p = new Element( 'p' ); const foo = new Text( 'foo' ); const element = new Element( 'elem', { bold: true, italic: true }, [ p, foo ] ); - const copy = element.clone(); + const copy = element._clone(); expect( copy.name ).to.equal( 'elem' ); expect( Array.from( copy.getAttributes() ) ).to.deep.equal( [ [ 'bold', true ], [ 'italic', true ] ] ); @@ -81,7 +81,7 @@ describe( 'Element', () => { const p = new Element( 'p', null, bar ); const element = new Element( 'elem', { bold: true, italic: true }, [ p, foo ] ); - const copy = element.clone( true ); + const copy = element._clone( true ); expect( copy.name ).to.equal( 'elem' ); expect( Array.from( copy.getAttributes() ) ).to.deep.equal( [ [ 'bold', true ], [ 'italic', true ] ] ); diff --git a/tests/model/node.js b/tests/model/node.js index ee0d1adea..9648ce915 100644 --- a/tests/model/node.js +++ b/tests/model/node.js @@ -136,10 +136,10 @@ describe( 'Node', () => { } ); } ); - describe( 'clone()', () => { + describe( '_clone()', () => { it( 'should return a copy of cloned node', () => { const node = new Node( { foo: 'bar' } ); - const copy = node.clone(); + const copy = node._clone(); expect( copy ).not.to.equal( node ); expect( Array.from( copy.getAttributes() ) ).to.deep.equal( Array.from( node.getAttributes() ) ); diff --git a/tests/model/text.js b/tests/model/text.js index 3e3c15e7f..b3ab4da94 100644 --- a/tests/model/text.js +++ b/tests/model/text.js @@ -52,10 +52,10 @@ describe( 'Text', () => { } ); } ); - describe( 'clone', () => { + describe( '_clone()', () => { it( 'should return a new Text instance, with data and attributes equal to cloned text node', () => { const text = new Text( 'foo', { bold: true } ); - const copy = text.clone(); + const copy = text._clone(); expect( copy.data ).to.equal( 'foo' ); expect( Array.from( copy.getAttributes() ) ).to.deep.equal( [ [ 'bold', true ] ] ); diff --git a/tests/view/attributeelement.js b/tests/view/attributeelement.js index 43b112d00..a761dd9d4 100644 --- a/tests/view/attributeelement.js +++ b/tests/view/attributeelement.js @@ -48,12 +48,12 @@ describe( 'AttributeElement', () => { } ); } ); - describe( 'clone', () => { + describe( '_clone()', () => { it( 'should clone element with priority', () => { const el = new AttributeElement( 'b' ); el._priority = 7; - const clone = el.clone(); + const clone = el._clone(); expect( clone ).to.not.equal( el ); expect( clone.name ).to.equal( el.name ); diff --git a/tests/view/editableelement.js b/tests/view/editableelement.js index 38c603dfc..52b7313ae 100644 --- a/tests/view/editableelement.js +++ b/tests/view/editableelement.js @@ -38,7 +38,7 @@ describe( 'EditableElement', () => { it( 'should be cloned properly', () => { element._document = docMock; - const newElement = element.clone(); + const newElement = element._clone(); expect( newElement.document ).to.equal( docMock ); } ); diff --git a/tests/view/element.js b/tests/view/element.js index 58975812c..ec86c05cc 100644 --- a/tests/view/element.js +++ b/tests/view/element.js @@ -123,10 +123,10 @@ describe( 'Element', () => { } ); } ); - describe( 'clone', () => { + describe( '_clone()', () => { it( 'should clone element', () => { const el = new Element( 'p', { attr1: 'foo', attr2: 'bar' } ); - const clone = el.clone(); + const clone = el._clone(); expect( clone ).to.not.equal( el ); expect( clone.name ).to.equal( el.name ); @@ -140,7 +140,7 @@ describe( 'Element', () => { new Element( 'span', { attr: 'qux' } ) ] ); const count = el.childCount; - const clone = el.clone( true ); + const clone = el._clone( true ); expect( clone ).to.not.equal( el ); expect( clone.name ).to.equal( el.name ); @@ -163,7 +163,7 @@ describe( 'Element', () => { new Element( 'b', { attr: 'baz' } ), new Element( 'span', { attr: 'qux' } ) ] ); - const clone = el.clone( false ); + const clone = el._clone( false ); expect( clone ).to.not.equal( el ); expect( clone.name ).to.equal( el.name ); @@ -175,7 +175,7 @@ describe( 'Element', () => { it( 'should clone class attribute', () => { const el = new Element( 'p', { foo: 'bar' } ); el._addClass( [ 'baz', 'qux' ] ); - const clone = el.clone( false ); + const clone = el._clone( false ); expect( clone ).to.not.equal( el ); expect( clone.name ).to.equal( el.name ); @@ -185,7 +185,7 @@ describe( 'Element', () => { it( 'should clone style attribute', () => { const el = new Element( 'p', { style: 'color: red; font-size: 12px;' } ); - const clone = el.clone( false ); + const clone = el._clone( false ); expect( clone ).to.not.equal( el ); expect( clone.name ).to.equal( el.name ); @@ -201,7 +201,7 @@ describe( 'Element', () => { el._setCustomProperty( 'foo', 'bar' ); el._setCustomProperty( symbol, 'baz' ); - const cloned = el.clone(); + const cloned = el._clone(); expect( cloned.getCustomProperty( 'foo' ) ).to.equal( 'bar' ); expect( cloned.getCustomProperty( symbol ) ).to.equal( 'baz' ); @@ -214,7 +214,7 @@ describe( 'Element', () => { expect( el.getFillerOffset ).to.be.undefined; el.getFillerOffset = fm; - const cloned = el.clone(); + const cloned = el._clone(); expect( cloned.getFillerOffset ).to.equal( fm ); } ); @@ -237,16 +237,16 @@ describe( 'Element', () => { } ); it( 'sould return false when name is not the same', () => { - const other = el.clone(); + const other = el._clone(); other.name = 'div'; expect( el.isSimilar( other ) ).to.be.false; } ); it( 'should return false when attributes are not the same', () => { - const other1 = el.clone(); - const other2 = el.clone(); - const other3 = el.clone(); + const other1 = el._clone(); + const other2 = el._clone(); + const other3 = el._clone(); other1._setAttribute( 'baz', 'qux' ); other2._setAttribute( 'foo', 'not-bar' ); other3._removeAttribute( 'foo' ); diff --git a/tests/view/emptyelement.js b/tests/view/emptyelement.js index 859a7d6e6..2eff0d3f1 100644 --- a/tests/view/emptyelement.js +++ b/tests/view/emptyelement.js @@ -70,9 +70,9 @@ describe( 'EmptyElement', () => { } ); } ); - describe( 'clone', () => { + describe( '_clone()', () => { it( 'should be cloned properly', () => { - const newEmptyElement = emptyElement.clone(); + const newEmptyElement = emptyElement._clone(); expect( newEmptyElement.name ).to.equal( 'img' ); expect( newEmptyElement.getAttribute( 'alt' ) ).to.equal( 'alternative text' ); diff --git a/tests/view/rooteditableelement.js b/tests/view/rooteditableelement.js index 6c7767e86..6ebd870e1 100644 --- a/tests/view/rooteditableelement.js +++ b/tests/view/rooteditableelement.js @@ -86,7 +86,7 @@ describe( 'RootEditableElement', () => { root._document = createDocumentMock(); root.rootName = 'header'; - const newRoot = root.clone(); + const newRoot = root._clone(); expect( newRoot._document ).to.equal( root._document ); expect( newRoot.rootName ).to.equal( root.rootName ); diff --git a/tests/view/text.js b/tests/view/text.js index 70b50dc10..914b408f6 100644 --- a/tests/view/text.js +++ b/tests/view/text.js @@ -40,10 +40,10 @@ describe( 'Text', () => { } ); } ); - describe( 'clone', () => { + describe( '_clone()', () => { it( 'should return new text with same data', () => { const text = new Text( 'foo bar' ); - const clone = text.clone(); + const clone = text._clone(); expect( clone ).to.not.equal( text ); expect( clone.data ).to.equal( text.data ); @@ -69,7 +69,7 @@ describe( 'Text', () => { } ); it( 'should return false when data is not the same', () => { - const other = text.clone(); + const other = text._clone(); other.data = 'not-foo'; expect( text.isSimilar( other ) ).to.be.false; diff --git a/tests/view/uielement.js b/tests/view/uielement.js index 99652d07a..a9b60f174 100644 --- a/tests/view/uielement.js +++ b/tests/view/uielement.js @@ -82,9 +82,9 @@ describe( 'UIElement', () => { } ); } ); - describe( 'clone()', () => { + describe( '_clone()', () => { it( 'should be properly cloned', () => { - const newUIElement = uiElement.clone(); + const newUIElement = uiElement._clone(); expect( newUIElement.name ).to.equal( 'span' ); expect( newUIElement.getAttribute( 'foo' ) ).to.equal( 'bar' ); From 24fab6e9ab68a54600fc2104381009bee06073e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Mon, 5 Mar 2018 18:51:35 +0100 Subject: [PATCH 682/724] Docs: Minor change. --- src/controller/datacontroller.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index d1216a411..5d9456652 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -178,6 +178,10 @@ export default class DataController { * This method also creates a batch with all the changes applied. If all you need is to parse data, use * the {@link #parse} method. * + * **Note** This method is {@link module:utils/observablemixin~ObservableMixin#decorate decorated} which is + * used by some plugins to change the behavior of this method. For example, the collaborative editing plugin changes + * this method’s nature to asynchronous by returning a promise. + * * @fires set * @param {String} data Input data. * @param {String} [rootName='main'] Root name. From faba0209564783954537aab9746a67526edacdc7 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Tue, 6 Mar 2018 10:57:38 +0100 Subject: [PATCH 683/724] Added missing docs. --- src/controller/datacontroller.js | 1 + src/conversion/conversion.js | 4 ++++ src/dataprocessor/htmldataprocessor.js | 2 +- src/model/documentfragment.js | 1 + src/model/element.js | 1 + src/model/model.js | 32 ++++++++++++++------------ src/model/nodelist.js | 1 + src/model/position.js | 1 + src/view/domconverter.js | 2 ++ src/view/matcher.js | 4 ++++ src/view/position.js | 2 ++ src/view/range.js | 2 ++ src/view/renderer.js | 1 + src/view/rooteditableelement.js | 1 + src/view/writer.js | 4 ++++ 15 files changed, 43 insertions(+), 16 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 66fa77d37..251b94bf1 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -66,6 +66,7 @@ export default class DataController { * cleared directly after the data are converted. However, the mapper is defined as a class property, because * it needs to be passed to the `DowncastDispatcher` as a conversion API. * + * @readonly * @member {module:engine/conversion/mapper~Mapper} */ this.mapper = new Mapper(); diff --git a/src/conversion/conversion.js b/src/conversion/conversion.js index cb6a942d8..f98d20e56 100644 --- a/src/conversion/conversion.js +++ b/src/conversion/conversion.js @@ -29,6 +29,10 @@ export default class Conversion { * Creates new Conversion instance. */ constructor() { + /** + * @private + * @member {Map} + */ this._dispatchersGroups = new Map(); } diff --git a/src/dataprocessor/htmldataprocessor.js b/src/dataprocessor/htmldataprocessor.js index 200237c16..60e8cc504 100644 --- a/src/dataprocessor/htmldataprocessor.js +++ b/src/dataprocessor/htmldataprocessor.js @@ -36,7 +36,7 @@ export default class HtmlDataProcessor { * A DOM converter used to convert DOM elements to view elements. * * @private - * @member + * @member {module:engine/view/domconverter~DomConverter} */ this._domConverter = new DomConverter( { blockFiller: NBSP_FILLER } ); diff --git a/src/model/documentfragment.js b/src/model/documentfragment.js index f28dd17a6..72ce770bf 100644 --- a/src/model/documentfragment.js +++ b/src/model/documentfragment.js @@ -38,6 +38,7 @@ export default class DocumentFragment { * which will be set as Markers to {@link module:engine/model/model~Model#markers model markers collection} * when DocumentFragment will be inserted to the document. * + * @readonly * @member {Map} module:engine/model/documentfragment~DocumentFragment#markers */ this.markers = new Map(); diff --git a/src/model/element.js b/src/model/element.js index 431040bf0..98762f3a3 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -40,6 +40,7 @@ export default class Element extends Node { /** * Element name. * + * @readonly * @member {String} module:engine/model/element~Element#name */ this.name = name; diff --git a/src/model/model.js b/src/model/model.js index 86cfb6175..c477f0bd3 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -39,15 +39,6 @@ import getSelectedContent from './utils/getselectedcontent'; */ export default class Model { constructor() { - /** - * All callbacks added by {@link module:engine/model/model~Model#change} or - * {@link module:engine/model/model~Model#enqueueChange} methods waiting to be executed. - * - * @private - * @type {Array.} - */ - this._pendingChanges = []; - /** * Models markers' collection. * @@ -59,24 +50,35 @@ export default class Model { /** * Editors document model. * + * @readonly * @member {module:engine/model/document~Document} */ this.document = new Document( this ); /** - * The last created and currently used writer instance. + * Schema for editors model. + * + * @readonly + * @member {module:engine/model/schema~Schema} + */ + this.schema = new Schema(); + + /** + * All callbacks added by {@link module:engine/model/model~Model#change} or + * {@link module:engine/model/model~Model#enqueueChange} methods waiting to be executed. * * @private - * @member {module:engine/model/writer~Writer} + * @type {Array.} */ - this._currentWriter = null; + this._pendingChanges = []; /** - * Schema for editors model. + * The last created and currently used writer instance. * - * @member {module:engine/model/schema~Schema} + * @private + * @member {module:engine/model/writer~Writer} */ - this.schema = new Schema(); + this._currentWriter = null; [ 'insertContent', 'deleteContent', 'modifySelection', 'getSelectedContent', 'applyOperation' ] .forEach( methodName => this.decorate( methodName ) ); diff --git a/src/model/nodelist.js b/src/model/nodelist.js index 6c481bc93..be925dc66 100644 --- a/src/model/nodelist.js +++ b/src/model/nodelist.js @@ -19,6 +19,7 @@ export default class NodeList { /** * Creates an empty node list. * + * @protected * @param {Iterable.} nodes Nodes contained in this node list. */ constructor( nodes ) { diff --git a/src/model/position.js b/src/model/position.js index 5e272c94f..d0c0b6674 100644 --- a/src/model/position.js +++ b/src/model/position.js @@ -104,6 +104,7 @@ export default class Position { * |- LI * |- b^a|r ^ has path: [ 1, 1, 1 ] | has path: [ 1, 1, 2 ] * + * @readonly * @member {Array.} module:engine/model/position~Position#path */ this.path = path; diff --git a/src/view/domconverter.js b/src/view/domconverter.js index 981094715..e835cf565 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -64,6 +64,7 @@ export default class DomConverter { /** * Tag names of DOM `Element`s which are considered pre-formatted elements. * + * @readonly * @member {Array.} module:engine/view/domconverter~DomConverter#preElements */ this.preElements = [ 'pre' ]; @@ -71,6 +72,7 @@ export default class DomConverter { /** * Tag names of DOM `Element`s which are considered block elements. * + * @readonly * @member {Array.} module:engine/view/domconverter~DomConverter#blockElements */ this.blockElements = [ 'p', 'div', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6' ]; diff --git a/src/view/matcher.js b/src/view/matcher.js index 5162011d8..67aef0725 100644 --- a/src/view/matcher.js +++ b/src/view/matcher.js @@ -19,6 +19,10 @@ export default class Matcher { * more information. */ constructor( ...pattern ) { + /** + * @private + * @type {Array} + */ this._patterns = []; this.add( ...pattern ); diff --git a/src/view/position.js b/src/view/position.js index 87d3293e3..6338df03a 100644 --- a/src/view/position.js +++ b/src/view/position.js @@ -27,6 +27,7 @@ export default class Position { /** * Position parent. * + * @readonly * @member {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment} * module:engine/view/position~Position#parent */ @@ -35,6 +36,7 @@ export default class Position { /** * Position offset. * + * @readonly * @member {Number} module:engine/view/position~Position#offset */ this.offset = offset; diff --git a/src/view/range.js b/src/view/range.js index c128b8dd5..babbce2e5 100644 --- a/src/view/range.js +++ b/src/view/range.js @@ -26,6 +26,7 @@ export default class Range { /** * Start position. * + * @readonly * @member {module:engine/view/position~Position} */ this.start = Position.createFromPosition( start ); @@ -33,6 +34,7 @@ export default class Range { /** * End position. * + * @readonly * @member {module:engine/view/position~Position} */ this.end = end ? Position.createFromPosition( end ) : Position.createFromPosition( start ); diff --git a/src/view/renderer.js b/src/view/renderer.js index 10e7ef4f9..247c46ab3 100644 --- a/src/view/renderer.js +++ b/src/view/renderer.js @@ -43,6 +43,7 @@ export default class Renderer { /** * Set of DOM Documents instances. * + * @readonly * @member {Set.} */ this.domDocuments = new Set(); diff --git a/src/view/rooteditableelement.js b/src/view/rooteditableelement.js index 58847c723..9ca377d50 100644 --- a/src/view/rooteditableelement.js +++ b/src/view/rooteditableelement.js @@ -31,6 +31,7 @@ export default class RootEditableElement extends EditableElement { * Name of this root inside {@link module:engine/view/document~Document} that is an owner of this root. If no * other name is set, `main` name is used. * + * @readonly * @member {String} */ this.rootName = 'main'; diff --git a/src/view/writer.js b/src/view/writer.js index c4d0e7ccb..6db864296 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -27,6 +27,10 @@ import EditableElement from './editableelement'; */ export default class Writer { constructor( document ) { + /** + * @readonly + * @type {module:engine/view/document~Document} + */ this.document = document; } From 5a6ab8ba17a8224df81aba353eea5deae580eaee Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Tue, 6 Mar 2018 14:03:26 +0100 Subject: [PATCH 684/724] Docs: Improvment in describing selection options. --- src/model/selection.js | 10 +++---- src/view/selection.js | 65 +++++++++++++++++++++++++++++------------- src/view/writer.js | 41 ++++++++++++++++---------- 3 files changed, 76 insertions(+), 40 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 874ab3fbe..82fbade2c 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -56,11 +56,11 @@ export default class Selection { * const position = new Position( root, path ); * const selection = new Selection( position ); * - * // Creates selection inside the node. + * // Creates selection inside the given node. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'in', { backward } ); * - * // Creates selection on the node. + * // Creates selection on the given node. * const paragraph = writer.createElement( 'paragraph' ); * selection.setTo( paragraph, 'on', { backward } ); * @@ -71,9 +71,9 @@ export default class Selection { * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/element~Element| * Iterable.|module:engine/model/range~Range|null} selectable - * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] + * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. * @param {Object} [options] - * @param {Boolean} [options.backward] + * @param {Boolean} [options.backward] Sets this selection instance to be backward. */ constructor( selectable, placeOrOffset, options ) { /** @@ -336,7 +336,7 @@ export default class Selection { * // Sets collapsed selection at the position of the given node and an offset. * selection.setTo( paragraph, offset ); * - * // Sets selection inside the given node. + * // Sets selection inside the given node. * selection.setTo( paragraph, 'in', { backward } ); * * // Sets selection on the given node. diff --git a/src/view/selection.js b/src/view/selection.js index 233b5e4a5..c90771ef0 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -41,11 +41,11 @@ export default class Selection { * * // Creates selection at the given range. * const range = new Range( start, end ); - * const selection = new Selection( range, { backward, fake, label } ); + * const selection = new Selection( range ); * * // Creates selection at the given ranges * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * const selection = new Selection( ranges, { backward, fake, label } ); + * const selection = new Selection( ranges ); * * // Creates selection from the other selection. * const otherSelection = new Selection(); @@ -53,19 +53,34 @@ export default class Selection { * * // Creates selection at the given position. * const position = new Position( root, path ); - * const selection = new Selection( position, { fake, label } ); + * const selection = new Selection( position ); * - * // Sets collapsed selection at the position of given item and offset. + * // Creates collapsed selection at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, offset, { fake, label } ); + * const selection = new Selection( paragraph, offset ); * - * // Sets selection inside the item. + * // Creates selection inside the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in', { backward, fake, label } ); + * const selection = new Selection( paragraph, 'in' ); * - * // Sets selection on the item. + * // Creates selection on the item. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on', { backward, fake, label } ); + * const selection = new Selection( paragraph, 'on' ); + * + * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument. + * + * // Creates backward selection. + * const selection = new Selection( range, { backward: true } ); + * + * // Creates fake selection. + * // Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * // This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * // represented in other way, for example by applying proper CSS class. + * const selection = new Selection( range, { fake: true } ); + * + * // Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM + * // (and be properly handled by screen readers). + * const selection = new Selection( range, { fake: true, label: 'foo' } ); * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} [selectable=null] @@ -404,18 +419,13 @@ export default class Selection { * {@link module:engine/view/item~Item item}, {@link module:engine/view/range~Range range}, * an iterable of {@link module:engine/view/range~Range ranges} or null. * - * This method provides option to create a fake selection. - * Fake selection does not render as browser native selection over selected elements and is hidden to the user. - * This way, no native selection UI artifacts are displayed to the user and selection over elements can be - * represented in other way, for example by applying proper CSS class. - * * // Sets selection to the given range. * const range = new Range( start, end ); - * selection.setTo( range, { backward, fake, label } ); + * selection.setTo( range ); * * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * selection.setTo( range, { backward, fake, label } ); + * selection.setTo( range ); * * // Sets selection to the other selection. * const otherSelection = new Selection(); @@ -423,20 +433,35 @@ export default class Selection { * * // Sets collapsed selection at the given position. * const position = new Position( root, path ); - * selection.setTo( position, { fake, label } ); + * selection.setTo( position ); * * // Sets collapsed selection at the position of given item and offset. - * selection.setTo( paragraph, offset, { fake, label } ); + * selection.setTo( paragraph, offset ); * * // Sets selection inside the item. - * selection.setTo( paragraph, 'in', { backward, fake, label } ); + * selection.setTo( paragraph, 'in' ); * * // Sets selection on the item. - * selection.setTo( paragraph, 'on', { backward, fake, label } ); + * selection.setTo( paragraph, 'on' ); * * // Clears selection. Removes all ranges. * selection.setTo( null ); * + * `Selection#setTo()` method allow passing additional options (`backward`, `fake` and `label`) as the last argument. + * + * // Sets selection as backward. + * selection.setTo( range, { backward: true } ); + * + * // Sets selection as fake. + 8 // Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * // This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * // represented in other way, for example by applying proper CSS class. + * selection.setTo( range, { fake: true } ); + * + * // Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM + * // (and be properly handled by screen readers). + * selection.setTo( range, { fake: true, label: 'foo' } ); + * * @protected * @fires change * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| diff --git a/src/view/writer.js b/src/view/writer.js index a41802810..9b2947ad4 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -36,23 +36,19 @@ export default class Writer { * {@link module:engine/view/item~Item item}, {@link module:engine/view/range~Range range}, * an iterable of {@link module:engine/view/range~Range ranges} or null. * - * This method provides option to create a fake selection. - * Fake selection does not render as browser native selection over selected elements and is hidden to the user. - * This way, no native selection UI artifacts are displayed to the user and selection over elements can be - * represented in other way, for example by applying proper CSS class. - * - * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM (and be - * properly handled by screen readers). - * - * Usage: + * ### Usage: * * // Sets selection to the given range. * const range = new Range( start, end ); - * writer.setSelection( range, { backward, fake, label } ); + * writer.setSelection( range ); + * + * // Sets backward selection to the given range. + * const range = new Range( start, end ); + * writer.setSelection( range ); * * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * writer.setSelection( range, { backward, fake, label } ); + * writer.setSelection( range ); * * // Sets selection to the other selection. * const otherSelection = new Selection(); @@ -60,20 +56,35 @@ export default class Writer { * * // Sets collapsed selection at the given position. * const position = new Position( root, path ); - * writer.setSelection( position, { fake, label } ); + * writer.setSelection( position ); * * // Sets collapsed selection at the position of given item and offset. - * selection.setTo( paragraph, offset, { fake, label } ); + * writer.setSelection( paragraph, offset ); * * // Sets selection inside the item. - * selection.setTo( paragraph, 'in', { backward, fake, label } ); + * writer.setSelection( paragraph, 'in' ); * * // Sets selection on the item. - * selection.setTo( paragraph, 'on', { backward, fake, label } ); + * writer.setSelection( paragraph, 'on' ); * * // Removes all ranges. * writer.setSelection( null ); * + * `Writer#setSelection()` allow passing additional options (`backward`, `fake` and `label`) as the last argument. + * + * // Sets selection as backward. + * writer.setSelection( range, { backward: true } ); + * + * // Sets selection as fake. + * // Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * // This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * // represented in other way, for example by applying proper CSS class. + * writer.setSelection( range, { fake: true } ); + * + * // Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM + * // (and be properly handled by screen readers). + * writer.setSelection( range, { fake: true, label: 'foo' } ); + * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| * Iterable.|module:engine/view/range~Range|module:engine/view/item~Item|null} selectable * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection. From 898d733e4026de8c2ee7305c268bd9417471928d Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Tue, 6 Mar 2018 14:35:59 +0100 Subject: [PATCH 685/724] Docs improvements. --- src/model/selection.js | 44 ++++++++++++++++++++++++++++-------------- src/model/writer.js | 20 +++++++++++++------ src/view/selection.js | 16 ++++++++++----- src/view/writer.js | 11 +++++++---- 4 files changed, 62 insertions(+), 29 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 82fbade2c..523dcf8d5 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -36,11 +36,11 @@ export default class Selection { * * // Creates selection at the given range. * const range = new Range( start, end ); - * const selection = new Selection( range, { backward } ); + * const selection = new Selection( range ); * * // Creates selection at the given ranges * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * const selection = new Selection( ranges, { backward } ); + * const selection = new Selection( ranges ); * * // Creates selection from the other selection. * // Note: It doesn't copies selection attributes. @@ -56,18 +56,26 @@ export default class Selection { * const position = new Position( root, path ); * const selection = new Selection( position ); * - * // Creates selection inside the given node. + * Creates a range inside an {@link module:engine/model/element~Element element} which starts before the first child of + * that element and ends after the last child of that element. + * * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'in', { backward } ); + * const selection = new Selection( paragraph, 'in' ); + * + * Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends just after the item. * - * // Creates selection on the given node. * const paragraph = writer.createElement( 'paragraph' ); - * selection.setTo( paragraph, 'on', { backward } ); + * const selection = new Selection( paragraph, 'on' ); * * // Creates selection at the start position of the given element. * const paragraph = writer.createElement( 'paragraph' ); * const selection = new Selection( paragraph, offset ); * + * `Selection`'s constructor allow passing additional options (`backward`) as the last argument. + * + * // Creates backward selection. + * const selection = new Selection( range, { backward: true } ); + * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/element~Element| * Iterable.|module:engine/model/range~Range|null} selectable @@ -311,13 +319,16 @@ export default class Selection { * {@link module:engine/model/element~Element element}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * + * // Removes all selection's ranges. + * selection.setTo( null ); + * * // Sets selection to the given range. * const range = new Range( start, end ); - * selection.setTo( range, { backward } ); + * selection.setTo( range ); * * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * selection.setTo( ranges, { backward } ); + * selection.setTo( ranges ); * * // Sets selection to other selection. * // Note: It doesn't copies selection attributes. @@ -336,14 +347,19 @@ export default class Selection { * // Sets collapsed selection at the position of the given node and an offset. * selection.setTo( paragraph, offset ); * - * // Sets selection inside the given node. - * selection.setTo( paragraph, 'in', { backward } ); + * Creates a range inside an {@link module:engine/model/element~Element element} which starts before the first child of + * that element and ends after the last child of that element. * - * // Sets selection on the given node. - * selection.setTo( paragraph, 'on', { backward } ); + * selection.setTo( paragraph, 'in' ); * - * // Removes all selection's ranges. - * selection.setTo( null ); + * Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends just after the item. + * + * selection.setTo( paragraph, 'on' ); + * + * `Selection#setTo()`' method allow passing additional options (`backward`) as the last argument. + * + * // Sets backward selection. + * const selection = new Selection( range, { backward: true } ); * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| * module:engine/model/position~Position|module:engine/model/node~Node| diff --git a/src/model/writer.js b/src/model/writer.js index e38be8e7c..ac1dd0629 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -907,11 +907,11 @@ export default class Writer { * * // Sets selection to the given range. * const range = new Range( start, end ); - * writer.setSelection( range, { backward } ); + * writer.setSelection( range ); * * // Sets selection to given ranges. * const ranges = [ new Range( start1, end2 ), new Range( star2, end2 ) ]; - * writer.setSelection( range, { backward } ); + * writer.setSelection( range ); * * // Sets selection to other selection. * const otherSelection = new Selection(); @@ -928,15 +928,23 @@ export default class Writer { * // Sets collapsed selection at the position of the given node and an offset. * writer.setSelection( paragraph, offset ); * - * // Sets selection inside the given node. - * writer.setSelection( paragraph, 'in', { backward } ); + * Creates a range inside an {@link module:engine/model/element~Element element} which starts before the first child of + * that element and ends after the last child of that element. * - * // Sets selection on the given node. - * writer.setSelection( paragraph, 'on', { backward } ); + * writer.setSelection( paragraph, 'in' ); + * + * Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends just after the item. + * + * writer.setSelection( paragraph, 'on' ); * * // Removes all selection's ranges. * writer.setSelection( null ); * + * `Writer#setSelection()` allow passing additional options (`backward`) as the last argument. + * + * // Sets selection as backward. + * writer.setSelection( range, { backward: true } ); + * * Throws `writer-incorrect-use` error when the writer is used outside the `change()` block. * * @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection| diff --git a/src/view/selection.js b/src/view/selection.js index c90771ef0..3446fa939 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -59,11 +59,14 @@ export default class Selection { * const paragraph = writer.createElement( 'paragraph' ); * const selection = new Selection( paragraph, offset ); * - * // Creates selection inside the item. + * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of + * that element and ends after the last child of that element. + * * const paragraph = writer.createElement( 'paragraph' ); * const selection = new Selection( paragraph, 'in' ); * - * // Creates selection on the item. + * Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends just after the item. + * * const paragraph = writer.createElement( 'paragraph' ); * const selection = new Selection( paragraph, 'on' ); * @@ -438,10 +441,13 @@ export default class Selection { * // Sets collapsed selection at the position of given item and offset. * selection.setTo( paragraph, offset ); * - * // Sets selection inside the item. + * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of + * that element and ends after the last child of that element. + * * selection.setTo( paragraph, 'in' ); * - * // Sets selection on the item. + * Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends just after the item. + * * selection.setTo( paragraph, 'on' ); * * // Clears selection. Removes all ranges. @@ -453,7 +459,7 @@ export default class Selection { * selection.setTo( range, { backward: true } ); * * // Sets selection as fake. - 8 // Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * // Fake selection does not render as browser native selection over selected elements and is hidden to the user. * // This way, no native selection UI artifacts are displayed to the user and selection over elements can be * // represented in other way, for example by applying proper CSS class. * selection.setTo( range, { fake: true } ); diff --git a/src/view/writer.js b/src/view/writer.js index 9b2947ad4..54449d3fe 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -61,16 +61,19 @@ export default class Writer { * // Sets collapsed selection at the position of given item and offset. * writer.setSelection( paragraph, offset ); * - * // Sets selection inside the item. - * writer.setSelection( paragraph, 'in' ); + * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of + * that element and ends after the last child of that element. + * + * writer.setSelection( paragraph, 'in' ); + * + * Creates a range on the {@link module:engine/view/item~Item item} which starts before the item and ends just after the item. * - * // Sets selection on the item. * writer.setSelection( paragraph, 'on' ); * * // Removes all ranges. * writer.setSelection( null ); * - * `Writer#setSelection()` allow passing additional options (`backward`, `fake` and `label`) as the last argument. + * `Writer#setSelection()` allow passing additional options (`backward`, `fake` and `label`) as the last argument. * * // Sets selection as backward. * writer.setSelection( range, { backward: true } ); From 5272858fe361824b3c24bd0eed18ae531b9a420d Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Tue, 6 Mar 2018 14:46:00 +0100 Subject: [PATCH 686/724] "view.Text#data" should be protected too. --- src/view/text.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/view/text.js b/src/view/text.js index fb796a09f..ed72ca2e7 100644 --- a/src/view/text.js +++ b/src/view/text.js @@ -32,7 +32,7 @@ export default class Text extends Node { * * Setting the data fires the {@link module:engine/view/node~Node#event:change:text change event}. * - * @private + * @protected * @member {String} module:engine/view/text~Text#_data */ this._data = data; From bca495f12e8119a25d4fffdbe545d3dd9691c337 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 6 Mar 2018 09:19:55 +0100 Subject: [PATCH 687/724] Changed: It should not be possible to move node from document to document fragment. --- src/model/writer.js | 10 ++++-- tests/model/writer.js | 78 ++++++++++++++++--------------------------- 2 files changed, 36 insertions(+), 52 deletions(-) diff --git a/src/model/writer.js b/src/model/writer.js index 4df67ba58..f7e7fb622 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -144,6 +144,9 @@ export default class Writer { * * Note that if the item already has parent it will be removed from the previous parent. * + * Note that you cannot re-insert a node from a document to a different document or document fragment. In this case, + * `model-writer-insert-forbidden-move` is thrown. + * * If you want to move {@link module:engine/model/range~Range range} instead of an * {@link module:engine/model/item~Item item} use {@link module:engine/model/writer~Writer#move move}. * @@ -172,8 +175,11 @@ export default class Writer { } // If it isn't the same root. else { - // We need to remove this item from old position first. - this.remove( item ); + if ( item.root.document ) { + throw new Error( 'model-writer-insert-forbidden-move: Cannot move a node from a document to a different tree.' ); + } else { + this.remove( item ); + } } } diff --git a/tests/model/writer.js b/tests/model/writer.js index f2490df29..ab5255830 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -258,29 +258,6 @@ describe( 'Writer', () => { expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { - const root = doc.createRoot(); - const docFrag = createDocumentFragment(); - const node = createText( 'foo' ); - - insert( node, root ); - - const spy = sinon.spy( model, 'applyOperation' ); - - insert( node, docFrag ); - - // Verify result. - expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { const docFragA = createDocumentFragment(); const docFragB = createDocumentFragment(); @@ -304,6 +281,18 @@ describe( 'Writer', () => { expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); + it( 'should throw when moving element from document to document fragment', () => { + const root = doc.createRoot(); + const docFrag = createDocumentFragment(); + const node = createText( 'foo' ); + + insert( node, root ); + + expect( () => { + insert( node, docFrag ); + } ).to.throw(); + } ); + it( 'should transfer markers from given DocumentFragment', () => { const root = doc.createRoot(); @@ -608,7 +597,7 @@ describe( 'Writer', () => { expect( spy.lastCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within the same document (documentA -> documentA)', () => { + it( 'should move element from one parent to the other within the same root (rootA -> rootA)', () => { const rootA = doc.createRoot(); const parent1 = createElement( 'parent' ); @@ -633,7 +622,7 @@ describe( 'Writer', () => { expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within the same document (documentA -> documentB)', () => { + it( 'should move element from one parent to the other within the same document (rootA -> rootB)', () => { const rootA = doc.createRoot( '$root', 'A' ); const rootB = doc.createRoot( '$root', 'B' ); const node = createText( 'foo' ); @@ -654,7 +643,7 @@ describe( 'Writer', () => { expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within the same document (docFragA -> docFragA)', () => { + it( 'should move element from one parent to the other within the same document fragment (docFragA -> docFragA)', () => { const docFragA = createDocumentFragment(); const parent1 = createElement( 'parent' ); const parent2 = createElement( 'parent' ); @@ -678,30 +667,7 @@ describe( 'Writer', () => { expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); - it( 'should move element from one parent to the other within different document (document -> docFrag)', () => { - const root = doc.createRoot(); - const docFrag = createDocumentFragment(); - const node = createText( 'foo' ); - - insert( node, root ); - - const spy = sinon.spy( model, 'applyOperation' ); - - append( node, docFrag ); - - // Verify result. - expect( Array.from( root.getChildren() ) ).to.deep.equal( [] ); - expect( Array.from( docFrag.getChildren() ) ).to.deep.equal( [ node ] ); - - // Verify deltas and operations. - sinon.assert.calledTwice( spy ); - expect( spy.firstCall.args[ 0 ].type ).to.equal( 'remove' ); - expect( spy.firstCall.args[ 0 ].delta.batch ).to.equal( batch ); - expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); - expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); - } ); - - it( 'should move element from one parent to the other within different document (docFragA -> docFragB)', () => { + it( 'should move element from one parent to the other within different document fragments (docFragA -> docFragB)', () => { const docFragA = createDocumentFragment(); const docFragB = createDocumentFragment(); const node = createText( 'foo' ); @@ -723,6 +689,18 @@ describe( 'Writer', () => { expect( spy.secondCall.args[ 0 ].type ).to.equal( 'insert' ); expect( spy.secondCall.args[ 0 ].delta.batch ).to.equal( batch ); } ); + + it( 'should throw when moving element from document to document fragment', () => { + const root = doc.createRoot(); + const docFrag = createDocumentFragment(); + const node = createText( 'foo' ); + + insert( node, root ); + + expect( () => { + append( node, docFrag ); + } ).to.throw(); + } ); } ); describe( 'appendText()', () => { From 2811575df3bab762422a351f6b6ec6af980a68d2 Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Tue, 6 Mar 2018 15:32:05 +0100 Subject: [PATCH 688/724] Docs: Added more explanation. --- src/model/writer.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/model/writer.js b/src/model/writer.js index f7e7fb622..aee0b05fc 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -176,8 +176,11 @@ export default class Writer { // If it isn't the same root. else { if ( item.root.document ) { + // It is forbidden to move a node that was already in a document outside of it. throw new Error( 'model-writer-insert-forbidden-move: Cannot move a node from a document to a different tree.' ); } else { + // Move between two different document fragments or from document fragment to a document is possible. + // In that case, remove the item from it's original parent. this.remove( item ); } } From 9a614aacc12d454ad7708b1563c3befd36804f64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Tue, 6 Mar 2018 16:43:43 +0100 Subject: [PATCH 689/724] Improved docs in DocumentSelection. --- src/model/documentselection.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 34f007cd5..69c78fe14 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -999,8 +999,11 @@ function getAttrsIfCharacter( node ) { } // Removes selection attributes from element which is not empty anymore. +// +// @private +// @param {module:engine/model/model~Model} model +// @param {module:engine/model/batch~Batch} batch function clearAttributesStoredInElement( model, batch ) { - // Clear attributes stored in selection; const differ = model.document.differ; for ( const entry of differ.getChanges() ) { From cf27c1cf0ec0c96180a4a18425cc399607ecfacb Mon Sep 17 00:00:00 2001 From: Piotr Jasiun Date: Tue, 6 Mar 2018 17:21:06 +0100 Subject: [PATCH 690/724] Docs polishing. --- src/model/selection.js | 17 +++++++---------- src/view/selection.js | 41 +++++++++++++++++++---------------------- 2 files changed, 26 insertions(+), 32 deletions(-) diff --git a/src/model/selection.js b/src/model/selection.js index 523dcf8d5..eca269804 100644 --- a/src/model/selection.js +++ b/src/model/selection.js @@ -56,21 +56,18 @@ export default class Selection { * const position = new Position( root, path ); * const selection = new Selection( position ); * - * Creates a range inside an {@link module:engine/model/element~Element element} which starts before the first child of - * that element and ends after the last child of that element. - * + * // Creates selection at the start position of the given element. * const paragraph = writer.createElement( 'paragraph' ); - * const selection = new Selection( paragraph, 'in' ); + * const selection = new Selection( paragraph, offset ); * - * Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends just after the item. + * // Creates a range inside an {@link module:engine/model/element~Element element} which starts before the + * // first child of that element and ends after the last child of that element. + * const selection = new Selection( paragraph, 'in' ); * - * const paragraph = writer.createElement( 'paragraph' ); + * // Creates a range on an {@link module:engine/model/item~Item item} which starts before the item and ends + * // just after the item. * const selection = new Selection( paragraph, 'on' ); * - * // Creates selection at the start position of the given element. - * const paragraph = writer.createElement( 'paragraph' ); - * const selection = new Selection( paragraph, offset ); - * * `Selection`'s constructor allow passing additional options (`backward`) as the last argument. * * // Creates backward selection. diff --git a/src/view/selection.js b/src/view/selection.js index 3446fa939..6e5470a90 100644 --- a/src/view/selection.js +++ b/src/view/selection.js @@ -55,19 +55,16 @@ export default class Selection { * const position = new Position( root, path ); * const selection = new Selection( position ); * - * // Creates collapsed selection at the position of given item and offset. + * // Creates collapsed selection at the position of given item and offset. * const paragraph = writer.createElement( 'paragraph' ); * const selection = new Selection( paragraph, offset ); * - * Creates a range inside an {@link module:engine/view/element~Element element} which starts before the first child of - * that element and ends after the last child of that element. - * - * const paragraph = writer.createElement( 'paragraph' ); + * // Creates a range inside an {@link module:engine/view/element~Element element} which starts before the + * // first child of that element and ends after the last child of that element. * const selection = new Selection( paragraph, 'in' ); * - * Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends just after the item. - * - * const paragraph = writer.createElement( 'paragraph' ); + * // Creates a range on an {@link module:engine/view/item~Item item} which starts before the item and ends + * // just after the item. * const selection = new Selection( paragraph, 'on' ); * * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument. @@ -75,14 +72,14 @@ export default class Selection { * // Creates backward selection. * const selection = new Selection( range, { backward: true } ); * - * // Creates fake selection. - * // Fake selection does not render as browser native selection over selected elements and is hidden to the user. - * // This way, no native selection UI artifacts are displayed to the user and selection over elements can be - * // represented in other way, for example by applying proper CSS class. - * const selection = new Selection( range, { fake: true } ); + * Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * represented in other way, for example by applying proper CSS class. * - * // Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM - * // (and be properly handled by screen readers). + * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM + * (and be properly handled by screen readers). + * + * // Creates fake selection with label. * const selection = new Selection( range, { fake: true, label: 'foo' } ); * * @param {module:engine/view/selection~Selection|module:engine/view/position~Position| @@ -458,14 +455,14 @@ export default class Selection { * // Sets selection as backward. * selection.setTo( range, { backward: true } ); * - * // Sets selection as fake. - * // Fake selection does not render as browser native selection over selected elements and is hidden to the user. - * // This way, no native selection UI artifacts are displayed to the user and selection over elements can be - * // represented in other way, for example by applying proper CSS class. - * selection.setTo( range, { fake: true } ); + * Fake selection does not render as browser native selection over selected elements and is hidden to the user. + * This way, no native selection UI artifacts are displayed to the user and selection over elements can be + * represented in other way, for example by applying proper CSS class. + * + * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM + * (and be properly handled by screen readers). * - * // Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM - * // (and be properly handled by screen readers). + * // Creates fake selection with label. * selection.setTo( range, { fake: true, label: 'foo' } ); * * @protected From 644802e79fb4643066b2c09803c694df56718a1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Tue, 6 Mar 2018 17:51:54 +0100 Subject: [PATCH 691/724] Docs: Fixed API docs. --- src/model/documentselection.js | 2 +- src/model/writer.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index c1c69cf9d..72774827e 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -348,7 +348,7 @@ export default class DocumentSelection { /** * Sets this selection's ranges and direction to the specified location based on the given * {@link module:engine/model/selection~Selection selection}, {@link module:engine/model/position~Position position}, - * {@link module:engine/model/element~Node node}, {@link module:engine/model/position~Position position}, + * {@link module:engine/model/node~Node node}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * Should be used only within the {@link module:engine/model/writer~Writer#setSelection} method. * diff --git a/src/model/writer.js b/src/model/writer.js index bae52f646..e7cd3aea5 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -911,7 +911,7 @@ export default class Writer { /** * Sets this selection's ranges and direction to the specified location based on the given * {@link module:engine/model/selection~Selection selection}, {@link module:engine/model/position~Position position}, - * {@link module:engine/model/element~Node node}, {@link module:engine/model/position~Position position}, + * {@link module:engine/model/node~Node node}, {@link module:engine/model/position~Position position}, * {@link module:engine/model/range~Range range}, an iterable of {@link module:engine/model/range~Range ranges} or null. * * // Sets selection to the given range. From bf2f76a403ab933ae9955ead24fc7a7dbec52760 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 7 Mar 2018 10:17:15 +0100 Subject: [PATCH 692/724] "view.Text#data" is protected now. --- src/dev-utils/view.js | 2 +- src/view/text.js | 57 ++++++++++++++++++++++++++++++------------ src/view/writer.js | 4 +-- tests/view/node.js | 6 ++--- tests/view/renderer.js | 12 ++++----- tests/view/text.js | 12 +++++++-- 6 files changed, 63 insertions(+), 30 deletions(-) diff --git a/src/dev-utils/view.js b/src/dev-utils/view.js index fe9f18553..a2b7cc6fd 100644 --- a/src/dev-utils/view.js +++ b/src/dev-utils/view.js @@ -449,7 +449,7 @@ class RangeParser { } text = text.replace( regexp, '' ); - node.data = text; + node._data = text; const index = node.index; const parent = node.parent; diff --git a/src/view/text.js b/src/view/text.js index ed72ca2e7..1d1a92f3f 100644 --- a/src/view/text.js +++ b/src/view/text.js @@ -33,19 +33,9 @@ export default class Text extends Node { * Setting the data fires the {@link module:engine/view/node~Node#event:change:text change event}. * * @protected - * @member {String} module:engine/view/text~Text#_data + * @member {String} module:engine/view/text~Text#_textData */ - this._data = data; - } - - /** - * Clones this node. - * - * @protected - * @returns {module:engine/view/text~Text} Text node that is a clone of this node. - */ - _clone() { - return new Text( this.data ); + this._textData = data; } /** @@ -58,16 +48,41 @@ export default class Text extends Node { /** * The text content. * - * Setting the data fires the {@link module:engine/view/node~Node#event:change:text change event}. + * @returns {String} */ get data() { - return this._data; + return this._textData; } - set data( data ) { + /** + * This getter is required when using the addition assignment operator on protected property: + * + * const foo = new Text( 'foo' ); + * const bar = new Text( 'bar' ); + * + * foo._data += bar.data; // executes: `foo._data = foo._data + bar.data` + * console.log( foo.data ); // prints: 'foobar' + * + * If the protected getter didn't exist, `foo._data` will return `undefined` and result of the merge will be invalid. + * + * @protected + * @returns {String} + */ + get _data() { + return this.data; + } + + /** + * Sets data and fires the {@link module:engine/view/node~Node#event:change:text change event}. + * + * @protected + * @fires change:text + * @param {String} data New data for the text node. + */ + set _data( data ) { this._fireChange( 'text', this ); - this._data = data; + this._textData = data; } /** @@ -84,4 +99,14 @@ export default class Text extends Node { return this === otherNode || this.data === otherNode.data; } + + /** + * Clones this node. + * + * @protected + * @returns {module:engine/view/text~Text} Text node that is a clone of this node. + */ + _clone() { + return new Text( this.data ); + } } diff --git a/src/view/writer.js b/src/view/writer.js index 0b66c0ad5..ff247e49e 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -1482,7 +1482,7 @@ function breakTextNode( position ) { const textToMove = position.parent.data.slice( position.offset ); // Leave rest of the text in position's parent. - position.parent.data = position.parent.data.slice( 0, position.offset ); + position.parent._data = position.parent.data.slice( 0, position.offset ); // Insert new text node after position's parent text node. position.parent.parent._insertChildren( position.parent.index + 1, new Text( textToMove ) ); @@ -1500,7 +1500,7 @@ function breakTextNode( position ) { function mergeTextNodes( t1, t2 ) { // Merge text data into first text node and remove second one. const nodeBeforeLength = t1.data.length; - t1.data += t2.data; + t1._data += t2.data; t2._remove(); return new Position( t1, nodeBeforeLength ); diff --git a/tests/view/node.js b/tests/view/node.js index 58261fa4c..b8c94d0b8 100644 --- a/tests/view/node.js +++ b/tests/view/node.js @@ -289,7 +289,7 @@ describe( 'Node', () => { const parsed = JSON.parse( json ); expect( parsed ).to.deep.equal( { - _data: 'a' + _textData: 'a' } ); } ); } ); @@ -380,9 +380,9 @@ describe( 'Node', () => { } ); } ); - describe( '_removeChildren()', () => { + describe( 'setText', () => { it( 'should fire change event', () => { - text.data = 'bar'; + text._data = 'bar'; sinon.assert.calledOnce( rootChangeSpy ); sinon.assert.calledWith( rootChangeSpy, 'text', text ); diff --git a/tests/view/renderer.js b/tests/view/renderer.js index 2bd1b2c68..419c4decb 100644 --- a/tests/view/renderer.js +++ b/tests/view/renderer.js @@ -80,7 +80,7 @@ describe( 'Renderer', () => { it( 'should mark text which need update', () => { const viewText = new ViewText( 'foo' ); viewRoot._appendChildren( viewText ); - viewText.data = 'bar'; + viewText._data = 'bar'; renderer.markToSync( 'text', viewText ); @@ -93,7 +93,7 @@ describe( 'Renderer', () => { viewRoot = new ViewElement( 'p' ); viewRoot._appendChildren( viewText ); - viewText.data = 'bar'; + viewText._data = 'bar'; renderer.markToSync( 'text', viewText ); @@ -205,7 +205,7 @@ describe( 'Renderer', () => { expect( domRoot.childNodes.length ).to.equal( 1 ); expect( domRoot.childNodes[ 0 ].data ).to.equal( 'foo' ); - viewText.data = 'bar'; + viewText._data = 'bar'; renderer.markToSync( 'text', viewText ); renderer.render(); @@ -1914,7 +1914,7 @@ describe( 'Renderer', () => { writer.unwrap( viewDoc.selection.getFirstRange(), new ViewAttributeElement( 'italic' ) ); } ); - viewRoot.getChild( 0 ).getChild( 0 ).getChild( 0 ).data = 'bar'; + viewRoot.getChild( 0 ).getChild( 0 ).getChild( 0 )._data = 'bar'; expect( getViewData( view ) ).to.equal( '

[bar]

' ); // Re-render changes in view to DOM. @@ -1935,7 +1935,7 @@ describe( 'Renderer', () => { // Change text and insert new element into paragraph. const textNode = viewRoot.getChild( 0 ).getChild( 0 ); - textNode.data = 'foobar'; + textNode._data = 'foobar'; view.change( writer => { writer.insert( ViewPosition.createAfter( textNode ), new ViewAttributeElement( 'img' ) ); @@ -1961,7 +1961,7 @@ describe( 'Renderer', () => { // Change text and insert new element into paragraph. const textNode = viewRoot.getChild( 0 ).getChild( 0 ); - textNode.data = 'foobar'; + textNode._data = 'foobar'; view.change( writer => { writer.insert( ViewPosition.createBefore( textNode ), new ViewAttributeElement( 'img' ) ); diff --git a/tests/view/text.js b/tests/view/text.js index 914b408f6..3acd9fc81 100644 --- a/tests/view/text.js +++ b/tests/view/text.js @@ -70,7 +70,7 @@ describe( 'Text', () => { it( 'should return false when data is not the same', () => { const other = text._clone(); - other.data = 'not-foo'; + other._data = 'not-foo'; expect( text.isSimilar( other ) ).to.be.false; } ); @@ -79,9 +79,17 @@ describe( 'Text', () => { describe( 'setText', () => { it( 'should change the text', () => { const text = new Text( 'foo' ); - text.data = 'bar'; + text._data = 'bar'; expect( text.data ).to.equal( 'bar' ); } ); + + it( 'works when using addition assignment operator (+=)', () => { + const foo = new Text( 'foo' ); + const bar = new Text( 'bar' ); + + foo._data += bar.data; + expect( foo.data ).to.equal( 'foobar' ); + } ); } ); } ); From 65c3fbd88288d6a9d05393d5b5226d8c7f23af70 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 7 Mar 2018 10:23:19 +0100 Subject: [PATCH 693/724] Changed order of the methods in code. --- src/model/element.js | 28 +++++++------- src/model/node.js | 50 ++++++++++++------------- src/model/text.js | 20 +++++----- src/view/attributeelement.js | 24 ++++++------ src/view/element.js | 72 ++++++++++++++++++------------------ 5 files changed, 97 insertions(+), 97 deletions(-) diff --git a/src/model/element.js b/src/model/element.js index 98762f3a3..80268d611 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -156,20 +156,6 @@ export default class Element extends Node { return this._children.getNodeStartOffset( node ); } - /** - * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element. - * If clone is deep, the original element's children are also cloned. If not, then empty element is removed. - * - * @protected - * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`, - * element will be cloned without any child. - */ - _clone( deep = false ) { - const children = deep ? Array.from( this._children ).map( node => node._clone( true ) ) : null; - - return new Element( this.name, this.getAttributes(), children ); - } - /** * Returns index of a node that occupies given offset. If given offset is too low, returns `0`. If given offset is * too high, returns {@link module:engine/model/element~Element#getChildIndex index after last child}. @@ -233,6 +219,20 @@ export default class Element extends Node { return json; } + /** + * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element. + * If clone is deep, the original element's children are also cloned. If not, then empty element is removed. + * + * @protected + * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`, + * element will be cloned without any child. + */ + _clone( deep = false ) { + const children = deep ? Array.from( this._children ).map( node => node._clone( true ) ) : null; + + return new Element( this.name, this.getAttributes(), children ); + } + /** * {@link module:engine/model/element~Element#_insertChildren Inserts} one or more nodes at the end of this element. * diff --git a/src/model/node.js b/src/model/node.js index 126d15514..bf3a17b18 100644 --- a/src/model/node.js +++ b/src/model/node.js @@ -201,16 +201,6 @@ export default class Node { return this.root.document || null; } - /** - * Creates a copy of this node, that is a node with exactly same attributes, and returns it. - * - * @protected - * @returns {module:engine/model/node~Node} Node with same attributes as this node. - */ - _clone() { - return new Node( this._attrs ); - } - /** * Gets path to the node. The path is an array containing starting offsets of consecutive ancestors of this node, * beginning from {@link module:engine/model/node~Node#root root}, down to this node's starting offset. The path can be used to @@ -324,6 +314,31 @@ export default class Node { return this._attrs.keys(); } + /** + * Converts `Node` to plain object and returns it. + * + * @returns {Object} `Node` converted to plain object. + */ + toJSON() { + const json = {}; + + if ( this._attrs.size ) { + json.attributes = [ ...this._attrs ]; + } + + return json; + } + + /** + * Creates a copy of this node, that is a node with exactly same attributes, and returns it. + * + * @protected + * @returns {module:engine/model/node~Node} Node with same attributes as this node. + */ + _clone() { + return new Node( this._attrs ); + } + /** * Removes this node from it's parent. * @@ -374,21 +389,6 @@ export default class Node { this._attrs.clear(); } - /** - * Converts `Node` to plain object and returns it. - * - * @returns {Object} `Node` converted to plain object. - */ - toJSON() { - const json = {}; - - if ( this._attrs.size ) { - json.attributes = [ ...this._attrs ]; - } - - return json; - } - /** * Checks whether given model tree object is of given type. * diff --git a/src/model/text.js b/src/model/text.js index 3877c3f3b..0041b860f 100644 --- a/src/model/text.js +++ b/src/model/text.js @@ -68,16 +68,6 @@ export default class Text extends Node { return type == 'text'; } - /** - * Creates a copy of this text node and returns it. Created text node has same text data and attributes as original text node. - * - * @protected - * @returns {module:engine/model/text~Text} `Text` instance created using given plain object. - */ - _clone() { - return new Text( this.data, this.getAttributes() ); - } - /** * Converts `Text` instance to plain object and returns it. * @@ -91,6 +81,16 @@ export default class Text extends Node { return json; } + /** + * Creates a copy of this text node and returns it. Created text node has same text data and attributes as original text node. + * + * @protected + * @returns {module:engine/model/text~Text} `Text` instance created using given plain object. + */ + _clone() { + return new Text( this.data, this.getAttributes() ); + } + /** * Creates a `Text` instance from given plain object (i.e. parsed JSON string). * diff --git a/src/view/attributeelement.js b/src/view/attributeelement.js index 64f36358d..e19426521 100644 --- a/src/view/attributeelement.js +++ b/src/view/attributeelement.js @@ -72,6 +72,18 @@ export default class AttributeElement extends Element { } } + /** + * Checks if this element is similar to other element. + * Both elements should have the same name, attributes and priority to be considered as similar. + * Two similar elements can contain different set of children nodes. + * + * @param {module:engine/view/element~Element} otherElement + * @returns {Boolean} + */ + isSimilar( otherElement ) { + return super.isSimilar( otherElement ) && this.priority == otherElement.priority; + } + /** * Clones provided element with priority. * @@ -88,18 +100,6 @@ export default class AttributeElement extends Element { return cloned; } - - /** - * Checks if this element is similar to other element. - * Both elements should have the same name, attributes and priority to be considered as similar. - * Two similar elements can contain different set of children nodes. - * - * @param {module:engine/view/element~Element} otherElement - * @returns {Boolean} - */ - isSimilar( otherElement ) { - return super.isSimilar( otherElement ) && this.priority == otherElement.priority; - } } /** diff --git a/src/view/element.js b/src/view/element.js index c2e6a4095..e806dec4c 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -158,42 +158,6 @@ export default class Element extends Node { } } - /** - * Clones provided element. - * - * @protected - * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`, - * element will be cloned without any children. - * @returns {module:engine/view/element~Element} Clone of this element. - */ - _clone( deep = false ) { - const childrenClone = []; - - if ( deep ) { - for ( const child of this.getChildren() ) { - childrenClone.push( child._clone( deep ) ); - } - } - - // ContainerElement and AttributeElement should be also cloned properly. - const cloned = new this.constructor( this.name, this._attrs, childrenClone ); - - // Classes and styles are cloned separately - this solution is faster than adding them back to attributes and - // parse once again in constructor. - cloned._classes = new Set( this._classes ); - cloned._styles = new Map( this._styles ); - - // Clone custom properties. - cloned._customProperties = new Map( this._customProperties ); - - // Clone filler offset method. - // We can't define this method in a prototype because it's behavior which - // is changed by e.g. toWidget() function from ckeditor5-widget. Perhaps this should be one of custom props. - cloned.getFillerOffset = this.getFillerOffset; - - return cloned; - } - /** * Gets child at the given index. * @@ -512,6 +476,42 @@ export default class Element extends Node { ( attributes == '' ? '' : ` ${ attributes }` ); } + /** + * Clones provided element. + * + * @protected + * @param {Boolean} [deep=false] If set to `true` clones element and all its children recursively. When set to `false`, + * element will be cloned without any children. + * @returns {module:engine/view/element~Element} Clone of this element. + */ + _clone( deep = false ) { + const childrenClone = []; + + if ( deep ) { + for ( const child of this.getChildren() ) { + childrenClone.push( child._clone( deep ) ); + } + } + + // ContainerElement and AttributeElement should be also cloned properly. + const cloned = new this.constructor( this.name, this._attrs, childrenClone ); + + // Classes and styles are cloned separately - this solution is faster than adding them back to attributes and + // parse once again in constructor. + cloned._classes = new Set( this._classes ); + cloned._styles = new Map( this._styles ); + + // Clone custom properties. + cloned._customProperties = new Map( this._customProperties ); + + // Clone filler offset method. + // We can't define this method in a prototype because it's behavior which + // is changed by e.g. toWidget() function from ckeditor5-widget. Perhaps this should be one of custom props. + cloned.getFillerOffset = this.getFillerOffset; + + return cloned; + } + /** * {@link module:engine/view/element~Element#_insertChildren Insert} a child node or a list of child nodes at the end of this node * and sets the parent of these nodes to this element. From 1be70963e96848d3c9b930f05d6ac441d30f4d37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Wed, 7 Mar 2018 10:28:03 +0100 Subject: [PATCH 694/724] Small doc fix. --- src/model/documentselection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 69c78fe14..8a15b3f75 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -531,7 +531,7 @@ class LiveSelection extends Selection { // Update selection's attributes. this._updateAttributes( false ); - // Clear selection attributes from element if no longer empty, + // Clear selection attributes from element if no longer empty. clearAttributesStoredInElement( this._model, batch ); } ); From 7852ef33b57457eb6455b10e7caaf5386d63ace4 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 7 Mar 2018 10:37:57 +0100 Subject: [PATCH 695/724] Added "view.Writer#setTextData()" for updating the content for specified text node. --- src/view/writer.js | 10 ++++++++++ tests/view/writer/writer.js | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/src/view/writer.js b/src/view/writer.js index ff247e49e..4de5cd083 100644 --- a/src/view/writer.js +++ b/src/view/writer.js @@ -225,6 +225,16 @@ export default class Writer { return uiElement; } + /** + * Sets the text content for the specified `textNode`. + * + * @param {String} value New value. + * @param {module:engine/view/text~Text} textNode Text node that will be updated. + */ + setTextData( value, textNode ) { + textNode._data = value; + } + /** * Adds or overwrite element's attribute with a specified key and value. * diff --git a/tests/view/writer/writer.js b/tests/view/writer/writer.js index ea7ffcfb9..3a7ab930d 100644 --- a/tests/view/writer/writer.js +++ b/tests/view/writer/writer.js @@ -128,6 +128,16 @@ describe( 'Writer', () => { } ); } ); + describe( 'setTextData()', () => { + it( 'should update the content for text node', () => { + const textNode = writer.createText( 'foo' ); + + writer.setTextData( 'bar', textNode ); + + expect( textNode.data ).to.equal( 'bar' ); + } ); + } ); + describe( 'setAttribute()', () => { it( 'should set attribute on given element', () => { const element = writer.createAttributeElement( 'span' ); From 4d86bf6e06bba0062f4586708614173a5f71b71a Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Tue, 6 Feb 2018 17:11:51 +0100 Subject: [PATCH 696/724] Fixed processing text data. --- src/view/domconverter.js | 11 +++++++---- src/view/observer/mutationobserver.js | 2 +- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/src/view/domconverter.js b/src/view/domconverter.js index f6d09e882..a90644367 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -7,7 +7,7 @@ * @module engine/view/domconverter */ -/* globals document, Node, NodeFilter */ +/* globals document, Node, NodeFilter, Text */ import ViewText from './text'; import ViewElement from './element'; @@ -956,10 +956,10 @@ export default class DomConverter { * @private */ _processDataFromDomText( node ) { - let data = getDataWithoutFiller( node ); + let data = node.data; if ( _hasDomParentOfType( node, this.preElements ) ) { - return data; + return getDataWithoutFiller( node ); } // Change all consecutive whitespace characters (from the [ \n\t\r] set – @@ -978,9 +978,12 @@ export default class DomConverter { } // If next text node does not exist remove space character from the end of this text node. - if ( !nextNode ) { + if ( !nextNode && !startsWithFiller( node ) ) { data = data.replace( / $/, '' ); } + + data = getDataWithoutFiller( new Text( data ) ); + // At this point we should have removed all whitespaces from DOM text data. // Now we have to change   chars, that were in DOM text data because of rendering reasons, to spaces. diff --git a/src/view/observer/mutationobserver.js b/src/view/observer/mutationobserver.js index 620acc7a0..7b9881762 100644 --- a/src/view/observer/mutationobserver.js +++ b/src/view/observer/mutationobserver.js @@ -204,8 +204,8 @@ export default class MutationObserver extends Observer { } for ( const viewElement of mutatedElements ) { - const domElement = domConverter.mapViewToDom( viewElement ); const viewChildren = Array.from( viewElement.getChildren() ); + const domElement = domConverter.mapViewToDom( viewElement ); const newViewChildren = Array.from( domConverter.domChildrenToView( domElement ) ); // It may happen that as a result of many changes (sth was inserted and then removed), From 3cf3a54afeaf9eb33b1210ac842a4f15c50d1d1c Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 12 Feb 2018 11:26:52 +0100 Subject: [PATCH 697/724] Added comment to link FF issue. --- src/view/domconverter.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/view/domconverter.js b/src/view/domconverter.js index a90644367..6dac7635a 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -982,6 +982,8 @@ export default class DomConverter { data = data.replace( / $/, '' ); } + // Firefox inserts whitespace and
instead of non-breaking space. To prevent normal space from + // being removed inline filler is removed after first string replaces. See ckeditor5#692. data = getDataWithoutFiller( new Text( data ) ); // At this point we should have removed all whitespaces from DOM text data. From 0688c26a4bf5b535563c1a1adcaa6c6b459fc029 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Mon, 12 Feb 2018 13:59:53 +0100 Subject: [PATCH 698/724] Added tests for coverting text with inline filler. --- tests/view/domconverter/dom-to-view.js | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/tests/view/domconverter/dom-to-view.js b/tests/view/domconverter/dom-to-view.js index a30194787..558cde1ca 100644 --- a/tests/view/domconverter/dom-to-view.js +++ b/tests/view/domconverter/dom-to-view.js @@ -525,6 +525,30 @@ describe( 'DomConverter', () => { // See also whitespace-handling-integration.js. // } ); + + describe( 'clearing auto filler', () => { + it( 'should remove inline filler when converting dom to view', () => { + const text = document.createTextNode( INLINE_FILLER + 'foo' ); + const view = converter.domToView( text ); + + expect( view.data ).to.equal( 'foo' ); + } ); + + // See https://github.com/ckeditor/ckeditor5/issues/692. + it( 'should not remove space after inline filler if previous node nor next node does not exist', () => { + const text = document.createTextNode( INLINE_FILLER + ' ' ); + const view = converter.domToView( text ); + + expect( view.data ).to.equal( ' ' ); + } ); + + it( 'should convert non breaking space to normal space after inline filler', () => { + const text = document.createTextNode( INLINE_FILLER + '\u00A0' ); + const view = converter.domToView( text ); + + expect( view.data ).to.equal( ' ' ); + } ); + } ); } ); describe( 'domChildrenToView', () => { From 30da0045cea1cbb79f61a336da2737ba8a16a0ee Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 14 Feb 2018 13:10:20 +0100 Subject: [PATCH 699/724] Added 3 test for 3 scenarios that fix ckeditor5#692. --- tests/view/observer/mutationobserver.js | 62 ++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/tests/view/observer/mutationobserver.js b/tests/view/observer/mutationobserver.js index d7aef2bfa..3b3498d0b 100644 --- a/tests/view/observer/mutationobserver.js +++ b/tests/view/observer/mutationobserver.js @@ -269,6 +269,66 @@ describe( 'MutationObserver', () => { expect( lastMutations[ 0 ].newText ).to.equal( 'xy' ); } ); + // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 1. + it( 'should handle space after inline filler at the end of container', () => { + const { view, selection } = parse( 'foo[]' ); + + viewRoot.appendChildren( view ); + viewDocument.selection.setTo( selection ); + + viewDocument.render(); + + const inlineFiller = domEditor.childNodes[ 2 ].childNodes[ 1 ].childNodes[ 0 ]; + + inlineFiller.data += ' '; + + mutationObserver.flush(); + + expect( lastMutations.length ).to.equal( 1 ); + expect( lastMutations[ 0 ].type ).to.equal( 'children' ); + expect( lastMutations[ 0 ].node ).to.equal( selection.getFirstPosition().parent ); + } ); + + // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 3. + it( 'should handle space after inline filler at the end of container #2', () => { + const { view, selection } = parse( 'foobar[]' ); + + viewRoot.appendChildren( view ); + viewDocument.selection.setTo( selection ); + + viewDocument.render(); + + const inlineFiller = domEditor.childNodes[ 2 ].childNodes[ 2 ]; + + inlineFiller.data += ' '; + + mutationObserver.flush(); + + expect( lastMutations.length ).to.equal( 1 ); + expect( lastMutations[ 0 ].type ).to.equal( 'children' ); + expect( lastMutations[ 0 ].node ).to.equal( selection.getFirstPosition().parent ); + } ); + + // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 2. + it( 'should handle space after inline filler at the beginning of container', () => { + const { view, selection } = parse( '[]foo' ); + + viewRoot.appendChildren( view ); + viewDocument.selection.setTo( selection ); + + viewDocument.render(); + + const inlineFiller = domEditor.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 0 ]; + + inlineFiller.data += ' '; + + mutationObserver.flush(); + + expect( lastMutations.length ).to.equal( 1 ); + expect( lastMutations[ 0 ].type ).to.equal( 'children' ); + expect( lastMutations[ 0 ].node ).to.equal( selection.getFirstPosition().parent ); + } ); + it( 'should have no block filler in mutation', () => { viewRoot.appendChildren( parse( '' ) ); @@ -359,7 +419,7 @@ describe( 'MutationObserver', () => { mutationObserver.flush(); - // There was onlu P2 change. P1 must be ignored. + // There was only P2 change. P1 must be ignored. const viewP2 = viewRoot.getChild( 1 ); expect( lastMutations.length ).to.equal( 1 ); expect( lastMutations[ 0 ].node ).to.equal( viewP2 ); From 5e774cd1a368009e7f2a1c1354f9870ccc468e8f Mon Sep 17 00:00:00 2001 From: Szymon Cofalik Date: Mon, 26 Feb 2018 12:55:21 +0100 Subject: [PATCH 700/724] Docs: Expanded inline comment. --- src/view/domconverter.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/view/domconverter.js b/src/view/domconverter.js index 6dac7635a..c9861f77f 100644 --- a/src/view/domconverter.js +++ b/src/view/domconverter.js @@ -982,8 +982,10 @@ export default class DomConverter { data = data.replace( / $/, '' ); } - // Firefox inserts whitespace and
instead of non-breaking space. To prevent normal space from - // being removed inline filler is removed after first string replaces. See ckeditor5#692. + // At the beginning and end of a block element, Firefox inserts normal space +
instead of non-breaking space. + // This means that the text node starts/end with normal space instead of non-breaking space. + // This causes a problem because the normal space would be removed in `.replace` calls above. To prevent that, + // the inline filler is removed only after the data is initially processed (by the `.replace` above). See ckeditor5#692. data = getDataWithoutFiller( new Text( data ) ); // At this point we should have removed all whitespaces from DOM text data. From c48c8ea160c58851eba5e1cde4f86f1c8fa6c8a9 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Thu, 1 Mar 2018 11:45:48 +0100 Subject: [PATCH 701/724] Tests: Added more accurate assertions. --- src/view/observer/mutationobserver.js | 2 +- tests/view/observer/mutationobserver.js | 58 ++++++++++++++++++++++--- 2 files changed, 53 insertions(+), 7 deletions(-) diff --git a/src/view/observer/mutationobserver.js b/src/view/observer/mutationobserver.js index 7b9881762..620acc7a0 100644 --- a/src/view/observer/mutationobserver.js +++ b/src/view/observer/mutationobserver.js @@ -204,8 +204,8 @@ export default class MutationObserver extends Observer { } for ( const viewElement of mutatedElements ) { - const viewChildren = Array.from( viewElement.getChildren() ); const domElement = domConverter.mapViewToDom( viewElement ); + const viewChildren = Array.from( viewElement.getChildren() ); const newViewChildren = Array.from( domConverter.domChildrenToView( domElement ) ); // It may happen that as a result of many changes (sth was inserted and then removed), diff --git a/tests/view/observer/mutationobserver.js b/tests/view/observer/mutationobserver.js index 3b3498d0b..3d35361f5 100644 --- a/tests/view/observer/mutationobserver.js +++ b/tests/view/observer/mutationobserver.js @@ -271,14 +271,21 @@ describe( 'MutationObserver', () => { // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 1. it( 'should handle space after inline filler at the end of container', () => { - const { view, selection } = parse( 'foo[]' ); + const { view, selection } = parse( + '' + + 'foo' + + '[]' + + '' + ); viewRoot.appendChildren( view ); viewDocument.selection.setTo( selection ); viewDocument.render(); - const inlineFiller = domEditor.childNodes[ 2 ].childNodes[ 1 ].childNodes[ 0 ]; + // Appended container is third in the tree. + const container = domEditor.childNodes[ 2 ]; + const inlineFiller = container.childNodes[ 1 ].childNodes[ 0 ]; inlineFiller.data += ' '; @@ -286,19 +293,31 @@ describe( 'MutationObserver', () => { expect( lastMutations.length ).to.equal( 1 ); expect( lastMutations[ 0 ].type ).to.equal( 'children' ); + expect( lastMutations[ 0 ].oldChildren.length ).to.equal( 0 ); + expect( lastMutations[ 0 ].newChildren.length ).to.equal( 1 ); + expect( lastMutations[ 0 ].newChildren[ 0 ].is( 'text' ) ).to.be.true; + expect( lastMutations[ 0 ].newChildren[ 0 ].data ).to.equal( ' ' ); expect( lastMutations[ 0 ].node ).to.equal( selection.getFirstPosition().parent ); } ); // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 3. it( 'should handle space after inline filler at the end of container #2', () => { - const { view, selection } = parse( 'foobar[]' ); + const { view, selection } = parse( + '' + + 'foo' + + 'bar' + + '[]' + + '' + ); viewRoot.appendChildren( view ); viewDocument.selection.setTo( selection ); viewDocument.render(); - const inlineFiller = domEditor.childNodes[ 2 ].childNodes[ 2 ]; + // Appended container is third in the tree. + const container = domEditor.childNodes[ 2 ]; + const inlineFiller = container.childNodes[ 2 ]; inlineFiller.data += ' '; @@ -306,19 +325,42 @@ describe( 'MutationObserver', () => { expect( lastMutations.length ).to.equal( 1 ); expect( lastMutations[ 0 ].type ).to.equal( 'children' ); + expect( lastMutations[ 0 ].oldChildren.length ).to.equal( 2 ); + expect( lastMutations[ 0 ].newChildren.length ).to.equal( 3 ); + + // Foo and attribute is removed and reinserted. + expect( lastMutations[ 0 ].oldChildren[ 0 ].is( 'text' ) ).to.be.true; + expect( lastMutations[ 0 ].oldChildren[ 0 ].data ).to.equal( 'foo' ); + expect( lastMutations[ 0 ].newChildren[ 0 ].is( 'text' ) ).to.be.true; + expect( lastMutations[ 0 ].newChildren[ 0 ].data ).to.equal( 'foo' ); + + expect( lastMutations[ 0 ].oldChildren[ 1 ].is( 'attributeElement' ) ).to.be.true; + expect( lastMutations[ 0 ].oldChildren[ 1 ].name ).to.equal( 'b' ); + expect( lastMutations[ 0 ].newChildren[ 1 ].is( 'attributeElement' ) ).to.be.true; + expect( lastMutations[ 0 ].newChildren[ 1 ].name ).to.equal( 'b' ); + + expect( lastMutations[ 0 ].newChildren[ 2 ].is( 'text' ) ).to.be.true; + expect( lastMutations[ 0 ].newChildren[ 2 ].data ).to.equal( ' ' ); expect( lastMutations[ 0 ].node ).to.equal( selection.getFirstPosition().parent ); } ); // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 2. it( 'should handle space after inline filler at the beginning of container', () => { - const { view, selection } = parse( '[]foo' ); + const { view, selection } = parse( + '' + + '[]' + + 'foo' + + '' + ); viewRoot.appendChildren( view ); viewDocument.selection.setTo( selection ); viewDocument.render(); - const inlineFiller = domEditor.childNodes[ 2 ].childNodes[ 0 ].childNodes[ 0 ]; + // Appended container is third in the tree. + const container = domEditor.childNodes[ 2 ]; + const inlineFiller = container.childNodes[ 0 ].childNodes[ 0 ]; inlineFiller.data += ' '; @@ -326,6 +368,10 @@ describe( 'MutationObserver', () => { expect( lastMutations.length ).to.equal( 1 ); expect( lastMutations[ 0 ].type ).to.equal( 'children' ); + expect( lastMutations[ 0 ].oldChildren.length ).to.equal( 0 ); + expect( lastMutations[ 0 ].newChildren.length ).to.equal( 1 ); + expect( lastMutations[ 0 ].newChildren[ 0 ].is( 'text' ) ).to.be.true; + expect( lastMutations[ 0 ].newChildren[ 0 ].data ).to.equal( ' ' ); expect( lastMutations[ 0 ].node ).to.equal( selection.getFirstPosition().parent ); } ); From 3cd535944fa61d0f4818c3fab71fbb8c061d6e86 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Thu, 1 Mar 2018 11:48:54 +0100 Subject: [PATCH 702/724] Aligned code to recent changes that landed on master. --- tests/view/observer/mutationobserver.js | 30 ++++++++++++------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/tests/view/observer/mutationobserver.js b/tests/view/observer/mutationobserver.js index 3d35361f5..16dc59eab 100644 --- a/tests/view/observer/mutationobserver.js +++ b/tests/view/observer/mutationobserver.js @@ -271,17 +271,17 @@ describe( 'MutationObserver', () => { // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 1. it( 'should handle space after inline filler at the end of container', () => { - const { view, selection } = parse( + const { view: viewContainer, selection } = parse( '' + 'foo' + '[]' + '' ); - viewRoot.appendChildren( view ); - viewDocument.selection.setTo( selection ); - - viewDocument.render(); + view.change( writer => { + viewRoot.appendChildren( viewContainer ); + writer.setSelection( selection ); + } ); // Appended container is third in the tree. const container = domEditor.childNodes[ 2 ]; @@ -302,7 +302,7 @@ describe( 'MutationObserver', () => { // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 3. it( 'should handle space after inline filler at the end of container #2', () => { - const { view, selection } = parse( + const { view: viewContainer, selection } = parse( '' + 'foo' + 'bar' + @@ -310,10 +310,10 @@ describe( 'MutationObserver', () => { '' ); - viewRoot.appendChildren( view ); - viewDocument.selection.setTo( selection ); - - viewDocument.render(); + view.change( writer => { + viewRoot.appendChildren( viewContainer ); + writer.setSelection( selection ); + } ); // Appended container is third in the tree. const container = domEditor.childNodes[ 2 ]; @@ -346,17 +346,17 @@ describe( 'MutationObserver', () => { // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 2. it( 'should handle space after inline filler at the beginning of container', () => { - const { view, selection } = parse( + const { view: viewContainer, selection } = parse( '' + '[]' + 'foo' + '' ); - viewRoot.appendChildren( view ); - viewDocument.selection.setTo( selection ); - - viewDocument.render(); + view.change( writer => { + viewRoot.appendChildren( viewContainer ); + writer.setSelection( selection ); + } ); // Appended container is third in the tree. const container = domEditor.childNodes[ 2 ]; From b66c4c8595e24aab91264e2592dcef932c6b6783 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Wed, 7 Mar 2018 14:58:56 +0100 Subject: [PATCH 703/724] Added "model.Writer#setTextData()" for updating the content for specified text node. --- src/model/writer.js | 10 ++++++++++ tests/model/writer.js | 16 ++++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/src/model/writer.js b/src/model/writer.js index e7cd3aea5..34c0b70f6 100644 --- a/src/model/writer.js +++ b/src/model/writer.js @@ -322,6 +322,16 @@ export default class Writer { } } + /** + * Sets the text content for the specified `textNode`. + * + * @param {String} value New value. + * @param {module:engine/model/text~Text} textNode Text node that will be updated. + */ + setTextData( value, textNode ) { + textNode._data = value; + } + /** * Sets value of the attribute with given key on a {@link module:engine/model/item~Item model item} * or on a {@link module:engine/model/range~Range range}. diff --git a/tests/model/writer.js b/tests/model/writer.js index 72b949623..ddbe3cc2b 100644 --- a/tests/model/writer.js +++ b/tests/model/writer.js @@ -811,6 +811,16 @@ describe( 'Writer', () => { } ); } ); + describe( 'setTextData()', () => { + it( 'should update the content for text node', () => { + const textNode = createText( 'foo' ); + + setTextData( 'bar', textNode ); + + expect( textNode.data ).to.equal( 'bar' ); + } ); + } ); + describe( 'setAttribute() / removeAttribute()', () => { let root, spy; @@ -2462,6 +2472,12 @@ describe( 'Writer', () => { } ); } + function setTextData( value, textNode ) { + model.enqueueChange( batch, writer => { + writer.setTextData( value, textNode ); + } ); + } + function setAttribute( key, value, itemOrRange ) { model.enqueueChange( batch, writer => { writer.setAttribute( key, value, itemOrRange ); From 3acdca02916f8346d56761a8f14e8e3033490a8f Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 7 Mar 2018 16:39:14 +0100 Subject: [PATCH 704/724] Added integration test. --- tests/tickets/ckeditor5-692.js | 71 ++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 tests/tickets/ckeditor5-692.js diff --git a/tests/tickets/ckeditor5-692.js b/tests/tickets/ckeditor5-692.js new file mode 100644 index 000000000..a4d7baf90 --- /dev/null +++ b/tests/tickets/ckeditor5-692.js @@ -0,0 +1,71 @@ +/** + * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * For licensing, see LICENSE.md. + */ + +import MutationObserver from '../../src/view/observer/mutationobserver'; +import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor.js'; +import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; +import { getData as getModelData } from '../../src/dev-utils/model'; +import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold.js'; +import { getData as getViewData } from '../../src/dev-utils/view'; +import { isInlineFiller } from '../../src/view/filler'; +import Input from '@ckeditor/ckeditor5-typing/src/input'; + +/* globals document */ + +describe( 'Bug ckeditor5#692', () => { + let editorElement, editor, mutationObserver, view, domEditor, root; + + beforeEach( () => { + editorElement = document.createElement( 'div' ); + document.body.appendChild( editorElement ); + + return ClassicTestEditor.create( editorElement, { + plugins: [ Paragraph, Bold, Input ] + } ).then( newEditor => { + editor = newEditor; + view = editor.editing.view; + mutationObserver = view.getObserver( MutationObserver ); + domEditor = editor.ui.view.editableElement; + root = editor.model.document.getRoot(); + } ); + } ); + + afterEach( () => { + document.body.removeChild( editorElement ); + + return editor.destroy(); + } ); + + describe( 'DomConverter', () => { + // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 1. + it( 'should handle space after inline filler at the end of container', () => { + editor.setData( '

foo

' ); + + const paragraph = root.getChild( 0 ); + + // Put caret after at

foo[]

. + editor.model.change( writer => { + writer.setSelection( paragraph, 3 ); + } ); + + // Create Bold attribute at the end of paragraph. + editor.execute( 'bold' ); + + expect( getModelData( editor.model ) ).to.equal( 'foo<$text bold="true">[]' ); + + const domParagraph = domEditor.childNodes[ 0 ]; + const textNode = domParagraph.childNodes[ 1 ].childNodes[ 0 ]; + + expect( isInlineFiller( textNode ) ).to.be.true; + + // Add space inside the strong's text node. + textNode.data += ' '; + mutationObserver.flush(); + + expect( getModelData( editor.model ) ).to.equal( 'foo<$text bold="true"> []' ); + expect( getViewData( editor.editing.view ) ).to.equal( '

foo {}

' ); + } ); + } ); +} ); From 3764463cbf2211f9668c60c215555f991d9d79b2 Mon Sep 17 00:00:00 2001 From: Maciej Bukowski Date: Wed, 7 Mar 2018 17:06:20 +0100 Subject: [PATCH 705/724] Added 2. integration test. --- tests/tickets/ckeditor5-692.js | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/tests/tickets/ckeditor5-692.js b/tests/tickets/ckeditor5-692.js index a4d7baf90..21384bd0b 100644 --- a/tests/tickets/ckeditor5-692.js +++ b/tests/tickets/ckeditor5-692.js @@ -67,5 +67,34 @@ describe( 'Bug ckeditor5#692', () => { expect( getModelData( editor.model ) ).to.equal( 'foo<$text bold="true"> []' ); expect( getViewData( editor.editing.view ) ).to.equal( '

foo {}

' ); } ); + + // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 2. + it( 'should handle space after inline filler at the end of container', () => { + editor.setData( '

foo

' ); + + const paragraph = root.getChild( 0 ); + + // Put caret after at

[]foo

. + editor.model.change( writer => { + writer.setSelection( paragraph, 0 ); + } ); + + // Create Bold attribute at the end of paragraph. + editor.execute( 'bold' ); + + expect( getModelData( editor.model ) ).to.equal( '<$text bold="true">[]foo' ); + + const domParagraph = domEditor.childNodes[ 0 ]; + const textNode = domParagraph.childNodes[ 0 ].childNodes[ 0 ]; + + expect( isInlineFiller( textNode ) ).to.be.true; + + // Add space inside the strong's text node. + textNode.data += ' '; + mutationObserver.flush(); + + expect( getModelData( editor.model ) ).to.equal( '<$text bold="true"> []foo' ); + expect( getViewData( editor.editing.view ) ).to.equal( '

{}foo

' ); + } ); } ); } ); From 929e6499f573155b8804b485c2ead84fd8a394b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Wed, 7 Mar 2018 21:02:15 +0100 Subject: [PATCH 706/724] Fixed code style. --- tests/tickets/ckeditor5-692.js | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/tests/tickets/ckeditor5-692.js b/tests/tickets/ckeditor5-692.js index 21384bd0b..83fdf9cc4 100644 --- a/tests/tickets/ckeditor5-692.js +++ b/tests/tickets/ckeditor5-692.js @@ -21,15 +21,17 @@ describe( 'Bug ckeditor5#692', () => { editorElement = document.createElement( 'div' ); document.body.appendChild( editorElement ); - return ClassicTestEditor.create( editorElement, { - plugins: [ Paragraph, Bold, Input ] - } ).then( newEditor => { - editor = newEditor; - view = editor.editing.view; - mutationObserver = view.getObserver( MutationObserver ); - domEditor = editor.ui.view.editableElement; - root = editor.model.document.getRoot(); - } ); + return ClassicTestEditor + .create( editorElement, { + plugins: [ Paragraph, Bold, Input ] + } ) + .then( newEditor => { + editor = newEditor; + view = editor.editing.view; + mutationObserver = view.getObserver( MutationObserver ); + domEditor = editor.ui.view.editableElement; + root = editor.model.document.getRoot(); + } ); } ); afterEach( () => { From ed99ed17ec489401ba5d5dc7fe30380814a2ac1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Wed, 7 Mar 2018 21:07:40 +0100 Subject: [PATCH 707/724] Simplified the tests. --- tests/tickets/ckeditor5-692.js | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/tests/tickets/ckeditor5-692.js b/tests/tickets/ckeditor5-692.js index 83fdf9cc4..b5a3ae32c 100644 --- a/tests/tickets/ckeditor5-692.js +++ b/tests/tickets/ckeditor5-692.js @@ -6,7 +6,7 @@ import MutationObserver from '../../src/view/observer/mutationobserver'; import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor.js'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; -import { getData as getModelData } from '../../src/dev-utils/model'; +import { getData as getModelData, setData as setModelData } from '../../src/dev-utils/model'; import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold.js'; import { getData as getViewData } from '../../src/dev-utils/view'; import { isInlineFiller } from '../../src/view/filler'; @@ -15,7 +15,7 @@ import Input from '@ckeditor/ckeditor5-typing/src/input'; /* globals document */ describe( 'Bug ckeditor5#692', () => { - let editorElement, editor, mutationObserver, view, domEditor, root; + let editorElement, editor, mutationObserver, view, domEditor; beforeEach( () => { editorElement = document.createElement( 'div' ); @@ -30,7 +30,6 @@ describe( 'Bug ckeditor5#692', () => { view = editor.editing.view; mutationObserver = view.getObserver( MutationObserver ); domEditor = editor.ui.view.editableElement; - root = editor.model.document.getRoot(); } ); } ); @@ -43,14 +42,7 @@ describe( 'Bug ckeditor5#692', () => { describe( 'DomConverter', () => { // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 1. it( 'should handle space after inline filler at the end of container', () => { - editor.setData( '

foo

' ); - - const paragraph = root.getChild( 0 ); - - // Put caret after at

foo[]

. - editor.model.change( writer => { - writer.setSelection( paragraph, 3 ); - } ); + setModelData( editor.model, 'foo[]' ); // Create Bold attribute at the end of paragraph. editor.execute( 'bold' ); @@ -72,14 +64,7 @@ describe( 'Bug ckeditor5#692', () => { // https://github.com/ckeditor/ckeditor5/issues/692 Scenario 2. it( 'should handle space after inline filler at the end of container', () => { - editor.setData( '

foo

' ); - - const paragraph = root.getChild( 0 ); - - // Put caret after at

[]foo

. - editor.model.change( writer => { - writer.setSelection( paragraph, 0 ); - } ); + setModelData( editor.model, '[]foo' ); // Create Bold attribute at the end of paragraph. editor.execute( 'bold' ); From 206ed1eb564f407532c0b5bb26db51b49847a638 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 8 Mar 2018 08:24:54 +0100 Subject: [PATCH 708/724] Fixed failing tests. --- tests/view/observer/mutationobserver.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/view/observer/mutationobserver.js b/tests/view/observer/mutationobserver.js index ea7830e1e..2cf74515c 100644 --- a/tests/view/observer/mutationobserver.js +++ b/tests/view/observer/mutationobserver.js @@ -279,7 +279,7 @@ describe( 'MutationObserver', () => { ); view.change( writer => { - viewRoot.appendChildren( viewContainer ); + viewRoot._appendChildren( viewContainer ); writer.setSelection( selection ); } ); @@ -311,7 +311,7 @@ describe( 'MutationObserver', () => { ); view.change( writer => { - viewRoot.appendChildren( viewContainer ); + viewRoot._appendChildren( viewContainer ); writer.setSelection( selection ); } ); @@ -354,7 +354,7 @@ describe( 'MutationObserver', () => { ); view.change( writer => { - viewRoot.appendChildren( viewContainer ); + viewRoot._appendChildren( viewContainer ); writer.setSelection( selection ); } ); From 5728e1fd4b77a5c076f1b94b57d57fe547cd2995 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 8 Mar 2018 09:00:05 +0100 Subject: [PATCH 709/724] Improved the docs. --- src/model/element.js | 3 +++ src/model/node.js | 5 +++++ src/view/attributeelement.js | 1 + src/view/containerelement.js | 3 ++- src/view/editableelement.js | 3 +++ src/view/element.js | 16 ++++++++++++++-- src/view/emptyelement.js | 1 + src/view/uielement.js | 2 ++ 8 files changed, 31 insertions(+), 3 deletions(-) diff --git a/src/model/element.js b/src/model/element.js index 80268d611..205e1678e 100644 --- a/src/model/element.js +++ b/src/model/element.js @@ -236,6 +236,7 @@ export default class Element extends Node { /** * {@link module:engine/model/element~Element#_insertChildren Inserts} one or more nodes at the end of this element. * + * @see module:engine/model/writer~Writer#append * @protected * @param {module:engine/model/item~Item|Iterable.} nodes Nodes to be inserted. */ @@ -247,6 +248,7 @@ export default class Element extends Node { * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes * to this element. * + * @see module:engine/model/writer~Writer#insert * @protected * @param {Number} index Index at which nodes should be inserted. * @param {module:engine/model/item~Item|Iterable.} items Items to be inserted. @@ -270,6 +272,7 @@ export default class Element extends Node { * Removes one or more nodes starting at the given index and sets * {@link module:engine/model/node~Node#parent parent} of these nodes to `null`. * + * @see module:engine/model/writer~Writer#remove * @protected * @param {Number} index Index of the first node to remove. * @param {Number} [howMany=1] Number of nodes to remove. diff --git a/src/model/node.js b/src/model/node.js index bf3a17b18..2f419cbfc 100644 --- a/src/model/node.js +++ b/src/model/node.js @@ -342,6 +342,7 @@ export default class Node { /** * Removes this node from it's parent. * + * @see module:engine/model/writer~Writer#remove * @protected */ _remove() { @@ -351,6 +352,7 @@ export default class Node { /** * Sets attribute on the node. If attribute with the same key already is set, it's value is overwritten. * + * @see module:engine/model/writer~Writer#setAttribute * @protected * @param {String} key Key of attribute to set. * @param {*} value Attribute value. @@ -362,6 +364,7 @@ export default class Node { /** * Removes all attributes from the node and sets given attributes. * + * @see module:engine/model/writer~Writer#setAttributes * @protected * @param {Object} [attrs] Attributes to set. See {@link module:utils/tomap~toMap} for a list of accepted values. */ @@ -372,6 +375,7 @@ export default class Node { /** * Removes an attribute with given key from the node. * + * @see module:engine/model/writer~Writer#removeAttribute * @protected * @param {String} key Key of attribute to remove. * @returns {Boolean} `true` if the attribute was set on the element, `false` otherwise. @@ -383,6 +387,7 @@ export default class Node { /** * Removes all attributes from the node. * + * @see module:engine/model/writer~Writer#clearAttributes * @protected */ _clearAttributes() { diff --git a/src/view/attributeelement.js b/src/view/attributeelement.js index e19426521..d1e622ce4 100644 --- a/src/view/attributeelement.js +++ b/src/view/attributeelement.js @@ -26,6 +26,7 @@ export default class AttributeElement extends Element { /** * Creates a attribute element. * + * @see module:engine/view/writer~Writer#createAttributeElement * @protected * @see module:engine/view/element~Element */ diff --git a/src/view/containerelement.js b/src/view/containerelement.js index 7520dd785..3735a0e9d 100644 --- a/src/view/containerelement.js +++ b/src/view/containerelement.js @@ -48,8 +48,9 @@ export default class ContainerElement extends Element { /** * Creates a container element. * - * @protected * @see module:engine/view/element~Element + * @see module:engine/view/writer~Writer#createContainerElement + * @protected */ constructor( name, attrs, children ) { super( name, attrs, children ); diff --git a/src/view/editableelement.js b/src/view/editableelement.js index 8c8845953..fb942c4ba 100644 --- a/src/view/editableelement.js +++ b/src/view/editableelement.js @@ -26,6 +26,9 @@ const documentSymbol = Symbol( 'document' ); export default class EditableElement extends ContainerElement { /** * Creates an editable element. + * + * @see module:engine/view/writer~Writer#createEditableElement + * @protected */ constructor( name, attrs, children ) { super( name, attrs, children ); diff --git a/src/view/element.js b/src/view/element.js index e806dec4c..eec64ab39 100644 --- a/src/view/element.js +++ b/src/view/element.js @@ -516,8 +516,10 @@ export default class Element extends Node { * {@link module:engine/view/element~Element#_insertChildren Insert} a child node or a list of child nodes at the end of this node * and sets the parent of these nodes to this element. * - * @fires module:engine/view/node~Node#change + * @see module:engine/view/writer~Writer#insert + * @protected * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. + * @fires module:engine/view/node~Node#change * @returns {Number} Number of appended nodes. */ _appendChildren( items ) { @@ -528,6 +530,7 @@ export default class Element extends Node { * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to * this element. * + * @see module:engine/view/writer~Writer#insert * @protected * @param {Number} index Position where nodes should be inserted. * @param {module:engine/view/item~Item|Iterable.} items Items to be inserted. @@ -559,10 +562,11 @@ export default class Element extends Node { /** * Removes number of child nodes starting at the given index and set the parent of these nodes to `null`. * + * @see module:engine/view/writer~Writer#remove * @param {Number} index Number of the first node to remove. * @param {Number} [howMany=1] Number of nodes to remove. - * @returns {Array.} The array of removed nodes. * @fires module:engine/view/node~Node#change + * @returns {Array.} The array of removed nodes. */ _removeChildren( index, howMany = 1 ) { this._fireChange( 'children', this ); @@ -577,6 +581,7 @@ export default class Element extends Node { /** * Adds or overwrite attribute with a specified key and value. * + * @see module:engine/view/writer~Writer#setAttribute * @protected * @param {String} key Attribute key. * @param {String} value Attribute value. @@ -599,6 +604,7 @@ export default class Element extends Node { /** * Removes attribute from the element. * + * @see module:engine/view/writer~Writer#removeAttribute * @protected * @param {String} key Attribute key. * @returns {Boolean} Returns true if an attribute existed and has been removed. @@ -639,6 +645,7 @@ export default class Element extends Node { * element._addClass( 'foo' ); // Adds 'foo' class. * element._addClass( [ 'foo', 'bar' ] ); // Adds 'foo' and 'bar' classes. * + * @see module:engine/view/writer~Writer#addClass * @protected * @param {Array.|String} className * @fires module:engine/view/node~Node#change @@ -656,6 +663,7 @@ export default class Element extends Node { * element._removeClass( 'foo' ); // Removes 'foo' class. * element._removeClass( [ 'foo', 'bar' ] ); // Removes both 'foo' and 'bar' classes. * + * @see module:engine/view/writer~Writer#removeClass * @param {Array.|String} className * @fires module:engine/view/node~Node#change */ @@ -675,6 +683,7 @@ export default class Element extends Node { * position: 'fixed' * } ); * + * @see module:engine/view/writer~Writer#setStyle * @protected * @param {String|Object} property Property name or object with key - value pairs. * @param {String} [value] Value to set. This parameter is ignored if object is provided as the first parameter. @@ -700,6 +709,7 @@ export default class Element extends Node { * element._removeStyle( 'color' ); // Removes 'color' style. * element._removeStyle( [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles. * + * @see module:engine/view/writer~Writer#removeStyle * @protected * @param {Array.|String} property * @fires module:engine/view/node~Node#change @@ -715,6 +725,7 @@ export default class Element extends Node { * Sets a custom property. Unlike attributes, custom properties are not rendered to the DOM, * so they can be used to add special data to elements. * + * @see module:engine/view/writer~Writer#setCustomProperty * @protected * @param {String|Symbol} key * @param {*} value @@ -726,6 +737,7 @@ export default class Element extends Node { /** * Removes the custom property stored under the given key. * + * @see module:engine/view/writer~Writer#removeCustomProperty * @protected * @param {String|Symbol} key * @returns {Boolean} Returns true if property was removed. diff --git a/src/view/emptyelement.js b/src/view/emptyelement.js index 69a07cfbd..5840f73cf 100644 --- a/src/view/emptyelement.js +++ b/src/view/emptyelement.js @@ -21,6 +21,7 @@ export default class EmptyElement extends Element { * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed, * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden). * + * @see module:engine/view/writer~Writer#createEmptyElement * @protected * @param {String} name Node name. * @param {Object|Iterable} [attributes] Collection of attributes. diff --git a/src/view/uielement.js b/src/view/uielement.js index c7c9b3e9c..720b1a698 100644 --- a/src/view/uielement.js +++ b/src/view/uielement.js @@ -23,6 +23,8 @@ export default class UIElement extends Element { * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` when third parameter is passed, * to inform that usage of UIElement is incorrect (adding child nodes to UIElement is forbidden). * + * @see module:engine/view/writer~Writer#createUIElement + * @protected * @param {String} name Node name. * @param {Object|Iterable} [attributes] Collection of attributes. */ From aad30a5d25a0540d6dec5736f70c023dbdf5f0bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Mon, 5 Mar 2018 17:18:30 +0100 Subject: [PATCH 710/724] Other: Renamed 'headings' ui component to 'heading'. --- tests/manual/highlight.js | 2 +- tests/manual/markers.js | 2 +- tests/manual/placeholder.js | 2 +- tests/manual/tickets/1088/1.js | 2 +- tests/manual/tickets/603/1.js | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/tests/manual/highlight.js b/tests/manual/highlight.js index 9a09cd3a3..31eb35981 100644 --- a/tests/manual/highlight.js +++ b/tests/manual/highlight.js @@ -67,7 +67,7 @@ class FancyWidget extends Plugin { ClassicEditor.create( global.document.querySelector( '#editor' ), { plugins: [ Enter, Typing, Paragraph, Undo, Heading, Bold, Italic, List, FancyWidget ], - toolbar: [ 'headings', '|', 'undo', 'redo', 'bold', 'italic', 'numberedList', 'bulletedList' ] + toolbar: [ 'heading', '|', 'undo', 'redo', 'bold', 'italic', 'numberedList', 'bulletedList' ] } ) .then( editor => { window.editor = editor; diff --git a/tests/manual/markers.js b/tests/manual/markers.js index bc7f4594a..23f48c0f5 100644 --- a/tests/manual/markers.js +++ b/tests/manual/markers.js @@ -29,7 +29,7 @@ let _uid = 1; ClassicEditor .create( document.querySelector( '#editor' ), { plugins: [ Enter, Typing, Paragraph, Bold, Italic, List, Heading, Undo ], - toolbar: [ 'headings', '|', 'bold', 'italic', 'bulletedList', 'numberedList', 'undo', 'redo' ] + toolbar: [ 'heading', '|', 'bold', 'italic', 'bulletedList', 'numberedList', 'undo', 'redo' ] } ) .then( editor => { window.editor = editor; diff --git a/tests/manual/placeholder.js b/tests/manual/placeholder.js index 19340e152..c5c07d0a2 100644 --- a/tests/manual/placeholder.js +++ b/tests/manual/placeholder.js @@ -17,7 +17,7 @@ import { attachPlaceholder } from '../../src/view/placeholder'; ClassicEditor .create( global.document.querySelector( '#editor' ), { plugins: [ Enter, Typing, Paragraph, Undo, Heading ], - toolbar: [ 'headings', '|', 'undo', 'redo' ] + toolbar: [ 'heading', '|', 'undo', 'redo' ] } ) .then( editor => { const view = editor.editing.view; diff --git a/tests/manual/tickets/1088/1.js b/tests/manual/tickets/1088/1.js index 73f655ebf..33f9be94d 100644 --- a/tests/manual/tickets/1088/1.js +++ b/tests/manual/tickets/1088/1.js @@ -13,7 +13,7 @@ ClassicEditor plugins: [ ArticlePluginSet ], toolbar: { items: [ - 'headings', + 'heading', 'bold', 'italic', 'link', diff --git a/tests/manual/tickets/603/1.js b/tests/manual/tickets/603/1.js index b7ae6871c..337ebbf0e 100644 --- a/tests/manual/tickets/603/1.js +++ b/tests/manual/tickets/603/1.js @@ -16,7 +16,7 @@ import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic'; ClassicEditor .create( document.querySelector( '#editor' ), { plugins: [ Enter, Typing, Paragraph, Heading, Bold, Italic ], - toolbar: [ 'headings', '|', 'bold', 'italic' ] + toolbar: [ 'heading', '|', 'bold', 'italic' ] } ) .then( editor => { window.editor = editor; From c22cd465c06dc7a935595fa06c1525c6997ed64d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Go=C5=82aszewski?= Date: Wed, 7 Mar 2018 17:09:40 +0100 Subject: [PATCH 711/724] Other: Rename ImageStyle options, UI components and merge commands into one command. --- tests/manual/tickets/1088/1.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/manual/tickets/1088/1.js b/tests/manual/tickets/1088/1.js index 33f9be94d..f2ddbaf86 100644 --- a/tests/manual/tickets/1088/1.js +++ b/tests/manual/tickets/1088/1.js @@ -26,8 +26,8 @@ ClassicEditor }, image: { toolbar: [ - 'imageStyleFull', - 'imageStyleSide', + 'imageStyle:full', + 'imageStyle:side', '|', 'imageTextAlternative' ] From 19bf4a3878d8260e6a4bf738ea40022d6b7604e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 8 Mar 2018 12:37:32 +0100 Subject: [PATCH 712/724] Removing non-exitent attributes from DocumentSelection prevents from adding them during attribute auto-update. --- src/model/documentselection.js | 9 ++++++--- tests/model/documentselection.js | 31 +++++++++++++++++++++++++++---- 2 files changed, 33 insertions(+), 7 deletions(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 8a15b3f75..ba93b2f45 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -801,6 +801,9 @@ class LiveSelection extends Selection { // Internal method for removing `LiveSelection` attribute. Supports attribute priorities (through `directChange` // parameter). // + // NOTE: Even if attribute is not present in the selection but is provided to this method, it's priority will + // be changed according to `directChange` parameter. + // // @private // @param {String} key Attribute key. // @param {Boolean} [directChange=true] `true` if the change is caused by `Selection` API, `false` if change @@ -815,6 +818,9 @@ class LiveSelection extends Selection { return false; } + // Update priorities map. + this._attributePriority.set( key, priority ); + // Don't do anything if value has not changed. if ( !super.hasAttribute( key ) ) { return false; @@ -822,9 +828,6 @@ class LiveSelection extends Selection { this._attrs.delete( key ); - // Update priorities map. - this._attributePriority.set( key, priority ); - return true; } diff --git a/tests/model/documentselection.js b/tests/model/documentselection.js index adc51f215..097e44250 100644 --- a/tests/model/documentselection.js +++ b/tests/model/documentselection.js @@ -439,6 +439,21 @@ describe( 'DocumentSelection', () => { expect( selection.getAttribute( 'foo' ) ).to.be.undefined; } ); + + it( 'should prevent auto update of the attribute even if attribute is not preset yet', () => { + selection._setTo( new Position( root, [ 0, 1 ] ) ); + + // Remove "foo" attribute that is not present in selection yet. + expect( selection.hasAttribute( 'foo' ) ).to.be.false; + selection._removeAttribute( 'foo' ); + + // Trigger selecton auto update on document change. It should not get attribute from surrounding text; + model.change( writer => { + writer.setAttribute( 'foo', 'bar', Range.createIn( fullP ) ); + } ); + + expect( selection.getAttribute( 'foo' ) ).to.be.undefined; + } ); } ); describe( '_getStoredAttributes()', () => { @@ -1056,10 +1071,18 @@ describe( 'DocumentSelection', () => { expect( data.attributeKeys ).to.deep.equal( [ 'foo' ] ); } ); - model.change( writer => { - const range = new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ); - writer.setAttribute( 'foo', 'bar', range ); - } ); + model.applyOperation( wrapInDelta( + new AttributeOperation( + new Range( new Position( root, [ 0, 1 ] ), new Position( root, [ 0, 5 ] ) ), + 'foo', + null, + 'bar', + doc.version + ) + ) ); + + // Attributes are auto updated on document change. + model.change( () => {} ); expect( selection.getAttribute( 'foo' ) ).to.equal( 'bar' ); expect( spyAttribute.calledOnce ).to.be.true; From d90354f8000eb75c4913a03eeaf90f274bae883f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Thu, 8 Mar 2018 14:09:18 +0100 Subject: [PATCH 713/724] Removed unnecessary check for position parent. --- src/model/documentselection.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/documentselection.js b/src/model/documentselection.js index 44dc7ee50..0441e1e2a 100644 --- a/src/model/documentselection.js +++ b/src/model/documentselection.js @@ -1012,7 +1012,7 @@ function clearAttributesStoredInElement( model, batch ) { const differ = model.document.differ; for ( const entry of differ.getChanges() ) { - if ( entry.type != 'insert' || !entry.position.parent ) { + if ( entry.type != 'insert' ) { continue; } From 1139034fb11b32f5192516a66619ddf528807382 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Szymon=20Kup=C5=9B?= Date: Fri, 9 Mar 2018 12:50:34 +0100 Subject: [PATCH 714/724] Fixed manual test for t/738. --- tests/manual/tickets/475/1.js | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/tests/manual/tickets/475/1.js b/tests/manual/tickets/475/1.js index 566fbee91..7235c4192 100644 --- a/tests/manual/tickets/475/1.js +++ b/tests/manual/tickets/475/1.js @@ -19,8 +19,6 @@ import { downcastAttributeToElement, } from '../../../../src/conversion/downcast-converters'; -import AttributeElement from '../../../../src/view/attributeelement'; - import Enter from '@ckeditor/ckeditor5-enter/src/enter'; import Typing from '@ckeditor/ckeditor5-typing/src/typing'; import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph'; @@ -33,8 +31,11 @@ class Link extends Plugin { // Allow bold attribute on all inline nodes. editor.model.schema.extend( '$text', { allowAttributes: 'link' } ); - editor.conversion.for( 'downcast' ).add( downcastAttributeToElement( 'link', { - view: attributeValue => new AttributeElement( 'a', { href: attributeValue } ) + editor.conversion.for( 'downcast' ).add( downcastAttributeToElement( { + model: 'link', + view: ( modelAttributeValue, viewWriter ) => { + return viewWriter.createAttributeElement( 'a', { href: modelAttributeValue } ); + } } ) ); editor.conversion.for( 'upcast' ).add( upcastElementToAttribute( { @@ -53,16 +54,12 @@ class AutoLinker extends Plugin { const changes = this.editor.model.document.differ.getChanges(); for ( const entry of changes ) { - if ( entry.type != 'insert' || entry.name != '$text' || !entry.position.textNode ) { + if ( entry.type != 'insert' || entry.name != '$text' || !entry.position.parent ) { continue; } - const textNode = entry.position.textNode; - const text = textNode.data; - - if ( !text ) { - return; - } + const parent = entry.position.parent; + const text = Array.from( parent.getChildren() ).map( item => item.data ).join( '' ); const regexp = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_+.~#?&//=]*)/g; let match; @@ -73,7 +70,7 @@ class AutoLinker extends Plugin { const length = url.length; if ( entry.position.offset + entry.length == index + length ) { - const livePos = LivePosition.createFromParentAndOffset( textNode.parent, index ); + const livePos = LivePosition.createFromParentAndOffset( parent, index ); this.editor.model.enqueueChange( writer => { const urlRange = Range.createFromPositionAndShift( livePos, length ); writer.setAttribute( 'link', url, urlRange ); From 0c06f31142e9fc90bd8593a2c36c1d614c1da967 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 9 Mar 2018 10:10:23 +0100 Subject: [PATCH 715/724] Introduced DataController#init method. --- src/controller/datacontroller.js | 34 +++++++++++++++---- tests/controller/datacontroller.js | 52 ++++++++++++++++++++++++++++-- 2 files changed, 77 insertions(+), 9 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 5d9456652..f2d441065 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -9,6 +9,7 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix'; import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import Mapper from '../conversion/mapper'; @@ -100,7 +101,7 @@ export default class DataController { this.upcastDispatcher.on( 'element', convertToModelFragment(), { priority: 'lowest' } ); this.upcastDispatcher.on( 'documentFragment', convertToModelFragment(), { priority: 'lowest' } ); - this.decorate( 'set' ); + this.decorate( 'init' ); } /** @@ -171,18 +172,39 @@ export default class DataController { return viewDocumentFragment; } + /** + * Sets initial input data parsed by the {@link #processor data processor} and + * converted by the {@link #upcastDispatcher view-to-model converters}. + * Initial data can be set only to document that {@link module:engine/model/document~Document#version} is equal 0. + * + * **Note** This method is {@link module:utils/observablemixin~ObservableMixin#decorate decorated} which is + * used by e.g. collaborative editing plugin that syncs remote data on init. + * + * @fires set + * @param {String} data Input data. + * @param {String} [rootName='main'] Root name. + */ + init( data, rootName = 'main' ) { + if ( this.model.document.version ) { + throw new CKEditorError( 'datacontroller-init-document-data-initialized: Trying to set initial data to initialized document.' ); + } + + const modelRoot = this.model.document.getRoot( rootName ); + + this.model.enqueueChange( 'transparent', writer => { + writer.insert( this.parse( data, modelRoot ), modelRoot ); + } ); + } + /** * Sets input data parsed by the {@link #processor data processor} and * converted by the {@link #upcastDispatcher view-to-model converters}. + * This method can be used any time to replace existing editor data by the new one without clearing the + * {@link module:engine/model/document~Document#history document history}. * * This method also creates a batch with all the changes applied. If all you need is to parse data, use * the {@link #parse} method. * - * **Note** This method is {@link module:utils/observablemixin~ObservableMixin#decorate decorated} which is - * used by some plugins to change the behavior of this method. For example, the collaborative editing plugin changes - * this method’s nature to asynchronous by returning a promise. - * - * @fires set * @param {String} data Input data. * @param {String} [rootName='main'] Root name. */ diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index 76feb1592..46528a833 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -7,6 +7,7 @@ import Model from '../../src/model/model'; import Range from '../../src/model/range'; import DataController from '../../src/controller/datacontroller'; import HtmlDataProcessor from '../../src/dataprocessor/htmldataprocessor'; +import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror'; import ModelDocumentFragment from '../../src/model/documentfragment'; import ViewDocumentFragment from '../../src/view/documentfragment'; @@ -152,17 +153,62 @@ describe( 'DataController', () => { } ); } ); - describe( 'set()', () => { + describe( 'init()', () => { it( 'should be decorated', () => { const spy = sinon.spy(); - data.on( 'set', spy ); + data.on( 'init', spy ); - data.set( 'foo bar' ); + data.init( 'foo bar' ); sinon.assert.calledWithExactly( spy, sinon.match.any, [ 'foo bar' ] ); } ); + it( 'should throw an error when document data is already initialized', () => { + data.init( '

Foo

' ); + + expect( () => { + data.init( '

Bar

' ); + } ).to.throw( + CKEditorError, + 'datacontroller-init-document-data-initialized: Trying to set initial data to initialized document.' + ); + } ); + + it( 'should set data to default main root', () => { + schema.extend( '$text', { allowIn: '$root' } ); + data.init( 'foo' ); + + expect( getData( model, { withoutSelection: true } ) ).to.equal( 'foo' ); + } ); + + it( 'should get root name as a parameter', () => { + schema.extend( '$text', { allowIn: '$root' } ); + data.init( 'foo', 'title' ); + + expect( getData( model, { withoutSelection: true, rootName: 'title' } ) ).to.equal( 'foo' ); + } ); + + it( 'should create a batch', () => { + schema.extend( '$text', { allowIn: '$root' } ); + data.init( 'foo' ); + + expect( count( modelDocument.history.getDeltas() ) ).to.equal( 1 ); + } ); + + it( 'should cause firing change event', () => { + const spy = sinon.spy(); + + schema.extend( '$text', { allowIn: '$root' } ); + model.document.on( 'change', spy ); + + data.init( 'foo' ); + + expect( spy.calledOnce ).to.be.true; + } ); + } ); + + describe( 'set()', () => { it( 'should set data to default main root', () => { schema.extend( '$text', { allowIn: '$root' } ); data.set( 'foo' ); From 7775e0062575ea1c6f59275977a3f0e0254eec90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 9 Mar 2018 13:46:17 +0100 Subject: [PATCH 716/724] Docs: Renamed set to init. --- src/controller/datacontroller.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index f2d441065..506ed3f9e 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -265,10 +265,10 @@ export default class DataController { destroy() {} /** - * Event fired by decorated {@link #set} method. + * Event fired by decorated {@link #init} method. * See {@link module:utils/observablemixin~ObservableMixin.decorate} for more information and samples. * - * @event set + * @event init */ } From 6c52281d06fd7ebff2bf241776e59d8092464065 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 9 Mar 2018 14:07:38 +0100 Subject: [PATCH 717/724] Docs: Imporved DataController#init error docs. --- src/controller/datacontroller.js | 11 +++++++++-- tests/controller/datacontroller.js | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 506ed3f9e..80493e548 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -180,13 +180,20 @@ export default class DataController { * **Note** This method is {@link module:utils/observablemixin~ObservableMixin#decorate decorated} which is * used by e.g. collaborative editing plugin that syncs remote data on init. * - * @fires set + * @fires init * @param {String} data Input data. * @param {String} [rootName='main'] Root name. */ init( data, rootName = 'main' ) { if ( this.model.document.version ) { - throw new CKEditorError( 'datacontroller-init-document-data-initialized: Trying to set initial data to initialized document.' ); + /** + * Cannot initialize already initialized data. Data should be initialized only once, during + * {@link module:core/editor/editor~Editor} initialization, when there is no content in + * the {@link module:engine/model/document~Document} yet. + * + * @error datacontroller-init-data-already-initialized + */ + throw new CKEditorError( 'datacontroller-init-data-already-initialized: Trying to set initial data to initialized document.' ); } const modelRoot = this.model.document.getRoot( rootName ); diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index 46528a833..6eefb9999 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -171,7 +171,7 @@ describe( 'DataController', () => { data.init( '

Bar

' ); } ).to.throw( CKEditorError, - 'datacontroller-init-document-data-initialized: Trying to set initial data to initialized document.' + 'datacontroller-init-data-already-initialized: Trying to set initial data to initialized document.' ); } ); From 160af760c2bc507fdb7a60e89d18d806d8d15fac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oskar=20Wr=C3=B3bel?= Date: Fri, 9 Mar 2018 14:19:23 +0100 Subject: [PATCH 718/724] Docs: Improved error docs. --- src/controller/datacontroller.js | 10 +++++----- tests/controller/datacontroller.js | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/controller/datacontroller.js b/src/controller/datacontroller.js index 80493e548..afd365ead 100644 --- a/src/controller/datacontroller.js +++ b/src/controller/datacontroller.js @@ -187,13 +187,13 @@ export default class DataController { init( data, rootName = 'main' ) { if ( this.model.document.version ) { /** - * Cannot initialize already initialized data. Data should be initialized only once, during - * {@link module:core/editor/editor~Editor} initialization, when there is no content in - * the {@link module:engine/model/document~Document} yet. + * Cannot set initial data to not empty {@link module:engine/model/document~Document}. + * Initial data should be set once, during {@link module:core/editor/editor~Editor} initialization, + * when the {@link module:engine/model/document~Document#version} is equal 0. * - * @error datacontroller-init-data-already-initialized + * @error datacontroller-init-document-not-empty */ - throw new CKEditorError( 'datacontroller-init-data-already-initialized: Trying to set initial data to initialized document.' ); + throw new CKEditorError( 'datacontroller-init-document-not-empty: Trying to set initial data to not empty document.' ); } const modelRoot = this.model.document.getRoot( rootName ); diff --git a/tests/controller/datacontroller.js b/tests/controller/datacontroller.js index 6eefb9999..a1e381691 100644 --- a/tests/controller/datacontroller.js +++ b/tests/controller/datacontroller.js @@ -171,7 +171,7 @@ describe( 'DataController', () => { data.init( '

Bar

' ); } ).to.throw( CKEditorError, - 'datacontroller-init-data-already-initialized: Trying to set initial data to initialized document.' + 'datacontroller-init-document-not-empty: Trying to set initial data to not empty document.' ); } ); From 0b58a3d9ca52340677514cce47f0410156bd7562 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Wed, 14 Mar 2018 14:30:50 +0100 Subject: [PATCH 719/724] Docs: Fixed a type ref. --- src/model/document.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/model/document.js b/src/model/document.js index 8378fe6ee..b8e350dff 100644 --- a/src/model/document.js +++ b/src/model/document.js @@ -368,7 +368,7 @@ export default class Document { * during that block execution. * * @event change - * @param {@link module:engine/model/batch~Batch} batch The batch that was used in the executed changes block. + * @param {module:engine/model/batch~Batch} batch The batch that was used in the executed changes block. */ } From 81472c8780907ca000a3a69d7ef316b53de212f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 15 Mar 2018 10:23:52 +0100 Subject: [PATCH 720/724] Internal: Methods should be sorted. --- src/model/model.js | 58 +++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/src/model/model.js b/src/model/model.js index c477f0bd3..f9c76f65b 100644 --- a/src/model/model.js +++ b/src/model/model.js @@ -212,35 +212,6 @@ export default class Model { } } - /** - * Common part of {@link module:engine/model/model~Model#change} and {@link module:engine/model/model~Model#enqueueChange} - * which calls callbacks and returns array of values returned by these callbacks. - * - * @private - * @returns {Array.<*>} Array of values returned by callbacks. - */ - _runPendingChanges() { - const ret = []; - - while ( this._pendingChanges.length ) { - // Create a new writer using batch instance created for this chain of changes. - const currentBatch = this._pendingChanges[ 0 ].batch; - this._currentWriter = new Writer( this, currentBatch ); - - // Execute changes callback and gather the returned value. - const callbackReturnValue = this._pendingChanges[ 0 ].callback( this._currentWriter ); - ret.push( callbackReturnValue ); - - // Fire internal `_change` event. - this.fire( '_change', this._currentWriter ); - - this._pendingChanges.shift(); - this._currentWriter = null; - } - - return ret; - } - /** * {@link module:utils/observablemixin~ObservableMixin#decorate Decorated} function to apply * {@link module:engine/model/operation/operation~Operation operations} on the model. @@ -359,6 +330,35 @@ export default class Model { this.stopListening(); } + /** + * Common part of {@link module:engine/model/model~Model#change} and {@link module:engine/model/model~Model#enqueueChange} + * which calls callbacks and returns array of values returned by these callbacks. + * + * @private + * @returns {Array.<*>} Array of values returned by callbacks. + */ + _runPendingChanges() { + const ret = []; + + while ( this._pendingChanges.length ) { + // Create a new writer using batch instance created for this chain of changes. + const currentBatch = this._pendingChanges[ 0 ].batch; + this._currentWriter = new Writer( this, currentBatch ); + + // Execute changes callback and gather the returned value. + const callbackReturnValue = this._pendingChanges[ 0 ].callback( this._currentWriter ); + ret.push( callbackReturnValue ); + + // Fire internal `_change` event. + this.fire( '_change', this._currentWriter ); + + this._pendingChanges.shift(); + this._currentWriter = null; + } + + return ret; + } + /** * Fired after leaving each {@link module:engine/model/model~Model#enqueueChange} block or outermost * {@link module:engine/model/model~Model#change} block. From fe7194b68b5133c5d9d07e3afdbb3ef55c837af4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 15 Mar 2018 11:37:42 +0100 Subject: [PATCH 721/724] Docs: Changelog. [skip ci] --- CHANGELOG.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d8c7dccc..2eb7a90bd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,89 @@ Changelog ========= +## [1.0.0-beta.1](https://github.com/ckeditor/ckeditor5-engine/compare/v1.0.0-alpha.2...v1.0.0-beta.1) (2018-03-15) + +### Features + +* Add support for the `'word'` unit in the `modifySelection()` helper. ([f37a97a](https://github.com/ckeditor/ckeditor5-engine/commit/f37a97a)) +* Allowed passing `true` as `view.Matcher`'s attribute match to check if that attribute is set. Closes [#1239](https://github.com/ckeditor/ckeditor5-engine/issues/1239). ([bc1c3e5](https://github.com/ckeditor/ckeditor5-engine/commit/bc1c3e5)) +* Consumable type name is now normalized inside `conversion.ModelConsumable` methods. Closes [#1214](https://github.com/ckeditor/ckeditor5-engine/issues/1214). ([131e9c8](https://github.com/ckeditor/ckeditor5-engine/commit/131e9c8)) +* Convert view to model using position. Closes [#1213](https://github.com/ckeditor/ckeditor5-engine/issues/1213). Closes [#1250](https://github.com/ckeditor/ckeditor5-engine/issues/1250). ([1961395](https://github.com/ckeditor/ckeditor5-engine/commit/1961395)) + + Feature: `Schema#findAllowedParent` has been introduced. + Feature: `SchemaContext#concat` has been introduced. +* Engine debug tools can be easily disabled using disableEngineDebug() function. Closes [#1193](https://github.com/ckeditor/ckeditor5-engine/issues/1193). ([0934496](https://github.com/ckeditor/ckeditor5-engine/commit/0934496)) +* Introduced `ViewElementDefinition` and `definition-based-converters` module with a set of utils allowing to turn element definitions to converters. Closes [#1198](https://github.com/ckeditor/ckeditor5-engine/issues/1198). ([d2e9f06](https://github.com/ckeditor/ckeditor5-engine/commit/d2e9f06)) +* Introduced composition observer. Closes [#1329](https://github.com/ckeditor/ckeditor5-engine/issues/1329). ([a0ad8fe](https://github.com/ckeditor/ckeditor5-engine/commit/a0ad8fe)) +* Introduced decorable DataController#init metohd. Closes [ckeditor/ckeditor5-core#120](https://github.com/ckeditor/ckeditor5-core/issues/120). ([d20d660](https://github.com/ckeditor/ckeditor5-engine/commit/d20d660)) +* Introduced two-step caret movement mechanism. Closes [#1289](https://github.com/ckeditor/ckeditor5-engine/issues/1289). ([88bb94c](https://github.com/ckeditor/ckeditor5-engine/commit/88bb94c)) + +### Bug fixes + +* [Firefox] Added fix for typing space on the edge of inline elements. Closes [ckeditor/ckeditor5#692](https://github.com/ckeditor/ckeditor5/issues/692). ([3ea70f3](https://github.com/ckeditor/ckeditor5-engine/commit/3ea70f3)) +* `DocumenSelection#change:range` event will be fired only once after multiple selection live ranges have changed. Closes [#1281](https://github.com/ckeditor/ckeditor5-engine/issues/1281). ([b26935c](https://github.com/ckeditor/ckeditor5-engine/commit/b26935c)) +* `model.DocumentSelection` should update it's attributes after each change, including external changes. Closes [#1267](https://github.com/ckeditor/ckeditor5-engine/issues/1267). ([b91d967](https://github.com/ckeditor/ckeditor5-engine/commit/b91d967)) +* `Model#insertContent()` will not merge nodes if the model after the merge would violate schema rules. Closes [ckeditor/ckeditor5#730](https://github.com/ckeditor/ckeditor5/issues/730). ([2a73830](https://github.com/ckeditor/ckeditor5-engine/commit/2a73830)) +* `Schema#getLimitElement()` will return a proper limit element (the root element) if one of the selection's ranges have the root element as the limit element. Closes [#1275](https://github.com/ckeditor/ckeditor5-engine/issues/1275). ([050a415](https://github.com/ckeditor/ckeditor5-engine/commit/050a415)) +* Added a 50ms timeout after `Document#focus` event before rendering to be sure that selection changes are processed on Firefox and Safari. Closes [ckeditor/ckeditor5#676](https://github.com/ckeditor/ckeditor5/issues/676). Closes [#1157](https://github.com/ckeditor/ckeditor5-engine/issues/1157). Closes [#1155](https://github.com/ckeditor/ckeditor5-engine/issues/1155). Closes [#1153](https://github.com/ckeditor/ckeditor5-engine/issues/1153). ([aba8e68](https://github.com/ckeditor/ckeditor5-engine/commit/aba8e68)) +* Added missing parse context in `DataController#set()`. Closes [#1278](https://github.com/ckeditor/ckeditor5-engine/issues/1278). ([8c56dce](https://github.com/ckeditor/ckeditor5-engine/commit/8c56dce)) +* Corrected how change items in `model.Differ` are dismissed if they are in inserted/removed parent. Closes https://github.com/ckeditor/ckeditor5/issues/733. ([e70ab96](https://github.com/ckeditor/ckeditor5-engine/commit/e70ab96)) +* Corrected offsets transformation in `model.Differ` when multiple change items interfere with each other. Closes [#1309](https://github.com/ckeditor/ckeditor5-engine/issues/1309). Closes https://github.com/ckeditor/ckeditor5/issues/849. ([30dcf6c](https://github.com/ckeditor/ckeditor5-engine/commit/30dcf6c)) +* Fixed a bug where Firefox would throw an `NS_ERROR_FAILURE` error when moving selection from a nested editable to the root editable. Closes [ckeditor/ckeditor5#721](https://github.com/ckeditor/ckeditor5/issues/721). ([4b7d435](https://github.com/ckeditor/ckeditor5-engine/commit/4b7d435)) +* Fixed memory leak in `DocumentSelection`. Closes [#903](https://github.com/ckeditor/ckeditor5-engine/issues/903). ([7e352e3](https://github.com/ckeditor/ckeditor5-engine/commit/7e352e3)) +* Improved how `model.Differ` checks whether the operation should be buffered or not. Closes [#1326](https://github.com/ckeditor/ckeditor5-engine/issues/1326). ([3e9f81b](https://github.com/ckeditor/ckeditor5-engine/commit/3e9f81b)) +* It should not be possible to move a `model.Node` from a `model.Document` to a `model.DocumentFragment`. Closes [#1337](https://github.com/ckeditor/ckeditor5-engine/issues/1337). ([24b97f5](https://github.com/ckeditor/ckeditor5-engine/commit/24b97f5)) +* Registered $marker element in Schema. Closes [#1317](https://github.com/ckeditor/ckeditor5-engine/issues/1317). ([2d1d62f](https://github.com/ckeditor/ckeditor5-engine/commit/2d1d62f)) +* The fake selection container will not leak into the viewport. Closes [ckeditor/ckeditor5#752](https://github.com/ckeditor/ckeditor5/issues/752). ([3f059a7](https://github.com/ckeditor/ckeditor5-engine/commit/3f059a7)) +* View stringify utility now sorts CSS classes and values in `style` attribute. Closes [#1179](https://github.com/ckeditor/ckeditor5-engine/issues/1179). ([fc7da80](https://github.com/ckeditor/ckeditor5-engine/commit/fc7da80)) + +### Other changes + +* Cleaned up the model, document and controllers API. Closes [#1208](https://github.com/ckeditor/ckeditor5-engine/issues/1208). ([aea6119](https://github.com/ckeditor/ckeditor5-engine/commit/aea6119)) +* Conversion utilities refactor. Closes [#1236](https://github.com/ckeditor/ckeditor5-engine/issues/1236). ([fd128a1](https://github.com/ckeditor/ckeditor5-engine/commit/fd128a1)) +* Fix `render()` and `change()` flow. Introduce postfixers in view. Closes [#1312](https://github.com/ckeditor/ckeditor5-engine/issues/1312). ([63b9d14](https://github.com/ckeditor/ckeditor5-engine/commit/63b9d14)) +* Introduced several improvements to conversion helpers. Closes [#1295](https://github.com/ckeditor/ckeditor5-engine/issues/1295). Closes [#1293](https://github.com/ckeditor/ckeditor5-engine/issues/1293). Closes [#1292](https://github.com/ckeditor/ckeditor5-engine/issues/1292). Closes [#1291](https://github.com/ckeditor/ckeditor5-engine/issues/1291). Closes [#1290](https://github.com/ckeditor/ckeditor5-engine/issues/1290). Closes [#1305](https://github.com/ckeditor/ckeditor5-engine/issues/1305). ([809ea24](https://github.com/ckeditor/ckeditor5-engine/commit/809ea24)) +* Keep the same marker instance when marker is updated. ([8eba5e9](https://github.com/ckeditor/ckeditor5-engine/commit/8eba5e9)) +* Make `Position` and `Range` immutable in model and view. Closes [#897](https://github.com/ckeditor/ckeditor5-engine/issues/897). ([836dfd8](https://github.com/ckeditor/ckeditor5-engine/commit/836dfd8)) +* Manual test for [#475](https://github.com/ckeditor/ckeditor5-engine/issues/475) now works correctly. Closes [#1271](https://github.com/ckeditor/ckeditor5-engine/issues/1271). ([c2d4cec](https://github.com/ckeditor/ckeditor5-engine/commit/c2d4cec)) +* Methods which modify the model's and view's tree are now protected and shouldn't be used directly in the code. Iinstance of `Writer` should be used instead. Closes [#738](https://github.com/ckeditor/ckeditor5-engine/issues/738). ([a4f3dad](https://github.com/ckeditor/ckeditor5-engine/commit/a4f3dad)) +* Migrated package styles to PostCSS. Moved visual styles to ckeditor5-theme-lark (see [ckeditor/ckeditor5-ui#144](https://github.com/ckeditor/ckeditor5-ui/issues/144)). ([5f65823](https://github.com/ckeditor/ckeditor5-engine/commit/5f65823)) +* Moved `consumable` parameter to `conversionApi` parameter in downcast. Closes [#1294](https://github.com/ckeditor/ckeditor5-engine/issues/1294). Closes [#1261](https://github.com/ckeditor/ckeditor5-engine/issues/1261). ([731db37](https://github.com/ckeditor/ckeditor5-engine/commit/731db37)) +* Moved `Document#getNearesetSelectionRange` to `Schema`. Closes [#1227](https://github.com/ckeditor/ckeditor5-engine/issues/1227). ([d1838a4](https://github.com/ckeditor/ckeditor5-engine/commit/d1838a4)) +* Moved selection methods to `Writer`, introduced `LiveSelection`. Closes [#1209](https://github.com/ckeditor/ckeditor5-engine/issues/1209). ([7db1fee](https://github.com/ckeditor/ckeditor5-engine/commit/7db1fee)) +* Operations that do not operate on a document should have `baseVersion` set to `null`. Closes [#1211](https://github.com/ckeditor/ckeditor5-engine/issues/1211). ([b527d7f](https://github.com/ckeditor/ckeditor5-engine/commit/b527d7f)) + + Fixed: Markers again are properly converted in `engine.controller.DataController`. + Fixed: Markers are cleared now before an operation is applied to `model.Document` tree to fix scenarios where marker range could not be converted to the view after the model changed. +* Prevented `Writer` from usage outside of the `change` block. Closes [#1212](https://github.com/ckeditor/ckeditor5-engine/issues/1212). ([2592bf1](https://github.com/ckeditor/ckeditor5-engine/commit/2592bf1)) +* Provided one API for two types of markers, improved docs. Closes [#1086](https://github.com/ckeditor/ckeditor5-engine/issues/1086). ([bfe23c9](https://github.com/ckeditor/ckeditor5-engine/commit/bfe23c9)) +* Refactor: engine/model reorganization, introducing new chnage and enqueueChange block, split batch/writer. Related: [#1186](https://github.com/ckeditor/ckeditor5-engine/issues/1186). ([5be1ad6](https://github.com/ckeditor/ckeditor5-engine/commit/5be1ad6)) +* Refactored events fired by model classes. Closes [#1207](https://github.com/ckeditor/ckeditor5-engine/issues/1207). ([f56bddf](https://github.com/ckeditor/ckeditor5-engine/commit/f56bddf)) +* Refactoring of the view API. Closes [#1210](https://github.com/ckeditor/ckeditor5-engine/issues/1210). ([dd9ae51](https://github.com/ckeditor/ckeditor5-engine/commit/dd9ae51)) +* Refactoring: Conversion refactoring. Introduced `model.Differ`. Changes now will be converted after all changes in a change block are done. Closes [#1172](https://github.com/ckeditor/ckeditor5-engine/issues/1172). ([6479bfd](https://github.com/ckeditor/ckeditor5-engine/commit/6479bfd)) +* Refactoring: make writer a protected operations util. ([440dfc7](https://github.com/ckeditor/ckeditor5-engine/commit/440dfc7)) +* Rewritten the Schema API. Closes [#532](https://github.com/ckeditor/ckeditor5-engine/issues/532). ([4e4f5c3](https://github.com/ckeditor/ckeditor5-engine/commit/4e4f5c3)) +* Simplified model to view selection conversion. Closes [#1238](https://github.com/ckeditor/ckeditor5-engine/issues/1238). ([9a53251](https://github.com/ckeditor/ckeditor5-engine/commit/9a53251)) +* UIElement custom `render()` method can be now provided without using inheritance. Closes [#1254](https://github.com/ckeditor/ckeditor5-engine/issues/1254). ([e05b8b1](https://github.com/ckeditor/ckeditor5-engine/commit/e05b8b1)) + +### BREAKING CHANGES + +* `view.Writer` is no longer an object literal with functions but a class. +* Introduced new method of creating custom UIElements. +* View document is now separated from the DOM. `view.Renderer`, `view.DomConverter` and observers are moved to `view.View`. +* `view#event:render` is introduced to indicate a moment when all changes are applied and document may be rendered to the DOM. +* Downcast converter helpers no longer accepts view elements instances as constructors are now protected. Callbacks using view writer should be used. +* Writer should be now used to set or remove markers, instead of MarkerCollection. +* View controller `view.View` is introduced. Changes to the view document tree structure should be done by using writer provided to callback in `view.change()` method. +* `ViewConversionApi#splitToAllowedParent` has been introduced. +* `ViewConversionApi#storage` has been introduced. +* `ViewConsumable` has been merged to `ViewConversionApi`. +* Format od data object passed across conversion callback has been changed. +Feature: `Schema#findAllowedParent` has been introduced. +Feature: `SchemaContext#concat` has been introduced. +* `DataController#parse`, `DataController#toModel`, `ViewConversionDispatcher#convert` gets `SchemaContextDefinition` as a contex instead of `String`. + + ## [1.0.0-alpha.2](https://github.com/ckeditor/ckeditor5-engine/compare/v1.0.0-alpha.1...v1.0.0-alpha.2) (2017-11-14) ### Bug fixes From 8fa9eb5a3d0e1d0e4f3ead3b71b482ebde3d483a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 15 Mar 2018 12:38:15 +0100 Subject: [PATCH 722/724] Docs: Corrected the changelog. [skip ci] --- CHANGELOG.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2eb7a90bd..ef8f1d051 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,14 @@ Changelog ## [1.0.0-beta.1](https://github.com/ckeditor/ckeditor5-engine/compare/v1.0.0-alpha.2...v1.0.0-beta.1) (2018-03-15) +### Major refactoring + +In 1.0.0-beta.1 the engine's API has underwent a thorough review which resulted in a deep refactoring. Most of the underlying concepts and architecture remained untouched. The API, though, is brand new. The changes are huge and, in this package exclusively, resulted in changing 40.000 LOC. Therefore, the list of changes below is neither complete nor will explain you how the engine is structured now and how to should migrate to this version. + +Instead, we recommend reading https://docs.ckeditor.com/ckeditor5/latest/framework/guides/architecture/editing-engine.html once more (it will be updated in a couple of days after the release). + +The good news is that the our focus when designing the new API was on developer experience. APIs which were dangerous or confusing were removed or hidden and new APIs were added in their place. The engine is now safer and more useful library and we hope you'll enjoy it :). + ### Features * Add support for the `'word'` unit in the `modifySelection()` helper. ([f37a97a](https://github.com/ckeditor/ckeditor5-engine/commit/f37a97a)) @@ -10,8 +18,8 @@ Changelog * Consumable type name is now normalized inside `conversion.ModelConsumable` methods. Closes [#1214](https://github.com/ckeditor/ckeditor5-engine/issues/1214). ([131e9c8](https://github.com/ckeditor/ckeditor5-engine/commit/131e9c8)) * Convert view to model using position. Closes [#1213](https://github.com/ckeditor/ckeditor5-engine/issues/1213). Closes [#1250](https://github.com/ckeditor/ckeditor5-engine/issues/1250). ([1961395](https://github.com/ckeditor/ckeditor5-engine/commit/1961395)) - Feature: `Schema#findAllowedParent` has been introduced. - Feature: `SchemaContext#concat` has been introduced. + Feature: `Schema#findAllowedParent()` has been introduced. + Feature: `SchemaContext#concat()` has been introduced. * Engine debug tools can be easily disabled using disableEngineDebug() function. Closes [#1193](https://github.com/ckeditor/ckeditor5-engine/issues/1193). ([0934496](https://github.com/ckeditor/ckeditor5-engine/commit/0934496)) * Introduced `ViewElementDefinition` and `definition-based-converters` module with a set of utils allowing to turn element definitions to converters. Closes [#1198](https://github.com/ckeditor/ckeditor5-engine/issues/1198). ([d2e9f06](https://github.com/ckeditor/ckeditor5-engine/commit/d2e9f06)) * Introduced composition observer. Closes [#1329](https://github.com/ckeditor/ckeditor5-engine/issues/1329). ([a0ad8fe](https://github.com/ckeditor/ckeditor5-engine/commit/a0ad8fe)) @@ -68,9 +76,10 @@ Changelog ### BREAKING CHANGES +* **Note:** See the "Major refactoring" section above. * `view.Writer` is no longer an object literal with functions but a class. -* Introduced new method of creating custom UIElements. -* View document is now separated from the DOM. `view.Renderer`, `view.DomConverter` and observers are moved to `view.View`. +* Introduced new method of creating custom UIElements. +* View document is now separated from the DOM. `view.Renderer`, `view.DomConverter` and observers are moved to `view.View`. * `view#event:render` is introduced to indicate a moment when all changes are applied and document may be rendered to the DOM. * Downcast converter helpers no longer accepts view elements instances as constructors are now protected. Callbacks using view writer should be used. * Writer should be now used to set or remove markers, instead of MarkerCollection. From e55efe519a05310fca24c1c2fac524cb4f1b24b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 15 Mar 2018 12:41:15 +0100 Subject: [PATCH 723/724] Internal: Updated dependencies. [skip ci] --- package.json | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/package.json b/package.json index e386cfcba..ecc36a96f 100644 --- a/package.json +++ b/package.json @@ -7,20 +7,20 @@ "ckeditor5-lib" ], "dependencies": { - "@ckeditor/ckeditor5-utils": "^1.0.0-alpha.2" + "@ckeditor/ckeditor5-utils": "^1.0.0-beta.1" }, "devDependencies": { - "@ckeditor/ckeditor5-basic-styles": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-core": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-editor-classic": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-enter": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-essentials": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-heading": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-list": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-typing": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-undo": "^1.0.0-alpha.2", - "@ckeditor/ckeditor5-widget": "^1.0.0-alpha.2", + "@ckeditor/ckeditor5-basic-styles": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-core": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-editor-classic": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-enter": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-essentials": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-heading": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-list": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-paragraph": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-typing": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-undo": "^1.0.0-beta.1", + "@ckeditor/ckeditor5-widget": "^1.0.0-beta.1", "eslint": "^4.15.0", "eslint-config-ckeditor5": "^1.0.7", "husky": "^0.14.3", From 40f9d006afbf399b5ef6797f9d0e155b35b72683 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 15 Mar 2018 12:45:04 +0100 Subject: [PATCH 724/724] Release: v1.0.0-beta.1. --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index ecc36a96f..59242ec97 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ckeditor/ckeditor5-engine", - "version": "1.0.0-alpha.2", + "version": "1.0.0-beta.1", "description": "CKEditor 5 editing engine.", "keywords": [ "ckeditor5",