JSDuck: Generated code documentation!
See CODING.md for how to run it.
Mistakes fixed:
* Warning: Unknown type function
-> Function
* Warning: Unknown type DOMElement
-> HTMLElement
* Warning: Unknown type DOM Node
-> HTMLElement
* Warning: Unknown type Integer
-> Mixed
* Warning: Unknown type Command
-> ve.Command
* Warning: Unknown type any
-> number
* Warning: Unknown type ve.Transaction
-> ve.dm.Transaction
* Warning: Unknown type ve.dm.AnnotationSet
-> ve.AnnotationSet
* Warning: Unknown type false
-> boolean
* Warning: Unknown type ve.dm.AlienNode
ve.dm doesn't have a generic AlienNode like ve.ce
-> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode
* Warning: Unknown type ve.ve.Surface
-> ve.ce.Surface
* ve.example.lookupNode:
-> Last @param should be @return
* ve.dm.Transaction.prototype.pushReplace:
-> @param {Array] should be @param {Array}
* Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
* Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
Differences fixed:
* Variadic arguments are like @param {Type...} [name]
instead of @param {Type} [name...]
* Convert all file headers from /** to /*! because JSDuck tries
to parse all /** blocks and fails to parse with all sorts of
errors for "Global property", "Unnamed property", and
"Duplicate property".
Find: \/\*\*([^@]+)(@copyright)
Replace: /*!$1$2
* Indented blocks are considered code examples.
A few methods had documentation with numbered lists that were
indented, which have now been updated to not be intended.
* The free-form text descriptions are parsed with Markdown,
which requires lists to be separated from paragraphs by an
empty line.
And we should use `backticks` instead of {braces} for inline
code in text paragraphs.
* Doc blocks for classes and their constructor have to be
in the correct order (@constructor, @param, @return must be
before @class, @abstract, @extends etc.)
* `@extends Class` must not have Class {wrapped}
* @throws must start with a {Type}
* @example means something else. It is used for an inline demo
iframe, not code block. For that simply indent with spaces.
* @member means something else.
Non-function properties are marked with @property, not @member.
* To create a link to a class or member, in most cases the name
is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux,
where a hash stands for "instance member", so Foo.bar#quux,
links to Foo.bar.prototype.quux (the is not supported, as
"prototype" is considered an implementation detail, it only
indexes class name and method name).
If the magic linker doesn't work for some case, the
verbose syntax is {@link #target label}.
* @property can't have sub-properties (nested @param and @return
values are supported, only @static @property can't be nested).
We only have one case of this, which can be worked around by
moving those in a new virtual class. The code is unaltered
(only moved down so that it isn't with the scope of the main
@class block). ve.dm.TransactionProcessor.processors.
New:
* @mixins: Classes mixed into the current class.
* @event: Events that can be emitted by a class. These are also
inherited by subclasses. (+ @param, @return and @preventable).
So ve.Node#event-attach is inherited to ve.dm.BreakNode,
just like @method is.
* @singleton: Plain objects such as ve, ve.dm, ve.ce were missing
documentation causing a tree error. Documented those as a
JSDuck singleton, which they but just weren't documented yet.
NB: Members of @singleton don't need @static (if present,
triggers a compiler warning).
* @chainable: Shorthand for "@return this". We were using
"@return {classname}" which is ambiguous (returns the same
instance or another instance?), @chainable is specifically
for "@return this". Creates proper labels in the generated
HTML pages.
Removed:
* @mixin: (not to be confused with @mixins). Not supported by
JSDuck. Every class is standalone anyway. Where needed marked
them @class + @abstract instead.
Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
|
|
|
/*!
|
2013-01-15 23:38:49 +00:00
|
|
|
* VisualEditor DataModel TransactionProcessor tests.
|
2012-07-19 21:25:16 +00:00
|
|
|
*
|
2013-02-19 23:37:34 +00:00
|
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
2012-07-19 00:11:26 +00:00
|
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
|
|
|
*/
|
|
|
|
|
|
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 08:43:33 +00:00
|
|
|
QUnit.module( 've.dm.TransactionProcessor' );
|
2012-05-01 02:06:20 +00:00
|
|
|
|
|
|
|
|
/* Tests */
|
|
|
|
|
|
Get rid of 'reversed' flag on transactions
The way we implemented undoing transactions was horrible. We'd process
the original transaction, but with a reversed=true flag. That meant we
had to keep track of the 'reversed' flag everywhere, and use ternaries
like insert = reversed ? op.remove : op.insert; all over the place to
access transaction operations. Redo then worked by reapplying the
transaction. We would verify that this was OK by tracking whether the
transaction was in an applied state or an undone state.
This commit makes it so every transaction can only be applied once. To
undo, you obtain a mirror image of the transaction with tx.reverse(),
then apply that. To redo, you clone the original transaction with
tx.clone() and apply that. All the code that had to use ternaries to
check whether the transaction was being applied in reverse or not is
gone now, because you can only apply a given transaction forwards,
never in reverse.
Bonus:
* Make ve.dm.Document's .completeHistory a simple array of
transactions, rather than transaction/boolean pairs
* In the protection of double application test, clone the example
document properly; it modified ve.dm.example.data, which was "fine"
because it ran .commit() and .rollback() the same number of times
Change-Id: I3050c5430be4a12510f22e20853560b92acebb67
2013-10-03 00:43:56 +00:00
|
|
|
QUnit.test( 'commit', function ( assert ) {
|
2013-04-06 16:45:26 +00:00
|
|
|
var i, originalData, originalDoc,
|
2013-03-20 22:35:05 +00:00
|
|
|
msg, testDoc, tx, expectedData, expectedDoc,
|
2013-04-06 16:45:26 +00:00
|
|
|
n = 0,
|
2013-03-20 22:35:05 +00:00
|
|
|
store = ve.dm.example.createExampleDocument().getStore(),
|
2012-10-06 00:34:12 +00:00
|
|
|
bold = ve.dm.example.createAnnotation( ve.dm.example.bold ),
|
|
|
|
|
italic = ve.dm.example.createAnnotation( ve.dm.example.italic ),
|
|
|
|
|
underline = ve.dm.example.createAnnotation( ve.dm.example.underline ),
|
2013-02-14 23:21:53 +00:00
|
|
|
metaElementInsert = {
|
2013-02-21 23:01:04 +00:00
|
|
|
'type': 'alienMeta',
|
2013-02-14 23:21:53 +00:00
|
|
|
'attributes': {
|
|
|
|
|
'style': 'comment',
|
|
|
|
|
'text': ' inline '
|
|
|
|
|
}
|
|
|
|
|
},
|
2013-02-21 23:01:04 +00:00
|
|
|
metaElementInsertClose = { 'type': '/alienMeta' },
|
2012-08-02 18:46:13 +00:00
|
|
|
cases = {
|
2012-10-25 20:06:07 +00:00
|
|
|
'no operations': {
|
|
|
|
|
'calls': [],
|
|
|
|
|
'expected': function () {}
|
|
|
|
|
},
|
|
|
|
|
'retaining': {
|
|
|
|
|
'calls': [['pushRetain', 38]],
|
|
|
|
|
'expected': function () {}
|
|
|
|
|
},
|
|
|
|
|
'annotating content': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStartAnnotating', 'set', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'set', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStartAnnotating', 'clear', italic],
|
|
|
|
|
['pushStartAnnotating', 'set', bold],
|
|
|
|
|
['pushStartAnnotating', 'set', underline],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'clear', italic],
|
|
|
|
|
['pushStopAnnotating', 'set', bold],
|
|
|
|
|
['pushStopAnnotating', 'set', underline]
|
2012-05-15 00:16:18 +00:00
|
|
|
],
|
2012-10-25 20:06:07 +00:00
|
|
|
'expected': function ( data ) {
|
2013-03-20 22:35:05 +00:00
|
|
|
data[1] = ['a', store.indexes( [ bold ] )];
|
|
|
|
|
data[2] = ['b', store.indexes( [ bold ] )];
|
|
|
|
|
data[3] = ['c', store.indexes( [ bold, underline ] )];
|
2012-10-25 20:06:07 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'annotating content and leaf elements': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 38],
|
|
|
|
|
['pushStartAnnotating', 'set', bold],
|
2012-11-23 21:07:20 +00:00
|
|
|
['pushRetain', 4],
|
2012-10-25 20:06:07 +00:00
|
|
|
['pushStopAnnotating', 'set', bold]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
2013-03-20 22:35:05 +00:00
|
|
|
data[38] = ['h', store.indexes( [ bold ] )];
|
|
|
|
|
data[39].annotations = store.indexes( [ bold ] );
|
|
|
|
|
data[41] = ['i', store.indexes( [ bold ] )];
|
2012-10-25 20:06:07 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'using an annotation method other than set or clear throws an exception': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushStartAnnotating', 'invalid-method', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'invalid-method', bold]
|
|
|
|
|
],
|
|
|
|
|
'exception': Error
|
|
|
|
|
},
|
|
|
|
|
'annotating branch opening element throws an exception': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushStartAnnotating', 'set', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'set', bold]
|
|
|
|
|
],
|
|
|
|
|
'exception': Error
|
|
|
|
|
},
|
|
|
|
|
'annotating branch closing element throws an exception': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 4],
|
|
|
|
|
['pushStartAnnotating', 'set', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'set', bold]
|
|
|
|
|
],
|
|
|
|
|
'exception': Error
|
|
|
|
|
},
|
|
|
|
|
'setting duplicate annotations throws an exception': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 2],
|
|
|
|
|
['pushStartAnnotating', 'set', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'set', bold]
|
|
|
|
|
],
|
|
|
|
|
'exception': Error
|
|
|
|
|
},
|
|
|
|
|
'removing non-existent annotations throws an exception': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStartAnnotating', 'clear', bold],
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushStopAnnotating', 'clear', bold]
|
|
|
|
|
],
|
|
|
|
|
'exception': Error
|
|
|
|
|
},
|
|
|
|
|
'changing, removing and adding attributes': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushReplaceElementAttribute', 'level', 1, 2],
|
|
|
|
|
['pushRetain', 12],
|
|
|
|
|
['pushReplaceElementAttribute', 'style', 'bullet', 'number'],
|
|
|
|
|
['pushReplaceElementAttribute', 'test', undefined, 'abcd'],
|
|
|
|
|
['pushRetain', 27],
|
2013-05-18 03:49:25 +00:00
|
|
|
['pushReplaceElementAttribute', 'src', ve.dm.example.imgSrc, undefined]
|
2012-06-06 22:34:55 +00:00
|
|
|
],
|
2012-10-25 20:06:07 +00:00
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data[0].attributes.level = 2;
|
|
|
|
|
data[12].attributes.style = 'number';
|
|
|
|
|
data[12].attributes.test = 'abcd';
|
2013-05-18 03:49:25 +00:00
|
|
|
delete data[39].attributes.src;
|
2012-10-25 20:06:07 +00:00
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'changing attributes on non-element data throws an exception': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
|
|
|
|
['pushReplaceElementAttribute', 'foo', 23, 42]
|
|
|
|
|
],
|
|
|
|
|
'exception': Error
|
|
|
|
|
},
|
|
|
|
|
'inserting text': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 1, 0, ['F', 'O', 'O']]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 1, 0, 'F', 'O', 'O' );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'removing text': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 1, 1, []]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 1, 1 );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'replacing text': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 1, 1, ['F', 'O', 'O']]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 1, 1, 'F', 'O', 'O' );
|
|
|
|
|
}
|
|
|
|
|
},
|
2013-01-29 17:39:09 +00:00
|
|
|
'emptying text': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 10],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 10, 1, []]
|
2013-01-29 17:39:09 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 10, 1 );
|
|
|
|
|
}
|
|
|
|
|
},
|
2012-10-25 20:06:07 +00:00
|
|
|
'inserting mixed content': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 1],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 1, 1, ['F', 'O', 'O', {'type':'image'}, {'type':'/image'}, 'B', 'A', 'R']]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 1, 1, 'F', 'O', 'O', {'type':'image'}, {'type':'/image'}, 'B', 'A', 'R' );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'converting an element': {
|
|
|
|
|
'calls': [
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 0, 1, [{ 'type': 'paragraph' }]],
|
2012-10-25 20:06:07 +00:00
|
|
|
['pushRetain', 3],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 4, 1, [{ 'type': '/paragraph' }]]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data[0].type = 'paragraph';
|
|
|
|
|
delete data[0].attributes;
|
|
|
|
|
data[4].type = '/paragraph';
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'splitting an element': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 2],
|
|
|
|
|
[
|
2013-04-06 16:45:26 +00:00
|
|
|
'pushReplace', 2, 0,
|
2012-10-25 20:06:07 +00:00
|
|
|
[{ 'type': '/heading' }, { 'type': 'heading', 'attributes': { 'level': 1 } }]
|
|
|
|
|
]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice(
|
|
|
|
|
2,
|
|
|
|
|
0,
|
|
|
|
|
{ 'type': '/heading' },
|
|
|
|
|
{ 'type': 'heading', 'attributes': { 'level': 1 } }
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'merging an element': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 57],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 57, 2, []]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 57, 2 );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'stripping elements': {
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 3],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 3, 1, []],
|
2012-10-25 20:06:07 +00:00
|
|
|
['pushRetain', 6],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 10, 1, []]
|
2012-10-25 20:06:07 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 10, 1 );
|
|
|
|
|
data.splice( 3, 1 );
|
|
|
|
|
}
|
2012-11-19 22:19:13 +00:00
|
|
|
},
|
|
|
|
|
'inserting text after alien node at the end': {
|
|
|
|
|
'data': [
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'a',
|
|
|
|
|
{ 'type': 'alienInline' },
|
|
|
|
|
{ 'type': '/alienInline' },
|
|
|
|
|
{ 'type': '/paragraph' }
|
|
|
|
|
],
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 4],
|
2013-04-06 16:45:26 +00:00
|
|
|
['pushReplace', 4, 0, ['b']]
|
2012-11-19 22:19:13 +00:00
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 4, 0, 'b' );
|
|
|
|
|
}
|
2013-02-14 23:21:53 +00:00
|
|
|
},
|
|
|
|
|
'inserting metadata element into existing element list': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 11 ],
|
|
|
|
|
['pushRetainMetadata', 2 ],
|
|
|
|
|
['pushReplaceMetadata', [], [ metaElementInsert ] ],
|
|
|
|
|
['pushRetainMetadata', 2 ],
|
2013-06-05 10:47:47 +00:00
|
|
|
['pushRetain', 1 ]
|
2013-02-14 23:21:53 +00:00
|
|
|
],
|
2013-05-06 11:34:32 +00:00
|
|
|
'expected': function ( data ) {
|
2013-02-14 23:21:53 +00:00
|
|
|
data.splice( 25, 0, metaElementInsert, metaElementInsertClose );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'inserting metadata element into empty list': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 3 ],
|
|
|
|
|
['pushReplaceMetadata', [], [ metaElementInsert ] ],
|
2013-06-05 10:47:47 +00:00
|
|
|
['pushRetain', 9 ]
|
2013-02-14 23:21:53 +00:00
|
|
|
],
|
2013-05-06 11:34:32 +00:00
|
|
|
'expected': function ( data ) {
|
2013-02-14 23:21:53 +00:00
|
|
|
data.splice( 7, 0, metaElementInsert, metaElementInsertClose );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'removing all metadata elements from a metadata list': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 11 ],
|
|
|
|
|
['pushReplaceMetadata', ve.dm.example.withMetaMetaData[11], [] ],
|
2013-06-05 10:47:47 +00:00
|
|
|
['pushRetain', 1 ]
|
2013-02-14 23:21:53 +00:00
|
|
|
],
|
2013-05-06 11:34:32 +00:00
|
|
|
'expected': function ( data ) {
|
2013-02-14 23:21:53 +00:00
|
|
|
data.splice( 21, 8 );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'removing some metadata elements from metadata list': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 11 ],
|
|
|
|
|
['pushRetainMetadata', 1 ],
|
|
|
|
|
['pushReplaceMetadata', ve.dm.example.withMetaMetaData[11].slice( 1, 3 ), [] ],
|
|
|
|
|
['pushRetainMetadata', 1 ],
|
2013-06-05 10:47:47 +00:00
|
|
|
['pushRetain', 1 ]
|
2013-02-14 23:21:53 +00:00
|
|
|
],
|
2013-05-06 11:34:32 +00:00
|
|
|
'expected': function ( data ) {
|
2013-02-14 23:21:53 +00:00
|
|
|
data.splice( 23, 4 );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'replacing metadata at end of list': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 11 ],
|
|
|
|
|
['pushRetainMetadata', 3 ],
|
|
|
|
|
['pushReplaceMetadata', [ ve.dm.example.withMetaMetaData[11][3] ], [ metaElementInsert ] ],
|
2013-06-05 10:47:47 +00:00
|
|
|
['pushRetain', 1 ]
|
2013-02-14 23:21:53 +00:00
|
|
|
],
|
2013-05-06 11:34:32 +00:00
|
|
|
'expected': function ( data ) {
|
2013-02-14 23:21:53 +00:00
|
|
|
data.splice( 27, 2, metaElementInsert, metaElementInsertClose );
|
|
|
|
|
}
|
2013-04-06 16:45:26 +00:00
|
|
|
},
|
2013-09-11 22:24:54 +00:00
|
|
|
'replacing metadata twice at the same offset': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
[ 'pushRetain', 11 ],
|
|
|
|
|
[ 'pushRetainMetadata', 1 ],
|
|
|
|
|
[ 'pushReplaceMetadata', [ ve.dm.example.withMetaMetaData[11][1] ], [ metaElementInsert ] ],
|
|
|
|
|
[ 'pushRetainMetadata', 1 ],
|
|
|
|
|
[ 'pushReplaceMetadata', [ ve.dm.example.withMetaMetaData[11][3] ], [ metaElementInsert ] ],
|
|
|
|
|
[ 'pushRetain', 1 ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 23, 2, metaElementInsert, metaElementInsertClose );
|
|
|
|
|
data.splice( 27, 2, metaElementInsert, metaElementInsertClose );
|
|
|
|
|
}
|
|
|
|
|
},
|
2013-04-06 16:45:26 +00:00
|
|
|
'removing data from between metadata merges metadata': {
|
|
|
|
|
'data': ve.dm.example.withMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushRetain', 7 ],
|
|
|
|
|
['pushReplace', 7, 2, []],
|
2013-06-05 10:47:47 +00:00
|
|
|
['pushRetain', 2 ]
|
2013-04-06 16:45:26 +00:00
|
|
|
],
|
2013-05-06 11:34:32 +00:00
|
|
|
'expected': function ( data ) {
|
2013-04-06 16:45:26 +00:00
|
|
|
data.splice( 15, 2 );
|
|
|
|
|
}
|
2013-07-12 22:57:26 +00:00
|
|
|
},
|
|
|
|
|
'structural replacement starting at an offset without metadata': {
|
|
|
|
|
'data': [
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'F',
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<!-- foo -->' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
'o', 'o',
|
|
|
|
|
{ 'type': '/paragraph' }
|
|
|
|
|
],
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushReplace', 0, 5, [ { 'type': 'table' }, { 'type': '/table' } ]]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
2013-08-30 03:24:59 +00:00
|
|
|
data.splice( 0, 2 );
|
|
|
|
|
data.splice( 2, 3, { 'type': 'table' }, { 'type': '/table' } );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'structural replacement starting at an offset with metadata': {
|
|
|
|
|
'data': [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<!-- foo -->' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'F',
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'style': 'comment',
|
|
|
|
|
'text': ' inline '
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
'o', 'o',
|
|
|
|
|
{ 'type': '/paragraph' }
|
|
|
|
|
],
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushReplace', 0, 5, [ { 'type': 'table' }, { 'type': '/table' } ]]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
// metadata is merged.
|
|
|
|
|
data.splice( 2, 2 );
|
|
|
|
|
data.splice( 4, 3, { 'type': 'table' }, { 'type': '/table' } );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'structural replacement ending at an offset with metadata': {
|
|
|
|
|
'data': [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<!-- foo -->' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'F',
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'style': 'comment',
|
|
|
|
|
'text': ' inline '
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
'o', 'o',
|
|
|
|
|
{ 'type': '/paragraph' },
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<!-- bar -->' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'B', 'a', 'r',
|
|
|
|
|
{ 'type': '/paragraph' }
|
|
|
|
|
],
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushReplace', 0, 5, [ { 'type': 'table' }, { 'type': '/table' } ]],
|
|
|
|
|
['pushRetain', 5 ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
// metadata is merged.
|
|
|
|
|
data.splice( 2, 2 );
|
|
|
|
|
data.splice( 4, 3, { 'type': 'table' }, { 'type': '/table' } );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'structural deletion ending at an offset with metadata': {
|
|
|
|
|
'data': [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<!-- foo -->' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'F',
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'style': 'comment',
|
|
|
|
|
'text': ' inline '
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
'o', 'o',
|
|
|
|
|
{ 'type': '/paragraph' },
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<!-- bar -->' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{ 'type': '/alienMeta' },
|
|
|
|
|
{ 'type': 'paragraph' },
|
|
|
|
|
'B', 'a', 'r',
|
|
|
|
|
{ 'type': '/paragraph' }
|
|
|
|
|
],
|
|
|
|
|
'calls': [
|
|
|
|
|
['pushReplace', 0, 5, [] ],
|
|
|
|
|
['pushRetain', 5 ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
// metadata is merged.
|
|
|
|
|
data.splice( 2, 2 );
|
2013-07-12 22:57:26 +00:00
|
|
|
data.splice( 4, 3 );
|
|
|
|
|
}
|
2013-09-02 18:51:23 +00:00
|
|
|
},
|
|
|
|
|
'preserves metadata on unwrap': {
|
|
|
|
|
'data': ve.dm.example.listWithMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
[ 'newFromWrap', new ve.Range( 1, 11 ),
|
|
|
|
|
[ { 'type': 'list' } ], [],
|
|
|
|
|
[ { 'type': 'listItem', 'attributes': {'styles': ['bullet']} } ], [] ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
data.splice( 35, 1 ); // remove '/list'
|
|
|
|
|
data.splice( 32, 1 ); // remove '/listItem'
|
|
|
|
|
data.splice( 20, 1 ); // remove 'listItem'
|
|
|
|
|
data.splice( 17, 1 ); // remove '/listItem'
|
|
|
|
|
data.splice( 5, 1 ); // remove 'listItem'
|
|
|
|
|
data.splice( 2, 1 ); // remove 'list'
|
|
|
|
|
}
|
2013-09-10 17:36:23 +00:00
|
|
|
},
|
|
|
|
|
'inserting trailing metadata (1)': {
|
|
|
|
|
'data': ve.dm.example.listWithMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
[ 'newFromMetadataInsertion', 12, 0, [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<meta property="fourteen" />' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
] ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
ve.batchSplice( data, data.length - 2, 0, [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<meta property="fourteen" />' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
'type': '/alienMeta'
|
|
|
|
|
}
|
|
|
|
|
] );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'inserting trailing metadata (2)': {
|
|
|
|
|
'data': ve.dm.example.listWithMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
[ 'newFromMetadataInsertion', 12, 1, [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<meta property="fourteen" />' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
] ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
ve.batchSplice( data, data.length, 0, [
|
|
|
|
|
{
|
|
|
|
|
'type': 'alienMeta',
|
|
|
|
|
'attributes': {
|
|
|
|
|
'domElements': $( '<meta property="fourteen" />' ).toArray()
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
'type': '/alienMeta'
|
|
|
|
|
}
|
|
|
|
|
] );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'removing trailing metadata': {
|
|
|
|
|
'data': ve.dm.example.listWithMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
[ 'newFromMetadataRemoval', 12, new ve.Range( 0, 1 ) ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
ve.batchSplice( data, data.length - 2, 2, [] );
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
'preserves trailing metadata': {
|
|
|
|
|
'data': ve.dm.example.listWithMeta,
|
|
|
|
|
'calls': [
|
|
|
|
|
[ 'newFromInsertion', 4, [ 'b' ] ]
|
|
|
|
|
],
|
|
|
|
|
'expected': function ( data ) {
|
|
|
|
|
ve.batchSplice( data, 12, 0, [ 'b' ] );
|
|
|
|
|
}
|
2012-06-06 22:34:55 +00:00
|
|
|
}
|
2012-10-25 20:06:07 +00:00
|
|
|
};
|
|
|
|
|
|
2013-04-06 16:45:26 +00:00
|
|
|
for ( msg in cases ) {
|
|
|
|
|
n += ( 'expected' in cases[msg] ) ? 4 : 1;
|
2012-08-24 02:06:36 +00:00
|
|
|
}
|
2013-04-06 16:45:26 +00:00
|
|
|
QUnit.expect( n );
|
2012-08-24 02:06:36 +00:00
|
|
|
|
2012-05-14 21:31:32 +00:00
|
|
|
// Run tests
|
2012-08-02 18:46:13 +00:00
|
|
|
for ( msg in cases ) {
|
2013-04-06 16:45:26 +00:00
|
|
|
// Generate original document
|
|
|
|
|
originalData = cases[msg].data || ve.dm.example.data;
|
|
|
|
|
originalDoc = new ve.dm.Document(
|
2013-07-28 20:51:32 +00:00
|
|
|
ve.dm.example.preprocessAnnotations( ve.copy( originalData ), store )
|
2013-04-06 16:45:26 +00:00
|
|
|
);
|
|
|
|
|
testDoc = new ve.dm.Document(
|
2013-07-28 20:51:32 +00:00
|
|
|
ve.dm.example.preprocessAnnotations( ve.copy( originalData ), store )
|
2013-04-06 16:45:26 +00:00
|
|
|
);
|
|
|
|
|
|
2012-08-02 18:46:13 +00:00
|
|
|
tx = new ve.dm.Transaction();
|
|
|
|
|
for ( i = 0; i < cases[msg].calls.length; i++ ) {
|
2013-09-02 18:51:23 +00:00
|
|
|
// some calls need the document as its first argument
|
|
|
|
|
if ( /^(pushReplace$|new)/.test( cases[msg].calls[i][0] ) ) {
|
2013-04-06 16:45:26 +00:00
|
|
|
cases[msg].calls[i].splice( 1, 0, testDoc );
|
|
|
|
|
}
|
2013-09-02 18:51:23 +00:00
|
|
|
// special case static methods of Transaction
|
|
|
|
|
if ( /^new/.test( cases[msg].calls[i][0] ) ) {
|
|
|
|
|
tx = ve.dm.Transaction[cases[msg].calls[i][0]].apply( null, cases[msg].calls[i].slice( 1 ) );
|
|
|
|
|
break;
|
|
|
|
|
}
|
2012-05-14 21:31:32 +00:00
|
|
|
tx[cases[msg].calls[i][0]].apply( tx, cases[msg].calls[i].slice( 1 ) );
|
|
|
|
|
}
|
2013-04-06 16:45:26 +00:00
|
|
|
|
2012-05-15 00:16:18 +00:00
|
|
|
if ( 'expected' in cases[msg] ) {
|
2012-05-15 07:25:27 +00:00
|
|
|
// Generate expected document
|
2013-07-28 20:51:32 +00:00
|
|
|
expectedData = ve.copy( originalData );
|
2012-05-15 07:25:27 +00:00
|
|
|
cases[msg].expected( expectedData );
|
2013-03-20 22:35:05 +00:00
|
|
|
expectedDoc = new ve.dm.Document(
|
|
|
|
|
ve.dm.example.preprocessAnnotations( expectedData, store )
|
|
|
|
|
);
|
2012-05-15 07:25:27 +00:00
|
|
|
// Commit
|
2013-03-20 22:35:05 +00:00
|
|
|
testDoc.commit( tx );
|
2013-06-05 17:22:01 +00:00
|
|
|
assert.deepEqualWithDomElements( testDoc.getFullData(), expectedDoc.getFullData(), 'commit (data): ' + msg );
|
2012-07-10 19:46:08 +00:00
|
|
|
assert.equalNodeTree(
|
2013-03-20 22:35:05 +00:00
|
|
|
testDoc.getDocumentNode(),
|
|
|
|
|
expectedDoc.getDocumentNode(),
|
2012-05-15 05:36:06 +00:00
|
|
|
'commit (tree): ' + msg
|
|
|
|
|
);
|
2012-05-15 07:25:27 +00:00
|
|
|
// Rollback
|
Get rid of 'reversed' flag on transactions
The way we implemented undoing transactions was horrible. We'd process
the original transaction, but with a reversed=true flag. That meant we
had to keep track of the 'reversed' flag everywhere, and use ternaries
like insert = reversed ? op.remove : op.insert; all over the place to
access transaction operations. Redo then worked by reapplying the
transaction. We would verify that this was OK by tracking whether the
transaction was in an applied state or an undone state.
This commit makes it so every transaction can only be applied once. To
undo, you obtain a mirror image of the transaction with tx.reverse(),
then apply that. To redo, you clone the original transaction with
tx.clone() and apply that. All the code that had to use ternaries to
check whether the transaction was being applied in reverse or not is
gone now, because you can only apply a given transaction forwards,
never in reverse.
Bonus:
* Make ve.dm.Document's .completeHistory a simple array of
transactions, rather than transaction/boolean pairs
* In the protection of double application test, clone the example
document properly; it modified ve.dm.example.data, which was "fine"
because it ran .commit() and .rollback() the same number of times
Change-Id: I3050c5430be4a12510f22e20853560b92acebb67
2013-10-03 00:43:56 +00:00
|
|
|
testDoc.commit( tx.reversed() );
|
2013-06-05 17:22:01 +00:00
|
|
|
assert.deepEqualWithDomElements( testDoc.getFullData(), originalDoc.getFullData(), 'rollback (data): ' + msg );
|
2012-07-10 19:46:08 +00:00
|
|
|
assert.equalNodeTree(
|
2013-03-20 22:35:05 +00:00
|
|
|
testDoc.getDocumentNode(),
|
2012-07-10 19:46:08 +00:00
|
|
|
originalDoc.getDocumentNode(),
|
2012-05-15 05:36:06 +00:00
|
|
|
'rollback (tree): ' + msg
|
|
|
|
|
);
|
2012-05-14 21:31:32 +00:00
|
|
|
} else if ( 'exception' in cases[msg] ) {
|
|
|
|
|
/*jshint loopfunc:true */
|
2012-07-10 19:46:08 +00:00
|
|
|
assert.throws(
|
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 08:43:33 +00:00
|
|
|
function () {
|
2013-03-20 22:35:05 +00:00
|
|
|
testDoc.commit( tx );
|
2012-05-14 21:31:32 +00:00
|
|
|
},
|
|
|
|
|
cases[msg].exception,
|
|
|
|
|
'commit: ' + msg
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
2012-05-04 22:50:50 +00:00
|
|
|
} );
|