Merge pull request 'Version 1.1.0' (#2) from develop into main

Reviewed-on: #2

.gitattributes

@@ -1,3 +0,0 @@
-/.git           export-ignore
-/.gitignore     export-ignore
-/.gitattributes export-ignore

README.md

@@ -5,10 +5,7 @@
 # Параметры в **.env**:
 
 ### TRANSLATE_SERVICE
-По умолчанию через какой сервис обращаться за переводом. На данный момент доступен только сервисы - **yandex**, **log**.
+По умолчанию через какой сервис обращаться за переводом. На данный момент доступен только один сервис - **yandex**.
-
-**yandex** - https://yandex.cloud/ru/services/translate<br>
-**log** - для проверки и внедрения в свой продукт.
 
 ### TRANSLATE_YANDEX_FOLDER_ID
 ID folder. Код можно увидеть в адресе console.yandex.cloud/folders/**{тут будет код}**.
@@ -26,16 +23,6 @@ ID folder. Код можно увидеть в адресе console.yandex.cloud
 ### TRANSLATE_YANDEX_LIMIT_MAX_SYMBOLS
 Максимальное количество символов за один запрос. Если превышает, то делится на две части и делает по очереди два запроса. По умолчанию стоит 9000 символов. **На данный момент работает только перевод через систему очередей.**
 
-### TRANSLATE_LOG_LIMIT_MAX_REQUEST
-Максимальное количество запросов в период, который указан в TRANSLATE_YANDEX_LIMIT_RATE_SECONDS. По умолчанию 20 запросов в секунду. **На данный момент работает только перевод через систему очередей.**
-
-### TRANSLATE_LOG_LIMIT_RATE_SECONDS
-Период в котором считается максимальное количество запросов. По умолчанию стоит секунда. **На данный момент работает только перевод через систему очередей.**
-
-### TRANSLATE_LOG_LIMIT_MAX_SYMBOLS
-Максимальное количество символов за один запрос. Если превышает, то делится на две части и делает по очереди два запроса. По умолчанию стоит 9000 символов. **На данный момент работает только перевод через систему очередей.**
-
-
 # Методы
 ### Перевести обычный текст
 > \KorElf\TranslateLaravel\Facades\Translate::translateText(
@@ -70,12 +57,12 @@ ID folder. Код можно увидеть в адресе console.yandex.cloud
 
 ### Перевести с помощью очередей (Queues)
 > \KorElf\TranslateLaravel\Facades\Translate::runJob(
-> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\KorElf\TranslateLaravel\DTO\RunTranslateDto &nbsp;&nbsp;\$params,
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\KorElf\TranslateLaravel\DTO\RunTranslateDto &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\$params,
-> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\KorElf\TranslateLaravel\DTO\AfterTranslateDto &nbsp;\$afterTranslateDto
+> <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\KorElf\TranslateLaravel\Contracts\TranslationCompletedListener \$completedListener
 <br>): \Illuminate\Foundation\Bus\PendingDispatch
 
 **\$params** - параметры перевода.
-<br>**\$afterTranslateDto** - после завершения перевода отправляет результат в объект \$afterTranslateDto->\$className. Объект должен соблюдать контракт **\KorElf\TranslateLaravel\Contracts\TranslationCompletedListener**.
+<br>**\$completedListener** - после завершения перевода отправляет результат в этот объект. Объект должен соблюдать контракт **\KorElf\TranslateLaravel\Contracts\TranslationCompletedListener**.
 
 **Пример:**
 > Создаём файл TranslationListener например в папке app/Services
@@ -89,41 +76,25 @@ ID folder. Код можно увидеть в адресе console.yandex.cloud
 >
 >       final class TranslationListener implements TranslationCompletedListener
 >       {
->           /**
+>           public function onTranslationCompleted(array $translatedText): void
->            * Объекты создаются и пробрасываются автоматически через контейнер `$application->make`,
->            * благодаря механизму автоматического внедрения зависимостей (Dependency Injection).
->            * Вы можете передавать свои собственные классы, поместив их в качестве параметров конструктора.
->            * Контейнер создаст эти объекты автоматически, основываясь на разрешении типа (type-hint).
->            */ 
->           // public function __construct(
->           //     private readonly SaveContentCommand $saveContentCommand
->           // ) { }
-> 
->           public function onTranslationCompleted(array $translatedText, array $data = []): void
 >           {
->               Log::info($data);
 >               foreach ($translatedText as $translatedTextKey => $translatedTextValue) {
 >                   Log::info($translatedTextKey . ': ' . $translatedTextValue);
 >               }
->               // $this->saveContentCommand->execute($data['contentId'], $translatedText);
 >           }
 >       }
 > 
 > Потом например в каком-то контроллере (а лучше конечно в сервисе) пишем такой метод
 >
->     public function sendingForTranslation(): View
+>     public function sendingForTranslation(\App\Services\TranslationListener $translationListener): View
 >     {
 >          // Вначале создаём объект с параметрами
 >         $params = (new \KorElf\TranslateLaravel\DTO\RunTranslateDto)
 >            ->addParamText('title', 'Заголовок', 'en', 'ru')
 >            ->addParamHtml('content', '<p>Привет, Мир!</p>', 'en', 'ru');
 > 
->          $translationCompletedListener = \App\Services\TranslationListener::class;
->          $data = ['contentId' => 1];
->          $afterTranslateDto = new \KorElf\TranslateLaravel\DTO\AfterTranslateDto($translationCompletedListener, $data);
-> 
 >         // Отправляем на очередь
->         \KorElf\TranslateLaravel\Facades\Translate::runJob($params, $afterTranslateDto);
+>         \KorElf\TranslateLaravel\Facades\Translate::runJob($params, $translationListener);
 >         
 >         return view('success');
 >     }

composer.json

@@ -22,8 +22,8 @@
     "illuminate/support": "^10.0|^11.0",
     "guzzlehttp/guzzle": "^7.0.1",
     "web-token/jwt-framework": "^3.0",
-    "ext-libxml": "*",
+    "ext-libxml": "^2.11.7",
-    "ext-dom": "*"
+    "ext-dom": "^2.11.7"
   },
   "extra": {
     "laravel": {

config/translate.php

@@ -35,16 +35,5 @@ return [
                 ],
             ],
         ],
-
-        'log' => [
-            'driver' => '\KorElf\TranslateLaravel\Translate\LogDriver',
-            'config' => [
-                'limit' => [
-                    'max_request'  => (int) env('TRANSLATE_LOG_LIMIT_MAX_REQUEST', 20),
-                    'rate_seconds' => (int) env('TRANSLATE_LOG_LIMIT_RATE_SECONDS', 1),
-                    'max_symbols' => (int) env('TRANSLATE_LOG_LIMIT_MAX_SYMBOLS', 9000),
-                ],
-            ],
-        ],
     ],
 ];

src/Contracts/TranslationCompletedListener.php

@@ -4,5 +4,5 @@ namespace KorElf\TranslateLaravel\Contracts;
 
 interface TranslationCompletedListener
 {
-    public function onTranslationCompleted(array $translatedText, array $data = []): void;
+    public function onTranslationCompleted(array $translatedText): void;
 }

src/DTO/AfterTranslateDto.php

@@ -1,32 +0,0 @@
-<?php declare(strict_types=1);
-
-namespace KorElf\TranslateLaravel\DTO;
-
-final readonly class AfterTranslateDto
-{
-    /**
-     * @param string $className The fully qualified class name (FQN) of a class that implements the TranslationCompletedListener interface.
-     * @param array $data Additional data associated with the translation process.
-     */
-    public function __construct(
-        private string $className,
-        private array $data = [],
-    ) { }
-
-    /**
-     * Get the fully qualified class name (FQN) of a class that implements the TranslationCompletedListener interface.
-     *
-     * @return class-string<\KorElf\TranslateLaravel\Contracts\TranslationCompletedListener>
-     */
-    public function getClassName(): string
-    {
-        return $this->className;
-    }
-
-    public function getData(): array
-    {
-        return $this->data;
-    }
-
-
-}

src/Facades/Translate.php

@@ -3,7 +3,7 @@
 namespace KorElf\TranslateLaravel\Facades;
 
 use Illuminate\Support\Facades\Facade;
-use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\Contracts\TranslationCompletedListener;
 use KorElf\TranslateLaravel\DTO\RunTranslateDto;
 
 /**
@@ -11,7 +11,7 @@ use KorElf\TranslateLaravel\DTO\RunTranslateDto;
  * @method static \KorElf\TranslateLaravel\Contracts\Translate resolve(string $name)
  * @method static string|array translateText(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null)
  * @method static string|array translateHtml(string|array $text, string $targetLanguageCode, ?string $sourceLanguageCode = null)
- * @method static \Illuminate\Foundation\Bus\PendingDispatch runJob(RunTranslateDto $params, AfterTranslateDto $afterTranslateDto)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch runJob(RunTranslateDto $params, TranslationCompletedListener $completedListener)
  * @method static \KorElf\TranslateLaravel\DTO\Languages listLanguages()
  * @method static string getDefaultDriver()
  * @method static void setDefaultDriver(string $name)

src/Jobs/AfterTranslate.php

@@ -5,11 +5,10 @@ namespace KorElf\TranslateLaravel\Jobs;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldBeEncrypted;
 use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Support\Facades\Cache;
-use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\Contracts\TranslationCompletedListener;
 use KorElf\TranslateLaravel\DTO\Translated;
 use KorElf\TranslateLaravel\Exceptions\AfterTranslateException;
 
@@ -21,12 +20,15 @@ final class AfterTranslate implements ShouldQueue, ShouldBeEncrypted
      * Create a new job instance.
      */
     public function __construct(
-        private readonly string            $groupName,
+        private readonly string                       $groupName,
-        private readonly Translated        $translated,
+        private readonly TranslationCompletedListener $listener,
-        private readonly AfterTranslateDto $afterTranslateDto
+        private readonly Translated                   $translated,
     ) { }
 
-    public function handle(Application $application): void
+    /**
+     * Execute the job.
+     */
+    public function handle(): void
     {
         $translated = [];
         $data = Cache::get($this->groupName, []);
@@ -41,15 +43,11 @@ final class AfterTranslate implements ShouldQueue, ShouldBeEncrypted
             $translated[$key] = implode(' ', $data[$key]);
         }
 
-        if (empty($data) || !empty($errors)) {
+        if (empty($data)) {
             throw new AfterTranslateException('Part or all of the text has not been translated. Keys: ' . implode(', ', $errors));
         }
-        $objectAfterTranslate = $application->make($this->afterTranslateDto->getClassName());
-        if (!$objectAfterTranslate instanceof \KorElf\TranslateLaravel\Contracts\TranslationCompletedListener) {
-            throw new AfterTranslateException('The class must implement the \KorElf\TranslateLaravel\Contracts\TranslationCompletedListener interface.');
-        }
-        $objectAfterTranslate->onTranslationCompleted($translated, $this->afterTranslateDto->getData());
-
         Cache::forget($this->groupName);
+
+        $this->listener->onTranslationCompleted($translated);
     }
 }

src/Jobs/RunTranslate.php

@@ -10,7 +10,7 @@ use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Facades\Bus;
 use Illuminate\Support\Str;
-use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
+use KorElf\TranslateLaravel\Contracts\TranslationCompletedListener;
 use KorElf\TranslateLaravel\DTO\ProcessTranslateDto;
 use korElf\TranslateLaravel\DTO\RunTranslateDto;
 use KorElf\TranslateLaravel\DTO\Translated;
@@ -24,8 +24,8 @@ final class RunTranslate implements ShouldQueue, ShouldBeEncrypted
      * Create a new job instance.
      */
     public function __construct(
-        private readonly RunTranslateDto    $runTranslateDto,
+        private readonly RunTranslateDto              $runTranslateDto,
-        private readonly AfterTranslateDto $afterTranslateDto,
+        private readonly TranslationCompletedListener $translationCompletedListener,
     ) { }
 
     /**
@@ -55,7 +55,7 @@ final class RunTranslate implements ShouldQueue, ShouldBeEncrypted
             }
             $translated->add($key, count($texts));
         }
-        $chains[] = new AfterTranslate($groupName, $translated, $this->afterTranslateDto);
+        $chains[] = new AfterTranslate($groupName, $this->translationCompletedListener, $translated);
 
         Bus::chain($chains)->dispatch();
     }

src/Translate/LogDriver.php

@@ -1,50 +0,0 @@
-<?php declare(strict_types=1);
-
-namespace KorElf\TranslateLaravel\Translate;
-
-use Illuminate\Contracts\Container\BindingResolutionException;
-use Illuminate\Contracts\Foundation\Application;
-use Illuminate\Support\Facades\Log;
-use KorElf\TranslateLaravel\Contracts\Translate;
-use KorElf\TranslateLaravel\DTO\Languages;
-
-final class LogDriver implements Translate
-{
-    /**
-     * @throws BindingResolutionException
-     */
-    public static function init(Application $app, array $config = []): Translate
-    {
-        return new self(
-            $app->make(Log::class),
-        );
-    }
-
-    public function __construct(
-        private readonly Log $log
-    ) { }
-
-    public function translateText(array|string $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array
-    {
-        $this->log::info('Translate text', ['text' => $text, 'targetLanguageCode' => $targetLanguageCode, 'sourceLanguageCode' => $sourceLanguageCode]);
-
-        return $text;
-    }
-
-    public function translateHtml(array|string $text, string $targetLanguageCode, ?string $sourceLanguageCode = null): string|array
-    {
-        $this->log::info('Translate html', ['text' => $text, 'targetLanguageCode' => $targetLanguageCode, 'sourceLanguageCode' => $sourceLanguageCode]);
-
-        return $text;
-    }
-
-    public function listLanguages(): Languages
-    {
-        $languages = new Languages();
-        $languages->add('ru', 'Russian');
-        $languages->add('en', 'English');
-        $languages->add('de', 'Deutsch');
-
-        return $languages;
-    }
-}

src/Translate/TranslateManager.php

@@ -4,10 +4,10 @@ namespace KorElf\TranslateLaravel\Translate;
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Foundation\Bus\PendingDispatch;
+use KorElf\TranslateLaravel\Contracts\CallbackAfterTranslated;
+use KorElf\TranslateLaravel\Contracts\Translate;
 use InvalidArgumentException;
 use KorElf\TranslateLaravel\Contracts\TranslationCompletedListener;
-use KorElf\TranslateLaravel\Contracts\Translate;
-use KorElf\TranslateLaravel\DTO\AfterTranslateDto;
 use KorElf\TranslateLaravel\DTO\RunTranslateDto;
 use KorElf\TranslateLaravel\Jobs\RunTranslate;
 
@@ -68,15 +68,9 @@ final class TranslateManager
     /**
      * Run through queues.
      */
-    public function runJob(RunTranslateDto $params, AfterTranslateDto $afterTranslateDto): PendingDispatch
+    public function runJob(RunTranslateDto $params, TranslationCompletedListener $completedListener): PendingDispatch
     {
-        $className = $afterTranslateDto->getClassName();
+        return RunTranslate::dispatch($params, $completedListener);
-        if (!is_subclass_of($className, TranslationCompletedListener::class)) {
-            throw new InvalidArgumentException('The class ' . $className . ' must implement the \KorElf\TranslateLaravel\Contracts\Translate\TranslationCompletedListener interface.');
-        }
-        unset($className);
-
-        return RunTranslate::dispatch($params, $afterTranslateDto);
     }
 
     public function getLimit(?string $driver = null): array