Added helper method runDisabled() to run blocks of code without model caching

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.4.13] - 4 Apr 2019
+### Added
+- helper function to run closure with model-caching disabled. Thanks for the suggestion, @mycarrysun
+
 ## [0.4.12] - 3 Apr 2019
 ### Updated
 - string and array helpers to use the `Str` and `Arr` classes directly, in preparation for helper deprecations in Laravel 5.9. Thanks @mycarrysun

README.md

@@ -154,6 +154,13 @@ or:
 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.
+3. If you only need to disable the cache for a block of code, or for non-
+    eloquent queries, this is probably the better option:
+    ```php
+    app("model-cache")->runDisabled(function () {
+        // your code here, it may return, as well
+    });
+    ```
 
 **Recommendation: use option #1 in all your seeder queries to avoid pulling in
 cached information when reseeding multiple times.**

src/Helper.php

@@ -0,0 +1,16 @@
+<?php namespace GeneaLabs\LaravelModelCaching;
+
+class Helper
+{
+    public function runDisabled(callable $closure)
+    {
+        $originalSetting = config('laravel-model-caching.disabled');
+        config(['laravel-model-caching.disabled' => true]);
+
+        $result = $closure();
+
+        config(['laravel-model-caching.disabled' => $originalSetting]);
+
+        return $result;
+    }
+}

src/Providers/Service.php

@@ -1,6 +1,7 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Providers;
 
 use GeneaLabs\LaravelModelCaching\Console\Commands\Clear;
+use GeneaLabs\LaravelModelCaching\Helper;
 use Illuminate\Support\ServiceProvider;
 
 class Service extends ServiceProvider
@@ -13,4 +14,9 @@ public function boot()
         $this->mergeConfigFrom($configPath, 'laravel-model-caching');
         $this->commands(Clear::class);
     }
+
+    public function register()
+    {
+        $this->app->bind("model-cache", Helper::class);
+    }
 }

tests/Integration/HelperTest.php

@@ -0,0 +1,34 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration;
+
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
+use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+
+class HelperTest extends IntegrationTestCase
+{
+    public function testClosureRunsWithCacheDisabled()
+    {
+        $key = sha1('genealabs:laravel-model-caching:testing::memory::authors:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesauthor'];
+
+        $authors = app("model-cache")->runDisabled(function () {
+            return (new Author)
+                ->get();
+        });
+
+        $cachedResults1 = $this->cache()
+            ->tags($tags)
+            ->get($key)["value"];
+        (new Author)
+            ->get();
+        $cachedResults2 = $this->cache()
+            ->tags($tags)
+            ->get($key)["value"];
+        $liveResults = (new UncachedAuthor)
+            ->get();
+
+        $this->assertEquals($liveResults->toArray(), $authors->toArray());
+        $this->assertNull($cachedResults1);
+        $this->assertEquals($authors->toArray(), $cachedResults2->toArray());
+    }
+}