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