Make /*jshint -W024*/ global to allow 'static' as property
[lhc/web/wiklou.git] / tests / qunit / suites / resources / mediawiki / mediawiki.test.js
1 ( function ( mw ) {
2 var specialCharactersPageName,
3 // Can't mock SITENAME since jqueryMsg caches it at load
4 siteName = mw.config.get( 'wgSiteName' );
5
6 // Since QUnitTestResources.php loads both mediawiki and mediawiki.jqueryMsg as
7 // dependencies, this only tests the monkey-patched behavior with the two of them combined.
8
9 // See mediawiki.jqueryMsg.test.js for unit tests for jqueryMsg-specific functionality.
10
11 QUnit.module( 'mediawiki', QUnit.newMwEnvironment( {
12 setup: function () {
13 specialCharactersPageName = '"Who" wants to be a millionaire & live on \'Exotic Island\'?';
14 },
15 config: {
16 wgArticlePath: '/wiki/$1',
17
18 // For formatnum tests
19 wgUserLanguage: 'en'
20 },
21 // Messages used in multiple tests
22 messages: {
23 'other-message': 'Other Message',
24 'mediawiki-test-pagetriage-del-talk-page-notify-summary': 'Notifying author of deletion nomination for [[$1]]',
25 'gender-plural-msg': '{{GENDER:$1|he|she|they}} {{PLURAL:$2|is|are}} awesome',
26 'grammar-msg': 'Przeszukaj {{GRAMMAR:grammar_case_foo|{{SITENAME}}}}',
27 'formatnum-msg': '{{formatnum:$1}}',
28 'int-msg': 'Some {{int:other-message}}',
29 'mediawiki-test-version-entrypoints-index-php': '[https://www.mediawiki.org/wiki/Manual:index.php index.php]',
30 'external-link-replace': 'Foo [$1 bar]'
31 }
32 } ) );
33
34 QUnit.test( 'Initial check', 8, function ( assert ) {
35 assert.ok( window.jQuery, 'jQuery defined' );
36 assert.ok( window.$, '$ defined' );
37 assert.strictEqual( window.$, window.jQuery, '$ alias to jQuery' );
38
39 this.suppressWarnings();
40 assert.ok( window.$j, '$j defined' );
41 assert.strictEqual( window.$j, window.jQuery, '$j alias to jQuery' );
42 this.restoreWarnings();
43
44 // window.mw and window.mediaWiki are not deprecated, but for some reason
45 // PhantomJS is triggerring the accessors on all mw.* properties in this test,
46 // and with that lots of unrelated deprecation notices.
47 this.suppressWarnings();
48 assert.ok( window.mediaWiki, 'mediaWiki defined' );
49 assert.ok( window.mw, 'mw defined' );
50 assert.strictEqual( window.mw, window.mediaWiki, 'mw alias to mediaWiki' );
51 this.restoreWarnings();
52 } );
53
54 QUnit.test( 'mw.format', 2, function ( assert ) {
55 assert.equal(
56 mw.format( 'Format $1 $2', 'foo', 'bar' ),
57 'Format foo bar',
58 'Simple parameters'
59 );
60 assert.equal(
61 mw.format( 'Format $1 $2' ),
62 'Format $1 $2',
63 'Missing parameters'
64 );
65 } );
66
67 QUnit.test( 'mw.Map', function ( assert ) {
68 var arry, conf, funky, globalConf, nummy, someValues;
69
70 conf = new mw.Map();
71
72 // Dummy variables
73 funky = function () {};
74 arry = [];
75 nummy = 7;
76
77 // Single get and set
78
79 assert.strictEqual( conf.set( 'foo', 'Bar' ), true, 'Map.set returns boolean true if a value was set for a valid key string' );
80 assert.equal( conf.get( 'foo' ), 'Bar', 'Map.get returns a single value value correctly' );
81
82 assert.strictEqual( conf.get( 'example' ), null, 'Map.get returns null if selection was a string and the key was not found' );
83 assert.strictEqual( conf.get( 'example', arry ), arry, 'Map.get returns fallback by reference if the key was not found' );
84 assert.strictEqual( conf.get( 'example', undefined ), undefined, 'Map.get supports `undefined` as fallback instead of `null`' );
85
86 assert.strictEqual( conf.get( 'constructor' ), null, 'Map.get does not look at Object.prototype of internal storage (constructor)' );
87 assert.strictEqual( conf.get( 'hasOwnProperty' ), null, 'Map.get does not look at Object.prototype of internal storage (hasOwnProperty)' );
88
89 conf.set( 'hasOwnProperty', function () { return true; } );
90 assert.strictEqual( conf.get( 'example', 'missing' ), 'missing', 'Map.get uses neutral hasOwnProperty method (positive)' );
91
92 conf.set( 'example', 'Foo' );
93 conf.set( 'hasOwnProperty', function () { return false; } );
94 assert.strictEqual( conf.get( 'example' ), 'Foo', 'Map.get uses neutral hasOwnProperty method (negative)' );
95
96 assert.strictEqual( conf.set( 'constructor', 42 ), true, 'Map.set for key "constructor"' );
97 assert.strictEqual( conf.get( 'constructor' ), 42, 'Map.get for key "constructor"' );
98
99 assert.strictEqual( conf.set( 'undef' ), false, 'Map.set requires explicit value (no undefined default)' );
100
101 assert.strictEqual( conf.set( 'undef', undefined ), true, 'Map.set allows setting value to `undefined`' );
102 assert.equal( conf.get( 'undef', 'fallback' ), undefined, 'Map.get supports retreiving value of `undefined`' );
103
104 assert.strictEqual( conf.set( funky, 'Funky' ), false, 'Map.set returns boolean false if key was invalid (Function)' );
105 assert.strictEqual( conf.set( arry, 'Arry' ), false, 'Map.set returns boolean false if key was invalid (Array)' );
106 assert.strictEqual( conf.set( nummy, 'Nummy' ), false, 'Map.set returns boolean false if key was invalid (Number)' );
107
108 assert.strictEqual( conf.get( funky ), null, 'Map.get ruturns null if selection was invalid (Function)' );
109 assert.strictEqual( conf.get( nummy ), null, 'Map.get ruturns null if selection was invalid (Number)' );
110
111 conf.set( String( nummy ), 'I used to be a number' );
112
113 assert.strictEqual( conf.exists( 'doesNotExist' ), false, 'Map.exists where property does not exist' );
114 assert.strictEqual( conf.exists( 'undef' ), true, 'Map.exists where value is `undefined`' );
115 assert.strictEqual( conf.exists( nummy ), false, 'Map.exists where key is invalid but looks like an existing key' );
116
117 // Multiple values at once
118 someValues = {
119 foo: 'bar',
120 lorem: 'ipsum',
121 MediaWiki: true
122 };
123 assert.strictEqual( conf.set( someValues ), true, 'Map.set returns boolean true if multiple values were set by passing an object' );
124 assert.deepEqual( conf.get( [ 'foo', 'lorem' ] ), {
125 foo: 'bar',
126 lorem: 'ipsum'
127 }, 'Map.get returns multiple values correctly as an object' );
128
129 assert.deepEqual( conf.get( [ 'foo', 'notExist' ] ), {
130 foo: 'bar',
131 notExist: null
132 }, 'Map.get return includes keys that were not found as null values' );
133
134 // Interacting with globals and accessing the values object
135 this.suppressWarnings();
136 assert.strictEqual( conf.get(), conf.values, 'Map.get returns the entire values object by reference (if called without arguments)' );
137 this.restoreWarnings();
138
139 conf.set( 'globalMapChecker', 'Hi' );
140
141 assert.ok( ( 'globalMapChecker' in window ) === false, 'Map does not its store values in the window object by default' );
142
143 globalConf = new mw.Map( true );
144 globalConf.set( 'anotherGlobalMapChecker', 'Hello' );
145
146 assert.ok( 'anotherGlobalMapChecker' in window, 'global Map stores its values in the window object' );
147
148 assert.equal( globalConf.get( 'anotherGlobalMapChecker' ), 'Hello', 'get value from global Map via get()' );
149 this.suppressWarnings();
150 assert.equal( window.anotherGlobalMapChecker, 'Hello', 'get value from global Map via window object' );
151 this.restoreWarnings();
152
153 // Change value via global Map
154 globalConf.set( 'anotherGlobalMapChecker', 'Again' );
155 assert.equal( globalConf.get( 'anotherGlobalMapChecker' ), 'Again', 'Change in global Map reflected via get()' );
156 this.suppressWarnings();
157 assert.equal( window.anotherGlobalMapChecker, 'Again', 'Change in global Map reflected window object' );
158 this.restoreWarnings();
159
160 // Change value via window object
161 this.suppressWarnings();
162 window.anotherGlobalMapChecker = 'World';
163 assert.equal( window.anotherGlobalMapChecker, 'World', 'Change in window object works' );
164 this.restoreWarnings();
165 assert.equal( globalConf.get( 'anotherGlobalMapChecker' ), 'Again', 'Change in window object not reflected in global Map' );
166
167 // Whitelist this global variable for QUnit's 'noglobal' mode
168 if ( QUnit.config.noglobals ) {
169 QUnit.config.pollution.push( 'anotherGlobalMapChecker' );
170 }
171 } );
172
173 QUnit.test( 'mw.message & mw.messages', function ( assert ) {
174 var goodbye, hello;
175
176 // Convenience method for asserting the same result for multiple formats
177 function assertMultipleFormats( messageArguments, formats, expectedResult, assertMessage ) {
178 var format, i,
179 len = formats.length;
180
181 for ( i = 0; i < len; i++ ) {
182 format = formats[ i ];
183 assert.equal( mw.message.apply( null, messageArguments )[ format ](), expectedResult, assertMessage + ' when format is ' + format );
184 }
185 }
186
187 assert.ok( mw.messages, 'messages defined' );
188 assert.ok( mw.messages.set( 'hello', 'Hello <b>awesome</b> world' ), 'mw.messages.set: Register' );
189
190 hello = mw.message( 'hello' );
191
192 // https://phabricator.wikimedia.org/T46459
193 assert.equal( hello.format, 'text', 'Message property "format" defaults to "text"' );
194
195 assert.strictEqual( hello.map, mw.messages, 'Message property "map" defaults to the global instance in mw.messages' );
196 assert.equal( hello.key, 'hello', 'Message property "key" (currect key)' );
197 assert.deepEqual( hello.parameters, [], 'Message property "parameters" defaults to an empty array' );
198
199 // TODO
200 assert.ok( hello.params, 'Message prototype "params"' );
201
202 hello.format = 'plain';
203 assert.equal( hello.toString(), 'Hello <b>awesome</b> world', 'Message.toString returns the message as a string with the current "format"' );
204
205 assert.equal( hello.escaped(), 'Hello &lt;b&gt;awesome&lt;/b&gt; world', 'Message.escaped returns the escaped message' );
206 assert.equal( hello.format, 'escaped', 'Message.escaped correctly updated the "format" property' );
207
208 assert.ok( mw.messages.set( 'multiple-curly-brace', '"{{SITENAME}}" is the home of {{int:other-message}}' ), 'mw.messages.set: Register' );
209 assertMultipleFormats( [ 'multiple-curly-brace' ], [ 'text', 'parse' ], '"' + siteName + '" is the home of Other Message', 'Curly brace format works correctly' );
210 assert.equal( mw.message( 'multiple-curly-brace' ).plain(), mw.messages.get( 'multiple-curly-brace' ), 'Plain format works correctly for curly brace message' );
211 assert.equal( mw.message( 'multiple-curly-brace' ).escaped(), mw.html.escape( '"' + siteName + '" is the home of Other Message' ), 'Escaped format works correctly for curly brace message' );
212
213 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' );
214 assertMultipleFormats( [ 'multiple-square-brackets-and-ampersand' ], [ 'plain', 'text' ], mw.messages.get( 'multiple-square-brackets-and-ampersand' ), 'Square bracket message is not processed' );
215 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' );
216 assert.htmlEqual( mw.message( 'multiple-square-brackets-and-ampersand' ).parse(), 'Visit the ' +
217 '<a title="Project:Community portal" href="/wiki/Project:Community_portal">community portal</a>' +
218 ' &amp; <a title="Project:Help desk" href="/wiki/Project:Help_desk">help desk</a>', 'Internal links work with parse' );
219
220 assertMultipleFormats( [ 'mediawiki-test-version-entrypoints-index-php' ], [ 'plain', 'text', 'escaped' ], mw.messages.get( 'mediawiki-test-version-entrypoints-index-php' ), 'External link markup is unprocessed' );
221 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' );
222
223 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' );
224 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' );
225 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' );
226
227 hello.parse();
228 assert.equal( hello.format, 'parse', 'Message.parse correctly updated the "format" property' );
229
230 hello.plain();
231 assert.equal( hello.format, 'plain', 'Message.plain correctly updated the "format" property' );
232
233 hello.text();
234 assert.equal( hello.format, 'text', 'Message.text correctly updated the "format" property' );
235
236 assert.strictEqual( hello.exists(), true, 'Message.exists returns true for existing messages' );
237
238 goodbye = mw.message( 'goodbye' );
239 assert.strictEqual( goodbye.exists(), false, 'Message.exists returns false for nonexistent messages' );
240
241 assertMultipleFormats( [ 'good<>bye' ], [ 'plain', 'text', 'parse', 'escaped' ], '⧼good&lt;&gt;bye⧽', 'Message.toString returns ⧼key⧽ if key does not exist' );
242
243 assert.ok( mw.messages.set( 'plural-test-msg', 'There {{PLURAL:$1|is|are}} $1 {{PLURAL:$1|result|results}}' ), 'mw.messages.set: Register' );
244 assertMultipleFormats( [ 'plural-test-msg', 6 ], [ 'text', 'parse', 'escaped' ], 'There are 6 results', 'plural get resolved' );
245 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' );
246
247 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' );
248 assertMultipleFormats( [ 'plural-test-msg-explicit', 12 ], [ 'text', 'parse', 'escaped' ], 'There are a dozen cars', 'explicit plural get resolved' );
249
250 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' );
251 assertMultipleFormats( [ 'plural-test-msg-explicit-beginning', 1 ], [ 'text', 'parse', 'escaped' ], 'Basket has one egg', 'explicit plural given at beginning get resolved for singular' );
252 assertMultipleFormats( [ 'plural-test-msg-explicit-beginning', 4 ], [ 'text', 'parse', 'escaped' ], 'Basket has 4 eggs', 'explicit plural given at beginning get resolved for plural' );
253 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' );
254 assertMultipleFormats( [ 'plural-test-msg-explicit-beginning', 0 ], [ 'text', 'parse', 'escaped' ], 'Basket has no eggs', 'explicit plural given at beginning get resolved for 0' );
255
256 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' );
257
258 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' );
259
260 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' );
261
262 assert.ok( mw.messages.set( 'mediawiki-test-categorytree-collapse-bullet', '[<b>−</b>]' ), 'mw.messages.set: Register' );
263 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' );
264
265 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' );
266 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' );
267
268 assertMultipleFormats( [ 'gender-plural-msg', 'male', 1 ], [ 'text', 'parse', 'escaped' ], 'he is awesome', 'Gender and plural are resolved' );
269 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' );
270
271 assert.equal( mw.message( 'grammar-msg' ).plain(), mw.messages.get( 'grammar-msg' ), 'Grammar is not resolved in plain mode' );
272 assertMultipleFormats( [ 'grammar-msg' ], [ 'text', 'parse' ], 'Przeszukaj ' + siteName, 'Grammar is resolved' );
273 assert.equal( mw.message( 'grammar-msg' ).escaped(), 'Przeszukaj ' + siteName, 'Grammar is resolved in escaped mode' );
274
275 assertMultipleFormats( [ 'formatnum-msg', '987654321.654321' ], [ 'text', 'parse', 'escaped' ], '987,654,321.654', 'formatnum is resolved' );
276 assert.equal( mw.message( 'formatnum-msg' ).plain(), mw.messages.get( 'formatnum-msg' ), 'formatnum is not resolved in plain mode' );
277
278 assertMultipleFormats( [ 'int-msg' ], [ 'text', 'parse', 'escaped' ], 'Some Other Message', 'int is resolved' );
279 assert.equal( mw.message( 'int-msg' ).plain(), mw.messages.get( 'int-msg' ), 'int is not resolved in plain mode' );
280
281 assert.ok( mw.messages.set( 'mediawiki-italics-msg', '<i>Very</i> important' ), 'mw.messages.set: Register' );
282 assertMultipleFormats( [ 'mediawiki-italics-msg' ], [ 'plain', 'text', 'parse' ], mw.messages.get( 'mediawiki-italics-msg' ), 'Simple italics unchanged' );
283 assert.htmlEqual(
284 mw.message( 'mediawiki-italics-msg' ).escaped(),
285 '&lt;i&gt;Very&lt;/i&gt; important',
286 'Italics are escaped in escaped mode'
287 );
288
289 assert.ok( mw.messages.set( 'mediawiki-italics-with-link', 'An <i>italicized [[link|wiki-link]]</i>' ), 'mw.messages.set: Register' );
290 assertMultipleFormats( [ 'mediawiki-italics-with-link' ], [ 'plain', 'text' ], mw.messages.get( 'mediawiki-italics-with-link' ), 'Italics with link unchanged' );
291 assert.htmlEqual(
292 mw.message( 'mediawiki-italics-with-link' ).escaped(),
293 'An &lt;i&gt;italicized [[link|wiki-link]]&lt;/i&gt;',
294 'Italics and link unchanged except for escaping in escaped mode'
295 );
296 assert.htmlEqual(
297 mw.message( 'mediawiki-italics-with-link' ).parse(),
298 'An <i>italicized <a title="link" href="' + mw.util.getUrl( 'link' ) + '">wiki-link</i>',
299 'Italics with link inside in parse mode'
300 );
301
302 assert.ok( mw.messages.set( 'mediawiki-script-msg', '<script >alert( "Who put this script here?" );</script>' ), 'mw.messages.set: Register' );
303 assertMultipleFormats( [ 'mediawiki-script-msg' ], [ 'plain', 'text' ], mw.messages.get( 'mediawiki-script-msg' ), 'Script unchanged' );
304 assert.htmlEqual(
305 mw.message( 'mediawiki-script-msg' ).escaped(),
306 '&lt;script &gt;alert( "Who put this script here?" );&lt;/script&gt;',
307 'Script escaped when using escaped format'
308 );
309 assert.htmlEqual(
310 mw.message( 'mediawiki-script-msg' ).parse(),
311 '&lt;script &gt;alert( "Who put this script here?" );&lt;/script&gt;',
312 'Script escaped when using parse format'
313 );
314
315 } );
316
317 QUnit.test( 'mw.msg', 14, function ( assert ) {
318 assert.ok( mw.messages.set( 'hello', 'Hello <b>awesome</b> world' ), 'mw.messages.set: Register' );
319 assert.equal( mw.msg( 'hello' ), 'Hello <b>awesome</b> world', 'Gets message with default options (existing message)' );
320 assert.equal( mw.msg( 'goodbye' ), '⧼goodbye⧽', 'Gets message with default options (nonexistent message)' );
321
322 assert.ok( mw.messages.set( 'plural-item', 'Found $1 {{PLURAL:$1|item|items}}' ), 'mw.messages.set: Register' );
323 assert.equal( mw.msg( 'plural-item', 5 ), 'Found 5 items', 'Apply plural for count 5' );
324 assert.equal( mw.msg( 'plural-item', 0 ), 'Found 0 items', 'Apply plural for count 0' );
325 assert.equal( mw.msg( 'plural-item', 1 ), 'Found 1 item', 'Apply plural for count 1' );
326
327 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' );
328
329 assert.equal( mw.msg( 'gender-plural-msg', 'male', 1 ), 'he is awesome', 'Gender test for male, plural count 1' );
330 assert.equal( mw.msg( 'gender-plural-msg', 'female', '1' ), 'she is awesome', 'Gender test for female, plural count 1' );
331 assert.equal( mw.msg( 'gender-plural-msg', 'unknown', 10 ), 'they are awesome', 'Gender test for neutral, plural count 10' );
332
333 assert.equal( mw.msg( 'grammar-msg' ), 'Przeszukaj ' + siteName, 'Grammar is resolved' );
334
335 assert.equal( mw.msg( 'formatnum-msg', '987654321.654321' ), '987,654,321.654', 'formatnum is resolved' );
336
337 assert.equal( mw.msg( 'int-msg' ), 'Some Other Message', 'int is resolved' );
338 } );
339
340 QUnit.test( 'mw.hook', 13, function ( assert ) {
341 var hook, add, fire, chars, callback;
342
343 mw.hook( 'test.hook.unfired' ).add( function () {
344 assert.ok( false, 'Unfired hook' );
345 } );
346
347 mw.hook( 'test.hook.basic' ).add( function () {
348 assert.ok( true, 'Basic callback' );
349 } );
350 mw.hook( 'test.hook.basic' ).fire();
351
352 mw.hook( 'hasOwnProperty' ).add( function () {
353 assert.ok( true, 'hook with name of predefined method' );
354 } );
355 mw.hook( 'hasOwnProperty' ).fire();
356
357 mw.hook( 'test.hook.data' ).add( function ( data1, data2 ) {
358 assert.equal( data1, 'example', 'Fire with data (string param)' );
359 assert.deepEqual( data2, [ 'two' ], 'Fire with data (array param)' );
360 } );
361 mw.hook( 'test.hook.data' ).fire( 'example', [ 'two' ] );
362
363 hook = mw.hook( 'test.hook.chainable' );
364 assert.strictEqual( hook.add(), hook, 'hook.add is chainable' );
365 assert.strictEqual( hook.remove(), hook, 'hook.remove is chainable' );
366 assert.strictEqual( hook.fire(), hook, 'hook.fire is chainable' );
367
368 hook = mw.hook( 'test.hook.detach' );
369 add = hook.add;
370 fire = hook.fire;
371 add( function ( x, y ) {
372 assert.deepEqual( [ x, y ], [ 'x', 'y' ], 'Detached (contextless) with data' );
373 } );
374 fire( 'x', 'y' );
375
376 mw.hook( 'test.hook.fireBefore' ).fire().add( function () {
377 assert.ok( true, 'Invoke handler right away if it was fired before' );
378 } );
379
380 mw.hook( 'test.hook.fireTwiceBefore' ).fire().fire().add( function () {
381 assert.ok( true, 'Invoke handler right away if it was fired before (only last one)' );
382 } );
383
384 chars = [];
385
386 mw.hook( 'test.hook.many' )
387 .add( function ( chr ) {
388 chars.push( chr );
389 } )
390 .fire( 'x' ).fire( 'y' ).fire( 'z' )
391 .add( function ( chr ) {
392 assert.equal( chr, 'z', 'Adding callback later invokes right away with last data' );
393 } );
394
395 assert.deepEqual( chars, [ 'x', 'y', 'z' ], 'Multiple callbacks with multiple fires' );
396
397 chars = [];
398 callback = function ( chr ) {
399 chars.push( chr );
400 };
401
402 mw.hook( 'test.hook.variadic' )
403 .add(
404 callback,
405 callback,
406 function ( chr ) {
407 chars.push( chr );
408 },
409 callback
410 )
411 .fire( 'x' )
412 .remove(
413 function () {
414 'not-added';
415 },
416 callback
417 )
418 .fire( 'y' )
419 .remove( callback )
420 .fire( 'z' );
421
422 assert.deepEqual(
423 chars,
424 [ 'x', 'x', 'x', 'x', 'y', 'z' ],
425 '"add" and "remove" support variadic arguments. ' +
426 '"add" does not filter unique. ' +
427 '"remove" removes all equal by reference. ' +
428 '"remove" is silent if the function is not found'
429 );
430 } );
431
432 }( mediaWiki ) );