LocaleTest.php 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. <?php
  2. /**
  3. * Lithium: the most rad php framework
  4. *
  5. * @copyright Copyright 2013, Union of RAD (http://union-of-rad.org)
  6. * @license http://opensource.org/licenses/bsd-license.php The BSD License
  7. */
  8. namespace lithium\tests\cases\g11n;
  9. use lithium\g11n\Locale;
  10. use lithium\action\Request as ActionRequest;
  11. use lithium\console\Request as ConsoleRequest;
  12. class LocaleTest extends \lithium\test\Unit {
  13. /**
  14. * Tests composing of a locale from tags.
  15. */
  16. public function testCompose() {
  17. $result = Locale::compose(array('language' => 'en'));
  18. $this->assertEqual('en', $result);
  19. $result = Locale::compose(array('language' => 'en', 'territory' => 'US'));
  20. $this->assertEqual('en_US', $result);
  21. $result = Locale::compose(array('language' => 'EN', 'territory' => 'US'));
  22. $this->assertEqual('EN_US', $result);
  23. $result = Locale::compose(array(
  24. 'language' => 'zh',
  25. 'script' => 'Hans',
  26. 'territory' => 'HK',
  27. 'variant' => 'REVISED'
  28. ));
  29. $this->assertEqual('zh_Hans_HK_REVISED', $result);
  30. $result = Locale::compose(array(
  31. 'territory' => 'HK',
  32. 'language' => 'zh',
  33. 'script' => 'Hans'
  34. ));
  35. $this->assertEqual('zh_Hans_HK', $result);
  36. $this->assertNull(Locale::compose(array()));
  37. }
  38. /**
  39. * Tests parsing of locales formatted strictly according to
  40. * the definition of the unicode locale identifier.
  41. */
  42. public function testDecomposeStrict() {
  43. $expected = array('language' => 'en');
  44. $this->assertEqual($expected, Locale::decompose('en'));
  45. $expected = array('language' => 'en', 'territory' => 'US');
  46. $this->assertEqual($expected, Locale::decompose('en_US'));
  47. $expected = array(
  48. 'language' => 'en',
  49. 'territory' => 'US',
  50. 'variant' => 'POSIX'
  51. );
  52. $this->assertEqual($expected, Locale::decompose('en_US_POSIX'));
  53. $expected = array('language' => 'kpe', 'territory' => 'GN');
  54. $this->assertEqual($expected, Locale::decompose('kpe_GN'));
  55. $expected = array('language' => 'zh', 'script' => 'Hans');
  56. $this->assertEqual($expected, Locale::decompose('zh_Hans'));
  57. $expected = array(
  58. 'language' => 'zh',
  59. 'script' => 'Hans',
  60. 'territory' => 'HK'
  61. );
  62. $this->assertEqual($expected, Locale::decompose('zh_Hans_HK'));
  63. $expected = array(
  64. 'language' => 'zh',
  65. 'script' => 'Hans',
  66. 'territory' => 'HK',
  67. 'variant' => 'REVISED'
  68. );
  69. $this->assertEqual($expected, Locale::decompose('zh_Hans_HK_REVISED'));
  70. }
  71. /**
  72. * Tests parsing of locales formatted loosely according to
  73. * the definition of the unicode locale identifier.
  74. */
  75. public function testDecomposeLoose() {
  76. $expected = array('language' => 'en', 'territory' => 'US');
  77. $this->assertEqual($expected, Locale::decompose('en-US'));
  78. $expected = array(
  79. 'language' => 'en',
  80. 'territory' => 'US',
  81. 'variant' => 'posiX'
  82. );
  83. $this->assertEqual($expected, Locale::decompose('en_US-posiX'));
  84. $expected = array('language' => 'kpe', 'territory' => 'gn');
  85. $this->assertEqual($expected, Locale::decompose('kpe_gn'));
  86. $expected = array(
  87. 'language' => 'ZH',
  88. 'script' => 'HANS',
  89. 'territory' => 'HK',
  90. 'variant' => 'REVISED'
  91. );
  92. $this->assertEqual($expected, Locale::decompose('ZH-HANS-HK_REVISED'));
  93. }
  94. /**
  95. * Tests failing of parsing invalid locales.
  96. */
  97. public function testDecomposeFail() {
  98. $this->expectException();
  99. try {
  100. Locale::decompose('deee_DE');
  101. $this->assert(false);
  102. } catch (Exception $e) {
  103. $this->assert(true);
  104. }
  105. $this->expectException();
  106. try {
  107. Locale::decompose('ZH-HANS-HK_REVISED_INVALID');
  108. $this->assert(false);
  109. } catch (Exception $e) {
  110. $this->assert(true);
  111. }
  112. }
  113. /**
  114. * Tests parsing of locales using shortcut methods.
  115. */
  116. public function testDecomposeUsingShortcutMethods() {
  117. $this->assertEqual('zh', Locale::language('zh_Hans_HK_REVISED'));
  118. $this->assertEqual('Hans', Locale::script('zh_Hans_HK_REVISED'));
  119. $this->assertEqual('HK', Locale::territory('zh_Hans_HK_REVISED'));
  120. $this->assertEqual('REVISED', Locale::variant('zh_Hans_HK_REVISED'));
  121. $this->assertNull(Locale::script('zh_HK'));
  122. $this->assertNull(Locale::territory('zh'));
  123. $this->assertNull(Locale::variant('zh'));
  124. $this->expectException();
  125. try {
  126. Locale::notAValidTag('zh_Hans_HK_REVISED');
  127. $this->assert(false);
  128. } catch (Exception $e) {
  129. $this->assert(true);
  130. }
  131. }
  132. /**
  133. * Tests if the ouput of `compose()` can be used as the input for `decompose()`
  134. * and vice versa.
  135. */
  136. public function testComposeDecomposeCompose() {
  137. $data = array('language' => 'en');
  138. $result = Locale::compose(Locale::decompose(Locale::compose($data)));
  139. $this->assertEqual('en', $result);
  140. $data = array('language' => 'en', 'territory' => 'US');
  141. $result = Locale::compose(Locale::decompose(Locale::compose($data)));
  142. $this->assertEqual('en_US', $result);
  143. $data = array(
  144. 'language' => 'zh',
  145. 'script' => 'Hans',
  146. 'territory' => 'HK',
  147. 'variant' => 'REVISED'
  148. );
  149. $result = Locale::compose(Locale::decompose(Locale::compose($data)));
  150. $this->assertEqual('zh_Hans_HK_REVISED', $result);
  151. }
  152. /**
  153. * Tests cascading of locales.
  154. */
  155. public function testCascade() {
  156. $this->assertEqual(array('root'), Locale::cascade('root'));
  157. $this->assertEqual(array('en', 'root'), Locale::cascade('en'));
  158. $this->assertEqual(array('en_US', 'en', 'root'), Locale::cascade('en_US'));
  159. $expected = array('zh_HK_REVISED', 'zh_HK', 'zh', 'root');
  160. $this->assertEqual($expected, Locale::cascade('zh_HK_REVISED'));
  161. $expected = array('zh_Hans_HK', 'zh_Hans', 'zh', 'root');
  162. $this->assertEqual($expected, Locale::cascade('zh_Hans_HK'));
  163. $expected = array('zh_Hans_HK_REVISED', 'zh_Hans_HK', 'zh_Hans', 'zh', 'root');
  164. $this->assertEqual($expected, Locale::cascade('zh_Hans_HK_REVISED'));
  165. }
  166. /**
  167. * Tests formatting of locale.
  168. */
  169. public function testCanonicalize() {
  170. $this->assertEqual('en_US', Locale::canonicalize('en-US'));
  171. $this->assertEqual('en_US_POSIX', Locale::canonicalize('en_US-posiX'));
  172. $this->assertEqual('kpe_GN', Locale::canonicalize('kpe_gn'));
  173. $this->assertEqual('zh_Hans_HK_REVISED', Locale::canonicalize('ZH-HANS-HK_REVISED'));
  174. }
  175. public function testLookup() {
  176. $result = Locale::lookup(
  177. array('zh_Hans_REVISED', 'zh_Hans_HK', 'zh', 'zh_Hans'), 'zh_Hans_HK_REVISED'
  178. );
  179. $this->assertEqual('zh_Hans_HK', $result);
  180. $result = Locale::lookup(
  181. array('zh', 'zh_Hans_REVISED', 'zh_Hans_HK', 'zh_Hans'),
  182. 'zh_Hans_HK_REVISED'
  183. );
  184. $this->assertEqual('zh_Hans_HK', $result);
  185. $result = Locale::lookup(
  186. array('en', 'en_UK', 'en_US', 'es', 'es_AR'),
  187. 'en'
  188. );
  189. $this->assertEqual('en', $result);
  190. $result = Locale::lookup(
  191. array('en', 'en_UK', 'en_US', 'es', 'es_AR'),
  192. 'en_UK'
  193. );
  194. $this->assertEqual('en_UK', $result);
  195. $result = Locale::lookup(
  196. array('en', 'en_UK', 'en_US', 'es', 'es_AR'),
  197. 'es_ES'
  198. );
  199. $this->assertEqual('es', $result);
  200. $result = Locale::lookup(
  201. array('en', 'en_UK', 'en_US', 'es_AR'),
  202. 'es_ES'
  203. );
  204. $this->assertEqual('es_AR', $result);
  205. }
  206. public function testPreferredFromActionRequest() {
  207. $request = new ActionRequest(array(
  208. 'env' => array('HTTP_ACCEPT_LANGUAGE' => 'da, en-gb;q=0.8, en;q=0.7')
  209. ));
  210. $result = Locale::preferred($request);
  211. $this->assertEqual('da', $result);
  212. $request = new ActionRequest(array('env' => array(
  213. 'HTTP_ACCEPT_LANGUAGE' => 'en-gb;q=0.8, da, en;q=0.7'
  214. )));
  215. $result = Locale::preferred($request);
  216. $this->assertEqual('da', $result);
  217. $request = new ActionRequest(array('env' => array(
  218. 'HTTP_ACCEPT_LANGUAGE' => 'en-gb;q=0.8, en;q=0.7'
  219. )));
  220. $result = Locale::preferred($request);
  221. $this->assertEqual('en_GB', $result);
  222. $request = new ActionRequest(array('env' => array(
  223. 'HTTP_ACCEPT_LANGUAGE' => 'fr;q=1, en-gb;q=0.8, en;q=0.7'
  224. )));
  225. $result = Locale::preferred($request);
  226. $request = new ActionRequest(array('env' => array(
  227. 'HTTP_ACCEPT_LANGUAGE' => 'fr,en,it,es;q=0.7'
  228. )));
  229. $result = Locale::preferred($request, array('en', 'fr', 'it'));
  230. $this->assertEqual('fr', $result);
  231. $request = new ActionRequest(array(
  232. 'env' => array('HTTP_ACCEPT_LANGUAGE' => 'da')
  233. ));
  234. $result = Locale::preferred($request);
  235. $this->assertEqual('da', $result);
  236. }
  237. public function testPreferredFromConsoleRequestLcAll() {
  238. $request = new ConsoleRequest(array('env' => array('LC_ALL' => 'es_ES@euro')));
  239. $result = Locale::preferred($request);
  240. $this->assertEqual('es_ES', $result);
  241. $request = new ConsoleRequest(array('env' => array('LC_ALL' => 'en_US.UTF-8')));
  242. $result = Locale::preferred($request);
  243. $this->assertEqual('en_US', $result);
  244. $request = new ConsoleRequest(array('env' => array('LC_ALL' => 'en_US')));
  245. $result = Locale::preferred($request);
  246. $this->assertEqual('en_US', $result);
  247. }
  248. public function testPreferredFromConsoleRequestLanguage() {
  249. $request = new ConsoleRequest(array('env' => array('LANGUAGE' => 'sv_SE:nn_NO:de_DE')));
  250. $result = Locale::preferred($request);
  251. $this->assertEqual('sv_SE', $result);
  252. }
  253. public function testPreferredFromConsoleRequestLang() {
  254. $request = new ConsoleRequest(array('env' => array(
  255. 'LANG' => 'es_ES@euro', 'LANGUAGE' => null, 'LC_ALL' => null
  256. )));
  257. $result = Locale::preferred($request);
  258. $this->assertEqual('es_ES', $result);
  259. }
  260. public function testPreferredFromConsoleRequestPrecedence() {
  261. $request = new ConsoleRequest(array('env' => array(
  262. 'LANGUAGE' => 'da_DK:ja_JP',
  263. 'LC_ALL' => 'fr_CA',
  264. 'LANG' => 'de_DE'
  265. )));
  266. $result = Locale::preferred($request);
  267. $this->assertEqual('da_DK', $result);
  268. $request = new ConsoleRequest(array(
  269. 'env' => array('LC_ALL' => 'fr_CA', 'LANG' => 'de_DE')
  270. ));
  271. $result = Locale::preferred($request);
  272. $this->assertEqual('fr_CA', $result);
  273. }
  274. public function testPreferredFromConsoleRequestEmptyLocales() {
  275. $request = new ConsoleRequest(array(
  276. 'env' => array('LC_ALL' => 'C', 'LANG' => null, 'LANGUAGE' => null)
  277. ));
  278. $this->assertNull(Locale::preferred($request));
  279. $request = new ConsoleRequest(array(
  280. 'env' => array('LC_ALL' => 'POSIX', 'LANG' => null, 'LANGUAGE' => null)
  281. ));
  282. $this->assertNull(Locale::preferred($request));
  283. $request = new ConsoleRequest(array(
  284. 'env' => array('LC_ALL' => '', 'LANG' => null, 'LANGUAGE' => null)
  285. ));
  286. $this->assertNull(Locale::preferred($request));
  287. }
  288. public function testPreferredAvailableNegotiation() {
  289. $result = Locale::preferred(
  290. array('nl_NL', 'nl_BE', 'nl', 'en_US', 'en'),
  291. array('en', 'en_US', 'nl_BE')
  292. );
  293. $this->assertEqual('nl_BE', $result);
  294. $result = Locale::preferred(
  295. array('da', 'en_GB', 'en'),
  296. array('da', 'en_GB', 'en')
  297. );
  298. $this->assertEqual('da', $result);
  299. $result = Locale::preferred(
  300. array('da', 'en_GB', 'en'),
  301. array('en', 'en_GB', 'da')
  302. );
  303. $this->assertEqual('da', $result);
  304. $result = Locale::preferred(
  305. array('da', 'en_GB', 'en'),
  306. array('en_GB', 'en')
  307. );
  308. $this->assertEqual('en_GB', $result);
  309. $result = Locale::preferred(
  310. array('da_DK', 'en_GB', 'en'),
  311. array('da', 'en_GB', 'en')
  312. );
  313. $this->assertEqual('da', $result);
  314. $result = Locale::preferred(
  315. array('zh_Hans_REVISED', 'zh_Hans_HK', 'zh', 'en'),
  316. array('zh_Hans_HK_REVISED', 'zh_Hans_HK', 'zh', 'en')
  317. );
  318. $this->assertEqual('zh', $result);
  319. $result = Locale::preferred(
  320. array('es_ES', 'en'),
  321. array('da', 'en_GB', 'en', 'es_AR')
  322. );
  323. $this->assertEqual('es_AR', $result);
  324. }
  325. /**
  326. * When the Accept-Language contains `*;q=0.01` it's been seen as `q` and
  327. * raises an exception.
  328. *
  329. * @see https://github.com/UnionOfRAD/lithium/issues/386
  330. */
  331. public function testPreferredStarWithQ() {
  332. $available = array('fr', 'de');
  333. $yandex = 'ru, uk;q=0.8, be;q=0.8, en;q=0.7, *;q=0.01';
  334. $request = new ActionRequest(array(
  335. 'env' => array('HTTP_ACCEPT_LANGUAGE' => $yandex)
  336. ));
  337. $result = Locale::preferred($request, $available);
  338. $this->assertNull($result);
  339. $exabot = 'en;q=0.9,*;q=0.8';
  340. $request = new ActionRequest(array(
  341. 'env' => array('HTTP_ACCEPT_LANGUAGE' => $exabot)
  342. ));
  343. $result = Locale::preferred($request, $available);
  344. $this->assertNull($result);
  345. }
  346. /**
  347. * When the Accept-Language is empty, it should return `null`.
  348. *
  349. * @see https://github.com/UnionOfRAD/lithium/issues/386
  350. */
  351. public function testPreferredEmpty() {
  352. $available = array('fr', 'de');
  353. $request = new ActionRequest(array(
  354. 'env' => array('HTTP_ACCEPT_LANGUAGE' => '')
  355. ));
  356. $result = Locale::preferred($request, $available);
  357. $this->assertNull($result);
  358. }
  359. /**
  360. * A random Firefox 4 sent us this Accept-Language header which is
  361. * malformed.
  362. *
  363. * @see https://github.com/UnionOfRAD/lithium/issues/386
  364. */
  365. public function testPreferredMalformedContainingChrome() {
  366. $available = array('fr', 'de');
  367. $randomFirefox4 = 'de-DE,de;q=0.7,chrome://global/locale/intl.properties;q=0.3';
  368. $request = new ActionRequest(array(
  369. 'env' => array('HTTP_ACCEPT_LANGUAGE' => $randomFirefox4)
  370. ));
  371. $result = Locale::preferred($request, $available);
  372. $this->assertIdentical('de', $result);
  373. }
  374. /**
  375. * A very strange Accept-Language which might be coming from a proxy, this
  376. * rule `x-ns…` must be ignored.
  377. *
  378. * @see https://github.com/UnionOfRAD/lithium/issues/386
  379. */
  380. public function testPreferredMalformedSquid() {
  381. $available = array('fr', 'de');
  382. $squid = 'fr,fr-fr;q=0.8,en-us;q=0.5,en;q=0.3,x-ns14sRVhG$uNxh';
  383. $request = new ActionRequest(array(
  384. 'env' => array('HTTP_ACCEPT_LANGUAGE' => $squid)
  385. ));
  386. $result = Locale::preferred($request, $available);
  387. $this->assertIdentical('fr', $result);
  388. }
  389. /**
  390. * An Accept-Language coming from a Chrome user which contains an invalid
  391. * item `es-419` causing `preferred` to fail with an exception while it
  392. * should ignored.
  393. *
  394. * @see https://github.com/UnionOfRAD/lithium/issues/386
  395. */
  396. public function testPreferredMalformedSpanish() {
  397. $available = array('fr', 'de');
  398. $chrome = 'es-419,es;q=0.8';
  399. $request = new ActionRequest(array(
  400. 'env' => array('HTTP_ACCEPT_LANGUAGE' => $chrome)
  401. ));
  402. $result = Locale::preferred($request, $available);
  403. $this->assertNull($result);
  404. }
  405. public function testRespondsToParentCall() {
  406. $this->assertTrue(Locale::respondsTo('applyFilter'));
  407. $this->assertFalse(Locale::respondsTo('fooBarBaz'));
  408. }
  409. public function testRespondsToMagic() {
  410. $this->assertTrue(Locale::respondsTo('language'));
  411. $this->assertTrue(Locale::respondsTo('territory'));
  412. $this->assertFalse(Locale::respondsTo('foobar'));
  413. }
  414. }
  415. ?>