Merge pull request #43 from cheprasov/v1.4.0

v1.4.0

Author: cheprasov

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## CHANGELOG
 
+### v1.4.0 (2016-07-18)
+- You can choose default version of Redis Client (**ClientFactory::setDefaultRedisVersion**).
+- Added parameter 'password' for config.
+- Added parameter 'database' for config.
+
 ### v1.3.1 (2016-05-18)
 - By default, the client works with the latest stable version of Redis (3.2.0).
 

README.md

@@ -1,7 +1,7 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 [![Latest Stable Version](https://poser.pugx.org/cheprasov/php-redis-client/v/stable)](https://packagist.org/packages/cheprasov/php-redis-client)
 [![Total Downloads](https://poser.pugx.org/cheprasov/php-redis-client/downloads)](https://packagist.org/packages/cheprasov/php-redis-client)
-# RedisClient v1.3.1 for PHP >= 5.5
+# RedisClient v1.4.0 for PHP >= 5.5
 
 ## About
 RedisClient is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from __2.6__ to __3.2__
@@ -19,6 +19,27 @@ RedisClient is a fast, fully-functional and user-friendly client for Redis, opti
 
 ## Usage
 
+### Config
+
+```
+$Redis = ClientFactory::create([
+    // Optional. Default = 'tcp://127.0.0.1:6379'. You can use 'unix:///tmp/redis.sock'
+    'server' => 'tcp://127.0.0.1:6379',
+
+    // Optional. Default = 1
+    'timeout' => 2,
+
+    // Optional. Specify version to avoid some unexpected errors.
+    'version' => '2.8.24',
+
+    // Optional. Use it only if Redis server requires password (AUTH)
+    'password' => 'some-password',
+
+    // Use it, if you want to select not default db (db != 0) on connect
+    'database' => 1,
+]);
+```
+
 ### Create a new instance of RedisClient
 ```php
 <?php

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "cheprasov/php-redis-client",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Php client for Redis. It is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from 2.6 to 3.2.0",
   "homepage": "http://github.com/cheprasov/php-redis-client",
   "minimum-stability": "stable",

phpunit.xml

@@ -34,6 +34,7 @@
         <const name="TEST_REDIS_SERVER_3x0_2" value="tcp://127.0.0.1:6386" />
         <const name="TEST_REDIS_SERVER_3x2_1" value="tcp://127.0.0.1:6387" />
         <const name="TEST_REDIS_SERVER_3x2_2" value="tcp://127.0.0.1:6388" />
+        <const name="TEST_REDIS_SERVER_PASSWORD" value="test-password-123" />
     </php>
 
 </phpunit>

src/RedisClient/Client/AbstractRedisClient.php

@@ -17,13 +17,16 @@
 use RedisClient\Pipeline\PipelineInterface;
 use RedisClient\Protocol\ProtocolInterface;
 use RedisClient\Protocol\RedisProtocol;
+use RedisClient\RedisClient;
 
 abstract class AbstractRedisClient {
 
-    const VERSION = '1.3.1';
+    const VERSION = '1.4.0';
 
     const CONFIG_SERVER = 'server';
     const CONFIG_TIMEOUT = 'timeout';
+    const CONFIG_DATABASE = 'database';
+    const CONFIG_PASSWORD = 'password';
 
     /**
      * Default configuration
@@ -59,7 +62,7 @@ protected function getConfig($param = null) {
         if (!$param) {
             return $this->config;
         }
-        return empty($this->config[$param]) ? null : $this->config[$param];
+        return isset($this->config[$param]) ? $this->config[$param] : null;
     }
 
     /**
@@ -73,10 +76,21 @@ protected function getProtocol() {
                     $this->getConfig(self::CONFIG_TIMEOUT)
                 )
             );
+            $this->onProtocolInit();
         }
         return $this->Protocol;
     }
 
+    protected function onProtocolInit() {
+        /** @var RedisClient $this */
+        if ($password = $this->getConfig(self::CONFIG_PASSWORD)) {
+            $this->auth($password);
+        }
+        if ($db = (int) $this->getConfig(self::CONFIG_DATABASE)) {
+            $this->select($db);
+        }
+    }
+
     /**
      * @inheritdoc
      */

src/RedisClient/ClientFactory.php

@@ -14,16 +14,58 @@
 use RedisClient\Client\Version\RedisClient2x8;
 use RedisClient\Client\Version\RedisClient3x0;
 use RedisClient\Client\Version\RedisClient3x2;
+use RedisClient\Exception\ErrorException;
+use RedisClient\Exception\InvalidArgumentException;
 
 class ClientFactory {
 
+    const REDIS_VERSION_2x6 = '2.6';
+    const REDIS_VERSION_2x8 = '2.8';
+    const REDIS_VERSION_3x0 = '3.0';
+    const REDIS_VERSION_3x2 = '3.2';
+
+    /**
+     * @var string|null
+     */
+    protected static $defaultRedisVersion;
+
+    /**
+     * @var array
+     */
     protected static $versions = [
-        '2.6' => RedisClient2x6::class,
-        '2.8' => RedisClient2x8::class,
-        '3.0' => RedisClient3x0::class,
-        '3.2' => RedisClient3x2::class,
+        self::REDIS_VERSION_2x6 => RedisClient2x6::class,
+        self::REDIS_VERSION_2x8 => RedisClient2x8::class,
+        self::REDIS_VERSION_3x0 => RedisClient3x0::class,
+        self::REDIS_VERSION_3x2 => RedisClient3x2::class,
     ];
 
+    /**
+     * @return string
+     */
+    public static function getDefaultRedisVersion() {
+        return self::$defaultRedisVersion ?: self::REDIS_VERSION_3x2;
+    }
+
+    /**
+     * @param string $version
+     * @throws InvalidArgumentException
+     * @throws ErrorException
+     */
+    public static function setDefaultRedisVersion($version) {
+        if (class_exists('\RedisClient\RedisClient', false)) {
+            throw new ErrorException('You can setup default version only if class "\RedisClient\RedisClient" is not loaded.');
+        }
+        if (self::$defaultRedisVersion) {
+            throw new ErrorException('Default Version is defined already.');
+        }
+        if (!array_key_exists($version, self::$versions)) {
+            throw new InvalidArgumentException(
+                'Invalid version. Supported versions are '. implode(',', array_keys(self::$versions))
+            );
+        }
+        self::$defaultRedisVersion = $version;
+    }
+
     /**
      * @param null|array $config
      * @return RedisClient2x6|RedisClient2x8|RedisClient3x0|RedisClient3x2|RedisClient
@@ -48,6 +90,9 @@ public static function createClientByVersion($version, $config = null) {
         foreach ($versions as $v) {
             if ($v >= $ver) {
                 $class = self::$versions[$v];
+                if (!self::$defaultRedisVersion) {
+                    self::setDefaultRedisVersion($v);
+                }
                 break;
             }
         }

src/RedisClient/Exception/InvalidArgumentException.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * This file is part of RedisClient.
+ * git: https://github.com/cheprasov/php-redis-client
+ *
+ * (C) Alexander Cheprasov <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace RedisClient\Exception;
+
+class InvalidArgumentException extends RedisException {
+
+}

src/RedisClient/Pipeline/Pipeline.php

@@ -10,10 +10,24 @@
  */
 namespace RedisClient\Pipeline;
 
-use RedisClient\Pipeline\Version\Pipeline3x2 as PipelineLastStableVersion;
+use RedisClient\ClientFactory;
+use RedisClient\Pipeline\Version\Pipeline2x6;
+use RedisClient\Pipeline\Version\Pipeline2x8;
+use RedisClient\Pipeline\Version\Pipeline3x0;
+use RedisClient\Pipeline\Version\Pipeline3x2;
 
-/**
- * @inheritdoc
- */
-class Pipeline extends PipelineLastStableVersion {
+switch (ClientFactory::getDefaultRedisVersion()) {
+    case '2.6':
+        class Pipeline extends Pipeline2x6 {};
+        break;
+    case '2.8':
+        class Pipeline extends Pipeline2x8 {};
+        break;
+    case '3.0':
+        class Pipeline extends Pipeline3x0 {};
+        break;
+    case '3.2':
+    default:
+        class Pipeline extends Pipeline3x2 {};
+        break;
 }

src/RedisClient/RedisClient.php

@@ -9,18 +9,24 @@
  * file that was distributed with this source code.
  */
 namespace RedisClient;
-use RedisClient\Client\Version\RedisClient3x2 as RedisClientLastStableVersion;
-use RedisClient\Pipeline\Pipeline;
-use RedisClient\Pipeline\PipelineInterface;
 
-class RedisClient extends RedisClientLastStableVersion {
-
-    /**
-     * @param \Closure|null $Pipeline
-     * @return PipelineInterface
-     */
-    protected function createPipeline(\Closure $Pipeline = null) {
-        return new Pipeline($Pipeline);
-    }
+use RedisClient\Client\Version\RedisClient2x6;
+use RedisClient\Client\Version\RedisClient2x8;
+use RedisClient\Client\Version\RedisClient3x0;
+use RedisClient\Client\Version\RedisClient3x2;
 
+switch (ClientFactory::getDefaultRedisVersion()) {
+    case '2.6':
+        class RedisClient extends RedisClient2x6 {};
+        break;
+    case '2.8':
+        class RedisClient extends RedisClient2x8 {};
+        break;
+    case '3.0':
+        class RedisClient extends RedisClient3x0 {};
+        break;
+    case '3.2':
+    default:
+        class RedisClient extends RedisClient3x2 {};
+        break;
 }

tests/Integration/DefaultDatabaseTest.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * This file is part of RedisClient.
+ * git: https://github.com/cheprasov/php-redis-client
+ *
+ * (C) Alexander Cheprasov <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Test\Integration;
+
+use RedisClient\Client\Version\RedisClient2x6;
+
+/**
+ * Check Redis Versions
+ */
+class DefaultDatabaseTest extends \PHPUnit_Framework_TestCase {
+
+    public function test_defaultDatabase() {
+        $Redis = new RedisClient2x6([
+            'server' => TEST_REDIS_SERVER_2x6_1,
+        ]);
+        $Redis->flushall();
+
+        for ($i = 0; $i <= 7; ++$i) {
+            $this->assertTrue($Redis->select($i));
+            $this->assertTrue($Redis->set('db', $i));
+        }
+
+        for ($i = 0; $i <= 7; ++$i) {
+            $Redis = new RedisClient2x6([
+                'server' => TEST_REDIS_SERVER_2x6_1,
+                'database' => $i
+            ]);
+            $this->assertEquals($i, $Redis->get('db'));
+        }
+    }
+
+}

tests/Integration/RedisVersionTest.php

@@ -33,13 +33,14 @@ class RedisVersionTest extends \PHPUnit_Framework_TestCase {
      *
      */
     public function test_RedisVersions() {
-        foreach ($this->versions as $arr) {
+        foreach ($this->versions as $n => $arr) {
             list($server, $clientVersion, $serverVersion) = $arr;
 
             $Redis = ClientFactory::create([
                 'server' => $server,
                 'timeout' => 2,
                 'version' => $clientVersion,
+                'password' => $n % 2 ? TEST_REDIS_SERVER_PASSWORD : null,
             ]);
 
             $this->assertSame($clientVersion, $Redis->getSupportedVersion());

tests/Integration/Version2x6/KeysCommandsTest.php

@@ -42,6 +42,7 @@ public static function setUpBeforeClass() {
         static::$Redis2 = new RedisClient2x6([
             'server' =>  static::TEST_REDIS_SERVER_2,
             'timeout' => 2,
+            'password' => TEST_REDIS_SERVER_PASSWORD,
         ]);
     }
 
@@ -201,21 +202,22 @@ public function test_migrate() {
         $Redis = static::$Redis;
         $Redis2 = static::$Redis2;
 
+        $this->assertSame(true, $Redis->flushall());
         $this->assertSame(true, $Redis2->flushall());
 
-        list(, $host, $port) = explode(':', str_replace('/', '', static::TEST_REDIS_SERVER_2), 3);
+        list(, $host, $port) = explode(':', str_replace('/', '', static::TEST_REDIS_SERVER_1), 3);
 
-        $this->assertSame(true, $Redis->set('one', 1));
+        $this->assertSame(true, $Redis2->set('one', 1));
 
-        $this->assertSame(null, $Redis2->get('one'));
-        $this->assertSame(true, $Redis->migrate($host, $port, 'one', 0, 100));
-        $this->assertSame('1', $Redis2->get('one'));
         $this->assertSame(null, $Redis->get('one'));
+        $this->assertSame(true, $Redis2->migrate($host, $port, 'one', 0, 100));
+        $this->assertSame('1', $Redis->get('one'));
+        $this->assertSame(null, $Redis2->get('one'));
 
-        $this->assertSame(true, $Redis->set('one', 11));
+        $this->assertSame(true, $Redis2->set('one', 11));
 
         try {
-            $this->assertSame(true, $Redis->migrate($host, $port, 'one', 0, 100));
+            $this->assertSame(true, $Redis2->migrate($host, $port, 'one', 0, 100));
             $this->assertFalse('Expect Exception');
         } catch (\Exception $Ex) {
             $this->assertInstanceOf(ErrorResponseException::class, $Ex);

tests/Integration/Version2x8/KeysCommandsTest.php

@@ -49,6 +49,7 @@ public static function setUpBeforeClass() {
         static::$Redis2 = new RedisClient2x8([
             'server' =>  static::TEST_REDIS_SERVER_2,
             'timeout' => 2,
+            'password' => TEST_REDIS_SERVER_PASSWORD,
         ]);
     }