Merge pull request #53 from php-cache/tagging04

Nyholm · Nyholm · commit dd0d87821b6c · 2016-03-18T13:01:02.000+01:00
Support for tagging 0.4
diff --git a/composer.json b/composer.json
@@ -9,7 +9,7 @@
         "router",
         "session"
     ],
-    "homepage":     "https://github.com/php-cache/cache-bundle",
+    "homepage":     "http://www.php-cache.com/en/latest/",
     "license":      "MIT",
     "authors":      [
         {
@@ -24,15 +24,15 @@
         }
     ],
     "require":      {
-        "php":                         "^5.5|^7",
+        "php":                         "^5.5|^7.0",
         "symfony/framework-bundle":    "^2.7|^3.0",
-        "cache/taggable-cache":        "^0.3",
+        "cache/taggable-cache":        "^0.4",
         "cache/session-handler":       "^0.1"
     },
     "require-dev":  {
         "phpunit/phpunit":             "^5.1|^4.0",
         "cache/psr-6-doctrine-bridge": "^2.0",
-        "cache/array-adapter":         "@stable"
+        "cache/array-adapter":         "^0.4"
     },
     "suggest":      {
         "cache/adapter-bundle": "To register PSR-6 compliant cache implementations as services.",
diff --git a/src/Cache/FixedTaggingCachePool.php b/src/Cache/FixedTaggingCachePool.php
@@ -11,6 +11,7 @@
 
 namespace Cache\CacheBundle\Cache;
 
+use Cache\Taggable\TaggableItemInterface;
 use Cache\Taggable\TaggablePoolInterface;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
@@ -48,54 +49,56 @@ public function __construct(TaggablePoolInterface $cache, array $tags)
      */
     public function getItem($key)
     {
-        return $this->cache->getItem($key, $this->tags);
+        return $this->cache->getItem($key);
     }
 
     /**
      * {@inheritdoc}
      */
     public function getItems(array $keys = [])
     {
-        return $this->cache->getItems($keys, $this->tags);
+        return $this->cache->getItems($keys);
     }
 
     /**
      * {@inheritdoc}
      */
     public function hasItem($key)
     {
-        return $this->cache->hasItem($key, $this->tags);
+        return $this->cache->hasItem($key);
     }
 
     /**
      * {@inheritdoc}
      */
     public function clear()
     {
-        return $this->cache->clear($this->tags);
+        return $this->cache->clear();
     }
 
     /**
      * {@inheritdoc}
      */
     public function deleteItem($key)
     {
-        return $this->cache->deleteItem($key, $this->tags);
+        return $this->cache->deleteItem($key);
     }
 
     /**
      * {@inheritdoc}
      */
     public function deleteItems(array $keys)
     {
-        return $this->cache->deleteItems($keys, $this->tags);
+        return $this->cache->deleteItems($keys);
     }
 
     /**
      * {@inheritdoc}
      */
     public function save(CacheItemInterface $item)
     {
+        $this->addTags($item);
+
         return $this->cache->save($item);
     }
 
@@ -104,9 +107,21 @@ public function save(CacheItemInterface $item)
      */
     public function saveDeferred(CacheItemInterface $item)
     {
+        $this->addTags($item);
+
         return $this->cache->saveDeferred($item);
     }
 
+    /**
+     * @param TaggableItemInterface $item
+     */
+    private function addTags(TaggableItemInterface $item)
+    {
+        foreach ($this->tags as $tag) {
+            $item->addTag($tag);
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
diff --git a/src/Cache/RecordingCachePool.php b/src/Cache/RecordingCachePool.php
@@ -67,11 +67,11 @@ private function timeCall($name, array $arguments = null)
         return $object;
     }
 
-    public function getItem($key, array $tags = [])
+    public function getItem($key)
     {
-        $call         = $this->timeCall(__FUNCTION__, [$key, $tags]);
-        $result       = $call->result;
-        $call->isHit  = $result->isHit();
+        $call        = $this->timeCall(__FUNCTION__, [$key]);
+        $result      = $call->result;
+        $call->isHit = $result->isHit();
 
         // Display the result in a good way depending on the data type
         if ($call->isHit) {
@@ -85,17 +85,17 @@ public function getItem($key, array $tags = [])
         return $result;
     }
 
-    public function hasItem($key, array $tags = [])
+    public function hasItem($key)
     {
-        $call          = $this->timeCall(__FUNCTION__, [$key, $tags]);
+        $call = $this->timeCall(__FUNCTION__, [$key]);
         $this->addCall($call);
 
         return $call->result;
     }
 
-    public function deleteItem($key, array $tags = [])
+    public function deleteItem($key)
     {
-        $call          = $this->timeCall(__FUNCTION__, [$key, $tags]);
+        $call = $this->timeCall(__FUNCTION__, [$key]);
         $this->addCall($call);
 
         return $call->result;
@@ -125,35 +125,43 @@ public function saveDeferred(CacheItemInterface $item)
         return $call->result;
     }
 
-    public function getItems(array $keys = [], array $tags = [])
+    public function getItems(array $keys = [])
     {
-        $call         = $this->timeCall(__FUNCTION__, [$keys, $tags]);
+        $call         = $this->timeCall(__FUNCTION__, [$keys]);
         $result       = $call->result;
         $call->result = sprintf('<DATA:%s>', gettype($result));
         $this->addCall($call);
 
         return $result;
     }
 
-    public function clear(array $tags = [])
+    public function clear()
+    {
+        $call = $this->timeCall(__FUNCTION__, []);
+        $this->addCall($call);
+
+        return $call->result;
+    }
+
+    public function clearTags(array $tags)
     {
-        $call          = $this->timeCall(__FUNCTION__, [$tags]);
+        $call = $this->timeCall(__FUNCTION__, [$tags]);
         $this->addCall($call);
 
         return $call->result;
     }
 
-    public function deleteItems(array $keys, array $tags = [])
+    public function deleteItems(array $keys)
     {
-        $call          = $this->timeCall(__FUNCTION__, [$keys, $tags]);
+        $call = $this->timeCall(__FUNCTION__, [$keys]);
         $this->addCall($call);
 
         return $call->result;
     }
 
     public function commit()
     {
-        $call          = $this->timeCall(__FUNCTION__);
+        $call = $this->timeCall(__FUNCTION__);
         $this->addCall($call);
 
         return $call->result;
diff --git a/src/Command/CacheFlushCommand.php b/src/Command/CacheFlushCommand.php
@@ -123,7 +123,7 @@ private function clearTypedCacheFromService($type, $serviceId)
         /** @type \Psr\Cache\CacheItemPoolInterface $service */
         $service = $this->getContainer()->get($serviceId);
         if ($service instanceof TaggablePoolInterface) {
-            return $service->clear([$type]);
+            return $service->clearTags([$type]);
         } else {
             return $service->clear();
         }
diff --git a/src/Routing/CachingRouter.php b/src/Routing/CachingRouter.php
@@ -11,7 +11,7 @@
 
 namespace Cache\CacheBundle\Routing;
 
-use Cache\Taggable\TaggablePoolInterface;
+use Cache\Taggable\TaggableItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\RouterInterface;
@@ -163,10 +163,10 @@ public function __call($method, $args)
      */
     private function getCacheItemFromKey($key, $tag)
     {
-        if ($this->cache instanceof TaggablePoolInterface) {
-            $item = $this->cache->getItem($key, ['router', $tag]);
-        } else {
-            $item = $this->cache->getItem($key);
+        $item = $this->cache->getItem($key);
+
+        if ($item instanceof TaggableItemInterface) {
+            $item->setTags(['router', $tag]);
         }
 
         return $item;
diff --git a/tests/ContainerTest.php b/tests/ContainerTest.php
@@ -18,9 +18,6 @@
  */
 class ContainerTest extends TestCase
 {
-    /**
-     *
-     */
     public function testContainer()
     {
         //$container = $this->createContainer();
diff --git a/tests/DependencyInjection/CacheExtensionTest.php b/tests/DependencyInjection/CacheExtensionTest.php
@@ -20,9 +20,6 @@
  */
 class CacheExtensionTest extends TestCase
 {
-    /**
-     *
-     */
     public function testRouterBuilder()
     {
         $container = $this->createContainerFromFile('router');

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Cache\CacheBundle\Cache;`
`13`	`13`
	`14`	`+use Cache\Taggable\TaggableItemInterface;`
`14`	`15`	`use Cache\Taggable\TaggablePoolInterface;`
`15`	`16`	`use Psr\Cache\CacheItemInterface;`
`16`	`17`	`use Psr\Cache\CacheItemPoolInterface;`
`@@ -48,54 +49,56 @@ public function __construct(TaggablePoolInterface $cache, array $tags)`
`48`	`49`	`*/`
`49`	`50`	`public function getItem($key)`
`50`	`51`	`{`
`51`		`- return $this->cache->getItem($key, $this->tags);`
	`52`	`+ return $this->cache->getItem($key);`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`/**`
`55`	`56`	`* {@inheritdoc}`
`56`	`57`	`*/`
`57`	`58`	`public function getItems(array $keys = [])`
`58`	`59`	`{`
`59`		`- return $this->cache->getItems($keys, $this->tags);`
	`60`	`+ return $this->cache->getItems($keys);`
`60`	`61`	`}`
`61`	`62`
`62`	`63`	`/**`
`63`	`64`	`* {@inheritdoc}`
`64`	`65`	`*/`
`65`	`66`	`public function hasItem($key)`
`66`	`67`	`{`
`67`		`- return $this->cache->hasItem($key, $this->tags);`
	`68`	`+ return $this->cache->hasItem($key);`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`/**`
`71`	`72`	`* {@inheritdoc}`
`72`	`73`	`*/`
`73`	`74`	`public function clear()`
`74`	`75`	`{`
`75`		`- return $this->cache->clear($this->tags);`
	`76`	`+ return $this->cache->clear();`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`/**`
`79`	`80`	`* {@inheritdoc}`
`80`	`81`	`*/`
`81`	`82`	`public function deleteItem($key)`
`82`	`83`	`{`
`83`		`- return $this->cache->deleteItem($key, $this->tags);`
	`84`	`+ return $this->cache->deleteItem($key);`
`84`	`85`	`}`
`85`	`86`
`86`	`87`	`/**`
`87`	`88`	`* {@inheritdoc}`
`88`	`89`	`*/`
`89`	`90`	`public function deleteItems(array $keys)`
`90`	`91`	`{`
`91`		`- return $this->cache->deleteItems($keys, $this->tags);`
	`92`	`+ return $this->cache->deleteItems($keys);`
`92`	`93`	`}`
`93`	`94`
`94`	`95`	`/**`
`95`	`96`	`* {@inheritdoc}`
`96`	`97`	`*/`
`97`	`98`	`public function save(CacheItemInterface $item)`
`98`	`99`	`{`
	`100`	`+ $this->addTags($item);`
	`101`	`+`
`99`	`102`	`return $this->cache->save($item);`
`100`	`103`	`}`
`101`	`104`
`@@ -104,9 +107,21 @@ public function save(CacheItemInterface $item)`
`104`	`107`	`*/`
`105`	`108`	`public function saveDeferred(CacheItemInterface $item)`
`106`	`109`	`{`
	`110`	`+ $this->addTags($item);`
	`111`	`+`
`107`	`112`	`return $this->cache->saveDeferred($item);`
`108`	`113`	`}`
`109`	`114`
	`115`	`+ /**`
	`116`	`+ * @param TaggableItemInterface $item`
	`117`	`+ */`
	`118`	`+ private function addTags(TaggableItemInterface $item)`
	`119`	`+ {`
	`120`	`+ foreach ($this->tags as $tag) {`
	`121`	`+ $item->addTag($tag);`
	`122`	`+ }`
	`123`	`+ }`
	`124`	`+`
`110`	`125`	`/**`
`111`	`126`	`* {@inheritdoc}`
`112`	`127`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -67,11 +67,11 @@ private function timeCall($name, array $arguments = null)`
`67`	`67`	`return $object;`
`68`	`68`	`}`
`69`	`69`
`70`		`- public function getItem($key, array $tags = [])`
	`70`	`+ public function getItem($key)`
`71`	`71`	`{`
`72`		`- $call = $this->timeCall(__FUNCTION__, [$key, $tags]);`
`73`		`- $result = $call->result;`
`74`		`- $call->isHit = $result->isHit();`
	`72`	`+ $call = $this->timeCall(__FUNCTION__, [$key]);`
	`73`	`+ $result = $call->result;`
	`74`	`+ $call->isHit = $result->isHit();`
`75`	`75`
`76`	`76`	`// Display the result in a good way depending on the data type`
`77`	`77`	`if ($call->isHit) {`
`@@ -85,17 +85,17 @@ public function getItem($key, array $tags = [])`
`85`	`85`	`return $result;`
`86`	`86`	`}`
`87`	`87`
`88`		`- public function hasItem($key, array $tags = [])`
	`88`	`+ public function hasItem($key)`
`89`	`89`	`{`
`90`		`- $call = $this->timeCall(__FUNCTION__, [$key, $tags]);`
	`90`	`+ $call = $this->timeCall(__FUNCTION__, [$key]);`
`91`	`91`	`$this->addCall($call);`
`92`	`92`
`93`	`93`	`return $call->result;`
`94`	`94`	`}`
`95`	`95`
`96`		`- public function deleteItem($key, array $tags = [])`
	`96`	`+ public function deleteItem($key)`
`97`	`97`	`{`
`98`		`- $call = $this->timeCall(__FUNCTION__, [$key, $tags]);`
	`98`	`+ $call = $this->timeCall(__FUNCTION__, [$key]);`
`99`	`99`	`$this->addCall($call);`
`100`	`100`
`101`	`101`	`return $call->result;`
`@@ -125,35 +125,43 @@ public function saveDeferred(CacheItemInterface $item)`
`125`	`125`	`return $call->result;`
`126`	`126`	`}`
`127`	`127`
`128`		`- public function getItems(array $keys = [], array $tags = [])`
	`128`	`+ public function getItems(array $keys = [])`
`129`	`129`	`{`
`130`		`- $call = $this->timeCall(__FUNCTION__, [$keys, $tags]);`
	`130`	`+ $call = $this->timeCall(__FUNCTION__, [$keys]);`
`131`	`131`	`$result = $call->result;`
`132`	`132`	`$call->result = sprintf('<DATA:%s>', gettype($result));`
`133`	`133`	`$this->addCall($call);`
`134`	`134`
`135`	`135`	`return $result;`
`136`	`136`	`}`
`137`	`137`
`138`		`- public function clear(array $tags = [])`
	`138`	`+ public function clear()`
	`139`	`+ {`
	`140`	`+ $call = $this->timeCall(__FUNCTION__, []);`
	`141`	`+ $this->addCall($call);`
	`142`	`+`
	`143`	`+ return $call->result;`
	`144`	`+ }`
	`145`	`+`
	`146`	`+ public function clearTags(array $tags)`
`139`	`147`	`{`
`140`		`- $call = $this->timeCall(__FUNCTION__, [$tags]);`
	`148`	`+ $call = $this->timeCall(__FUNCTION__, [$tags]);`
`141`	`149`	`$this->addCall($call);`
`142`	`150`
`143`	`151`	`return $call->result;`
`144`	`152`	`}`
`145`	`153`
`146`		`- public function deleteItems(array $keys, array $tags = [])`
	`154`	`+ public function deleteItems(array $keys)`
`147`	`155`	`{`
`148`		`- $call = $this->timeCall(__FUNCTION__, [$keys, $tags]);`
	`156`	`+ $call = $this->timeCall(__FUNCTION__, [$keys]);`
`149`	`157`	`$this->addCall($call);`
`150`	`158`
`151`	`159`	`return $call->result;`
`152`	`160`	`}`
`153`	`161`
`154`	`162`	`public function commit()`
`155`	`163`	`{`
`156`		`- $call = $this->timeCall(__FUNCTION__);`
	`164`	`+ $call = $this->timeCall(__FUNCTION__);`
`157`	`165`	`$this->addCall($call);`
`158`	`166`
`159`	`167`	`return $call->result;`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ private function clearTypedCacheFromService($type, $serviceId)`
`123`	`123`	`/** @type \Psr\Cache\CacheItemPoolInterface $service */`
`124`	`124`	`$service = $this->getContainer()->get($serviceId);`
`125`	`125`	`if ($service instanceof TaggablePoolInterface) {`
`126`		`- return $service->clear([$type]);`
	`126`	`+ return $service->clearTags([$type]);`
`127`	`127`	`} else {`
`128`	`128`	`return $service->clear();`
`129`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,6 @@`
`18`	`18`	`*/`
`19`	`19`	`class ContainerTest extends TestCase`
`20`	`20`	`{`
`21`		`- /**`
`22`		`- *`
`23`		`- */`
`24`	`21`	`public function testContainer()`
`25`	`22`	`{`
`26`	`23`	`//$container = $this->createContainer();`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,6 @@`
`20`	`20`	`*/`
`21`	`21`	`class CacheExtensionTest extends TestCase`
`22`	`22`	`{`
`23`		`- /**`
`24`		`- *`
`25`		`- */`
`26`	`23`	`public function testRouterBuilder()`
`27`	`24`	`{`
`28`	`25`	`$container = $this->createContainerFromFile('router');`