Merge branch 'master' into feature/add-config-to-disable-cache

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,13 @@ 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.35] - 21 Feb 2018
+### Fixed
+- cache key generation for `find()` and `findOrFail()`.
+
+### Added
+- caching for `paginate()`;
+
 ## [0.2.33] - 19 Feb 2018
 ### Added
 - unit test to make sure `Model::all()` returns a collection when only only

composer.json

@@ -25,7 +25,8 @@
         "phpmd/phpmd": "*",
         "phpunit/phpunit": "*",
         "sebastian/phpcpd": "*",
-        "symfony/thanks": "^1.0"
+        "symfony/thanks": "^1.0",
+        "predis/predis": "^1.1"
     },
     "autoload": {
         "psr-4": {

phpunit.xml

@@ -9,7 +9,7 @@
     convertWarningsToExceptions="true"
     printerClass="Codedungeon\PHPUnitPrettyResultPrinter\Printer"
     processIsolation="false"
-    stopOnFailure="true"
+    stopOnFailure="false"
     syntaxCheck="false"
 >
 <testsuites>

src/CacheKey.php

@@ -13,8 +13,8 @@ class CacheKey
     protected function getCachePrefix() : string
     {
         return "genealabs:laravel-model-caching:"
-            . (config('genealabs:laravel-model-caching', '')
-                ? config('genealabs:laravel-model-caching', '') . ":"
+            . (config('laravel-model-caching.cache-prefix')
+                ? config('laravel-model-caching.cache-prefix', '') . ":"
                 : "");
     }
 

src/CacheTags.php

@@ -18,8 +18,8 @@ public function __construct(array $eagerLoad, Model $model)
     protected function getCachePrefix() : string
     {
         return "genealabs:laravel-model-caching:"
-            . (config('genealabs:laravel-model-caching', '')
-                ? config('genealabs:laravel-model-caching', '') . ":"
+            . (config('laravel-model-caching.cache-prefix')
+                ? config('laravel-model-caching.cache-prefix', '') . ":"
                 : "");
     }
 

src/CachedBuilder.php

@@ -67,7 +67,7 @@ public function find($id, $columns = ['*'])
         }
 
         $arguments = func_get_args();
-        $cacheKey = $this->makeCacheKey($columns);
+        $cacheKey = $this->makeCacheKey(['*'], null, "-find_{$id}");
         $method = 'find';
 
         return $this->cachedValue($arguments, $cacheKey, $method);
@@ -125,6 +125,24 @@ public function min($column)
         return $this->cachedValue($arguments, $cacheKey, $method);
     }
 
+    public function paginate(
+        $perPage = null,
+        $columns = ['*'],
+        $pageName = 'page',
+        $page = null
+    ) {
+        if (! $this->isCachable) {
+            return parent::paginate($perPage, $columns, $pageName, $page);
+        }
+
+        $arguments = func_get_args();
+        $page = $page ?: 1;
+        $cacheKey = $this->makeCacheKey($columns, null, "-paginate_by_{$perPage}_{$pageName}_{$page}");
+        $method = 'paginate';
+
+        return $this->cachedValue($arguments, $cacheKey, $method);
+    }
+
     public function pluck($column, $key = null)
     {
         if (! $this->isCachable) {
@@ -197,7 +215,9 @@ protected function preventHashCollision(
         string $method
     ) {
         if ($result['key'] !== $cacheKey) {
-            cache()->tags($cacheTags)->forget($hashedCacheKey);
+            $this->cache()
+                ->tags($cacheTags)
+                ->forget($hashedCacheKey);
 
             $result = $this->retrieveCachedValue(
                 $arguments,

src/Console/Commands/Flush.php

@@ -13,9 +13,11 @@ public function handle()
 
         if (! $option) {
             cache()
-                ->store(config('laravel-model-caching:store'))
+                ->store(config('laravel-model-caching.store'))
                 ->flush();
 
+            $this->info("✔︎ Entire model cache has been flushed.");
+
             return 0;
         }
 

src/Traits/Cachable.php

@@ -11,7 +11,6 @@
 trait Cachable
 {
     protected $isCachable = true;
-    protected static $isCachableKey = 'genealabs:laravel-model-caching:is-disabled';
 
     protected function cache(array $tags = [])
     {
@@ -43,8 +42,6 @@ protected function addTagsWhenCalledFromCachedBuilder(array $tags) : array
 
     public function disableCache()
     {
-        cache()->forever(self::$isCachableKey, true);
-
         $this->isCachable = false;
 
         return $this;
@@ -89,10 +86,6 @@ public static function bootCachable()
 
     public static function all($columns = ['*'])
     {
-        if (! cache()->get(self::$isCachableKey)) {
-            return parent::all($columns);
-        }
-
         $class = get_called_class();
         $instance = new $class;
         $tags = [str_slug(get_called_class())];
@@ -106,8 +99,8 @@ public static function all($columns = ['*'])
 
     public function newEloquentBuilder($query)
     {
-        if (cache()->get(self::$isCachableKey)) {
-            cache()->forget(self::$isCachableKey);
+        if (! $this->isCachable) {
+            $this->isCachable = true;
 
             return new EloquentBuilder($query);
         }

tests/CreatesApplication.php

@@ -1,16 +1,48 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests;
 
 use GeneaLabs\LaravelModelCaching\Providers\Service as LaravelModelCachingService;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Book;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Profile;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Publisher;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Store;
 use Orchestra\Database\ConsoleServiceProvider;
 
 trait CreatesApplication
 {
+    protected $cache;
+
     public function setUp()
     {
         parent::setUp();
 
         $this->withFactories(__DIR__ . '/database/factories');
         $this->loadMigrationsFrom(__DIR__ . '/database/migrations');
+
+        $this->cache = cache()
+            ->store(config('laravel-model-caching.store'));
+
+        $this->cache()->flush();
+        $publishers = factory(Publisher::class, 10)->create();
+        factory(Author::class, 10)->create()
+            ->each(function ($author) use ($publishers) {
+                factory(Book::class, random_int(2, 10))->make()
+                    ->each(function ($book) use ($author, $publishers) {
+                        $book->author()->associate($author);
+                        $book->publisher()->associate($publishers[rand(0, 9)]);
+                        $book->save();
+                    });
+                factory(Profile::class)->make([
+                    'author_id' => $author->id,
+                ]);
+            });
+
+        $bookIds = (new Book)->all()->pluck('id');
+        factory(Store::class, 10)->create()
+            ->each(function ($store) use ($bookIds) {
+                $store->books()->sync(rand($bookIds->min(), $bookIds->max()));
+            });
+        $this->cache()->flush();
     }
 
     /**
@@ -23,4 +55,22 @@ protected function getPackageProviders($app)
             ConsoleServiceProvider::class,
         ];
     }
+
+    protected function getEnvironmentSetUp($app)
+    {
+        $app['config']->set('database.redis.default', [
+            'host' => env('REDIS_HOST', '192.168.10.10'),
+        ]);
+        $app['config']->set('database.redis.model-cache', [
+            'host' => env('REDIS_HOST', '192.168.10.10'),
+            'password' => env('REDIS_PASSWORD', null),
+            'port' => env('REDIS_PORT', 6379),
+            'database' => 1,
+        ]);
+        $app['config']->set('cache.stores.model', [
+            'driver' => 'redis',
+            'connection' => 'model-cache',
+        ]);
+        $app['config']->set('laravel-model-caching.store', 'model');
+    }
 }

tests/Fixtures/BaseModel.php

@@ -11,7 +11,7 @@ class BaseModel extends Model
 
     public function __construct($attributes = [])
     {
-        config(['genealabs:laravel-model-caching' => 'test-prefix']);
+        config(['laravel-model-caching.cache-prefix' => 'test-prefix']);
 
         parent::__construct($attributes);
     }