Update model cache prefix functionality

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.5.0] - 20 May 2019
+### Changed
+- implementation of model-based cache prefix.
+
 ## [0.4.24] - 18 May 2019
 ### Fixed
 - BelongsToMany relationship to not cache if the target model is not also cachable.

README.md

@@ -50,6 +50,11 @@ Be sure to not require a specific version of this package when requiring it:
 composer require genealabs/laravel-model-caching:*
 ```
 
+## Upgrade Notes
+### 0.5.0
+The following implementations have changed (see the respective sections below):
+- model-specific cache prefix
+
 ## Configuration
 ### Recommended (Optional) Custom Cache Store
 If you would like to use a different cache store than the default one used by
@@ -99,10 +104,6 @@ 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. If you are developing a
-multi-tenant application, see the note above.**
-
 Here's is an example:
 ```php
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
@@ -116,15 +117,16 @@ class BaseModel extends Model
 {
     use Cachable;
 
-    public function __construct($attributes = [])
-    {
-        config(['laravel-model-caching.cache-prefix' => 'test-prefix']);
-
-        parent::__construct($attributes);
-    }
+    protected $cachePrefix = "test-prefix";
 }
 ```
 
+The cache prefix can also be set in the configuration to prefix all cached
+models across the board:
+```php
+    'cache-prefix' => 'test-prefix',
+```
+
 ### 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.

src/CacheKey.php

@@ -3,7 +3,6 @@
 use GeneaLabs\LaravelModelCaching\Traits\CachePrefixing;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
-use Illuminate\Database\Query\Expression;
 use Illuminate\Support\Str;
 
 class CacheKey

src/Traits/CachePrefixing.php

@@ -4,12 +4,22 @@ trait CachePrefixing
 {
     protected function getCachePrefix() : string
     {
+        $cachePrefix = config("laravel-model-caching.cache-prefix", "");
+
+        if ($this->model
+            && property_exists($this->model, "cachePrefix")
+        ) {
+            $cachePrefix = $this->model->cachePrefix;
+        }
+
+        $cachePrefix = $cachePrefix
+            ? "{$cachePrefix}:"
+            : "";
+
         return "genealabs:laravel-model-caching:"
             . $this->getConnectionName() . ":"
             . $this->getDatabaseName() . ":"
-            . (config("laravel-model-caching.cache-prefix")
-                ? config("laravel-model-caching.cache-prefix", "") . ":"
-                : "");
+            . $cachePrefix;
     }
 
     protected function getDatabaseName() : string

src/Traits/Caching.php

@@ -57,10 +57,20 @@ public function flushCache(array $tags = [])
 
     protected function getCachePrefix() : string
     {
+        $cachePrefix = config("laravel-model-caching.cache-prefix", "");
+
+        if ($this->model
+            && property_exists($this->model, "cachePrefix")
+        ) {
+            $cachePrefix = $this->model->cachePrefix;
+        }
+
+        $cachePrefix = $cachePrefix
+            ? "{$cachePrefix}:"
+            : "";
+
         return "genealabs:laravel-model-caching:"
-            . (config('laravel-model-caching.cache-prefix')
-                ? config('laravel-model-caching.cache-prefix', '') . ":"
-                : "");
+            . $cachePrefix;
     }
 
     protected function makeCacheKey(

src/Traits/ModelCaching.php

@@ -9,7 +9,33 @@
 
 trait ModelCaching
 {
-    protected $cacheCooldownSeconds = 0;
+    public function __get($key)
+    {
+        if ($key === "cachePrefix") {
+            return $this->cachePrefix
+                ?? "";
+        }
+
+        if ($key === "cacheCooldownSeconds") {
+            return $this->cacheCooldownSeconds
+                ?? 0;
+        }
+
+        return parent::__get($key);
+    }
+
+    public function __set($key, $value)
+    {
+        if ($key === "cachePrefix") {
+            $this->cachePrefix = $value;
+        }
+
+        if ($key === "cacheCooldownSeconds") {
+            $this->cacheCooldownSeconds = $value;
+        }
+
+        parent::__set($key, $value);
+    }
 
     public static function all($columns = ['*'])
     {
@@ -151,9 +177,4 @@ public function scopeWithCacheCooldownSeconds(
 
         return $query;
     }
-
-    public function getcacheCooldownSecondsAttribute() : int
-    {
-        return $this->cacheCooldownSeconds;
-    }
 }

tests/Fixtures/BaseModel.php

@@ -1,14 +1,53 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
 
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\SoftDeletes;
 
-class PrefixedAuthor extends BaseModel
+class PrefixedAuthor extends Model
 {
+    use Cachable;
+    use SoftDeletes;
+
+    protected $cachePrefix = "model-prefix";
+    protected $casts = [
+        "finances" => "array",
+    ];
     protected $fillable = [
         'name',
         'email',
+        "finances",
     ];
     protected $table = "authors";
+
+    public function books() : HasMany
+    {
+        return $this->hasMany(Book::class);
+    }
+
+    public function profile() : HasOne
+    {
+        return $this->hasOne(Profile::class);
+    }
+
+    public function getLatestBookAttribute()
+    {
+        return $this
+            ->books()
+            ->latest("id")
+            ->first();
+    }
+
+    public function scopeStartsWithA(Builder $query) : Builder
+    {
+        return $query->where('name', 'LIKE', 'A%');
+    }
+
+    public function scopeNameStartsWith(Builder $query, string $startOfName) : Builder
+    {
+        return $query->where("name", "LIKE", "{$startOfName}%");
+    }
 }

tests/Fixtures/PrefixedAuthor.php

@@ -23,7 +23,7 @@ public function setUp() : void
     public function testMorphTo()
     {
         $key1 = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:books:genealabslaravelmodelcachingtestsfixturesbook-author_id_=_1-testing:{$this->testingSqlitePath}testing.sqlite:image");
-        $key2 = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:books:genealabslaravelmodelcachingtestsfixturesbook-author_id_=_2-testing:{$this->testingSqlitePath}testing.sqlite:image");
+        $key2 = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:books:genealabslaravelmodelcachingtestsfixturesbook-author_id_=_4-testing:{$this->testingSqlitePath}testing.sqlite:image");
         $tags = [
             "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesbook",
             "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesimage",
@@ -38,7 +38,7 @@ public function testMorphTo()
             ->get($key1)['value'];
         $books2 = (new Book)
             ->with("image")
-            ->where("author_id", 2)
+            ->where("author_id", 4)
             ->get();
         $cachedResults2 = $this->cache()
             ->tags($tags)

tests/Integration/CachedBuilder/MorphOneTest.php

@@ -0,0 +1,37 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\CachedBuilder;
+
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\PrefixedAuthor;
+
+class PrefixTest extends IntegrationTestCase
+{
+    public function testCachePrefixIsAddedForPrefixedModel()
+    {
+        $prefixKey = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:model-prefix:authors:genealabslaravelmodelcachingtestsfixturesprefixedauthor-first");
+        $prefixTags = [
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:model-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor",
+        ];
+        $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:authors:genealabslaravelmodelcachingtestsfixturesauthor-first");
+        $tags = [
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesauthor",
+        ];
+
+        $prefixAuthor = (new PrefixedAuthor)
+            ->first();
+        $author = (new Author)
+            ->first();
+        $prefixCachedResults = $this
+            ->cache()
+            ->tags($prefixTags)
+            ->get($prefixKey)['value'];
+        $nonPrefixCachedResults = $this
+            ->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+
+        $this->assertEquals($prefixCachedResults, $prefixAuthor);
+        $this->assertEquals($nonPrefixCachedResults, $author);
+        $this->assertNotNull($author);
+    }
+}

tests/Integration/CachedBuilder/PrefixTest.php

@@ -89,7 +89,6 @@ public function testDeletingModelClearsCache()
         $this->assertNull($results);
     }
 
-    /** @group test */
     public function testHasManyRelationshipIsCached()
     {
         $authors = (new Author)->with('books')->get();

tests/Integration/CachedBuilderTest.php

@@ -46,8 +46,8 @@ public function testExtendedModelIsFlushed()
         $authors = (new PrefixedAuthor)
             ->get();
 
-        $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:test-prefix:authors:genealabslaravelmodelcachingtestsfixturesprefixedauthor");
-        $tags = ["genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor"];
+        $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:model-prefix:authors:genealabslaravelmodelcachingtestsfixturesprefixedauthor");
+        $tags = ["genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:model-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor"];
 
         $cachedResults = $this
             ->cache

tests/Integration/Console/Commands/FlushTest.php

@@ -51,9 +51,9 @@ public function testSetCachePrefixAttribute()
         $results = $this->
             cache()
             ->tags([
-                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor",
+                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:model-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor",
             ])
-            ->get(sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:test-prefix:authors:genealabslaravelmodelcachingtestsfixturesprefixedauthor"))['value'];
+            ->get(sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:model-prefix:authors:genealabslaravelmodelcachingtestsfixturesprefixedauthor"))['value'];
 
         $this->assertNotNull($results);
     }