tests/qunit/suites/resources/mediawiki/mediawiki.jqueryMsg.test.js

   1 ( function ( mw, $ ) {
   2
   3 var mwLanguageCache = {}, oldGetOuterHtml, formatnumTests;
   4
   5 QUnit.module( 'mediawiki.jqueryMsg', QUnit.newMwEnvironment( {
   6         setup: function () {
   7                 this.orgMwLangauge = mw.language;
   8                 mw.language = $.extend( true, {}, this.orgMwLangauge );
   9                 oldGetOuterHtml = $.fn.getOuterHtml;
  10                 $.fn.getOuterHtml = function () {
  11                         var $div = $( '<div>' ), html;
  12                         $div.append( $( this ).eq( 0 ).clone() );
  13                         html = $div.html();
  14                         $div.empty();
  15                         $div = undefined;
  16                         return html;
  17                 };
  18         },
  19         teardown: function () {
  20                 mw.language = this.orgMwLangauge;
  21                 $.fn.getOuterHtml = oldGetOuterHtml;
  22         }
  23 }) );
  24
  25 function getMwLanguage( langCode, cb ) {
  26         if ( mwLanguageCache[langCode] !== undefined ) {
  27                 mwLanguageCache[langCode].add( cb );
  28                 return;
  29         }
  30         mwLanguageCache[langCode] = $.Callbacks( 'once memory' );
  31         mwLanguageCache[langCode].add( cb );
  32         $.ajax({
  33                 url: mw.util.wikiScript( 'load' ),
  34                 data: {
  35                         skin: mw.config.get( 'skin' ),
  36                         lang: langCode,
  37                         debug: mw.config.get( 'debug' ),
  38                         modules: [
  39                                 'mediawiki.language.data',
  40                                 'mediawiki.language'
  41                         ].join( '|' ),
  42                         only: 'scripts'
  43                 },
  44                 dataType: 'script'
  45         }).done( function () {
  46                 mwLanguageCache[langCode].fire( mw.language );
  47         }).fail( function () {
  48                 mwLanguageCache[langCode].fire( false );
  49         });
  50 }
  51
  52 QUnit.test( 'Replace', 9, function ( assert ) {
  53         var parser = mw.jqueryMsg.getMessageFunction();
  54
  55         mw.messages.set( 'simple', 'Foo $1 baz $2' );
  56
  57         assert.equal( parser( 'simple' ), 'Foo $1 baz $2', 'Replacements with no substitutes' );
  58         assert.equal( parser( 'simple', 'bar' ), 'Foo bar baz $2', 'Replacements with less substitutes' );
  59         assert.equal( parser( 'simple', 'bar', 'quux' ), 'Foo bar baz quux', 'Replacements with all substitutes' );
  60
  61         mw.messages.set( 'plain-input', '<foo foo="foo">x$1y&lt;</foo>z' );
  62
  63         assert.equal(
  64                 parser( 'plain-input', 'bar' ),
  65                 '&lt;foo foo="foo"&gt;xbary&amp;lt;&lt;/foo&gt;z',
  66                 'Input is not considered html'
  67         );
  68
  69         mw.messages.set( 'plain-replace', 'Foo $1' );
  70
  71         assert.equal(
  72                 parser( 'plain-replace', '<bar bar="bar">&gt;</bar>' ),
  73                 'Foo &lt;bar bar="bar"&gt;&amp;gt;&lt;/bar&gt;',
  74                 'Replacement is not considered html'
  75         );
  76
  77         mw.messages.set( 'object-replace', 'Foo $1' );
  78
  79         assert.equal(
  80                 parser( 'object-replace', $( '<div class="bar">&gt;</div>' ) ),
  81                 'Foo <div class="bar">&gt;</div>',
  82                 'jQuery objects are preserved as raw html'
  83         );
  84
  85         assert.equal(
  86                 parser( 'object-replace', $( '<div class="bar">&gt;</div>' ).get( 0 ) ),
  87                 'Foo <div class="bar">&gt;</div>',
  88                 'HTMLElement objects are preserved as raw html'
  89         );
  90
  91         assert.equal(
  92                 parser( 'object-replace', $( '<div class="bar">&gt;</div>' ).toArray() ),
  93                 'Foo <div class="bar">&gt;</div>',
  94                 'HTMLElement[] arrays are preserved as raw html'
  95         );
  96
  97         mw.messages.set( 'wikilink-replace', 'Foo [$1 bar]' );
  98         assert.equal(
  99                 parser( 'wikilink-replace', 'http://example.org/?x=y&z' ),
 100                 'Foo <a href="http://example.org/?x=y&amp;z">bar</a>',
 101                 'Href is not double-escaped in wikilink function'
 102         );
 103 } );
 104
 105 QUnit.test( 'Plural', 3, function ( assert ) {
 106         var parser = mw.jqueryMsg.getMessageFunction();
 107
 108         mw.messages.set( 'plural-msg', 'Found $1 {{PLURAL:$1|item|items}}' );
 109         assert.equal( parser( 'plural-msg', 0 ), 'Found 0 items', 'Plural test for english with zero as count' );
 110         assert.equal( parser( 'plural-msg', 1 ), 'Found 1 item', 'Singular test for english' );
 111         assert.equal( parser( 'plural-msg', 2 ), 'Found 2 items', 'Plural test for english' );
 112 } );
 113
 114 QUnit.test( 'Gender', 11, function ( assert ) {
 115         // TODO: These tests should be for mw.msg once mw.msg integrated with mw.jqueryMsg
 116         // TODO: English may not be the best language for these tests. Use a language like Arabic or Russian
 117         var user = mw.user,
 118                 parser = mw.jqueryMsg.getMessageFunction();
 119
 120         // The values here are not significant,
 121         // what matters is which of the values is choosen by the parser
 122         mw.messages.set( 'gender-msg', '$1: {{GENDER:$2|blue|pink|green}}' );
 123
 124         user.options.set( 'gender', 'male' );
 125         assert.equal(
 126                 parser( 'gender-msg', 'Bob', 'male' ),
 127                 'Bob: blue',
 128                 'Masculine from string "male"'
 129         );
 130         assert.equal(
 131                 parser( 'gender-msg', 'Bob', user ),
 132                 'Bob: blue',
 133                 'Masculine from mw.user object'
 134         );
 135
 136         user.options.set( 'gender', 'unknown' );
 137         assert.equal(
 138                 parser( 'gender-msg', 'Foo', user ),
 139                 'Foo: green',
 140                 'Neutral from mw.user object' );
 141         assert.equal(
 142                 parser( 'gender-msg', 'Alice', 'female' ),
 143                 'Alice: pink',
 144                 'Feminine from string "female"' );
 145         assert.equal(
 146                 parser( 'gender-msg', 'User' ),
 147                 'User: green',
 148                 'Neutral when no parameter given' );
 149         assert.equal(
 150                 parser( 'gender-msg', 'User', 'unknown' ),
 151                 'User: green',
 152                 'Neutral from string "unknown"'
 153         );
 154
 155         mw.messages.set( 'gender-msg-one-form', '{{GENDER:$1|User}}: $2 {{PLURAL:$2|edit|edits}}' );
 156
 157         assert.equal(
 158                 parser( 'gender-msg-one-form', 'male', 10 ),
 159                 'User: 10 edits',
 160                 'Gender neutral and plural form'
 161         );
 162         assert.equal(
 163                 parser( 'gender-msg-one-form', 'female', 1 ),
 164                 'User: 1 edit',
 165                 'Gender neutral and singular form'
 166         );
 167
 168         mw.messages.set( 'gender-msg-lowercase', '{{gender:$1|he|she}} is awesome' );
 169         assert.equal(
 170                 parser( 'gender-msg-lowercase', 'male' ),
 171                 'he is awesome',
 172                 'Gender masculine'
 173         );
 174         assert.equal(
 175                 parser( 'gender-msg-lowercase', 'female' ),
 176                 'she is awesome',
 177                 'Gender feminine'
 178         );
 179
 180         mw.messages.set( 'gender-msg-wrong', '{{gender}} test' );
 181         assert.equal(
 182                 parser( 'gender-msg-wrong', 'female' ),
 183                 ' test',
 184                 'Invalid syntax should result in {{gender}} simply being stripped away'
 185         );
 186 } );
 187
 188 QUnit.test( 'Grammar', 2, function ( assert ) {
 189         var parser = mw.jqueryMsg.getMessageFunction();
 190
 191         // Assume the grammar form grammar_case_foo is not valid in any language
 192         mw.messages.set( 'grammar-msg', 'Przeszukaj {{GRAMMAR:grammar_case_foo|{{SITENAME}}}}' );
 193         assert.equal( parser( 'grammar-msg' ), 'Przeszukaj ' + mw.config.get( 'wgSiteName' ), 'Grammar Test with sitename' );
 194
 195         mw.messages.set( 'grammar-msg-wrong-syntax', 'Przeszukaj {{GRAMMAR:grammar_case_xyz}}' );
 196         assert.equal( parser( 'grammar-msg-wrong-syntax' ), 'Przeszukaj ' , 'Grammar Test with wrong grammar template syntax' );
 197 } );
 198
 199 QUnit.test( 'Match PHP parser', mw.libs.phpParserData.tests.length, function ( assert ) {
 200         mw.messages.set( mw.libs.phpParserData.messages );
 201         $.each( mw.libs.phpParserData.tests, function ( i, test ) {
 202                 QUnit.stop();
 203                 getMwLanguage( test.lang, function ( langClass ) {
 204                         QUnit.start();
 205                         if ( !langClass ) {
 206                                 assert.ok( false, 'Language "' + test.lang + '" failed to load' );
 207                                 return;
 208                         }
 209                         mw.config.set( 'wgUserLanguage', test.lang ) ;
 210                         var parser = new mw.jqueryMsg.parser( { language: langClass } );
 211                         assert.equal(
 212                                 parser.parse( test.key, test.args ).html(),
 213                                 test.result,
 214                                 test.name
 215                         );
 216                 } );
 217         } );
 218 });
 219
 220 QUnit.test( 'Wikilink', 6, function ( assert ) {
 221         var parser = mw.jqueryMsg.getMessageFunction(),
 222                 expectedListUsers,
 223                 expectedDisambiguationsText,
 224                 expectedMultipleBars,
 225                 expectedSpecialCharacters,
 226                 specialCharactersPageName;
 227
 228         /*
 229          The below three are all identical to or based on real messages.  For disambiguations-text,
 230          the bold was removed because it is not yet implemented.
 231         */
 232
 233         mw.messages.set( 'statistics-users', '注册[[Special:ListUsers|用户]]' );
 234
 235         expectedListUsers = '注册' + $( '<a>' ).attr( {
 236                 title: 'Special:ListUsers',
 237                 href: mw.util.wikiGetlink( 'Special:ListUsers' )
 238         } ).text( '用户' ).getOuterHtml();
 239
 240         assert.equal(
 241                 parser( 'statistics-users' ),
 242                 expectedListUsers,
 243                 'Piped wikilink'
 244         );
 245
 246         expectedDisambiguationsText = 'The following pages contain at least one link to a disambiguation page.\nThey may have to link to a more appropriate page instead.\nA page is treated as a disambiguation page if it uses a template that is linked from ' +
 247                 $( '<a>' ).attr( {
 248                         title: 'MediaWiki:Disambiguationspage',
 249                         href: mw.util.wikiGetlink( 'MediaWiki:Disambiguationspage' )
 250                 } ).text( 'MediaWiki:Disambiguationspage' ).getOuterHtml() + '.';
 251         mw.messages.set( 'disambiguations-text', 'The following pages contain at least one link to a disambiguation page.\nThey may have to link to a more appropriate page instead.\nA page is treated as a disambiguation page if it uses a template that is linked from [[MediaWiki:Disambiguationspage]].' );
 252         assert.equal(
 253                 parser( 'disambiguations-text' ),
 254                 expectedDisambiguationsText,
 255                 'Wikilink without pipe'
 256         );
 257
 258         mw.messages.set( 'version-entrypoints-index-php', '[https://www.mediawiki.org/wiki/Manual:index.php index.php]' );
 259         assert.equal(
 260                 parser( 'version-entrypoints-index-php' ),
 261                 '<a href="https://www.mediawiki.org/wiki/Manual:index.php">index.php</a>',
 262                 'External link'
 263         );
 264
 265         // Pipe trick is not supported currently, but should not parse as text either.
 266         mw.messages.set( 'pipe-trick', '[[Tampa, Florida|]]' );
 267         assert.equal(
 268                 parser( 'pipe-trick' ),
 269                 'pipe-trick: Parse error at position 0 in input: [[Tampa, Florida|]]',
 270                 'Pipe trick should return error string.'
 271         );
 272
 273         expectedMultipleBars = $( '<a>' ).attr( {
 274                 title: 'Main Page',
 275                 href: mw.util.wikiGetlink( 'Main Page' )
 276         } ).text( 'Main|Page' ).getOuterHtml();
 277         mw.messages.set( 'multiple-bars', '[[Main Page|Main|Page]]' );
 278         assert.equal(
 279                 parser( 'multiple-bars' ),
 280                 expectedMultipleBars,
 281                 'Bar in anchor'
 282         );
 283
 284         specialCharactersPageName = '"Who" wants to be a millionaire & live on \'Exotic Island\'?';
 285         expectedSpecialCharacters = $( '<a>' ).attr( {
 286                 title: specialCharactersPageName,
 287                 href: mw.util.wikiGetlink( specialCharactersPageName )
 288         } ).text( specialCharactersPageName ).getOuterHtml();
 289
 290         mw.messages.set( 'special-characters', '[[' + specialCharactersPageName + ']]' );
 291         assert.equal(
 292                 parser( 'special-characters' ),
 293                 expectedSpecialCharacters,
 294                 'Special characters'
 295         );
 296 });
 297
 298 QUnit.test( 'Int', 4, function ( assert ) {
 299         var parser = mw.jqueryMsg.getMessageFunction(),
 300             newarticletextSource = 'You have followed a link to a page that does not exist yet. To create the page, start typing in the box below (see the [[{{Int:Helppage}}|help page]] for more info). If you are here by mistake, click your browser\'s back button.',
 301                 expectedNewarticletext;
 302
 303         mw.messages.set( 'helppage', 'Help:Contents' );
 304
 305         expectedNewarticletext = 'You have followed a link to a page that does not exist yet. To create the page, start typing in the box below (see the ' +
 306                 $( '<a>' ).attr( {
 307                         title: mw.msg( 'helppage' ),
 308                         href: mw.util.wikiGetlink( mw.msg( 'helppage' ) )
 309                 } ).text( 'help page' ).getOuterHtml() + ' for more info). If you are here by mistake, click your browser\'s back button.';
 310
 311         mw.messages.set( 'newarticletext', newarticletextSource );
 312
 313         assert.equal(
 314                 parser( 'newarticletext' ),
 315                 expectedNewarticletext,
 316                 'Link with nested message'
 317         );
 318
 319         mw.messages.set( 'portal-url', 'Project:Community portal' );
 320         mw.messages.set( 'see-portal-url', '{{Int:portal-url}} is an important community page.' );
 321         assert.equal(
 322                 parser( 'see-portal-url' ),
 323                 'Project:Community portal is an important community page.',
 324                 'Nested message'
 325         );
 326
 327         mw.messages.set( 'newarticletext-lowercase',
 328                 newarticletextSource.replace( 'Int:Helppage', 'int:helppage' ) );
 329
 330         assert.equal(
 331                 parser( 'newarticletext-lowercase' ),
 332                 expectedNewarticletext,
 333                 'Link with nested message, lowercase include'
 334         );
 335
 336         mw.messages.set( 'uses-missing-int', '{{int:doesnt-exist}}' );
 337
 338         assert.equal(
 339                 parser( 'uses-missing-int' ),
 340                 '[doesnt-exist]',
 341                 'int: where nested message does not exist'
 342         );
 343 });
 344
 345 // Tests that getMessageFunction is used for messages with curly braces or square brackets,
 346 // but not otherwise.
 347 QUnit.test( 'mw.msg()', 8, function ( assert ) {
 348         // Should be
 349         var map, oldGMF, outerCalled, innerCalled;
 350
 351         map = new mw.Map();
 352         map.set( {
 353                 'curly-brace': '{{int:message}}',
 354                 'single-square-bracket': '[https://www.mediawiki.org/ MediaWiki]',
 355                 'double-square-bracket': '[[Some page]]',
 356                 'regular': 'Other message'
 357         } );
 358
 359         oldGMF = mw.jqueryMsg.getMessageFunction;
 360
 361         mw.jqueryMsg.getMessageFunction = function() {
 362                 outerCalled = true;
 363                 return function() {
 364                         innerCalled = true;
 365                 };
 366         };
 367
 368         function verifyGetMessageFunction( key, shouldCall ) {
 369                 outerCalled = false;
 370                 innerCalled = false;
 371                 ( new mw.Message( map, key ) ).parser();
 372                 assert.strictEqual( outerCalled, shouldCall, 'Outer function called for ' + key );
 373                 assert.strictEqual( innerCalled, shouldCall, 'Inner function called for ' + key );
 374         }
 375
 376         verifyGetMessageFunction( 'curly-brace', true );
 377         verifyGetMessageFunction( 'single-square-bracket', true );
 378         verifyGetMessageFunction( 'double-square-bracket', true );
 379         verifyGetMessageFunction( 'regular', false );
 380
 381         mw.jqueryMsg.getMessageFunction = oldGMF;
 382 } );
 383
 384 formatnumTests = [
 385         {
 386                 lang: 'en',
 387                 number: 987654321.654321,
 388                 result: '987654321.654321',
 389                 description: 'formatnum test for English, decimal seperator'
 390         },
 391         {
 392                 lang: 'ar',
 393                 number: 987654321.654321,
 394                 result: '٩٨٧٦٥٤٣٢١٫٦٥٤٣٢١',
 395                 description: 'formatnum test for Arabic, with decimal seperator'
 396         },
 397         {
 398                 lang: 'ar',
 399                 number: '٩٨٧٦٥٤٣٢١٫٦٥٤٣٢١',
 400                 result: 987654321,
 401                 integer: true,
 402                 description: 'formatnum test for Arabic, with decimal seperator, reverse'
 403         },
 404         {
 405                 lang: 'ar',
 406                 number: -12.89,
 407                 result: '-١٢٫٨٩',
 408                 description: 'formatnum test for Arabic, negative number'
 409         },
 410         {
 411                 lang: 'ar',
 412                 number: '-١٢٫٨٩',
 413                 result: -12,
 414                 integer: true,
 415                 description: 'formatnum test for Arabic, negative number, reverse'
 416         },
 417         {
 418                 lang: 'nl',
 419                 number: 987654321.654321,
 420                 result: '987654321,654321',
 421                 description: 'formatnum test for Nederlands, decimal seperator'
 422         },
 423         {
 424                 lang: 'nl',
 425                 number: -12.89,
 426                 result: '-12,89',
 427                 description: 'formatnum test for Nederlands, negative number'
 428         },
 429         {
 430                 lang: 'nl',
 431                 number: 'invalidnumber',
 432                 result: 'invalidnumber',
 433                 description: 'formatnum test for Nederlands, invalid number'
 434         }
 435 ];
 436
 437 QUnit.test( 'formatnum', formatnumTests.length, function ( assert ) {
 438         mw.messages.set( 'formatnum-msg', '{{formatnum:$1}}' );
 439         mw.messages.set( 'formatnum-msg-int', '{{formatnum:$1|R}}' );
 440         $.each( formatnumTests, function ( i, test ) {
 441                 QUnit.stop();
 442                 getMwLanguage( test.lang, function ( langClass ) {
 443                         QUnit.start();
 444                         if ( !langClass ) {
 445                                 assert.ok( false, 'Language "' + test.lang + '" failed to load' );
 446                                 return;
 447                         }
 448                         mw.messages.set(test.message );
 449                         mw.config.set( 'wgUserLanguage', test.lang ) ;
 450                         var parser = new mw.jqueryMsg.parser( { language: langClass } );
 451                         assert.equal(
 452                                 parser.parse( test.integer ? 'formatnum-msg-int' : 'formatnum-msg',
 453                                         [ test.number ] ).html(),
 454                                 test.result,
 455                                 test.description
 456                         );
 457                 } );
 458         } );
 459 });
 460
 461 }( mediaWiki, jQuery ) );