Added config and environment variable to allow removal of database information from cache-key

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.6.1] - 2019-07-20
+### Added
+- config and environment variable to allow removal of database information from cache-key.
+
 ## [0.6.0] - 2019-07-20
 ### Changed
 - environment variable `MODEL_CACHE_DISABLED` to `MODEL_CACHE_ENABLED` to better conform to standards.

config/laravel-model-caching.php

@@ -5,5 +5,7 @@
 
     'enabled' => env('MODEL_CACHE_ENABLED', true),
 
+    'use-database-keying' => env('MODEL_CACHE_USE_DATABASE_KEYING', true),
+
     'store' => env('MODEL_CACHE_STORE'),
 ];

src/Traits/CachePrefixing.php

@@ -6,24 +6,27 @@ trait CachePrefixing
 {
     protected function getCachePrefix() : string
     {
-        $cachePrefix = Container::getInstance()
+        $cachePrefix = "genealabs:laravel-model-caching:";
+        $useDatabaseKeying = Container::getInstance()
+            ->make("config")
+            ->get("laravel-model-caching.use-database-keying");
+
+        if ($useDatabaseKeying) {
+            $cachePrefix .= $this->getConnectionName() . ":";
+            $cachePrefix .= $this->getDatabaseName() . ":";
+        }
+
+        $cachePrefix .= Container::getInstance()
             ->make("config")
             ->get("laravel-model-caching.cache-prefix", "");
 
         if ($this->model
             && property_exists($this->model, "cachePrefix")
         ) {
-            $cachePrefix = $this->model->cachePrefix;
+            $cachePrefix .= $this->model->cachePrefix . ":";
         }
 
-        $cachePrefix = $cachePrefix
-            ? "{$cachePrefix}:"
-            : "";
-
-        return "genealabs:laravel-model-caching:"
-            . $this->getConnectionName() . ":"
-            . $this->getDatabaseName() . ":"
-            . $cachePrefix;
+        return $cachePrefix;
     }
 
     protected function getDatabaseName() : string

tests/Integration/Traits/CachePrefixingTest.php

@@ -0,0 +1,51 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\Traits;
+
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
+use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+
+class CachePrefixingTest extends IntegrationTestCase
+{
+    public function testDatabaseKeyingEnabled()
+    {
+        $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:authors:genealabslaravelmodelcachingtestsfixturesauthor-authors.deleted_at_null-first");
+        $tags = [
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesauthor",
+        ];
+
+        $author = (new Author)
+            ->first();
+        $cachedResults = $this->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+        $liveResults = (new UncachedAuthor)
+            ->first();
+
+        $this->assertEquals($liveResults->pluck("id"), $author->pluck("id"));
+        $this->assertEquals($liveResults->pluck("id"), $cachedResults->pluck("id"));
+        $this->assertNotEmpty($author);
+        $this->assertNotEmpty($cachedResults);
+        $this->assertNotEmpty($liveResults);
+    }
+
+    public function testDatabaseKeyingDisabled()
+    {
+        config(["laravel-model-caching.use-database-keying" => false]);
+        $key = sha1("genealabs:laravel-model-caching:authors:genealabslaravelmodelcachingtestsfixturesauthor-authors.deleted_at_null-first");
+        $tags = ["genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor"];
+
+        $author = (new Author)
+            ->first();
+        $cachedResults = $this->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+        $liveResults = (new UncachedAuthor)
+            ->first();
+
+        $this->assertEquals($liveResults->pluck("id"), $author->pluck("id"));
+        $this->assertEquals($liveResults->pluck("id"), $cachedResults->pluck("id"));
+        $this->assertNotEmpty($author);
+        $this->assertNotEmpty($cachedResults);
+        $this->assertNotEmpty($liveResults);
+    }
+}