feature #18675 [VarDumper] Add Redis caster (nicolas-grekas)

This PR was merged into the 3.2-dev branch.

Discussion
----------

[VarDumper] Add Redis caster

| Q             | A
| ------------- | ---
| Branch?       | 3.2
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Helps working on Redis connections

Commits
-------

56ae8c8 [VarDumper] Add Redis caster

src/Symfony/Component/VarDumper/Caster/RedisCaster.php

@@ -0,0 +1,75 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Caster;
+
+use Symfony\Component\VarDumper\Cloner\Stub;
+
+/**
+ * Casts Redis class from ext-redis to array representation.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+class RedisCaster
+{
+    private static $serializer = array(
+        \Redis::SERIALIZER_NONE => 'NONE',
+        \Redis::SERIALIZER_PHP => 'PHP',
+        2 => 'IGBINARY', // Optional Redis::SERIALIZER_IGBINARY
+    );
+
+    public static function castRedis(\Redis $c, array $a, Stub $stub, $isNested)
+    {
+        $prefix = Caster::PREFIX_VIRTUAL;
+
+        if (defined('HHVM_VERSION_ID')) {
+            $ser = $a[Caster::PREFIX_PROTECTED.'serializer'];
+            $a[Caster::PREFIX_PROTECTED.'serializer'] = isset(self::$serializer[$ser]) ? new ConstStub(self::$serializer[$ser], $ser) : $ser;
+
+            return $a;
+        }
+
+        if (!$connected = $c->isConnected()) {
+            return $a + array(
+                $prefix.'isConnected' => $connected,
+            );
+        }
+
+        $ser = $c->getOption(\Redis::OPT_SERIALIZER);
+        $retry = defined('Redis::OPT_SCAN') ? $c->getOption(\Redis::OPT_SCAN) : 0;
+
+        return $a + array(
+            $prefix.'isConnected' => $connected,
+            $prefix.'host' => $c->getHost(),
+            $prefix.'port' => $c->getPort(),
+            $prefix.'auth' => $c->getAuth(),
+            $prefix.'dbNum' => $c->getDbNum(),
+            $prefix.'timeout' => $c->getTimeout(),
+            $prefix.'persistentId' => $c->getPersistentID(),
+            $prefix.'options' => new EnumStub(array(
+                'READ_TIMEOUT' => $c->getOption(\Redis::OPT_READ_TIMEOUT),
+                'SERIALIZER' => isset(self::$serializer[$ser]) ? new ConstStub(self::$serializer[$ser], $ser) : $ser,
+                'PREFIX' => $c->getOption(\Redis::OPT_PREFIX),
+                'SCAN' => new ConstStub($retry ? 'RETRY' : 'NORETRY', $retry),
+            )),
+        );
+    }
+
+    public static function castRedisArray(\RedisArray $c, array $a, Stub $stub, $isNested)
+    {
+        $prefix = Caster::PREFIX_VIRTUAL;
+
+        return $a + array(
+            $prefix.'hosts' => $c->_hosts(),
+            $prefix.'function' => $c->_function(),
+        );
+    }
+}

src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php

@@ -100,6 +100,9 @@ abstract class AbstractCloner implements ClonerInterface
 
         'MongoCursorInterface' => 'Symfony\Component\VarDumper\Caster\MongoCaster::castCursor',
 
+        'Redis' => 'Symfony\Component\VarDumper\Caster\RedisCaster::castRedis',
+        'RedisArray' => 'Symfony\Component\VarDumper\Caster\RedisCaster::castRedisArray',
+
         ':curl' => 'Symfony\Component\VarDumper\Caster\ResourceCaster::castCurl',
         ':dba' => 'Symfony\Component\VarDumper\Caster\ResourceCaster::castDba',
         ':dba persistent' => 'Symfony\Component\VarDumper\Caster\ResourceCaster::castDba',

src/Symfony/Component/VarDumper/Tests/Caster/RedisCasterTest.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Tests\Caster;
+
+use Symfony\Component\VarDumper\Test\VarDumperTestTrait;
+
+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ * @requires extension redis
+ */
+class RedisCasterTest extends \PHPUnit_Framework_TestCase
+{
+    use VarDumperTestTrait;
+
+    public function testNotConnected()
+    {
+        $redis = new \Redis();
+
+        if (defined('HHVM_VERSION_ID')) {
+            $xCast = <<<'EODUMP'
+Redis {
+  #host: ""
+%A
+}
+EODUMP;
+        } else {
+            $xCast = <<<'EODUMP'
+Redis {
+  isConnected: false
+}
+EODUMP;
+        }
+
+        $this->assertDumpMatchesFormat($xCast, $redis);
+    }
+
+    public function testConnected()
+    {
+        $redis = new \Redis();
+        if (!@$redis->connect('127.0.0.1')) {
+            $e = error_get_last();
+            self::markTestSkipped($e['message']);
+        }
+
+        if (defined('HHVM_VERSION_ID')) {
+            $xCast = <<<'EODUMP'
+Redis {
+  #host: "127.0.0.1"
+%A
+}
+EODUMP;
+        } else {
+            $xCast = <<<'EODUMP'
+Redis {
+  +"socket": Redis Socket Buffer resource
+  isConnected: true
+  host: "127.0.0.1"
+  port: 6379
+  auth: null
+  dbNum: 0
+  timeout: 0.0
+  persistentId: null
+  options: {
+    READ_TIMEOUT: 0.0
+    SERIALIZER: NONE
+    PREFIX: null
+    SCAN: NORETRY
+  }
+}
+EODUMP;
+        }
+
+        $this->assertDumpMatchesFormat($xCast, $redis);
+    }
+}