Fixed BelongsToMany relationship to not cache if the target model is not also cachable

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.4.24] - 18 May 2019
+### Fixed
+- BelongsToMany relationship to not cache if the target model is not also cachable.
+
 ## [0.4.23] - 18 May 2019
 ### Added
 - tests for lazy-loading the following relationships:

src/Traits/ModelCaching.php

@@ -5,6 +5,7 @@
 use GeneaLabs\LaravelModelCaching\CachedBuilder;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
 trait ModelCaching
 {
@@ -89,7 +90,22 @@ protected function newBelongsToMany(
         $relatedKey,
         $relationName = null
     ) {
-        return new CachedBelongsToMany(
+        if (method_exists($query->getModel(), "isCachable")
+            && $query->getModel()->isCachable()
+        ) {
+            return new CachedBelongsToMany(
+                $query,
+                $parent,
+                $table,
+                $foreignPivotKey,
+                $relatedPivotKey,
+                $parentKey,
+                $relatedKey,
+                $relationName
+            );
+        }
+
+        return new BelongsToMany(
             $query,
             $parent,
             $table,

tests/Fixtures/Book.php

@@ -48,4 +48,9 @@ public function stores() : BelongsToMany
     {
         return $this->belongsToMany(Store::class);
     }
+
+    public function uncachedStores() : BelongsToMany
+    {
+        return $this->belongsToMany(UncachedStore::class, "book_store", "book_id", "store_id");
+    }
 }

tests/Integration/CachedBuilder/BelongsToManyTest.php

@@ -128,4 +128,35 @@ public function testInvalidatingCacheWhenUpdating()
         $this->assertNotEmpty($result);
         $this->assertNull($cachedResult);
     }
+
+    public function testUncachedRelatedModelDoesntCache()
+    {
+        $bookId = (new Store)
+            ->disableModelCaching()
+            ->with("books")
+            ->first()
+            ->books
+            ->first()
+            ->id;
+        $key = sha1("genealabs:laravel-model-caching:testing::memory::book-store:genealabslaravelmodelcachingcachedbelongstomany-book_store.book_id_=_{$bookId}");
+        $tags = [
+            'genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesuncachedstore',
+        ];
+
+        $result = (new Book)
+            ->find($bookId)
+            ->uncachedStores;
+        $cachedResult = $this
+            ->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+        $uncachedResult = (new UncachedBook)
+            ->find($bookId)
+            ->stores;
+
+        $this->assertEquals($uncachedResult->pluck("id"), $result->pluck("id"));
+        $this->assertNull($cachedResult);
+        $this->assertNotNull($result);
+        $this->assertNotNull($uncachedResult);
+    }
 }