Finish implementing optional cache disabling

Author: mikebronner

src/CachedBuilder.php

@@ -3,25 +3,21 @@
 use GeneaLabs\LaravelModelCaching\Traits\Cachable;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 
+/**
+ * @SuppressWarnings(PHPMD.TooManyPublicMethods)
+ */
 class CachedBuilder extends EloquentBuilder
 {
     use Cachable;
 
-    protected $isCacheDisabled = false;
+    protected $isCachable = true;
 
-    public function __call(string $method, array $parameters)
+    public function avg($column)
     {
-        if (method_exists($this, $method)) {
-            if (isCacheDisabled) {
-                return parent::$method($parameters);
-            }
-
-            $this->$method($parameters);
+        if (! $this->isCachable) {
+            return parent::avg($column);
         }
-    }
 
-    public function avg($column)
-    {
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey() . "-avg_{$column}", function () use ($column) {
                 return parent::avg($column);
@@ -30,6 +26,10 @@ public function avg($column)
 
     public function count($columns = ['*'])
     {
+        if (! $this->isCachable) {
+            return parent::count($columns);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey() . "-count", function () use ($columns) {
                 return parent::count($columns);
@@ -38,6 +38,10 @@ public function count($columns = ['*'])
 
     public function cursor()
     {
+        if (! $this->isCachable) {
+            return collect(parent::cursor());
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey() . "-cursor", function () {
                 return collect(parent::cursor());
@@ -52,11 +56,22 @@ public function delete()
         return parent::delete();
     }
 
+    public function disableCache()
+    {
+        $this->isCachable = false;
+
+        return $this;
+    }
+
     /**
      * @SuppressWarnings(PHPMD.ShortVariable)
      */
     public function find($id, $columns = ['*'])
     {
+        if (! $this->isCachable) {
+            return parent::find($id, $columns);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey($columns, $id), function () use ($id, $columns) {
                 return parent::find($id, $columns);
@@ -65,6 +80,10 @@ public function find($id, $columns = ['*'])
 
     public function first($columns = ['*'])
     {
+        if (! $this->isCachable) {
+            return parent::first($columns);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey($columns) . '-first', function () use ($columns) {
                 return parent::first($columns);
@@ -73,6 +92,10 @@ public function first($columns = ['*'])
 
     public function get($columns = ['*'])
     {
+        if (! $this->isCachable) {
+            return parent::get($columns);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey($columns), function () use ($columns) {
                 return parent::get($columns);
@@ -81,6 +104,10 @@ public function get($columns = ['*'])
 
     public function max($column)
     {
+        if (! $this->isCachable) {
+            return parent::max($column);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey() . "-max_{$column}", function () use ($column) {
                 return parent::max($column);
@@ -89,6 +116,10 @@ public function max($column)
 
     public function min($column)
     {
+        if (! $this->isCachable) {
+            return parent::min($column);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey() . "-min_{$column}", function () use ($column) {
                 return parent::min($column);
@@ -97,6 +128,10 @@ public function min($column)
 
     public function pluck($column, $key = null)
     {
+        if (! $this->isCachable) {
+            return parent::pluck($column, $key);
+        }
+
         $cacheKey = $this->makeCacheKey([$column]) . "-pluck_{$column}";
 
         if ($key) {
@@ -111,6 +146,10 @@ public function pluck($column, $key = null)
 
     public function sum($column)
     {
+        if (! $this->isCachable) {
+            return parent::sum($column);
+        }
+
         return $this->cache($this->makeCacheTags())
             ->rememberForever($this->makeCacheKey() . "-sum_{$column}", function () use ($column) {
                 return parent::sum($column);

src/CachedModel.php

@@ -14,6 +14,12 @@ abstract class CachedModel extends Model
 {
     public function newEloquentBuilder($query)
     {
+        if (session('genealabs-laravel-model-caching-is-disabled')) {
+            session()->forget('genealabs-laravel-model-caching-is-disabled');
+
+            return new EloquentBuilder($query);
+        }
+
         return new Builder($query);
     }
 
@@ -52,11 +58,11 @@ public function cache(array $tags = [])
         return $cache;
     }
 
-    public function scopeDisableCache(EloquentBuilder $query) : EloquentBuilder
+    public function disableCache() : self
     {
-        $query->disableCache();
+        session(['genealabs-laravel-model-caching-is-disabled' => true]);
 
-        return $query;
+        return $this;
     }
 
     public function flushCache(array $tags = [])

tests/Unit/CachedBuilderTest.php

@@ -29,7 +29,7 @@ public function setUp()
         cache()->flush();
         $publishers = factory(Publisher::class, 10)->create();
         factory(Author::class, 10)->create()
-            ->each(function($author) use ($publishers) {
+            ->each(function ($author) use ($publishers) {
                 factory(Book::class, random_int(2, 10))->make()
                     ->each(function ($book) use ($author, $publishers) {
                         $book->author()->associate($author);

tests/Unit/CachedModelTest.php

@@ -52,14 +52,19 @@ public function testAllModelResultsCreatesCache()
             'genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
-        $cachedResults = cache()->tags($tags)
+        $cachedResults = cache()
+            ->tags($tags)
             ->get($key);
-        $liveResults = (new UncachedAuthor)->all();
+        $liveResults = (new UncachedAuthor)
+            ->all();
 
         $this->assertEquals($authors, $cachedResults);
         $this->assertEmpty($liveResults->diffAssoc($cachedResults));
     }
 
+    /**
+     * @group test
+     **/
     public function testScopeDisablesCaching()
     {
         $key = 'genealabslaravelmodelcachingtestsfixturesauthor';