added shlud_cache configuration option

readme.md

@@ -1,30 +1,44 @@
 # Russian Doll Caching for Laravel 5.1 LTS and Laravel 5.2
 
+Efficient view caching.
+
 Inspired by the excellent series at https://laracasts.com/series/russian-doll-caching-in-laravel .
 
 Watch that series to understand the concepts around it and to use it properly, 
 for example: how to invalidate the cache upwards.
 
 ## Installation
 
+In your terminal/shell run:
+
 ```
 composer require rodrigopedra/russian-doll-caching
 ```
 
-## Configuration
-
-Add the provider to your config/app.php:
+Add the provider to your config/app.php service providers array:
 
 ```php
-// in your config/app.php add the provider to the service providers key
+/* ... */
 
 'providers' => [
     /* ... */
 
     RodrigoPedra\RussianDollCaching\RussianDollCachingServiceProvider::class,
-]
+],
+
+/* ... */
+```
+
+## Configuration
+
+In your terminal/shell run:
+
+```
+php artisan vendor:publish --provider="RodrigoPedra\RussianDollCaching\RussianDollCachingServiceProvider"
 ```
 
+You can configure a `should_cache` constraint, so you can skip caching, for example, while developing locally.
+
 ## Usage
 
 Use the `@russian` directive in your blade templates the same way you would use the `@include` directive.

src/RussianDollCaching/RussianDollCaching.php

@@ -16,16 +16,21 @@ class RussianDollCaching
     /** @var View */
     protected $view;
 
+    /** @var bool */
+    protected $shouldCache;
+
     /**
      * RussianDollCaching constructor.
      *
      * @param  \Illuminate\Contracts\Cache\Repository $cache
      * @param  \Illuminate\Contracts\View\Factory     $view
+     * @param  bool                                   $shouldCache
      */
-    public function __construct( Cache $cache, View $view )
+    public function __construct( Cache $cache, View $view, $shouldCache = true )
     {
-        $this->cache = $cache;
-        $this->view  = $view;
+        $this->cache       = $cache;
+        $this->view        = $view;
+        $this->shouldCache = $shouldCache;
     }
 
     /**
@@ -41,6 +46,10 @@ public function get( $view, $data, $prefix = null )
     {
         $key = $this->makeKey( $view, (array)$data, $prefix );
 
+        if (!$this->shouldCache) {
+            return $this->view->make( $view, $data )->render();
+        }
+
         return $this->getCache()->rememberForever( $key, function () use ( $view, $data ) {
             return $this->view->make( $view, $data )->render();
         } );

src/RussianDollCaching/RussianDollCachingServiceProvider.php

@@ -8,6 +8,8 @@ class RussianDollCachingServiceProvider extends ServiceProvider
 {
     public function boot()
     {
+        $this->publishes( [ __DIR__ . DIRECTORY_SEPARATOR . 'config.php' => config_path( 'russian.php' ) ] );
+
         $this->app[ 'blade.compiler' ]->directive( 'russian', function ( $expression ) {
             $className = RussianDollCaching::class;
 
@@ -17,8 +19,10 @@ public function boot()
 
     public function register()
     {
+        $this->mergeConfigFrom( __DIR__ . DIRECTORY_SEPARATOR . 'config.php', 'russian' );
+
         $this->app->singleton( RussianDollCaching::class, function ( $app ) {
-            return new RussianDollCaching( $app[ 'cache.store' ], $app[ 'view' ] );
+            return new RussianDollCaching( $app[ 'cache.store' ], $app[ 'view' ], !!config( 'russian.should_cache' ) );
         } );
     }
 }

src/RussianDollCaching/config.php

@@ -0,0 +1,12 @@
+<?php
+
+return [
+    /**
+     * Use this to skip caching under some circunstances. For example you can avoid caching
+     * the views in the local environment while developing changing the condition to:
+     *
+     * 'should_cache' => app('env') !== 'local',
+     */
+
+    'should_cache' => true,
+];