Update extractors (#143)

* An extractor may support multiple file types * Update extractors interface Co-authored-by: Tobias Nyholm <tobias.nyholm@gmail.com>
php-translation · Dec 26, 2019 · cf6a992 · cf6a992
1 parent 3231e7a
commit cf6a992
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 57 deletions.
diff --git a/src/Extractor.php b/src/Extractor.php
@@ -42,29 +42,6 @@ public function extractFromDirectory(string $dir): SourceCollection
         return $this->doExtract($finder);
     }
 
-    private function getType(SplFileInfo $file): string
-    {
-        $filename = $file->getFilename();
-        if (preg_match('|.+\.blade\.php$|', $filename)) {
-            $ext = 'blade.php';
-        } else {
-            $ext = $file->getExtension();
-        }
-
-        switch ($ext) {
-            case 'php':
-            case 'php5':
-            case 'phtml':
-                return 'php';
-            case 'twig':
-                return 'twig';
-            case 'blade.php':
-                return 'blade';
-            default:
-                return $ext;
-        }
-    }
-
     public function addFileExtractor(FileExtractor $fileExtractor): void
     {
         $this->fileExtractors[] = $fileExtractor;
@@ -74,16 +51,29 @@ private function doExtract(Finder $finder): SourceCollection
     {
         $collection = new SourceCollection();
         foreach ($finder as $file) {
-            $type = $this->getType($file);
-            foreach ($this->fileExtractors as $extractor) {
-                if ($extractor->getType() !== $type) {
-                    continue;
-                }
-
+            if (null !== $extractor = $this->getRelevantExtractorForFile($file)) {
                 $extractor->getSourceLocations($file, $collection);
             }
         }
 
         return $collection;
     }
+
+    private function getRelevantExtractorForFile(SplFileInfo $file): ?FileExtractor
+    {
+        $filename = $file->getFilename();
+        if (preg_match('|.+\.blade\.php$|', $filename)) {
+            $ext = 'blade.php';
+        } else {
+            $ext = $file->getExtension();
+        }
+
+        foreach ($this->fileExtractors as $extractor) {
+            if ($extractor->supportsExtension($ext)) {
+                return $extractor;
+            }
+        }
+
+        return null;
+    }
 }
diff --git a/src/FileExtractor/BladeFileExtractor.php b/src/FileExtractor/BladeFileExtractor.php
@@ -67,8 +67,8 @@ public function findTranslations(SplFileInfo $file): array
     /**
      * {@inheritdoc}
      */
-    public function getType(): string
+    public function supportsExtension(string $extension): bool
     {
-        return 'blade';
+        return 'blade.php' === $extension;
     }
 }
diff --git a/src/FileExtractor/FileExtractor.php b/src/FileExtractor/FileExtractor.php
@@ -21,8 +21,5 @@ interface FileExtractor
 {
     public function getSourceLocations(SplFileInfo $file, SourceCollection $collection): void;
 
-    /**
-     * The file type the extractor supports.
-     */
-    public function getType(): string;
+    public function supportsExtension(string $extension): bool;
 }
diff --git a/src/FileExtractor/PHPFileExtractor.php b/src/FileExtractor/PHPFileExtractor.php
@@ -53,9 +53,9 @@ public function getSourceLocations(SplFileInfo $file, SourceCollection $collecti
     /**
      * {@inheritdoc}
      */
-    public function getType(): string
+    public function supportsExtension(string $extension): bool
     {
-        return 'php';
+        return \in_array($extension, ['php', 'php5', 'phtml']);
     }
 
     public function addVisitor(NodeVisitor $visitor): void

diff --git a/src/FileExtractor/TwigFileExtractor.php b/src/FileExtractor/TwigFileExtractor.php
@@ -56,9 +56,9 @@ public function getSourceLocations(SplFileInfo $file, SourceCollection $collecti
     /**
      * {@inheritdoc}
      */
-    public function getType(): string
+    public function supportsExtension(string $extension): bool
     {
-        return 'twig';
+        return 'twig' === $extension;
     }
 
     public function addVisitor(NodeVisitorInterface $visitor): void

diff --git a/tests/Smoke/AllExtractorsTest.php b/tests/Smoke/AllExtractorsTest.php
@@ -94,13 +94,8 @@ public function testNoException()
 
     /**
      * Assert that a translation key exists in source collection.
-     *
-     * @param $translationKey
-     * @param string $message
-     *
-     * @return SourceLocation
      */
-    private function translationExists(SourceCollection $sc, $translationKey, $message = null)
+    private function translationExists(SourceCollection $sc, string $translationKey, string $message = null): SourceLocation
     {
         if (empty($message)) {
             $message = sprintf('Tried to find "%s" but failed', $translationKey);
@@ -123,11 +118,8 @@ private function translationExists(SourceCollection $sc, $translationKey, $messa
 
     /**
      * Assert that a translation key is missing in source collection.
-     *
-     * @param $translationKey
-     * @param string $message
      */
-    private function translationMissing(SourceCollection $sc, $translationKey, $message = null)
+    private function translationMissing(SourceCollection $sc, string $translationKey, string $message = null)
     {
         if (empty($message)) {
             $message = sprintf('The translation key "%s" should not exist', $translationKey);
@@ -145,10 +137,7 @@ private function translationMissing(SourceCollection $sc, $translationKey, $mess
         $this->assertFalse($found, $message);
     }
 
-    /**
-     * @return PHPFileExtractor
-     */
-    private function getPHPFileExtractor()
+    private function getPHPFileExtractor(): PHPFileExtractor
     {
         $file = new PHPFileExtractor();
         $file->addVisitor(new ContainerAwareTrans());
@@ -166,10 +155,7 @@ private function getPHPFileExtractor()
         return $file;
     }
 
-    /**
-     * @return TwigFileExtractor
-     */
-    private function getTwigFileExtractor()
+    private function getTwigFileExtractor(): TwigFileExtractor
     {
         $file = new TwigFileExtractor(TwigEnvironmentFactory::create());
         $file->addVisitor(new TwigVisitor());