wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-25 06:46:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Visual.../modules/ve/test/ve.BranchNode.test.js
Timo Tijhof b1d9c83b5d Object management: Object create/inherit/clone utilities 
* For the most common case:
  - replace ve.extendClass with ve.inheritClass (chose slightly
    different names to detect usage of the old/new one, and I
    like 'inherit' better).
  - move it up to below the constructor, see doc block for why.

* Cases where more than 2 arguments were passed to
  ve.extendClass are handled differently depending on the case.

  In case of a longer inheritance tree, the other arguments
  could be omitted (like in "ve.ce.FooBar, ve.FooBar,
  ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar,
  because ve.ce.FooBar inherits from ve.Bar).

  In the case of where it previously had two mixins with
  ve.extendClass(), either one becomes inheritClass and one
  a mixin, both to mixinClass().

  No visible changes should come from this commit as the
  instances still all have the same visible properties in the
  end. No more or less than before.

* Misc.:
 - Be consistent in calling parent constructors in the
   same order as the inheritance.
 - Add missing @extends and @param documentation.
 - Replace invalid {Integer} type hint with {Number}.
 - Consistent doc comments order:
   @class, @abstract, @constructor, @extends, @params.
 - Fix indentation errors
   A fairly common mistake was a superfluous space before the
   identifier on the assignment line directly below the
   documentation comment.
   $ ack "^ [^*]" --js modules/ve
 - Typo "Inhertiance" -> "Inheritance".
 - Replacing the other confusing comment "Inheritance" (inside
   the constructor) with "Parent constructor".
 - Add missing @abstract for ve.ui.Tool.
 - Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js
 - Add function names to all @constructor functions. Now that we
   have inheritance it is important and useful to have these
   functions not be anonymous.

   Example of debug shot: http://cl.ly/image/1j3c160w3D45

   Makes the difference between

   < documentNode;
   > ve_dm_DocumentNode
     ...
     : ve_dm_BranchNode
       ...
       : ve_dm_Node
         ...
         : ve_dm_Node
           ...
           : Object
             ...

   without names (current situation):

   < documentNode;
   > Object
     ...
     : Object
       ...
       : Object
         ...
         : Object
           ...
           : Object
             ...

   though before this commit, it really looks like this
   (flattened since ve.extendClass really did a mixin):

   < documentNode;
   > Object
     ...
     ...
     ...

   Pattern in Sublime (case-sensitive) to find nameless
   constructor functions:
   "^ve\..*\.([A-Z])([^\.]+) = function \("

Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-06 15:29:31 -07:00

212 lines
7.2 KiB
JavaScript
Raw Blame History

/**
* 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 ve_BranchNodeStub( children ) {
ve.BranchNode.call( this, children );
};
ve.inheritClass( ve.BranchNodeStub, ve.Node );
ve.mixinClass( 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 count, t, i, reversed,
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': Error,
'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 );
}
}
count = 0;
for ( t = 0; t < tests.length; t++ ) {
if ( tests[t].hasOwnProperty( 'reverse' ) ) {
count++;
}
count++;
}
QUnit.expect( count );
for ( i = 0; i < tests.length; i++ ) {
executeTest( tests[i] );
if ( tests[i].reverse !== undefined ) {
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 );
}
}
} );
Reference in a new issue View git blame Copy permalink