mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 12:16:51 +00:00
b1d9c83b5d
* 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
352 lines
9.3 KiB
JavaScript
352 lines
9.3 KiB
JavaScript
/**
|
|
* VisualEditor example data sets and helper functions.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/* Static Members */
|
|
|
|
ve.example = {};
|
|
|
|
/* Methods */
|
|
|
|
ve.example.getSelectNodesCases = function ( doc ) {
|
|
var lookup = ve.example.lookupNode,
|
|
documentNode = doc.getDocumentNode();
|
|
return [
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 0, 3 ), 'leaves' ),
|
|
'expected': [
|
|
// heading/text
|
|
{
|
|
'node': lookup( documentNode, 0, 0 ),
|
|
'range': new ve.Range( 1, 3 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 1, 4 )
|
|
}
|
|
],
|
|
'msg': 'partial leaf results have ranges with global offsets'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 0, 11 ), 'leaves' ),
|
|
'expected': [
|
|
// heading/text
|
|
{
|
|
'node': lookup( documentNode, 0, 0 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 1, 4 )
|
|
},
|
|
// table/tableSection/tableRow/tableCell/paragraph/text
|
|
{
|
|
'node': lookup( documentNode, 1, 0, 0, 0, 0, 0 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 10, 11 ),
|
|
'nodeOuterRange': new ve.Range( 10, 11 )
|
|
}
|
|
],
|
|
'msg': 'leaf nodes do not have ranges, leaf nodes from different levels'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 29, 43 ), 'leaves' ),
|
|
'expected': [
|
|
// table/tableSection/tableRow/tableCell/list/listItem/paragraph/text
|
|
{
|
|
'node': lookup( documentNode, 1, 0, 0, 0, 2, 0, 0, 0 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 29, 30 ),
|
|
'nodeOuterRange': new ve.Range( 29, 30 )
|
|
},
|
|
// preformatted/text
|
|
{
|
|
'node': lookup( documentNode, 2, 0 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 38, 39 ),
|
|
'nodeOuterRange': new ve.Range( 38, 39 )
|
|
},
|
|
// preformatted/image
|
|
{
|
|
'node': lookup( documentNode, 2, 1 ),
|
|
'index': 1,
|
|
'nodeRange': new ve.Range( 40, 40 ),
|
|
'nodeOuterRange': new ve.Range( 39, 41 )
|
|
},
|
|
// preformatted/text
|
|
{
|
|
'node': lookup( documentNode, 2, 2 ),
|
|
'index': 2,
|
|
'nodeRange': new ve.Range( 41, 42 ),
|
|
'nodeOuterRange': new ve.Range( 41, 42 )
|
|
}
|
|
],
|
|
'msg': 'leaf nodes that are not text nodes'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 2, 16 ), 'siblings' ),
|
|
'expected': [
|
|
// heading
|
|
{
|
|
'node': lookup( documentNode, 0 ),
|
|
'range': new ve.Range( 2, 4 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 0, 5 )
|
|
},
|
|
// table
|
|
{
|
|
'node': lookup( documentNode, 1 ),
|
|
'range': new ve.Range( 6, 16 ),
|
|
'index': 1,
|
|
'nodeRange': new ve.Range( 6, 36 ),
|
|
'nodeOuterRange': new ve.Range( 5, 37 )
|
|
}
|
|
],
|
|
'msg': 'siblings at the document level'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 2, 51 ), 'siblings' ),
|
|
'expected': [
|
|
// heading
|
|
{
|
|
'node': lookup( documentNode, 0 ),
|
|
'range': new ve.Range( 2, 4 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 0, 5 )
|
|
},
|
|
// table
|
|
{
|
|
'node': lookup( documentNode, 1 ),
|
|
'index': 1,
|
|
'nodeRange': new ve.Range( 6, 36 ),
|
|
'nodeOuterRange': new ve.Range( 5, 37 )
|
|
},
|
|
// preformatted
|
|
{
|
|
'node': lookup( documentNode, 2 ),
|
|
'index': 2,
|
|
'nodeRange': new ve.Range( 38, 42 ),
|
|
'nodeOuterRange': new ve.Range( 37, 43 )
|
|
},
|
|
// definitionList
|
|
{
|
|
'node': lookup( documentNode, 3 ),
|
|
'range': new ve.Range( 44, 51 ),
|
|
'index': 3,
|
|
'nodeRange': new ve.Range( 44, 54 ),
|
|
'nodeOuterRange': new ve.Range( 43, 55 )
|
|
}
|
|
],
|
|
'msg': 'more than 2 siblings at the document level'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 1, 1 ), 'leaves' ),
|
|
'expected': [
|
|
// heading/text
|
|
{
|
|
'node': lookup( documentNode, 0, 0 ),
|
|
'range': new ve.Range( 1, 1 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 1, 4 )
|
|
}
|
|
],
|
|
'msg': 'zero-length range at the start of a text node returns text node rather than parent'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 4, 4 ), 'leaves' ),
|
|
'expected': [
|
|
// heading/text
|
|
{
|
|
'node': lookup( documentNode, 0, 0 ),
|
|
'range': new ve.Range( 4, 4 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 1, 4 )
|
|
}
|
|
],
|
|
'msg': 'zero-length range at the end of a text node returns text node rather than parent'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 2, 3 ), 'leaves' ),
|
|
'expected': [
|
|
// heading/text
|
|
{
|
|
'node': lookup( documentNode, 0, 0 ),
|
|
'range': new ve.Range( 2, 3 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 1, 4 )
|
|
}
|
|
],
|
|
'msg': 'range entirely within one leaf node'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 5, 5 ), 'leaves' ),
|
|
'expected': [
|
|
// document
|
|
{
|
|
'node': documentNode,
|
|
'range': new ve.Range( 5, 5 ),
|
|
// no 'index' because documentNode has no parent
|
|
'indexInNode': 1,
|
|
'nodeRange': new ve.Range( 0, 61 ),
|
|
'nodeOuterRange': new ve.Range( 0, 61 )
|
|
}
|
|
],
|
|
'msg': 'zero-length range between two children of the document'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 0, 0 ), 'leaves' ),
|
|
'expected': [
|
|
// document
|
|
{
|
|
'node': documentNode,
|
|
'range': new ve.Range( 0, 0 ),
|
|
// no 'index' because documentNode has no parent
|
|
'indexInNode': 0,
|
|
'nodeRange': new ve.Range( 0, 61 ),
|
|
'nodeOuterRange': new ve.Range( 0, 61 )
|
|
}
|
|
],
|
|
'msg': 'zero-length range at the start of the document'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 32, 39 ), 'leaves' ),
|
|
'expected': [
|
|
// table/tableSection/tableRow/tableCell/list
|
|
{
|
|
'node': lookup( documentNode, 1, 0, 0, 0, 2 ),
|
|
'range': new ve.Range( 32, 32 ),
|
|
'index': 2,
|
|
'indexInNode': 1,
|
|
'nodeRange': new ve.Range( 27, 32 ),
|
|
'nodeOuterRange': new ve.Range( 26, 33 )
|
|
},
|
|
// preformatted/text
|
|
{
|
|
'node': lookup( documentNode, 2, 0 ),
|
|
// no 'range' because the text node is covered completely
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 38, 39 ),
|
|
'nodeOuterRange': new ve.Range( 38, 39 )
|
|
}
|
|
],
|
|
'msg': 'range with 5 closings and a text node'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 2, 57 ), 'covered' ),
|
|
'expected': [
|
|
// heading/text
|
|
{
|
|
'node': lookup( documentNode, 0, 0 ),
|
|
'range': new ve.Range( 2, 4 ),
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 1, 4 ),
|
|
'nodeOuterRange': new ve.Range( 1, 4 )
|
|
},
|
|
// table
|
|
{
|
|
'node': lookup( documentNode, 1 ),
|
|
// no 'range' because the table is covered completely
|
|
'index': 1,
|
|
'nodeRange': new ve.Range( 6, 36 ),
|
|
'nodeOuterRange': new ve.Range( 5, 37 )
|
|
},
|
|
// preformatted
|
|
{
|
|
'node': lookup( documentNode, 2 ),
|
|
// no 'range' because the node is covered completely
|
|
'index': 2,
|
|
'nodeRange': new ve.Range( 38, 42 ),
|
|
'nodeOuterRange': new ve.Range( 37, 43 )
|
|
},
|
|
// definitionList
|
|
{
|
|
'node': lookup( documentNode, 3 ),
|
|
// no 'range' because the node is covered completely
|
|
'index': 3,
|
|
'nodeRange': new ve.Range( 44, 54 ),
|
|
'nodeOuterRange': new ve.Range( 43, 55 )
|
|
},
|
|
// paragraph/text
|
|
{
|
|
'node': lookup( documentNode, 4, 0 ),
|
|
// no 'range' because the text node is covered completely
|
|
'index': 0,
|
|
'nodeRange': new ve.Range( 56, 57 ),
|
|
'nodeOuterRange': new ve.Range( 56, 57 )
|
|
}
|
|
],
|
|
'msg': 'range from the first heading into the second-to-last paragraph, in covered mode'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 14, 14 ), 'siblings' ),
|
|
'expected': [
|
|
// table/tableSection/tableRow/tableCell/list/listItem
|
|
{
|
|
'node': lookup( documentNode, 1, 0, 0, 0, 1, 0 ),
|
|
'range': new ve.Range( 14, 14 ),
|
|
'index': 0,
|
|
'indexInNode': 0,
|
|
'nodeRange': new ve.Range( 14, 24 ),
|
|
'nodeOuterRange': new ve.Range( 13, 25 )
|
|
}
|
|
],
|
|
'msg': 'zero-length range at the beginning of a listItem, in siblings mode'
|
|
},
|
|
{
|
|
'actual': doc.selectNodes( new ve.Range( 25, 27 ), 'covered' ),
|
|
'expected': [
|
|
// table/tableSection/tableRow/tableCell/list
|
|
{
|
|
'node': lookup( documentNode, 1, 0, 0, 0, 1 ),
|
|
'range': new ve.Range( 25, 25 ),
|
|
'index': 1,
|
|
'indexInNode': 1,
|
|
'nodeRange': new ve.Range( 13, 25 ),
|
|
'nodeOuterRange': new ve.Range( 12, 26 )
|
|
},
|
|
// table/tableSection/tableRow/tableCell/list
|
|
{
|
|
'node': lookup( documentNode, 1, 0, 0, 0, 2 ),
|
|
'range': new ve.Range( 27, 27 ),
|
|
'index': 2,
|
|
'indexInNode': 0,
|
|
'nodeRange': new ve.Range( 27, 32 ),
|
|
'nodeOuterRange': new ve.Range( 26, 33 )
|
|
}
|
|
],
|
|
'msg': 'range covering a list closing and a list opening'
|
|
}
|
|
];
|
|
};
|
|
|
|
/**
|
|
* Looks up a value in a node tree.
|
|
*
|
|
* @method
|
|
* @param {ve.Node} root Root node to lookup from
|
|
* @param {Number} [...] Index path
|
|
* @param {ve.Node} Node at given path
|
|
*/
|
|
ve.example.lookupNode = function ( root ) {
|
|
var i,
|
|
node = root;
|
|
for ( i = 1; i < arguments.length; i++ ) {
|
|
node = node.children[arguments[i]];
|
|
}
|
|
return node;
|
|
};
|
|
|
|
ve.example.createDomElement = function ( type, attributes ) {
|
|
var key,
|
|
element = document.createElement( type );
|
|
for ( key in attributes ) {
|
|
element.setAttribute( key, attributes[key] );
|
|
}
|
|
return element;
|
|
};
|