[VarDumper] Added a way to print or not comma separator and/or trailing comma

lyrixx · lyrixx · commit 1ef07515c19b · 2017-02-20T11:13:52.000+01:00
Usecase: Be able to display a dump on one line. It's already used in the following projets: https://github.com/bobthecow/psysh/blob/master/src/Psy/VarDumper/Dumper.php#L93-L95
diff --git a/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php b/src/Symfony/Component/VarDumper/Dumper/AbstractDumper.php
@@ -23,6 +23,8 @@ abstract class AbstractDumper implements DataDumperInterface, DumperInterface
 {
     const DUMP_LIGHT_ARRAY = 1;
     const DUMP_STRING_LENGTH = 2;
+    const DUMP_COMMA_SEPARATOR = 4;
+    const DUMP_TRAILING_COMMA = 8;
 
     public static $defaultOutput = 'php://output';
 
diff --git a/src/Symfony/Component/VarDumper/Dumper/CliDumper.php b/src/Symfony/Component/VarDumper/Dumper/CliDumper.php
@@ -155,7 +155,7 @@ public function dumpScalar(Cursor $cursor, $type, $value)
 
         $this->line .= $this->style($style, $value, $attr);
 
-        $this->dumpLine($cursor->depth, true);
+        $this->endValue($cursor);
     }
 
     /**
@@ -171,7 +171,7 @@ public function dumpString(Cursor $cursor, $str, $bin, $cut)
         }
         if ('' === $str) {
             $this->line .= '""';
-            $this->dumpLine($cursor->depth, true);
+            $this->endValue($cursor);
         } else {
             $attr += array(
                 'length' => 0 <= $cut ? mb_strlen($str, 'UTF-8') + $cut : 0,
@@ -237,7 +237,11 @@ public function dumpString(Cursor $cursor, $str, $bin, $cut)
                     $lineCut = 0;
                 }
 
-                $this->dumpLine($cursor->depth, $i > $m);
+                if ($i > $m) {
+                    $this->endValue($cursor);
+                } else {
+                    $this->dumpLine($cursor->depth);
+                }
             }
         }
     }
@@ -280,7 +284,7 @@ public function leaveHash(Cursor $cursor, $type, $class, $hasChild, $cut)
     {
         $this->dumpEllipsis($cursor, $hasChild, $cut);
         $this->line .= Cursor::HASH_OBJECT === $type ? '}' : (Cursor::HASH_RESOURCE !== $type ? ']' : ($hasChild ? '}' : ''));
-        $this->dumpLine($cursor->depth, true);
+        $this->endValue($cursor);
     }
 
     /**
@@ -486,4 +490,15 @@ protected function dumpLine($depth, $endOfValue = false)
         }
         parent::dumpLine($depth);
     }
+
+    protected function endValue(Cursor $cursor)
+    {
+        if (self::DUMP_TRAILING_COMMA & $this->flags && 0 < $cursor->depth) {
+            $this->line .= ',';
+        } elseif (self::DUMP_COMMA_SEPARATOR & $this->flags && 1 < $cursor->hashLength - $cursor->hashIndex) {
+            $this->line .= ',';
+        }
+
+        $this->dumpLine($cursor->depth, true);
+    }
 }
diff --git a/src/Symfony/Component/VarDumper/Tests/CliDumperTest.php b/src/Symfony/Component/VarDumper/Tests/CliDumperTest.php
@@ -107,6 +107,67 @@ class: "Symfony\Component\VarDumper\Tests\CliDumperTest"
         );
     }
 
+    /**
+     * @dataProvider provideDumpWithCommaFlagTests
+     */
+    public function testDumpWithCommaFlag($expected, $flags)
+    {
+        $dumper = new CliDumper(null, null, $flags);
+        $dumper->setColors(false);
+        $cloner = new VarCloner();
+
+        $var = array(
+            'array' => array('a', 'b'),
+            'string' => 'hello',
+            'multiline string' => "this\nis\na\multiline\nstring",
+        );
+
+        $dump = $dumper->dump($cloner->cloneVar($var), true);
+
+        $this->assertSame($expected, $dump);
+    }
+
+    public function provideDumpWithCommaFlagTests()
+    {
+        $expected = <<<'EOTXT'
+array:3 [
+  "array" => array:2 [
+    0 => "a",
+    1 => "b"
+  ],
+  "string" => "hello",
+  "multiline string" => """
+    this\n
+    is\n
+    a\multiline\n
+    string
+    """
+]
+
+EOTXT;
+
+        yield array($expected, CliDumper::DUMP_COMMA_SEPARATOR);
+
+        $expected = <<<'EOTXT'
+array:3 [
+  "array" => array:2 [
+    0 => "a",
+    1 => "b",
+  ],
+  "string" => "hello",
+  "multiline string" => """
+    this\n
+    is\n
+    a\multiline\n
+    string
+    """,
+]
+
+EOTXT;
+
+        yield array($expected, CliDumper::DUMP_TRAILING_COMMA);
+    }
+
     /**
      * @requires extension xml
      */

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ abstract class AbstractDumper implements DataDumperInterface, DumperInterface`
`23`	`23`	`{`
`24`	`24`	`const DUMP_LIGHT_ARRAY = 1;`
`25`	`25`	`const DUMP_STRING_LENGTH = 2;`
	`26`	`+ const DUMP_COMMA_SEPARATOR = 4;`
	`27`	`+ const DUMP_TRAILING_COMMA = 8;`
`26`	`28`
`27`	`29`	`public static $defaultOutput = 'php://output';`
`28`	`30`
Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ public function dumpScalar(Cursor $cursor, $type, $value)`
`155`	`155`
`156`	`156`	`$this->line .= $this->style($style, $value, $attr);`
`157`	`157`
`158`		`- $this->dumpLine($cursor->depth, true);`
	`158`	`+ $this->endValue($cursor);`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`/**`
`@@ -171,7 +171,7 @@ public function dumpString(Cursor $cursor, $str, $bin, $cut)`
`171`	`171`	`}`
`172`	`172`	`if ('' === $str) {`
`173`	`173`	`$this->line .= '""';`
`174`		`- $this->dumpLine($cursor->depth, true);`
	`174`	`+ $this->endValue($cursor);`
`175`	`175`	`} else {`
`176`	`176`	`$attr += array(`
`177`	`177`	`'length' => 0 <= $cut ? mb_strlen($str, 'UTF-8') + $cut : 0,`
`@@ -237,7 +237,11 @@ public function dumpString(Cursor $cursor, $str, $bin, $cut)`
`237`	`237`	`$lineCut = 0;`
`238`	`238`	`}`
`239`	`239`
`240`		`- $this->dumpLine($cursor->depth, $i > $m);`
	`240`	`+ if ($i > $m) {`
	`241`	`+ $this->endValue($cursor);`
	`242`	`+ } else {`
	`243`	`+ $this->dumpLine($cursor->depth);`
	`244`	`+ }`
`241`	`245`	`}`
`242`	`246`	`}`
`243`	`247`	`}`
`@@ -280,7 +284,7 @@ public function leaveHash(Cursor $cursor, $type, $class, $hasChild, $cut)`
`280`	`284`	`{`
`281`	`285`	`$this->dumpEllipsis($cursor, $hasChild, $cut);`
`282`	`286`	`$this->line .= Cursor::HASH_OBJECT === $type ? '}' : (Cursor::HASH_RESOURCE !== $type ? ']' : ($hasChild ? '}' : ''));`
`283`		`- $this->dumpLine($cursor->depth, true);`
	`287`	`+ $this->endValue($cursor);`
`284`	`288`	`}`
`285`	`289`
`286`	`290`	`/**`
`@@ -486,4 +490,15 @@ protected function dumpLine($depth, $endOfValue = false)`
`486`	`490`	`}`
`487`	`491`	`parent::dumpLine($depth);`
`488`	`492`	`}`
	`493`	`+`
	`494`	`+ protected function endValue(Cursor $cursor)`
	`495`	`+ {`
	`496`	`+ if (self::DUMP_TRAILING_COMMA & $this->flags && 0 < $cursor->depth) {`
	`497`	`+ $this->line .= ',';`
	`498`	`+ } elseif (self::DUMP_COMMA_SEPARATOR & $this->flags && 1 < $cursor->hashLength - $cursor->hashIndex) {`
	`499`	`+ $this->line .= ',';`
	`500`	`+ }`
	`501`	`+`
	`502`	`+ $this->dumpLine($cursor->depth, true);`
	`503`	`+ }`
`489`	`504`	`}`