Merge pull request #9 from shadowhand/feature/redis-adapter

Add Redis storage adapter

Author: richardfullmer

README.md

@@ -40,10 +40,15 @@ Storage
 There are a number of different storage implementations for where the configuration for the rollout is stored.
 
 * ArrayStorage - default storage, not persistent
-* DoctrineCacheStorageAdapter - requires `doctrine/cache`
-* PDOStorageAdapter - persistent with a simple \PDO object
+* DoctrineCacheStorageAdapter - requires [doctrine/cache][doctrine-cache]
+* PDOStorageAdapter - persistent using [PDO][pdo]
+* RedisStorageAdapter - persistent using [Redis][redis]
 
-The storage implementation must implement the `Storage\StorageInterface`'s methods.
+[doctrine-cache]: https://packagist.org/packages/doctrine/cache
+[pdo]: http://php.net/pdo
+[redis]: http://redis.io
+
+All storage adapters must implement `Opensoft\Rollout\Storage\StorageInterface`.
 
 Groups
 ------

phpunit.xml.dist

@@ -25,4 +25,8 @@
         </whitelist>
     </filter>
 
+    <logging>
+        <log type="coverage-text" target="php://stdout"/>
+    </logging>
+
 </phpunit>

src/Storage/RedisStorageAdapter.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Opensoft\Rollout\Storage;
+
+/**
+ * Storage adapter using Redis
+ *
+ * @author Woody Gilk <@shadowhand>
+ */
+class RedisStorageAdapter implements StorageInterface
+{
+    /**
+     * @var string
+     */
+    const DEFAULT_GROUP = 'rollout_feature';
+
+    /**
+     * @var object
+     */
+    private $redis;
+
+    /**
+     * @var string
+     */
+    private $group = self::DEFAULT_GROUP;
+
+    public function __construct($redis, $group = null)
+    {
+        $this->redis = $redis;
+
+        if ($group) {
+            $this->group = $group;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function get($key)
+    {
+        $result = $this->redis->hget($this->group, $key);
+
+        if (empty($result)) {
+            return null;
+        }
+
+        $result = json_decode($result, true);
+
+        if (JSON_ERROR_NONE !== json_last_error()) {
+            return null;
+        }
+
+        return $result;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function set($key, $value)
+    {
+        $this->redis->hset($this->group, $key, json_encode($value));
+    }
+}

tests/Storage/RedisStorageAdapterTest.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Opensoft\Tests\Storage;
+
+use Opensoft\Rollout\Storage\RedisStorageAdapter;
+
+class RedisStorageAdapterTest extends \PHPUnit_Framework_TestCase
+{
+    private $redis;
+
+    public function setUp()
+    {
+        $this->redis = $this->getMockBuilder('\Opensoft\Tests\Storage\mockRedis')->getMock();
+    }
+
+    public function testGet()
+    {
+        $this->redis->expects($this->once())
+            ->method('hget')
+            ->with(RedisStorageAdapter::DEFAULT_GROUP, 'key')
+            ->willReturn(json_encode('success'));
+
+        $adapter = new RedisStorageAdapter($this->redis);
+
+        $result = $adapter->get('key');
+        $this->assertSame('success', $result);
+    }
+
+    public function testGetWithCustomGroup()
+    {
+        $this->redis->expects($this->once())
+            ->method('hget')
+            ->with('rollout_test', 'key')
+            ->willReturn(json_encode('success'));
+
+        $adapter = new RedisStorageAdapter($this->redis, 'rollout_test');
+
+        $result = $adapter->get('key');
+        $this->assertSame('success', $result);
+    }
+
+    public function testGetNotExistsFailure()
+    {
+        $this->redis->expects($this->once())
+            ->method('hget')
+            ->with(RedisStorageAdapter::DEFAULT_GROUP, 'key')
+            ->willReturn('');
+
+        $adapter = new RedisStorageAdapter($this->redis);
+
+        $result = $adapter->get('key');
+        $this->assertNull($result);
+    }
+
+    public function testGetJsonDecodeFailure()
+    {
+        $this->redis->expects($this->once())
+            ->method('hget')
+            ->with(RedisStorageAdapter::DEFAULT_GROUP, 'key')
+            ->willReturn('not json');
+
+        $adapter = new RedisStorageAdapter($this->redis);
+
+        $result = $adapter->get('key');
+        $this->assertNull($result);
+    }
+
+    public function testSet()
+    {
+        $this->redis->expects($this->once())
+            ->method('hset')
+            ->with(RedisStorageAdapter::DEFAULT_GROUP, 'key', json_encode('value'));
+
+        $adapter = new RedisStorageAdapter($this->redis);
+
+        $adapter->set('key', 'value');
+    }
+
+    public function testSetWithCustomGroup()
+    {
+        $this->redis->expects($this->once())
+            ->method('hset')
+            ->with('rollout_test', 'key', json_encode('value'));
+
+        $adapter = new RedisStorageAdapter($this->redis, 'rollout_test');
+
+        $adapter->set('key', 'value');
+    }
+}
+
+interface mockRedis
+{
+    public function hget($key, $field);
+    public function hset($key, $field, $value);
+}