86 fire event when adding translations (#107)

* Add basic event class to fire later

* Clean up controller, move logic to abstract class

* Rename event and pass all relevant data

* Add tests that event is fired with right data

* Auto fix formatting issues with php-cs-fixer

Use laravel shift preset

Author: simonvomeyser

src/Drivers/Translation.php

@@ -2,8 +2,11 @@
 
 namespace JoeDixon\Translation\Drivers;
 
+use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Str;
+use JoeDixon\Translation\Events\TranslationAdded;
 
 abstract class Translation
 {
@@ -98,4 +101,20 @@ public function filterTranslationsFor($language, $filter)
             });
         });
     }
+
+    public function add(Request $request, $language, $isGroupTranslation)
+    {
+        $namespace = $request->has('namespace') && $request->get('namespace') ? "{$request->get('namespace')}::" : '';
+        $group = $namespace.$request->get('group');
+        $key = $request->get('key');
+        $value = $request->get('value') ?: '';
+
+        if ($isGroupTranslation) {
+            $this->addGroupTranslation($language, $group, $key, $value);
+        } else {
+            $this->addSingleTranslation($language, 'single', $key, $value);
+        }
+
+        Event::dispatch(new TranslationAdded($language, $group ?: 'single', $key, $value));
+    }
 }

src/Events/TranslationAdded.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace JoeDixon\Translation\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+class TranslationAdded
+{
+    use Dispatchable;
+
+    public $key;
+    public $group;
+    public $value;
+    public $language;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(string $language, string $group, string $key, string $value)
+    {
+        $this->language = $language;
+        $this->group = $group;
+        $this->key = $key;
+        $this->value = $value;
+    }
+}

src/Http/Controllers/LanguageTranslationController.php

@@ -53,12 +53,9 @@ public function create(Request $request, $language)
 
     public function store(TranslationRequest $request, $language)
     {
-        if ($request->filled('group')) {
-            $namespace = $request->has('namespace') && $request->get('namespace') ? "{$request->get('namespace')}::" : '';
-            $this->translation->addGroupTranslation($language, "{$namespace}{$request->get('group')}", $request->get('key'), $request->get('value') ?: '');
-        } else {
-            $this->translation->addSingleTranslation($language, 'single', $request->get('key'), $request->get('value') ?: '');
-        }
+        $isGroupTranslation = $request->filled('group');
+
+        $this->translation->add($request, $language, $isGroupTranslation);
 
         return redirect()
             ->route('languages.translations.index', $language)
@@ -67,11 +64,9 @@ public function store(TranslationRequest $request, $language)
 
     public function update(Request $request, $language)
     {
-        if (! Str::contains($request->get('group'), 'single')) {
-            $this->translation->addGroupTranslation($language, $request->get('group'), $request->get('key'), $request->get('value') ?: '');
-        } else {
-            $this->translation->addSingleTranslation($language, $request->get('group'), $request->get('key'), $request->get('value') ?: '');
-        }
+        $isGroupTranslation = ! Str::contains($request->get('group'), 'single');
+
+        $this->translation->add($request, $language, $isGroupTranslation);
 
         return ['success' => true];
     }

tests/DatabaseDriverTest.php

@@ -3,7 +3,9 @@
 namespace JoeDixon\Translation\Tests;
 
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Support\Facades\Event;
 use JoeDixon\Translation\Drivers\Translation;
+use JoeDixon\Translation\Events\TranslationAdded;
 use JoeDixon\Translation\Exceptions\LanguageExistsException;
 use JoeDixon\Translation\Language;
 use JoeDixon\Translation\Translation as TranslationModel;
@@ -339,4 +341,36 @@ public function a_translation_can_be_updated()
 
         $this->assertDatabaseHas('translations', ['language_id' => 1, 'group' => 'test', 'key' => 'hello', 'value' => 'Hello there!']);
     }
+
+    /** @test */
+    public function adding_a_translation_fires_an_event_with_the_expected_data()
+    {
+        Event::fake();
+
+        $data = ['key' => 'joe', 'value' => 'is cool'];
+        $this->post(config('translation.ui_url').'/en/translations', $data);
+
+        Event::assertDispatched(TranslationAdded::class, function ($event) use ($data) {
+            return $event->language === 'en' &&
+                    $event->group === 'single' &&
+                    $event->value === $data['value'] &&
+                    $event->key === $data['key'];
+        });
+    }
+
+    /** @test */
+    public function updating_a_translation_fires_an_event_with_the_expected_data()
+    {
+        Event::fake();
+
+        $data = ['group' => 'test', 'key' => 'hello', 'value' => 'Hello there!'];
+        $this->post(config('translation.ui_url').'/en/translations', $data);
+
+        Event::assertDispatched(TranslationAdded::class, function ($event) use ($data) {
+            return $event->language === 'en' &&
+                    $event->group === $data['group'] &&
+                    $event->value === $data['value'] &&
+                    $event->key === $data['key'];
+        });
+    }
 }

tests/FileDriverTest.php

@@ -2,7 +2,9 @@
 
 namespace JoeDixon\Translation\Tests;
 
+use Illuminate\Support\Facades\Event;
 use JoeDixon\Translation\Drivers\Translation;
+use JoeDixon\Translation\Events\TranslationAdded;
 use JoeDixon\Translation\Exceptions\LanguageExistsException;
 use JoeDixon\Translation\TranslationBindingsServiceProvider;
 use JoeDixon\Translation\TranslationServiceProvider;
@@ -335,4 +337,44 @@ public function a_translation_can_be_updated()
             "<?php\n\nreturn ".var_export(['hello' => 'Hello', 'whats_up' => 'What\'s up!'], true).';'.\PHP_EOL
         );
     }
+
+    /** @test */
+    public function adding_a_translation_fires_an_event_with_the_expected_data()
+    {
+        Event::fake();
+
+        $data = ['key' => 'joe', 'value' => 'is cool'];
+        $this->post(config('translation.ui_url').'/en/translations', $data);
+
+        Event::assertDispatched(TranslationAdded::class, function ($event) use ($data) {
+            return $event->language === 'en' &&
+                $event->group === 'single' &&
+                $event->value === $data['value'] &&
+                $event->key === $data['key'];
+        });
+        file_put_contents(
+            app()['path.lang'].'/en.json',
+            json_encode((object) ['Hello' => 'Hello', 'What\'s up' => 'What\'s up!'], JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT)
+        );
+    }
+
+    /** @test */
+    public function updating_a_translation_fires_an_event_with_the_expected_data()
+    {
+        Event::fake();
+
+        $data = ['group' => 'test', 'key' => 'hello', 'value' => 'Hello there!'];
+        $this->post(config('translation.ui_url').'/en/translations', $data);
+
+        Event::assertDispatched(TranslationAdded::class, function ($event) use ($data) {
+            return $event->language === 'en' &&
+                $event->group === $data['group'] &&
+                $event->value === $data['value'] &&
+                $event->key === $data['key'];
+        });
+        file_put_contents(
+            app()['path.lang'].'/en/test.php',
+            "<?php\n\nreturn ".var_export(['hello' => 'Hello', 'whats_up' => 'What\'s up!'], true).';'.\PHP_EOL
+        );
+    }
 }