[TwigBridge] add Twig dump() function + tests and fixes

Author: nicolas-grekas

composer.json

@@ -85,10 +85,7 @@
             "src/Symfony/Component/HttpFoundation/Resources/stubs",
             "src/Symfony/Component/Intl/Resources/stubs"
         ],
-        "files": [
-            "src/Symfony/Component/Intl/Resources/stubs/functions.php",
-            "src/Symfony/Component/VarDumper/Resources/functions/dump.php"
-        ]
+        "files": [ "src/Symfony/Component/Intl/Resources/stubs/functions.php" ]
     },
     "minimum-stability": "dev",
     "extra": {

src/Symfony/Bridge/Twig/Extension/DumpExtension.php

@@ -12,6 +12,8 @@
 namespace Symfony\Bridge\Twig\Extension;
 
 use Symfony\Bridge\Twig\TokenParser\DumpTokenParser;
+use Symfony\Component\VarDumper\Cloner\ClonerInterface;
+use Symfony\Component\VarDumper\Dumper\HtmlDumper;
 
 /**
  * Provides integration of the dump() function with Twig.
@@ -20,6 +22,18 @@
  */
 class DumpExtension extends \Twig_Extension
 {
+    public function __construct(ClonerInterface $cloner = null)
+    {
+        $this->cloner = $cloner;
+    }
+
+    public function getFunctions()
+    {
+        return array(
+            new \Twig_SimpleFunction('dump', array($this, 'dump'), array('is_safe' => array('html'), 'needs_context' => true, 'needs_environment' => true)),
+        );
+    }
+
     public function getTokenParsers()
     {
         return array(new DumpTokenParser());
@@ -29,4 +43,38 @@ public function getName()
     {
         return 'dump';
     }
+
+    public function dump(\Twig_Environment $env, $context)
+    {
+        if (!$env->isDebug() || !$this->cloner) {
+            return;
+        }
+
+        if (2 === func_num_args()) {
+            $vars = array();
+            foreach ($context as $key => $value) {
+                if (!$value instanceof \Twig_Template) {
+                    $vars[$key] = $value;
+                }
+            }
+
+            $vars = array($vars);
+        } else {
+            $vars = func_get_args();
+            unset($vars[0], $vars[1]);
+        }
+
+        $html = '';
+        $dumper = new HtmlDumper(function ($line, $depth) use (&$html) {
+            if (-1 !== $depth) {
+                $html .= str_repeat('  ', $depth).$line."\n";
+            }
+        });
+
+        foreach ($vars as $value) {
+            $dumper->dump($this->cloner->cloneVar($value));
+        }
+
+        return $html;
+    }
 }

src/Symfony/Bridge/Twig/Tests/Extension/DumpExtensionTest.php

@@ -13,20 +13,22 @@
 
 use Symfony\Bridge\Twig\Extension\DumpExtension;
 use Symfony\Component\VarDumper\VarDumper;
+use Symfony\Component\VarDumper\Cloner\PhpCloner;
 
 class DumpExtensionTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * @dataProvider getDumpParams
+     * @dataProvider getDumpTags
      */
-    public function testDebugDump($template, $debug, $expectedOutput, $expectedDumped)
+    public function testDumpTag($template, $debug, $expectedOutput, $expectedDumped)
     {
+        $extension = new DumpExtension(new PhpCloner());
         $twig = new \Twig_Environment(new \Twig_Loader_String(), array(
             'debug' => $debug,
             'cache' => false,
             'optimizations' => 0,
         ));
-        $twig->addExtension(new DumpExtension());
+        $twig->addExtension($extension);
 
         $dumped = null;
         $exception = null;
@@ -46,12 +48,58 @@ public function testDebugDump($template, $debug, $expectedOutput, $expectedDumpe
         $this->assertSame($expectedDumped, $dumped);
     }
 
-    public function getDumpParams()
+    public function getDumpTags()
     {
         return array(
             array('A{% dump %}B', true, 'AB', array()),
             array('A{% set foo="bar"%}B{% dump %}C', true, 'ABC', array('foo' => 'bar')),
             array('A{% dump %}B', false, 'AB', null),
         );
     }
+
+    /**
+     * @dataProvider getDumpArgs
+     */
+    public function testDump($context, $args, $expectedOutput, $debug = true)
+    {
+        $extension = new DumpExtension(new PhpCloner());
+        $twig = new \Twig_Environment(new \Twig_Loader_String(), array(
+            'debug' => $debug,
+            'cache' => false,
+            'optimizations' => 0,
+        ));
+
+        array_unshift($args, $context);
+        array_unshift($args, $twig);
+
+        $dump = call_user_func_array(array($extension, 'dump'), $args);
+
+        if ($debug) {
+            $this->assertStringStartsWith('<script>', $dump);
+            $dump = preg_replace('/^.*?<pre/', '<pre', $dump);
+        }
+        $this->assertEquals($expectedOutput, $dump);
+    }
+
+    public function getDumpArgs()
+    {
+        return array(
+            array(array(), array(), '', false),
+            array(array(), array(), "<pre id=sf-dump><span class=sf-dump-0>[]\n</span></pre><script>Sfjs.dump.instrument()</script>\n"),
+            array(
+                array(),
+                array(123, 456),
+                "<pre id=sf-dump><span class=sf-dump-0><span class=sf-dump-num>123</span>\n</span></pre><script>Sfjs.dump.instrument()</script>\n"
+                ."<pre id=sf-dump><span class=sf-dump-0><span class=sf-dump-num>456</span>\n</span></pre><script>Sfjs.dump.instrument()</script>\n",
+            ),
+            array(
+                array('foo' => 'bar'),
+                array(),
+                "<pre id=sf-dump><span class=sf-dump-0><span class=sf-dump-note>array:1</span> [<span name=sf-dump-child>\n"
+                ."  <span class=sf-dump-1>\"<span class=sf-dump-meta>foo</span>\" => \"<span class=sf-dump-str>bar</span>\"\n"
+                ."</span></span>]\n"
+                ."</span></pre><script>Sfjs.dump.instrument()</script>\n",
+            ),
+        );
+    }
 }

src/Symfony/Bundle/TwigBundle/Resources/config/debug.xml

@@ -17,12 +17,9 @@
             <argument type="service" id="debug.stopwatch" />
         </service>
 
-        <service id="twig.extension.debug" class="Twig_Extension_Debug" public="false">
-            <tag name="twig.extension" />
-        </service>
-
         <service id="twig.extension.dump" class="%twig.extension.dump.class%" public="false">
             <tag name="twig.extension" />
+            <argument type="service" id="var_dumper.cloner" on-invalid="null" />
         </service>
     </services>
 </container>

src/Symfony/Component/HttpKernel/DataCollector/DumpDataCollector.php

@@ -169,7 +169,7 @@ public function getDumps($format, $maxDepthLimit = -1, $maxItemsPerDepth = -1)
             $dumper->dump(
                 $dump['data']->getLimitedClone($maxDepthLimit, $maxItemsPerDepth),
                 function ($line, $depth) use (&$data) {
-                    if (false !==$depth) {
+                    if (-1 !== $depth) {
                         $data .= str_repeat('  ', $depth).$line."\n";
                     }
                 }

src/Symfony/Component/HttpKernel/Tests/DataCollector/DumpDataCollectorTest.php

@@ -34,14 +34,17 @@ public function testDump()
 
         $xDump = array(
             array(
-              'data' => "<!DOCTYPE html><style> pre.sf-dump { background-color: #300a24; white-space: pre; line-height: 1.2em; color: #eee8d5; font-family: monospace, sans-serif; padding: 5px; } .sf-dump span { display: inline; }a.sf-dump-ref {color:#444444}span.sf-dump-num {font-weight:bold;color:#0087FF}span.sf-dump-const {font-weight:bold;color:#0087FF}span.sf-dump-str {font-weight:bold;color:#00D7FF}span.sf-dump-cchr {font-style: italic}span.sf-dump-note {color:#D7AF00}span.sf-dump-ref {color:#444444}span.sf-dump-public {color:#008700}span.sf-dump-protected {color:#D75F00}span.sf-dump-private {color:#D70000}span.sf-dump-meta {color:#005FFF}</style><pre class=sf-dump><span class=sf-dump-0><span class=sf-dump-num>123</span>\n</pre>\n",
+              'data' => "<pre id=sf-dump><span class=sf-dump-0><span class=sf-dump-num>123</span>\n</span></pre><script>Sfjs.dump.instrument()</script>\n",
               'name' => 'DumpDataCollectorTest.php',
               'file' => __FILE__,
               'line' => $line,
               'fileExcerpt' => false,
             ),
         );
-        $this->assertSame($xDump, $collector->getDumps('html'));
+        $dump = $collector->getDumps('html');
+        $this->assertTrue(isset($dump[0]['data']));
+        $dump[0]['data'] = preg_replace('/^.*?<pre/', '<pre', $dump[0]['data']);
+        $this->assertSame($xDump, $dump);
 
         $this->assertStringStartsWith(
             'a:1:{i:0;a:5:{s:4:"data";O:39:"Symfony\Component\VarDumper\Cloner\Data":3:{s:45:"Symfony\Component\VarDumper\Cloner\Datadata";a:1:{i:0;a:1:{i:0;i:123;}}s:49:"Symfony\Component\VarDumper\Cloner\DatamaxDepth";i:-1;s:57:"Symfony\Component\VarDumper\Cloner\DatamaxItemsPerDepth";i:-1;}s:4:"name";s:25:"DumpDataCollectorTest.php";s:4:"file";s:',

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

@@ -29,8 +29,9 @@ public static function castReflector(\Reflector $c, array $a, Stub $stub, $isNes
 
     public static function castClosure(\Closure $c, array $a, Stub $stub, $isNested)
     {
+        $stub->class = 'Closure'; // HHVM generates unique class names for closures
         $a = static::castReflector(new \ReflectionFunction($c), $a, $stub, $isNested);
-        unset($a["\0+\0000"], $a['name']);
+        unset($a["\0+\0000"], $a['name'], $a["\0+\0this"], $a["\0+\0parameter"]);
 
         return $a;
     }

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

@@ -28,7 +28,7 @@ public static function castCurl($h, array $a, Stub $stub, $isNested)
     public static function castDba($dba, array $a, Stub $stub, $isNested)
     {
         $list = dba_list();
-        $a['file'] = $list[substr((string) $dba, 13)];
+        $a['file'] = $list[(int) $dba];
 
         return $a;
     }