8000 feature #48432 [VarDumper] Add support of named arguments to `dd()` a… · symfony/symfony@d8d93c6 · GitHub
[go: up one dir, main page]
Skip to content

Commit d8d93c6

Browse files
nicolas-grekasnicolas-grekas
committed
feature #48432 [VarDumper] Add support of named arguments to dd() and dump() to display a label (alexandre-daubois)
This PR was merged into the 6.3 branch. Discussion ---------- [VarDumper] Add support of named arguments to `dd()` and `dump()` to display a label | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | _N/A_ | License | MIT | Doc PR | _Todo_ Following an idea from `@nicolas`-grekas, the goal here is to ease debugging with `dd()` and `dump()` by supporting named arguments passed to them. This will display a label, helping understand the goal/meaning of a dump. **Example in web browser:** ![image](https://user-images.githubusercontent.com/2144837/205279233-7c250d07-4616-4ed8-907e-b1b3cac9a3f2.png) **Example in CLI:** ![image](https://user-images.githubusercontent.com/2144837/205122796-79427c98-48fe-4f11-b2c5-58b51a2fbbf6.png) The above example is clickable and points to `file:///home/alexandredaubois/PhpstormProjects/dummy_project/src/Command/TestCommand.php#L15`. No more `dd("First one", $var1, "Second var", $var2);`! Commits ------- 2519c5c [VarDumper] Add support of named arguments to `dd()` and `dump()` to display the argument name
2 parents ad3424c + 2519c5c commit d8d93c6

File tree

11 files changed

+144
-18
lines changed

11 files changed

+144
-18
lines changed

‎src/Symfony/Component/VarDumper/CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ CHANGELOG
55
---
66

77
* Add caster for `WeakMap`
8+
* Add support of named arguments to `dd()` and `dump()` to display the argument name
89

910
6.2
1011
---

‎src/Symfony/Component/VarDumper/Caster/ScalarStub.php‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\VarDumper\Caster;
13+
14+
use Symfony\Component\VarDumper\Cloner\Stub;
15+
16+
/**
17+
* Represents any arbitrary value.
18+
*
19+
* @author Alexandre Daubois <alex.daubois@gmail.com>
20+
*/
21+
class ScalarStub extends Stub
22+
{
23+
public function __construct(mixed $value)
24+
{
25+
$this->value = $value;
26+
}
27+
}

‎src/Symfony/Component/VarDumper/Caster/StubCaster.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,12 @@ public static function castEnum(EnumStub $c, array $a, Stub $stub, bool $isNeste
8181

8282
return $a;
8383
}
84+
85+
public static function castScalar(ScalarStub $scalarStub, array $a, Stub $stub)
86+
{
87+
$stub->type = Stub::TYPE_SCALAR;
88+
$stub->attr['value'] = $scalarStub->value;
89+
90+
return $a;
91+
}
8492
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ abstract class AbstractCloner implements ClonerInterface
2828
'Symfony\Component\VarDumper\Caster\CutArrayStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castCutArray'],
2929
'Symfony\Component\VarDumper\Caster\ConstStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
3030
'Symfony\Component\VarDumper\Caster\EnumStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castEnum'],
31+
'Symfony\Component\VarDumper\Caster\ScalarStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castScalar'],
3132

3233
'Fiber' => ['Symfony\Component\VarDumper\Caster\FiberCaster', 'castFiber'],
3334

‎src/Symfony/Component/VarDumper/Cloner/Data.php‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,11 @@ public function withContext(array $context): static
211211
return $data;
212212
}
213213

214+
public function getContext(): array
215+
{
216+
return $this->context;
217+
}
218+
214219
/**
215220
* Seeks to a specific key in nested data structures.
216221
*/
@@ -262,11 +267,12 @@ public function dump(DumperInterface $dumper)
262267
{
263268
$refs = [0];
264269
$cursor = new Cursor();
270+
$label = $this->context['label'] ?? '';
265271

266272
if ($cursor->attr = $this->context[SourceContextProvider::class] ?? []) {
267273
$cursor->attr['if_links'] = true;
268274
$cursor->hashType = -1;
269-
$dumper->dumpScalar($cursor, 'default', '^');
275+
$dumper->dumpScalar($cursor, 'default', $label.'^');
270276
$cursor->attr = ['if_links' => true];
271277
$dumper->dumpScalar($cursor, 'default', ' ');
272278
$cursor->hashType = 0;
@@ -362,6 +368,10 @@ private function dumpItem(DumperInterface $dumper, Cursor $cursor, array &$refs,
362368
$dumper->leaveHash($cursor, $item->type, $item->class, $withChildren, $cut);
363369
break;
364370

371+
case Stub::TYPE_SCALAR:
372+
$dumper->dumpScalar($cursor, 'default', $item->attr['value']);
373+
break;
374+
365375
default:
366376
throw new \RuntimeException(sprintf('Unexpected Stub type: "%s".', $item->type));
367377
}

‎src/Symfony/Component/VarDumper/Cloner/Stub.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ class Stub
2323
public const TYPE_ARRAY = 3;
2424
public const TYPE_OBJECT = 4;
2525
public const TYPE_RESOURCE = 5;
26+
public const TYPE_SCALAR = 6;
2627

2728
public const STRING_BINARY = 1;
2829
public const STRING_UTF8 = 2;

‎src/Symfony/Component/VarDumper/Dumper/ContextualizedDumper.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function __construct(DataDumperInterface $wrappedDumper, array $contextPr
3333

3434
public function dump(Data $data)
3535
{
36-
$context = [];
36+
$context = $data->getContext();
3737
foreach ($this->contextProviders as $contextProvider) {
3838
$context[$contextProvider::class] = $contextProvider->getContext();
3939
}

‎src/Symfony/Component/VarDumper/Resources/functions/dump.php‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,36 @@
99
* file that was distributed with this source code.
1010
*/
1111

12+
use Symfony\Component\VarDumper\Caster\ScalarStub;
1213
use Symfony\Component\VarDumper\VarDumper;
1314

1415
if (!function_exists('dump')) {
1516
/**
1617
* @author Nicolas Grekas <p@tchwork.com>
18+
* @author Alexandre Daubois <alex.daubois@gmail.com>
1719
*/
18-
function dump(mixed $var, mixed ...$moreVars): mixed
20+
function dump(mixed ...$vars): mixed
1921
{
20-
VarDumper::dump($var);
22+
if (!$vars) {
23+
VarDumper::dump(new ScalarStub('🐛'));
2124

22-
foreach ($moreVars as $v) {
23-
VarDumper::dump($v);
25+
return null;
2426
}
2527

26-
if (1 < func_num_args()) {
27-
return func_get_args();
28+
if (isset($vars[0]) && 1 === count($vars)) {
29+
VarDumper::dump($vars[0]);
30+
$k = 0;
31+
} else {
32+
foreach ($vars as $k => $v) {
33+
VarDumper::dump($v, is_int($k) ? 1 + $k : $k);
34+
}
2835
}
2936

30-
return $var;
37+
if (1 < count($vars)) {
38+
return $vars;
39+
}
40+
41+
return $vars[$k];
3142
}
3243
}
3344

@@ -38,8 +49,12 @@ function dd(mixed ...$vars): never
3849
header('HTTP/1.1 500 Internal Server Error');
3950
}
4051

41-
foreach ($vars as $v) {
42-
VarDumper::dump($v);
52+
if (isset($vars[0]) && 1 === count($vars)) {
53+
VarDumper::dump($vars[0]);
54+
} else {
55+
foreach ($vars as $k => $v) {
56+
VarDumper::dump($v, is_int($k) ? 1 + $k : $k);
57+
}
4358
}
4459

4560
exit(1);

‎src/Symfony/Component/VarDumper/Tests/Caster/StubCasterTest.php‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use Symfony\Component\VarDumper\Caster\ArgsStub;
1616
use Symfony\Component\VarDumper\Caster\ClassStub;
1717
use Symfony\Component\VarDumper\Caster\LinkStub;
18+
use Symfony\Component\VarDumper\Caster\ScalarStub;
1819
use Symfony\Component\VarDumper\Cloner\VarCloner;
1920
use Symfony\Component\VarDumper\Dumper\HtmlDumper;
2021
use Symfony\Component\VarDumper\Test\VarDumperTestTrait;
@@ -87,6 +88,19 @@ public function testArgsStubWithClosure()
8788
$this->assertDumpMatchesFormat($expectedDump, $args);
8889
}
8990

91+
public function testEmptyStub()
92+
{
93+
$args = [new ScalarStub('🐛')];
94+
95+
$expectedDump = <<<'EODUMP'
96+
array:1 [
97+
0 => 🐛
98+
]
99+
EODUMP;
100+
101+
$this->assertDumpMatchesFormat($expectedDump, $args);
102+
}
103+
90104
public function testLinkStub()
91105
{
92106
$var = [new LinkStub(__CLASS__, 0, __FILE__)];
@@ -203,7 +217,7 @@ public function testClassStubWithAnonymousClass()
203217

204218
$expectedDump = <<<'EODUMP'
205219
<foo></foo><bar><span class=sf-dump-note>array:1</span> [<samp data-depth=1 class=sf-dump-expanded>
206-
<span class=sf-dump-index>0</span> => "<a href="%sStubCasterTest.php:195" rel="noopener noreferrer"><span class=sf-dump-str title="19 characters">Exception@anonymous</span></a>"
220+
<span class=sf-dump-index>0</span> => "<a href="%sStubCasterTest.php:209" rel="noopener noreferrer"><span class=sf-dump-str title="19 characters">Exception@anonymous</span></a>"
207221
</samp>]
208222
</bar>
209223
EODUMP;

‎src/Symfony/Component/VarDumper/Tests/Dumper/FunctionsTest.php‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@
1818

1919
class FunctionsTest extends TestCase
2020
{
21+
public function testDumpWithoutArg()
22+
{
23+
$this->setupVarDumper();
24+
25+
ob_start();
26+
$return = dump();
27+
ob_end_clean();
28+
29+
$this->assertNull($return);
30+
}
31+
2132
public function testDumpReturnsFirstArg()
2233
{
2334
$this->setupVarDumper();
@@ -28,7 +39,20 @@ public function testDumpReturnsFirstArg()
2839
$return = dump($var1);
2940
ob_end_clean();
3041

31-
$this->assertEquals($var1, $return);
42+
$this->assertSame($var1, $return);
43+
}
44+
45+
public function testDumpReturnsFirstNamedArgWithoutSectionName()
46+
{
47+
$this->setupVarDumper();
48+
49+
$var1 = 'a';
50+
51+
ob_start();
52+
$return = dump(first: $var1);
53+
ob_end_clean();
54+
55+
$this->assertSame($var1, $return);
3256
}
3357

3458
public function testDumpReturnsAllArgsInArray()
@@ -43,7 +67,22 @@ public function testDumpReturnsAllArgsInArray()
4367
$return = dump($var1, $var2, $var3);
4468
ob_end_clean();
4569

46-
$this->assertEquals([$var1, $var2, $var3], $return);
70+
$this->assertSame([$var1, $var2, $var3], $return);
71+
}
72+
73+
public function testDumpReturnsAllNamedArgsInArray()
74+
{
75+
$this->setupVarDumper();
76+
77+
$var1 = 'a';
78+
$var2 = 'b';
79+
$var3 = 'c';
80+
81+
ob_start();
82+
$return = dump($var1, second: $var2, third: $var3);
83+
ob_end_clean();
84+
85+
$t 495B his->assertSame([$var1, 'second' => $var2, 'third' => $var3], $return);
4786
}
4887

4988
protected function setupVarDumper()

0 commit comments

Comments
 (0)
0