feature/hash-cache-keys

src/CacheKey.php

@@ -17,8 +17,11 @@ public function __construct(array $eagerLoad, Model $model, Builder $query)
         $this->query = $query;
     }
 
-    public function make(array $columns = ['*'], $idColumn = null) : string
-    {
+    public function make(
+        array $columns = ['*'],
+        $idColumn = null,
+        string $keyDifferentiator = ''
+    ) : string {
         $key = $this->getModelSlug();
         $key .= $this->getIdColumn($idColumn ?: '');
         $key .= $this->getQueryColumns($columns);
@@ -27,6 +30,8 @@ public function make(array $columns = ['*'], $idColumn = null) : string
         $key .= $this->getOrderByClauses();
         $key .= $this->getOffsetClause();
         $key .= $this->getLimitClause();
+        $key .= $keyDifferentiator;
+        $key = sha1($key);
 
         return $key;
     }

src/CachedBuilder.php

@@ -17,9 +17,12 @@ public function avg($column)
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-avg_{$column}", function () use ($column) {
-                return parent::avg($column);
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-avg_{$column}"),
+                function () use ($column) {
+                    return parent::avg($column);
+                }
+            );
     }
 
     public function count($columns = ['*'])
@@ -29,9 +32,12 @@ public function count($columns = ['*'])
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-count", function () use ($columns) {
-                return parent::count($columns);
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-count"),
+                function () use ($columns) {
+                    return parent::count($columns);
+                }
+            );
     }
 
     public function cursor()
@@ -41,9 +47,12 @@ public function cursor()
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-cursor", function () {
-                return collect(parent::cursor());
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-cursor"),
+                function () {
+                    return collect(parent::cursor());
+                }
+            );
     }
 
     public function delete()
@@ -64,9 +73,12 @@ public function find($id, $columns = ['*'])
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey($columns, $id), function () use ($id, $columns) {
-                return parent::find($id, $columns);
-            });
+            ->rememberForever(
+                $this->makeCacheKey($columns, $id),
+                function () use ($id, $columns) {
+                    return parent::find($id, $columns);
+                }
+            );
     }
 
     public function first($columns = ['*'])
@@ -76,9 +88,12 @@ public function first($columns = ['*'])
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey($columns) . '-first', function () use ($columns) {
-                return parent::first($columns);
-            });
+            ->rememberForever(
+                $this->makeCacheKey($columns, null, '-first'),
+                function () use ($columns) {
+                    return parent::first($columns);
+                }
+            );
     }
 
     public function get($columns = ['*'])
@@ -88,9 +103,12 @@ public function get($columns = ['*'])
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey($columns), function () use ($columns) {
-                return parent::get($columns);
-            });
+            ->rememberForever(
+                $this->makeCacheKey($columns),
+                function () use ($columns) {
+                    return parent::get($columns);
+                }
+            );
     }
 
     public function max($column)
@@ -100,9 +118,12 @@ public function max($column)
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-max_{$column}", function () use ($column) {
-                return parent::max($column);
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-max_{$column}"),
+                function () use ($column) {
+                    return parent::max($column);
+                }
+            );
     }
 
     public function min($column)
@@ -112,9 +133,12 @@ public function min($column)
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-min_{$column}", function () use ($column) {
-                return parent::min($column);
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-min_{$column}"),
+                function () use ($column) {
+                    return parent::min($column);
+                }
+            );
     }
 
     public function pluck($column, $key = null)
@@ -123,11 +147,8 @@ public function pluck($column, $key = null)
             return parent::pluck($column, $key);
         }
 
-        $cacheKey = $this->makeCacheKey([$column]) . "-pluck_{$column}";
-
-        if ($key) {
-            $cacheKey .= "_{$key}";
-        }
+        $keyDifferentiator = "-pluck_{$column}" . ($key ? "_{$key}" : "");
+        $cacheKey = $this->makeCacheKey([$column], null, $keyDifferentiator);
 
         return $this->cache($this->makeCacheTags())
             ->rememberForever($cacheKey, function () use ($column, $key) {
@@ -142,9 +163,12 @@ public function sum($column)
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-sum_{$column}", function () use ($column) {
-                return parent::sum($column);
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-sum_{$column}"),
+                function () use ($column) {
+                    return parent::sum($column);
+                }
+            );
     }
 
     public function value($column)
@@ -154,8 +178,11 @@ public function value($column)
         }
 
         return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-value_{$column}", function () use ($column) {
-                return parent::value($column);
-            });
+            ->rememberForever(
+                $this->makeCacheKey(['*'], null, "-value_{$column}"),
+                function () use ($column) {
+                    return parent::value($column);
+                }
+            );
     }
 }

src/CachedModel.php

@@ -55,7 +55,7 @@ public static function all($columns = ['*'])
         $class = get_called_class();
         $instance = new $class;
         $tags = [str_slug(get_called_class())];
-        $key = 'genealabslaravelmodelcachingtestsfixturesauthor';
+        $key = $instance->makeCacheKey();
 
         return $instance->cache($tags)
             ->rememberForever($key, function () use ($columns) {

src/Traits/Cachable.php

@@ -4,6 +4,7 @@
 use GeneaLabs\LaravelModelCaching\CacheTags;
 use GeneaLabs\LaravelModelCaching\CachedModel;
 use Illuminate\Cache\TaggableStore;
+use Illuminate\Database\Query\Builder;
 
 trait Cachable
 {
@@ -41,10 +42,17 @@ public function flushCache(array $tags = [])
         $this->cache($tags)->flush();
     }
 
-    protected function makeCacheKey(array $columns = ['*'], $idColumn = null) : string
-    {
-        return (new CacheKey($this->eagerLoad, $this->model, $this->query))
-            ->make($columns, $idColumn);
+    protected function makeCacheKey(
+        array $columns = ['*'],
+        $idColumn = null,
+        string $keyDifferentiator = ''
+    ) : string {
+        $eagerLoad = $this->eagerLoad ?? [];
+        $model = $this->model ?? $this;
+        $query = $this->query ?? app(Builder::class);
+
+        return (new CacheKey($eagerLoad, $model, $query))
+            ->make($columns, $idColumn, $keyDifferentiator);
     }
 
     protected function makeCacheTags() : array

tests/Unit/CacheKeyTest.php

@@ -0,0 +1,23 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Unit;
+
+use GeneaLabs\LaravelModelCaching\CachedBuilder;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\UnitTestCase;
+use ReflectionMethod;
+
+class CacheKeyTest extends UnitTestCase
+{
+    public function testKeyIsSHA1()
+    {
+        $makeCacheKey = new ReflectionMethod(
+            CachedBuilder::class,
+            'makeCacheKey'
+        );
+        $makeCacheKey->setAccessible(true);
+
+        $builder = (new Author)->startsWithA();
+        $key = $makeCacheKey->invoke($builder);
+
+        $this->assertTrue(strlen($key) === 40 && ctype_xdigit($key));
+    }
+}