support subdrivers

Author: QuentinGab

src/Drivers/Driver.php

@@ -10,8 +10,20 @@ abstract class Driver
 {
     /**
      * Make an instance based on configs
+     *
+     * @param  array<array-key, mixed>  $config
      */
-    abstract public static function make(): static;
+    abstract public static function make(array $config = []): static;
+
+    /**
+     * A unique identifier for the driver
+     */
+    abstract public function getKey(): string;
+
+    /**
+     * @return static[]
+     */
+    abstract public function getSubDrivers(): array;
 
     /**
      * @return array<int, string>

src/Drivers/JsonDriver.php

@@ -18,16 +18,46 @@ final public function __construct(
         //
     }
 
-    public static function make(): static
+    public static function make(array $config = []): static
     {
         return new static(
             storage: Storage::build([
                 'driver' => 'local',
                 'root' => config()->string('translator.lang_path'),
+                ...$config,
             ])
         );
     }
 
+    public function getKey(): string
+    {
+        return $this->storage->path('');
+    }
+
+    /**
+     * @return static[]
+     */
+    public function getSubDrivers(): array
+    {
+        return collect($this->storage->directories())
+            ->flatMap(function (string $directory) {
+                $subdriver = static::make([
+                    'root' => $this->storage->path($directory),
+                ]);
+
+                return [
+                    $subdriver,
+                    ...$subdriver->getSubDrivers(),
+                ];
+            })
+            ->filter(function ($driver) {
+                return ! empty($driver->getLocales());
+            })
+            ->sortBy(fn ($driver) => $driver->getKey())
+            ->values()
+            ->all();
+    }
+
     public function getFilePath(string $locale): string
     {
         return "{$locale}.json";

src/Drivers/PhpDriver.php

@@ -18,16 +18,49 @@ final public function __construct(
         //
     }
 
-    public static function make(): static
+    public static function make(array $config = []): static
     {
         return new static(
             storage: Storage::build([
                 'driver' => 'local',
                 'root' => config()->string('translator.lang_path'),
+                ...$config,
             ])
         );
     }
 
+    public function getKey(): string
+    {
+        return $this->storage->path('');
+    }
+
+    /**
+     * @return static[]
+     */
+    public function getSubDrivers(): array
+    {
+        return collect($this->storage->directories())
+            ->flatMap(function (string $directory) {
+                $subdriver = static::make([
+                    'root' => $this->storage->path($directory),
+                ]);
+
+                return [
+                    $subdriver,
+                    ...$subdriver->getSubDrivers(),
+                ];
+            })
+            ->filter(function ($driver) {
+                return collect($driver->getLocales())
+                    ->contains(function ($locale) use ($driver) {
+                        return ! empty($driver->getNamespaces($locale));
+                    });
+            })
+            ->sortBy(fn ($driver) => $driver->getKey())
+            ->values()
+            ->all();
+    }
+
     public function getFilePath(string $locale, string $namespace): string
     {
         return "{$locale}/{$namespace}.php";
@@ -49,7 +82,7 @@ public function getLocales(): array
      */
     public function getNamespaces(string $locale): array
     {
-        return collect($this->storage->allFiles($locale))
+        return collect($this->storage->files($locale))
             ->filter(fn (string $file) => File::extension($file) === 'php')
             ->map(fn (string $file) => File::name($file))
             ->sort(SORT_NATURAL)

tests/Feature/PhpDriverTest.php

@@ -29,7 +29,7 @@
         driver: $this->getPhpDriver(),
     );
 
-    expect($translator->getLocales())->toBe(['dummy', 'en', 'fr', 'fr_CA', 'pt_BR']);
+    expect($translator->getLocales())->toBe(['en', 'fr', 'fr_CA', 'not_a_locale', 'pt_BR', 'sublang', 'vendorlang']);
 });
 
 it('gets translations', function () {

tests/Unit/JsonDriverTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+it('gets nested folder as subdrivers', function () {
+    $driver = $this->getJsonDriver();
+
+    $subDrivers = $driver->getSubDrivers();
+
+    $subDriversKeys = collect($subDrivers)->map(fn ($driver) => $driver->getKey())->all();
+
+    expect($subDriversKeys)->tobe([
+        $driver->storage->path('sublang/'),
+        $driver->storage->path('sublang/subsublang/'),
+        $driver->storage->path('vendorlang/package/'),
+    ]);
+});

tests/Unit/PhpDriverTest.php

@@ -21,3 +21,17 @@
         "<?php\n\ndeclare(strict_types=1);\n\nreturn [\n    'Login' => 'Login',\n    'Don\'t have an account?' => 'Don\'t have an account?',\n    'nested' => [\n        'Don\'t have an account?' => 'Don\'t have an account?',\n    ],\n];\n"
     );
 });
+
+it('gets nested folder as subdrivers', function () {
+    $driver = $this->getPhpDriver();
+
+    $subDrivers = $driver->getSubDrivers();
+
+    $subDriversKeys = collect($subDrivers)->map(fn ($driver) => $driver->getKey())->all();
+
+    expect($subDriversKeys)->tobe([
+        $driver->storage->path('sublang/'),
+        $driver->storage->path('sublang/subsublang/'),
+        $driver->storage->path('vendorlang/package/'),
+    ]);
+});

tests/src/lang/dummy/message.php renamed to tests/src/lang/not_a_locale/message.php

@@ -0,0 +1,3 @@
+{
+    "Sublang translations": "Sublang translations"
+}

tests/src/lang/dummy/de/foo.php renamed to tests/src/lang/sublang/en/auth.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    //
+];