Merge pull request #9 from wazzac/develop/v2.3.0

Develop/v2.3.0 to `main`: Next feature release v2.3.0

Author: wazzac

CHANGELOG.md

@@ -1,4 +1,13 @@
 # Release Notes
+
+## v2.3.0 `2025-06-17`
+
+### Changed
+- Refactored `TranslateController` to use instance (non-static) methods and registered it as a singleton in the service provider.
+- Updated all Blade directives in `DomTranslateServiceProvider` to use the singleton instance via `app(TranslateController::class)`.
+- Improved Blade directive registration for proper PHP syntax and singleton usage.
+
+
 ## v2.2.1 `2024-07-21`
 ### Updated
 - Renamed the `PhraseHelper.php` class to conform to PSR-1.

README.md

@@ -37,9 +37,22 @@ php artisan vendor:publish --tag="dom-translate-migrations"
 php artisan migrate
 ```
 
+Register the Service Provider (if not auto-discovered):
+Add to `bootstrap/providers.php`:
+
+```php
+return [
+        App\Providers\AppServiceProvider::class,
+        Wazza\DomTranslate\Providers\DomTranslateServiceProvider::class,
+];
+```
+
+> _If your package supports Laravel auto-discovery, this step may be optional._
+
 Add `DOM_TRANSLATE_GOOGLE_KEY={your_google_api_key}` to your `.env` file and run:
 
 ```bash
+php artisan config:clear
 php artisan config:cache
 ```
 
@@ -105,27 +118,39 @@ Here are a few examples of how to use the translate Blade directive in your HTML
 Four directives are available by default (`@transl8()` is the main one). You can add more in your Laravel _AppServiceProvider_ file (under the `register()` method).
 
 ```php
-// Register the default Blade directive - @transl8()
-// Only the phrase argument is required. Default source and destination languages are sourced from the config file.
-// - Format: transl8('Phrase','target','source')
-// - Example: transl8('This must be translated to French.','fr')
-Blade::directive('transl8', function ($string) {
-    return \Wazza\DomTranslate\Controllers\TranslateController::phrase($string);
-});
-
-// Register language-specific Blade directives
-// French - @transl8fr('phrase')
-Blade::directive('transl8fr', function ($string) {
-    return \Wazza\DomTranslate\Controllers\TranslateController::translate($string, "fr", "en");
-});
-// German - @transl8de('phrase')
-Blade::directive('transl8de', function ($string) {
-    return \Wazza\DomTranslate\Controllers\TranslateController::translate($string, "de", "en");
-});
-// Japanese - @transl8je('phrase')
-Blade::directive('transl8je', function ($string) {
-    return \Wazza\DomTranslate\Controllers\TranslateController::translate($string, "je", "en");
-});
+    // Register the default Blade directive - @transl8()
+    // Only the phrase argument is required. Default source and destination languages are sourced from the config file.
+    // - Format: transl8('Phrase','target','source')
+    // - Example: transl8('This must be translated to French.','fr')
+    // Register the @transl8 directive separately
+    Blade::directive('transl8', function ($string) {
+        return "<?= app(" . TranslateController::class . "::class)->phrase({$string}); ?>";
+    });
+
+    // Register the @transl8 directive for specific languages you use often
+    $languages = [
+        'fr', // French
+        'de', // German
+        'nl', // Dutch
+        'es', // Spanish
+        'it', // Italian
+        'pt', // Portuguese
+        'ru', // Russian
+        'zhcn' => 'zh-CN', // Chinese Simplified
+        'zhtw' => 'zh-TW', // Chinese Traditional
+        'af', // Afrikaans
+        'ar' => 'ar-SA', // Arabic
+        // ... Add more languages as needed
+    ];
+
+    // Register directives for each language by iterating over the languages array
+    foreach ($languages as $alias => $langCode) {
+        // Handle array values like 'zhcn' => 'zh-CN'
+        $directive = is_string($alias) ? $alias : $langCode;
+        Blade::directive("transl8{$directive}", function ($string) use ($langCode) {
+            return "<?= app(" . TranslateController::class . "::class)->translate({$string}, '{$langCode}', 'en'); ?>";
+        });
+    }
 ```
 
 ## Future Development (Backlog)

composer.json

@@ -2,18 +2,30 @@
     "name": "wazza/dom-translate",
     "description": "A Laravel Package that will use the build-in Blade Directive to define specific phrases for auto-translation before being rendered to the screen.",
     "type": "library",
+    "keywords": [
+        "laravel",
+        "translation",
+        "blade-translate",
+        "blade",
+        "package"
+    ],
+    "homepage": "https://www.wazzac.dev",
+    "repository": "https://github.com/wazzac/laravel-translate",
+    "readme": "README.md",
     "require": {
-        "php": "^8.1",
         "ext-json": "*",
-        "illuminate/support": "~10",
-        "guzzlehttp/guzzle": "^7.4"
+        "guzzlehttp/guzzle": "^7.8",
+        "illuminate/support": "^12.0",
+        "php": "^8.2 || ^8.3"
     },
     "require-dev": {
         "fakerphp/faker": "^1.20.0",
-        "phpunit/phpunit": "~10",
-        "orchestra/testbench": "~8",
+        "laravel/legacy-factories": "~1",
         "mockery/mockery": "^1.2",
-        "laravel/legacy-factories": "~1"
+        "orchestra/testbench": "^10.0",
+        "pestphp/pest": "^3.8",
+        "pestphp/pest-plugin-laravel": "^3.2",
+        "phpunit/phpunit": "^11.0"
     },
     "license": "MIT",
     "autoload": {
@@ -26,8 +38,8 @@
         "psr-4": {
             "Wazza\\DomTranslate\\": "src/",
             "Wazza\\DomTranslate\\Tests\\": "tests/",
-            "Database\\Factories\\": "database/factories/",
-            "Database\\Seeders\\": "database/seeders/"
+            "Wazza\\DomTranslate\\Database\\Factories\\": "database/factories/",
+            "Wazza\\DomTranslate\\Database\\Seeders\\": "database/seeders/"
         }
     },
     "extra": {
@@ -40,15 +52,27 @@
             }
         }
     },
-    "authors": [{
-        "name": "Warren Coetzee",
-        "email": "warren.coetzee@gmail.com",
-        "homepage": "https://www.wazzac.dev"
-    }],
+    "authors": [
+        {
+            "name": "Warren Coetzee",
+            "email": "warren.coetzee@gmail.com",
+            "homepage": "https://www.wazzac.dev"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/wazzacdev/laravel-translate/issues",
+        "source": "https://github.com/wazzacdev/laravel-translate"
+    },
     "scripts": {
         "post-autoload-dump": [
             "@php ./vendor/bin/testbench package:discover --ansi"
         ]
     },
-    "minimum-stability": "stable"
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    }
 }