[VarDumper] Add support of named arguments to dd() and dump() to display a "section name"

alexandre-daubois · alexandre-daubois · commit f148793736c7 · 2022-12-01T18:43:40.000+01:00
diff --git a/src/Symfony/Component/VarDumper/CHANGELOG.md b/src/Symfony/Component/VarDumper/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Add support of named arguments to `dd()` and `dump()` to display a "section name"
+
 6.2
 ---
 
diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php
@@ -211,6 +211,11 @@ public function withContext(array $context): static
         return $data;
     }
 
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+
     /**
      * Seeks to a specific key in nested data structures.
      */
@@ -266,6 +271,11 @@ public function dump(DumperInterface $dumper)
         if ($cursor->attr = $this->context[SourceContextProvider::class] ?? []) {
             $cursor->attr['if_links'] = true;
             $cursor->hashType = -1;
+
+            if (null !== ($sectionName = $this->context['section_name'] ?? null)) {
+                $dumper->dumpScalar($cursor, 'default', $sectionName);
+            }
+
             $dumper->dumpScalar($cursor, 'default', '^');
             $cursor->attr = ['if_links' => true];
             $dumper->dumpScalar($cursor, 'default', ' ');
diff --git a/src/Symfony/Component/VarDumper/Dumper/ContextualizedDumper.php b/src/Symfony/Component/VarDumper/Dumper/ContextualizedDumper.php
@@ -33,7 +33,7 @@ public function __construct(DataDumperInterface $wrappedDumper, array $contextPr
 
     public function dump(Data $data)
     {
-        $context = [];
+        $context = $data->getContext();
         foreach ($this->contextProviders as $contextProvider) {
             $context[$contextProvider::class] = $contextProvider->getContext();
         }
diff --git a/src/Symfony/Component/VarDumper/Resources/functions/dump.php b/src/Symfony/Component/VarDumper/Resources/functions/dump.php
@@ -14,20 +14,19 @@
 if (!function_exists('dump')) {
     /**
      * @author Nicolas Grekas <p@tchwork.com>
+     * @author Alexandre Daubois <alex.daubois@gmail.com>
      */
-    function dump(mixed $var, mixed ...$moreVars): mixed
+    function dump(mixed ...$vars): mixed
     {
-        VarDumper::dump($var);
-
-        foreach ($moreVars as $v) {
-            VarDumper::dump($v);
+        foreach ($vars as $key => $v) {
+            VarDumper::dump($v, is_numeric($key) ? null : $key);
         }
 
-        if (1 < func_num_args()) {
-            return func_get_args();
+        if (1 < count($vars)) {
+            return $vars;
         }
 
-        return $var;
+        return reset($vars);
     }
 }
 
@@ -41,8 +40,8 @@ function dd(...$vars): void
             header('HTTP/1.1 500 Internal Server Error');
         }
 
-        foreach ($vars as $v) {
-            VarDumper::dump($v);
+        foreach ($vars as $key => $v) {
+            VarDumper::dump($v, is_numeric($key) ? null : $key);
         }
 
         exit(1);
diff --git a/src/Symfony/Component/VarDumper/Tests/Dumper/FunctionsTest.php b/src/Symfony/Component/VarDumper/Tests/Dumper/FunctionsTest.php
@@ -31,6 +31,19 @@ public function testDumpReturnsFirstArg()
         $this->assertEquals($var1, $return);
     }
 
+    public function testDumpReturnsFirstNamedArgWithoutSectionName()
+    {
+        $this->setupVarDumper();
+
+        $var1 = 'a';
+
+        ob_start();
+        $return = dump(first: $var1);
+        ob_end_clean();
+
+        $this->assertEquals($var1, $return);
+    }
+
     public function testDumpReturnsAllArgsInArray()
     {
         $this->setupVarDumper();
@@ -46,6 +59,21 @@ public function testDumpReturnsAllArgsInArray()
         $this->assertEquals([$var1, $var2, $var3], $return);
     }
 
+    public function testDumpReturnsAllNamedArgsInArray()
+    {
+        $this->setupVarDumper();
+
+        $var1 = 'a';
+        $var2 = 'b';
+        $var3 = 'c';
+
+        ob_start();
+        $return = dump($var1, second: $var2, third: $var3);
+        ob_end_clean();
+
+        $this->assertEquals([$var1, 'second' => $var2, 'third' => $var3], $return);
+    }
+
     protected function setupVarDumper()
     {
         $cloner = new VarCloner();
diff --git a/src/Symfony/Component/VarDumper/VarDumper.php b/src/Symfony/Component/VarDumper/VarDumper.php
@@ -37,13 +37,13 @@ class VarDumper
      */
     private static $handler;
 
-    public static function dump(mixed $var)
+    public static function dump(mixed $var, string $sectionName = null)
     {
         if (null === self::$handler) {
             self::register();
         }
 
-        return (self::$handler)($var);
+        return (self::$handler)($var, $sectionName);
     }
 
     public static function setHandler(callable $callable = null): ?callable
@@ -90,8 +90,13 @@ private static function register(): void
             $dumper = new ContextualizedDumper($dumper, [new SourceContextProvider()]);
         }
 
-        self::$handler = function ($var) use ($cloner, $dumper) {
-            $dumper->dump($cloner->cloneVar($var));
+        self::$handler = function ($var, string $sectionName = null) use ($cloner, $dumper) {
+            $dumper->dump(
+                $cloner->cloneVar($var)
+                    ->withContext([
+                        'section_name' => $sectionName,
+                    ])
+            );
         };
     }
 

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function __construct(DataDumperInterface $wrappedDumper, array $contextPr`
`33`	`33`
`34`	`34`	`public function dump(Data $data)`
`35`	`35`	`{`
`36`		`- $context = [];`
	`36`	`+ $context = $data->getContext();`
`37`	`37`	`foreach ($this->contextProviders as $contextProvider) {`
`38`	`38`	`$context[$contextProvider::class] = $contextProvider->getContext();`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,20 +14,19 @@`
`14`	`14`	`if (!function_exists('dump')) {`
`15`	`15`	`/**`
`16`	`16`	`* @author Nicolas Grekas <p@tchwork.com>`
	`17`	`+ * @author Alexandre Daubois <alex.daubois@gmail.com>`
`17`	`18`	`*/`
`18`		`- function dump(mixed $var, mixed ...$moreVars): mixed`
	`19`	`+ function dump(mixed ...$vars): mixed`
`19`	`20`	`{`
`20`		`- VarDumper::dump($var);`
`21`		`-`
`22`		`- foreach ($moreVars as $v) {`
`23`		`- VarDumper::dump($v);`
	`21`	`+ foreach ($vars as $key => $v) {`
	`22`	`+ VarDumper::dump($v, is_numeric($key) ? null : $key);`
`24`	`23`	`}`
`25`	`24`
`26`		`- if (1 < func_num_args()) {`
`27`		`- return func_get_args();`
	`25`	`+ if (1 < count($vars)) {`
	`26`	`+ return $vars;`
`28`	`27`	`}`
`29`	`28`
`30`		`- return $var;`
	`29`	`+ return reset($vars);`
`31`	`30`	`}`
`32`	`31`	`}`
`33`	`32`
`@@ -41,8 +40,8 @@ function dd(...$vars): void`
`41`	`40`	`header('HTTP/1.1 500 Internal Server Error');`
`42`	`41`	`}`
`43`	`42`
`44`		`- foreach ($vars as $v) {`
`45`		`- VarDumper::dump($v);`
	`43`	`+ foreach ($vars as $key => $v) {`
	`44`	`+ VarDumper::dump($v, is_numeric($key) ? null : $key);`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`exit(1);`
Original file line number	Diff line number	Diff line change
`@@ -37,13 +37,13 @@ class VarDumper`
`37`	`37`	`*/`
`38`	`38`	`private static $handler;`
`39`	`39`
`40`		`- public static function dump(mixed $var)`
	`40`	`+ public static function dump(mixed $var, string $sectionName = null)`
`41`	`41`	`{`
`42`	`42`	`if (null === self::$handler) {`
`43`	`43`	`self::register();`
`44`	`44`	`}`
`45`	`45`
`46`		`- return (self::$handler)($var);`
	`46`	`+ return (self::$handler)($var, $sectionName);`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`public static function setHandler(callable $callable = null): ?callable`
`@@ -90,8 +90,13 @@ private static function register(): void`
`90`	`90`	`$dumper = new ContextualizedDumper($dumper, [new SourceContextProvider()]);`
`91`	`91`	`}`
`92`	`92`
`93`		`- self::$handler = function ($var) use ($cloner, $dumper) {`
`94`		`- $dumper->dump($cloner->cloneVar($var));`
	`93`	`+ self::$handler = function ($var, string $sectionName = null) use ($cloner, $dumper) {`
	`94`	`+ $dumper->dump(`
	`95`	`+ $cloner->cloneVar($var)`
	`96`	`+ ->withContext([`
	`97`	`+ 'section_name' => $sectionName,`
	`98`	`+ ])`
	`99`	`+ );`
`95`	`100`	`};`
`96`	`101`	`}`
`97`	`102`