support nested folders

Author: QuentinGab

src/Collections/PhpTranslations.php

@@ -98,16 +98,16 @@ public function except(array $keys): static
         $items = $this->items;
 
         foreach ($keys as $key) {
+
             if (array_key_exists($key, $items)) {
                 unset($items[$key]);
             } elseif (str_contains($key, '.')) {
-
                 $this->recursiveForget(
                     $items,
                     explode('.', $key)
                 );
-
             }
+
         }
 
         return new static($items);

src/Drivers/PhpDriver.php

@@ -7,6 +7,7 @@
 use Elegantly\Translator\Collections\PhpTranslations;
 use Elegantly\Translator\Collections\Translations;
 use Illuminate\Contracts\Filesystem\Filesystem;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Storage;
 
@@ -82,21 +83,27 @@ public function getLocales(): array
      */
     public function getNamespaces(string $locale): array
     {
-        return collect($this->storage->files($locale))
+        return collect($this->storage->allFiles($locale))
             ->filter(fn (string $file) => File::extension($file) === 'php')
-            ->map(fn (string $file) => File::name($file))
+            ->map(function (string $file) use ($locale) {
+                return str($file)
+                    ->after($locale.DIRECTORY_SEPARATOR)
+                    ->beforeLast('.')
+                    ->value();
+            })
             ->sort(SORT_NATURAL)
             ->values()
             ->all();
     }
 
     public function getTranslations(string $locale): PhpTranslations
     {
-        $values = collect($this->getNamespaces($locale))
-            ->mapWithKeys(function ($namespace) use ($locale) {
-                return [$namespace => $this->getTranslationsInNamespace($locale, $namespace)];
-            })
-            ->all();
+        $values = Arr::mapWithKeys(
+            $this->getNamespaces($locale),
+            fn ($namespace) => [
+                $namespace => $this->getTranslationsInNamespace($locale, $namespace),
+            ]
+        );
 
         return new PhpTranslations(
             PhpTranslations::prepareTranslations($values) ?? []

src/Translator.php

@@ -15,8 +15,12 @@
 
 class Translator
 {
+    /**
+     * @param  string[]  $ignoredTranslations
+     */
     final public function __construct(
         public Driver $driver,
+        public array $ignoredTranslations = [],
         public ?TranslateServiceInterface $translateService = null,
         public ?ProofreadServiceInterface $proofreadService = null,
         public ?SearchCodeServiceInterface $searchcodeService = null,
@@ -29,6 +33,7 @@ public function driver(null|string|Driver $name): static
     {
         return new static(
             driver: $name instanceof Driver ? $name : TranslatorServiceProvider::getDriverFromConfig($name),
+            ignoredTranslations: $this->ignoredTranslations,
             translateService: $this->translateService,
             proofreadService: $this->proofreadService,
             searchcodeService: $this->searchcodeService,
@@ -40,6 +45,7 @@ public function withProofreadService(ProofreadServiceInterface $service): static
     {
         return new static(
             driver: $this->driver,
+            ignoredTranslations: $this->ignoredTranslations,
             translateService: $this->translateService,
             proofreadService: $service,
             searchcodeService: $this->searchcodeService,
@@ -51,6 +57,7 @@ public function withTranslateService(TranslateServiceInterface $service): static
     {
         return new static(
             driver: $this->driver,
+            ignoredTranslations: $this->ignoredTranslations,
             translateService: $service,
             proofreadService: $this->proofreadService,
             searchcodeService: $this->searchcodeService,
@@ -62,6 +69,7 @@ public function withSearchcodeService(SearchCodeServiceInterface $service): stat
     {
         return new static(
             driver: $this->driver,
+            ignoredTranslations: $this->ignoredTranslations,
             translateService: $this->translateService,
             proofreadService: $this->proofreadService,
             searchcodeService: $service,
@@ -79,9 +87,11 @@ public function getLocales(): array
         }
 
         if ($validator = TranslatorServiceProvider::getLocaleValidator()) {
+            $validator = $validator::make();
+
             return array_values(array_filter(
                 $this->driver->getLocales(),
-                fn ($locale) => $validator::make()->isValid($locale),
+                fn ($locale) => $validator->isValid($locale),
             ));
         }
 
@@ -125,9 +135,7 @@ public function getMissingTranslations(
         );
 
         return collect($keys)
-            ->filter(function ($value, $key) use ($translations) {
-                return ! $translations->has($key);
-            })
+            ->filter(fn ($value, $key) => ! $translations->has($key))
             ->all();
     }
 
@@ -140,11 +148,14 @@ public function getDeadTranslations(string $locale): Translations
             throw TranslatorServiceException::missingSearchcodeService();
         }
 
-        $defined = $this->searchcodeService->filesByTranslations();
+        $keys = array_keys($this->searchcodeService->filesByTranslations());
 
         return $this
             ->getTranslations($locale)
-            ->except(array_keys($defined));
+            ->except([
+                ...$this->ignoredTranslations,
+                ...$keys,
+            ]);
     }
 
     public function getUntranslatedTranslations(

src/TranslatorServiceProvider.php

@@ -61,6 +61,7 @@ public function registeringPackage(): void
         $this->app->scoped(Translator::class, function () {
             return new Translator(
                 driver: static::getDriverFromConfig(),
+                ignoredTranslations: static::getIgnoredTranslationsFromConfig(),
                 translateService: static::getTranslateServiceFromConfig(),
                 proofreadService: static::getProofreadServiceFromConfig(),
                 searchcodeService: static::getSearchcodeServiceFromConfig(),
@@ -80,6 +81,14 @@ public static function getDriverFromConfig(?string $driverName = null): Driver
         };
     }
 
+    /**
+     * @return string[]
+     */
+    public static function getIgnoredTranslationsFromConfig(): array
+    {
+        return (array) config('translator.searchcode.ignored_translations');
+    }
+
     public static function getTranslateServiceFromConfig(?string $serviceName = null): ?TranslateServiceInterface
     {
         /** @var string|null $service */

tests/Feature/JsonDriverTest.php

@@ -9,7 +9,7 @@
         driver: $this->getJsonDriver(),
     );
 
-    expect($translator->getLocales())->toBe(['fr']);
+    expect($translator->getLocales())->toBe(['fr', 'it']);
 });
 
 it('gets translations', function () {
@@ -21,11 +21,12 @@
 
     expect($translations->toArray())->toBe([
         'All rights reserved.' => 'Tous droits réservés.',
-        'This one is used.' => 'Celui-ci est utilisé.',
+        'This one is untranslated' => 'Celui-ci est manquant',
+        'This one is dead' => 'Celui-ci est mort',
     ]);
 });
 
-it('gets undefined translations', function () {
+it('gets missing translations', function () {
     $translator = new Translator(
         driver: $this->getJsonDriver(),
         searchcodeService: $this->getSearchCodeService()
@@ -34,29 +35,34 @@
     $keys = $translator->getMissingTranslations('fr');
 
     expect($keys)->toBe([
-        'messages.dummy.class' => [
+        'This one is missing' => [
             'count' => 1,
             'files' => [
-                $this->formatPath($this->getAppPath().'/DummyClass.php'),
+                $this->formatPath($this->getResourcesPath().'/views/json/foo.blade.php'),
+            ],
+        ],
+        'messages.missing' => [
+            'count' => 2,
+            'files' => [
+                $this->formatPath($this->getResourcesPath().'/views/foo.blade.php'),
             ],
         ],
-        'messages.dummy.component' => [
+        'messages.nested.missing' => [
             'count' => 1,
             'files' => [
-                $this->formatPath($this->getResourcesPath().'/components/dummy-component.blade.php'),
+                $this->formatPath($this->getResourcesPath().'/views/foo.blade.php'),
             ],
         ],
-        'messages.dummy.nested' => [
+        'messages.title' => [
             'count' => 1,
             'files' => [
-                $this->formatPath($this->getResourcesPath().'/views/dummy-view.blade.php'),
+                $this->formatPath($this->getAppPath().'/Foo.php'),
             ],
         ],
-        'messages.dummy.view' => [
-            'count' => 3,
+        'users/account.title' => [
+            'count' => 1,
             'files' => [
-                $this->formatPath($this->getResourcesPath().'/components/dummy-component.blade.php'),
-                $this->formatPath($this->getResourcesPath().'/views/dummy-view.blade.php'),
+                $this->formatPath($this->getResourcesPath().'/components/users/account.blade.php'),
             ],
         ],
     ]);
@@ -72,25 +78,24 @@
     $dead = $translator->getDeadTranslations('fr');
 
     expect($dead->keys())->toBe([
-        'All rights reserved.',
+        'This one is dead',
     ]);
 
 });
 
-it('gets missing translations', function () {
+it('gets untranslated translations', function () {
     $translator = new Translator(
         driver: $this->getJsonDriver(),
         searchcodeService: $this->getSearchCodeService()
     );
 
     $keys = $translator->getUntranslatedTranslations(
         source: 'fr',
-        target: 'en'
+        target: 'it'
     );
 
     expect($keys->toArray())->toBe([
-        'All rights reserved.' => 'Tous droits réservés.',
-        'This one is used.' => 'Celui-ci est utilisé.',
+        'This one is untranslated' => 'Celui-ci est manquant',
     ]);
 
 });