Merge branch 'feature/add-disablecache-for-all-query' into develop

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.2.51] - 51 Mar 2018
+### Added
+- disabling of `all()` query.
+
 ## [0.2.50] - 10 Mar 2018
 ### Added
 - cache invalidation when `destroy()`ing models.

README.md

@@ -131,11 +131,6 @@ There are two methods by which model-caching can be disabled:
 1. Use `->disableCache()` in a query-by-query instance.
 2. Set `MODEL_CACHE_DISABLED=TRUE` in your `.env` file.
 
-**EXCEPTION:** currently the `::all()` method cannot be disabled by doing something
-like this: `$model->disableCache()->all()`, because it is a static method. To
-work around this, use the `->get()` method if you really need to disable the
-cache for that single query. Disabling cache via the config flag still works.
-
 **Recommendation: use option #1 in all your seeder queries to avoid pulling in
 cached information when reseeding multiple times.**
 You can disable a given query by using `disableCache()` anywhere in the query chain. For example:

src/CachedBuilder.php

@@ -1,5 +1,6 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
+use GeneaLabs\LaravelModelCaching\Traits\BuilderCaching;
 use GeneaLabs\LaravelModelCaching\Traits\Caching;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 
@@ -8,6 +9,7 @@
  */
 class CachedBuilder extends EloquentBuilder
 {
+    use BuilderCaching;
     use Caching;
 
     public function avg($column)

src/Traits/BuilderCaching.php

@@ -0,0 +1,15 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Traits;
+
+use Illuminate\Database\Eloquent\Collection;
+
+trait BuilderCaching
+{
+    public function all($columns = ['*']) : Collection
+    {
+        if (! $this->isCachable()) {
+            $this->model->disableModelCaching();
+        }
+
+        return $this->model->get($columns);
+    }
+}

tests/Integration/CachedBuilderPaginationTest.php

@@ -32,7 +32,8 @@ public function testPaginationIsCached()
             'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
-        $cachedResults = $this->cache()
+        $cachedResults = $this
+            ->cache()
             ->tags($tags)
             ->get($key)['value'];
         $liveResults = (new UncachedAuthor)

tests/Integration/Traits/BuilderCachingTest.php

@@ -0,0 +1,39 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\Traits;
+
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Book;
+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 Illuminate\Database\Eloquent\Collection;
+
+class BuilderCachingTest extends IntegrationTestCase
+{
+    use RefreshDatabase;
+
+    public function testDisablingAllQuery()
+    {
+        $allAuthors = (new Author)
+            ->disableCache()
+            ->all();
+        $key = sha1("genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor");
+        $tags = [
+            "genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor",
+        ];
+        $cachedAuthors = $this
+            ->cache()
+            ->tags($tags)
+            ->get($key)["value"];
+
+        $this->assertInstanceOf(Collection::class, $allAuthors);
+        $this->assertNull($cachedAuthors);
+    }
+}