Do some more refactoring

mikebronner · mikebronner · commit 9edd7755df6a · 2017-10-17T14:13:10.000-07:00
diff --git a/src/CachedBuilder.php b/src/CachedBuilder.php
@@ -13,24 +13,24 @@ class CachedBuilder extends EloquentBuilder
 
     public function avg($column)
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-avg_{$column}", function () use ($column) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this) . "-avg_{$column}", function () use ($column) {
                 return parent::avg($column);
             });
     }
 
     public function count($columns = ['*'])
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-count", function () use ($columns) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this) . "-count", function () use ($columns) {
                 return parent::count($columns);
             });
     }
 
     public function cursor()
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-cursor", function () {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this) . "-cursor", function () {
                 return collect(parent::cursor());
             });
     }
@@ -40,62 +40,62 @@ public function cursor()
      */
     public function find($id, $columns = ['*'])
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey($columns, $id), function () use ($id, $columns) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this, $columns, $id), function () use ($id, $columns) {
                 return parent::find($id, $columns);
             });
     }
 
     public function first($columns = ['*'])
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey($columns) . '-first', function () use ($columns) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this, $columns) . '-first', function () use ($columns) {
                 return parent::first($columns);
             });
     }
 
     public function get($columns = ['*'])
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey($columns), function () use ($columns) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this, $columns), function () use ($columns) {
                 return parent::get($columns);
             });
     }
 
     public function max($column)
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-max_{$column}", function () use ($column) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this) . "-max_{$column}", function () use ($column) {
                 return parent::max($column);
             });
     }
 
     public function min($column)
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-min_{$column}", function () use ($column) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this) . "-min_{$column}", function () use ($column) {
                 return parent::min($column);
             });
     }
 
     public function pluck($column, $key = null)
     {
-        $cacheKey = $this->makeCacheKey([$column]) . "-pluck_{$column}";
+        $cacheKey = $this->makeCacheKey($this, [$column]) . "-pluck_{$column}";
 
         if ($key) {
             $cacheKey .= "_{$key}";
         }
 
-        return $this->cache($this->makeCacheTags())
+        return $this->cache($this->makeCacheTags($this))
             ->rememberForever($cacheKey, function () use ($column, $key) {
                 return parent::pluck($column, $key);
             });
     }
 
     public function sum($column)
     {
-        return $this->cache($this->makeCacheTags())
-            ->rememberForever($this->makeCacheKey() . "-sum_{$column}", function () use ($column) {
+        return $this->cache($this->makeCacheTags($this))
+            ->rememberForever($this->makeCacheKey($this) . "-sum_{$column}", function () use ($column) {
                 return parent::sum($column);
             });
     }
diff --git a/src/Traits/CacheKeyable.php b/src/Traits/CacheKeyable.php
@@ -1,19 +1,23 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Traits;
 
+use GeneaLabs\LaravelModelCaching\CachedBuilder;
 use Illuminate\Support\Collection;
 
 trait CacheKeyable
 {
-    protected function makeCacheKey(array $columns = ['*'], $idColumn = null) : string
-    {
-        $key = $this->getModelSlug();
+    protected function makeCacheKey(
+        CachedBuilder $builder,
+        array $columns = ['*'],
+        $idColumn = null
+    ) : string {
+        $key = $this->getModelSlug($builder);
         $key .= $this->getIdColumn($idColumn ?: '');
         $key .= $this->getQueryColumns($columns);
-        $key .= $this->getWhereClauses();
-        $key .= $this->getWithModels();
-        $key .= $this->getOrderByClauses();
-        $key .= $this->getOffsetClause();
-        $key .= $this->getLimitClause();
+        $key .= $this->getWhereClauses($builder);
+        $key .= $this->getWithModels($builder);
+        $key .= $this->getOrderByClauses($builder);
+        $key .= $this->getOffsetClause($builder);
+        $key .= $this->getLimitClause($builder);
 
         return $key;
     }
@@ -23,32 +27,32 @@ protected function getIdColumn(string $idColumn) : string
         return $idColumn ? "_{$idColumn}" : '';
     }
 
-    protected function getLimitClause() : string
+    protected function getLimitClause(CachedBuilder $builder) : string
     {
-        if (! $this->query->limit) {
+        if (! $builder->query->limit) {
             return '';
         }
 
-        return "-limit_{$this->query->limit}";
+        return "-limit_{$builder->query->limit}";
     }
 
-    protected function getModelSlug() : string
+    protected function getModelSlug(CachedBuilder $builder) : string
     {
-        return str_slug(get_class($this->model));
+        return str_slug(get_class($builder->model));
     }
 
-    protected function getOffsetClause() : string
+    protected function getOffsetClause(CachedBuilder $builder) : string
     {
-        if (! $this->query->offset) {
+        if (! $builder->query->offset) {
             return '';
         }
 
-        return "-offset_{$this->query->offset}";
+        return "-offset_{$builder->query->offset}";
     }
 
-    protected function getOrderByClauses() : string
+    protected function getOrderByClauses(CachedBuilder $builder) : string
     {
-        $orders = collect($this->query->orders);
+        $orders = collect($builder->query->orders);
 
         return $orders->reduce(function($carry, $order){
             return $carry . '_orderBy_' . $order['column'] . '_' . $order['direction'];
@@ -79,12 +83,12 @@ protected function getValuesClause(array $where = null) : string
             : '';
     }
 
-    protected function getWhereClauses(array $wheres = []) : string
+    protected function getWhereClauses(CachedBuilder $builder, array $wheres = []) : string
     {
-        return $this->getWheres($wheres)
-            ->reduce(function ($carry, $where) {
+        return $this->getWheres($builder, $wheres)
+            ->reduce(function ($carry, $where) use ($builder) {
                 if (in_array($where['type'], ['Exists', 'Nested', 'NotExists'])) {
-                    return '_' . strtolower($where['type']) . $this->getWhereClauses($where['query']->wheres);
+                    return '_' . strtolower($where['type']) . $this->getWhereClauses($builder, $where['query']->wheres);
                 }
 
                 if ($where['type'] === 'Column') {
@@ -104,20 +108,20 @@ protected function getWhereClauses(array $wheres = []) : string
             . '';
     }
 
-    protected function getWheres(array $wheres) : Collection
+    protected function getWheres(CachedBuilder $builder, array $wheres) : Collection
     {
         $wheres = collect($wheres);
 
         if ($wheres->isEmpty()) {
-            $wheres = collect($this->query->wheres);
+            $wheres = collect($builder->query->wheres);
         }
 
         return $wheres;
     }
 
-    protected function getWithModels() : string
+    protected function getWithModels(CachedBuilder $builder) : string
     {
-        $eagerLoads = collect($this->eagerLoad);
+        $eagerLoads = collect($builder->eagerLoad);
 
         if ($eagerLoads->isEmpty()) {
             return '';
diff --git a/src/Traits/CacheTagable.php b/src/Traits/CacheTagable.php
@@ -1,18 +1,19 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Traits;
 
+use GeneaLabs\LaravelModelCaching\CachedBuilder;
 use Illuminate\Database\Eloquent\Relations\Relation;
 
 trait CacheTagable
 {
-    public function makeCacheTags() : array
+    public function makeCacheTags(CachedBuilder $builder) : array
     {
-        return collect($this->eagerLoad)
+        return collect($builder->eagerLoad)
             ->keys()
-            ->map(function ($relationName) {
+            ->map(function ($relationName) use ($builder) {
                 $relation = collect(explode('.', $relationName))
-                    ->reduce(function ($carry, $name) {
+                    ->reduce(function ($carry, $name) use ($builder) {
                         if (! $carry) {
-                            $carry = $this->model;
+                            $carry = $builder->model;
                         }
 
                         if ($carry instanceof Relation) {
@@ -24,7 +25,7 @@ public function makeCacheTags() : array
 
                 return str_slug(get_class($relation->getQuery()->model));
             })
-            ->prepend(str_slug(get_class($this->model)))
+            ->prepend(str_slug(get_class($builder->model)))
             ->values()
             ->toArray();
     }

Original file line number	Diff line number	Diff line change
`@@ -13,24 +13,24 @@ class CachedBuilder extends EloquentBuilder`
`13`	`13`
`14`	`14`	`public function avg($column)`
`15`	`15`	`{`
`16`		`- return $this->cache($this->makeCacheTags())`
`17`		`- ->rememberForever($this->makeCacheKey() . "-avg_{$column}", function () use ($column) {`
	`16`	`+ return $this->cache($this->makeCacheTags($this))`
	`17`	`+ ->rememberForever($this->makeCacheKey($this) . "-avg_{$column}", function () use ($column) {`
`18`	`18`	`return parent::avg($column);`
`19`	`19`	`});`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`public function count($columns = ['*'])`
`23`	`23`	`{`
`24`		`- return $this->cache($this->makeCacheTags())`
`25`		`- ->rememberForever($this->makeCacheKey() . "-count", function () use ($columns) {`
	`24`	`+ return $this->cache($this->makeCacheTags($this))`
	`25`	`+ ->rememberForever($this->makeCacheKey($this) . "-count", function () use ($columns) {`
`26`	`26`	`return parent::count($columns);`
`27`	`27`	`});`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public function cursor()`
`31`	`31`	`{`
`32`		`- return $this->cache($this->makeCacheTags())`
`33`		`- ->rememberForever($this->makeCacheKey() . "-cursor", function () {`
	`32`	`+ return $this->cache($this->makeCacheTags($this))`
	`33`	`+ ->rememberForever($this->makeCacheKey($this) . "-cursor", function () {`
`34`	`34`	`return collect(parent::cursor());`
`35`	`35`	`});`
`36`	`36`	`}`
`@@ -40,62 +40,62 @@ public function cursor()`
`40`	`40`	`*/`
`41`	`41`	`public function find($id, $columns = ['*'])`
`42`	`42`	`{`
`43`		`- return $this->cache($this->makeCacheTags())`
`44`		`- ->rememberForever($this->makeCacheKey($columns, $id), function () use ($id, $columns) {`
	`43`	`+ return $this->cache($this->makeCacheTags($this))`
	`44`	`+ ->rememberForever($this->makeCacheKey($this, $columns, $id), function () use ($id, $columns) {`
`45`	`45`	`return parent::find($id, $columns);`
`46`	`46`	`});`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`public function first($columns = ['*'])`
`50`	`50`	`{`
`51`		`- return $this->cache($this->makeCacheTags())`
`52`		`- ->rememberForever($this->makeCacheKey($columns) . '-first', function () use ($columns) {`
	`51`	`+ return $this->cache($this->makeCacheTags($this))`
	`52`	`+ ->rememberForever($this->makeCacheKey($this, $columns) . '-first', function () use ($columns) {`
`53`	`53`	`return parent::first($columns);`
`54`	`54`	`});`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`public function get($columns = ['*'])`
`58`	`58`	`{`
`59`		`- return $this->cache($this->makeCacheTags())`
`60`		`- ->rememberForever($this->makeCacheKey($columns), function () use ($columns) {`
	`59`	`+ return $this->cache($this->makeCacheTags($this))`
	`60`	`+ ->rememberForever($this->makeCacheKey($this, $columns), function () use ($columns) {`
`61`	`61`	`return parent::get($columns);`
`62`	`62`	`});`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`public function max($column)`
`66`	`66`	`{`
`67`		`- return $this->cache($this->makeCacheTags())`
`68`		`- ->rememberForever($this->makeCacheKey() . "-max_{$column}", function () use ($column) {`
	`67`	`+ return $this->cache($this->makeCacheTags($this))`
	`68`	`+ ->rememberForever($this->makeCacheKey($this) . "-max_{$column}", function () use ($column) {`
`69`	`69`	`return parent::max($column);`
`70`	`70`	`});`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`public function min($column)`
`74`	`74`	`{`
`75`		`- return $this->cache($this->makeCacheTags())`
`76`		`- ->rememberForever($this->makeCacheKey() . "-min_{$column}", function () use ($column) {`
	`75`	`+ return $this->cache($this->makeCacheTags($this))`
	`76`	`+ ->rememberForever($this->makeCacheKey($this) . "-min_{$column}", function () use ($column) {`
`77`	`77`	`return parent::min($column);`
`78`	`78`	`});`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`public function pluck($column, $key = null)`
`82`	`82`	`{`
`83`		`- $cacheKey = $this->makeCacheKey([$column]) . "-pluck_{$column}";`
	`83`	`+ $cacheKey = $this->makeCacheKey($this, [$column]) . "-pluck_{$column}";`
`84`	`84`
`85`	`85`	`if ($key) {`
`86`	`86`	`$cacheKey .= "_{$key}";`
`87`	`87`	`}`
`88`	`88`
`89`		`- return $this->cache($this->makeCacheTags())`
	`89`	`+ return $this->cache($this->makeCacheTags($this))`
`90`	`90`	`->rememberForever($cacheKey, function () use ($column, $key) {`
`91`	`91`	`return parent::pluck($column, $key);`
`92`	`92`	`});`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`public function sum($column)`
`96`	`96`	`{`
`97`		`- return $this->cache($this->makeCacheTags())`
`98`		`- ->rememberForever($this->makeCacheKey() . "-sum_{$column}", function () use ($column) {`
	`97`	`+ return $this->cache($this->makeCacheTags($this))`
	`98`	`+ ->rememberForever($this->makeCacheKey($this) . "-sum_{$column}", function () use ($column) {`
`99`	`99`	`return parent::sum($column);`
`100`	`100`	`});`
`101`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,19 +1,23 @@`
`1`	`1`	`<?php namespace GeneaLabs\LaravelModelCaching\Traits;`
`2`	`2`
	`3`	`+use GeneaLabs\LaravelModelCaching\CachedBuilder;`
`3`	`4`	`use Illuminate\Support\Collection;`
`4`	`5`
`5`	`6`	`trait CacheKeyable`
`6`	`7`	`{`
`7`		`- protected function makeCacheKey(array $columns = ['*'], $idColumn = null) : string`
`8`		`- {`
`9`		`- $key = $this->getModelSlug();`
	`8`	`+ protected function makeCacheKey(`
	`9`	`+ CachedBuilder $builder,`
	`10`	`+ array $columns = ['*'],`
	`11`	`+ $idColumn = null`
	`12`	`+ ) : string {`
	`13`	`+ $key = $this->getModelSlug($builder);`
`10`	`14`	`$key .= $this->getIdColumn($idColumn ?: '');`
`11`	`15`	`$key .= $this->getQueryColumns($columns);`
`12`		`- $key .= $this->getWhereClauses();`
`13`		`- $key .= $this->getWithModels();`
`14`		`- $key .= $this->getOrderByClauses();`
`15`		`- $key .= $this->getOffsetClause();`
`16`		`- $key .= $this->getLimitClause();`
	`16`	`+ $key .= $this->getWhereClauses($builder);`
	`17`	`+ $key .= $this->getWithModels($builder);`
	`18`	`+ $key .= $this->getOrderByClauses($builder);`
	`19`	`+ $key .= $this->getOffsetClause($builder);`
	`20`	`+ $key .= $this->getLimitClause($builder);`
`17`	`21`
`18`	`22`	`return $key;`
`19`	`23`	`}`
`@@ -23,32 +27,32 @@ protected function getIdColumn(string $idColumn) : string`
`23`	`27`	`return $idColumn ? "_{$idColumn}" : '';`
`24`	`28`	`}`
`25`	`29`
`26`		`- protected function getLimitClause() : string`
	`30`	`+ protected function getLimitClause(CachedBuilder $builder) : string`
`27`	`31`	`{`
`28`		`- if (! $this->query->limit) {`
	`32`	`+ if (! $builder->query->limit) {`
`29`	`33`	`return '';`
`30`	`34`	`}`
`31`	`35`
`32`		`- return "-limit_{$this->query->limit}";`
	`36`	`+ return "-limit_{$builder->query->limit}";`
`33`	`37`	`}`
`34`	`38`
`35`		`- protected function getModelSlug() : string`
	`39`	`+ protected function getModelSlug(CachedBuilder $builder) : string`
`36`	`40`	`{`
`37`		`- return str_slug(get_class($this->model));`
	`41`	`+ return str_slug(get_class($builder->model));`
`38`	`42`	`}`
`39`	`43`
`40`		`- protected function getOffsetClause() : string`
	`44`	`+ protected function getOffsetClause(CachedBuilder $builder) : string`
`41`	`45`	`{`
`42`		`- if (! $this->query->offset) {`
	`46`	`+ if (! $builder->query->offset) {`
`43`	`47`	`return '';`
`44`	`48`	`}`
`45`	`49`
`46`		`- return "-offset_{$this->query->offset}";`
	`50`	`+ return "-offset_{$builder->query->offset}";`
`47`	`51`	`}`
`48`	`52`
`49`		`- protected function getOrderByClauses() : string`
	`53`	`+ protected function getOrderByClauses(CachedBuilder $builder) : string`
`50`	`54`	`{`
`51`		`- $orders = collect($this->query->orders);`
	`55`	`+ $orders = collect($builder->query->orders);`
`52`	`56`
`53`	`57`	`return $orders->reduce(function($carry, $order){`
`54`	`58`	`return $carry . '_orderBy_' . $order['column'] . '_' . $order['direction'];`
`@@ -79,12 +83,12 @@ protected function getValuesClause(array $where = null) : string`
`79`	`83`	`: '';`
`80`	`84`	`}`
`81`	`85`
`82`		`- protected function getWhereClauses(array $wheres = []) : string`
	`86`	`+ protected function getWhereClauses(CachedBuilder $builder, array $wheres = []) : string`
`83`	`87`	`{`
`84`		`- return $this->getWheres($wheres)`
`85`		`- ->reduce(function ($carry, $where) {`
	`88`	`+ return $this->getWheres($builder, $wheres)`
	`89`	`+ ->reduce(function ($carry, $where) use ($builder) {`
`86`	`90`	`if (in_array($where['type'], ['Exists', 'Nested', 'NotExists'])) {`
`87`		`- return '_' . strtolower($where['type']) . $this->getWhereClauses($where['query']->wheres);`
	`91`	`+ return '_' . strtolower($where['type']) . $this->getWhereClauses($builder, $where['query']->wheres);`
`88`	`92`	`}`
`89`	`93`
`90`	`94`	`if ($where['type'] === 'Column') {`
`@@ -104,20 +108,20 @@ protected function getWhereClauses(array $wheres = []) : string`
`104`	`108`	`. '';`
`105`	`109`	`}`
`106`	`110`
`107`		`- protected function getWheres(array $wheres) : Collection`
	`111`	`+ protected function getWheres(CachedBuilder $builder, array $wheres) : Collection`
`108`	`112`	`{`
`109`	`113`	`$wheres = collect($wheres);`
`110`	`114`
`111`	`115`	`if ($wheres->isEmpty()) {`
`112`		`- $wheres = collect($this->query->wheres);`
	`116`	`+ $wheres = collect($builder->query->wheres);`
`113`	`117`	`}`
`114`	`118`
`115`	`119`	`return $wheres;`
`116`	`120`	`}`
`117`	`121`
`118`		`- protected function getWithModels() : string`
	`122`	`+ protected function getWithModels(CachedBuilder $builder) : string`
`119`	`123`	`{`
`120`		`- $eagerLoads = collect($this->eagerLoad);`
	`124`	`+ $eagerLoads = collect($builder->eagerLoad);`
`121`	`125`
`122`	`126`	`if ($eagerLoads->isEmpty()) {`
`123`	`127`	`return '';`