TranslatorTest.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Bundle\FrameworkBundle\Tests\Translation;
  11. use PHPUnit\Framework\TestCase;
  12. use Symfony\Bundle\FrameworkBundle\Translation\Translator;
  13. use Symfony\Component\Filesystem\Filesystem;
  14. use Symfony\Component\Translation\MessageCatalogue;
  15. use Symfony\Component\Translation\MessageSelector;
  16. class TranslatorTest extends TestCase
  17. {
  18. protected $tmpDir;
  19. protected function setUp()
  20. {
  21. $this->tmpDir = sys_get_temp_dir().'/sf2_translation';
  22. $this->deleteTmpDir();
  23. }
  24. protected function tearDown()
  25. {
  26. $this->deleteTmpDir();
  27. }
  28. protected function deleteTmpDir()
  29. {
  30. if (!file_exists($dir = $this->tmpDir)) {
  31. return;
  32. }
  33. $fs = new Filesystem();
  34. $fs->remove($dir);
  35. }
  36. public function testTransWithoutCaching()
  37. {
  38. $translator = $this->getTranslator($this->getLoader());
  39. $translator->setLocale('fr');
  40. $translator->setFallbackLocales(array('en', 'es', 'pt-PT', 'pt_BR', 'fr.UTF-8', 'sr@latin'));
  41. $this->assertEquals('foo (FR)', $translator->trans('foo'));
  42. $this->assertEquals('bar (EN)', $translator->trans('bar'));
  43. $this->assertEquals('foobar (ES)', $translator->trans('foobar'));
  44. $this->assertEquals('choice 0 (EN)', $translator->transChoice('choice', 0));
  45. $this->assertEquals('no translation', $translator->trans('no translation'));
  46. $this->assertEquals('foobarfoo (PT-PT)', $translator->trans('foobarfoo'));
  47. $this->assertEquals('other choice 1 (PT-BR)', $translator->transChoice('other choice', 1));
  48. $this->assertEquals('foobarbaz (fr.UTF-8)', $translator->trans('foobarbaz'));
  49. $this->assertEquals('foobarbax (sr@latin)', $translator->trans('foobarbax'));
  50. }
  51. public function testTransWithCaching()
  52. {
  53. // prime the cache
  54. $translator = $this->getTranslator($this->getLoader(), array('cache_dir' => $this->tmpDir));
  55. $translator->setLocale('fr');
  56. $translator->setFallbackLocales(array('en', 'es', 'pt-PT', 'pt_BR', 'fr.UTF-8', 'sr@latin'));
  57. $this->assertEquals('foo (FR)', $translator->trans('foo'));
  58. $this->assertEquals('bar (EN)', $translator->trans('bar'));
  59. $this->assertEquals('foobar (ES)', $translator->trans('foobar'));
  60. $this->assertEquals('choice 0 (EN)', $translator->transChoice('choice', 0));
  61. $this->assertEquals('no translation', $translator->trans('no translation'));
  62. $this->assertEquals('foobarfoo (PT-PT)', $translator->trans('foobarfoo'));
  63. $this->assertEquals('other choice 1 (PT-BR)', $translator->transChoice('other choice', 1));
  64. $this->assertEquals('foobarbaz (fr.UTF-8)', $translator->trans('foobarbaz'));
  65. $this->assertEquals('foobarbax (sr@latin)', $translator->trans('foobarbax'));
  66. // do it another time as the cache is primed now
  67. $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
  68. $loader->expects($this->never())->method('load');
  69. $translator = $this->getTranslator($loader, array('cache_dir' => $this->tmpDir));
  70. $translator->setLocale('fr');
  71. $translator->setFallbackLocales(array('en', 'es', 'pt-PT', 'pt_BR', 'fr.UTF-8', 'sr@latin'));
  72. $this->assertEquals('foo (FR)', $translator->trans('foo'));
  73. $this->assertEquals('bar (EN)', $translator->trans('bar'));
  74. $this->assertEquals('foobar (ES)', $translator->trans('foobar'));
  75. $this->assertEquals('choice 0 (EN)', $translator->transChoice('choice', 0));
  76. $this->assertEquals('no translation', $translator->trans('no translation'));
  77. $this->assertEquals('foobarfoo (PT-PT)', $translator->trans('foobarfoo'));
  78. $this->assertEquals('other choice 1 (PT-BR)', $translator->transChoice('other choice', 1));
  79. $this->assertEquals('foobarbaz (fr.UTF-8)', $translator->trans('foobarbaz'));
  80. $this->assertEquals('foobarbax (sr@latin)', $translator->trans('foobarbax'));
  81. }
  82. public function testTransWithCachingWithInvalidLocale()
  83. {
  84. $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
  85. $translator = $this->getTranslator($loader, array('cache_dir' => $this->tmpDir), 'loader', '\Symfony\Bundle\FrameworkBundle\Tests\Translation\TranslatorWithInvalidLocale');
  86. $translator->setLocale('invalid locale');
  87. $this->{method_exists($this, $_ = 'expectException') ? $_ : 'setExpectedException'}('\InvalidArgumentException');
  88. $translator->trans('foo');
  89. }
  90. public function testLoadResourcesWithoutCaching()
  91. {
  92. $loader = new \Symfony\Component\Translation\Loader\YamlFileLoader();
  93. $resourceFiles = array(
  94. 'fr' => array(
  95. __DIR__.'/../Fixtures/Resources/translations/messages.fr.yml',
  96. ),
  97. );
  98. $translator = $this->getTranslator($loader, array('resource_files' => $resourceFiles), 'yml');
  99. $translator->setLocale('fr');
  100. $this->assertEquals('répertoire', $translator->trans('folder'));
  101. }
  102. public function testGetDefaultLocale()
  103. {
  104. $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface')->getMock();
  105. $container
  106. ->expects($this->once())
  107. ->method('getParameter')
  108. ->with('kernel.default_locale')
  109. ->will($this->returnValue('en'))
  110. ;
  111. $translator = new Translator($container, new MessageSelector());
  112. $this->assertSame('en', $translator->getLocale());
  113. }
  114. /** @dataProvider getDebugModeAndCacheDirCombinations */
  115. public function testResourceFilesOptionLoadsBeforeOtherAddedResources($debug, $enableCache)
  116. {
  117. $someCatalogue = $this->getCatalogue('some_locale', array());
  118. $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
  119. $loader->expects($this->at(0))
  120. ->method('load')
  121. /* The "messages.some_locale.loader" is passed via the resource_file option and shall be loaded first */
  122. ->with('messages.some_locale.loader', 'some_locale', 'messages')
  123. ->willReturn($someCatalogue);
  124. $loader->expects($this->at(1))
  125. ->method('load')
  126. /* This resource is added by an addResource() call and shall be loaded after the resource_files */
  127. ->with('second_resource.some_locale.loader', 'some_locale', 'messages')
  128. ->willReturn($someCatalogue);
  129. $options = array(
  130. 'resource_files' => array('some_locale' => array('messages.some_locale.loader')),
  131. 'debug' => $debug,
  132. );
  133. if ($enableCache) {
  134. $options['cache_dir'] = $this->tmpDir;
  135. }
  136. /** @var Translator $translator */
  137. $translator = $this->createTranslator($loader, $options);
  138. $translator->addResource('loader', 'second_resource.some_locale.loader', 'some_locale', 'messages');
  139. $translator->trans('some_message', array(), null, 'some_locale');
  140. }
  141. public function getDebugModeAndCacheDirCombinations()
  142. {
  143. return array(
  144. array(false, false),
  145. array(true, false),
  146. array(false, true),
  147. array(true, true),
  148. );
  149. }
  150. protected function getCatalogue($locale, $messages, $resources = array())
  151. {
  152. $catalogue = new MessageCatalogue($locale);
  153. foreach ($messages as $key => $translation) {
  154. $catalogue->set($key, $translation);
  155. }
  156. foreach ($resources as $resource) {
  157. $catalogue->addResource($resource);
  158. }
  159. return $catalogue;
  160. }
  161. protected function getLoader()
  162. {
  163. $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
  164. $loader
  165. ->expects($this->at(0))
  166. ->method('load')
  167. ->will($this->returnValue($this->getCatalogue('fr', array(
  168. 'foo' => 'foo (FR)',
  169. ))))
  170. ;
  171. $loader
  172. ->expects($this->at(1))
  173. ->method('load')
  174. ->will($this->returnValue($this->getCatalogue('en', array(
  175. 'foo' => 'foo (EN)',
  176. 'bar' => 'bar (EN)',
  177. 'choice' => '{0} choice 0 (EN)|{1} choice 1 (EN)|]1,Inf] choice inf (EN)',
  178. ))))
  179. ;
  180. $loader
  181. ->expects($this->at(2))
  182. ->method('load')
  183. ->will($this->returnValue($this->getCatalogue('es', array(
  184. 'foobar' => 'foobar (ES)',
  185. ))))
  186. ;
  187. $loader
  188. ->expects($this->at(3))
  189. ->method('load')
  190. ->will($this->returnValue($this->getCatalogue('pt-PT', array(
  191. 'foobarfoo' => 'foobarfoo (PT-PT)',
  192. ))))
  193. ;
  194. $loader
  195. ->expects($this->at(4))
  196. ->method('load')
  197. ->will($this->returnValue($this->getCatalogue('pt_BR', array(
  198. 'other choice' => '{0} other choice 0 (PT-BR)|{1} other choice 1 (PT-BR)|]1,Inf] other choice inf (PT-BR)',
  199. ))))
  200. ;
  201. $loader
  202. ->expects($this->at(5))
  203. ->method('load')
  204. ->will($this->returnValue($this->getCatalogue('fr.UTF-8', array(
  205. 'foobarbaz' => 'foobarbaz (fr.UTF-8)',
  206. ))))
  207. ;
  208. $loader
  209. ->expects($this->at(6))
  210. ->method('load')
  211. ->will($this->returnValue($this->getCatalogue('sr@latin', array(
  212. 'foobarbax' => 'foobarbax (sr@latin)',
  213. ))))
  214. ;
  215. return $loader;
  216. }
  217. protected function getContainer($loader)
  218. {
  219. $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface')->getMock();
  220. $container
  221. ->expects($this->any())
  222. ->method('get')
  223. ->will($this->returnValue($loader))
  224. ;
  225. return $container;
  226. }
  227. public function getTranslator($loader, $options = array(), $loaderFomat = 'loader', $translatorClass = '\Symfony\Bundle\FrameworkBundle\Translation\Translator')
  228. {
  229. $translator = $this->createTranslator($loader, $options, $translatorClass, $loaderFomat);
  230. if ('loader' === $loaderFomat) {
  231. $translator->addResource('loader', 'foo', 'fr');
  232. $translator->addResource('loader', 'foo', 'en');
  233. $translator->addResource('loader', 'foo', 'es');
  234. $translator->addResource('loader', 'foo', 'pt-PT'); // European Portuguese
  235. $translator->addResource('loader', 'foo', 'pt_BR'); // Brazilian Portuguese
  236. $translator->addResource('loader', 'foo', 'fr.UTF-8');
  237. $translator->addResource('loader', 'foo', 'sr@latin'); // Latin Serbian
  238. }
  239. return $translator;
  240. }
  241. public function testWarmup()
  242. {
  243. $loader = new \Symfony\Component\Translation\Loader\YamlFileLoader();
  244. $resourceFiles = array(
  245. 'fr' => array(
  246. __DIR__.'/../Fixtures/Resources/translations/messages.fr.yml',
  247. ),
  248. );
  249. // prime the cache
  250. $translator = $this->getTranslator($loader, array('cache_dir' => $this->tmpDir, 'resource_files' => $resourceFiles), 'yml');
  251. $translator->setFallbackLocales(array('fr'));
  252. $translator->warmup($this->tmpDir);
  253. $loader = $this->getMockBuilder('Symfony\Component\Translation\Loader\LoaderInterface')->getMock();
  254. $loader
  255. ->expects($this->never())
  256. ->method('load');
  257. $translator = $this->getTranslator($loader, array('cache_dir' => $this->tmpDir, 'resource_files' => $resourceFiles), 'yml');
  258. $translator->setLocale('fr');
  259. $translator->setFallbackLocales(array('fr'));
  260. $this->assertEquals('répertoire', $translator->trans('folder'));
  261. }
  262. private function createTranslator($loader, $options, $translatorClass = '\Symfony\Bundle\FrameworkBundle\Translation\Translator', $loaderFomat = 'loader')
  263. {
  264. return new $translatorClass(
  265. $this->getContainer($loader),
  266. new MessageSelector(),
  267. array($loaderFomat => array($loaderFomat)),
  268. $options
  269. );
  270. }
  271. }
  272. class TranslatorWithInvalidLocale extends Translator
  273. {
  274. /**
  275. * {@inheritdoc}
  276. */
  277. public function setLocale($locale)
  278. {
  279. $this->locale = $locale;
  280. }
  281. }