mediawiki-extensions-Visual.../modules/ve/test/init/ve.init.Platform.test.js

99 lines
2.4 KiB
JavaScript
Raw Normal View History

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
/*!
init.Platform: Refactor parsed messages. Rewrite VisualEditorMessagesModule: * Replace copy-paste dump of user-css module with stuff for VisualEditor (class commend and module::$origin). * Remove duplication between getMessages and getScript. * Actually implement getModifiedTime so that the comment in getMessages() about cache invalidation is actually true Fixes bug 42670: ext.visualEditor.specialMessages cache broken ve.init: * Implement addParsedMessages and getParsedMessage so that we don't mix up plain messages with raw html messages (minoredit was previously overloaded in mw.msg storage with a parsed html message and retrieved though ve.msg, which is documented as retuning plain text, not raw html). This is now separated into a different method. * Improved documentation of the other msg methods to emphasise their differences * Removed redundant code in attachSaveDialog() that was (partially) already done in setupSaveDialog() and moved the remaining bits into it as well. Checked all callers of these and they are both only called from ViewPageTarget.prototype.onLoad * Also implement them in the standalone platform implementation, with the html escaper based on mw.html.escape * Update init.platform.getMessage to use undefined instead of discouraged 'if-in' statement. * Add test suite. demos/test: * Re-run makeStaticLoader.php on test to add ve.init.Platform.test * Re-run makeStaticLoader.php on demos and update i18n caller to use ve.init.platform.addParsedMessages (also moved out of the auto-generated block for easier updating) Change-Id: I7f26b47e9467e850c08b9c217c4f1098590de109
2012-12-04 06:56:41 +00:00
* VisualEditor initialization tests.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
init.Platform: Refactor parsed messages. Rewrite VisualEditorMessagesModule: * Replace copy-paste dump of user-css module with stuff for VisualEditor (class commend and module::$origin). * Remove duplication between getMessages and getScript. * Actually implement getModifiedTime so that the comment in getMessages() about cache invalidation is actually true Fixes bug 42670: ext.visualEditor.specialMessages cache broken ve.init: * Implement addParsedMessages and getParsedMessage so that we don't mix up plain messages with raw html messages (minoredit was previously overloaded in mw.msg storage with a parsed html message and retrieved though ve.msg, which is documented as retuning plain text, not raw html). This is now separated into a different method. * Improved documentation of the other msg methods to emphasise their differences * Removed redundant code in attachSaveDialog() that was (partially) already done in setupSaveDialog() and moved the remaining bits into it as well. Checked all callers of these and they are both only called from ViewPageTarget.prototype.onLoad * Also implement them in the standalone platform implementation, with the html escaper based on mw.html.escape * Update init.platform.getMessage to use undefined instead of discouraged 'if-in' statement. * Add test suite. demos/test: * Re-run makeStaticLoader.php on test to add ve.init.Platform.test * Re-run makeStaticLoader.php on demos and update i18n caller to use ve.init.platform.addParsedMessages (also moved out of the auto-generated block for easier updating) Change-Id: I7f26b47e9467e850c08b9c217c4f1098590de109
2012-12-04 06:56:41 +00:00
* @license The MIT License (MIT); see LICENSE.txt
*/
QUnit.module( 've.init.Platform', {
setup: function () {
this.platform = ve.init.platform;
// Clone and deference instance
ve.init.platform = ve.cloneObject( ve.init.platform );
// Reset internal properties needed to keep tests atomic
ve.init.platform.parsedMessages = {};
// Platform specific properties
// TODO: Perhaps this warrants a clearMessages() method?
if ( ve.init.sa && ve.init.platform instanceof ve.init.sa.Platform ) {
ve.init.platform.messages = {};
} else if ( ve.init.mw && ve.init.platform instanceof ve.init.mw.Platform ) {
/*global mw */
this.mwMessagesValues = ve.copyObject( mw.messages.values );
}
},
teardown: function () {
ve.init.platform = this.platform;
if ( ve.init.mw && ve.init.platform instanceof ve.init.mw.Platform ) {
/*global mw */
mw.messages.values = this.mwMessagesValues;
}
}
} );
QUnit.test( 'messages', 4, function ( assert ) {
var platform = ve.init.platform;
assert.strictEqual(
platform.getMessage( 'foo' ),
'<foo>',
'return bracket-wrapped key as fallback'
);
platform.addMessages( {
foo: 'Foo & Bar <quux action="followed">by</quux>!',
bacon: 'Bacon <&> Ipsum: $1'
} );
assert.strictEqual(
platform.getMessage( 'foo' ),
'Foo & Bar <quux action="followed">by</quux>!',
'return plain message'
);
assert.strictEqual(
platform.getMessage( 'bacon', 10 ),
'Bacon <&> Ipsum: 10',
'return plain message with $# replacements'
);
assert.strictEqual(
platform.getMessage( 'quux' ),
'<quux>',
'return bracket-wrapped key as fallback (after set up)'
);
} );
QUnit.test( 'parsedMessage', 3, function ( assert ) {
var platform = ve.init.platform;
assert.strictEqual(
platform.getParsedMessage( 'foo' ),
'&lt;foo&gt;',
'return html escaped brackets in wrapped-key fallback'
);
platform.addMessages( {
foo: 'Foo & Bar <quux action="followed">by</quux>!',
bacon: 'Bacon <&> Ipsum: $1'
} );
platform.addParsedMessages( {
foo: 'Foo <quux>&lt;html&gt;</quux>'
} );
assert.strictEqual(
platform.getParsedMessage( 'foo' ),
'Foo <quux>&lt;html&gt;</quux>',
'prefer value from parsedMessage store'
);
assert.strictEqual(
platform.getParsedMessage( 'bacon', 10 ),
'Bacon &lt;&amp;&gt; Ipsum: $1',
'fall back to html-escaped version of plain message, no $# replacements'
);
} );