validate locales

Author: QuentinGab

README.md

@@ -26,28 +26,29 @@ Easily manage all your Laravel translation strings with powerful features:
 # Table of Contents
 
 1. [Installation](#installation)
-2. [Configuring the Driver](#configuring-the-driver)
-3. [Sorting and Formatting](#sorting-and-formatting)
+1. [Configuring the Driver](#configuring-the-driver)
+1. [Configuring the Locales](#configuring-the-locales)
+1. [Sorting and Formatting](#sorting-and-formatting)
     - [CLI Commands](#cli-commands)
     - [Using Code](#using-code)
-4. [Automatic Translation](#automatic-translation)
+1. [Automatic Translation](#automatic-translation)
     - [Configuring OpenAI](#configuring-openai)
     - [Configuring DeepL](#configuring-deepl)
     - [CLI Translation](#cli-translation)
     - [Programmatic Translation](#programmatic-translation)
-5. [Proofreading Translations](#proofreading-translations)
+1. [Proofreading Translations](#proofreading-translations)
     - [CLI Proofreading](#cli-proofreading)
     - [Programmatic Proofreading](#programmatic-proofreading)
-6. [Identifying Untranslated Translations](#identifying-untranslated-translations)
+1. [Identifying Untranslated Translations](#identifying-untranslated-translations)
     - [CLI Usage](#cli-usage)
     - [Programmatic Usage](#programmatic-usage)
-7. [Detecting Missing Translations](#detecting-missing-translations)
+1. [Detecting Missing Translations](#detecting-missing-translations)
     - [CLI Usage](#cli-usage-1)
     - [Programmatic Usage](#programmatic-usage-1)
-8. [Detecting Dead Translations](#detecting-dead-translations)
+1. [Detecting Dead Translations](#detecting-dead-translations)
     - [CLI Usage](#cli-usage-2)
     - [Programmatic Usage](#programmatic-usage-2)
-9. [Code Scanner Configuration](#code-scanner-configuration)
+1. [Code Scanner Configuration](#code-scanner-configuration)
     - [Included Paths](#included-paths)
     - [Excluded Paths](#excluded-paths)
     - [Ignored Translation Keys](#ignored-translation-keys)
@@ -94,6 +95,22 @@ return [
 ];
 ```
 
+## Configuring the Locales
+
+By default, this package will attempt to determine the locales defined in your application by scanning your `lang` directory.
+
+To set the locales manually, use the following configuration:
+
+````php
+return [
+    // ...
+
+    'locales' => ['en', 'fr', 'es'],
+
+    // ...
+];
+
+
 ---
 
 ## Sorting and Formatting
@@ -104,7 +121,7 @@ Sort translations with the default driver:
 
 ```bash
 php artisan translator:sort
-```
+````
 
 Specify a driver for sorting:
 

composer.json

@@ -25,7 +25,8 @@
         "nikic/php-parser": "^5.1",
         "openai-php/laravel": "^0.10.1",
         "spatie/laravel-package-tools": "^1.16",
-        "symfony/finder": "^6.0||^7.0"
+        "symfony/finder": "^6.0||^7.0",
+        "symfony/intl": "^7.2"
     },
     "require-dev": {
         "laravel/pint": "^1.14",

config/translator.php

@@ -1,6 +1,7 @@
 <?php
 
 use Elegantly\Translator\Drivers\PhpDriver;
+use Elegantly\Translator\Support\LocaleValidator;
 
 return [
 
@@ -29,6 +30,21 @@
     */
     'sort_keys' => false,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Locales
+    |--------------------------------------------------------------------------
+    |
+    | If set to an array such as ['en', 'es', 'fr']:
+    | -> Translator::getLocales() will return this array.
+    | If set to a class implementing `\Elegantly\Translator\Contracts\ValidateLocales`:
+    | -> The locales will be those found in the lang directory and filtered according to the class.
+    | If set to `null`:
+    | -> The locales will be those found in the lang directory.
+    |
+    */
+    'locales' => LocaleValidator::class,
+
     /*
     |--------------------------------------------------------------------------
     | Third-Party Services

src/Contracts/ValidateLocales.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Elegantly\Translator\Contracts;
+
+interface ValidateLocales
+{
+    public static function make(): self;
+
+    public function isValid(string $locale): bool;
+}

src/Drivers/PhpDriver.php

@@ -36,7 +36,7 @@ public function getFilePath(string $locale, string $namespace): string
      */
     public function getLocales(): array
     {
-        return collect($this->storage->allDirectories())
+        return collect($this->storage->directories())
             ->sort(SORT_NATURAL)
             ->values()
             ->toArray();

src/Support/LocaleValidator.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Elegantly\Translator\Support;
+
+use Elegantly\Translator\Contracts\ValidateLocales;
+use Symfony\Component\Intl\Locales;
+
+class LocaleValidator implements ValidateLocales
+{
+    public static function make(): self
+    {
+        return new self;
+    }
+
+    public function isValid(string $locale): bool
+    {
+        return Locales::exists($locale);
+    }
+}

src/Translator.php

@@ -36,6 +36,17 @@ public function driver(?string $name): static
      */
     public function getLocales(): array
     {
+        if ($locales = TranslatorServiceProvider::getLocalesFromConfig()) {
+            return $locales;
+        }
+
+        if ($validator = TranslatorServiceProvider::getLocaleValidator()) {
+            return array_values(array_filter(
+                $this->driver->getLocales(),
+                fn ($locale) => $validator::make()->isValid($locale),
+            ));
+        }
+
         return $this->driver->getLocales();
     }
 

src/TranslatorServiceProvider.php

@@ -10,6 +10,7 @@
 use Elegantly\Translator\Commands\ProofreadCommand;
 use Elegantly\Translator\Commands\SortCommand;
 use Elegantly\Translator\Commands\UntranslatedCommand;
+use Elegantly\Translator\Contracts\ValidateLocales;
 use Elegantly\Translator\Drivers\Driver;
 use Elegantly\Translator\Drivers\JsonDriver;
 use Elegantly\Translator\Drivers\PhpDriver;
@@ -53,7 +54,7 @@ public function registeringPackage(): void
             return new Translator(
                 driver: static::getDriverFromConfig(),
                 translateService: static::getTranslateServiceFromConfig(),
-                proofreadService: static::getproofreadServiceFromConfig(),
+                proofreadService: static::getProofreadServiceFromConfig(),
                 searchcodeService: static::getSearchcodeServiceFromConfig(),
             );
         });
@@ -86,7 +87,7 @@ public static function getTranslateServiceFromConfig(?string $serviceName = null
         };
     }
 
-    public static function getproofreadServiceFromConfig(?string $serviceName = null): ?ProofreadServiceInterface
+    public static function getProofreadServiceFromConfig(?string $serviceName = null): ?ProofreadServiceInterface
     {
         /** @var string|null $service */
         $service = $serviceName ?? config('translator.proofread.service');
@@ -115,4 +116,34 @@ public static function getSearchcodeServiceFromConfig(?string $serviceName = nul
             default => $service::make(),
         };
     }
+
+    /**
+     * @return ?array<int, string>
+     */
+    public static function getLocalesFromConfig(): ?array
+    {
+        /** @var array<int, string>|class-string<ValidateLocales> */
+        $locales = config('translator.locales');
+
+        if (is_array($locales)) {
+            return $locales;
+        }
+
+        return null;
+    }
+
+    /**
+     * @return null|class-string<ValidateLocales>
+     */
+    public static function getLocaleValidator(): ?string
+    {
+        /** @var array<int, string>|class-string<ValidateLocales> */
+        $validator = config('translator.locales');
+
+        if (is_array($validator)) {
+            return null;
+        }
+
+        return $validator;
+    }
 }

tests/Feature/PhpDriverTest.php

@@ -2,12 +2,32 @@
 
 use Elegantly\Translator\Translator;
 
-it('gets locales', function () {
+it('gets locales from the directory', function () {
     $translator = new Translator(
         driver: $this->getPhpDriver(),
     );
 
-    expect($translator->getLocales())->toBe(['en', 'fr']);
+    expect($translator->getLocales())->toBe(['en', 'fr', 'pt_BR']);
+});
+
+it('gets locales from the config', function () {
+    config()->set('translator.locales', ['fr']);
+
+    $translator = new Translator(
+        driver: $this->getPhpDriver(),
+    );
+
+    expect($translator->getLocales())->toBe(['fr']);
+});
+
+it('gets locales from the config when null', function () {
+    config()->set('translator.locales', null);
+
+    $translator = new Translator(
+        driver: $this->getPhpDriver(),
+    );
+
+    expect($translator->getLocales())->toBe(['dummy', 'en', 'fr', 'pt_BR']);
 });
 
 it('gets translations', function () {

tests/src/lang/dummy/de/foo.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    //
+];