Allow \RedisArray and \RedisCluster objects for RedisCachePool (#194)

Author: wshafer

Diff for: README.md

@@ -20,14 +20,28 @@ composer require cache/redis-adapter
 
 ### Use
 
-To create an instance of `RedisCachePool` you need to configure a `\Redis` client. 
+To create an instance of `RedisCachePool` you need to configure a `\Redis`, `\RedisArray` or `\RedisCluster` client. 
 
+\Redis
 ```php
 $client = new \Redis();
 $client->connect('127.0.0.1', 6379);
 $pool = new RedisCachePool($client);
 ```
 
+\RedisArray
+```php
+$client = new \RedisArray(['127.0.0.1:6379', '127.0.0.2:6379']);
+$pool = new RedisCachePool($client);
+```
+
+\RedisCluster
+```php
+$client = new \RedisCluster(null, ['127.0.0.1:7000', '127.0.0.2:7001', '127.0.0.2:7002',]);
+$pool = new RedisCachePool($client);
+```
+
+_See [PhpRedis](https://github.com/phpredis/phpredis) for more connection options_
 
 ### Contribute
 

Diff for: RedisCachePool.php

@@ -12,6 +12,7 @@
 namespace Cache\Adapter\Redis;
 
 use Cache\Adapter\Common\AbstractCachePool;
+use Cache\Adapter\Common\Exception\CachePoolException;
 use Cache\Adapter\Common\PhpCacheItem;
 use Cache\Hierarchy\HierarchicalCachePoolTrait;
 use Cache\Hierarchy\HierarchicalPoolInterface;
@@ -29,10 +30,19 @@ class RedisCachePool extends AbstractCachePool implements HierarchicalPoolInterf
     protected $cache;
 
     /**
-     * @param \Redis $cache
+     * @param \Redis|\RedisArray|\RedisCluster $cache
      */
-    public function __construct(\Redis $cache)
+    public function __construct($cache)
     {
+        if (!$cache instanceof \Redis
+            && !$cache instanceof \RedisArray
+            && !$cache instanceof \RedisCluster
+        ) {
+            throw new CachePoolException(
+                'Cache instance must be of type \Redis, \RedisArray, or \RedisCluster'
+            );
+        }
+
         $this->cache = $cache;
     }
 
@@ -53,7 +63,44 @@ protected function fetchObjectFromCache($key)
      */
     protected function clearAllObjectsFromCache()
     {
-        return $this->cache->flushDb();
+        if ($this->cache instanceof \RedisCluster) {
+            return $this->clearAllObjectsFromCacheCluster();
+        }
+
+        $result = $this->cache->flushDb();
+
+        if (!is_array($result)) {
+            return $result;
+        }
+
+        $success = true;
+
+        foreach ($result as $serverResult) {
+            if (!$serverResult) {
+                $success = false;
+                break;
+            }
+        }
+
+        return $success;
+    }
+
+    /**
+     * Clear all objects from all nodes in the cluster.
+     *
+     * @return bool false if error
+     */
+    protected function clearAllObjectsFromCacheCluster()
+    {
+        $nodes = $this->cache->_masters();
+
+        foreach ($nodes as $node) {
+            if (!$this->cache->flushDB($node)) {
+                return false;
+            }
+        }
+
+        return true;
     }
 
     /**

Diff for: Tests/ArrayIntegrationHierarchyTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\HierarchicalCachePoolTest;
+
+class ArrayIntegrationHierarchyTest extends HierarchicalCachePoolTest
+{
+    use CreateRedisArrayCachePoolTrait;
+}

Diff for: Tests/ArrayIntegrationPoolTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\CachePoolTest as BaseTest;
+
+class ArrayIntegrationPoolTest extends BaseTest
+{
+    use CreateRedisArrayCachePoolTrait;
+}

Diff for: Tests/ArrayIntegrationSimpleCacheTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\SimpleCacheTest as BaseTest;
+
+class ArrayIntegrationSimpleCacheTest extends BaseTest
+{
+    use CreateRedisArrayCachePoolTrait;
+}

Diff for: Tests/ArrayIntegrationTagTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\TaggableCachePoolTest;
+
+class ArrayIntegrationTagTest extends TaggableCachePoolTest
+{
+    use CreateRedisArrayCachePoolTrait;
+}

Diff for: Tests/ClusterIntegrationHierarchyTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\HierarchicalCachePoolTest;
+
+class ClusterIntegrationHierarchyTest extends HierarchicalCachePoolTest
+{
+    use CreateRedisClusterPoolTrait;
+}

Diff for: Tests/ClusterIntegrationPoolTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\CachePoolTest as BaseTest;
+
+class ClusterIntegrationPoolTest extends BaseTest
+{
+    use CreateRedisClusterPoolTrait;
+}

Diff for: Tests/ClusterIntegrationSimpleCacheTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\SimpleCacheTest as BaseTest;
+
+class ClusterIntegrationSimpleCacheTest extends BaseTest
+{
+    use CreateRedisClusterPoolTrait;
+}

Diff for: Tests/ClusterIntegrationTagTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\IntegrationTests\TaggableCachePoolTest;
+
+class ClusterIntegrationTagTest extends TaggableCachePoolTest
+{
+    use CreateRedisClusterPoolTrait;
+}

Diff for: Tests/CreateRedisArrayCachePoolTrait.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\Adapter\Redis\RedisCachePool;
+
+trait CreateRedisArrayCachePoolTrait
+{
+    private $client = null;
+
+    public function createCachePool()
+    {
+        return new RedisCachePool($this->getClient());
+    }
+
+    private function getClient()
+    {
+        if ($this->client === null) {
+            $this->client = new \RedisArray(['127.0.0.1:6379']);
+        }
+
+        return $this->client;
+    }
+
+    public function createSimpleCache()
+    {
+        return $this->createCachePool();
+    }
+}

Diff for: Tests/CreateRedisClusterPoolTrait.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\Adapter\Redis\Tests;
+
+use Cache\Adapter\Redis\RedisCachePool;
+
+trait CreateRedisClusterPoolTrait
+{
+    private $client = null;
+
+    public function createCachePool()
+    {
+        return new RedisCachePool($this->getClient());
+    }
+
+    private function getClient()
+    {
+        if ($this->client === null) {
+            $this->client = new \RedisCluster(null, ['127.0.0.1:7000', '127.0.0.1:7001', '127.0.0.1:7002']);
+        }
+
+        return $this->client;
+    }
+
+    public function createSimpleCache()
+    {
+        return $this->createCachePool();
+    }
+}

Diff for: Tests/CreatePoolTrait.php renamed to Tests/CreateRedisPoolTrait.php

@@ -13,7 +13,7 @@
 
 use Cache\Adapter\Redis\RedisCachePool;
 
-trait CreatePoolTrait
+trait CreateRedisPoolTrait
 {
     private $client = null;
 

Diff for: Tests/IntegrationHierarchyTest.php

@@ -15,5 +15,5 @@
 
 class IntegrationHierarchyTest extends HierarchicalCachePoolTest
 {
-    use CreatePoolTrait;
+    use CreateRedisPoolTrait;
 }

Diff for: Tests/IntegrationPoolTest.php

@@ -15,5 +15,5 @@
 
 class IntegrationPoolTest extends BaseTest
 {
-    use CreatePoolTrait;
+    use CreateRedisPoolTrait;
 }

Diff for: Tests/IntegrationSimpleCacheTest.php

@@ -15,5 +15,5 @@
 
 class IntegrationSimpleCacheTest extends BaseTest
 {
-    use CreatePoolTrait;
+    use CreateRedisPoolTrait;
 }

Diff for: Tests/IntegrationTagTest.php

@@ -15,5 +15,5 @@
 
 class IntegrationTagTest extends TaggableCachePoolTest
 {
-    use CreatePoolTrait;
+    use CreateRedisPoolTrait;
 }