Add method parameter type documentation
[lhc/web/wiklou.git] / tests / qunit / suites / resources / mediawiki / mediawiki.util.test.js
1 ( function ( mw, $ ) {
2 QUnit.module( 'mediawiki.util', QUnit.newMwEnvironment( {
3 setup: function () {
4 this.taPrefix = mw.util.tooltipAccessKeyPrefix;
5 mw.util.tooltipAccessKeyPrefix = 'ctrl-alt-';
6 },
7 teardown: function () {
8 mw.util.tooltipAccessKeyPrefix = this.taPrefix;
9 }
10 } ) );
11
12 QUnit.test( 'rawurlencode', 1, function ( assert ) {
13 assert.equal( mw.util.rawurlencode( 'Test:A & B/Here' ), 'Test%3AA%20%26%20B%2FHere' );
14 } );
15
16 QUnit.test( 'wikiUrlencode', 1, function ( assert ) {
17 assert.equal( mw.util.wikiUrlencode( 'Test:A & B/Here' ), 'Test:A_%26_B/Here' );
18 } );
19
20 QUnit.test( 'wikiGetlink', 3, function ( assert ) {
21 // Not part of startUp module
22 mw.config.set( 'wgArticlePath', '/wiki/$1' );
23 mw.config.set( 'wgPageName', 'Foobar' );
24
25 var href = mw.util.wikiGetlink( 'Sandbox' );
26 assert.equal( href, '/wiki/Sandbox', 'Simple title; Get link for "Sandbox"' );
27
28 href = mw.util.wikiGetlink( 'Foo:Sandbox ? 5+5=10 ! (test)/subpage' );
29 assert.equal( href, '/wiki/Foo:Sandbox_%3F_5%2B5%3D10_%21_%28test%29/subpage',
30 'Advanced title; Get link for "Foo:Sandbox ? 5+5=10 ! (test)/subpage"' );
31
32 href = mw.util.wikiGetlink();
33 assert.equal( href, '/wiki/Foobar', 'Default title; Get link for current page ("Foobar")' );
34 } );
35
36 QUnit.test( 'wikiScript', 4, function ( assert ) {
37 mw.config.set( {
38 'wgScript': '/w/i.php', // customized wgScript for bug 39103
39 'wgLoadScript': '/w/l.php', // customized wgLoadScript for bug 39103
40 'wgScriptPath': '/w',
41 'wgScriptExtension': '.php'
42 } );
43
44 assert.equal( mw.util.wikiScript(), mw.config.get( 'wgScript' ),
45 'wikiScript() returns wgScript'
46 );
47 assert.equal( mw.util.wikiScript( 'index' ), mw.config.get( 'wgScript' ),
48 'wikiScript( index ) returns wgScript'
49 );
50 assert.equal( mw.util.wikiScript( 'load' ), mw.config.get( 'wgLoadScript' ),
51 'wikiScript( load ) returns wgLoadScript'
52 );
53 assert.equal( mw.util.wikiScript( 'api' ), '/w/api.php', 'API path' );
54 } );
55
56 QUnit.test( 'addCSS', 3, function ( assert ) {
57 var $el, style;
58 $el = $( '<div>' ).attr( 'id', 'mw-addcsstest' ).appendTo( '#qunit-fixture' );
59
60 style = mw.util.addCSS( '#mw-addcsstest { visibility: hidden; }' );
61 assert.equal( typeof style, 'object', 'addCSS returned an object' );
62 assert.strictEqual( style.disabled, false, 'property "disabled" is available and set to false' );
63
64 assert.equal( $el.css( 'visibility' ), 'hidden', 'Added style properties are in effect' );
65
66 // Clean up
67 $( style.ownerNode ).remove();
68 } );
69
70 QUnit.asyncTest( 'toggleToc', 4, function ( assert ) {
71 var tocHtml, $toggleLink;
72
73 function actionC() {
74 QUnit.start();
75 }
76
77 function actionB() {
78 assert.strictEqual( mw.util.toggleToc( $toggleLink, actionC ), true, 'Return boolean true if the TOC is now visible.' );
79 }
80
81 function actionA() {
82 assert.strictEqual( mw.util.toggleToc( $toggleLink, actionB ), false, 'Return boolean false if the TOC is now hidden.' );
83 }
84
85 assert.strictEqual( mw.util.toggleToc(), null, 'Return null if there is no table of contents on the page.' );
86
87 tocHtml = '<div id="toc" class="toc">' +
88 '<div id="toctitle">' +
89 '<h2>Contents</h2>' +
90 '<span class="toctoggle">&nbsp;[<a href="#" class="internal" id="togglelink">Hide</a>&nbsp;]</span>' +
91 '</div>' +
92 '<ul><li></li></ul>' +
93 '</div>';
94 $( tocHtml ).appendTo( '#qunit-fixture' ),
95 $toggleLink = $( '#togglelink' );
96
97 assert.strictEqual( $toggleLink.length, 1, 'Toggle link is appended to the page.' );
98
99 actionA();
100 } );
101
102 QUnit.test( 'getParamValue', 5, function ( assert ) {
103 var url;
104
105 url = 'http://example.org/?foo=wrong&foo=right#&foo=bad';
106 assert.equal( mw.util.getParamValue( 'foo', url ), 'right', 'Use latest one, ignore hash' );
107 assert.strictEqual( mw.util.getParamValue( 'bar', url ), null, 'Return null when not found' );
108
109 url = 'http://example.org/#&foo=bad';
110 assert.strictEqual( mw.util.getParamValue( 'foo', url ), null, 'Ignore hash if param is not in querystring but in hash (bug 27427)' );
111
112 url = 'example.org?' + $.param( { 'TEST': 'a b+c' } );
113 assert.strictEqual( mw.util.getParamValue( 'TEST', url ), 'a b+c', 'Bug 30441: getParamValue must understand "+" encoding of space' );
114
115 url = 'example.org?' + $.param( { 'TEST': 'a b+c d' } ); // check for sloppy code from r95332 :)
116 assert.strictEqual( mw.util.getParamValue( 'TEST', url ), 'a b+c d', 'Bug 30441: getParamValue must understand "+" encoding of space (multiple spaces)' );
117 } );
118
119 QUnit.test( 'tooltipAccessKey', 4, function ( assert ) {
120 assert.equal( typeof mw.util.tooltipAccessKeyPrefix, 'string', 'tooltipAccessKeyPrefix must be a string' );
121 assert.equal( $.type( mw.util.tooltipAccessKeyRegexp ), 'regexp', 'tooltipAccessKeyRegexp is a regexp' );
122 assert.ok( mw.util.updateTooltipAccessKeys, 'updateTooltipAccessKeys is non-empty' );
123
124 'Example [a]'.replace( mw.util.tooltipAccessKeyRegexp, function ( sub, m1, m2, m3, m4, m5, m6 ) {
125 assert.equal( m6, 'a', 'tooltipAccessKeyRegexp finds the accesskey hint' );
126 } );
127 } );
128
129 QUnit.test( '$content', 2, function ( assert ) {
130 assert.ok( mw.util.$content instanceof jQuery, 'mw.util.$content instance of jQuery' );
131 assert.strictEqual( mw.util.$content.length, 1, 'mw.util.$content must have length of 1' );
132 } );
133
134 /**
135 * Portlet names are prefixed with 'p-test' to avoid conflict with core
136 * when running the test suite under a wiki page.
137 * Previously, test elements where invisible to the selector since only
138 * one element can have a given id.
139 */
140 QUnit.test( 'addPortletLink', 11, function ( assert ) {
141 var pTestTb, pCustom, vectorTabs, tbRL, cuQuux, $cuQuux, tbMW, $tbMW, tbRLDM, caFoo, addedAfter;
142
143 pTestTb = '\
144 <div class="portlet" id="p-test-tb">\
145 <h3>Toolbox</h3>\
146 <ul class="body"></ul>\
147 </div>';
148 pCustom = '\
149 <div class="portlet" id="p-test-custom">\
150 <h3>Views</h3>\
151 <ul class="body">\
152 <li id="c-foo"><a href="#">Foo</a></li>\
153 <li id="c-barmenu">\
154 <ul>\
155 <li id="c-bar-baz"><a href="#">Baz</a></a>\
156 </ul>\
157 </li>\
158 </ul>\
159 </div>';
160 vectorTabs = '\
161 <div id="p-test-views" class="vectorTabs">\
162 <h3>Views</h3>\
163 <ul></ul>\
164 </div>';
165
166 $( '#qunit-fixture' ).append( pTestTb, pCustom, vectorTabs );
167
168 tbRL = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/ResourceLoader',
169 'ResourceLoader', 't-rl', 'More info about ResourceLoader on MediaWiki.org ', 'l'
170 );
171
172 assert.ok( $.isDomElement( tbRL ), 'addPortletLink returns a valid DOM Element according to $.isDomElement' );
173
174 tbMW = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/',
175 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', tbRL );
176 $tbMW = $( tbMW );
177
178 assert.propEqual(
179 $tbMW.getAttrs(),
180 {
181 id: 't-mworg'
182 },
183 'Validate attributes of created element'
184 );
185
186 assert.propEqual(
187 $tbMW.find( 'a' ).getAttrs(),
188 {
189 href: '//mediawiki.org/',
190 title: 'Go to MediaWiki.org [ctrl-alt-m]',
191 accesskey: 'm'
192 },
193 'Validate attributes of anchor tag in created element'
194 );
195
196 assert.equal( $tbMW.closest( '.portlet' ).attr( 'id' ), 'p-test-tb', 'Link was inserted within correct portlet' );
197 assert.strictEqual( $tbMW.next()[0], tbRL, 'Link is in the correct position (by passing nextnode)' );
198
199 cuQuux = mw.util.addPortletLink( 'p-test-custom', '#', 'Quux', null, 'Example [shift-x]', 'q' );
200 $cuQuux = $( cuQuux );
201
202 assert.equal( $cuQuux.find( 'a' ).attr( 'title' ), 'Example [ctrl-alt-q]', 'Existing accesskey is stripped and updated' );
203
204 assert.equal(
205 $( '#p-test-custom #c-barmenu ul li' ).length,
206 1,
207 'addPortletLink did not add the item to all <ul> elements in the portlet (bug 35082)'
208 );
209
210 tbRLDM = mw.util.addPortletLink( 'p-test-tb', '//mediawiki.org/wiki/RL/DM',
211 'Default modules', 't-rldm', 'List of all default modules ', 'd', '#t-rl' );
212
213 assert.equal( $( tbRLDM ).next().attr( 'id' ), 't-rl', 'Link is in the correct position (by passing CSS selector)' );
214
215 caFoo = mw.util.addPortletLink( 'p-test-views', '#', 'Foo' );
216
217 assert.strictEqual( $tbMW.find( 'span' ).length, 0, 'No <span> element should be added for porlets without vectorTabs class.' );
218 assert.strictEqual( $( caFoo ).find( 'span' ).length, 1, 'A <span> element should be added for porlets with vectorTabs class.' );
219
220 addedAfter = mw.util.addPortletLink( 'p-test-tb', '#', 'After foo', 'post-foo', 'After foo', null, $( tbRL ) );
221 assert.strictEqual( $( addedAfter ).next()[0], tbRL, 'Link is in the correct position (by passing a jQuery object as nextnode)' );
222 } );
223
224 QUnit.test( 'jsMessage', 1, function ( assert ) {
225 var a = mw.util.jsMessage( 'MediaWiki is <b>Awesome</b>.' );
226 assert.ok( a, 'Basic checking of return value' );
227
228 // Clean up
229 $( '#mw-js-message' ).remove();
230 } );
231
232 QUnit.test( 'validateEmail', 6, function ( assert ) {
233 assert.strictEqual( mw.util.validateEmail( '' ), null, 'Should return null for empty string ' );
234 assert.strictEqual( mw.util.validateEmail( 'user@localhost' ), true, 'Return true for a valid e-mail address' );
235
236 // testEmailWithCommasAreInvalids
237 assert.strictEqual( mw.util.validateEmail( 'user,foo@example.org' ), false, 'Emails with commas are invalid' );
238 assert.strictEqual( mw.util.validateEmail( 'userfoo@ex,ample.org' ), false, 'Emails with commas are invalid' );
239
240 // testEmailWithHyphens
241 assert.strictEqual( mw.util.validateEmail( 'user-foo@example.org' ), true, 'Emails may contain a hyphen' );
242 assert.strictEqual( mw.util.validateEmail( 'userfoo@ex-ample.org' ), true, 'Emails may contain a hyphen' );
243 } );
244
245 QUnit.test( 'isIPv6Address', 40, function ( assert ) {
246 // Shortcuts
247 function assertFalseIPv6( addy, summary ) {
248 return assert.strictEqual( mw.util.isIPv6Address( addy ), false, summary );
249 }
250
251 function assertTrueIPv6( addy, summary ) {
252 return assert.strictEqual( mw.util.isIPv6Address( addy ), true, summary );
253 }
254
255 // Based on IPTest.php > testisIPv6
256 assertFalseIPv6( ':fc:100::', 'IPv6 starting with lone ":"' );
257 assertFalseIPv6( 'fc:100:::', 'IPv6 ending with a ":::"' );
258 assertFalseIPv6( 'fc:300', 'IPv6 with only 2 words' );
259 assertFalseIPv6( 'fc:100:300', 'IPv6 with only 3 words' );
260
261 $.each(
262 ['fc:100::',
263 'fc:100:a::',
264 'fc:100:a:d::',
265 'fc:100:a:d:1::',
266 'fc:100:a:d:1:e::',
267 'fc:100:a:d:1:e:ac::'], function ( i, addy ) {
268 assertTrueIPv6( addy, addy + ' is a valid IP' );
269 } );
270
271 assertFalseIPv6( 'fc:100:a:d:1:e:ac:0::', 'IPv6 with 8 words ending with "::"' );
272 assertFalseIPv6( 'fc:100:a:d:1:e:ac:0:1::', 'IPv6 with 9 words ending with "::"' );
273
274 assertFalseIPv6( ':::' );
275 assertFalseIPv6( '::0:', 'IPv6 ending in a lone ":"' );
276
277 assertTrueIPv6( '::', 'IPv6 zero address' );
278 $.each(
279 ['::0',
280 '::fc',
281 '::fc:100',
282 '::fc:100:a',
283 '::fc:100:a:d',
284 '::fc:100:a:d:1',
285 '::fc:100:a:d:1:e',
286 '::fc:100:a:d:1:e:ac',
287
288 'fc:100:a:d:1:e:ac:0'], function ( i, addy ) {
289 assertTrueIPv6( addy, addy + ' is a valid IP' );
290 } );
291
292 assertFalseIPv6( '::fc:100:a:d:1:e:ac:0', 'IPv6 with "::" and 8 words' );
293 assertFalseIPv6( '::fc:100:a:d:1:e:ac:0:1', 'IPv6 with 9 words' );
294
295 assertFalseIPv6( ':fc::100', 'IPv6 starting with lone ":"' );
296 assertFalseIPv6( 'fc::100:', 'IPv6 ending with lone ":"' );
297 assertFalseIPv6( 'fc:::100', 'IPv6 with ":::" in the middle' );
298
299 assertTrueIPv6( 'fc::100', 'IPv6 with "::" and 2 words' );
300 assertTrueIPv6( 'fc::100:a', 'IPv6 with "::" and 3 words' );
301 assertTrueIPv6( 'fc::100:a:d', 'IPv6 with "::" and 4 words' );
302 assertTrueIPv6( 'fc::100:a:d:1', 'IPv6 with "::" and 5 words' );
303 assertTrueIPv6( 'fc::100:a:d:1:e', 'IPv6 with "::" and 6 words' );
304 assertTrueIPv6( 'fc::100:a:d:1:e:ac', 'IPv6 with "::" and 7 words' );
305 assertTrueIPv6( '2001::df', 'IPv6 with "::" and 2 words' );
306 assertTrueIPv6( '2001:5c0:1400:a::df', 'IPv6 with "::" and 5 words' );
307 assertTrueIPv6( '2001:5c0:1400:a::df:2', 'IPv6 with "::" and 6 words' );
308
309 assertFalseIPv6( 'fc::100:a:d:1:e:ac:0', 'IPv6 with "::" and 8 words' );
310 assertFalseIPv6( 'fc::100:a:d:1:e:ac:0:1', 'IPv6 with 9 words' );
311 } );
312
313 QUnit.test( 'isIPv4Address', 11, function ( assert ) {
314 // Shortcuts
315 function assertFalseIPv4( addy, summary ) {
316 assert.strictEqual( mw.util.isIPv4Address( addy ), false, summary );
317 }
318
319 function assertTrueIPv4( addy, summary ) {
320 assert.strictEqual( mw.util.isIPv4Address( addy ), true, summary );
321 }
322
323 // Based on IPTest.php > testisIPv4
324 assertFalseIPv4( false, 'Boolean false is not an IP' );
325 assertFalseIPv4( true, 'Boolean true is not an IP' );
326 assertFalseIPv4( '', 'Empty string is not an IP' );
327 assertFalseIPv4( 'abc', '"abc" is not an IP' );
328 assertFalseIPv4( ':', 'Colon is not an IP' );
329 assertFalseIPv4( '124.24.52', 'IPv4 not enough quads' );
330 assertFalseIPv4( '24.324.52.13', 'IPv4 out of range' );
331 assertFalseIPv4( '.24.52.13', 'IPv4 starts with period' );
332
333 assertTrueIPv4( '124.24.52.13', '124.24.52.134 is a valid IP' );
334 assertTrueIPv4( '1.24.52.13', '1.24.52.13 is a valid IP' );
335 assertFalseIPv4( '74.24.52.13/20', 'IPv4 ranges are not recogzized as valid IPs' );
336 } );
337 }( mediaWiki, jQuery ) );