Here Comes a New Challenger : FrontendExtractor

More flexible way to handle extraction from other sources than twig or php
willdurand · jeremy-richard · Jun 10, 2016 · Jun 10, 2016 · Jun 10, 2016 · Jun 18, 2016
commit 0ee29c6953b5be8d1dd1625146290e402716cbca
diff --git a/DependencyInjection/BazingaJsTranslationExtension.php b/DependencyInjection/BazingaJsTranslationExtension.php
@@ -44,5 +44,9 @@ public function load(array $configs, ContainerBuilder $container)
             ->replaceArgument(4, $config['default_domain'])
             ->replaceArgument(5, $config['active_locales'])
             ->replaceArgument(6, $config['active_domains']);
+
+        $container
+          ->getDefinition('bazinga.jstranslation.translation_frontend_extractor')
+          ->replaceArgument(1, $config['frontend']);
     }
 }
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -34,6 +34,17 @@ public function getConfigTreeBuilder()
                     ->prototype('scalar')
                     ->end()
                 ->end()
+                ->arrayNode('frontend')
+                  ->arrayPrototype()
+                    ->children()
+                      ->arrayNode('extensions')
+                        ->prototype('scalar')
+                        ->end()
+                      ->end()
+                      ->scalarNode('sequence')->end()
+                    ->end()
+                  ->end()
+                ->end()
             ->end();
 
         return $builder;

diff --git a/Extractor/CoffeeExtractor.php b/Extractor/CoffeeExtractor.php
diff --git a/Extractor/Extractor.php → Extractor/FrontendExtractor.php b/Extractor/Extractor.php → Extractor/FrontendExtractor.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Translation\MessageCatalogue;
 use Symfony\Component\Translation\Extractor\ExtractorInterface;
 
-abstract class Extractor extends AbstractFileExtractor implements ExtractorInterface
+final class FrontendExtractor extends AbstractFileExtractor implements ExtractorInterface
 {
     const FUNCTION_STRING_ARGUMENT_REGEX = '\s?[\'"]([^"\'),]+)[\'"]\s?';
     const REGEX_DELIMITER = '/';
@@ -17,8 +17,11 @@ abstract class Extractor extends AbstractFileExtractor implements ExtractorInter
 
     private $filesystem;
 
-    public function __construct(Filesystem $filesystem) {
-        $this->filesystem = $filesystem;;
+    private $configuration;
+
+    public function __construct(Filesystem $filesystem, array $configuration = []) {
+        $this->filesystem = $filesystem;
+        $this->configuration = $configuration;
     }
 
     /**
@@ -29,7 +32,14 @@ public function extract($resource, MessageCatalogue $catalogue)
         $files = $this->extractFiles($resource);
 
         foreach ($files as $file) {
-            $this->parseMessagesFromContent(file_get_contents($file), $catalogue);
+            foreach ($this->configuration as $configuration)
+            {
+              $pathInfo = pathinfo($file);
+              if (in_array($pathInfo['extension'], $configuration['extensions'], true))
+              {
+                $this->parseMessagesFromContent(file_get_contents($file), $catalogue, $configuration['sequence']);
+              }
+            }
         }
     }
 
@@ -41,9 +51,9 @@ public function setPrefix($prefix)
         $this->prefix = $prefix;
     }
 
-    private function parseMessagesFromContent($fileContent, MessageCatalogue $catalogue)
+    private function parseMessagesFromContent($fileContent, MessageCatalogue $catalogue, $sequence)
     {
-        $messages = $this->getMessagesForSequence($fileContent, $this->sequence);
+        $messages = $this->getMessagesForSequence($fileContent, $sequence);
 
         foreach ($messages as $message) {
             $catalogue->set($message, $this->prefix.$message);
@@ -53,7 +63,10 @@ private function parseMessagesFromContent($fileContent, MessageCatalogue $catalo
     /**
      * @return array
      */
-    abstract protected function getSupportedFileExtensions();
+    protected function getSupportedFileExtensions()
+    {
+      return call_user_func_array('array_merge', array_column($this->configuration, 'extensions'));
+    }
 
     protected function canBeExtracted($file)
     {

diff --git a/Extractor/JsExtractor.php b/Extractor/JsExtractor.php
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -26,13 +26,10 @@
             <argument>%kernel.root_dir%</argument>
             <tag name="console.command" command="bazinga:js-translation:dump" />
         </service>
-        <service id="bazinga.jstranslation.translation_js_extractor" class="Bazinga\Bundle\JsTranslationBundle\Extractor\JsExtractor">
+        <service id="bazinga.jstranslation.translation_frontend_extractor" class="Bazinga\Bundle\JsTranslationBundle\Extractor\FrontendExtractor" public="true">
             <argument type="service" id="filesystem"></argument>
-            <tag name="translation.extractor" alias="js" />
-        </service>
-        <service id="bazinga.jstranslation.translation_coffee_extractor" class="Bazinga\Bundle\JsTranslationBundle\Extractor\CoffeeExtractor">
-            <argument type="service" id="filesystem"></argument>
-            <tag name="translation.extractor" alias="coffee" />
+            <tag name="translation.extractor" alias="frontend" />
+            <argument></argument> <!-- frontend -->
         </service>
     </services>
 </container>
diff --git a/Tests/Extractor/CoffeeExtractorTest.php b/Tests/Extractor/CoffeeExtractorTest.php
diff --git a/Tests/Extractor/AbstractExtractorTest.php → Tests/Extractor/FrontendExtractorTest.php b/Tests/Extractor/AbstractExtractorTest.php → Tests/Extractor/FrontendExtractorTest.php
@@ -2,20 +2,26 @@
 
 namespace Bazinga\JsTranslationBundle\Tests\Extractor;
 
-use PHPUnit\Framework\TestCase;
+use Bazinga\Bundle\JsTranslationBundle\Extractor\FrontendExtractor;
+use Bazinga\Bundle\JsTranslationBundle\Tests\WebTestCase;
 use Symfony\Component\Translation\MessageCatalogue;
-use Bazinga\Bundle\JsTranslationBundle\Extractor\Extractor;
 
-abstract class AbstractExtractorTest extends TestCase
+final class FrontendExtractorTest extends WebTestCase
 {
     const TEST_LOCALE = 'en';
     const TEST_KEY_1 = 'test-key-1';
 
     /**
-     * @var Extractor
+     * @var FrontendExtractor
      */
     protected $extractor;
 
+    public function setUp()
+    {
+      $container = $this->getContainer();
+      $this->extractor = $container->get('bazinga.jstranslation.translation_frontend_extractor');
+    }
+
     /**
      * @dataProvider resourcesWithNotValidTransFunctionUsage
      */

diff --git a/Tests/Extractor/JsExtractorTest.php b/Tests/Extractor/JsExtractorTest.php
diff --git a/Tests/Fixtures/app/config/base_config.yml b/Tests/Fixtures/app/config/base_config.yml
@@ -19,3 +19,6 @@ bazinga_js_translation:
         - messages
         - numerics
         - foo
+    frontend:
+        - { extensions: [ 'coffee' ], sequence: '\.trans(?:Choice)?\s' }
+        - { extensions: [ 'js', 'jsx', 'ts' ], sequence: '\.trans(?:Choice)?\(' }