Merge "wfMessage: use Message::params() to handle all the message parameters"
[lhc/web/wiklou.git] / tests / phpunit / includes / MessageTest.php
index bb9af8f..1de9c23 100644 (file)
@@ -18,8 +18,8 @@ class MessageTest extends MediaWikiLangTestCase {
        public function testConstructor( $expectedLang, $key, $params, $language ) {
                $message = new Message( $key, $params, $language );
 
-               $this->assertEquals( $key, $message->getKey() );
-               $this->assertEquals( $params, $message->getParams() );
+               $this->assertSame( $key, $message->getKey() );
+               $this->assertSame( $params, $message->getParams() );
                $this->assertEquals( $expectedLang, $message->getLanguage() );
 
                $messageSpecifier = $this->getMockForAbstractClass( 'MessageSpecifier' );
@@ -29,8 +29,8 @@ class MessageTest extends MediaWikiLangTestCase {
                        ->method( 'getParams' )->will( $this->returnValue( $params ) );
                $message = new Message( $messageSpecifier, [], $language );
 
-               $this->assertEquals( $key, $message->getKey() );
-               $this->assertEquals( $params, $message->getParams() );
+               $this->assertSame( $key, $message->getKey() );
+               $this->assertSame( $params, $message->getParams() );
                $this->assertEquals( $expectedLang, $message->getLanguage() );
        }
 
@@ -51,6 +51,10 @@ class MessageTest extends MediaWikiLangTestCase {
                                [],
                                [],
                        ],
+                       [
+                               [],
+                               [ [] ],
+                       ],
                        [
                                [ 'foo' ],
                                [ 'foo' ],
@@ -68,19 +72,37 @@ class MessageTest extends MediaWikiLangTestCase {
                                [ [ 'baz', 'foo' ] ],
                        ],
                        [
-                               [ 'baz', 'foo' ],
+                               [ Message::rawParam( 'baz' ) ],
+                               [ Message::rawParam( 'baz' ) ],
+                       ],
+                       [
+                               [ Message::rawParam( 'baz' ), 'foo' ],
+                               [ Message::rawParam( 'baz' ), 'foo' ],
+                       ],
+                       [
+                               [ Message::rawParam( 'baz' ) ],
+                               [ [ Message::rawParam( 'baz' ) ] ],
+                       ],
+                       [
+                               [ Message::rawParam( 'baz' ), 'foo' ],
+                               [ [ Message::rawParam( 'baz' ), 'foo' ] ],
+                       ],
+
+                       // Test handling of erroneous input, to detect if it changes
+                       [
+                               [ [ 'baz', 'foo' ], 'hhh' ],
                                [ [ 'baz', 'foo' ], 'hhh' ],
                        ],
                        [
-                               [ 'baz', 'foo' ],
+                               [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
                                [ [ 'baz', 'foo' ], 'hhh', [ 'ahahahahha' ] ],
                        ],
                        [
-                               [ 'baz', 'foo' ],
+                               [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
                                [ [ 'baz', 'foo' ], [ 'ahahahahha' ] ],
                        ],
                        [
-                               [ 'baz' ],
+                               [ [ 'baz' ], [ 'ahahahahha' ] ],
                                [ [ 'baz' ], [ 'ahahahahha' ] ],
                        ],
                ];
@@ -97,7 +119,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $returned = call_user_func_array( [ $msg, 'params' ], $args );
 
                $this->assertSame( $msg, $returned );
-               $this->assertEquals( $expected, $msg->getParams() );
+               $this->assertSame( $expected, $msg->getParams() );
        }
 
        public static function provideConstructorLanguage() {
@@ -165,8 +187,8 @@ class MessageTest extends MediaWikiLangTestCase {
 
                $msg = new Message( $key );
                $this->assertContains( $msg->getKey(), $expected );
-               $this->assertEquals( $expected, $msg->getKeysToTry() );
-               $this->assertEquals( count( $expected ) > 1, $msg->isMultiKey() );
+               $this->assertSame( $expected, $msg->getKeysToTry() );
+               $this->assertSame( count( $expected ) > 1, $msg->isMultiKey() );
        }
 
        /**
@@ -190,16 +212,45 @@ class MessageTest extends MediaWikiLangTestCase {
         * @covers Message::__construct
         */
        public function testWfMessageParams() {
-               $this->assertEquals( 'Return to $1.', wfMessage( 'returnto' )->text() );
-               $this->assertEquals( 'Return to $1.', wfMessage( 'returnto', [] )->text() );
-               $this->assertEquals(
+               $this->assertSame( 'Return to $1.', wfMessage( 'returnto' )->text() );
+               $this->assertSame( 'Return to $1.', wfMessage( 'returnto', [] )->text() );
+               $this->assertSame(
+                       'Return to 1,024.',
+                       wfMessage( 'returnto', Message::numParam( 1024 ) )->text()
+               );
+               $this->assertSame(
+                       'Return to 1,024.',
+                       wfMessage( 'returnto', [ Message::numParam( 1024 ) ] )->text()
+               );
+               $this->assertSame(
                        'You have foo (bar).',
                        wfMessage( 'youhavenewmessages', 'foo', 'bar' )->text()
                );
-               $this->assertEquals(
+               $this->assertSame(
                        'You have foo (bar).',
                        wfMessage( 'youhavenewmessages', [ 'foo', 'bar' ] )->text()
                );
+               $this->assertSame(
+                       'You have 1,024 (bar).',
+                       wfMessage(
+                               'youhavenewmessages',
+                               Message::numParam( 1024 ), 'bar'
+                       )->text()
+               );
+               $this->assertSame(
+                       'You have foo (2,048).',
+                       wfMessage(
+                               'youhavenewmessages',
+                               'foo', Message::numParam( 2048 )
+                       )->text()
+               );
+               $this->assertSame(
+                       'You have 1,024 (2,048).',
+                       wfMessage(
+                               'youhavenewmessages',
+                               [ Message::numParam( 1024 ), Message::numParam( 2048 ) ]
+                       )->text()
+               );
        }
 
        /**
@@ -222,13 +273,13 @@ class MessageTest extends MediaWikiLangTestCase {
         * @covers Message::toString
         */
        public function testToStringKey() {
-               $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->text() );
-               $this->assertEquals( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->text() );
-               $this->assertEquals( '⧼i&lt;dont&gt;exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->text() );
-               $this->assertEquals( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->plain() );
-               $this->assertEquals( '⧼i&lt;dont&gt;exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->plain() );
-               $this->assertEquals( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->escaped() );
-               $this->assertEquals(
+               $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->text() );
+               $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->text() );
+               $this->assertSame( '⧼i&lt;dont&gt;exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->text() );
+               $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->plain() );
+               $this->assertSame( '⧼i&lt;dont&gt;exist-evar⧽', wfMessage( 'i<dont>exist-evar' )->plain() );
+               $this->assertSame( '⧼i-dont-exist-evar⧽', wfMessage( 'i-dont-exist-evar' )->escaped() );
+               $this->assertSame(
                        '⧼i&lt;dont&gt;exist-evar⧽',
                        wfMessage( 'i<dont>exist-evar' )->escaped()
                );
@@ -254,10 +305,10 @@ class MessageTest extends MediaWikiLangTestCase {
         */
        public function testToString( $key, $format, $expect, $expectImplicit ) {
                $msg = new Message( $key );
-               $this->assertEquals( $expect, $msg->$format() );
-               $this->assertEquals( $expect, $msg->toString() );
-               $this->assertEquals( $expectImplicit, $msg->__toString() );
-               $this->assertEquals( $expect, $msg->toString() );
+               $this->assertSame( $expect, $msg->$format() );
+               $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' );
+               $this->assertSame( $expectImplicit, $msg->__toString() );
+               $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' );
        }
 
        public static function provideToString_raw() {
@@ -280,31 +331,31 @@ class MessageTest extends MediaWikiLangTestCase {
         * @covers Message::__toString
         * @dataProvider provideToString_raw
         */
-       public function testToString_raw( $key, $format, $expect, $expectImplicit ) {
+       public function testToString_raw( $message, $format, $expect, $expectImplicit ) {
                // make the message behave like RawMessage and use the key as-is
                $msg = $this->getMockBuilder( Message::class )->setMethods( [ 'fetchMessage' ] )
-                       ->setConstructorArgs( [ $key ] )
+                       ->disableOriginalConstructor()
                        ->getMock();
-               $msg->expects( $this->any() )->method( 'fetchMessage' )->willReturn( $key );
+               $msg->expects( $this->any() )->method( 'fetchMessage' )->willReturn( $message );
                /** @var Message $msg */
-               $this->assertEquals( $expect, $msg->$format() );
-               $this->assertEquals( $expect, $msg->toString() );
-               $this->assertEquals( $expectImplicit, $msg->__toString() );
-               $this->assertEquals( $expect, $msg->toString() );
+               $this->assertSame( $expect, $msg->$format() );
+               $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by previous call' );
+               $this->assertSame( $expectImplicit, $msg->__toString() );
+               $this->assertSame( $expect, $msg->toString(), 'toString is unaffected by __toString' );
        }
 
        /**
         * @covers Message::inLanguage
         */
        public function testInLanguage() {
-               $this->assertEquals( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() );
-               $this->assertEquals( 'Заглавная страница',
+               $this->assertSame( 'Main Page', wfMessage( 'mainpage' )->inLanguage( 'en' )->text() );
+               $this->assertSame( 'Заглавная страница',
                        wfMessage( 'mainpage' )->inLanguage( 'ru' )->text() );
 
                // NOTE: make sure internal caching of the message text is reset appropriately
                $msg = wfMessage( 'mainpage' );
-               $this->assertEquals( 'Main Page', $msg->inLanguage( Language::factory( 'en' ) )->text() );
-               $this->assertEquals(
+               $this->assertSame( 'Main Page', $msg->inLanguage( Language::factory( 'en' ) )->text() );
+               $this->assertSame(
                        'Заглавная страница',
                        $msg->inLanguage( Language::factory( 'ru' ) )->text()
                );
@@ -315,19 +366,19 @@ class MessageTest extends MediaWikiLangTestCase {
         * @covers Message::rawParams
         */
        public function testRawParams() {
-               $this->assertEquals(
+               $this->assertSame(
                        '(Заглавная страница)',
                        wfMessage( 'parentheses', 'Заглавная страница' )->plain()
                );
-               $this->assertEquals(
+               $this->assertSame(
                        '(Заглавная страница $1)',
                        wfMessage( 'parentheses', 'Заглавная страница $1' )->plain()
                );
-               $this->assertEquals(
+               $this->assertSame(
                        '(Заглавная страница)',
                        wfMessage( 'parentheses' )->rawParams( 'Заглавная страница' )->plain()
                );
-               $this->assertEquals(
+               $this->assertSame(
                        '(Заглавная страница $1)',
                        wfMessage( 'parentheses' )->rawParams( 'Заглавная страница $1' )->plain()
                );
@@ -339,8 +390,8 @@ class MessageTest extends MediaWikiLangTestCase {
         */
        public function testRawMessage() {
                $msg = new RawMessage( 'example &' );
-               $this->assertEquals( 'example &', $msg->plain() );
-               $this->assertEquals( 'example &amp;', $msg->escaped() );
+               $this->assertSame( 'example &', $msg->plain() );
+               $this->assertSame( 'example &amp;', $msg->escaped() );
        }
 
        /**
@@ -352,7 +403,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $msg = new RawMessage( '$1$2$3$4$5$6$7$8$9$10$11$12' );
                // One less than above has placeholders
                $params = [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k' ];
-               $this->assertEquals(
+               $this->assertSame(
                        'abcdefghijka2',
                        $msg->params( $params )->plain(),
                        'Params > 9 are replaced correctly'
@@ -360,7 +411,7 @@ class MessageTest extends MediaWikiLangTestCase {
 
                $msg = new RawMessage( 'Params$*' );
                $params = [ 'ab', 'bc', 'cd' ];
-               $this->assertEquals(
+               $this->assertSame(
                        'Params: ab, bc, cd',
                        $msg->params( $params )->text()
                );
@@ -374,7 +425,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $lang = Language::factory( 'en' );
                $msg = new RawMessage( '$1' );
 
-               $this->assertEquals(
+               $this->assertSame(
                        $lang->formatNum( 123456.789 ),
                        $msg->inLanguage( $lang )->numParams( 123456.789 )->plain(),
                        'numParams is handled correctly'
@@ -389,7 +440,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $lang = Language::factory( 'en' );
                $msg = new RawMessage( '$1' );
 
-               $this->assertEquals(
+               $this->assertSame(
                        $lang->formatDuration( 1234 ),
                        $msg->inLanguage( $lang )->durationParams( 1234 )->plain(),
                        'durationParams is handled correctly'
@@ -406,7 +457,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $lang = Language::factory( 'en' );
                $msg = new RawMessage( '$1' );
 
-               $this->assertEquals(
+               $this->assertSame(
                        $lang->formatExpiry( wfTimestampNow() ),
                        $msg->inLanguage( $lang )->expiryParams( wfTimestampNow() )->plain(),
                        'expiryParams is handled correctly'
@@ -421,7 +472,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $lang = Language::factory( 'en' );
                $msg = new RawMessage( '$1' );
 
-               $this->assertEquals(
+               $this->assertSame(
                        $lang->formatTimePeriod( 1234 ),
                        $msg->inLanguage( $lang )->timeperiodParams( 1234 )->plain(),
                        'timeperiodParams is handled correctly'
@@ -436,7 +487,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $lang = Language::factory( 'en' );
                $msg = new RawMessage( '$1' );
 
-               $this->assertEquals(
+               $this->assertSame(
                        $lang->formatSize( 123456 ),
                        $msg->inLanguage( $lang )->sizeParams( 123456 )->plain(),
                        'sizeParams is handled correctly'
@@ -451,7 +502,7 @@ class MessageTest extends MediaWikiLangTestCase {
                $lang = Language::factory( 'en' );
                $msg = new RawMessage( '$1' );
 
-               $this->assertEquals(
+               $this->assertSame(
                        $lang->formatBitrate( 123456 ),
                        $msg->inLanguage( $lang )->bitrateParams( 123456 )->plain(),
                        'bitrateParams is handled correctly'
@@ -505,13 +556,143 @@ class MessageTest extends MediaWikiLangTestCase {
                        'one $2',
                        '<div>foo</div> [[Bar]] {{Baz}} &lt;',
                ];
-               $this->assertEquals(
+               $this->assertSame(
                        $expect,
                        $msg->inLanguage( $lang )->plaintextParams( $params )->$format(),
                        "Fail formatting for $format"
                );
        }
 
+       public static function provideListParam() {
+               $lang = Language::factory( 'de' );
+               $msg1 = new Message( 'mainpage', [], $lang );
+               $msg2 = new RawMessage( "''link''", [], $lang );
+
+               return [
+                       'Simple comma list' => [
+                               [ 'a', 'b', 'c' ],
+                               'comma',
+                               'text',
+                               'a, b, c'
+                       ],
+
+                       'Simple semicolon list' => [
+                               [ 'a', 'b', 'c' ],
+                               'semicolon',
+                               'text',
+                               'a; b; c'
+                       ],
+
+                       'Simple pipe list' => [
+                               [ 'a', 'b', 'c' ],
+                               'pipe',
+                               'text',
+                               'a | b | c'
+                       ],
+
+                       'Simple text list' => [
+                               [ 'a', 'b', 'c' ],
+                               'text',
+                               'text',
+                               'a, b and c'
+                       ],
+
+                       'Empty list' => [
+                               [],
+                               'comma',
+                               'text',
+                               ''
+                       ],
+
+                       'List with all "before" params, ->text()' => [
+                               [ "''link''", Message::numParam( 12345678 ) ],
+                               'semicolon',
+                               'text',
+                               '\'\'link\'\'; 12,345,678'
+                       ],
+
+                       'List with all "before" params, ->parse()' => [
+                               [ "''link''", Message::numParam( 12345678 ) ],
+                               'semicolon',
+                               'parse',
+                               '<i>link</i>; 12,345,678'
+                       ],
+
+                       'List with all "after" params, ->text()' => [
+                               [ $msg1, $msg2, Message::rawParam( '[[foo]]' ) ],
+                               'semicolon',
+                               'text',
+                               'Main Page; \'\'link\'\'; [[foo]]'
+                       ],
+
+                       'List with all "after" params, ->parse()' => [
+                               [ $msg1, $msg2, Message::rawParam( '[[foo]]' ) ],
+                               'semicolon',
+                               'parse',
+                               'Main Page; <i>link</i>; [[foo]]'
+                       ],
+
+                       'List with both "before" and "after" params, ->text()' => [
+                               [ $msg1, $msg2, Message::rawParam( '[[foo]]' ), "''link''", Message::numParam( 12345678 ) ],
+                               'semicolon',
+                               'text',
+                               'Main Page; \'\'link\'\'; [[foo]]; \'\'link\'\'; 12,345,678'
+                       ],
+
+                       'List with both "before" and "after" params, ->parse()' => [
+                               [ $msg1, $msg2, Message::rawParam( '[[foo]]' ), "''link''", Message::numParam( 12345678 ) ],
+                               'semicolon',
+                               'parse',
+                               'Main Page; <i>link</i>; [[foo]]; <i>link</i>; 12,345,678'
+                       ],
+               ];
+       }
+
+       /**
+        * @covers Message::listParam
+        * @covers Message::extractParam
+        * @covers Message::formatListParam
+        * @dataProvider provideListParam
+        */
+       public function testListParam( $list, $type, $format, $expect ) {
+               $lang = Language::factory( 'en' );
+
+               $msg = new RawMessage( '$1' );
+               $msg->params( [ Message::listParam( $list, $type ) ] );
+               $this->assertEquals(
+                       $expect,
+                       $msg->inLanguage( $lang )->$format()
+               );
+       }
+
+       /**
+        * @covers Message::extractParam
+        */
+       public function testMessageAsParam() {
+               $this->setMwGlobals( [
+                       'wgScript' => '/wiki/index.php',
+                       'wgArticlePath' => '/wiki/$1',
+               ] );
+
+               $msg = new Message( 'returnto', [
+                       new Message( 'apihelp-link', [
+                               'foo', new Message( 'mainpage', [], Language::factory( 'en' ) )
+                       ], Language::factory( 'de' ) )
+               ], Language::factory( 'es' ) );
+
+               $this->assertEquals(
+                       'Volver a [[Special:ApiHelp/foo|Página principal]].',
+                       $msg->text(),
+                       'Process with ->text()'
+               );
+               $this->assertEquals(
+                       '<p>Volver a <a href="/wiki/Special:ApiHelp/foo" title="Special:ApiHelp/foo">Página '
+                               . "principal</a>.\n</p>",
+                       $msg->parseAsBlock(),
+                       'Process with ->parseAsBlock()'
+               );
+       }
+
        public static function provideParser() {
                return [
                        [
@@ -546,7 +727,7 @@ class MessageTest extends MediaWikiLangTestCase {
         */
        public function testParser( $expect, $format ) {
                $msg = new RawMessage( "''&'' <x><!-- x -->" );
-               $this->assertEquals(
+               $this->assertSame(
                        $expect,
                        $msg->inLanguage( 'en' )->$format()
                );
@@ -560,9 +741,9 @@ class MessageTest extends MediaWikiLangTestCase {
 
                // NOTE: make sure internal caching of the message text is reset appropriately
                $msg = wfMessage( 'mainpage' );
-               $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
-               $this->assertEquals( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" );
-               $this->assertEquals( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" );
+               $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
+               $this->assertSame( 'Main Page', $msg->inContentLanguage()->plain(), "inContentLanguage()" );
+               $this->assertSame( 'Accueil', $msg->inLanguage( 'fr' )->plain(), "inLanguage( 'fr' )" );
        }
 
        /**
@@ -577,18 +758,18 @@ class MessageTest extends MediaWikiLangTestCase {
                // NOTE: make sure internal caching of the message text is reset appropriately.
                // NOTE: wgForceUIMsgAsContentMsg forces the messages *current* language to be used.
                $msg = wfMessage( 'mainpage' );
-               $this->assertEquals(
+               $this->assertSame(
                        'Accueil',
                        $msg->inContentLanguage()->plain(),
                        'inContentLanguage() with ForceUIMsg override enabled'
                );
-               $this->assertEquals( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" );
-               $this->assertEquals(
+               $this->assertSame( 'Main Page', $msg->inLanguage( 'en' )->plain(), "inLanguage( 'en' )" );
+               $this->assertSame(
                        'Main Page',
                        $msg->inContentLanguage()->plain(),
                        'inContentLanguage() with ForceUIMsg override enabled'
                );
-               $this->assertEquals( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
+               $this->assertSame( 'Hauptseite', $msg->inLanguage( 'de' )->plain(), "inLanguage( 'de' )" );
        }
 
        /**
@@ -607,18 +788,18 @@ class MessageTest extends MediaWikiLangTestCase {
                $msg = new Message( 'parentheses' );
                $msg->rawParams( '<a>foo</a>' );
                $msg->title( Title::newFromText( 'Testing' ) );
-               $this->assertEquals( '(<a>foo</a>)', $msg->parse(), 'Sanity check' );
+               $this->assertSame( '(<a>foo</a>)', $msg->parse(), 'Sanity check' );
                $msg = unserialize( serialize( $msg ) );
-               $this->assertEquals( '(<a>foo</a>)', $msg->parse() );
+               $this->assertSame( '(<a>foo</a>)', $msg->parse() );
                $title = TestingAccessWrapper::newFromObject( $msg )->title;
                $this->assertInstanceOf( 'Title', $title );
-               $this->assertEquals( 'Testing', $title->getFullText() );
+               $this->assertSame( 'Testing', $title->getFullText() );
 
                $msg = new Message( 'mainpage' );
                $msg->inLanguage( 'de' );
-               $this->assertEquals( 'Hauptseite', $msg->plain(), 'Sanity check' );
+               $this->assertSame( 'Hauptseite', $msg->plain(), 'Sanity check' );
                $msg = unserialize( serialize( $msg ) );
-               $this->assertEquals( 'Hauptseite', $msg->plain() );
+               $this->assertSame( 'Hauptseite', $msg->plain() );
        }
 
        /**
@@ -651,4 +832,3 @@ class MessageTest extends MediaWikiLangTestCase {
                ];
        }
 }
-