Add config setting to allow disabling of model-caching

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.2.36] - 23 Feb 2018
+### Added
+- config setting to allow disabling of model-caching.
+
 ## [0.2.35] - 21 Feb 2018
 ### Fixed
 - cache key generation for `find()` and `findOrFail()`.

README.md

@@ -106,13 +106,17 @@ Not only that, but it probably isn't a good idea to cache the user model anyway,
 since you always want to pull the most up-to-date info on it.
 
 ### Optional Disabling Caching of Queries
-**Recommendation: add this to all your seeder queries to avoid pulling in
+There are two methods by which model-caching can be disabled:
+1. Use `->disableCache()` in a query-by-query instance.
+2. Set `MODEL_CACHE_DISABLED=TRUE` in your `.env` file.
+
+**Recommendation: use option #1 in all your seeder queries to avoid pulling in
 cached information when reseeding multiple times.**
 You can disable a given query by using `disableCache()` in the query chain, and
 it needs to be placed (anywhere) prior to the query command (`get()`, `all()`,
 `find()`, etc). For example:
 ```php
-$results = $myModel->disableCache()->all();
+$results = $myModel->disableCache()->get();
 ```
 
 ### Manual Flushing of Specific Model

config/laravel-model-caching.php

@@ -1,7 +1,9 @@
 <?php
 
 return [
-    'store' => env('MODEL_CACHE_STORE'),
-
     'cache-prefix' => '',
+
+    'disabled' => env('MODEL_CACHE_STORE', false),
+
+    'store' => env('MODEL_CACHE_STORE'),
 ];

src/CachedBuilder.php

@@ -12,7 +12,7 @@ class CachedBuilder extends EloquentBuilder
 
     public function avg($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::avg($column);
         }
 
@@ -25,7 +25,7 @@ public function avg($column)
 
     public function count($columns = ['*'])
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::count($columns);
         }
 
@@ -38,7 +38,7 @@ public function count($columns = ['*'])
 
     public function cursor()
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return collect(parent::cursor());
         }
 
@@ -62,7 +62,7 @@ public function delete()
      */
     public function find($id, $columns = ['*'])
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::find($id, $columns);
         }
 
@@ -75,7 +75,7 @@ public function find($id, $columns = ['*'])
 
     public function first($columns = ['*'])
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::first($columns);
         }
 
@@ -88,7 +88,7 @@ public function first($columns = ['*'])
 
     public function get($columns = ['*'])
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::get($columns);
         }
 
@@ -101,7 +101,7 @@ public function get($columns = ['*'])
 
     public function max($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::max($column);
         }
 
@@ -114,7 +114,7 @@ public function max($column)
 
     public function min($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::min($column);
         }
 
@@ -131,7 +131,7 @@ public function paginate(
         $pageName = 'page',
         $page = null
     ) {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::paginate($perPage, $columns, $pageName, $page);
         }
 
@@ -145,7 +145,7 @@ public function paginate(
 
     public function pluck($column, $key = null)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::pluck($column, $key);
         }
 
@@ -159,7 +159,7 @@ public function pluck($column, $key = null)
 
     public function sum($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::sum($column);
         }
 
@@ -172,7 +172,7 @@ public function sum($column)
 
     public function value($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::value($column);
         }
 

src/Traits/Cachable.php

@@ -99,12 +99,18 @@ public static function all($columns = ['*'])
 
     public function newEloquentBuilder($query)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             $this->isCachable = true;
 
             return new EloquentBuilder($query);
         }
 
         return new CachedBuilder($query);
     }
+
+    public function isCachable() : bool
+    {
+        return $this->isCachable
+            && ! config('laravel-model-caching.disabled');
+    }
 }

tests/Unit/Traits/CachableTest.php

@@ -23,6 +23,7 @@ public function testSpecifyingAlternateCacheDriver()
     {
         $configCacheStores = config('cache.stores');
         $configCacheStores['customCache'] = ['driver' => 'array'];
+        // TODO: make sure the alternate cache is actually loaded
         config(['cache.stores' => $configCacheStores]);
         config(['laravel-model-caching.store' => 'customCache']);
         $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
@@ -49,28 +50,51 @@ public function testSetCachePrefixAttribute()
     {
         (new PrefixedAuthor)->get();
 
-        $results = $this->cache()
-            ->tags(['genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor'])
+        $results = $this->
+            cache()
+            ->tags([
+                'genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor',
+            ])
             ->get(sha1('genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor'))['value'];
 
         $this->assertNotNull($results);
     }
 
-    public function testAllReturnsCollection()
+    // public function testAllReturnsCollection()
+    // {
+    //     (new Author)->truncate();
+    //     factory(Author::class, 1)->create();
+    //     $authors = (new Author)->all();
+    //
+    //     $cachedResults = $this
+    //         ->cache()
+    //         ->tags([
+    //             'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+    //         ])
+    //         ->get(sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'))['value'];
+    //     $liveResults = (new UncachedAuthor)->all();
+    //
+    //     $this->assertInstanceOf(Collection::class, $authors);
+    //     $this->assertInstanceOf(Collection::class, $cachedResults);
+    //     $this->assertInstanceOf(Collection::class, $liveResults);
+    // }
+
+    public function testsCacheFlagDisablesCaching()
     {
-        (new Author)->truncate();
-        factory(Author::class, 1)->create();
-        $authors = (new Author)->all();
+        config(['laravel-model-caching.disabled' => true]);
 
-        $cachedResults = $this->cache()
+        $authors = (new Author)->get();
+        $cachedAuthors = $this
+            ->cache()
             ->tags([
                 'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
             ])
-            ->get(sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'))['value'];
-        $liveResults = (new UncachedAuthor)->all();
+            ->get(sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'));
+
+        config(['laravel-model-caching.disabled' => false]);
 
-        $this->assertInstanceOf(Collection::class, $authors);
-        $this->assertInstanceOf(Collection::class, $cachedResults);
-        $this->assertInstanceOf(Collection::class, $liveResults);
+        $this->assertNull($cachedAuthors);
+        $this->assertNotEmpty($authors);
+        $this->assertCount(10, $authors);
     }
 }