Removed old HTMLCacheUpdateJob b/c code
[lhc/web/wiklou.git] / tests / qunit / suites / resources / mediawiki / mediawiki.test.js
1 /*jshint -W024 */
2 ( function ( mw, $ ) {
3 var specialCharactersPageName,
4 // Can't mock SITENAME since jqueryMsg caches it at load
5 siteName = mw.config.get( 'wgSiteName' );
6
7 // Since QUnitTestResources.php loads both mediawiki and mediawiki.jqueryMsg as
8 // dependencies, this only tests the monkey-patched behavior with the two of them combined.
9
10 // See mediawiki.jqueryMsg.test.js for unit tests for jqueryMsg-specific functionality.
11
12 QUnit.module( 'mediawiki', QUnit.newMwEnvironment( {
13 setup: function () {
14 specialCharactersPageName = '"Who" wants to be a millionaire & live on \'Exotic Island\'?';
15 },
16 config: {
17 wgArticlePath: '/wiki/$1',
18
19 // For formatnum tests
20 wgUserLanguage: 'en'
21 },
22 // Messages used in multiple tests
23 messages: {
24 'other-message': 'Other Message',
25 'mediawiki-test-pagetriage-del-talk-page-notify-summary': 'Notifying author of deletion nomination for [[$1]]',
26 'gender-plural-msg': '{{GENDER:$1|he|she|they}} {{PLURAL:$2|is|are}} awesome',
27 'grammar-msg': 'Przeszukaj {{GRAMMAR:grammar_case_foo|{{SITENAME}}}}',
28 'formatnum-msg': '{{formatnum:$1}}',
29 'int-msg': 'Some {{int:other-message}}',
30 'mediawiki-test-version-entrypoints-index-php': '[https://www.mediawiki.org/wiki/Manual:index.php index.php]',
31 'external-link-replace': 'Foo [$1 bar]'
32 }
33 } ) );
34
35 mw.loader.addSource(
36 'testloader',
37 QUnit.fixurl( mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/load.mock.php' )
38 );
39
40 QUnit.test( 'Initial check', 8, function ( assert ) {
41 assert.ok( window.jQuery, 'jQuery defined' );
42 assert.ok( window.$, '$ defined' );
43 assert.strictEqual( window.$, window.jQuery, '$ alias to jQuery' );
44
45 this.suppressWarnings();
46 assert.ok( window.$j, '$j defined' );
47 assert.strictEqual( window.$j, window.jQuery, '$j alias to jQuery' );
48 this.restoreWarnings();
49
50 // window.mw and window.mediaWiki are not deprecated, but for some reason
51 // PhantomJS is triggerring the accessors on all mw.* properties in this test,
52 // and with that lots of unrelated deprecation notices.
53 this.suppressWarnings();
54 assert.ok( window.mediaWiki, 'mediaWiki defined' );
55 assert.ok( window.mw, 'mw defined' );
56 assert.strictEqual( window.mw, window.mediaWiki, 'mw alias to mediaWiki' );
57 this.restoreWarnings();
58 } );
59
60 QUnit.test( 'mw.Map', 35, function ( assert ) {
61 var arry, conf, funky, globalConf, nummy, someValues;
62
63 conf = new mw.Map();
64 // Dummy variables
65 funky = function () {};
66 arry = [];
67 nummy = 7;
68
69 // Single get and set
70
71 assert.strictEqual( conf.set( 'foo', 'Bar' ), true, 'Map.set returns boolean true if a value was set for a valid key string' );
72 assert.equal( conf.get( 'foo' ), 'Bar', 'Map.get returns a single value value correctly' );
73
74 assert.strictEqual( conf.get( 'example' ), null, 'Map.get returns null if selection was a string and the key was not found' );
75 assert.strictEqual( conf.get( 'example', arry ), arry, 'Map.get returns fallback by reference if the key was not found' );
76 assert.strictEqual( conf.get( 'example', undefined ), undefined, 'Map.get supports `undefined` as fallback instead of `null`' );
77
78 assert.strictEqual( conf.get( 'constructor' ), null, 'Map.get does not look at Object.prototype of internal storage (constructor)' );
79 assert.strictEqual( conf.get( 'hasOwnProperty' ), null, 'Map.get does not look at Object.prototype of internal storage (hasOwnProperty)' );
80
81 conf.set( 'hasOwnProperty', function () { return true; } );
82 assert.strictEqual( conf.get( 'example', 'missing' ), 'missing', 'Map.get uses neutral hasOwnProperty method (positive)' );
83
84 conf.set( 'example', 'Foo' );
85 conf.set( 'hasOwnProperty', function () { return false; } );
86 assert.strictEqual( conf.get( 'example' ), 'Foo', 'Map.get uses neutral hasOwnProperty method (negative)' );
87
88 assert.strictEqual( conf.set( 'constructor', 42 ), true, 'Map.set for key "constructor"' );
89 assert.strictEqual( conf.get( 'constructor' ), 42, 'Map.get for key "constructor"' );
90
91 assert.strictEqual( conf.set( 'undef' ), false, 'Map.set requires explicit value (no undefined default)' );
92
93 assert.strictEqual( conf.set( 'undef', undefined ), true, 'Map.set allows setting value to `undefined`' );
94 assert.equal( conf.get( 'undef', 'fallback' ), undefined, 'Map.get supports retreiving value of `undefined`' );
95
96 assert.strictEqual( conf.set( funky, 'Funky' ), false, 'Map.set returns boolean false if key was invalid (Function)' );
97 assert.strictEqual( conf.set( arry, 'Arry' ), false, 'Map.set returns boolean false if key was invalid (Array)' );
98 assert.strictEqual( conf.set( nummy, 'Nummy' ), false, 'Map.set returns boolean false if key was invalid (Number)' );
99
100 assert.strictEqual( conf.get( funky ), null, 'Map.get ruturns null if selection was invalid (Function)' );
101 assert.strictEqual( conf.get( nummy ), null, 'Map.get ruturns null if selection was invalid (Number)' );
102
103 conf.set( String( nummy ), 'I used to be a number' );
104
105 assert.strictEqual( conf.exists( 'doesNotExist' ), false, 'Map.exists where property does not exist' );
106 assert.strictEqual( conf.exists( 'undef' ), true, 'Map.exists where value is `undefined`' );
107 assert.strictEqual( conf.exists( nummy ), false, 'Map.exists where key is invalid but looks like an existing key' );
108
109 // Multiple values at once
110 someValues = {
111 'foo': 'bar',
112 'lorem': 'ipsum',
113 'MediaWiki': true
114 };
115 assert.strictEqual( conf.set( someValues ), true, 'Map.set returns boolean true if multiple values were set by passing an object' );
116 assert.deepEqual( conf.get( ['foo', 'lorem'] ), {
117 'foo': 'bar',
118 'lorem': 'ipsum'
119 }, 'Map.get returns multiple values correctly as an object' );
120
121 assert.deepEqual( conf, new mw.Map( conf.values ), 'new mw.Map maps over existing values-bearing object' );
122
123 assert.deepEqual( conf.get( ['foo', 'notExist'] ), {
124 'foo': 'bar',
125 'notExist': null
126 }, 'Map.get return includes keys that were not found as null values' );
127
128 // Interacting with globals and accessing the values object
129 assert.strictEqual( conf.get(), conf.values, 'Map.get returns the entire values object by reference (if called without arguments)' );
130
131 conf.set( 'globalMapChecker', 'Hi' );
132
133 assert.ok( ( 'globalMapChecker' in window ) === false, 'Map does not its store values in the window object by default' );
134
135 globalConf = new mw.Map( true );
136 globalConf.set( 'anotherGlobalMapChecker', 'Hello' );
137
138 assert.ok( 'anotherGlobalMapChecker' in window, 'global Map stores its values in the window object' );
139
140 assert.equal( globalConf.get( 'anotherGlobalMapChecker' ), 'Hello', 'get value from global Map via get()' );
141 this.suppressWarnings();
142 assert.equal( window.anotherGlobalMapChecker, 'Hello', 'get value from global Map via window object' );
143 this.restoreWarnings();
144
145 // Change value via global Map
146 globalConf.set('anotherGlobalMapChecker', 'Again');
147 assert.equal( globalConf.get( 'anotherGlobalMapChecker' ), 'Again', 'Change in global Map reflected via get()' );
148 this.suppressWarnings();
149 assert.equal( window.anotherGlobalMapChecker, 'Again', 'Change in global Map reflected window object' );
150 this.restoreWarnings();
151
152 // Change value via window object
153 this.suppressWarnings();
154 window.anotherGlobalMapChecker = 'World';
155 assert.equal( window.anotherGlobalMapChecker, 'World', 'Change in window object works' );
156 this.restoreWarnings();
157 assert.equal( globalConf.get( 'anotherGlobalMapChecker' ), 'Again', 'Change in window object not reflected in global Map' );
158
159 // Whitelist this global variable for QUnit's 'noglobal' mode
160 if ( QUnit.config.noglobals ) {
161 QUnit.config.pollution.push( 'anotherGlobalMapChecker' );
162 }
163 } );
164
165 QUnit.test( 'mw.config', 1, function ( assert ) {
166 assert.ok( mw.config instanceof mw.Map, 'mw.config instance of mw.Map' );
167 } );
168
169 QUnit.test( 'mw.message & mw.messages', 100, function ( assert ) {
170 var goodbye, hello;
171
172 // Convenience method for asserting the same result for multiple formats
173 function assertMultipleFormats( messageArguments, formats, expectedResult, assertMessage ) {
174 var len = formats.length, format, i;
175 for ( i = 0; i < len; i++ ) {
176 format = formats[i];
177 assert.equal( mw.message.apply( null, messageArguments )[format](), expectedResult, assertMessage + ' when format is ' + format );
178 }
179 }
180
181 assert.ok( mw.messages, 'messages defined' );
182 assert.ok( mw.messages instanceof mw.Map, 'mw.messages instance of mw.Map' );
183 assert.ok( mw.messages.set( 'hello', 'Hello <b>awesome</b> world' ), 'mw.messages.set: Register' );
184
185 hello = mw.message( 'hello' );
186
187 // https://bugzilla.wikimedia.org/show_bug.cgi?id=44459
188 assert.equal( hello.format, 'text', 'Message property "format" defaults to "text"' );
189
190 assert.strictEqual( hello.map, mw.messages, 'Message property "map" defaults to the global instance in mw.messages' );
191 assert.equal( hello.key, 'hello', 'Message property "key" (currect key)' );
192 assert.deepEqual( hello.parameters, [], 'Message property "parameters" defaults to an empty array' );
193
194 // Todo
195 assert.ok( hello.params, 'Message prototype "params"' );
196
197 hello.format = 'plain';
198 assert.equal( hello.toString(), 'Hello <b>awesome</b> world', 'Message.toString returns the message as a string with the current "format"' );
199
200 assert.equal( hello.escaped(), 'Hello &lt;b&gt;awesome&lt;/b&gt; world', 'Message.escaped returns the escaped message' );
201 assert.equal( hello.format, 'escaped', 'Message.escaped correctly updated the "format" property' );
202
203 assert.ok( mw.messages.set( 'multiple-curly-brace', '"{{SITENAME}}" is the home of {{int:other-message}}' ), 'mw.messages.set: Register' );
204 assertMultipleFormats( ['multiple-curly-brace'], ['text', 'parse'], '"' + siteName + '" is the home of Other Message', 'Curly brace format works correctly' );
205 assert.equal( mw.message( 'multiple-curly-brace' ).plain(), mw.messages.get( 'multiple-curly-brace' ), 'Plain format works correctly for curly brace message' );
206 assert.equal( mw.message( 'multiple-curly-brace' ).escaped(), mw.html.escape( '"' + siteName + '" is the home of Other Message' ), 'Escaped format works correctly for curly brace message' );
207
208 assert.ok( mw.messages.set( 'multiple-square-brackets-and-ampersand', 'Visit the [[Project:Community portal|community portal]] & [[Project:Help desk|help desk]]' ), 'mw.messages.set: Register' );
209 assertMultipleFormats( ['multiple-square-brackets-and-ampersand'], ['plain', 'text'], mw.messages.get( 'multiple-square-brackets-and-ampersand' ), 'Square bracket message is not processed' );
210 assert.equal( mw.message( 'multiple-square-brackets-and-ampersand' ).escaped(), 'Visit the [[Project:Community portal|community portal]] &amp; [[Project:Help desk|help desk]]', 'Escaped format works correctly for square bracket message' );
211 assert.htmlEqual( mw.message( 'multiple-square-brackets-and-ampersand' ).parse(), 'Visit the ' +
212 '<a title="Project:Community portal" href="/wiki/Project:Community_portal">community portal</a>' +
213 ' &amp; <a title="Project:Help desk" href="/wiki/Project:Help_desk">help desk</a>', 'Internal links work with parse' );
214
215 assertMultipleFormats( ['mediawiki-test-version-entrypoints-index-php'], ['plain', 'text', 'escaped'], mw.messages.get( 'mediawiki-test-version-entrypoints-index-php' ), 'External link markup is unprocessed' );
216 assert.htmlEqual( mw.message( 'mediawiki-test-version-entrypoints-index-php' ).parse(), '<a href="https://www.mediawiki.org/wiki/Manual:index.php">index.php</a>', 'External link works correctly in parse mode' );
217
218 assertMultipleFormats( ['external-link-replace', 'http://example.org/?x=y&z'], ['plain', 'text'], 'Foo [http://example.org/?x=y&z bar]', 'Parameters are substituted but external link is not processed' );
219 assert.equal( mw.message( 'external-link-replace', 'http://example.org/?x=y&z' ).escaped(), 'Foo [http://example.org/?x=y&amp;z bar]', 'In escaped mode, parameters are substituted and ampersand is escaped, but external link is not processed' );
220 assert.htmlEqual( mw.message( 'external-link-replace', 'http://example.org/?x=y&z' ).parse(), 'Foo <a href="http://example.org/?x=y&amp;z">bar</a>', 'External link with replacement works in parse mode without double-escaping' );
221
222 hello.parse();
223 assert.equal( hello.format, 'parse', 'Message.parse correctly updated the "format" property' );
224
225 hello.plain();
226 assert.equal( hello.format, 'plain', 'Message.plain correctly updated the "format" property' );
227
228 hello.text();
229 assert.equal( hello.format, 'text', 'Message.text correctly updated the "format" property' );
230
231 assert.strictEqual( hello.exists(), true, 'Message.exists returns true for existing messages' );
232
233 goodbye = mw.message( 'goodbye' );
234 assert.strictEqual( goodbye.exists(), false, 'Message.exists returns false for nonexistent messages' );
235
236 assertMultipleFormats( ['goodbye'], ['plain', 'text'], '<goodbye>', 'Message.toString returns <key> if key does not exist' );
237 // bug 30684
238 assertMultipleFormats( ['goodbye'], ['parse', 'escaped'], '&lt;goodbye&gt;', 'Message.toString returns properly escaped &lt;key&gt; if key does not exist' );
239
240 assert.ok( mw.messages.set( 'plural-test-msg', 'There {{PLURAL:$1|is|are}} $1 {{PLURAL:$1|result|results}}' ), 'mw.messages.set: Register' );
241 assertMultipleFormats( ['plural-test-msg', 6], ['text', 'parse', 'escaped'], 'There are 6 results', 'plural get resolved' );
242 assert.equal( mw.message( 'plural-test-msg', 6 ).plain(), 'There {{PLURAL:6|is|are}} 6 {{PLURAL:6|result|results}}', 'Parameter is substituted but plural is not resolved in plain' );
243
244 assert.ok( mw.messages.set( 'plural-test-msg-explicit', 'There {{plural:$1|is one car|are $1 cars|0=are no cars|12=are a dozen cars}}' ), 'mw.messages.set: Register message with explicit plural forms' );
245 assertMultipleFormats( ['plural-test-msg-explicit', 12], ['text', 'parse', 'escaped'], 'There are a dozen cars', 'explicit plural get resolved' );
246
247 assert.ok( mw.messages.set( 'plural-test-msg-explicit-beginning', 'Basket has {{plural:$1|0=no eggs|12=a dozen eggs|6=half a dozen eggs|one egg|$1 eggs}}' ), 'mw.messages.set: Register message with explicit plural forms' );
248 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 1], ['text', 'parse', 'escaped'], 'Basket has one egg', 'explicit plural given at beginning get resolved for singular' );
249 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 4], ['text', 'parse', 'escaped'], 'Basket has 4 eggs', 'explicit plural given at beginning get resolved for plural' );
250 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 6], ['text', 'parse', 'escaped'], 'Basket has half a dozen eggs', 'explicit plural given at beginning get resolved for 6' );
251 assertMultipleFormats( ['plural-test-msg-explicit-beginning', 0], ['text', 'parse', 'escaped'], 'Basket has no eggs', 'explicit plural given at beginning get resolved for 0' );
252
253 assertMultipleFormats( ['mediawiki-test-pagetriage-del-talk-page-notify-summary'], ['plain', 'text'], mw.messages.get( 'mediawiki-test-pagetriage-del-talk-page-notify-summary' ), 'Double square brackets with no parameters unchanged' );
254
255 assertMultipleFormats( ['mediawiki-test-pagetriage-del-talk-page-notify-summary', specialCharactersPageName], ['plain', 'text'], 'Notifying author of deletion nomination for [[' + specialCharactersPageName + ']]', 'Double square brackets with one parameter' );
256
257 assert.equal( mw.message( 'mediawiki-test-pagetriage-del-talk-page-notify-summary', specialCharactersPageName ).escaped(), 'Notifying author of deletion nomination for [[' + mw.html.escape( specialCharactersPageName ) + ']]', 'Double square brackets with one parameter, when escaped' );
258
259 assert.ok( mw.messages.set( 'mediawiki-test-categorytree-collapse-bullet', '[<b>−</b>]' ), 'mw.messages.set: Register' );
260 assert.equal( mw.message( 'mediawiki-test-categorytree-collapse-bullet' ).plain(), mw.messages.get( 'mediawiki-test-categorytree-collapse-bullet' ), 'Single square brackets unchanged in plain mode' );
261
262 assert.ok( mw.messages.set( 'mediawiki-test-wikieditor-toolbar-help-content-signature-result', '<a href=\'#\' title=\'{{#special:mypage}}\'>Username</a> (<a href=\'#\' title=\'{{#special:mytalk}}\'>talk</a>)' ), 'mw.messages.set: Register' );
263 assert.equal( mw.message( 'mediawiki-test-wikieditor-toolbar-help-content-signature-result' ).plain(), mw.messages.get( 'mediawiki-test-wikieditor-toolbar-help-content-signature-result' ), 'HTML message with curly braces is not changed in plain mode' );
264
265 assertMultipleFormats( ['gender-plural-msg', 'male', 1], ['text', 'parse', 'escaped'], 'he is awesome', 'Gender and plural are resolved' );
266 assert.equal( mw.message( 'gender-plural-msg', 'male', 1 ).plain(), '{{GENDER:male|he|she|they}} {{PLURAL:1|is|are}} awesome', 'Parameters are substituted, but gender and plural are not resolved in plain mode' );
267
268 assert.equal( mw.message( 'grammar-msg' ).plain(), mw.messages.get( 'grammar-msg' ), 'Grammar is not resolved in plain mode' );
269 assertMultipleFormats( ['grammar-msg'], ['text', 'parse'], 'Przeszukaj ' + siteName, 'Grammar is resolved' );
270 assert.equal( mw.message( 'grammar-msg' ).escaped(), 'Przeszukaj ' + siteName, 'Grammar is resolved in escaped mode' );
271
272 assertMultipleFormats( ['formatnum-msg', '987654321.654321'], ['text', 'parse', 'escaped'], '987,654,321.654', 'formatnum is resolved' );
273 assert.equal( mw.message( 'formatnum-msg' ).plain(), mw.messages.get( 'formatnum-msg' ), 'formatnum is not resolved in plain mode' );
274
275 assertMultipleFormats( ['int-msg'], ['text', 'parse', 'escaped'], 'Some Other Message', 'int is resolved' );
276 assert.equal( mw.message( 'int-msg' ).plain(), mw.messages.get( 'int-msg' ), 'int is not resolved in plain mode' );
277
278 assert.ok( mw.messages.set( 'mediawiki-italics-msg', '<i>Very</i> important' ), 'mw.messages.set: Register' );
279 assertMultipleFormats( ['mediawiki-italics-msg'], ['plain', 'text', 'parse'], mw.messages.get( 'mediawiki-italics-msg' ), 'Simple italics unchanged' );
280 assert.htmlEqual(
281 mw.message( 'mediawiki-italics-msg' ).escaped(),
282 '&lt;i&gt;Very&lt;/i&gt; important',
283 'Italics are escaped in escaped mode'
284 );
285
286 assert.ok( mw.messages.set( 'mediawiki-italics-with-link', 'An <i>italicized [[link|wiki-link]]</i>' ), 'mw.messages.set: Register' );
287 assertMultipleFormats( ['mediawiki-italics-with-link'], ['plain', 'text'], mw.messages.get( 'mediawiki-italics-with-link' ), 'Italics with link unchanged' );
288 assert.htmlEqual(
289 mw.message( 'mediawiki-italics-with-link' ).escaped(),
290 'An &lt;i&gt;italicized [[link|wiki-link]]&lt;/i&gt;',
291 'Italics and link unchanged except for escaping in escaped mode'
292 );
293 assert.htmlEqual(
294 mw.message( 'mediawiki-italics-with-link' ).parse(),
295 'An <i>italicized <a title="link" href="' + mw.util.getUrl( 'link' ) + '">wiki-link</i>',
296 'Italics with link inside in parse mode'
297 );
298
299 assert.ok( mw.messages.set( 'mediawiki-script-msg', '<script >alert( "Who put this script here?" );</script>' ), 'mw.messages.set: Register' );
300 assertMultipleFormats( ['mediawiki-script-msg'], ['plain', 'text'], mw.messages.get( 'mediawiki-script-msg' ), 'Script unchanged' );
301 assert.htmlEqual(
302 mw.message( 'mediawiki-script-msg' ).escaped(),
303 '&lt;script &gt;alert( "Who put this script here?" );&lt;/script&gt;',
304 'Script escaped when using escaped format'
305 );
306 assert.htmlEqual(
307 mw.message( 'mediawiki-script-msg' ).parse(),
308 '&lt;script &gt;alert( "Who put this script here?" );&lt;/script&gt;',
309 'Script escaped when using parse format'
310 );
311
312 } );
313
314 QUnit.test( 'mw.msg', 14, function ( assert ) {
315 assert.ok( mw.messages.set( 'hello', 'Hello <b>awesome</b> world' ), 'mw.messages.set: Register' );
316 assert.equal( mw.msg( 'hello' ), 'Hello <b>awesome</b> world', 'Gets message with default options (existing message)' );
317 assert.equal( mw.msg( 'goodbye' ), '<goodbye>', 'Gets message with default options (nonexistent message)' );
318
319 assert.ok( mw.messages.set( 'plural-item', 'Found $1 {{PLURAL:$1|item|items}}' ), 'mw.messages.set: Register' );
320 assert.equal( mw.msg( 'plural-item', 5 ), 'Found 5 items', 'Apply plural for count 5' );
321 assert.equal( mw.msg( 'plural-item', 0 ), 'Found 0 items', 'Apply plural for count 0' );
322 assert.equal( mw.msg( 'plural-item', 1 ), 'Found 1 item', 'Apply plural for count 1' );
323
324 assert.equal( mw.msg( 'mediawiki-test-pagetriage-del-talk-page-notify-summary', specialCharactersPageName ), 'Notifying author of deletion nomination for [[' + specialCharactersPageName + ']]', 'Double square brackets in mw.msg one parameter' );
325
326 assert.equal( mw.msg( 'gender-plural-msg', 'male', 1 ), 'he is awesome', 'Gender test for male, plural count 1' );
327 assert.equal( mw.msg( 'gender-plural-msg', 'female', '1' ), 'she is awesome', 'Gender test for female, plural count 1' );
328 assert.equal( mw.msg( 'gender-plural-msg', 'unknown', 10 ), 'they are awesome', 'Gender test for neutral, plural count 10' );
329
330 assert.equal( mw.msg( 'grammar-msg' ), 'Przeszukaj ' + siteName, 'Grammar is resolved' );
331
332 assert.equal( mw.msg( 'formatnum-msg', '987654321.654321' ), '987,654,321.654', 'formatnum is resolved' );
333
334 assert.equal( mw.msg( 'int-msg' ), 'Some Other Message', 'int is resolved' );
335 } );
336
337 /**
338 * The sync style load test (for @import). This is, in a way, also an open bug for
339 * ResourceLoader ("execute js after styles are loaded"), but browsers don't offer a
340 * way to get a callback from when a stylesheet is loaded (that is, including any
341 * @import rules inside). To work around this, we'll have a little time loop to check
342 * if the styles apply.
343 * Note: This test originally used new Image() and onerror to get a callback
344 * when the url is loaded, but that is fragile since it doesn't monitor the
345 * same request as the css @import, and Safari 4 has issues with
346 * onerror/onload not being fired at all in weird cases like this.
347 */
348 function assertStyleAsync( assert, $element, prop, val, fn ) {
349 var styleTestStart,
350 el = $element.get( 0 ),
351 styleTestTimeout = ( QUnit.config.testTimeout || 5000 ) - 200;
352
353 function isCssImportApplied() {
354 // Trigger reflow, repaint, redraw, whatever (cross-browser)
355 var x = $element.css( 'height' );
356 x = el.innerHTML;
357 el.className = el.className;
358 x = document.documentElement.clientHeight;
359
360 return $element.css( prop ) === val;
361 }
362
363 function styleTestLoop() {
364 var styleTestSince = new Date().getTime() - styleTestStart;
365 // If it is passing or if we timed out, run the real test and stop the loop
366 if ( isCssImportApplied() || styleTestSince > styleTestTimeout ) {
367 assert.equal( $element.css( prop ), val,
368 'style "' + prop + ': ' + val + '" from url is applied (after ' + styleTestSince + 'ms)'
369 );
370
371 if ( fn ) {
372 fn();
373 }
374
375 return;
376 }
377 // Otherwise, keep polling
378 setTimeout( styleTestLoop, 150 );
379 }
380
381 // Start the loop
382 styleTestStart = new Date().getTime();
383 styleTestLoop();
384 }
385
386 function urlStyleTest( selector, prop, val ) {
387 return QUnit.fixurl(
388 mw.config.get( 'wgScriptPath' ) +
389 '/tests/qunit/data/styleTest.css.php?' +
390 $.param( {
391 selector: selector,
392 prop: prop,
393 val: val
394 } )
395 );
396 }
397
398 QUnit.asyncTest( 'mw.loader', 2, function ( assert ) {
399 var isAwesomeDone;
400
401 mw.loader.testCallback = function () {
402 QUnit.start();
403 assert.strictEqual( isAwesomeDone, undefined, 'Implementing module is.awesome: isAwesomeDone should still be undefined' );
404 isAwesomeDone = true;
405 };
406
407 mw.loader.implement( 'test.callback', [QUnit.fixurl( mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/callMwLoaderTestCallback.js' )], {}, {} );
408
409 mw.loader.using( 'test.callback', function () {
410
411 // /sample/awesome.js declares the "mw.loader.testCallback" function
412 // which contains a call to start() and ok()
413 assert.strictEqual( isAwesomeDone, true, 'test.callback module should\'ve caused isAwesomeDone to be true' );
414 delete mw.loader.testCallback;
415
416 }, function () {
417 QUnit.start();
418 assert.ok( false, 'Error callback fired while loader.using "test.callback" module' );
419 } );
420 } );
421
422 QUnit.asyncTest( 'mw.loader with Object method as module name', 2, function ( assert ) {
423 var isAwesomeDone;
424
425 mw.loader.testCallback = function () {
426 QUnit.start();
427 assert.strictEqual( isAwesomeDone, undefined, 'Implementing module hasOwnProperty: isAwesomeDone should still be undefined' );
428 isAwesomeDone = true;
429 };
430
431 mw.loader.implement( 'hasOwnProperty', [QUnit.fixurl( mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/callMwLoaderTestCallback.js' )], {}, {} );
432
433 mw.loader.using( 'hasOwnProperty', function () {
434
435 // /sample/awesome.js declares the "mw.loader.testCallback" function
436 // which contains a call to start() and ok()
437 assert.strictEqual( isAwesomeDone, true, 'hasOwnProperty module should\'ve caused isAwesomeDone to be true' );
438 delete mw.loader.testCallback;
439
440 }, function () {
441 QUnit.start();
442 assert.ok( false, 'Error callback fired while loader.using "hasOwnProperty" module' );
443 } );
444 } );
445
446 QUnit.asyncTest( 'mw.loader.using( .. ).promise', 2, function ( assert ) {
447 var isAwesomeDone;
448
449 mw.loader.testCallback = function () {
450 QUnit.start();
451 assert.strictEqual( isAwesomeDone, undefined, 'Implementing module is.awesome: isAwesomeDone should still be undefined' );
452 isAwesomeDone = true;
453 };
454
455 mw.loader.implement( 'test.promise', [QUnit.fixurl( mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/callMwLoaderTestCallback.js' )], {}, {} );
456
457 mw.loader.using( 'test.promise' )
458 .done( function () {
459
460 // /sample/awesome.js declares the "mw.loader.testCallback" function
461 // which contains a call to start() and ok()
462 assert.strictEqual( isAwesomeDone, true, 'test.promise module should\'ve caused isAwesomeDone to be true' );
463 delete mw.loader.testCallback;
464
465 } )
466 .fail( function () {
467 QUnit.start();
468 assert.ok( false, 'Error callback fired while loader.using "test.promise" module' );
469 } );
470 } );
471
472 QUnit.asyncTest( 'mw.loader.implement( styles={ "css": [text, ..] } )', 2, function ( assert ) {
473 var $element = $( '<div class="mw-test-implement-a"></div>' ).appendTo( '#qunit-fixture' );
474
475 assert.notEqual(
476 $element.css( 'float' ),
477 'right',
478 'style is clear'
479 );
480
481 mw.loader.implement(
482 'test.implement.a',
483 function () {
484 assert.equal(
485 $element.css( 'float' ),
486 'right',
487 'style is applied'
488 );
489 QUnit.start();
490 },
491 {
492 'all': '.mw-test-implement-a { float: right; }'
493 },
494 {}
495 );
496
497 mw.loader.load( [
498 'test.implement.a'
499 ] );
500 } );
501
502 QUnit.asyncTest( 'mw.loader.implement( styles={ "url": { <media>: [url, ..] } } )', 7, function ( assert ) {
503 var $element1 = $( '<div class="mw-test-implement-b1"></div>' ).appendTo( '#qunit-fixture' ),
504 $element2 = $( '<div class="mw-test-implement-b2"></div>' ).appendTo( '#qunit-fixture' ),
505 $element3 = $( '<div class="mw-test-implement-b3"></div>' ).appendTo( '#qunit-fixture' );
506
507 assert.notEqual(
508 $element1.css( 'text-align' ),
509 'center',
510 'style is clear'
511 );
512 assert.notEqual(
513 $element2.css( 'float' ),
514 'left',
515 'style is clear'
516 );
517 assert.notEqual(
518 $element3.css( 'text-align' ),
519 'right',
520 'style is clear'
521 );
522
523 mw.loader.implement(
524 'test.implement.b',
525 function () {
526 // Note: QUnit.start() must only be called when the entire test is
527 // complete. So, make sure that we don't start until *both*
528 // assertStyleAsync calls have completed.
529 var pending = 2;
530 assertStyleAsync( assert, $element2, 'float', 'left', function () {
531 assert.notEqual( $element1.css( 'text-align' ), 'center', 'print style is not applied' );
532
533 pending--;
534 if ( pending === 0 ) {
535 QUnit.start();
536 }
537 } );
538 assertStyleAsync( assert, $element3, 'float', 'right', function () {
539 assert.notEqual( $element1.css( 'text-align' ), 'center', 'print style is not applied' );
540
541 pending--;
542 if ( pending === 0 ) {
543 QUnit.start();
544 }
545 } );
546 },
547 {
548 'url': {
549 'print': [urlStyleTest( '.mw-test-implement-b1', 'text-align', 'center' )],
550 'screen': [
551 // bug 40834: Make sure it actually works with more than 1 stylesheet reference
552 urlStyleTest( '.mw-test-implement-b2', 'float', 'left' ),
553 urlStyleTest( '.mw-test-implement-b3', 'float', 'right' )
554 ]
555 }
556 },
557 {}
558 );
559
560 mw.loader.load( [
561 'test.implement.b'
562 ] );
563 } );
564
565 // Backwards compatibility
566 QUnit.asyncTest( 'mw.loader.implement( styles={ <media>: text } ) (back-compat)', 2, function ( assert ) {
567 var $element = $( '<div class="mw-test-implement-c"></div>' ).appendTo( '#qunit-fixture' );
568
569 assert.notEqual(
570 $element.css( 'float' ),
571 'right',
572 'style is clear'
573 );
574
575 mw.loader.implement(
576 'test.implement.c',
577 function () {
578 assert.equal(
579 $element.css( 'float' ),
580 'right',
581 'style is applied'
582 );
583 QUnit.start();
584 },
585 {
586 'all': '.mw-test-implement-c { float: right; }'
587 },
588 {}
589 );
590
591 mw.loader.load( [
592 'test.implement.c'
593 ] );
594 } );
595
596 // Backwards compatibility
597 QUnit.asyncTest( 'mw.loader.implement( styles={ <media>: [url, ..] } ) (back-compat)', 4, function ( assert ) {
598 var $element = $( '<div class="mw-test-implement-d"></div>' ).appendTo( '#qunit-fixture' ),
599 $element2 = $( '<div class="mw-test-implement-d2"></div>' ).appendTo( '#qunit-fixture' );
600
601 assert.notEqual(
602 $element.css( 'float' ),
603 'right',
604 'style is clear'
605 );
606 assert.notEqual(
607 $element2.css( 'text-align' ),
608 'center',
609 'style is clear'
610 );
611
612 mw.loader.implement(
613 'test.implement.d',
614 function () {
615 assertStyleAsync( assert, $element, 'float', 'right', function () {
616
617 assert.notEqual( $element2.css( 'text-align' ), 'center', 'print style is not applied (bug 40500)' );
618
619 QUnit.start();
620 } );
621 },
622 {
623 'all': [urlStyleTest( '.mw-test-implement-d', 'float', 'right' )],
624 'print': [urlStyleTest( '.mw-test-implement-d2', 'text-align', 'center' )]
625 },
626 {}
627 );
628
629 mw.loader.load( [
630 'test.implement.d'
631 ] );
632 } );
633
634 // @import (bug 31676)
635 QUnit.asyncTest( 'mw.loader.implement( styles has @import)', 5, function ( assert ) {
636 var isJsExecuted, $element;
637
638 mw.loader.implement(
639 'test.implement.import',
640 function () {
641 assert.strictEqual( isJsExecuted, undefined, 'javascript not executed multiple times' );
642 isJsExecuted = true;
643
644 assert.equal( mw.loader.getState( 'test.implement.import' ), 'ready', 'module state is "ready" while implement() is executing javascript' );
645
646 $element = $( '<div class="mw-test-implement-import">Foo bar</div>' ).appendTo( '#qunit-fixture' );
647
648 assert.equal( mw.msg( 'test-foobar' ), 'Hello Foobar, $1!', 'Messages are loaded before javascript execution' );
649
650 assertStyleAsync( assert, $element, 'float', 'right', function () {
651 assert.equal( $element.css( 'text-align' ), 'center',
652 'CSS styles after the @import rule are working'
653 );
654
655 QUnit.start();
656 } );
657 },
658 {
659 'css': [
660 '@import url(\''
661 + urlStyleTest( '.mw-test-implement-import', 'float', 'right' )
662 + '\');\n'
663 + '.mw-test-implement-import { text-align: center; }'
664 ]
665 },
666 {
667 'test-foobar': 'Hello Foobar, $1!'
668 }
669 );
670
671 mw.loader.load( 'test.implement' );
672
673 } );
674
675 QUnit.test( 'mw.loader.implement( only scripts )', 1, function ( assert ) {
676 mw.loader.implement( 'test.onlyscripts', function () {} );
677 assert.strictEqual( mw.loader.getState( 'test.onlyscripts' ), 'ready' );
678 } );
679
680 QUnit.asyncTest( 'mw.loader.implement( only messages )', 2, function ( assert ) {
681 assert.assertFalse( mw.messages.exists( 'bug_29107' ), 'Verify that the test message doesn\'t exist yet' );
682
683 mw.loader.implement( 'test.implement.msgs', [], {}, { 'bug_29107': 'loaded' } );
684 mw.loader.using( 'test.implement.msgs', function () {
685 QUnit.start();
686 assert.ok( mw.messages.exists( 'bug_29107' ), 'Bug 29107: messages-only module should implement ok' );
687 }, function () {
688 QUnit.start();
689 assert.ok( false, 'Error callback fired while implementing "test.implement.msgs" module' );
690 } );
691 } );
692
693 QUnit.test( 'mw.loader erroneous indirect dependency', 3, function ( assert ) {
694 mw.loader.register( [
695 ['test.module1', '0'],
696 ['test.module2', '0', ['test.module1']],
697 ['test.module3', '0', ['test.module2']]
698 ] );
699 mw.loader.implement( 'test.module1', function () {
700 throw new Error( 'expected' );
701 }, {}, {} );
702 assert.strictEqual( mw.loader.getState( 'test.module1' ), 'error', 'Expected "error" state for test.module1' );
703 assert.strictEqual( mw.loader.getState( 'test.module2' ), 'error', 'Expected "error" state for test.module2' );
704 assert.strictEqual( mw.loader.getState( 'test.module3' ), 'error', 'Expected "error" state for test.module3' );
705 } );
706
707 QUnit.test( 'mw.loader out-of-order implementation', 9, function ( assert ) {
708 mw.loader.register( [
709 ['test.module4', '0'],
710 ['test.module5', '0', ['test.module4']],
711 ['test.module6', '0', ['test.module5']]
712 ] );
713 mw.loader.implement( 'test.module4', function () {
714 }, {}, {} );
715 assert.strictEqual( mw.loader.getState( 'test.module4' ), 'ready', 'Expected "ready" state for test.module4' );
716 assert.strictEqual( mw.loader.getState( 'test.module5' ), 'registered', 'Expected "registered" state for test.module5' );
717 assert.strictEqual( mw.loader.getState( 'test.module6' ), 'registered', 'Expected "registered" state for test.module6' );
718 mw.loader.implement( 'test.module6', function () {
719 }, {}, {} );
720 assert.strictEqual( mw.loader.getState( 'test.module4' ), 'ready', 'Expected "ready" state for test.module4' );
721 assert.strictEqual( mw.loader.getState( 'test.module5' ), 'registered', 'Expected "registered" state for test.module5' );
722 assert.strictEqual( mw.loader.getState( 'test.module6' ), 'loaded', 'Expected "loaded" state for test.module6' );
723 mw.loader.implement( 'test.module5', function () {
724 }, {}, {} );
725 assert.strictEqual( mw.loader.getState( 'test.module4' ), 'ready', 'Expected "ready" state for test.module4' );
726 assert.strictEqual( mw.loader.getState( 'test.module5' ), 'ready', 'Expected "ready" state for test.module5' );
727 assert.strictEqual( mw.loader.getState( 'test.module6' ), 'ready', 'Expected "ready" state for test.module6' );
728 } );
729
730 QUnit.test( 'mw.loader missing dependency', 13, function ( assert ) {
731 mw.loader.register( [
732 ['test.module7', '0'],
733 ['test.module8', '0', ['test.module7']],
734 ['test.module9', '0', ['test.module8']]
735 ] );
736 mw.loader.implement( 'test.module8', function () {
737 }, {}, {} );
738 assert.strictEqual( mw.loader.getState( 'test.module7' ), 'registered', 'Expected "registered" state for test.module7' );
739 assert.strictEqual( mw.loader.getState( 'test.module8' ), 'loaded', 'Expected "loaded" state for test.module8' );
740 assert.strictEqual( mw.loader.getState( 'test.module9' ), 'registered', 'Expected "registered" state for test.module9' );
741 mw.loader.state( 'test.module7', 'missing' );
742 assert.strictEqual( mw.loader.getState( 'test.module7' ), 'missing', 'Expected "missing" state for test.module7' );
743 assert.strictEqual( mw.loader.getState( 'test.module8' ), 'error', 'Expected "error" state for test.module8' );
744 assert.strictEqual( mw.loader.getState( 'test.module9' ), 'error', 'Expected "error" state for test.module9' );
745 mw.loader.implement( 'test.module9', function () {
746 }, {}, {} );
747 assert.strictEqual( mw.loader.getState( 'test.module7' ), 'missing', 'Expected "missing" state for test.module7' );
748 assert.strictEqual( mw.loader.getState( 'test.module8' ), 'error', 'Expected "error" state for test.module8' );
749 assert.strictEqual( mw.loader.getState( 'test.module9' ), 'error', 'Expected "error" state for test.module9' );
750 mw.loader.using(
751 ['test.module7'],
752 function () {
753 assert.ok( false, 'Success fired despite missing dependency' );
754 assert.ok( true, 'QUnit expected() count dummy' );
755 },
756 function ( e, dependencies ) {
757 assert.strictEqual( $.isArray( dependencies ), true, 'Expected array of dependencies' );
758 assert.deepEqual( dependencies, ['test.module7'], 'Error callback called with module test.module7' );
759 }
760 );
761 mw.loader.using(
762 ['test.module9'],
763 function () {
764 assert.ok( false, 'Success fired despite missing dependency' );
765 assert.ok( true, 'QUnit expected() count dummy' );
766 },
767 function ( e, dependencies ) {
768 assert.strictEqual( $.isArray( dependencies ), true, 'Expected array of dependencies' );
769 dependencies.sort();
770 assert.deepEqual(
771 dependencies,
772 ['test.module7', 'test.module8', 'test.module9'],
773 'Error callback called with all three modules as dependencies'
774 );
775 }
776 );
777 } );
778
779 QUnit.asyncTest( 'mw.loader dependency handling', 5, function ( assert ) {
780 mw.loader.register( [
781 // [module, version, dependencies, group, source]
782 ['testMissing', '1', [], null, 'testloader'],
783 ['testUsesMissing', '1', ['testMissing'], null, 'testloader'],
784 ['testUsesNestedMissing', '1', ['testUsesMissing'], null, 'testloader']
785 ] );
786
787 function verifyModuleStates() {
788 assert.equal( mw.loader.getState( 'testMissing' ), 'missing', 'Module not known to server must have state "missing"' );
789 assert.equal( mw.loader.getState( 'testUsesMissing' ), 'error', 'Module with missing dependency must have state "error"' );
790 assert.equal( mw.loader.getState( 'testUsesNestedMissing' ), 'error', 'Module with indirect missing dependency must have state "error"' );
791 }
792
793 mw.loader.using( ['testUsesNestedMissing'],
794 function () {
795 assert.ok( false, 'Error handler should be invoked.' );
796 assert.ok( true ); // Dummy to reach QUnit expect()
797
798 verifyModuleStates();
799
800 QUnit.start();
801 },
802 function ( e, badmodules ) {
803 assert.ok( true, 'Error handler should be invoked.' );
804 // As soon as server spits out state('testMissing', 'missing');
805 // it will bubble up and trigger the error callback.
806 // Therefor the badmodules array is not testUsesMissing or testUsesNestedMissing.
807 assert.deepEqual( badmodules, ['testMissing'], 'Bad modules as expected.' );
808
809 verifyModuleStates();
810
811 QUnit.start();
812 }
813 );
814 } );
815
816 QUnit.asyncTest( 'mw.loader skin-function handling', 5, function ( assert ) {
817 mw.loader.register( [
818 // [module, version, dependencies, group, source, skip]
819 ['testSkipped', '1', [], null, 'testloader', 'return true;'],
820 ['testNotSkipped', '1', [], null, 'testloader', 'return false;'],
821 ['testUsesSkippable', '1', ['testSkipped', 'testNotSkipped'], null, 'testloader']
822 ] );
823
824 function verifyModuleStates() {
825 assert.equal( mw.loader.getState( 'testSkipped' ), 'ready', 'Module is ready when skipped' );
826 assert.equal( mw.loader.getState( 'testNotSkipped' ), 'ready', 'Module is ready when not skipped but loaded' );
827 assert.equal( mw.loader.getState( 'testUsesSkippable' ), 'ready', 'Module is ready when skippable dependencies are ready' );
828 }
829
830 mw.loader.using( ['testUsesSkippable'],
831 function () {
832 assert.ok( true, 'Success handler should be invoked.' );
833 assert.ok( true ); // Dummy to match error handler and reach QUnit expect()
834
835 verifyModuleStates();
836
837 QUnit.start();
838 },
839 function ( e, badmodules ) {
840 assert.ok( false, 'Error handler should not be invoked.' );
841 assert.deepEqual( badmodules, [], 'Bad modules as expected.' );
842
843 verifyModuleStates();
844
845 QUnit.start();
846 }
847 );
848 } );
849
850 QUnit.asyncTest( 'mw.loader( "//protocol-relative" ) (bug 30825)', 2, function ( assert ) {
851 // This bug was actually already fixed in 1.18 and later when discovered in 1.17.
852 // Test is for regressions!
853
854 // Forge an URL to the test callback script
855 var target = QUnit.fixurl(
856 mw.config.get( 'wgServer' ) + mw.config.get( 'wgScriptPath' ) + '/tests/qunit/data/qunitOkCall.js'
857 );
858
859 // Confirm that mw.loader.load() works with protocol-relative URLs
860 target = target.replace( /https?:/, '' );
861
862 assert.equal( target.slice( 0, 2 ), '//',
863 'URL must be relative to test relative URLs!'
864 );
865
866 // Async!
867 // The target calls QUnit.start
868 mw.loader.load( target );
869 } );
870
871 QUnit.test( 'mw.html', 13, function ( assert ) {
872 assert.throws( function () {
873 mw.html.escape();
874 }, TypeError, 'html.escape throws a TypeError if argument given is not a string' );
875
876 assert.equal( mw.html.escape( '<mw awesome="awesome" value=\'test\' />' ),
877 '&lt;mw awesome=&quot;awesome&quot; value=&#039;test&#039; /&gt;', 'escape() escapes special characters to html entities' );
878
879 assert.equal( mw.html.element(),
880 '<undefined/>', 'element() always returns a valid html string (even without arguments)' );
881
882 assert.equal( mw.html.element( 'div' ), '<div/>', 'element() Plain DIV (simple)' );
883
884 assert.equal( mw.html.element( 'div', {}, '' ), '<div></div>', 'element() Basic DIV (simple)' );
885
886 assert.equal(
887 mw.html.element(
888 'div', {
889 id: 'foobar'
890 }
891 ),
892 '<div id="foobar"/>',
893 'html.element DIV (attribs)' );
894
895 assert.equal( mw.html.element( 'p', null, 12 ), '<p>12</p>', 'Numbers are valid content and should be casted to a string' );
896
897 assert.equal( mw.html.element( 'p', { title: 12 }, '' ), '<p title="12"></p>', 'Numbers are valid attribute values' );
898
899 // Example from https://www.mediawiki.org/wiki/ResourceLoader/Default_modules#mediaWiki.html
900 assert.equal(
901 mw.html.element(
902 'div',
903 {},
904 new mw.html.Raw(
905 mw.html.element( 'img', { src: '<' } )
906 )
907 ),
908 '<div><img src="&lt;"/></div>',
909 'Raw inclusion of another element'
910 );
911
912 assert.equal(
913 mw.html.element(
914 'option', {
915 selected: true
916 }, 'Foo'
917 ),
918 '<option selected="selected">Foo</option>',
919 'Attributes may have boolean values. True copies the attribute name to the value.'
920 );
921
922 assert.equal(
923 mw.html.element(
924 'option', {
925 value: 'foo',
926 selected: false
927 }, 'Foo'
928 ),
929 '<option value="foo">Foo</option>',
930 'Attributes may have boolean values. False keeps the attribute from output.'
931 );
932
933 assert.equal( mw.html.element( 'div',
934 null, 'a' ),
935 '<div>a</div>',
936 'html.element DIV (content)' );
937
938 assert.equal( mw.html.element( 'a',
939 { href: 'http://mediawiki.org/w/index.php?title=RL&action=history' }, 'a' ),
940 '<a href="http://mediawiki.org/w/index.php?title=RL&amp;action=history">a</a>',
941 'html.element DIV (attribs + content)' );
942
943 } );
944
945 QUnit.test( 'mw.hook', 13, function ( assert ) {
946 var hook, add, fire, chars, callback;
947
948 mw.hook( 'test.hook.unfired' ).add( function () {
949 assert.ok( false, 'Unfired hook' );
950 } );
951
952 mw.hook( 'test.hook.basic' ).add( function () {
953 assert.ok( true, 'Basic callback' );
954 } );
955 mw.hook( 'test.hook.basic' ).fire();
956
957 mw.hook( 'hasOwnProperty' ).add( function () {
958 assert.ok( true, 'hook with name of predefined method' );
959 } );
960 mw.hook( 'hasOwnProperty' ).fire();
961
962 mw.hook( 'test.hook.data' ).add( function ( data1, data2 ) {
963 assert.equal( data1, 'example', 'Fire with data (string param)' );
964 assert.deepEqual( data2, ['two'], 'Fire with data (array param)' );
965 } );
966 mw.hook( 'test.hook.data' ).fire( 'example', ['two'] );
967
968 hook = mw.hook( 'test.hook.chainable' );
969 assert.strictEqual( hook.add(), hook, 'hook.add is chainable' );
970 assert.strictEqual( hook.remove(), hook, 'hook.remove is chainable' );
971 assert.strictEqual( hook.fire(), hook, 'hook.fire is chainable' );
972
973 hook = mw.hook( 'test.hook.detach' );
974 add = hook.add;
975 fire = hook.fire;
976 add( function ( x, y ) {
977 assert.deepEqual( [x, y], ['x', 'y'], 'Detached (contextless) with data' );
978 } );
979 fire( 'x', 'y' );
980
981 mw.hook( 'test.hook.fireBefore' ).fire().add( function () {
982 assert.ok( true, 'Invoke handler right away if it was fired before' );
983 } );
984
985 mw.hook( 'test.hook.fireTwiceBefore' ).fire().fire().add( function () {
986 assert.ok( true, 'Invoke handler right away if it was fired before (only last one)' );
987 } );
988
989 chars = [];
990
991 mw.hook( 'test.hook.many' )
992 .add( function ( chr ) {
993 chars.push( chr );
994 } )
995 .fire( 'x' ).fire( 'y' ).fire( 'z' )
996 .add( function ( chr ) {
997 assert.equal( chr, 'z', 'Adding callback later invokes right away with last data' );
998 } );
999
1000 assert.deepEqual( chars, ['x', 'y', 'z'], 'Multiple callbacks with multiple fires' );
1001
1002 chars = [];
1003 callback = function ( chr ) {
1004 chars.push( chr );
1005 };
1006
1007 mw.hook( 'test.hook.variadic' )
1008 .add(
1009 callback,
1010 callback,
1011 function ( chr ) {
1012 chars.push( chr );
1013 },
1014 callback
1015 )
1016 .fire( 'x' )
1017 .remove(
1018 function () {
1019 'not-added';
1020 },
1021 callback
1022 )
1023 .fire( 'y' )
1024 .remove( callback )
1025 .fire( 'z' );
1026
1027 assert.deepEqual(
1028 chars,
1029 ['x', 'x', 'x', 'x', 'y', 'z'],
1030 '"add" and "remove" support variadic arguments. ' +
1031 '"add" does not filter unique. ' +
1032 '"remove" removes all equal by reference. ' +
1033 '"remove" is silent if the function is not found'
1034 );
1035 } );
1036
1037 }( mediaWiki, jQuery ) );