Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Fix: Graveyard changes are correctly handled in Differ for new operat…
Browse files Browse the repository at this point in the history 
…ions.
  • Loading branch information
@scofalik
scofalik committed Sep 10, 2018
1 parent 2ef33b1 commit 4b4db90
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 1 deletion.
39 changes: 38 additions & 1 deletion src/model/differ.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,39 +183,71 @@ export default class Differ {
case 'split': {
const splitElement = operation.position.parent;

// Mark that children of the split element were removed.
if ( !this._isInInsertedElement( splitElement ) ) {
this._markRemove( splitElement, operation.position.offset, operation.howMany );
}

// Mark that the new element (split copy) was inserted.
if ( !this._isInInsertedElement( splitElement.parent ) ) {
this._markInsert( splitElement.parent, operation.insertionPosition.offset, 1 );
}

// If the split took the element from the graveyard, mark that the element from the graveyard was removed.
if ( operation.graveyardPosition ) {
const graveyardParent = operation.graveyardPosition.parent;

this._markRemove( graveyardParent, operation.graveyardPosition.offset, 1 );
}

break;
}
case 'merge': {
// Mark that the merged element was removed.
const mergedElement = operation.sourcePosition.parent;
const mergedIntoElement = operation.targetPosition.parent;

if ( !this._isInInsertedElement( mergedElement.parent ) ) {
this._markRemove( mergedElement.parent, mergedElement.startOffset, 1 );
}

// Mark that the merged element was inserted into graveyard.
// The `isInsertedElement` check might not be needed but there is one case in OT where merged element
// is inserted into wrapping element.
const graveyardParent = operation.graveyardPosition.parent;

if ( !this._isInInsertedElement( graveyardParent ) ) {
this._markInsert( graveyardParent, operation.graveyardPosition.offset, 1 );
}

// Mark that children of merged element were inserted at new parent.
const mergedIntoElement = operation.targetPosition.parent;

if ( !this._isInInsertedElement( mergedIntoElement ) ) {
this._markInsert( mergedIntoElement, operation.targetPosition.offset, mergedElement.maxOffset );
}

break;
}
case 'wrap': {
// Mark that some elements were removed from their original parent and that a new (wrapper) element
// was added in that parent.
if ( !this._isInInsertedElement( operation.position.parent ) ) {
this._markRemove( operation.position.parent, operation.position.offset, operation.howMany );
this._markInsert( operation.position.parent, operation.position.offset, 1 );
}

// If the wrap took the element from the graveyard, mark that the element from the graveyard was removed.
if ( operation.graveyardPosition ) {
const graveyardParent = operation.graveyardPosition.parent;

this._markRemove( graveyardParent, operation.graveyardPosition.offset, 1 );
}

break;
}
case 'unwrap': {
// Mark that the unwrapped element was removed from its original parent and that new (unwrapped) nodes
// were inserted in that parent.
const elementToUnwrap = operation.position.parent;
const offset = elementToUnwrap.startOffset;
const parent = elementToUnwrap.parent;
Expand All @@ -225,6 +257,11 @@ export default class Differ {
this._markInsert( parent, offset, elementToUnwrap.maxOffset );
}

// Mark that the unwrapped element was moved to the graveyard.
const graveyardParent = operation.graveyardPosition.parent;

this._markInsert( graveyardParent, operation.graveyardPosition.offset, 1 );

break;
}
}
Expand Down
65 changes: 65 additions & 0 deletions tests/model/differ.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1302,6 +1302,29 @@ describe( 'Differ', () => {
] );
} );
} );

it( 'should correctly mark a change in graveyard', () => {
model.change( () => {
merge( new Position( root, [ 1, 0 ] ), new Position( root, [ 0, 3 ] ) );
} );

model.change( () => {
const operation = new SplitOperation(
new Position( root, [ 0, 3 ] ),
3,
new Position( doc.graveyard, [ 0 ] ),
doc.version
);

model.applyOperation( operation );

expectChanges( [
{ type: 'remove', name: 'paragraph', length: 1, position: new Position( doc.graveyard, [ 0 ] ) },
{ type: 'remove', name: '$text', length: 3, position: new Position( root, [ 0, 3 ] ) },
{ type: 'insert', name: 'paragraph', length: 1, position: new Position( root, [ 1 ] ) }
], true );
} );
} );
} );

describe( 'merge', () => {
Expand Down Expand Up @@ -1356,6 +1379,18 @@ describe( 'Differ', () => {
] );
} );
} );

it( 'should correctly mark a change in graveyard', () => {
model.change( () => {
merge( new Position( root, [ 1, 0 ] ), new Position( root, [ 0, 3 ] ) );

expectChanges( [
{ type: 'insert', name: 'paragraph', length: 1, position: new Position( doc.graveyard, [ 0 ] ) },
{ type: 'insert', name: '$text', length: 3, position: new Position( root, [ 0, 3 ] ) },
{ type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 1 ] ) }
], true );
} );
} );
} );

describe( 'wrap', () => {
Expand Down Expand Up @@ -1399,6 +1434,24 @@ describe( 'Differ', () => {
] );
} );
} );

it( 'should correctly mark a change in graveyard', () => {
model.change( () => {
unwrap( new Position( root, [ 0, 0 ] ) );
} );

model.change( () => {
const operation = new WrapOperation( new Position( root, [ 0 ] ), 3, new Position( doc.graveyard, [ 0 ] ), doc.version );

model.applyOperation( operation );

expectChanges( [
{ type: 'remove', name: 'paragraph', length: 1, position: new Position( doc.graveyard, [ 0 ] ) },
{ type: 'remove', name: '$text', length: 3, position: new Position( root, [ 0 ] ) },
{ type: 'insert', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) }
], true );
} );
} );
} );

describe( 'unwrap', () => {
Expand Down Expand Up @@ -1452,6 +1505,18 @@ describe( 'Differ', () => {
] );
} );
} );

it( 'should correctly mark a change in graveyard', () => {
model.change( () => {
unwrap( new Position( root, [ 0, 0 ] ) );

expectChanges( [
{ type: 'insert', name: 'paragraph', length: 1, position: new Position( doc.graveyard, [ 0 ] ) },
{ type: 'remove', name: 'paragraph', length: 1, position: new Position( root, [ 0 ] ) },
{ type: 'insert', name: '$text', length: 3, position: new Position( root, [ 0 ] ) }
], true );
} );
} );
} );

describe( 'markers', () => {
Expand Down

0 comments on commit 4b4db90

Please sign in to comment.