Merge pull request #7 from MortenDHansen/alternate-approach

Alternate approach
MortenDHansen · Mar 1, 2022 · 7582691 · 7582691
2 parents 5becb41 + 26c7335
commit 7582691
Show file tree

Hide file tree

Showing 12 changed files with 57 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,15 @@ The key will be created in the table for the current locale. So, if you have vis
 will update the table whenever the key is encountered and found missing.
 
 If you have an en.json that sets `{"animal":"bird"}`, the result of the above will be 'bird'. You may now override that
-in the database.
+in the database by simply updating the record with:
+
+```php
+$record = DatabaseLangItem::where('locale', 'en')->where('group', '*')->where('key', 'animal')->first();
+$record->value = 'giraffe';
+$record->save();
+```
+
+now result of `__('animal')` is giraffe.
 
 ## Installation
 
@@ -55,5 +63,4 @@ Now you need to replace the laravel TranslationServiceProvider with the service
 ## Remarks
 
 - Of course getting, and writing language keys whenever they appear is quite a heavy load of you have many of them.
-  Therefore the package caches the keys. When cache is cold, the pages may be quite slow for the first couple of
-  requests.
+  Therefore the package caches the keys. When cache is cold, the pages may be quite slow.
diff --git a/composer.json b/composer.json
@@ -43,9 +43,6 @@
     }
   },
   "extra": {
-    "aliases": {
-      "DbTrans": "MortenDHansen\\LaravelDatabaseTranslations\\Facades\\DatabaseTranslationsFacade"
-    }
   },
   "scripts": {
     "test": "vendor/bin/phpunit"

diff --git a/config/translations-database.php b/config/translations-database.php
@@ -9,5 +9,7 @@
     | Loaded translations from database are cached by the default cache selected
     |
     */
-    'cache-prefix' => 'laravel-db-translations'
+    'cache-prefix' => 'laravel-db-translations',
+
+    'cache-driver' => config('cache.default')
 ];
diff --git a/src/DatabaseTranslationsLoader.php b/src/DatabaseTranslationsLoader.php
@@ -3,7 +3,6 @@
 namespace MortenDHansen\LaravelDatabaseTranslations;
 
 use Illuminate\Contracts\Translation\Loader;
-use MortenDHansen\LaravelDatabaseTranslations\Facades\DbTrans;
 
 class DatabaseTranslationsLoader implements Loader
 {

diff --git a/src/DatabaseTranslationsServiceProvider.php b/src/DatabaseTranslationsServiceProvider.php
@@ -4,7 +4,6 @@
 
 use Illuminate\Translation\FileLoader;
 use Illuminate\Translation\TranslationServiceProvider;
-use MortenDHansen\LaravelDatabaseTranslations\Facades\DbTrans;
 
 class DatabaseTranslationsServiceProvider extends TranslationServiceProvider
 {

diff --git a/src/DatabaseTranslationsTranslator.php b/src/DatabaseTranslationsTranslator.php
@@ -2,8 +2,6 @@
 
 namespace MortenDHansen\LaravelDatabaseTranslations;
 
-use MortenDHansen\LaravelDatabaseTranslations\Facades\DbTrans;
-
 class DatabaseTranslationsTranslator extends \Illuminate\Translation\Translator
 {
 

diff --git a/src/Facades/DbTrans.php → src/DbTrans.php b/src/Facades/DbTrans.php → src/DbTrans.php
@@ -1,26 +1,29 @@
 <?php
 
-namespace MortenDHansen\LaravelDatabaseTranslations\Facades;
+namespace MortenDHansen\LaravelDatabaseTranslations;
 
 use Carbon\Carbon;
 use MortenDHansen\LaravelDatabaseTranslations\Models\DatabaseLangItem;
 
+use function config;
+
 class DbTrans
 {
     public static function getDatabaseTranslations(string $group, string $locale): array
     {
-        $cacheKey = app('dbtrans')->getCacheKey($group, $locale);
-        return cache()->remember($cacheKey, Carbon::now()->addDay(), function () use ($group, $locale) {
-            return DatabaseLangItem::where('locale', $locale)
-                ->where('group', $group)
-                ->get()
-                ->mapWithKeys(function (DatabaseLangItem $langItem) {
-                    $result = [$langItem->key => $langItem->value];
-                    if (is_array(json_decode($langItem->value, true))) {
-                        $result = [];
-                        foreach (json_decode($langItem->value, true) as $subKey => $subValue) {
-                            $result[$langItem->key . '.' . $subKey] = $subValue;
-                        }
+        $cacheKey = DbTrans::getCacheKey($group, $locale);
+        return \Cache::driver(config('translations-database.cache-driver'))->remember($cacheKey,
+            Carbon::now()->addDay(), function () use ($group, $locale) {
+                return DatabaseLangItem::where('locale', $locale)
+                    ->where('group', $group)
+                    ->get()
+                    ->mapWithKeys(function (DatabaseLangItem $langItem) {
+                        $result = [$langItem->key => $langItem->value];
+                        if (is_array(json_decode($langItem->value, true))) {
+                            $result = [];
+                            foreach (json_decode($langItem->value, true) as $subKey => $subValue) {
+                                $result[$langItem->key . '.' . $subKey] = $subValue;
+                            }
                     }
                     return $result;
                 })->toArray();

diff --git a/src/Facades/DatabaseTranslationsFacade.php b/src/Facades/DatabaseTranslationsFacade.php
diff --git a/src/Models/DatabaseLangItem.php b/src/Models/DatabaseLangItem.php
@@ -2,9 +2,10 @@
 
 namespace MortenDHansen\LaravelDatabaseTranslations\Models;
 
+use Cache;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use MortenDHansen\LaravelDatabaseTranslations\database\Factories\DatabaseLangItemFactory;
-use MortenDHansen\LaravelDatabaseTranslations\Facades\DbTrans;
+use MortenDHansen\LaravelDatabaseTranslations\DbTrans;
 
 class DatabaseLangItem extends \Illuminate\Database\Eloquent\Model
 {
@@ -27,12 +28,14 @@ protected static function boot()
         parent::boot();
 
         static::created(function ($model) {
-            cache()->forget(DbTrans::getCacheKey($model->group, $model->locale));
+            Cache::driver(config('translations-database.cache-driver'))->forget(DbTrans::getCacheKey($model->group,
+                $model->locale));
             DbTrans::getDatabaseTranslations($model->group, $model->locale);
         });
 
         static::updated(function ($model) {
-            cache()->forget(DbTrans::getCacheKey($model->group, $model->locale));
+            Cache::driver(config('translations-database.cache-driver'))->forget(DbTrans::getCacheKey($model->group,
+                $model->locale));
             DbTrans::getDatabaseTranslations($model->group, $model->locale);
         });
     }

diff --git a/tests/Feature/BasicTest.php b/tests/Feature/BasicTest.php
@@ -65,14 +65,4 @@ public function databaseMayHaveTranslations()
         $this->assertDatabaseCount('database_lang_items', 10);
     }
 
-    /**
-     * @test
-     * @return void
-     */
-    public function canUseFacade()
-    {
-        $facade = app('dbtrans');
-        $this->assertInstanceOf(\MortenDHansen\LaravelDatabaseTranslations\Facades\DbTrans::class, $facade);
-    }
-
 }
diff --git a/tests/Feature/DatabaseTranslationsTest.php b/tests/Feature/DatabaseTranslationsTest.php
@@ -4,7 +4,7 @@
 
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Illuminate\Support\Facades\Validator;
-use MortenDHansen\LaravelDatabaseTranslations\Facades\DbTrans;
+use MortenDHansen\LaravelDatabaseTranslations\DbTrans;
 use MortenDHansen\LaravelDatabaseTranslations\Models\DatabaseLangItem;
 
 class DatabaseTranslationsTest extends \MortenDHansen\LaravelDatabaseTranslations\Tests\TestCase
@@ -58,6 +58,26 @@ public function databaseTranslationsOverrideFiles()
         $this->assertEquals('blue', __('food.salad'));
     }
 
+    /**
+     * @test
+     * @return void
+     */
+    public function changesToOverrideTakesImmidiateEffect()
+    {
+        __('animal');
+        $this->assertDatabaseHas('database_lang_items', ['group' => '*', 'locale' => 'en', 'key' => 'animal']);
+
+        $record = DatabaseLangItem::where('group', '*')->where('locale', 'en')->where('key', 'animal')->first();
+        $this->assertNull($record->value);
+
+        $record->value = 'bird';
+        $record->save();
+        $this->assertDatabaseHas('database_lang_items',
+            ['group' => '*', 'locale' => 'en', 'key' => 'animal', 'value' => 'bird']);
+
+        $this->assertEquals('bird', __('animal'));
+    }
+
     /**
      * @test
      * @return void

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -60,6 +60,7 @@ protected function getEnvironmentSetUp($app)
             'driver' => 'file',
             'path' => __DIR__ . '/temp/cache'
         ]);
+
         $app['path.lang'] = __DIR__ . '/lang';
         $app['config']->set('translations-database.cache-prefix', 'laravel-db-translations');
     }