feature #12355 [VarDumper] Use symfony.com's colorscheme (nicolas-grekas, WouterJ)

fabpot · fabpot · commit 0e4953c6db77 · 2014-11-02T01:18:24.000+01:00
This PR was merged into the 2.6-dev branch. Discussion ---------- [VarDumper] Use symfony.com's colorscheme As promised, this PR changed the current colorscheme to something used in Symfony. This means developers have a consistent experience and the colorscheme is easier to read. While doings this, I also improved the `HtmlDumper#style()` method to make it easier to understand and maintain. I also changed a bit of the output it created, mostly adding visibility prefixes to properties. **Before** ![sf-dump-before](https://cloud.githubusercontent.com/assets/749025/4828241/b070d32e-5f7e-11e4-9d51-865ffd47753e.png) **After** ![sf-dump-after](https://cloud.githubusercontent.com/assets/749025/4828244/b4ec3e52-5f7e-11e4-9031-71f41bc30c25.png) | Q | A | ------------- | --- | Bug fix? | yes | New feature? | yes | BC breaks? | - | Deprecations? | - | Tests pass? | - | Fixed tickets | #12348 | License | MIT | Doc PR | the one about the VarDumper Commits ------- 07a1e70 Changed meta color a316420 [VarDumper] use symfony.com colorscheme 7ffba44 [VarDumper] UML prefixes for properties
diff --git a/Dumper/CliDumper.php b/Dumper/CliDumper.php
@@ -39,6 +39,8 @@ class CliDumper extends AbstractDumper
         'protected' => '38;5;166',
         'private'   => '38;5;160',
         'meta'      => '38;5;27',
+        'key'       => '38;5;27',
+        'index'     => '38;5;27',
     );
 
     protected static $controlCharsRx = '/[\x00-\x1F\x7F]/';
@@ -258,14 +260,16 @@ protected function dumpKey(Cursor $cursor)
         if (null !== $key = $cursor->hashKey) {
             $attr = array('binary' => $cursor->hashKeyIsBinary);
             $bin = $cursor->hashKeyIsBinary ? 'b' : '';
+            $style = 'key';
             switch ($cursor->hashType) {
                 default:
                 case Cursor::HASH_INDEXED:
+                    $style = 'index';
                 case Cursor::HASH_ASSOC:
                     if (is_int($key)) {
-                        $this->line .= $this->style('meta', $key).' => ';
+                        $this->line .= $this->style($style, $key).' => ';
                     } else {
-                        $this->line .= $bin.'"'.$this->style('meta', $key).'" => ';
+                        $this->line .= $bin.'"'.$this->style($style, $key).'" => ';
                     }
                     break;
 
@@ -274,28 +278,33 @@ protected function dumpKey(Cursor $cursor)
                     // No break;
                 case Cursor::HASH_OBJECT:
                     if (!isset($key[0]) || "\0" !== $key[0]) {
-                        $this->line .= $bin.$this->style('public', $key).': ';
+                        $this->line .= '+'.$bin.$this->style('public', $key).': ';
                     } elseif (0 < strpos($key, "\0", 1)) {
                         $key = explode("\0", substr($key, 1), 2);
 
                         switch ($key[0]) {
                             case '+': // User inserted keys
                                 $attr['dynamic'] = true;
-                                $this->line .= $bin.'"'.$this->style('public', $key[1], $attr).'": ';
+                                $this->line .= '+'.$bin.'"'.$this->style('public', $key[1], $attr).'": ';
                                 break 2;
-
-                            case '~': $style = 'meta';      break;
-                            case '*': $style = 'protected'; break;
+                            case '~':
+                                $style = 'meta';
+                                break;
+                            case '*':
+                                $style = 'protected';
+                                $bin = '#'.$bin;
+                                break;
                             default:
                                 $attr['class'] = $key[0];
                                 $style = 'private';
+                                $bin = '-'.$bin;
                                 break;
                         }
 
                         $this->line .= $bin.$this->style($style, $key[1], $attr).': ';
                     } else {
                         // This case should not happen
-                        $this->line .= $bin.'"'.$this->style('private', $key, array('class' => '')).'": ';
+                        $this->line .= '-'.$bin.'"'.$this->style('private', $key, array('class' => '')).'": ';
                     }
                     break;
             }
diff --git a/Dumper/HtmlDumper.php b/Dumper/HtmlDumper.php
@@ -31,17 +31,19 @@ class HtmlDumper extends CliDumper
     protected $headerIsDumped = false;
     protected $lastDepth = -1;
     protected $styles = array(
-        'num'       => 'font-weight:bold;color:#0087FF',
-        'const'     => 'font-weight:bold;color:#0087FF',
-        'str'       => 'font-weight:bold;color:#00D7FF',
+        'num'       => 'font-weight:bold;color:#1299DA',
+        'const'     => 'font-weight:bold',
+        'str'       => 'font-weight:bold;color:#56DB3A',
         'cchr'      => 'font-style: italic',
-        'note'      => 'color:#D7AF00',
-        'ref'       => 'color:#585858',
-        'solo-ref'  => 'color:#585858',
-        'public'    => 'color:#008700',
-        'protected' => 'color:#D75F00',
-        'private'   => 'color:#D70000',
-        'meta'      => 'color:#005FFF',
+        'note'      => 'color:#1299DA',
+        'ref'       => 'color:#A0A0A0',
+        'solo-ref'  => 'color:#A0A0A0',
+        'public'    => 'color:#FFFFFF',
+        'protected' => 'color:#FFFFFF',
+        'private'   => 'color:#FFFFFF',
+        'meta'      => 'color:#B729D9',
+        'key'       => 'color:#56DB3A',
+        'index'     => 'color:#1299DA',
     );
 
     /**
@@ -150,7 +152,7 @@ function a(e, f) {
     });
     a('mouseover', function (a) {
         if (a = idRx.exec(a.className)) {
-            refStyle.innerHTML = 'pre.sf-dump .'+a[0]+'{background-color: yellow; border-radius: 2px}';
+            refStyle.innerHTML = 'pre.sf-dump .'+a[0]+'{background-color: #B729D9; color: #FFF !important; border-radius: 2px}';
         }
     });
     a('click', function (a, e) {
@@ -245,13 +247,12 @@ function a(e, f) {
 <style>
 pre.sf-dump {
     display: block;
-    background-color: #300a24;
+    background-color: #18171B;
     white-space: pre;
     line-height: 1.2em;
-    color: #eee8d5;
-    font: 12px monospace, sans-serif;
+    color: #FF8400;
+    font: 12px Menlo, Monaco, Consolas, monospace;
     padding: 5px;
-    border-radius: 5px;
 }
 pre.sf-dump span {
     display: inline;
@@ -337,8 +338,8 @@ protected function style($style, $value, $attr = array())
 
         if ('const' === $style && array_key_exists('value', $attr)) {
             $style .= sprintf(' title="%s"', htmlspecialchars(json_encode($attr['value']), ENT_QUOTES, 'UTF-8'));
-        } elseif ('public' === $style && !empty($attr['dynamic'])) {
-            $style .= ' title="Runtime added dynamic property"';
+        } elseif ('public' === $style) {
+            $style .= sprintf(' title="%s"', empty($attr['dynamic']) ? 'Public property' : 'Runtime added dynamic property');
         } elseif ('str' === $style && 1 < $attr['length']) {
             $style .= sprintf(' title="%s%s characters"', $attr['length'], $attr['binary'] ? ' binary or non-UTF-8' : '');
         } elseif ('note' === $style) {
@@ -347,8 +348,10 @@ protected function style($style, $value, $attr = array())
             } elseif (':' === $v[0]) {
                 return sprintf('<abbr title="`%s` resource" class=sf-dump-%s>%s</abbr>', substr($v, 1), $style, $v);
             }
+        } elseif ('protected' === $style) {
+            $style .= ' title="Protected property"';
         } elseif ('private' === $style) {
-            $style .= sprintf(' title="%s::%s"', $attr['class'], $v);
+            $style .= sprintf(' title="Private property defined in class:&#10;`%s`"', $attr['class']);
         }
 
         return "<span class=sf-dump-$style>$v</span>";
diff --git a/Tests/CliDumperTest.php b/Tests/CliDumperTest.php
@@ -72,8 +72,8 @@ public function testGet()
   }
   8 => :Unknown {@{$res2}}
   "obj" => Symfony\Component\VarDumper\Tests\Fixture\DumbFoo {#%d
-    foo: "foo"
-    "bar": "bar"
+    +foo: "foo"
+    +"bar": "bar"
   }
   "closure" => Closure {#%d
     reflection: """
diff --git a/Tests/HtmlDumperTest.php b/Tests/HtmlDumperTest.php
@@ -52,19 +52,19 @@ public function testGet()
         $this->assertStringMatchesFormat(
             <<<EOTXT
 <foo></foo><bar><span class=sf-dump-note>array:25</span> [<samp>
-  "<span class=sf-dump-meta>number</span>" => <span class=sf-dump-num>1</span>
-  <span class=sf-dump-meta>0</span> => <a class=sf-dump-ref href=#{$dumpId}-ref01 title="2 occurrences">&amp;1</a> <span class=sf-dump-const>null</span>
-  "<span class=sf-dump-meta>const</span>" => <span class=sf-dump-num>1.1</span>
-  <span class=sf-dump-meta>1</span> => <span class=sf-dump-const>true</span>
-  <span class=sf-dump-meta>2</span> => <span class=sf-dump-const>false</span>
-  <span class=sf-dump-meta>3</span> => <span class=sf-dump-num>NAN</span>
-  <span class=sf-dump-meta>4</span> => <span class=sf-dump-num>INF</span>
-  <span class=sf-dump-meta>5</span> => <span class=sf-dump-num>-INF</span>
-  <span class=sf-dump-meta>6</span> => <span class=sf-dump-num>{$intMax}</span>
-  "<span class=sf-dump-meta>str</span>" => "<span class=sf-dump-str title="4 characters">d&#233;j&#224;</span>"
-  <span class=sf-dump-meta>7</span> => b"<span class=sf-dump-str title="2 binary or non-UTF-8 characters">&#233;<span class=sf-dump-cchr title=\\x00>@</span></span>"
-  "<span class=sf-dump-meta>[]</span>" => []
-  "<span class=sf-dump-meta>res</span>" => <abbr title="`stream` resource" class=sf-dump-note>:stream</abbr> {<a class=sf-dump-solo-ref>@{$res1}</a><samp>
+  "<span class=sf-dump-key>number</span>" => <span class=sf-dump-num>1</span>
+  <span class=sf-dump-key>0</span> => <a class=sf-dump-ref href=#{$dumpId}-ref01 title="2 occurrences">&amp;1</a> <span class=sf-dump-const>null</span>
+  "<span class=sf-dump-key>const</span>" => <span class=sf-dump-num>1.1</span>
+  <span class=sf-dump-key>1</span> => <span class=sf-dump-const>true</span>
+  <span class=sf-dump-key>2</span> => <span class=sf-dump-const>false</span>
+  <span class=sf-dump-key>3</span> => <span class=sf-dump-num>NAN</span>
+  <span class=sf-dump-key>4</span> => <span class=sf-dump-num>INF</span>
+  <span class=sf-dump-key>5</span> => <span class=sf-dump-num>-INF</span>
+  <span class=sf-dump-key>6</span> => <span class=sf-dump-num>{$intMax}</span>
+  "<span class=sf-dump-key>str</span>" => "<span class=sf-dump-str title="4 characters">d&#233;j&#224;</span>"
+  <span class=sf-dump-key>7</span> => b"<span class=sf-dump-str title="2 binary or non-UTF-8 characters">&#233;<span class=sf-dump-cchr title=\\x00>@</span></span>"
+  "<span class=sf-dump-key>[]</span>" => []
+  "<span class=sf-dump-key>res</span>" => <abbr title="`stream` resource" class=sf-dump-note>:stream</abbr> {<a class=sf-dump-solo-ref>@{$res1}</a><samp>
     <span class=sf-dump-meta>wrapper_type</span>: "<span class=sf-dump-str title="9 characters">plainfile</span>"
     <span class=sf-dump-meta>stream_type</span>: "<span class=sf-dump-str title="5 characters">STDIO</span>"
     <span class=sf-dump-meta>mode</span>: "<span class=sf-dump-str>r</span>"
@@ -75,12 +75,12 @@ public function testGet()
     <span class=sf-dump-meta>eof</span>: <span class=sf-dump-const>false</span>
     <span class=sf-dump-meta>options</span>: []
   </samp>}
-  <span class=sf-dump-meta>8</span> => <abbr title="`Unknown` resource" class=sf-dump-note>:Unknown</abbr> {<a class=sf-dump-solo-ref>@{$res2}</a>}
-  "<span class=sf-dump-meta>obj</span>" => <abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="2 occurrences">#%d</a><samp id={$dumpId}-ref2%d>
-    <span class=sf-dump-public>foo</span>: "<span class=sf-dump-str title="3 characters">foo</span>"
-    "<span class=sf-dump-public title="Runtime added dynamic property">bar</span>": "<span class=sf-dump-str title="3 characters">bar</span>"
+  <span class=sf-dump-key>8</span> => <abbr title="`Unknown` resource" class=sf-dump-note>:Unknown</abbr> {<a class=sf-dump-solo-ref>@{$res2}</a>}
+  "<span class=sf-dump-key>obj</span>" => <abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="2 occurrences">#%d</a><samp id={$dumpId}-ref2%d>
+    +<span class=sf-dump-public title="Public property">foo</span>: "<span class=sf-dump-str title="3 characters">foo</span>"
+    +"<span class=sf-dump-public title="Runtime added dynamic property">bar</span>": "<span class=sf-dump-str title="3 characters">bar</span>"
   </samp>}
-  "<span class=sf-dump-meta>closure</span>" => <span class=sf-dump-note>Closure</span> {<a class=sf-dump-solo-ref>#%d</a><samp>
+  "<span class=sf-dump-key>closure</span>" => <span class=sf-dump-note>Closure</span> {<a class=sf-dump-solo-ref>#%d</a><samp>
     <span class=sf-dump-meta>reflection</span>: """
       <span class=sf-dump-str title="%d characters">Closure [ &lt;user&gt; {$closureLabel} Symfony\Component\VarDumper\Tests\Fixture\{closure} ] {</span>
       <span class=sf-dump-str title="%d characters">  @@ {$var['file']} {$var['line']} - {$var['line']}</span>
@@ -92,19 +92,19 @@ public function testGet()
       <span class=sf-dump-str title="%d characters">}</span>
       """
   </samp>}
-  "<span class=sf-dump-meta>line</span>" => <span class=sf-dump-num>{$var['line']}</span>
-  "<span class=sf-dump-meta>nobj</span>" => <span class=sf-dump-note>array:1</span> [<samp>
-    <span class=sf-dump-meta>0</span> => <a class=sf-dump-ref href=#{$dumpId}-ref03 title="2 occurrences">&amp;3</a> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="3 occurrences">#%d</a>}
+  "<span class=sf-dump-key>line</span>" => <span class=sf-dump-num>{$var['line']}</span>
+  "<span class=sf-dump-key>nobj</span>" => <span class=sf-dump-note>array:1</span> [<samp>
+    <span class=sf-dump-index>0</span> => <a class=sf-dump-ref href=#{$dumpId}-ref03 title="2 occurrences">&amp;3</a> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="3 occurrences">#%d</a>}
   </samp>]
-  "<span class=sf-dump-meta>recurs</span>" => <a class=sf-dump-ref href=#{$dumpId}-ref04 title="2 occurrences">&amp;4</a> <span class=sf-dump-note>array:1</span> [<samp id={$dumpId}-ref04>
-    <span class=sf-dump-meta>0</span> => <a class=sf-dump-ref href=#{$dumpId}-ref04 title="2 occurrences">&amp;4</a> <span class=sf-dump-note>array:1</span> [<a class=sf-dump-ref href=#{$dumpId}-ref04 title="2 occurrences">&amp;4</a>]
+  "<span class=sf-dump-key>recurs</span>" => <a class=sf-dump-ref href=#{$dumpId}-ref04 title="2 occurrences">&amp;4</a> <span class=sf-dump-note>array:1</span> [<samp id={$dumpId}-ref04>
+    <span class=sf-dump-index>0</span> => <a class=sf-dump-ref href=#{$dumpId}-ref04 title="2 occurrences">&amp;4</a> <span class=sf-dump-note>array:1</span> [<a class=sf-dump-ref href=#{$dumpId}-ref04 title="2 occurrences">&amp;4</a>]
   </samp>]
-  <span class=sf-dump-meta>9</span> => <a class=sf-dump-ref href=#{$dumpId}-ref01 title="2 occurrences">&amp;1</a> <span class=sf-dump-const>null</span>
-  "<span class=sf-dump-meta>sobj</span>" => <abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="2 occurrences">#%d</a>}
-  "<span class=sf-dump-meta>snobj</span>" => <a class=sf-dump-ref href=#{$dumpId}-ref03 title="2 occurrences">&amp;3</a> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="3 occurrences">#%d</a>}
-  "<span class=sf-dump-meta>snobj2</span>" => {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="3 occurrences">#%d</a>}
-  "<span class=sf-dump-meta>file</span>" => "<span class=sf-dump-str title="%d characters">{$var['file']}</span>"
-  b"<span class=sf-dump-meta>bin-key-&#233;</span>" => ""
+  <span class=sf-dump-key>9</span> => <a class=sf-dump-ref href=#{$dumpId}-ref01 title="2 occurrences">&amp;1</a> <span class=sf-dump-const>null</span>
+  "<span class=sf-dump-key>sobj</span>" => <abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="2 occurrences">#%d</a>}
+  "<span class=sf-dump-key>snobj</span>" => <a class=sf-dump-ref href=#{$dumpId}-ref03 title="2 occurrences">&amp;3</a> {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="3 occurrences">#%d</a>}
+  "<span class=sf-dump-key>snobj2</span>" => {<a class=sf-dump-ref href=#{$dumpId}-ref2%d title="3 occurrences">#%d</a>}
+  "<span class=sf-dump-key>file</span>" => "<span class=sf-dump-str title="%d characters">{$var['file']}</span>"
+  b"<span class=sf-dump-key>bin-key-&#233;</span>" => ""
 </samp>]
 </bar>
 

Original file line number	Diff line number	Diff line change
`@@ -72,8 +72,8 @@ public function testGet()`
`72`	`72`	`}`
`73`	`73`	`8 => :Unknown {@{$res2}}`
`74`	`74`	`"obj" => Symfony\Component\VarDumper\Tests\Fixture\DumbFoo {#%d`
`75`		`- foo: "foo"`
`76`		`- "bar": "bar"`
	`75`	`+ +foo: "foo"`
	`76`	`+ +"bar": "bar"`
`77`	`77`	`}`
`78`	`78`	`"closure" => Closure {#%d`
`79`	`79`	`reflection: """`