github-9: remove symfony bundle enable config option since rollbar ha…

…s its own enabled option
OxCom · Apr 17, 2018 · 28947e4 · 28947e4
1 parent 3530545
commit 28947e4
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 63 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -17,17 +17,11 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder      = new TreeBuilder();
-        $rootNode         = $treeBuilder->root(RollbarExtension::ALIAS);
+        $treeBuilder = new TreeBuilder();
+        $rollbarConfigNode = $treeBuilder->root(RollbarExtension::ALIAS);
 
         // the intendation in this method reflects the structure of the rootNode
         // for convenience
-
-        $rootNode->children()
-            ->scalarNode('enable')->defaultTrue()->end();
-
-            $rollbarConfigNode = $rootNode->children()
-                ->arrayNode('config');
 
         foreach (\Rollbar\Config::listOptions() as $option) {
             // TODO: this is duplicated code from
@@ -53,13 +47,14 @@ public function getConfigTreeBuilder()
                 \Rollbar\Defaults::get()->$method() :
                 null;
 
-            $rollbarConfigNode->children()
-            ->scalarNode($option)->defaultValue($default)->end();
+            $rollbarConfigNode
+                ->children()
+                ->scalarNode($option)
+                ->defaultValue($default)
+                ->end();
         }
-
-            $rollbarConfigNode->end();
 
-        $rootNode->end();
+        $rollbarConfigNode->end();
 
         return $treeBuilder;
     }

diff --git a/DependencyInjection/RollbarExtension.php b/DependencyInjection/RollbarExtension.php
@@ -33,10 +33,6 @@ public function load(array $configs, ContainerBuilder $container)
         $configuration = new Configuration();
         $config        = $this->processConfiguration($configuration, $configs);
 
-        if (empty($config['enable'])) {
-            return;
-        }
-
         // load services and register listeners
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.yml');

diff --git a/EventListener/ErrorListener.php b/EventListener/ErrorListener.php
@@ -96,9 +96,9 @@ protected function isReportable($code)
         $config = $this->getContainer()->getParameter(RollbarExtension::ALIAS . '.config');
 
         return true
-            && $config['enable']
-            && !(error_reporting() === 0 && $config['config']['report_suppressed'])
-            && !(($config['config']['use_error_reporting'] && (error_reporting() & $code) === 0))
-            && !($config['config']['included_errno'] != -1 && ($code & $config['config']['included_errno']) != $code);
+            && $config['enabled']
+            && !(error_reporting() === 0 && $config['report_suppressed'])
+            && !(($config['use_error_reporting'] && (error_reporting() & $code) === 0))
+            && !($config['included_errno'] != -1 && ($code & $config['included_errno']) != $code);
     }
 }
diff --git a/Factories/RollbarHandlerFactory.php b/Factories/RollbarHandlerFactory.php
@@ -19,37 +19,37 @@ public function __construct(ContainerInterface $container)
         $this->config = $container->getParameter(RollbarExtension::ALIAS . '.config');
 
         if (isset($_ENV['ROLLBAR_TEST_TOKEN']) && $_ENV['ROLLBAR_TEST_TOKEN']) {
-            $this->config['config']['access_token'] = $_ENV['ROLLBAR_TEST_TOKEN'];
+            $this->config['access_token'] = $_ENV['ROLLBAR_TEST_TOKEN'];
         }
 
-        if (empty($this->config['config']['person'])) {
+        if (empty($this->config['person'])) {
             try {
                 if ($token = $container->get('security.token_storage')->getToken()) {
-                    $this->config['config']['person'] = $token->getUser();
+                    $this->config['person'] = $token->getUser();
                 }
             } catch (\Exception $exception) {
             }
         }
 
-        if (!empty($this->config['config']['person_fn']) &&
-            is_callable($this->config['config']['person_fn']) ) {
-            $this->config['config']['person'] = null;
+        if (!empty($this->config['person_fn']) &&
+            is_callable($this->config['person_fn']) ) {
+            $this->config['person'] = null;
         }
 
-        if (!empty($this->config['enable'])) {
-            Rollbar::init($this->config['config'], false, false, false);
-        }
+        // if (!empty($this->config['enable'])) {
+            Rollbar::init($this->config, false, false, false);
+        // }
     }
 
     public function createRollbarHandler()
     {
-        if (!empty($this->config['enable'])) {
+        // if (!empty($this->config['enable'])) {
             return new RollbarMonologHandler(
                 Rollbar::logger(),
                 Logger::ERROR
             );
-        }
+        // }
 
-        return null;
+        // return null;
     }
 }
diff --git a/README.md b/README.md
@@ -46,10 +46,8 @@ This bundle depends on [symfony/monolog-bundle](https://github.com/symfony/monol
 ```yaml
 
 rollbar:
-  enable: true
-  config:
-    access_token: YourAccessToken
-    environment: YourEnvironmentName
+  access_token: YourAccessToken
+  environment: YourEnvironmentName
 
 monolog:
   handlers:
@@ -107,11 +105,9 @@ All of them can be configured by nesting them in `rollbar.config` array, i.e.:
 ```yaml
 
 rollbar:
-  enable: true
-  config:
-    access_token: YourAccessToken
-    environment: YourEnvironmentName
-    scrub_fields: [password, password_confirmation, credit_card_number]
+  access_token: YourAccessToken
+  environment: YourEnvironmentName
+  scrub_fields: [password, password_confirmation, credit_card_number]
 
 ```
 
@@ -128,11 +124,9 @@ You can provide your own logic for retrieving user data with the `person_fn` con
 ```yaml
 
 rollbar:
-    enable: true
-    config:
-        access_token: YourAccessToken
-        environment: YourEnvironmentName
-        person_fn: '\Example\UserData::personFn'
+  access_token: YourAccessToken
+  environment: YourEnvironmentName
+  person_fn: '\Example\UserData::personFn'
         
 ```
 

diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -46,14 +46,8 @@ public function testParameters()
 
             $defaults[$option] = $default;
         }
-
-
-        $default = [
-            'enable' => true,
-            'config' => $defaults
-        ];
 
         $this->assertNotEmpty($config);
-        $this->assertEquals($default, $config);
+        $this->assertEquals($defaults, $config);
     }
 }
diff --git a/Tests/DependencyInjection/RollbarExtensionTest.php b/Tests/DependencyInjection/RollbarExtensionTest.php
@@ -30,19 +30,23 @@ protected function getContainerExtensions()
      * @dataProvider generatorConfigVars
      *
      * @param string $var
-     * @param mixed  $value
+     * @param mixed  $values
      */
-    public function testConfigEnabledVars($var, $value)
+    public function testConfigEnabledVars($var, $expected)
     {
         $this->load();
 
-        $this->assertContainerBuilderHasParameter($var, $value);
+        $param = $this->container->getParameter($var);
+
+        foreach ($expected as $key => $value) {
+            $this->assertEquals($param[$key], $value);
+        }
     }
 
     public function generatorConfigVars()
     {
         return [
-            ['rollbar.config', ['enable' => true]],
+            ['rollbar.config', ['enabled' => true]],
         ];
     }
 
@@ -54,11 +58,15 @@ public function generatorConfigVars()
      * @param string $var
      * @param mixed  $value
      */
-    public function testConfigDisabledVars($var, $value)
+    public function testConfigDisabledVars($var, $expected)
     {
-        $this->load(['enable' => false]);
+        $this->load(['enabled' => false]);
 
-        $this->assertContainerBuilderHasParameter($var, $value);
+        $param = $this->container->getParameter($var);
+
+        foreach ($expected as $key => $value) {
+            $this->assertEquals($param[$key], $value);
+        }
     }
 
     public function testAlias()

diff --git a/Tests/Fixtures/app/config/config_test.yml b/Tests/Fixtures/app/config/config_test.yml
@@ -3,8 +3,6 @@ imports:
     - { resource: parameters.yml }
 
 rollbar:
-  enable: true
-  config:
     access_token: ~
 
 monolog: