Merge pull request #101 from sebastienheyd/master

Cache tagging support

Author: arrilot

README.md

@@ -302,6 +302,39 @@ No caching is turned on by default.
 A cache key depends on a widget name and each widget parameter.
 Override ```cacheKey``` method if you need to adjust it.
 
+### Cache tagging
+
+When tagging is supported ([see the Laravel cache documentation](https://laravel.com/docs/cache#cache-tags)) and to 
+simplify cache flushing, a tag `widgets` is assigned by default to all widgets. 
+You can define one or more additional tags to your widgets by setting the values 
+in the `$cacheTags` property in your widget class. Example :
+
+```php
+class RecentNews extends AbstractWidget
+{
+    /**
+     * Cache tags allow you to tag related items in the cache 
+     * and then flush all cached values that assigned a given tag.
+     *
+     * @var array
+     */
+    public $cacheTags = ['news', 'frontend'];
+}
+```
+
+For this example, if you need to flush :
+
+```php
+// Clear widgets with the tag news
+Cache::tags('news')->flush();
+
+// Clear widgets with the tag news OR backend
+Cache::tags(['news', 'frontend'])->flush();
+
+// Flush all widgets cache
+Cache::tags('widgets')->flush();
+```
+
 ## Widget groups (extra)
 
 In most cases Blade is a perfect tool for setting the position and order of widgets.

composer.json

@@ -16,7 +16,8 @@
         "illuminate/contracts": ">=5.1",
         "illuminate/view": ">=5.1",
         "illuminate/container": ">=5.1",
-        "illuminate/console": ">=5.1"
+        "illuminate/console": ">=5.1",
+        "illuminate/cache": ">=5.1"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.0"

src/AbstractWidget.php

@@ -20,6 +20,13 @@ abstract class AbstractWidget
      */
     public $cacheTime = false;
 
+    /**
+     * Cache tags allow you to tag related items in the cache and then flush all cached values that assigned a given tag.
+     *
+     * @var array
+     */
+    public $cacheTags = [];
+
     /**
      * Should widget params be encrypted before sending them to /arrilot/load-widget?
      * Turning encryption off can help with making custom reloads from javascript, but makes widget params publicly accessible.
@@ -84,6 +91,16 @@ public function cacheKey(array $params = [])
         return 'arrilot.widgets.'.serialize($params);
     }
 
+    /**
+     * Cache tags to help flush all cache with the same tag(s).
+     *
+     * @return array
+     */
+    public function cacheTags()
+    {
+        return array_unique(array_merge(['widgets'], $this->cacheTags));
+    }
+
     /**
      * Add defaults to configuration array.
      *

src/Contracts/ApplicationWrapperContract.php

@@ -11,11 +11,12 @@ interface ApplicationWrapperContract
      *
      * @param $key
      * @param $minutes
+     * @param $tags
      * @param callable $callback
      *
      * @return mixed
      */
-    public function cache($key, $minutes, Closure $callback);
+    public function cache($key, $minutes, $tags, Closure $callback);
 
     /**
      * Wrapper around app()->call().

src/Factories/JavascriptFactory.php

@@ -47,7 +47,7 @@ public function getLoader($encryptParams = true)
      * Construct javascript code to reload the widget.
      *
      * @param float|int $timeout
-     * @param bool $encryptParams
+     * @param bool      $encryptParams
      *
      * @return string
      */

src/Factories/WidgetFactory.php

@@ -67,7 +67,7 @@ protected function getContent()
     protected function getContentFromCache($args)
     {
         if ($cacheTime = (float) $this->getCacheTime()) {
-            return $this->app->cache($this->widget->cacheKey($args), $cacheTime, function () {
+            return $this->app->cache($this->widget->cacheKey($args), $cacheTime, $this->widget->cacheTags(), function () {
                 return $this->getContent();
             });
         }

src/Misc/EncryptException.php

@@ -6,5 +6,4 @@
 
 class EncryptException extends Exception
 {
-
 }

src/Misc/LaravelApplicationWrapper.php

@@ -26,13 +26,20 @@ public function __construct()
      *
      * @param $key
      * @param $minutes
+     * @param $tags
      * @param callable $callback
      *
      * @return mixed
      */
-    public function cache($key, $minutes, Closure $callback)
+    public function cache($key, $minutes, $tags, Closure $callback)
     {
-        return $this->app->make('cache')->remember($key, $minutes, $callback);
+        $cache = $this->app->make('cache');
+
+        if (method_exists($cache->getStore(), 'tags')) {
+            $cache = $cache->tags($tags);
+        }
+
+        return $cache->remember($key, $minutes, $callback);
     }
 
     /**

tests/Dummies/TestCachedWidget.php

@@ -8,6 +8,8 @@ class TestCachedWidget extends AbstractWidget
 {
     public $cacheTime = 60;
 
+    public $cacheTags = ['test'];
+
     protected $slides = 6;
 
     public function run()

tests/Support/TestApplicationWrapper.php

@@ -25,11 +25,12 @@ class TestApplicationWrapper implements ApplicationWrapperContract
      *
      * @param $key
      * @param $minutes
+     * @param $tags
      * @param Closure $callback
      *
      * @return mixed
      */
-    public function cache($key, $minutes, Closure $callback)
+    public function cache($key, $minutes, $tags, Closure $callback)
     {
         return 'Cached output. Key: '.$key.', minutes: '.$minutes;
     }