feature symfony#29121 [FrameworkBundle][Translation] Add support for Translator paths, Twig paths and Translator aware services paths in commands (yceruto)

This PR was merged into the 4.3-dev branch. Discussion ---------- [FrameworkBundle][Translation] Add support for Translator paths, Twig paths and Translator aware services paths in commands | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony#29085, symfony#29633, symfony#17739 | License | MIT | Doc PR | TODO Add custom (also common) Twig and Translation paths to the translation commands: * Custom directories configured in `twig.paths`. * Custom directories configured in `translator.paths` * The `Resources/translations/` directory of `Validation` component (if installed). * The `Resources/translations/` directory of `Form` component (if installed). * The `Resources/translations/` directory of Security Core component (if installed). Commits ------- 31d7a09 Add support for translator paths and twig paths in translation commands

Author: fabpot

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -15,6 +15,7 @@ CHANGELOG
  * Added information about deprecated aliases in `debug:autowiring` 
  * Added php ini session options `sid_length` and `sid_bits_per_character` 
  to the `session` section of the configuration
+ * Added support for Translator paths, Twig paths in translation commands.
 
 4.2.0
 -----

src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php

@@ -50,11 +50,13 @@ class TranslationDebugCommand extends Command
  private $extractor;
  private $defaultTransPath;
  private $defaultViewsPath;
+ private $transPaths;
+ private $viewsPaths;
 
  /**
  * @param TranslatorInterface $translator
  */
- public function __construct($translator, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultTransPath = null, string $defaultViewsPath = null)
+ public function __construct($translator, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultTransPath = null, string $defaultViewsPath = null, array $transPaths = [], array $viewsPaths = [])
  {
  if (!$translator instanceof LegacyTranslatorInterface && !$translator instanceof TranslatorInterface) {
  throw new \TypeError(sprintf('Argument 1 passed to %s() must be an instance of %s, %s given.', __METHOD__, TranslatorInterface::class, \is_object($translator) ? \get_class($translator) : \gettype($translator)));
@@ -66,6 +68,8 @@ public function __construct($translator, TranslationReaderInterface $reader, Ext
  $this->extractor = $extractor;
  $this->defaultTransPath = $defaultTransPath;
  $this->defaultViewsPath = $defaultViewsPath;
+ $this->transPaths = $transPaths;
+ $this->viewsPaths = $viewsPaths;
  }
 
  /**
@@ -131,7 +135,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
  $rootDir = $kernel->getContainer()->getParameter('kernel.root_dir');
 
  // Define Root Paths
- $transPaths = [];
+ $transPaths = $this->transPaths;
  if (is_dir($dir = $rootDir.'/Resources/translations')) {
  if ($dir !== $this->defaultTransPath) {
  $notice = sprintf('Storing translations in the "%s" directory is deprecated since Symfony 4.2, ', $dir);
@@ -142,7 +146,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
  if ($this->defaultTransPath) {
  $transPaths[] = $this->defaultTransPath;
  }
- $viewsPaths = [];
+ $viewsPaths = $this->viewsPaths;
  if (is_dir($dir = $rootDir.'/Resources/views')) {
  if ($dir !== $this->defaultViewsPath) {
  $notice = sprintf('Storing templates in the "%s" directory is deprecated since Symfony 4.2, ', $dir);

src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php

@@ -44,8 +44,10 @@ class TranslationUpdateCommand extends Command
  private $defaultLocale;
  private $defaultTransPath;
  private $defaultViewsPath;
+ private $transPaths;
+ private $viewsPaths;
 
- public function __construct(TranslationWriterInterface $writer, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultLocale, string $defaultTransPath = null, string $defaultViewsPath = null)
+ public function __construct(TranslationWriterInterface $writer, TranslationReaderInterface $reader, ExtractorInterface $extractor, string $defaultLocale, string $defaultTransPath = null, string $defaultViewsPath = null, array $transPaths = [], array $viewsPaths = [])
  {
  parent::__construct();
 
@@ -55,6 +57,8 @@ public function __construct(TranslationWriterInterface $writer, TranslationReade
  $this->defaultLocale = $defaultLocale;
  $this->defaultTransPath = $defaultTransPath;
  $this->defaultViewsPath = $defaultViewsPath;
+ $this->transPaths = $transPaths;
+ $this->viewsPaths = $viewsPaths;
  }
 
  /**
@@ -122,7 +126,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
  $rootDir = $kernel->getContainer()->getParameter('kernel.root_dir');
 
  // Define Root Paths
- $transPaths = [];
+ $transPaths = $this->transPaths;
  if (is_dir($dir = $rootDir.'/Resources/translations')) {
  if ($dir !== $this->defaultTransPath) {
  $notice = sprintf('Storing translations in the "%s" directory is deprecated since Symfony 4.2, ', $dir);
@@ -133,7 +137,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
  if ($this->defaultTransPath) {
  $transPaths[] = $this->defaultTransPath;
  }
- $viewsPaths = [];
+ $viewsPaths = $this->viewsPaths;
  if (is_dir($dir = $rootDir.'/Resources/views')) {
  if ($dir !== $this->defaultViewsPath) {
  $notice = sprintf('Storing templates in the "%s" directory is deprecated since Symfony 4.2, ', $dir);

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -1023,20 +1023,21 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
 
  // Discover translation directories
  $dirs = [];
+ $transPaths = [];
  if (class_exists('Symfony\Component\Validator\Validation')) {
  $r = new \ReflectionClass('Symfony\Component\Validator\Validation');
 
- $dirs[] = \dirname($r->getFileName()).'/Resources/translations';
+ $dirs[] = $transPaths[] = \dirname($r->getFileName()).'/Resources/translations';
  }
  if (class_exists('Symfony\Component\Form\Form')) {
  $r = new \ReflectionClass('Symfony\Component\Form\Form');
 
- $dirs[] = \dirname($r->getFileName()).'/Resources/translations';
+ $dirs[] = $transPaths[] = \dirname($r->getFileName()).'/Resources/translations';
  }
  if (class_exists('Symfony\Component\Security\Core\Exception\AuthenticationException')) {
  $r = new \ReflectionClass('Symfony\Component\Security\Core\Exception\AuthenticationException');
 
- $dirs[] = \dirname(\dirname($r->getFileName())).'/Resources/translations';
+ $dirs[] = $transPaths[] = \dirname(\dirname($r->getFileName())).'/Resources/translations';
  }
  $defaultDir = $container->getParameterBag()->resolveValue($config['default_path']);
  $rootDir = $container->getParameter('kernel.root_dir');
@@ -1053,11 +1054,13 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
 
  foreach ($config['paths'] as $dir) {
  if ($container->fileExists($dir)) {
- $dirs[] = $dir;
+ $dirs[] = $transPaths[] = $dir;
  } else {
  throw new \UnexpectedValueException(sprintf('%s defined in translator.paths does not exist or is not a directory', $dir));
  }
  }
+ $container->getDefinition('console.command.translation_debug')->replaceArgument(5, $transPaths);
+ $container->getDefinition('console.command.translation_update')->replaceArgument(6, $transPaths);
 
  if ($container->fileExists($defaultDir)) {
  $dirs[] = $defaultDir;

src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php

@@ -100,7 +100,9 @@ public function build(ContainerBuilder $container)
  $container->addCompilerPass(new AddAnnotationsCachedReaderPass(), PassConfig::TYPE_AFTER_REMOVING, -255);
  $this->addCompilerPassIfExists($container, AddValidatorInitializersPass::class);
  $this->addCompilerPassIfExists($container, AddConsoleCommandPass::class, PassConfig::TYPE_BEFORE_REMOVING);
- $this->addCompilerPassIfExists($container, TranslatorPass::class);
+ // must be registered as late as possible to get access to all Twig paths registered in
+ // twig.template_iterator definition
+ $this->addCompilerPassIfExists($container, TranslatorPass::class, PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);
  $container->addCompilerPass(new LoggingTranslatorPass());
  $container->addCompilerPass(new AddExpressionLanguageProvidersPass(false));
  $this->addCompilerPassIfExists($container, TranslationExtractorPass::class);

src/Symfony/Bundle/FrameworkBundle/Resources/config/console.xml

@@ -101,6 +101,8 @@
  <argument type="service" id="translation.extractor" />
  <argument>%translator.default_path%</argument>
  <argument /> <!-- %twig.default_path% -->
+ <argument type="collection" /> <!-- Translator paths -->
+ <argument type="collection" /> <!-- Twig paths -->
  <tag name="console.command" command="debug:translation" />
  </service>
 
@@ -111,6 +113,8 @@
  <argument>%kernel.default_locale%</argument>
  <argument>%translator.default_path%</argument>
  <argument /> <!-- %twig.default_path% -->
+ <argument type="collection" /> <!-- Translator paths -->
+ <argument type="collection" /> <!-- Twig paths -->
  <tag name="console.command" command="translation:update" />
  </service>
 

src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationDebugCommandTest.php

@@ -90,7 +90,7 @@ public function testDebugDefaultRootDirectory()
  $this->fs->mkdir($this->translationDir.'/translations');
  $this->fs->mkdir($this->translationDir.'/templates');
 
- $tester = $this->createCommandTester(['foo' => 'foo'], ['bar' => 'bar']);
+ $tester = $this->createCommandTester(['foo' => 'foo'], ['bar' => 'bar'], null, [$this->translationDir.'/trans'], [$this->translationDir.'/views']);
  $tester->execute(['locale' => 'en']);
 
  $this->assertRegExp('/missing/', $tester->getDisplay());
@@ -145,7 +145,7 @@ protected function tearDown()
  /**
  * @return CommandTester
  */
- private function createCommandTester($extractedMessages = [], $loadedMessages = [], $kernel = null)
+ private function createCommandTester($extractedMessages = [], $loadedMessages = [], $kernel = null, array $transPaths = [], array $viewsPaths = [])
  {
  $translator = $this->getMockBuilder('Symfony\Component\Translation\Translator')
  ->disableOriginalConstructor()
@@ -207,7 +207,7 @@ private function createCommandTester($extractedMessages = [], $loadedMessages =
  ->method('getContainer')
  ->will($this->returnValue($container));
 
- $command = new TranslationDebugCommand($translator, $loader, $extractor, $this->translationDir.'/translations', $this->translationDir.'/templates');
+ $command = new TranslationDebugCommand($translator, $loader, $extractor, $this->translationDir.'/translations', $this->translationDir.'/templates', $transPaths, $viewsPaths);
 
  $application = new Application($kernel);
  $application->add($command);

src/Symfony/Bundle/FrameworkBundle/Tests/Command/TranslationUpdateCommandTest.php

@@ -39,7 +39,7 @@ public function testDumpMessagesAndCleanInRootDirectory()
  $this->fs->mkdir($this->translationDir.'/translations');
  $this->fs->mkdir($this->translationDir.'/templates');
 
- $tester = $this->createCommandTester(['messages' => ['foo' => 'foo']]);
+ $tester = $this->createCommandTester(['messages' => ['foo' => 'foo']], [], null, [$this->translationDir.'/trans'], [$this->translationDir.'/views']);
  $tester->execute(['command' => 'translation:update', 'locale' => 'en', '--dump-messages' => true, '--clean' => true]);
  $this->assertRegExp('/foo/', $tester->getDisplay());
  $this->assertRegExp('/1 message was successfully extracted/', $tester->getDisplay());
@@ -121,7 +121,7 @@ protected function tearDown()
  /**
  * @return CommandTester
  */
- private function createCommandTester($extractedMessages = [], $loadedMessages = [], HttpKernel\KernelInterface $kernel = null)
+ private function createCommandTester($extractedMessages = [], $loadedMessages = [], HttpKernel\KernelInterface $kernel = null, array $transPaths = [], array $viewsPaths = [])
  {
  $translator = $this->getMockBuilder('Symfony\Component\Translation\Translator')
  ->disableOriginalConstructor()
@@ -197,7 +197,7 @@ private function createCommandTester($extractedMessages = [], $loadedMessages =
  ->method('getContainer')
  ->will($this->returnValue($container));
 
- $command = new TranslationUpdateCommand($writer, $loader, $extractor, 'en', $this->translationDir.'/translations', $this->translationDir.'/templates');
+ $command = new TranslationUpdateCommand($writer, $loader, $extractor, 'en', $this->translationDir.'/translations', $this->translationDir.'/templates', $transPaths, $viewsPaths);
 
  $application = new Application($kernel);
  $application->add($command);

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/DependencyInjection/TranslationDebugPass.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * Remove in Symfony 5.0 when the templates directory deprecation is gone.
+ */
+class TranslationDebugPass implements CompilerPassInterface
+{
+ public function process(ContainerBuilder $container)
+ {
+ if ($container->hasDefinition('console.command.translation_debug')) {
+ // skipping the /Resources/views path deprecation
+ $container->getDefinition('console.command.translation_debug')
+ ->setArgument(4, '%kernel.project_dir%/Resources/views');
+ }
+ }
+}

src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/TestBundle.php

@@ -13,6 +13,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection\AnnotationReaderPass;
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection\Config\CustomConfig;
+use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection\TranslationDebugPass;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -29,5 +30,6 @@ public function build(ContainerBuilder $container)
  $extension->setCustomConfig(new CustomConfig());
 
  $container->addCompilerPass(new AnnotationReaderPass(), PassConfig::TYPE_AFTER_REMOVING);
+ $container->addCompilerPass(new TranslationDebugPass());
  }
 }