feature: support disabling cache (#10)

Co-authored-by: ryangjchandler <[email protected]>

README.md

@@ -52,6 +52,12 @@ If you want to cache the content for a particular model, i.e. a `User` model, yo
 
 When a new user is passed to this view, a separate cache entry will be created.
 
+### Disabling caching
+
+If you wish to disable caching when using the `@cache` directive (useful for local development and testing), you can set the `BLADE_CACHE_DIRECTIVE_ENABLED` environment variable to `false`.
+
+Alternatively, publish the configuration file and modify the `enabled` entry accordingly.
+
 ## Testing
 
 ```bash

config/blade-cache-directive.php

@@ -2,6 +2,8 @@
 
 return [
 
+    'enabled' => env('BLADE_CACHE_DIRECTIVE_ENABLED', true),
+
     'ttl' => env('BLADE_CACHE_DIRECTIVE_TTL', 3600),
 
 ];

src/BladeCacheDirectiveServiceProvider.php

@@ -28,7 +28,7 @@ public function packageBooted()
                     \$__cache_directive_ttl = config('blade-cache-directive.ttl');
                 }
 
-                if (\Illuminate\Support\Facades\Cache::has(\$__cache_directive_key)) {
+                if (config('blade-cache-directive.enabled') && \Illuminate\Support\Facades\Cache::has(\$__cache_directive_key)) {
                     echo \Illuminate\Support\Facades\Cache::get(\$__cache_directive_key);
                 } else {
                     \$__cache_directive_buffering = true;

tests/CacheTest.php

@@ -2,7 +2,8 @@
 
 namespace RyanChandler\BladeCacheDirective\Tests;
 
-use Artisan;
+use Carbon\Carbon;
+use Illuminate\Support\Facades\Artisan;
 
 class CacheTest extends TestCase
 {
@@ -18,7 +19,7 @@ public function setUp(): void
         $this->second_value = now()->subDays(20);
         $this->third_value = now()->subDays(60);
     }
-    
+
     /** @test */
     public function the_cache_directive_will_render_the_same_view_before_ttl_expired()
     {
@@ -41,7 +42,21 @@ public function the_cache_directive_will_render_other_view_after_ttl_expired()
         $this->assertEquals($this->second_value->format('Y-m-d H:i:s'), $this->renderView('cache', compact('time')));
     }
 
-    protected function renderView($view, $parameters)
+    /** @test */
+    public function the_cache_directive_can_be_disabled()
+    {
+        config()->set('blade-cache-directive.enabled', false);
+
+        $first = $this->renderView('disabled');
+
+        Carbon::setTestNow(now()->addMinute());
+
+        $second = $this->renderView('disabled');
+
+        $this->assertNotEquals($first, $second);
+    }
+
+    protected function renderView($view, $parameters = [])
     {
         Artisan::call('view:clear');
 

tests/resources/views/disabled.blade.php

@@ -0,0 +1,3 @@
+@cache('now', now()->addDay())
+    {{ now()->format('H:i:s') }}
+@endcache