MessageFormatterTest.php 6.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yiiunit\framework\i18n;

use yii\i18n\MessageFormatter;
use yiiunit\TestCase;

/**
 * @author Alexander Makarov <sam@rmcreative.ru>
 * @since 2.0
 * @group i18n
 */
class MessageFormatterTest extends TestCase
{
	const N = 'n';
	const N_VALUE = 42;
	const SUBJECT = 'сабж';
	const SUBJECT_VALUE = 'Answer to the Ultimate Question of Life, the Universe, and Everything';

25 26 27 28 29 30 31
	protected function setUp()
	{
		if (!extension_loaded("intl")) {
			$this->markTestSkipped("intl not installed. Skipping.");
		}
	}

32
	public function patterns()
33
	{
Alexander Makarov committed
34 35
		return [
			[
36 37
				'{'.self::SUBJECT.'} is {'.self::N.', number}', // pattern
				self::SUBJECT_VALUE.' is '.self::N_VALUE, // expected
Alexander Makarov committed
38
				[ // params
39 40
					self::N => self::N_VALUE,
					self::SUBJECT => self::SUBJECT_VALUE,
Alexander Makarov committed
41 42
				]
			],
43

44 45 46 47 48 49 50 51 52
			[
				'{'.self::SUBJECT.'} is {'.self::N.', number, integer}', // pattern
				self::SUBJECT_VALUE.' is '.self::N_VALUE, // expected
				[ // params
					self::N => self::N_VALUE,
					self::SUBJECT => self::SUBJECT_VALUE,
				]
			],

53
			// This one was provided by Aura.Intl. Thanks!
Alexander Makarov committed
54
			[<<<_MSG_
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
{gender_of_host, select,
  female {{num_guests, plural, offset:1
	  =0 {{host} does not give a party.}
	  =1 {{host} invites {guest} to her party.}
	  =2 {{host} invites {guest} and one other person to her party.}
	 other {{host} invites {guest} and # other people to her party.}}}
  male {{num_guests, plural, offset:1
	  =0 {{host} does not give a party.}
	  =1 {{host} invites {guest} to his party.}
	  =2 {{host} invites {guest} and one other person to his party.}
	 other {{host} invites {guest} and # other people to his party.}}}
  other {{num_guests, plural, offset:1
	  =0 {{host} does not give a party.}
	  =1 {{host} invites {guest} to their party.}
	  =2 {{host} invites {guest} and one other person to their party.}
	  other {{host} invites {guest} and # other people to their party.}}}}
71 72 73
_MSG_
				,
				'ralph invites beep and 3 other people to his party.',
Alexander Makarov committed
74
				[
75 76 77 78
					'gender_of_host' => 'male',
					'num_guests' => 4,
					'host' => 'ralph',
					'guest' => 'beep'
Alexander Makarov committed
79 80
				]
			],
81

Alexander Makarov committed
82
			[
83 84
				'{name} is {gender} and {gender, select, female{she} male{he} other{it}} loves Yii!',
				'Alexander is male and he loves Yii!',
Alexander Makarov committed
85
				[
86 87
					'name' => 'Alexander',
					'gender' => 'male',
Alexander Makarov committed
88 89
				],
			],
90

91
			// verify pattern in select does not get replaced
Alexander Makarov committed
92
			[
93 94
				'{name} is {gender} and {gender, select, female{she} male{he} other{it}} loves Yii!',
				'Alexander is male and he loves Yii!',
Alexander Makarov committed
95
				[
96 97 98 99 100 101
					'name' => 'Alexander',
					'gender' => 'male',
					 // following should not be replaced
					'he' => 'wtf',
					'she' => 'wtf',
					'it' => 'wtf',
Alexander Makarov committed
102 103
				]
			],
104

105
			// verify pattern in select message gets replaced
Alexander Makarov committed
106
			[
107 108
				'{name} is {gender} and {gender, select, female{she} male{{he}} other{it}} loves Yii!',
				'Alexander is male and wtf loves Yii!',
Alexander Makarov committed
109
				[
110 111 112 113
					'name' => 'Alexander',
					'gender' => 'male',
					'he' => 'wtf',
					'she' => 'wtf',
Alexander Makarov committed
114 115
				],
			],
116

117
			// some parser specific verifications
Alexander Makarov committed
118
			[
119 120
				'{gender} and {gender, select, female{she} male{{he}} other{it}} loves {nr, number} is {gender}!',
				'male and wtf loves 42 is male!',
Alexander Makarov committed
121
				[
122 123 124 125
					'nr' => 42,
					'gender' => 'male',
					'he' => 'wtf',
					'she' => 'wtf',
Alexander Makarov committed
126 127 128
				],
			],
		];
129 130
	}

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
	public function parsePatterns()
	{
		return [
			[
				self::SUBJECT_VALUE.' is {0, number}', // pattern
				self::SUBJECT_VALUE.' is '.self::N_VALUE, // expected
				[ // params
					0 => self::N_VALUE,
				]
			],

			[
				self::SUBJECT_VALUE.' is {'.self::N.', number}', // pattern
				self::SUBJECT_VALUE.' is '.self::N_VALUE, // expected
				[ // params
					self::N => self::N_VALUE,
				]
			],

			[
				self::SUBJECT_VALUE.' is {'.self::N.', number, integer}', // pattern
				self::SUBJECT_VALUE.' is '.self::N_VALUE, // expected
				[ // params
					self::N => self::N_VALUE,
				]
			],

			[
				"{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree",
				"4,560 monkeys on 123 trees make 37.073 monkeys per tree",
				[
					0 => 4560,
					1 => 123,
					2 => 37.073
				],
				'en_US'
			],

			[
				"{0,number,integer} Affen auf {1,number,integer} Bäumen sind {2,number} Affen pro Baum",
				"4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum",
				[
					0 => 4560,
					1 => 123,
					2 => 37.073
				],
				'de',
			],

			[
				"{monkeyCount,number,integer} monkeys on {trees,number,integer} trees make {monkeysPerTree,number} monkeys per tree",
				"4,560 monkeys on 123 trees make 37.073 monkeys per tree",
				[
					'monkeyCount' => 4560,
					'trees' => 123,
					'monkeysPerTree' => 37.073
				],
				'en_US'
			],

			[
				"{monkeyCount,number,integer} Affen auf {trees,number,integer} Bäumen sind {monkeysPerTree,number} Affen pro Baum",
				"4.560 Affen auf 123 Bäumen sind 37,073 Affen pro Baum",
				[
					'monkeyCount' => 4560,
					'trees' => 123,
					'monkeysPerTree' => 37.073
				],
				'de',
			],
		];
	}

204 205 206
	/**
	 * @dataProvider patterns
	 */
207
	public function testNamedArguments($pattern, $expected, $args)
208
	{
209
		$formatter = new MessageFormatter();
210
		$result = $formatter->format($pattern, $args, 'en_US');
211
		$this->assertEquals($expected, $result, $formatter->getErrorMessage());
212 213
	}

214 215 216 217 218 219 220 221 222 223
	/**
	 * @dataProvider parsePatterns
	 */
	public function testParseNamedArguments($pattern, $expected, $args, $locale = 'en_US')
	{
		$formatter = new MessageFormatter();
		$result = $formatter->parse($pattern, $expected, $locale);
		$this->assertEquals($args, $result, $formatter->getErrorMessage() . ' Pattern: ' . $pattern);
	}

224 225 226 227
	public function testInsufficientArguments()
	{
		$expected = '{'.self::SUBJECT.'} is '.self::N_VALUE;

228
		$formatter = new MessageFormatter();
229
		$result = $formatter->format('{'.self::SUBJECT.'} is {'.self::N.', number}', [
230
			self::N => self::N_VALUE,
231
		], 'en_US');
232

233
		$this->assertEquals($expected, $result, $formatter->getErrorMessage());
234 235 236 237 238
	}

	public function testNoParams()
	{
		$pattern = '{'.self::SUBJECT.'} is '.self::N;
239
		$formatter = new MessageFormatter();
240
		$result = $formatter->format($pattern, [], 'en_US');
241
		$this->assertEquals($pattern, $result, $formatter->getErrorMessage());
242
	}
243
}