Update cache-cooldown checks to avoid calculating cooldown if not set

Author: mikebronner

README.md

@@ -124,7 +124,19 @@ For example you might have a busy site where comments are submitted at a high
 rate, and you don't want every comment submission to invalidate the cache. While
 I don't necessarily recommend this, you might experiment it's effectiveness.
 
-It can be implemented like so:
+To ise it, it must be enabled in the model:
+```php
+class MyModel extends Model
+{
+    use Cachable;
+
+    protected $useCacheCooldown = true;
+
+    // ...
+}
+```
+
+After that it can be implemented in queries:
 ```php
 (new Comment)
     ->withCacheCooldownSeconds(30)

src/Traits/Caching.php

@@ -93,6 +93,10 @@ protected function makeCacheTags() : array
 
     public function getModelCacheCooldown(Model $instance) : array
     {
+        if (! $instance->useCacheCooldown) {
+            return [null, null, null];
+        }
+
         $cachePrefix = $this->getCachePrefix();
         $modelClassName = get_class($instance);
         [$cacheCooldown, $invalidatedAt, $savedAt] = $this

src/Traits/ModelCaching.php

@@ -6,6 +6,8 @@
 
 trait ModelCaching
 {
+    protected $useCacheCooldown = false;
+
     public static function all($columns = ['*'])
     {
         if (config('laravel-model-caching.disabled')) {
@@ -105,4 +107,9 @@ public function scopeWithCacheCooldownSeconds(
 
         return $query;
     }
+
+    public function getUseCacheCooldownAttribute() : bool
+    {
+        return $this->useCacheCooldown;
+    }
 }

tests/Fixtures/AuthorWithCooldown.php

@@ -0,0 +1,12 @@
+<?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 AuthorWithCooldown extends Author
+{
+    protected $table = "authors";
+    protected $useCacheCooldown = true;
+}

tests/Integration/CachedModelTest.php

@@ -2,18 +2,10 @@
 
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Book;
-use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Observers\AuthorObserver;
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\PrefixedAuthor;
-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\IntegrationTestCase;
-use Illuminate\Foundation\Testing\RefreshDatabase;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\AuthorWithCooldown;
 
 class CachedModelTest extends IntegrationTestCase
 {
@@ -155,17 +147,17 @@ public function testWhereHasWithClosureIsBeingCached()
 
     public function testModelCacheDoesntInvalidateDuringCooldownPeriod()
     {
-        $authors = (new Author)
+        $authors = (new AuthorWithCooldown)
             ->withCacheCooldownSeconds(1)
             ->get();
 
         factory(Author::class, 1)->create();
-        $authorsDuringCooldown = (new Author)
+        $authorsDuringCooldown = (new AuthorWithCooldown)
             ->get();
         $uncachedAuthors = (new UncachedAuthor)
             ->get();
         sleep(2);
-        $authorsAfterCooldown = (new Author)
+        $authorsAfterCooldown = (new AuthorWithCooldown)
             ->get();
 
         $this->assertCount(10, $authors);
@@ -176,7 +168,7 @@ public function testModelCacheDoesntInvalidateDuringCooldownPeriod()
 
     public function testModelCacheDoesInvalidateWhenNoCooldownPeriod()
     {
-        $authors = (new Author)
+        $authors = (new AuthorWithCooldown)
             ->get();
 
         factory(Author::class, 1)->create();