mediawiki-extensions-Visual.../modules/ve/test/ve.BranchNode.test.js
Timo Tijhof 88f6089952 Kranitor #1: On-boarding
'''Kranitor commits''' are commits by Krinkle with his janitor hat on.
Must never contain functional changes mixed with miscellaneous changes.

.gitignore:
 * Add .DS_Store to the ignore list so that browsing the directories
   on Mac OS X, will not add these files to the list of untracked
   files.
 * Fix missing newline at end of file

.jshintrc
 * raises -> throws
 * +module (QUnit.module)
 * remove 'Node' (as of node-jshint 1.7.2 this is now part of
   'browser:true', as it should be)

Authors:
 * Adding myself

MWExtension/VisualEditor.php
 * Fix default value of wgVisualEditorParsoidURL to not
   point to the experimental instance in WMF Labs.

Issues:
 * ve.ce.TextNode:
  - Fix TODO: Don't perform a useless clone of an already-jQuerified object.
  - Use .html() to set html content instead of encapsulating between
    two strings. This is slightly faster but more importantly safer,
    and prevents situations where the resulting jQuery collection
    actually contains 2 elements instead of 1, thus messing up
    what .contents() is iterating over.
 * ve.ce.Document.test.js
  - Fix: ReferenceError: assert is not defined
 * ve.dm.Document.test.js
  - Fix: ReferenceError: assert is not defined
 * ve.dm.Transaction.test.js
  - Fix: ReferenceError: assert is not defined
 * ve.dm.TransactionProcessor.test.js
  - Fix: ReferenceError: assert is not defined
 * ext.visualEditor.viewPageTarget
  - Missing dependency on 'mediawiki.Title'

Code conventions / Misc cleanup
 * Various JSHint warnings.
 * Whitespace
 * jQuery(): Use '<tag>' for element creation,
   use '<valid><xml/></valid>' for parsing
 * Use the default operator instead of ternary when the condition and
   first value are the same.
   x = foo ? foo : bar; -> x = foo || bar;
   Because contrary to some programming language (PHP...), in JS the
   default operator does not enforce a boolean result but returns the
   original value, hence it being called the 'default' operator, as
   opposed to the 'or' operator.
 * No need to call addClass() twice, it takes a space-separated list
   (jQuery splits by space and adds if needed)
 * Use .on( event[, selector], fn ) instead of the deprecated
   routers to it such as .bind(), .delegate() and .live().
   All these three are now built-in and fully compatible with .on()
 * Add 'XXX:' comments for suspicious code that I don't want to change
   as part of a clean up commit.
 * Remove unused variables (several var x = this; where x was not
   used anywhere, possibly from boilerplate copy/paste)
 * Follows-up Trevor's commit that converts test suites to the new
   QUnit format. Also removed the globals since we no longer use those
   any more.

Change-Id: I7e37c9bff812e371c7f65a6fd85d9e2af3e0a22f
2012-07-27 14:40:00 -07:00

211 lines
7.3 KiB
JavaScript

/**
* VisualEditor BranchNode tests.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
QUnit.module( 've.BranchNode' );
/* Stubs */
ve.BranchNodeStub = function ( children ) {
// Inheritance
ve.BranchNode.call( this, children );
};
ve.extendClass( ve.BranchNodeStub, ve.BranchNode );
/* Tests */
QUnit.test( 'getChildren', 2, function ( assert ) {
var node1 = new ve.BranchNodeStub(),
node2 = new ve.BranchNodeStub( [node1] );
assert.deepEqual( node1.getChildren(), [] );
assert.deepEqual( node2.getChildren(), [node1] );
} );
QUnit.test( 'indexOf', 4, function ( assert ) {
var node1 = new ve.BranchNodeStub(),
node2 = new ve.BranchNodeStub(),
node3 = new ve.BranchNodeStub(),
node4 = new ve.BranchNodeStub( [node1, node2, node3] );
assert.strictEqual( node4.indexOf( null ), -1 );
assert.strictEqual( node4.indexOf( node1 ), 0 );
assert.strictEqual( node4.indexOf( node2 ), 1 );
assert.strictEqual( node4.indexOf( node3 ), 2 );
} );
QUnit.test( 'traverseLeafNodes', 1, function ( assert ) {
var fragment = new ve.dm.Document( ve.dm.example.data ),
docNode = fragment.getDocumentNode(),
children = docNode.getChildren(),
tests = [
// Test 1 & 2
{
'node': docNode,
'output': [
children[0].children[0],
children[1].children[0].children[0].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[2].children[0].children[0].children[0],
children[2].children[0],
children[2].children[1],
children[2].children[2],
children[3].children[0].children[0].children[0],
children[3].children[1].children[0].children[0],
children[4].children[0],
children[5].children[0]
],
'reverse': true,
'desc': 'Traversing the entire document returns all leaf nodes'
},
// Test 3 & 4
{
'node': docNode,
'output': [
children[0].children[0],
children[1].children[0].children[0].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0]
],
'reverse': [
children[5].children[0],
children[4].children[0],
children[3].children[1].children[0].children[0],
children[3].children[0].children[0].children[0],
children[2].children[2],
children[2].children[1],
children[2].children[0],
children[1].children[0].children[0].children[0].children[2].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0]
],
'callback': function ( node ) {
if ( node === children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0] ) {
return false;
}
},
'desc': 'Returning false from the callback stops the traversal'
},
// Test 5 & 6
{
'node': docNode,
'output': [
children[2].children[0],
children[2].children[1],
children[2].children[2],
children[3].children[0].children[0].children[0],
children[3].children[1].children[0].children[0],
children[4].children[0],
children[5].children[0]
],
'reverse': [
children[2].children[0],
children[1].children[0].children[0].children[0].children[2].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[0].children[0],
children[0].children[0]
],
'from': children[2].children[0],
'desc': 'Starting at a leaf node returns that leaf node and everything after it',
'reverseDesc': 'Starting at a leaf node returns that leaf node and everything before it (in reverse)'
},
// Test 7 & 8
{
'node': docNode,
'output': [
children[1].children[0].children[0].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[2].children[0].children[0].children[0],
children[2].children[0],
children[2].children[1],
children[2].children[2],
children[3].children[0].children[0].children[0],
children[3].children[1].children[0].children[0],
children[4].children[0],
children[5].children[0]
],
'reverse': [
children[0].children[0]
],
'from': children[1],
'desc': 'Starting at a non-leaf node returns all leaf nodes inside and after it',
'reverseDesc': 'Starting at a non-leaf node returns all leaf nodes before it and none inside (in reverse)'
},
// Test 9 & 10
{
'node': children[1],
'output': [
children[1].children[0].children[0].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[1].children[0].children[1].children[0].children[0].children[0],
children[1].children[0].children[0].children[0].children[2].children[0].children[0].children[0]
],
'reverse': true,
'desc': 'Calling traverseLeafNodes() on a non-root node only returns leaf nodes inside that node'
},
// Test 11
{
'node': children[1],
'from': children[2],
'exception': /^from parameter passed to traverseLeafNodes\(\) must be a descendant$/,
'desc': 'Passing a sibling for from results in an exception'
}
];
function executeTest( test ) {
var realLeaves = [],
callback = function ( node ) {
var retval;
realLeaves.push( node );
if ( test.callback ) {
retval = test.callback( node );
if ( retval !== undefined ) {
return retval;
}
}
},
f = function () {
test.node.traverseLeafNodes( callback, test.from, test.isReversed );
};
if ( test.exception ) {
assert.throws( f, test.exception, test.desc );
} else {
f();
assert.ok( ve.compareArrays( realLeaves, test.output ), test.desc );
}
}
var count = 0;
for ( var t = 0; t < tests.length; t++ ) {
if ( tests[t].hasOwnProperty( 'reverse' ) ) {
count++;
}
count++;
}
QUnit.expect( count );
for ( var i = 0; i < tests.length; i++ ) {
executeTest( tests[i] );
if ( tests[i].reverse !== undefined ) {
var reversed = {
'node': tests[i].node,
'from': tests[i].from,
'callback': tests[i].callback,
'exception': tests[i].exception,
'isReversed': true,
'desc': tests[i].reverseDesc || tests[i].desc + ' (in reverse)'
};
if ( tests[i].output !== undefined && tests[i].reverse === true ) {
reversed.output = tests[i].output.reverse();
} else {
reversed.output = tests[i].reverse;
}
executeTest( reversed );
}
}
} );