Merge branch 'release/0.2.31'

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.31] - 18 Feb 2018
+### Added
+- optional cache key prefixing.
+
 ## [0.2.30] - 18 Feb 2018
 ### Changed
 - detection of Cachable trait to use `class_uses()` instead of looking for

README.md

@@ -68,6 +68,37 @@ abstract class BaseModel
 }
 ```
 
+### Optional Cache Key Prefix
+Thanks to @lucian-dragomir for suggesting this feature! You can use cache key
+prefixing to keep cache entries separate for multi-tenant applications. For this
+it is recommended to add the Cachable trait to a base model, then set the cache
+key prefix config value there.
+
+**Note that the config setting is included before the parent method is called,
+so that the setting is available in the parent as well.**
+
+Here's is an example:
+```php
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
+
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+
+class BaseModel extends Model
+{
+    use Cachable;
+
+    public function __construct($attributes = [])
+    {
+        config(['genealabs:laravel-model-caching' => 'test-prefix']);
+
+        parent::__construct($attributes);
+    }
+}
+```
+
 ### Exception: User Model
 I would not recommend caching the user model, as it is a special case, since it
 extends `Illuminate\Foundation\Auth\User`. Overriding that would break functionality.

config/laravel-model-caching.php

@@ -2,4 +2,6 @@
 
 return [
     'store' => env('MODEL_CACHE_STORE'),
+
+    'cache-prefix' => '',
 ];

src/CacheKey.php

@@ -10,8 +10,19 @@ class CacheKey
     protected $model;
     protected $query;
 
-    public function __construct(array $eagerLoad, Model $model, Builder $query)
+    protected function getCachePrefix() : string
     {
+        return "genealabs:laravel-model-caching:"
+            . (config('genealabs:laravel-model-caching', '')
+                ? config('genealabs:laravel-model-caching', '') . ":"
+                : "");
+    }
+
+    public function __construct(
+        array $eagerLoad,
+        Model $model,
+        Builder $query
+    ) {
         $this->eagerLoad = $eagerLoad;
         $this->model = $model;
         $this->query = $query;
@@ -22,7 +33,8 @@ public function make(
         $idColumn = null,
         string $keyDifferentiator = ''
     ) : string {
-        $key = $this->getModelSlug();
+        $key = $this->getCachePrefix();
+        $key .= $this->getModelSlug();
         $key .= $this->getIdColumn($idColumn ?: '');
         $key .= $this->getQueryColumns($columns);
         $key .= $this->getWhereClauses();

src/CacheTags.php

@@ -15,9 +15,17 @@ public function __construct(array $eagerLoad, Model $model)
         $this->model = $model;
     }
 
+    protected function getCachePrefix() : string
+    {
+        return "genealabs:laravel-model-caching:"
+            . (config('genealabs:laravel-model-caching', '')
+                ? config('genealabs:laravel-model-caching', '') . ":"
+                : "");
+    }
+
     public function make() : array
     {
-        return collect($this->eagerLoad)
+        $tags = collect($this->eagerLoad)
             ->keys()
             ->map(function ($relationName) {
                 $relation = collect(explode('.', $relationName))
@@ -33,10 +41,16 @@ public function make() : array
                         return $carry->{$name}();
                     });
 
-                return str_slug(get_class($relation->getQuery()->getModel()));
+                return $this->getCachePrefix()
+                    . str_slug(get_class($relation->getQuery()->getModel()));
             })
-            ->prepend(str_slug(get_class($this->model)))
+            ->prepend(
+                $this->getCachePrefix()
+                    . str_slug(get_class($this->model))
+            )
             ->values()
             ->toArray();
+
+        return $tags;
     }
 }

src/Traits/Cachable.php

@@ -11,7 +11,7 @@
 trait Cachable
 {
     protected $isCachable = true;
-    protected static $isCachableKey = 'genealabs:model-caching:is-disabled';
+    protected static $isCachableKey = 'genealabs:laravel-model-caching:is-disabled';
 
     protected function cache(array $tags = [])
     {
@@ -89,7 +89,7 @@ public static function bootCachable()
 
     public static function all($columns = ['*'])
     {
-        if (cache()->get(self::$isCachableKey)) {
+        if (! cache()->get(self::$isCachableKey)) {
             return parent::all($columns);
         }
 

tests/Fixtures/BaseModel.php

@@ -0,0 +1,18 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
+
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+
+class BaseModel extends Model
+{
+    use Cachable;
+
+    public function __construct($attributes = [])
+    {
+        config(['genealabs:laravel-model-caching' => 'test-prefix']);
+
+        parent::__construct($attributes);
+    }
+}

tests/Fixtures/PrefixedAuthor.php

@@ -0,0 +1,17 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
+
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+
+class PrefixedAuthor extends BaseModel
+{
+    use Cachable;
+
+    protected $fillable = [
+        'name',
+        'email',
+    ];
+    protected $table = "authors";
+}