add grammar support

Author: QuentinGab

README.md

@@ -51,7 +51,10 @@ return [
 
 ## Usage
 
-You can use the package like a CLI tool with the following command:
+This package can be used:
+
+-   Like a CLI tool, using commands.
+-   In a programmatic way using `\Elegantly\Translator\Facades\Translator::class` facade class.
 
 ### Sort all translations in natural order
 
@@ -61,14 +64,80 @@ You can format and sort all your php translations files using:
 php artisan translator:sort
 ```
 
-### Finnd the missing translations
+```php
+use Elegantly\Translator\Facades\Translator;
+
+Translator::sortAllTranslations();
+```
+
+### Find the missing translations
 
 You can display all the missing translations present in a given locale but not in the other ones using:
 
 ```bash
 php artisan translator:missing fr
 ```
 
+```php
+use Elegantly\Translator\Facades\Translator;
+
+Translator::getAllMissingTranslations('fr');
+```
+
+### Auto translate strings
+
+This package can automatically translate your files for you.
+It includes 2 services right now:
+
+-   DeepL
+-   OpenAI
+
+You can also define your own service.
+
+### Auto-translate using DeepL
+
+First, you need to edit the config file to add your DeepL api key and select deepl as your service:
+
+```php
+return [
+    'translate' => [
+        'service' => 'deepl', // select the default service here
+
+        'services' => [
+            'deepl' => [
+                'key' => env('DEEPL_KEY'), // add you api key here
+            ],
+
+        ],
+    ],
+]
+```
+
+To translate all the missing translations use:
+
+```bash
+php artisan translator:translate --from=fr --to=en
+```
+
+To translate all translations use:
+
+```bash
+php artisan translator:translate --from=fr --to=en --all
+```
+
+Ommitting the `--to` option will translate to every available languages in your project.
+
+```php
+use Elegantly\Translator\Facades\Translator;
+
+Translator::translateTranslations(
+    referenceLocale: 'fr',
+    targetLocale: 'en',
+    namespace: 'namespace-file',
+    keys: ['title', ...]
+);
+```
+
 ## Testing
 
 ```bash

src/Commands/FixGrammarTranslationsCommand.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Elegantly\Translator\Commands;
+
+use Elegantly\Translator\Facades\Translator;
+use Elegantly\Translator\TranslatorServiceProvider;
+use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
+
+class FixGrammarTranslationsCommand extends Command
+{
+    public $signature = 'translator:grammar {--locales=} {--service=} ';
+
+    public $description = 'Translate translations from the given locale to the target one.';
+
+    public function handle(): int
+    {
+        $serviceArg = $this->option('service');
+        $localesArg = explode(",", (string) $this->option('locales'));
+
+        $service = TranslatorServiceProvider::getGrammarServiceFromConfig($serviceArg);
+
+        $locales = collect(Translator::getLanguages())
+            ->when($localesArg, fn (Collection $items) => $items->intersect($localesArg));
+
+
+        foreach ($locales as $locale) {
+
+            $this->info("Fixing grammar in '{$locale}' locale:");
+            $this->line('Using service ' . get_class($service));
+
+            $namespaces = Translator::getNamespaces($locale);
+
+            foreach ($namespaces as $namespace) {
+
+                $keys = Translator::getTranslations($locale, $namespace)
+                    ->dot()
+                    ->keys()
+                    ->toArray();
+
+                $this->line(count($keys) . " keys to fix found in {$locale}/{$namespace}.php");
+                if (!$this->confirm("Would you like to continue?", true)) {
+                    continue;
+                }
+
+                $translations = Translator::fixGrammarTranslations(
+                    $locale,
+                    $namespace,
+                    $keys,
+                    $service
+                );
+
+                $this->table(
+                    headers: ['key', 'Translation'],
+                    rows: $translations->dot()->map(fn ($value, $key) => ["{$namespace}.{$key}", $value])
+                );
+            }
+        }
+
+        return self::SUCCESS;
+    }
+}

src/Commands/TranslateTranslationsCommand.php

@@ -31,7 +31,7 @@ public function handle(): int
 
             $this->info("Translating from '{$from}' to '{$target}':");
             if ($service) {
-                $this->line('Using custom service '.get_class($service));
+                $this->line('Using custom service ' . get_class($service));
             }
 
             foreach ($namespaces as $namespace) {
@@ -42,7 +42,7 @@ public function handle(): int
                     $keys = Translator::getMissingTranslations($from, $target, $namespace);
                 }
 
-                if (! $this->confirm(count($keys)." keys to translate found in {$target}.{$namespace}.php, would you like to continue?", true)) {
+                if (!$this->confirm(count($keys) . " keys to translate found in {$target}/{$namespace}.php, would you like to continue?", true)) {
                     continue;
                 }
 

src/Facades/Translator.php

@@ -2,6 +2,7 @@
 
 namespace Elegantly\Translator\Facades;
 
+use Elegantly\Translator\Services\Grammar\GrammarServiceInterface;
 use Elegantly\Translator\Services\Translate\TranslateServiceInterface;
 use Elegantly\Translator\Translations;
 use Illuminate\Support\Facades\Facade;
@@ -12,6 +13,7 @@
  * @method static Translations getTranslations(string $locale, string $namespace)
  * @method static Translations sortTranslations(string $locale, string $namespace)
  * @method static Translations translateTranslations(string $referenceLocale, string $targetLocale, string $namespace, array $keys, ?TranslateServiceInterface $service)
+ * @method static Translations fixGrammarTranslations(string $locale, string $namespace, array $keys, ?GrammarServiceInterface $service)
  * @method static array<int, string> getMissingTranslations(string $referenceLocale, string $targetLocale, string $namespace)
  * @method static array getAllMissingTranslations(string $referenceLocale)
  * @method static void sortAllTranslations()

src/Translator.php

@@ -142,8 +142,9 @@ function (Translations $translations) use ($referenceLocale, $targetLocale, $nam
 
                 $referenceTranslations = $this->getTranslations($referenceLocale, $namespace);
 
-                $referenceValues = collect($keys)
-                    ->mapWithKeys(fn (string $key) => [$key => $referenceTranslations->get($key)])
+                $referenceValues = $referenceTranslations
+                    ->dot()
+                    ->only($keys)
                     ->filter(fn ($value) => ! blank($value))
                     ->toArray();
 
@@ -161,6 +162,35 @@ function (Translations $translations) use ($referenceLocale, $targetLocale, $nam
         )->only($keys);
     }
 
+    public function fixGrammarTranslations(
+        string $locale,
+        string $namespace,
+        array $keys,
+        ?GrammarServiceInterface $service = null,
+    ): Translations {
+        $service = $service ?? $this->grammarService;
+
+        if (! $service) {
+            throw TranslatorServiceException::missingGrammarService();
+        }
+
+        return $this->transformTranslations($locale, $namespace, function (Translations $translations) use ($service, $keys) {
+
+            $fixedTranslations = $service->fixAll(
+                texts: $translations->dot()
+                    ->only($keys)
+                    ->filter(fn ($value) => ! blank($value))
+                    ->toArray()
+            );
+
+            foreach ($fixedTranslations as $key => $value) {
+                $translations->set($key, $value);
+            }
+
+            return $translations;
+        });
+    }
+
     public function translateTranslation(
         string $referenceLocale,
         string $targetLocale,