Merge branch 'release/0.2.38'

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,14 @@ 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.38] - 24 Feb 2018
+### Added
+- cache-invalidation-cool-down functionality.
+
+## [0.2.37] - 23 Feb 2018
+### Added
+- disabling of `->all()` method caching via config flag.
+
 ## [0.2.36] - 23 Feb 2018
 ### Added
 - config setting to allow disabling of model-caching.
@@ -15,6 +23,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - caching for `paginate()`;
 
+## [0.2.34] - 21 Feb 2018
+### Added
+- implementation tests using redis.
+- additional tests for some edge case scenarios.
+
+### Fixed
+- cache key prefix functionality.
+
+### Updated
+- tests through refactoring and cleaning up.
+
 ## [0.2.33] - 19 Feb 2018
 ### Added
 - unit test to make sure `Model::all()` returns a collection when only only

README.md

@@ -41,7 +41,7 @@ environment variable in your `.env` file to the name of a cache store configured
 in `config/cache.php` (you can define any custom cache store based on your
 specific needs there). For example:
 ```
-MODEL_CACHE_STORE=redis
+MODEL_CACHE_STORE=redis2
 ```
 
 ## Usage
@@ -105,7 +105,20 @@ extends `Illuminate\Foundation\Auth\User`. Overriding that would break functiona
 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
+### Experimental: Cache Cool-down In Specific Models
+In some instances, you may want to add a cache invalidation cool-down period.
+For example you might have a busy site where comments are submitted at a high
+rate, and you don't want every comment submission to invalidate the cache. While
+I don't necessarily recommend this, you might experiment it's effectiveness.
+
+It can be implemented like so:
+```php
+(new Comment)
+    ->withCacheCooldownSeconds(30)
+    ->get();
+```
+
+### Disabling Caching of Queries
 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.

src/CacheKey.php

@@ -13,8 +13,8 @@ class CacheKey
     protected function getCachePrefix() : string
     {
         return "genealabs:laravel-model-caching:"
-            . (config('laravel-model-caching.cache-prefix')
-                ? config('laravel-model-caching.cache-prefix', '') . ":"
+            . (config("laravel-model-caching.cache-prefix")
+                ? config("laravel-model-caching.cache-prefix", "") . ":"
                 : "");
     }
 
@@ -29,13 +29,13 @@ public function __construct(
     }
 
     public function make(
-        array $columns = ['*'],
+        array $columns = ["*"],
         $idColumn = null,
-        string $keyDifferentiator = ''
+        string $keyDifferentiator = ""
     ) : string {
         $key = $this->getCachePrefix();
         $key .= $this->getModelSlug();
-        $key .= $this->getIdColumn($idColumn ?: '');
+        $key .= $this->getIdColumn($idColumn ?: "");
         $key .= $this->getQueryColumns($columns);
         $key .= $this->getWhereClauses();
         $key .= $this->getWithModels();
@@ -49,13 +49,13 @@ public function make(
 
     protected function getIdColumn(string $idColumn) : string
     {
-        return $idColumn ? "_{$idColumn}" : '';
+        return $idColumn ? "_{$idColumn}" : "";
     }
 
     protected function getLimitClause() : string
     {
         if (! $this->query->limit) {
-            return '';
+            return "";
         }
 
         return "-limit_{$this->query->limit}";
@@ -69,7 +69,7 @@ protected function getModelSlug() : string
     protected function getOffsetClause() : string
     {
         if (! $this->query->offset) {
-            return '';
+            return "";
         }
 
         return "-offset_{$this->query->offset}";
@@ -81,48 +81,48 @@ protected function getOrderByClauses() : string
 
         return $orders
             ->reduce(function ($carry, $order) {
-                if (($order['type'] ?? '') === 'Raw') {
-                    return $carry . '_orderByRaw_' . str_slug($order['sql']);
+                if (($order["type"] ?? "") === "Raw") {
+                    return $carry . "_orderByRaw_" . str_slug($order["sql"]);
                 }
 
-                return $carry . '_orderBy_' . $order['column'] . '_' . $order['direction'];
+                return $carry . "_orderBy_" . $order["column"] . "_" . $order["direction"];
             })
-            ?: '';
+            ?: "";
     }
 
     protected function getQueryColumns(array $columns) : string
     {
-        if ($columns === ['*'] || $columns === []) {
-            return '';
+        if ($columns === ["*"] || $columns === []) {
+            return "";
         }
 
-        return '_' . implode('_', $columns);
+        return "_" . implode("_", $columns);
     }
 
     protected function getTypeClause($where) : string
     {
-        $type =in_array($where['type'], ['In', 'NotIn', 'Null', 'NotNull', 'between'])
-            ? strtolower($where['type'])
-            : strtolower($where['operator']);
+        $type =in_array($where["type"], ["In", "NotIn", "Null", "NotNull", "between"])
+            ? strtolower($where["type"])
+            : strtolower($where["operator"]);
 
-        return str_replace(' ', '_', $type);
+        return str_replace(" ", "_", $type);
     }
 
     protected function getValuesClause(array $where = null) : string
     {
-        if (in_array($where['type'], ['NotNull'])) {
-            return '';
+        if (in_array($where["type"], ["NotNull"])) {
+            return "";
         }
 
-        $values = is_array(array_get($where, 'values'))
-            ? implode('_', $where['values'])
-            : '';
+        $values = is_array(array_get($where, "values"))
+            ? implode("_", $where["values"])
+            : "";
 
-        if (! $values && $this->query->bindings['where'] ?? false) {
-            $values = implode('_', $this->query->bindings['where']);
+        if (! $values && $this->query->bindings["where"] ?? false) {
+            $values = implode("_", $this->query->bindings["where"]);
         }
 
-        return '_' . $values;
+        return "_" . $values;
     }
 
     protected function getWhereClauses(array $wheres = []) : string
@@ -136,46 +136,46 @@ protected function getWhereClauses(array $wheres = []) : string
 
                 return $value;
             })
-            . '';
+            . "";
     }
 
     protected function getNestedClauses(array $where) : string
     {
-        if (! in_array($where['type'], ['Exists', 'Nested', 'NotExists'])) {
-            return '';
+        if (! in_array($where["type"], ["Exists", "Nested", "NotExists"])) {
+            return "";
         }
 
-        return '_' . strtolower($where['type']) . $this->getWhereClauses($where['query']->wheres);
+        return "_" . strtolower($where["type"]) . $this->getWhereClauses($where["query"]->wheres);
     }
 
     protected function getColumnClauses(array $where) : string
     {
-        if ($where['type'] !== 'Column') {
-            return '';
+        if ($where["type"] !== "Column") {
+            return "";
         }
 
-        return "_{$where['boolean']}_{$where['first']}_{$where['operator']}_{$where['second']}";
+        return "_{$where["boolean"]}_{$where["first"]}_{$where["operator"]}_{$where["second"]}";
     }
 
     protected function getRawClauses(array $where) : string
     {
-        if ($where['type'] !== 'raw') {
-            return '';
+        if ($where["type"] !== "raw") {
+            return "";
         }
 
-        return "_{$where['boolean']}_" . str_slug($where['sql']);
+        return "_{$where["boolean"]}_" . str_slug($where["sql"]);
     }
 
     protected function getOtherClauses(array $where, string $carry = null) : string
     {
-        if (in_array($where['type'], ['Exists', 'Nested', 'NotExists', 'raw', 'Column'])) {
-            return '';
+        if (in_array($where["type"], ["Exists", "Nested", "NotExists", "raw", "Column"])) {
+            return "";
         }
 
         $value = $this->getTypeClause($where);
         $value .= $this->getValuesClause($where);
 
-        return "{$carry}-{$where['column']}_{$value}";
+        return "{$carry}-{$where["column"]}_{$value}";
     }
 
     protected function getWheres(array $wheres) : Collection
@@ -194,9 +194,9 @@ protected function getWithModels() : string
         $eagerLoads = collect($this->eagerLoad);
 
         if ($eagerLoads->isEmpty()) {
-            return '';
+            return "";
         }
 
-        return '-' . implode('-', $eagerLoads->keys()->toArray());
+        return "-" . implode("-", $eagerLoads->keys()->toArray());
     }
 }