mediawiki-extensions-Visual.../modules/ve/test/dm/ve.dm.DocumentSynchronizer.test.js
Trevor Parscal 8d33a3de0d Major Documentation Cleanup
* Made method descriptions imperative: "Do this" rather than "Does this"
* Changed use of "this object" to "the object" in method documentation
* Added missing documentation
* Fixed incorrect documentation
* Fixed incorrect debug method names (as in those VeDmClassName tags we add to functions so they make sense when dumped into in the console)
* Normalized use of package names throughout
* Normalized class descriptions
* Removed incorrect @abstract tags
* Added missing @method tags
* Lots of other minor cleanup

Change-Id: I4ea66a2dd107613e2ea3a5f56ff54d675d72957e
2013-01-16 15:37:59 -08:00

69 lines
3 KiB
JavaScript

/*!
* VisualEditor DataModel DocumentSynchronizer tests.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
QUnit.module( 've.dm.DocumentSynchronizer' );
/* Tests */
QUnit.test( 'getDocument', 1, function ( assert ) {
var doc = new ve.dm.Document( ve.copyArray( ve.dm.example.data ) ),
ds = new ve.dm.DocumentSynchronizer( doc );
assert.strictEqual( ds.getDocument(), doc );
} );
QUnit.test( 'synchronize', 6, function ( assert ) {
var doc = new ve.dm.Document( ve.copyArray( ve.dm.example.data ) ),
ds = new ve.dm.DocumentSynchronizer( doc ),
firstTextNodeUpdates = 0,
firstTextNodeAnnotations = 0,
firstTextNodeLengthChanges = [],
secondTextNodeUpdates = 0,
secondTextNodeAnnotations = 0,
secondTextNodeLengthChanges = [];
// Annotate "a" with bold formatting
doc.data[1] = ['a', new ve.AnnotationSet( [ new ve.dm.TextStyleBoldAnnotation() ] )];
ds.pushAnnotation( new ve.Range( 1, 2 ) );
// Insert "xyz" between "a" and "b"
doc.spliceData( 2, 0, [ 'x', 'y', 'z' ] );
ds.pushResize( doc.getDocumentNode().getNodeFromOffset( 2 ), 3 );
// Annotate "d" with italic formatting (was at 10, now at 13)
doc.data[13] = ['d', new ve.AnnotationSet( [ new ve.dm.TextStyleItalicAnnotation() ] )];
ds.pushAnnotation( new ve.Range( 10, 11 ) );
doc.getDocumentNode().getChildren()[0].getChildren()[0].on( 'update', function () {
firstTextNodeUpdates++;
} );
doc.getDocumentNode().getChildren()[0].getChildren()[0].on( 'annotation', function () {
firstTextNodeAnnotations++;
} );
doc.getDocumentNode().getChildren()[0].getChildren()[0].on( 'lengthChange', function ( diff ) {
firstTextNodeLengthChanges.push( diff );
} );
doc.getDocumentNode().getChildren()[1].getChildren()[0].getChildren()[0].getChildren()[0].getChildren()[0].getChildren()[0]
.on( 'update', function () {
secondTextNodeUpdates++;
} );
doc.getDocumentNode().getChildren()[1].getChildren()[0].getChildren()[0].getChildren()[0].getChildren()[0].getChildren()[0]
.on( 'annotation', function () {
secondTextNodeAnnotations++;
} );
doc.getDocumentNode().getChildren()[1].getChildren()[0].getChildren()[0].getChildren()[0].getChildren()[0].getChildren()[0]
.on( 'lengthChange', function ( diff ) {
secondTextNodeLengthChanges.push( diff );
} );
ds.synchronize();
// TODO technically this should be 1, not 2, see DocumentSynchronizer.synchronizers.resize
assert.deepEqual( firstTextNodeUpdates, 2, 'annotation and insertion each trigger update event (1st paragraph)' );
assert.deepEqual( firstTextNodeAnnotations, 1, 'annotation triggers annotation event (1st paragraph)' );
assert.deepEqual( firstTextNodeLengthChanges, [ 3 ], 'insertion triggers lengthChange event (1st paragraph)' );
assert.deepEqual( secondTextNodeUpdates, 1, 'annotation triggers update event (2nd paragraph)' );
assert.deepEqual( secondTextNodeAnnotations, 1, 'annotation triggers annotation event (2nd paragraph)' );
assert.deepEqual( secondTextNodeLengthChanges, [], 'lengthChange not triggered for 2nd paragraph' );
} );