Merge remote-tracking branch 'upstream/master' into respect-isCachable

Author: Henk Koop

CHANGELOG.md

@@ -4,6 +4,22 @@ 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.49] - 9 Mar 2018
+### Fixed
+- caching of `->first()` queries.
+
+## [0.2.48] - 9 Mar 2018
+### Added
+- database connection name to cache prefix.
+
+## [0.2.47] - 5 Mar 2018
+### Fixed
+- exception when calling disableCache() when caching is already disabled via config.
+
+## [0.2.46] - 5 Mar 2018
+### Fixed
+- package dependency version to work with Laravel 5.5.
+
 ## [0.2.45] - 3 Mar 2018
 ### Fixed
 - pagination cache key generation; fixes #85.

README.md

@@ -67,6 +67,13 @@ abstract class BaseModel
     //
 }
 ```
+### Multiple Database Connections
+__Thanks to @dtvmedia for suggestion this feature. This is actually a more robust
+solution than cache-prefixes.__
+
+Keeping keys separate for multiple database connections is automatically handled.
+This is especially important for multi-tenant applications, and of course any
+application using multiple database connections.
 
 ### Optional Cache Key Prefix
 Thanks to @lucian-dragomir for suggesting this feature! You can use cache key
@@ -75,7 +82,8 @@ 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.**
+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
@@ -92,7 +100,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);
     }

src/CacheKey.php

@@ -1,23 +1,18 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
+use GeneaLabs\LaravelModelCaching\Traits\CachePrefixing;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Collection;
 
 class CacheKey
 {
+    use CachePrefixing;
+
     protected $eagerLoad;
     protected $model;
     protected $query;
 
-    protected function getCachePrefix() : string
-    {
-        return "genealabs:laravel-model-caching:"
-            . (config("laravel-model-caching.cache-prefix")
-                ? config("laravel-model-caching.cache-prefix", "") . ":"
-                : "");
-    }
-
     public function __construct(
         array $eagerLoad,
         Model $model,

src/CacheTags.php

@@ -1,26 +1,27 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
 use GeneaLabs\LaravelModelCaching\CachedBuilder;
+use GeneaLabs\LaravelModelCaching\Traits\CachePrefixing;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Database\Query\Builder;
 
 class CacheTags
 {
+    use CachePrefixing;
+
     protected $eagerLoad;
     protected $model;
+    protected $query;
 
-    public function __construct(array $eagerLoad, Model $model)
-    {
+    public function __construct(
+        array $eagerLoad,
+        Model $model,
+        Builder $query
+    ) {
         $this->eagerLoad = $eagerLoad;
         $this->model = $model;
-    }
-
-    protected function getCachePrefix() : string
-    {
-        return "genealabs:laravel-model-caching:"
-            . (config('laravel-model-caching.cache-prefix')
-                ? config('laravel-model-caching.cache-prefix', '') . ":"
-                : "");
+        $this->query = $query;
     }
 
     public function make() : array

src/CachedBuilder.php

@@ -60,7 +60,7 @@ public function first($columns = ["*"])
             return parent::first($columns);
         }
 
-        $cacheKey = $this->makeCacheKey($columns);
+        $cacheKey = $this->makeCacheKey($columns, null, "-first");
 
         return $this->cachedValue(func_get_args(), $cacheKey);
     }

src/Console/Commands/Flush.php

@@ -49,8 +49,10 @@ protected function flushModelCache(string $option) : int
         return 0;
     }
 
-    protected function getAllTraitsUsedByClass(string $classname, bool $autoload = true) : Collection
-    {
+    protected function getAllTraitsUsedByClass(
+        string $classname,
+        bool $autoload = true
+    ) : Collection {
         $traits = collect();
 
         if (class_exists($classname, $autoload)) {
@@ -60,7 +62,8 @@ protected function getAllTraitsUsedByClass(string $classname, bool $autoload = t
         $parentClass = get_parent_class($classname);
 
         if ($parentClass) {
-            $traits = $traits->merge($this->getAllTraitsUsedByClass($parentClass, $autoload));
+            $traits = $traits
+                ->merge($this->getAllTraitsUsedByClass($parentClass, $autoload));
         }
 
         return $traits;

src/Traits/CachePrefixing.php

@@ -0,0 +1,18 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Traits;
+
+trait CachePrefixing
+{
+    protected function getCachePrefix() : string
+    {
+        return "genealabs:laravel-model-caching:"
+            . $this->getDatabaseConnectionName() . ":"
+            . (config("laravel-model-caching.cache-prefix")
+                ? config("laravel-model-caching.cache-prefix", "") . ":"
+                : "");
+    }
+
+    protected function getDatabaseConnectionName() : string
+    {
+        return $this->query->connection->getName();
+    }
+}

src/Traits/Caching.php

@@ -77,7 +77,11 @@ protected function makeCacheKey(
 
     protected function makeCacheTags() : array
     {
-        $tags = (new CacheTags($this->eagerLoad ?? [], $this->model ?? $this))
+        $eagerLoad = $this->eagerLoad ?? [];
+        $model = $this->model ?? $this;
+        $query = $this->query ?? app(Builder::class);
+
+        $tags = (new CacheTags($eagerLoad, $model, $query))
             ->make();
 
         return $tags;

tests/Integration/CachedBuilderMultipleQueryTest.php

@@ -0,0 +1,41 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration;
+
+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 GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedBook;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedProfile;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedPublisher;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedStore;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Http\Resources\Author as AuthorResource;
+use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Collection;
+
+class CachedBuilderMultipleQueryTest extends IntegrationTestCase
+{
+    use RefreshDatabase;
+
+    public function testCallingAllThenFirstQueriesReturnsDifferingResults()
+    {
+        $allAuthors = (new Author)->all();
+        $firstAuthor = (new Author)->first();
+
+        $this->assertNotEquals($allAuthors, $firstAuthor);
+        $this->assertInstanceOf(Author::class, $firstAuthor);
+        $this->assertInstanceOf(Collection::class, $allAuthors);
+    }
+
+    public function testCallingGetThenFirstQueriesReturnsDifferingResults()
+    {
+        $allAuthors = (new Author)->get();
+        $firstAuthor = (new Author)->first();
+
+        $this->assertNotEquals($allAuthors, $firstAuthor);
+        $this->assertInstanceOf(Author::class, $firstAuthor);
+        $this->assertInstanceOf(Collection::class, $allAuthors);
+    }
+}

tests/Integration/CachedBuilderPaginationTest.php

@@ -27,9 +27,9 @@ public function testPaginationIsCached()
         $authors = (new Author)
             ->paginate(3);
 
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor-paginate_by_3_page_1');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor-paginate_by_3_page_1');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
         $cachedResults = $this->cache()