bug #28444 [VarDumper] fix dumping signature of callables (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 57c76a405b4e · 2018-09-16T21:17:45.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- [VarDumper] fix dumping signature of callables | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Adds missing visual hint when returning by reference + makes exclude-verbose mode display only the signature. E.g. using psysh, before: ![image](https://user-images.githubusercontent.com/243674/45360788-ebe0bf80-b5d0-11e8-8e43-62f954e926af.png) after: ![image](https://user-images.githubusercontent.com/243674/45360760-d9668600-b5d0-11e8-820a-98cc174ba2ca.png) (`dump -a` shows the details as usual.) Commits ------- 16f2bd5 [VarDumper] fix dumping signature of callables
diff --git a/src/Symfony/Component/VarDumper/Caster/ClassStub.php b/src/Symfony/Component/VarDumper/Caster/ClassStub.php
@@ -70,9 +70,6 @@ public function __construct(string $identifier, $callable = null)
                 } else {
                     $this->value .= $s;
                 }
-                if (isset($this->attr['ellipsis'])) {
-                    $this->attr['ellipsis'] += \strlen($this->value) - \strlen($identifier);
-                }
             }
         } catch (\ReflectionException $e) {
             return;
diff --git a/src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php b/src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php
@@ -33,13 +33,22 @@ class ReflectionCaster
 
     public static function castClosure(\Closure $c, array $a, Stub $stub, $isNested, $filter = 0)
     {
-        $prefix = Caster::PREFIX_VIRTUAL;
         $c = new \ReflectionFunction($c);
 
         $a = static::castFunctionAbstract($c, $a, $stub, $isNested, $filter);
 
         $stub->class .= self::getSignature($a);
 
+        $prefix = Caster::PREFIX_DYNAMIC;
+        unset($a['name'], $a[$prefix.'this'], $a[$prefix.'parameter'], $a[Caster::PREFIX_VIRTUAL.'extra']);
+        $prefix = Caster::PREFIX_VIRTUAL;
+
+        if ($filter & Caster::EXCLUDE_VERBOSE) {
+            $stub->cut += ($c->getFileName() ? 2 : 0) + \count($a);
+
+            return array();
+        }
+
         if (isset($a[$prefix.'parameters'])) {
             foreach ($a[$prefix.'parameters']->value as &$v) {
                 $param = $v;
@@ -53,14 +62,11 @@ public static function castClosure(\Closure $c, array $a, Stub $stub, $isNested,
             }
         }
 
-        if (!($filter & Caster::EXCLUDE_VERBOSE) && $f = $c->getFileName()) {
+        if ($f = $c->getFileName()) {
             $a[$prefix.'file'] = new LinkStub($f, $c->getStartLine());
             $a[$prefix.'line'] = $c->getStartLine().' to '.$c->getEndLine();
         }
 
-        $prefix = Caster::PREFIX_DYNAMIC;
-        unset($a['name'], $a[$prefix.'this'], $a[$prefix.'parameter'], $a[Caster::PREFIX_VIRTUAL.'extra']);
-
         return $a;
     }
 
@@ -333,7 +339,7 @@ public static function getSignature(array $a)
                 }
             }
         }
-        $signature = '('.substr($signature, 2).')';
+        $signature = (empty($a[$prefix.'returnsReference']) ? '' : '&').'('.substr($signature, 2).')';
 
         if (isset($a[$prefix.'returnType'])) {
             $signature .= ': '.substr(strrchr('\\'.$a[$prefix.'returnType'], '\\'), 1);
diff --git a/src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php b/src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php
@@ -87,16 +87,9 @@ public function testClosureCaster()
 
     public function testClosureCasterExcludingVerbosity()
     {
-        $var = function () {};
+        $var = function &($a = 5) {};
 
-        $expectedDump = <<<EOTXT
-Closure() {
-  class: "Symfony\Component\VarDumper\Tests\Caster\ReflectionCasterTest"
-  this: Symfony\Component\VarDumper\Tests\Caster\ReflectionCasterTest { …}
-}
-EOTXT;
-
-        $this->assertDumpEquals($expectedDump, $var, Caster::EXCLUDE_VERBOSE);
+        $this->assertDumpEquals('Closure&($a = 5) { …6}', $var, Caster::EXCLUDE_VERBOSE);
     }
 
     public function testReflectionParameter()

Original file line number	Diff line number	Diff line change
`@@ -70,9 +70,6 @@ public function __construct(string $identifier, $callable = null)`
`70`	`70`	`} else {`
`71`	`71`	`$this->value .= $s;`
`72`	`72`	`}`
`73`		`- if (isset($this->attr['ellipsis'])) {`
`74`		`- $this->attr['ellipsis'] += \strlen($this->value) - \strlen($identifier);`
`75`		`- }`
`76`	`73`	`}`
`77`	`74`	`} catch (\ReflectionException $e) {`
`78`	`75`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -33,13 +33,22 @@ class ReflectionCaster`
`33`	`33`
`34`	`34`	`public static function castClosure(\Closure $c, array $a, Stub $stub, $isNested, $filter = 0)`
`35`	`35`	`{`
`36`		`- $prefix = Caster::PREFIX_VIRTUAL;`
`37`	`36`	`$c = new \ReflectionFunction($c);`
`38`	`37`
`39`	`38`	`$a = static::castFunctionAbstract($c, $a, $stub, $isNested, $filter);`
`40`	`39`
`41`	`40`	`$stub->class .= self::getSignature($a);`
`42`	`41`
	`42`	`+ $prefix = Caster::PREFIX_DYNAMIC;`
	`43`	`+ unset($a['name'], $a[$prefix.'this'], $a[$prefix.'parameter'], $a[Caster::PREFIX_VIRTUAL.'extra']);`
	`44`	`+ $prefix = Caster::PREFIX_VIRTUAL;`
	`45`	`+`
	`46`	`+ if ($filter & Caster::EXCLUDE_VERBOSE) {`
	`47`	`+ $stub->cut += ($c->getFileName() ? 2 : 0) + \count($a);`
	`48`	`+`
	`49`	`+ return array();`
	`50`	`+ }`
	`51`	`+`
`43`	`52`	`if (isset($a[$prefix.'parameters'])) {`
`44`	`53`	`foreach ($a[$prefix.'parameters']->value as &$v) {`
`45`	`54`	`$param = $v;`
`@@ -53,14 +62,11 @@ public static function castClosure(\Closure $c, array $a, Stub $stub, $isNested,`
`53`	`62`	`}`
`54`	`63`	`}`
`55`	`64`
`56`		`- if (!($filter & Caster::EXCLUDE_VERBOSE) && $f = $c->getFileName()) {`
	`65`	`+ if ($f = $c->getFileName()) {`
`57`	`66`	`$a[$prefix.'file'] = new LinkStub($f, $c->getStartLine());`
`58`	`67`	`$a[$prefix.'line'] = $c->getStartLine().' to '.$c->getEndLine();`
`59`	`68`	`}`
`60`	`69`
`61`		`- $prefix = Caster::PREFIX_DYNAMIC;`
`62`		`- unset($a['name'], $a[$prefix.'this'], $a[$prefix.'parameter'], $a[Caster::PREFIX_VIRTUAL.'extra']);`
`63`		`-`
`64`	`70`	`return $a;`
`65`	`71`	`}`
`66`	`72`
`@@ -333,7 +339,7 @@ public static function getSignature(array $a)`
`333`	`339`	`}`
`334`	`340`	`}`
`335`	`341`	`}`
`336`		`- $signature = '('.substr($signature, 2).')';`
	`342`	`+ $signature = (empty($a[$prefix.'returnsReference']) ? '' : '&').'('.substr($signature, 2).')';`
`337`	`343`
`338`	`344`	`if (isset($a[$prefix.'returnType'])) {`
`339`	`345`	`$signature .= ': '.substr(strrchr('\\'.$a[$prefix.'returnType'], '\\'), 1);`