mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 18:39:52 +00:00
88f6089952
'''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
271 lines
7.9 KiB
JavaScript
271 lines
7.9 KiB
JavaScript
/**
|
|
* VisualEditor data model TransactionProcessor tests.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
QUnit.module( 've.dm.TransactionProcessor' );
|
|
|
|
/* Tests */
|
|
|
|
QUnit.test( 'commit/rollback', function ( assert ) {
|
|
var cases = {
|
|
'no operations': {
|
|
'calls': [],
|
|
'expected': function ( data ) {}
|
|
},
|
|
'retaining': {
|
|
'calls': [['pushRetain', 38]],
|
|
'expected': function ( data ) {}
|
|
},
|
|
'annotating content': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStartAnnotating', 'clear', { 'type': 'textStyle/italic' }],
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/underline' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'clear', { 'type': 'textStyle/italic' }],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/underline' }]
|
|
],
|
|
'expected': function ( data ) {
|
|
var b = { '{"type":"textStyle/bold"}': { 'type': 'textStyle/bold' } },
|
|
u = { '{"type":"textStyle/underline"}': { 'type': 'textStyle/underline' } };
|
|
data[1] = ['a', b];
|
|
data[2] = ['b', b];
|
|
data[3] = ['c', ve.extendObject( {}, b, u )];
|
|
}
|
|
},
|
|
'annotating content and leaf elements': {
|
|
'calls': [
|
|
['pushRetain', 38],
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 2],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/bold' }]
|
|
],
|
|
'expected': function ( data ) {
|
|
var b = { '{"type":"textStyle/bold"}': { 'type': 'textStyle/bold' } };
|
|
data[38] = ['h', b];
|
|
data[39].annotations = b;
|
|
}
|
|
},
|
|
'using an annotation method other than set or clear throws an exception': {
|
|
'calls': [
|
|
['pushStartAnnotating', 'invalid-method', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'invalid-method', { 'type': 'textStyle/bold' }]
|
|
],
|
|
'exception': /^Invalid annotation method/
|
|
},
|
|
'annotating branch opening element throws an exception': {
|
|
'calls': [
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/bold' }]
|
|
],
|
|
'exception': /^Invalid transaction, cannot annotate a branch opening element$/
|
|
},
|
|
'annotating branch closing element throws an exception': {
|
|
'calls': [
|
|
['pushRetain', 4],
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/bold' }]
|
|
],
|
|
'exception': /^Invalid transaction, cannot annotate a branch closing element$/
|
|
},
|
|
'setting duplicate annotations throws an exception': {
|
|
'calls': [
|
|
['pushRetain', 2],
|
|
['pushStartAnnotating', 'set', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'set', { 'type': 'textStyle/bold' }]
|
|
],
|
|
'exception': /^Invalid transaction, annotation to be set is already set$/
|
|
},
|
|
'removing non-existent annotations throws an exception': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushStartAnnotating', 'clear', { 'type': 'textStyle/bold' }],
|
|
['pushRetain', 1],
|
|
['pushStopAnnotating', 'clear', { 'type': 'textStyle/bold' }]
|
|
],
|
|
'exception': /^Invalid transaction, annotation to be cleared is not set$/
|
|
},
|
|
'changing, removing and adding attributes': {
|
|
'calls': [
|
|
['pushReplaceElementAttribute', 'level', 1, 2],
|
|
['pushRetain', 12],
|
|
['pushReplaceElementAttribute', 'style', 'bullet', 'number'],
|
|
['pushReplaceElementAttribute', 'test', undefined, 'abcd'],
|
|
['pushRetain', 27],
|
|
['pushReplaceElementAttribute', 'html/src', 'image.png', undefined]
|
|
],
|
|
'expected': function ( data ) {
|
|
data[0].attributes.level = 2;
|
|
data[12].attributes.style = 'number';
|
|
data[12].attributes.test = 'abcd';
|
|
delete data[39].attributes['html/src'];
|
|
}
|
|
},
|
|
'changing attributes on non-element data throws an exception': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushReplaceElementAttribute', 'foo', 23, 42]
|
|
],
|
|
'exception': /^Invalid element error, can not set attributes on non-element data$/
|
|
},
|
|
'inserting text': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushReplace', [], ['F', 'O', 'O']]
|
|
],
|
|
'expected': function ( data ) {
|
|
data.splice( 1, 0, 'F', 'O', 'O' );
|
|
}
|
|
},
|
|
'removing text': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushReplace', ['a'], []]
|
|
],
|
|
'expected': function ( data ) {
|
|
data.splice( 1, 1 );
|
|
}
|
|
},
|
|
'replacing text': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushReplace', ['a'], ['F', 'O', 'O']]
|
|
],
|
|
'expected': function ( data ) {
|
|
data.splice( 1, 1, 'F', 'O', 'O' );
|
|
}
|
|
},
|
|
'inserting mixed content': {
|
|
'calls': [
|
|
['pushRetain', 1],
|
|
['pushReplace', ['a'], ['F', 'O', 'O', {'type':'image'}, {'type':'/image'}, 'B', 'A', 'R']]
|
|
],
|
|
'expected': function ( data ) {
|
|
data.splice( 1, 1, 'F', 'O', 'O', {'type':'image'}, {'type':'/image'}, 'B', 'A', 'R' );
|
|
}
|
|
},
|
|
'converting an element': {
|
|
'calls': [
|
|
[
|
|
'pushReplace',
|
|
[{ 'type': 'heading', 'attributes': { 'level': 1 } }],
|
|
[{ 'type': 'paragraph' }]
|
|
],
|
|
['pushRetain', 3],
|
|
['pushReplace', [{ 'type': '/heading' }], [{ 'type': '/paragraph' }]]
|
|
],
|
|
'expected': function ( data ) {
|
|
data[0].type = 'paragraph';
|
|
delete data[0].attributes;
|
|
data[4].type = '/paragraph';
|
|
}
|
|
},
|
|
'splitting an element': {
|
|
'calls': [
|
|
['pushRetain', 2],
|
|
[
|
|
'pushReplace',
|
|
[],
|
|
[{ '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],
|
|
[
|
|
'pushReplace',
|
|
[{ 'type': '/paragraph' }, { 'type': 'paragraph' }],
|
|
[]
|
|
]
|
|
],
|
|
'expected': function ( data ) {
|
|
data.splice( 57, 2 );
|
|
}
|
|
},
|
|
'stripping elements': {
|
|
'calls': [
|
|
['pushRetain', 3],
|
|
[
|
|
'pushReplace',
|
|
[['c', { '{"type":"textStyle/italic"}': { 'type': 'textStyle/italic' } }]],
|
|
[]
|
|
],
|
|
['pushRetain', 6],
|
|
[
|
|
'pushReplace',
|
|
['d'],
|
|
[]
|
|
]
|
|
],
|
|
'expected': function ( data ) {
|
|
data.splice( 10, 1 );
|
|
data.splice( 3, 1 );
|
|
}
|
|
}
|
|
};
|
|
// Generate original document
|
|
var originalData = ve.dm.example.data,
|
|
originalDoc = new ve.dm.Document( originalData );
|
|
// Run tests
|
|
for ( var msg in cases ) {
|
|
var testDocument = new ve.dm.Document( ve.copyArray( originalData ) ),
|
|
tx = new ve.dm.Transaction();
|
|
for ( var i = 0; i < cases[msg].calls.length; i++ ) {
|
|
tx[cases[msg].calls[i][0]].apply( tx, cases[msg].calls[i].slice( 1 ) );
|
|
}
|
|
if ( 'expected' in cases[msg] ) {
|
|
// Generate expected document
|
|
var expectedData = ve.copyArray( originalData );
|
|
cases[msg].expected( expectedData );
|
|
var expectedDocument = new ve.dm.Document( expectedData );
|
|
// Commit
|
|
ve.dm.TransactionProcessor.commit( testDocument, tx );
|
|
assert.deepEqual( testDocument.getData(), expectedData, 'commit (data): ' + msg );
|
|
assert.equalNodeTree(
|
|
testDocument.getDocumentNode(),
|
|
expectedDocument.getDocumentNode(),
|
|
'commit (tree): ' + msg
|
|
);
|
|
// Rollback
|
|
ve.dm.TransactionProcessor.rollback( testDocument, tx );
|
|
assert.deepEqual( testDocument.getData(), ve.dm.example.data, 'rollback (data): ' + msg );
|
|
assert.equalNodeTree(
|
|
testDocument.getDocumentNode(),
|
|
originalDoc.getDocumentNode(),
|
|
'rollback (tree): ' + msg
|
|
);
|
|
} else if ( 'exception' in cases[msg] ) {
|
|
/*jshint loopfunc:true */
|
|
assert.throws(
|
|
function () {
|
|
ve.dm.TransactionProcessor.commit( testDocument, tx );
|
|
},
|
|
cases[msg].exception,
|
|
'commit: ' + msg
|
|
);
|
|
}
|
|
}
|
|
} );
|