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