Merge branch 'feature/add-config-to-disable-cache' into develop

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,17 @@ 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()`.
+
+### Added
+- caching for `paginate()`;
+
 ## [0.2.33] - 19 Feb 2018
 ### Added
 - unit test to make sure `Model::all()` returns a collection when only only

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

composer.json

@@ -25,7 +25,8 @@
         "phpmd/phpmd": "*",
         "phpunit/phpunit": "*",
         "sebastian/phpcpd": "*",
-        "symfony/thanks": "^1.0"
+        "symfony/thanks": "^1.0",
+        "predis/predis": "^1.1"
     },
     "autoload": {
         "psr-4": {

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'),
 ];

phpunit.xml

@@ -9,7 +9,7 @@
     convertWarningsToExceptions="true"
     printerClass="Codedungeon\PHPUnitPrettyResultPrinter\Printer"
     processIsolation="false"
-    stopOnFailure="true"
+    stopOnFailure="false"
     syntaxCheck="false"
 >
 <testsuites>

src/CacheKey.php

@@ -13,8 +13,8 @@ class CacheKey
     protected function getCachePrefix() : string
     {
         return "genealabs:laravel-model-caching:"
-            . (config('genealabs:laravel-model-caching', '')
-                ? config('genealabs:laravel-model-caching', '') . ":"
+            . (config('laravel-model-caching.cache-prefix')
+                ? config('laravel-model-caching.cache-prefix', '') . ":"
                 : "");
     }
 

src/CacheTags.php

@@ -18,8 +18,8 @@ public function __construct(array $eagerLoad, Model $model)
     protected function getCachePrefix() : string
     {
         return "genealabs:laravel-model-caching:"
-            . (config('genealabs:laravel-model-caching', '')
-                ? config('genealabs:laravel-model-caching', '') . ":"
+            . (config('laravel-model-caching.cache-prefix')
+                ? config('laravel-model-caching.cache-prefix', '') . ":"
                 : "");
     }
 

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,20 +62,20 @@ public function delete()
      */
     public function find($id, $columns = ['*'])
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::find($id, $columns);
         }
 
         $arguments = func_get_args();
-        $cacheKey = $this->makeCacheKey($columns);
+        $cacheKey = $this->makeCacheKey(['*'], null, "-find_{$id}");
         $method = 'find';
 
         return $this->cachedValue($arguments, $cacheKey, $method);
     }
 
     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);
         }
 
@@ -125,9 +125,27 @@ public function min($column)
         return $this->cachedValue($arguments, $cacheKey, $method);
     }
 
+    public function paginate(
+        $perPage = null,
+        $columns = ['*'],
+        $pageName = 'page',
+        $page = null
+    ) {
+        if (! $this->isCachable()) {
+            return parent::paginate($perPage, $columns, $pageName, $page);
+        }
+
+        $arguments = func_get_args();
+        $page = $page ?: 1;
+        $cacheKey = $this->makeCacheKey($columns, null, "-paginate_by_{$perPage}_{$pageName}_{$page}");
+        $method = 'paginate';
+
+        return $this->cachedValue($arguments, $cacheKey, $method);
+    }
+
     public function pluck($column, $key = null)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::pluck($column, $key);
         }
 
@@ -141,7 +159,7 @@ public function pluck($column, $key = null)
 
     public function sum($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::sum($column);
         }
 
@@ -154,7 +172,7 @@ public function sum($column)
 
     public function value($column)
     {
-        if (! $this->isCachable) {
+        if (! $this->isCachable()) {
             return parent::value($column);
         }
 
@@ -197,7 +215,9 @@ protected function preventHashCollision(
         string $method
     ) {
         if ($result['key'] !== $cacheKey) {
-            cache()->tags($cacheTags)->forget($hashedCacheKey);
+            $this->cache()
+                ->tags($cacheTags)
+                ->forget($hashedCacheKey);
 
             $result = $this->retrieveCachedValue(
                 $arguments,

src/Console/Commands/Flush.php

@@ -13,9 +13,11 @@ public function handle()
 
         if (! $option) {
             cache()
-                ->store(config('laravel-model-caching:store'))
+                ->store(config('laravel-model-caching.store'))
                 ->flush();
 
+            $this->info("✔︎ Entire model cache has been flushed.");
+
             return 0;
         }
 

src/Traits/Cachable.php

@@ -11,7 +11,6 @@
 trait Cachable
 {
     protected $isCachable = true;
-    protected static $isCachableKey = 'genealabs:laravel-model-caching:is-disabled';
 
     protected function cache(array $tags = [])
     {
@@ -43,8 +42,6 @@ protected function addTagsWhenCalledFromCachedBuilder(array $tags) : array
 
     public function disableCache()
     {
-        cache()->forever(self::$isCachableKey, true);
-
         $this->isCachable = false;
 
         return $this;
@@ -89,10 +86,6 @@ public static function bootCachable()
 
     public static function all($columns = ['*'])
     {
-        if (! cache()->get(self::$isCachableKey)) {
-            return parent::all($columns);
-        }
-
         $class = get_called_class();
         $instance = new $class;
         $tags = [str_slug(get_called_class())];
@@ -106,12 +99,18 @@ public static function all($columns = ['*'])
 
     public function newEloquentBuilder($query)
     {
-        if (cache()->get(self::$isCachableKey)) {
-            cache()->forget(self::$isCachableKey);
+        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');
+    }
 }