tests/phpunit/includes/MessageTest.php

   1 <?php
   2
   3 class MessageTest extends MediaWikiLangTestCase {
   4
   5         protected function setUp() {
   6                 parent::setUp();
   7
   8                 $this->setMwGlobals( array(
   9                         'wgLang' => Language::factory( 'en' ),
  10                         'wgForceUIMsgAsContentMsg' => array(),
  11                 ) );
  12         }
  13
  14         /**
  15          * @covers Message::__construct
  16          * @dataProvider provideConstructor
  17          */
  18         public function testConstructor( $expectedLang, $key, $params, $language ) {
  19                 $reflection = new ReflectionClass( 'Message' );
  20
  21                 $keyProperty = $reflection->getProperty( 'key' );
  22                 $keyProperty->setAccessible( true );
  23
  24                 $paramsProperty = $reflection->getProperty( 'parameters' );
  25                 $paramsProperty->setAccessible( true );
  26
  27                 $langProperty = $reflection->getProperty( 'language' );
  28                 $langProperty->setAccessible( true );
  29
  30                 $message = new Message( $key, $params, $language );
  31
  32                 $this->assertEquals( $key, $keyProperty->getValue( $message ) );
  33                 $this->assertEquals( $params, $paramsProperty->getValue( $message ) );
  34                 $this->assertEquals( $expectedLang, $langProperty->getValue( $message ) );
  35         }
  36
  37         public function provideConstructor() {
  38                 $langDe = Language::factory( 'de' );
  39                 $langEn = Language::factory( 'en' );
  40
  41                 return array(
  42                         array( $langDe, 'foo', array(), $langDe ),
  43                         array( $langDe, 'foo', array( 'bar' ), $langDe ),
  44                         array( $langEn, 'foo', array( 'bar' ), null )
  45                 );
  46         }
  47
  48         public function provideTestParams() {
  49                 return array(
  50                         array( array() ),
  51                         array( array( 'foo' ), 'foo' ),
  52                         array( array( 'foo', 'bar' ), 'foo', 'bar' ),
  53                         array( array( 'baz' ), array( 'baz' ) ),
  54                         array( array( 'baz', 'foo' ), array( 'baz', 'foo' ) ),
  55                         array( array( 'baz', 'foo' ), array( 'baz', 'foo' ), 'hhh' ),
  56                         array( array( 'baz', 'foo' ), array( 'baz', 'foo' ), 'hhh', array( 'ahahahahha' ) ),
  57                         array( array( 'baz', 'foo' ), array( 'baz', 'foo' ), array( 'ahahahahha' ) ),
  58                         array( array( 'baz' ), array( 'baz' ), array( 'ahahahahha' ) ),
  59                 );
  60         }
  61
  62         public function getLanguageProvider() {
  63                 return array(
  64                         array( 'foo', array( 'bar' ), 'en' ),
  65                         array( 'foo', array( 'bar' ), 'de' )
  66                 );
  67         }
  68
  69         /**
  70          * @covers Message::getLanguage
  71          * @dataProvider getLanguageProvider
  72          */
  73         public function testGetLanguageCode( $key, $params, $languageCode ) {
  74                 $language = Language::factory( $languageCode );
  75                 $message = new Message( $key, $params, $language );
  76
  77                 $this->assertEquals( $language, $message->getLanguage() );
  78         }
  79
  80         /**
  81          * @covers Message::params
  82          * @dataProvider provideTestParams
  83          */
  84         public function testParams( $expected ) {
  85                 $msg = new Message( 'imasomething' );
  86
  87                 $returned = call_user_func_array( array( $msg, 'params' ), array_slice( func_get_args(), 1 ) );
  88
  89                 $this->assertSame( $msg, $returned );
  90                 $this->assertEquals( $expected, $msg->getParams() );
  91         }
  92
  93         /**
  94          * @covers Message::exists
  95          */
  96         public function testExists() {
  97                 $this->assertTrue( wfMessage( 'mainpage' )->exists() );
  98                 $this->assertTrue( wfMessage( 'mainpage' )->params( array() )->exists() );
  99                 $this->assertTrue( wfMessage( 'mainpage' )->rawParams( 'foo', 123 )->exists() );
 100                 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->exists() );
 101                 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->params( array() )->exists() );
 102                 $this->assertFalse( wfMessage( 'i-dont-exist-evar' )->rawParams( 'foo', 123 )->exists() );
 103         }
 104
 105         /**
 106          * @covers Message::__construct
 107          */
 108         public function testKey() {
 109                 $this->assertInstanceOf( 'Message', wfMessage( 'mainpage' ) );
 110                 $this->assertInstanceOf( 'Message', wfMessage( 'i-dont-exist-evar' ) );
 111                 $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->text() );
 112                 $this->assertEquals( '&lt;i-dont-exist-evar&gt;', wfMessage( 'i-dont-exist-evar' )->text() );
 113                 $this->assertEquals( '<i-dont-exist-evar>', wfMessage( 'i-dont-exist-evar' )->plain() );
 114                 $this->assertEquals( '&lt;i-dont-exist-evar&gt;', wfMessage( 'i-dont-exist-evar' )->escaped() );
 115         }
 116
 117         /**
 118          * @covers Message::inLanguage
 119          */
 120         public function testInLanguage() {
 121                 $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() );
 122                 $this->assertEquals( 'Заглавная страница', wfMessage( 'mainpage' )->inLanguage( 'ru' )->text() );
 123
 124                 // NOTE: make sure internal caching of the message text is reset appropriately
 125                 $msg = wfMessage( 'mainpage' );
 126                 $this->assertEquals( 'Main Page', $msg->inLanguage( Language::factory( 'en' ) )->text() );
 127                 $this->assertEquals( 'Заглавная страница', $msg->inLanguage( Language::factory( 'ru' ) )->text() );
 128         }
 129
 130         /**
 131          * @covers Message::__construct
 132          */
 133         public function testMessageParams() {
 134                 $this->assertEquals( 'Return to $1.', wfMessage( 'returnto' )->text() );
 135                 $this->assertEquals( 'Return to $1.', wfMessage( 'returnto', array() )->text() );
 136                 $this->assertEquals( 'You have foo (bar).', wfMessage( 'youhavenewmessages', 'foo', 'bar' )->text() );
 137                 $this->assertEquals( 'You have foo (bar).', wfMessage( 'youhavenewmessages', array( 'foo', 'bar' ) )->text() );
 138         }
 139
 140         /**
 141          * @covers Message::__construct
 142          * @covers Message::rawParams
 143          */
 144         public function testMessageParamSubstitution() {
 145                 $this->assertEquals( '(Заглавная страница)', wfMessage( 'parentheses', 'Заглавная страница' )->plain() );
 146                 $this->assertEquals( '(Заглавная страница $1)', wfMessage( 'parentheses', 'Заглавная страница $1' )->plain() );
 147                 $this->assertEquals( '(Заглавная страница)', wfMessage( 'parentheses' )->rawParams( 'Заглавная страница' )->plain() );
 148                 $this->assertEquals( '(Заглавная страница $1)', wfMessage( 'parentheses' )->rawParams( 'Заглавная страница $1' )->plain() );
 149         }
 150
 151         /**
 152          * @covers Message::__construct
 153          * @covers Message::params
 154          */
 155         public function testDeliciouslyManyParams() {
 156                 $msg = new RawMessage( '$1$2$3$4$5$6$7$8$9$10$11$12' );
 157                 // One less than above has placeholders
 158                 $params = array( 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k' );
 159                 $this->assertEquals( 'abcdefghijka2', $msg->params( $params )->plain(), 'Params > 9 are replaced correctly' );
 160         }
 161
 162         /**
 163          * @covers Message::numParams
 164          */
 165         public function testMessageNumParams() {
 166                 $lang = Language::factory( 'en' );
 167                 $msg = new RawMessage( '$1' );
 168
 169                 $this->assertEquals(
 170                         $lang->formatNum( 123456.789 ),
 171                         $msg->inLanguage( $lang )->numParams( 123456.789 )->plain(),
 172                         'numParams is handled correctly'
 173                 );
 174         }
 175
 176         /**
 177          * @covers Message::durationParams
 178          */
 179         public function testMessageDurationParams() {
 180                 $lang = Language::factory( 'en' );
 181                 $msg = new RawMessage( '$1' );
 182
 183                 $this->assertEquals(
 184                         $lang->formatDuration( 1234 ),
 185                         $msg->inLanguage( $lang )->durationParams( 1234 )->plain(),
 186                         'durationParams is handled correctly'
 187                 );
 188         }
 189
 190         /**
 191          * FIXME: This should not need database, but Language#formatExpiry does (bug 55912)
 192          * @group Database
 193          * @covers Message::expiryParams
 194          */
 195         public function testMessageExpiryParams() {
 196                 $lang = Language::factory( 'en' );
 197                 $msg = new RawMessage( '$1' );
 198
 199                 $this->assertEquals(
 200                         $lang->formatExpiry( wfTimestampNow() ),
 201                         $msg->inLanguage( $lang )->expiryParams( wfTimestampNow() )->plain(),
 202                         'expiryParams is handled correctly'
 203                 );
 204         }
 205
 206         /**
 207          * @covers Message::timeperiodParams
 208          */
 209         public function testMessageTimeperiodParams() {
 210                 $lang = Language::factory( 'en' );
 211                 $msg = new RawMessage( '$1' );
 212
 213                 $this->assertEquals(
 214                         $lang->formatTimePeriod( 1234 ),
 215                         $msg->inLanguage( $lang )->timeperiodParams( 1234 )->plain(),
 216                         'timeperiodParams is handled correctly'
 217                 );
 218         }
 219
 220         /**
 221          * @covers Message::sizeParams
 222          */
 223         public function testMessageSizeParams() {
 224                 $lang = Language::factory( 'en' );
 225                 $msg = new RawMessage( '$1' );
 226
 227                 $this->assertEquals(
 228                         $lang->formatSize( 123456 ),
 229                         $msg->inLanguage( $lang )->sizeParams( 123456 )->plain(),
 230                         'sizeParams is handled correctly'
 231                 );
 232         }
 233
 234         /**
 235          * @covers Message::bitrateParams
 236          */
 237         public function testMessageBitrateParams() {
 238                 $lang = Language::factory( 'en' );
 239                 $msg = new RawMessage( '$1' );
 240
 241                 $this->assertEquals(
 242                         $lang->formatBitrate( 123456 ),
 243                         $msg->inLanguage( $lang )->bitrateParams( 123456 )->plain(),
 244                         'bitrateParams is handled correctly'
 245                 );
 246         }
 247
 248         /**
 249          * @covers Message::inContentLanguage
 250          */
 251         public function testInContentLanguage() {
 252                 $this->setMwGlobals( 'wgLang', Language::factory( 'fr' ) );
 253
 254                 // NOTE: make sure internal caching of the message text is reset appropriately
 255                 $msg = wfMessage( 'mainpage' );
 256                 $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
 257                 $this->assertEquals( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" );
 258                 $this->assertEquals( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" );
 259         }
 260
 261         /**
 262          * @covers Message::inContentLanguage
 263          */
 264         public function testInContentLanguageOverride() {
 265                 $this->setMwGlobals( array(
 266                         'wgLang' => Language::factory( 'fr' ),
 267                         'wgForceUIMsgAsContentMsg' => array( 'mainpage' ),
 268                 ) );
 269
 270                 // NOTE: make sure internal caching of the message text is reset appropriately.
 271                 // NOTE: wgForceUIMsgAsContentMsg forces the messages *current* language to be used.
 272                 $msg = wfMessage( 'mainpage' );
 273                 $this->assertEquals( 'Accueil', $msg->inContentLanguage()->plain(), 'inContentLanguage() with ForceUIMsg override enabled' );
 274                 $this->assertEquals( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" );
 275                 $this->assertEquals( 'Main Page', $msg->inContentLanguage()->plain(), 'inContentLanguage() with ForceUIMsg override enabled' );
 276                 $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
 277         }
 278
 279         /**
 280          * @expectedException MWException
 281          * @covers Message::inLanguage
 282          */
 283         public function testInLanguageThrows() {
 284                 wfMessage( 'foo' )->inLanguage( 123 );
 285         }
 286 }