Add methods getTranslationChanges() and wasTranslationChanged()

src/Translatable/Translatable.php

@@ -4,6 +4,7 @@
 
 use Astrotomic\Translatable\Traits\Relationship;
 use Astrotomic\Translatable\Traits\Scopes;
+use Astrotomic\Translatable\Validation\RuleFactory;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
@@ -458,4 +459,35 @@ public function __isset($key)
     {
         return $this->isTranslationAttribute($key) || parent::__isset($key);
     }
+
+    public function getTranslationChanges(): array
+    {
+        switch (config('translatable.rule_factory.format')) {
+            case RuleFactory::FORMAT_KEY:
+                $replacementFunc = function (string $key, string $locale): string {
+                    return $key . ':' . $locale;
+                };
+                break;
+            default:
+                $replacementFunc = function (string $key, string $locale): string {
+                    return $locale . '.' . $key;
+                };
+        }
+        $translationChanges = array();
+        foreach ($this->translations as $translation) {
+            $locale = $translation->locale;
+            foreach ($translation->getChanges() as $attribute => $value) {
+                $translationChanges[$replacementFunc($attribute, $locale)] = $value;
+            }
+        }
+        return $translationChanges;
+    }
+
+    public function wasTranslationChanged($attributes = null): bool
+    {
+        return $this->hasChanges(
+            $this->getTranslationChanges(),
+            is_array($attributes) ? $attributes : func_get_args()
+        );
+    }
 }

tests/TranslatableTest.php

@@ -9,6 +9,7 @@
 use Astrotomic\Translatable\Tests\Eloquent\Person;
 use Astrotomic\Translatable\Tests\Eloquent\Vegetable;
 use Astrotomic\Translatable\Tests\Eloquent\VegetableTranslation;
+use Astrotomic\Translatable\Validation\RuleFactory;
 use Illuminate\Database\Eloquent\MassAssignmentException;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Support\Facades\App;
@@ -438,10 +439,10 @@ public function it_returns_if_attribute_is_translated(): void
     /** @test */
     public function config_overrides_apps_locale(): void
     {
-        $veegtable = factory(Vegetable::class)->create(['name:de' => 'Erbsen']);
+        $vegetable = factory(Vegetable::class)->create(['name:de' => 'Erbsen']);
         App::make('config')->set('translatable.locale', 'de');
 
-        static::assertEquals('Erbsen', $veegtable->name);
+        static::assertEquals('Erbsen', $vegetable->name);
     }
 
     /** @test */
@@ -1058,4 +1059,49 @@ public function it_can_restore_translations_in_a_transaction()
         $this->assertDatabaseHas('vegetables', ['identity' => $vegetable->identity]);
         $this->assertDatabaseHas('vegetable_translations', ['vegetable_identity' => $vegetable->identity]);
     }
+
+    /** @test */
+    public function it_returns_no_translation_changes_for_unchanged_model()
+    {
+        $vegetable = factory(Vegetable::class)->create([
+            'en' => ['name' => 'Peas'],
+            'de' => ['name' => 'Erbsen']
+        ]);
+        $changes = $vegetable->getTranslationChanges();
+        static::assertIsArray($changes);
+        static::assertEmpty($changes);
+        static::assertFalse($vegetable->wasTranslationChanged());
+    }
+
+    /** @test */
+    public function it_returns_translation_changes_for_changed_model()
+    {
+        $vegetable = factory(Vegetable::class)->create([
+            'en' => ['name' => 'Peas'],
+            'de' => ['name' => 'Birnen']
+        ]);
+        $vegetable->fill(['de' => ['name' => 'Erbsen']]);
+        $vegetable->save();
+
+        static::assertEquals(['de.name' => 'Erbsen'], $vegetable->getTranslationChanges());
+        static::assertTrue($vegetable->wasTranslationChanged());
+        static::assertTrue($vegetable->wasTranslationChanged('de.name'));
+        static::assertFalse($vegetable->wasTranslationChanged('en.name'));
+    }
+
+    /** @test */
+    public function it_returns_translation_changes_in_format_array()
+    {
+        $this->app->make('config')->set('translatable.rule_factory.format', RuleFactory::FORMAT_KEY);
+        $vegetable = factory(Vegetable::class)->create([
+            'en' => ['name' => 'Peas'],
+            'de' => ['name' => 'Birnen']
+        ]);
+        $vegetable->fill(['de' => ['name' => 'Erbsen']]);
+        $vegetable->save();
+
+        static::assertEquals(['name:de' => 'Erbsen'], $vegetable->getTranslationChanges());
+        static::assertTrue($vegetable->wasTranslationChanged('name:de'));
+        static::assertFalse($vegetable->wasTranslationChanged('de.name'));
+    }
 }