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