Merge pull request #28 from thiagocordeiro/thiago/#26-scan-different-…

…file-extension

#26 Added multiple extension scan capabilities

phpcs.xml

@@ -31,6 +31,7 @@
         <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingTraversableReturnTypeHintSpecification"/>
         <exclude name="SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntax.DisallowedArrayTypeHintSyntax"/>
         <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.UselessDocComment"/>
+        <exclude name="Squiz.Strings.ConcatenationSpacing.PaddingFound"/>
     </rule>
 
     <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">

src/Framework/LaravelConfigLoader.php

@@ -24,6 +24,11 @@ public function output(): string
         return $this->loadConfigInString('output');
     }
 
+    public function extensions(): array
+    {
+        return $this->loadConfigInArray('extensions');
+    }
+
     private function loadConfigInArray(string $key): array
     {
         $values = $this->load($key);

src/Framework/config.php

@@ -10,6 +10,7 @@
         resource_path('views'),
     ],
     'output' => resource_path('lang'),
+    'extensions' => ['php'],
     'container' => [
         'config_loader' => LaravelConfigLoader::class,
         'translation_repository' => LaravelJsonTranslationRepository::class,

src/Translator/ConfigLoader.php

@@ -9,4 +9,6 @@ public function languages(): array;
     public function directories(): array;
 
     public function output(): string;
+
+    public function extensions(): array;
 }

src/Translator/Exception/InvalidExtensionsConfiguration.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace Translator\Translator\Exception;
+
+use Exception;
+
+class InvalidExtensionsConfiguration extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('Invalid extensions configuration');
+    }
+}

src/Translator/TranslationScanner.php

@@ -3,33 +3,43 @@
 namespace Translator\Translator;
 
 use Translator\Translator\Exception\InvalidDirectoriesConfiguration;
+use Translator\Translator\Exception\InvalidExtensionsConfiguration;
 
 class TranslationScanner
 {
     /**
+     * @param string[] $extensions
+     * @param string[] $directories
      * @return Translation[]
      * @throws InvalidDirectoriesConfiguration
+     * @throws InvalidExtensionsConfiguration
      */
-    public function scan(string ...$directories): array
+    public function scan(array $extensions, array $directories): array
     {
+        if (empty($extensions)) {
+            throw new InvalidExtensionsConfiguration();
+        }
+
         if (empty($directories)) {
             throw new InvalidDirectoriesConfiguration();
         }
 
-        return array_reduce($directories, function (array $collection, string $directory): array {
+        $ext = implode(',', $extensions);
+
+        return array_reduce($directories, function (array $collection, string $directory) use ($ext): array {
             return array_merge(
                 $collection,
-                $this->scanDirectory($directory)
+                $this->scanDirectory($directory, $ext)
             );
         }, []);
     }
 
     /**
      * @return Translation[]
      */
-    private function scanDirectory(string $path): array
+    private function scanDirectory(string $path, string $extensions): array
     {
-        $files = glob_recursive("{$path}/*.php", GLOB_BRACE);
+        $files = glob_recursive("{$path}/*.{{$extensions}}", GLOB_BRACE);
 
         return array_reduce($files, function (array $keys, $file): array {
             $content = $this->getFileContent($file);

src/Translator/TranslationService.php

@@ -3,6 +3,7 @@
 namespace Translator\Translator;
 
 use Translator\Translator\Exception\InvalidDirectoriesConfiguration;
+use Translator\Translator\Exception\InvalidExtensionsConfiguration;
 
 class TranslationService
 {
@@ -24,12 +25,14 @@ public function __construct(ConfigLoader $config, TranslationScanner $scanner, T
 
     /**
      * @throws InvalidDirectoriesConfiguration
+     * @throws InvalidExtensionsConfiguration
      */
     public function scanAndSaveNewKeys(): void
     {
         $directories = $this->config->directories();
+        $extensions = $this->config->extensions();
 
-        $translations = $this->scanner->scan(...$directories);
+        $translations = $this->scanner->scan($extensions, $directories);
 
         $this->storeTranslations($translations);
     }

tests/Fixtures/App/View/Component.vue

@@ -0,0 +1,18 @@
+<template>
+  <div>
+    {{ __('This is a vue component') }}
+  </div>
+</template>
+
+<script>
+export default {
+  data() {
+    return {
+      labels: {
+        title: __('Vue Component Title'),
+      },
+    };
+  },
+};
+</script>
+

tests/Unit/Translator/TranslationScannerTest.php

@@ -27,14 +27,14 @@ public function testWhenDirectoriesToScanAreNotSetThenThrowException(): void
 
         $this->expectException(InvalidDirectoriesConfiguration::class);
 
-        $this->scanner->scan(...$directories);
+        $this->scanner->scan(['php'], $directories);
     }
 
     public function testShouldFindTranslationsForUnderscoreFunctions(): void
     {
         $__dir = $this->fixturesDir.'/App/Functions/UnderscoreUnderscore';
 
-        $translations = $this->scanner->scan(...[$__dir]);
+        $translations = $this->scanner->scan(['php'], [$__dir]);
 
         $this->assertEquals(
             [
@@ -48,7 +48,7 @@ public function testShouldFindTranslationsForLangFunctions(): void
     {
         $langDir = $this->fixturesDir.'/App/Functions/Lang';
 
-        $translations = $this->scanner->scan(...[$langDir]);
+        $translations = $this->scanner->scan(['php'], [$langDir]);
 
         $this->assertEquals(
             [
@@ -58,11 +58,26 @@ public function testShouldFindTranslationsForLangFunctions(): void
         );
     }
 
+    public function testShouldFindTranslationsForDifferentFileExtensions(): void
+    {
+        $langDir = $this->fixturesDir . '/App/View';
+
+        $translations = $this->scanner->scan(['vue'], [$langDir]);
+
+        $this->assertEquals(
+            [
+                'This is a vue component' => new Translation('This is a vue component', ''),
+                'Vue Component Title' => new Translation('Vue Component Title', ''),
+            ],
+            $translations
+        );
+    }
+
     public function testShouldFindTranslationsForBladeTemplates(): void
     {
-        $viewDir = $this->fixturesDir.'/App/View';
+        $viewDir = $this->fixturesDir . '/App/View';
 
-        $translations = $this->scanner->scan(...[$viewDir]);
+        $translations = $this->scanner->scan(['php'], [$viewDir]);
 
         $this->assertEquals(
             [
@@ -92,7 +107,7 @@ public function testShouldFindMultipleTranslationForDifferentFunctionsAndFiles()
     {
         $appDir = $this->fixturesDir.'/App';
 
-        $translations = $this->scanner->scan(...[$appDir]);
+        $translations = $this->scanner->scan(['php'], [$appDir]);
 
         $this->assertEquals(
             [

tests/Unit/Translator/TranslationServiceTest.php

@@ -44,6 +44,9 @@ protected function setUp(): void
 
     public function testShouldScanAndSaveKeys(): void
     {
+        $this->configLoader
+            ->method('extensions')
+            ->willReturn(['php']);
         $this->configLoader
             ->method('directories')
             ->willReturn([$this->fixturesDir.'/App/View']);
@@ -72,6 +75,9 @@ public function testWhenGivenTranslationAlreadyExistsThenDoNotOverride(): void
         $this->configLoader
             ->method('directories')
             ->willReturn([$this->fixturesDir.'/App/Functions/Lang']);
+        $this->configLoader
+            ->method('extensions')
+            ->willReturn(['php']);
 
         $this->repository
             ->method('exists')