From 609636e95ed970c052b77a8f178da46989da44ee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?G=C3=A1bor=20Egyed?= <egyed.gabor@4drops.hu>
Date: Sat, 16 Feb 2013 23:02:39 +0100
Subject: [PATCH] [Config] tweaked dumper to indent multi-line info

---
 .../Config/Definition/ReferenceDumper.php     |  4 +-
 .../Tests/Definition/ReferenceDumperTest.php  | 62 +++++++++++++++++
 .../Configuration/ExampleConfiguration.php    | 67 +++++++++++++++++++
 3 files changed, 132 insertions(+), 1 deletion(-)
 create mode 100644 src/Symfony/Component/Config/Tests/Definition/ReferenceDumperTest.php
 create mode 100644 src/Symfony/Component/Config/Tests/Fixtures/Configuration/ExampleConfiguration.php

diff --git a/src/Symfony/Component/Config/Definition/ReferenceDumper.php b/src/Symfony/Component/Config/Definition/ReferenceDumper.php
index 3230c01931..ef2b05d10f 100644
--- a/src/Symfony/Component/Config/Definition/ReferenceDumper.php
+++ b/src/Symfony/Component/Config/Definition/ReferenceDumper.php
@@ -115,10 +115,12 @@ class ReferenceDumper
         $default = (string) $default != '' ? ' '.$default : '';
         $comments = count($comments) ? '# '.implode(', ', $comments) : '';
 
-        $text = sprintf('%-20s %s %s', $node->getName().':', $default, $comments);
+        $text = rtrim(sprintf('%-20s %s %s', $node->getName() . ':', $default, $comments), ' ');
 
         if ($info = $node->getInfo()) {
             $this->writeLine('');
+            // indenting multi-line info
+            $info = str_replace("\n", sprintf("\n%" . $depth * 4 . "s# ", ' '), $info);
             $this->writeLine('# '.$info, $depth * 4);
         }
 
diff --git a/src/Symfony/Component/Config/Tests/Definition/ReferenceDumperTest.php b/src/Symfony/Component/Config/Tests/Definition/ReferenceDumperTest.php
new file mode 100644
index 0000000000..137caf8cbc
--- /dev/null
+++ b/src/Symfony/Component/Config/Tests/Definition/ReferenceDumperTest.php
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Tests\Definition;
+
+use Symfony\Component\Config\Definition\ReferenceDumper;
+use Symfony\Component\Config\Tests\Fixtures\Configuration\ExampleConfiguration;
+
+class ReferenceDumperTest extends \PHPUnit_Framework_TestCase
+{
+    public function testDumper()
+    {
+        $configuration = new ExampleConfiguration();
+
+        $dumper = new ReferenceDumper();
+        $this->assertEquals($this->getConfigurationAsString(), $dumper->dump($configuration));
+    }
+
+    private function getConfigurationAsString()
+    {
+      return <<<EOL
+root:
+    boolean:              true
+    scalar_empty:         ~
+    scalar_null:          ~
+    scalar_true:          true
+    scalar_false:         false
+    scalar_default:       default
+    scalar_array_empty:   []
+    scalar_array_defaults:
+
+        # Defaults:
+        - elem1
+        - elem2
+
+    # some info
+    array:
+        child1:               ~
+        child2:               ~
+
+        # this is a long
+        # multi-line info text
+        # which should be indented
+        child3:               ~ # Example: example setting
+    array_prototype:
+        parameters:
+
+            # Prototype
+            name:
+                value:                ~ # Required
+
+EOL;
+    }
+}
diff --git a/src/Symfony/Component/Config/Tests/Fixtures/Configuration/ExampleConfiguration.php b/src/Symfony/Component/Config/Tests/Fixtures/Configuration/ExampleConfiguration.php
new file mode 100644
index 0000000000..7511dc6244
--- /dev/null
+++ b/src/Symfony/Component/Config/Tests/Fixtures/Configuration/ExampleConfiguration.php
@@ -0,0 +1,67 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Tests\Fixtures\Configuration;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class ExampleConfiguration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $rootNode = $treeBuilder->root('root');
+
+        $rootNode
+            ->children()
+                ->booleanNode('boolean')->defaultTrue()->end()
+                ->scalarNode('scalar_empty')->end()
+                ->scalarNode('scalar_null')->defaultNull()->end()
+                ->scalarNode('scalar_true')->defaultTrue()->end()
+                ->scalarNode('scalar_false')->defaultFalse()->end()
+                ->scalarNode('scalar_default')->defaultValue('default')->end()
+                ->scalarNode('scalar_array_empty')->defaultValue(array())->end()
+                ->scalarNode('scalar_array_defaults')->defaultValue(array('elem1', 'elem2'))->end()
+                ->arrayNode('array')
+                    ->info('some info')
+                    ->canBeUnset()
+                    ->children()
+                        ->scalarNode('child1')->end()
+                        ->scalarNode('child2')->end()
+                        ->scalarNode('child3')
+                            ->info(
+                                "this is a long\n".
+                                "multi-line info text\n".
+                                "which should be indented"
+                            )
+                            ->example('example setting')
+                        ->end()
+                    ->end()
+                ->end()
+                ->arrayNode('array_prototype')
+                    ->children()
+                        ->arrayNode('parameters')
+                            ->useAttributeAsKey('name')
+                            ->prototype('array')
+                                ->children()
+                                    ->scalarNode('value')->isRequired()->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end()
+        ;
+
+        return $treeBuilder;
+    }
+}