Rename toolbar config to profiling

Author: sagikazarmark

CHANGELOG.md

@@ -15,6 +15,7 @@
 ### Deprecated
 
 - `auto` value in `toolbar.enabled` config
+- `toolbar` config, use `profiling` instead
 
 
 ## 1.2.2 - 2016-07-19

DependencyInjection/Configuration.php

@@ -69,6 +69,26 @@ public function getConfigTreeBuilder()
                     return $v;
                 })
             ->end()
+            ->beforeNormalization() // @deprecated toolbar in 1.3.0, use profiling instead
+                ->ifTrue(function ($v) {
+                    return is_array($v) && array_key_exists('toolbar', $v) && is_array($v['toolbar']);
+                })
+                ->then(function ($v) {
+                    if (array_key_exists('enabled', $v['toolbar']) && 'auto' === $v['toolbar']['enabled']) {
+                        $v['toolbar']['enabled'] = $this->debug; // @deprecated value auto in 1.3.0
+                    }
+
+                    if (array_key_exists('profiling', $v) && is_array($v['profiling'])) {
+                        $v['profiling'] = array_merge($v['profiling'], $v['toolbar']);
+                    } else {
+                        $v['profiling'] = $v['toolbar'];
+                    }
+
+                    unset($v['toolbar']);
+
+                    return $v;
+                })
+            ->end()
             ->children()
                 ->arrayNode('main_alias')
                     ->addDefaultsIfNotSet()
@@ -90,17 +110,14 @@ public function getConfigTreeBuilder()
                         ->scalarNode('stream_factory')->defaultNull()->end()
                     ->end()
                 ->end()
-                ->arrayNode('toolbar')
+                ->arrayNode('profiling')
                     ->addDefaultsIfNotSet()
+                    ->treatFalseLike(['enabled' => false])
+                    ->treatTrueLike(['enabled' => true])
+                    ->treatNullLike(['enabled' => $this->debug])
                     ->info('Extend the debug profiler with information about requests.')
                     ->children()
-                        ->booleanNode('enabled') // @deprecated value auto in 1.3.0
-                            ->beforeNormalization()
-                                ->ifString()
-                                ->then(function ($v) {
-                                    return 'auto' === $v ? $this->debug : $v;
-                                })
-                            ->end()
+                        ->booleanNode('enabled')
                             ->info('Turn the toolbar on or off. Defaults to kernel debug mode.')
                             ->defaultValue($this->debug)
                         ->end()

DependencyInjection/HttplugExtension.php

@@ -53,20 +53,20 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         // Configure toolbar
-        if ($config['toolbar']['enabled']) {
+        if ($config['profiling']['enabled']) {
             $loader->load('data-collector.xml');
 
-            if (!empty($config['toolbar']['formatter'])) {
+            if (!empty($config['profiling']['formatter'])) {
                 // Add custom formatter
                 $container
                     ->getDefinition('httplug.collector.debug_collector')
-                    ->replaceArgument(0, new Reference($config['toolbar']['formatter']))
+                    ->replaceArgument(0, new Reference($config['profiling']['formatter']))
                 ;
             }
 
             $container
                 ->getDefinition('httplug.formatter.full_http_message')
-                ->addArgument($config['toolbar']['captured_body_length'])
+                ->addArgument($config['profiling']['captured_body_length'])
             ;
         }
 
@@ -91,7 +91,7 @@ private function configureClients(ContainerBuilder $container, array $config)
                 $first = $name;
             }
 
-            $this->configureClient($container, $name, $arguments, $config['toolbar']['enabled']);
+            $this->configureClient($container, $name, $arguments, $config['profiling']['enabled']);
         }
 
         // If we have clients configured
@@ -294,7 +294,7 @@ private function configureAutoDiscoveryClients(ContainerBuilder $container, arra
                     $container,
                     'auto_discovered_client',
                     [HttpClientDiscovery::class, 'find'],
-                    $config['toolbar']['enabled']
+                    $config['profiling']['enabled']
                 );
             }
 
@@ -309,7 +309,7 @@ private function configureAutoDiscoveryClients(ContainerBuilder $container, arra
                     $container,
                     'auto_discovered_async',
                     [HttpAsyncClientDiscovery::class, 'find'],
-                    $config['toolbar']['enabled']
+                    $config['profiling']['enabled']
                 );
             }
 

Tests/Resources/Fixtures/config/full.php

@@ -13,7 +13,7 @@
         'uri_factory'     => 'Http\Message\UriFactory\GuzzleUriFactory',
         'stream_factory'  => 'Http\Message\StreamFactory\GuzzleStreamFactory',
     ],
-    'toolbar' => [
+    'profiling' => [
         'enabled' => true,
         'formatter' => 'my_toolbar_formatter',
         'captured_body_length' => 0,

Tests/Resources/Fixtures/config/full.xml

@@ -14,7 +14,7 @@
             <uri-factory>Http\Message\UriFactory\GuzzleUriFactory</uri-factory>
             <stream-factory>Http\Message\StreamFactory\GuzzleStreamFactory</stream-factory>
         </classes>
-        <toolbar enabled="true" formatter="my_toolbar_formatter" captured_body_length="0"/>
+        <profiling enabled="true" formatter="my_toolbar_formatter" captured_body_length="0"/>
         <plugins>
             <authentication>
                 <my_basic type="basic" username="foo" password="bar"/>

Tests/Resources/Fixtures/config/full.yml

@@ -9,7 +9,7 @@ httplug:
         message_factory: Http\Message\MessageFactory\GuzzleMessageFactory
         uri_factory: Http\Message\UriFactory\GuzzleUriFactory
         stream_factory: Http\Message\StreamFactory\GuzzleStreamFactory
-    toolbar:
+    profiling:
         enabled: true
         formatter: my_toolbar_formatter
         captured_body_length: 0

Tests/Resources/Fixtures/config/toolbar.yml

@@ -0,0 +1,5 @@
+httplug:
+    toolbar:
+        enabled: true
+        formatter: null
+        captured_body_length: 0

Tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -39,7 +39,7 @@ public function testEmptyConfiguration()
                 'stream_factory' => null,
             ],
             'clients' => [],
-            'toolbar' => [
+            'profiling' => [
                 'enabled' => true,
                 'formatter' => null,
                 'captured_body_length' => 0,
@@ -95,6 +95,7 @@ public function testEmptyConfiguration()
             'config/empty.yml',
             'config/empty.xml',
             'config/empty.php',
+            'config/toolbar.yml',
             'config/toolbar_auto.yml',
         ]);
 
@@ -119,7 +120,7 @@ public function testSupportsAllConfigFormats()
                 'stream_factory' => 'Http\Message\StreamFactory\GuzzleStreamFactory',
             ],
             'clients' => [],
-            'toolbar' => [
+            'profiling' => [
                 'enabled' => true,
                 'formatter' => 'my_toolbar_formatter',
                 'captured_body_length' => 0,