Merge pull request #49 from Astrotomic/ft-translation-usage

Allows to load `translation` relation instead of load all `translations`

Author: Gummibeer

src/Translatable/Translatable.php

@@ -9,6 +9,7 @@
 use Astrotomic\Translatable\Traits\Relationship;
 
 /**
+ * @property-read null|Model $translation
  * @property-read Collection|Model[] $translations
  * @property-read string $translationModel
  * @property-read string $translationForeignKey
@@ -391,6 +392,14 @@ private function getFallbackLocale(?string $locale = null): ?string
 
     private function getTranslationByLocaleKey(string $key): ?Model
     {
+        if (
+            $this->relationLoaded('translation')
+            && $this->translation
+            && $this->translation->getAttribute($this->getLocaleKey()) == $key
+        ) {
+            return $this->translation;
+        }
+
         return $this->translations->firstWhere($this->getLocaleKey(), $key);
     }
 

tests/TranslatableTest.php

@@ -918,4 +918,56 @@ public function test_it_returns_first_existing_translation_as_fallback()
         $this->assertInstanceOf(CountryTranslation::class, $translation);
         $this->assertEquals($helper->getCountryLocale('de', 'DE'), $translation->locale);
     }
+
+    public function test_it_uses_translation_relation_if_locale_matches()
+    {
+        $this->app->make('config')->set('translatable.use_fallback', false);
+        $this->app->setLocale('de');
+
+        /** @var Country $country */
+        $country = Country::find(1);
+        $country->load('translation');
+        $this->assertTrue($country->relationLoaded('translation'));
+        $this->assertFalse($country->relationLoaded('translations'));
+
+        $translation = $country->getTranslation();
+        $this->assertInstanceOf(CountryTranslation::class, $translation);
+        $this->assertEquals('de', $translation->locale);
+        $this->assertFalse($country->relationLoaded('translations'));
+    }
+
+    public function test_it_uses_translations_relation_if_locale_does_not_match()
+    {
+        $this->app->make('config')->set('translatable.use_fallback', false);
+        $this->app->setLocale('de');
+
+        /** @var Country $country */
+        $country = Country::find(1);
+        $country->load('translation');
+        $this->assertTrue($country->relationLoaded('translation'));
+        $this->assertFalse($country->relationLoaded('translations'));
+        $this->app->setLocale('en');
+
+        $translation = $country->getTranslation();
+        $this->assertInstanceOf(CountryTranslation::class, $translation);
+        $this->assertEquals('en', $translation->locale);
+        $this->assertTrue($country->relationLoaded('translations'));
+    }
+
+    public function test_it_does_not_load_translation_relation_if_not_already_loaded()
+    {
+        $this->app->make('config')->set('translatable.use_fallback', false);
+        $this->app->setLocale('de');
+
+        /** @var Country $country */
+        $country = Country::find(1);
+        $this->assertFalse($country->relationLoaded('translation'));
+        $this->assertFalse($country->relationLoaded('translations'));
+
+        $translation = $country->getTranslation();
+        $this->assertInstanceOf(CountryTranslation::class, $translation);
+        $this->assertEquals('de', $translation->locale);
+        $this->assertFalse($country->relationLoaded('translation'));
+        $this->assertTrue($country->relationLoaded('translations'));
+    }
 }