#353 rename audit to enable_logger

skafandri · skafandri · commit b6f370ba9f57 · 2016-04-29T15:08:21.000+03:00
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -88,7 +88,7 @@ protected function addProducers(ArrayNodeDefinition $node)
                             ->scalarNode('connection')->defaultValue('default')->end()
                             ->scalarNode('auto_setup_fabric')->defaultTrue()->end()
                             ->scalarNode('class')->defaultValue('%old_sound_rabbit_mq.producer.class%')->end()
-                            ->scalarNode('audit')->defaultFalse()->end()
+                            ->scalarNode('enable_logger')->defaultFalse()->end()
                         ->end()
                     ->end()
                 ->end()
@@ -144,7 +144,7 @@ protected function addConsumers(ArrayNodeDefinition $node)
                                     ->booleanNode('global')->defaultFalse()->end()
                                 ->end()
                             ->end()
-                            ->scalarNode('audit')->defaultFalse()->end()
+                            ->scalarNode('enable_logger')->defaultFalse()->end()
                         ->end()
                     ->end()
                 ->end()
@@ -176,7 +176,7 @@ protected function addMultipleConsumers(ArrayNodeDefinition $node)
                             ->end()
                         ->end()
                         ->scalarNode('queues_provider')->defaultNull()->end()
-                        ->scalarNode('audit')->defaultFalse()->end()
+                        ->scalarNode('enable_logger')->defaultFalse()->end()
                     ->end()
                 ->end()
             ->end()
@@ -207,7 +207,7 @@ protected function addDynamicConsumers(ArrayNodeDefinition $node)
                                 ->end()
                             ->end()
                             ->scalarNode('queue_options_provider')->isRequired()->end()
-                            ->scalarNode('audit')->defaultFalse()->end()
+                            ->scalarNode('enable_logger')->defaultFalse()->end()
                         ->end()
                     ->end()
                 ->end()
@@ -279,7 +279,7 @@ protected function addRpcServers(ArrayNodeDefinition $node)
                                 ->end()
                             ->end()
                             ->scalarNode('serializer')->defaultValue('serialize')->end()
-                            ->scalarNode('audit')->defaultFalse()->end()
+                            ->scalarNode('enable_logger')->defaultFalse()->end()
                         ->end()
                     ->end()
                 ->end()
diff --git a/DependencyInjection/OldSoundRabbitMqExtension.php b/DependencyInjection/OldSoundRabbitMqExtension.php
@@ -150,7 +150,7 @@ protected function loadProducers()
                     $definition->addMethodCall('disableAutoSetupFabric');
                 }
 
-                if ($producer['audit']) {
+                if ($producer['enable_logger']) {
                     $this->injectLogger($definition);
                 }
 
@@ -183,7 +183,7 @@ protected function loadConsumers()
                 ));
             }
 
-            if(isset($consumer['idle_timeout'])) {
+            if (isset($consumer['idle_timeout'])) {
                 $definition->addMethodCall('setIdleTimeout', array($consumer['idle_timeout']));
             }
             if (!$consumer['auto_setup_fabric']) {
@@ -195,7 +195,7 @@ protected function loadConsumers()
                 $this->injectLoggedChannel($definition, $key, $consumer['connection']);
             }
 
-            if ($consumer['audit']) {
+            if ($consumer['enable_logger']) {
                 $this->injectLogger($definition);
             }
 
@@ -219,7 +219,7 @@ protected function loadMultipleConsumers()
             }
 
             foreach ($consumer['queues'] as $queueName => $queueOptions) {
-                $queues[$queueOptions['name']]  = $queueOptions;
+                $queues[$queueOptions['name']] = $queueOptions;
                 $queues[$queueOptions['name']]['callback'] = array(new Reference($queueOptions['callback']), 'execute');
                 $callbacks[] = new Reference($queueOptions['callback']);
             }
@@ -246,7 +246,7 @@ protected function loadMultipleConsumers()
                 ));
             }
 
-            if(isset($consumer['idle_timeout'])) {
+            if (isset($consumer['idle_timeout'])) {
                 $definition->addMethodCall('setIdleTimeout', array($consumer['idle_timeout']));
             }
             if (!$consumer['auto_setup_fabric']) {
@@ -258,7 +258,7 @@ protected function loadMultipleConsumers()
                 $this->injectLoggedChannel($definition, $key, $consumer['connection']);
             }
 
-            if ($consumer['audit']) {
+            if ($consumer['enable_logger']) {
                 $this->injectLogger($definition);
             }
 
@@ -272,18 +272,18 @@ protected function loadMultipleConsumers()
             }
         }
     }
-    
+
     protected function loadDynamicConsumers()
-    {   
+    {
         foreach ($this->config['dynamic_consumers'] as $key => $consumer) {
-            
+
             if (empty($consumer['queue_options_provider'])) {
                 throw new InvalidConfigurationException(
                     "Error on loading $key dynamic consumer. " .
                     "'queue_provider' parameter should be defined."
                 );
             }
-            
+
             $definition = new Definition('%old_sound_rabbit_mq.dynamic_consumer.class%');
             $definition
                 ->addTag('old_sound_rabbit_mq.base_amqp')
@@ -299,13 +299,13 @@ protected function loadDynamicConsumers()
                     $consumer['qos_options']['global']
                 ));
             }
-            
+
             $definition->addMethodCall(
-                    'setQueueOptionsProvider',
-                    array(new Reference($consumer['queue_options_provider']))
-                );
-            
-            if(isset($consumer['idle_timeout'])) {
+                'setQueueOptionsProvider',
+                array(new Reference($consumer['queue_options_provider']))
+            );
+
+            if (isset($consumer['idle_timeout'])) {
                 $definition->addMethodCall('setIdleTimeout', array($consumer['idle_timeout']));
             }
             if (!$consumer['auto_setup_fabric']) {
@@ -317,7 +317,7 @@ protected function loadDynamicConsumers()
                 $this->injectLoggedChannel($definition, $key, $consumer['connection']);
             }
 
-            if ($consumer['audit']) {
+            if ($consumer['enable_logger']) {
                 $this->injectLogger($definition);
             }
 
@@ -456,7 +456,7 @@ protected function loadRpcServers()
 
     protected function injectLoggedChannel(Definition $definition, $name, $connectionName)
     {
-        $id      = sprintf('old_sound_rabbit_mq.channel.%s', $name);
+        $id = sprintf('old_sound_rabbit_mq.channel.%s', $name);
         $channel = new Definition('%old_sound_rabbit_mq.logged.channel.class%');
         $channel
             ->setPublic(false)
@@ -487,12 +487,12 @@ public function getAlias()
      */
     protected function addDequeuerAwareCall($callback, $name)
     {
-        if (! $this->container->has($callback)) {
+        if (!$this->container->has($callback)) {
             return;
         }
 
         $callbackDefinition = $this->container->findDefinition($callback);
-        $refClass           = new \ReflectionClass($callbackDefinition->getClass());
+        $refClass = new \ReflectionClass($callbackDefinition->getClass());
         if ($refClass->implementsInterface('OldSound\RabbitMqBundle\RabbitMq\DequeuerAwareInterface')) {
             $callbackDefinition->addMethodCall('setDequeuer', array(new Reference($name)));
         }
@@ -503,5 +503,8 @@ private function injectLogger(Definition $definition)
         $definition->addTag('monolog.logger', array(
             'channel' => 'phpamqplib'
         ));
+        if ($this->container->has('logger')) {
+            $definition->addMethodCall('setLogger', array(new Reference('logger')));
+        }
     }
 }
diff --git a/README.md b/README.md
@@ -364,7 +364,7 @@ And that's it!
 ### Audit / Logging ###
 
 This was a requirement to have a traceability of messages received/published.
-In order to enable this you'll need to add "audit" config to consumers or publishers.
+In order to enable this you'll need to add "enable_logger" config to consumers or publishers.
 
 ```yaml
 consumers:
@@ -373,7 +373,7 @@ consumers:
         exchange_options: {name: 'upload-picture', type: direct}
         queue_options:    {name: 'upload-picture'}
         callback:         upload_picture_service
-        audit: true
+        enable_logger: true
 ```
 
 If you would like you can also treat logging from queues with different handlers in monolog, by referencing channel "phpamqplib"
diff --git a/Tests/DependencyInjection/Fixtures/config_with_enable_logger.yml b/Tests/DependencyInjection/Fixtures/config_with_enable_logger.yml
@@ -19,4 +19,7 @@ old_sound_rabbit_mq:
             queue_options:
                 name:       default_queue
             callback:       default.callback
-            audit:      true
+            enable_logger:      true
+services:
+    logger:
+        class: \stdClass
diff --git a/Tests/DependencyInjection/OldSoundRabbitMqExtensionTest.php b/Tests/DependencyInjection/OldSoundRabbitMqExtensionTest.php
@@ -807,10 +807,10 @@ public function testProducerWithoutExplicitExchangeOptionsConnectsToAMQPDefault(
 
     public function testProducersWithLogger()
     {
-        $container = $this->getContainer('config_with_audit.yml');
+        $container = $this->getContainer('config_with_enable_logger.yml');
+        $definition = $container->getDefinition('old_sound_rabbit_mq.default_consumer_consumer');
         $this->assertTrue(
-            $container->getDefinition('old_sound_rabbit_mq.default_consumer_consumer')->hasTag('monolog.logger'),
-            'service should be marked for logger'
+            $definition->hasTag('monolog.logger'), 'service should be marked for logger'
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ protected function loadProducers()`
`150`	`150`	`$definition->addMethodCall('disableAutoSetupFabric');`
`151`	`151`	`}`
`152`	`152`
`153`		`- if ($producer['audit']) {`
	`153`	`+ if ($producer['enable_logger']) {`
`154`	`154`	`$this->injectLogger($definition);`
`155`	`155`	`}`
`156`	`156`
`@@ -183,7 +183,7 @@ protected function loadConsumers()`
`183`	`183`	`));`
`184`	`184`	`}`
`185`	`185`
`186`		`- if(isset($consumer['idle_timeout'])) {`
	`186`	`+ if (isset($consumer['idle_timeout'])) {`
`187`	`187`	`$definition->addMethodCall('setIdleTimeout', array($consumer['idle_timeout']));`
`188`	`188`	`}`
`189`	`189`	`if (!$consumer['auto_setup_fabric']) {`
`@@ -195,7 +195,7 @@ protected function loadConsumers()`
`195`	`195`	`$this->injectLoggedChannel($definition, $key, $consumer['connection']);`
`196`	`196`	`}`
`197`	`197`
`198`		`- if ($consumer['audit']) {`
	`198`	`+ if ($consumer['enable_logger']) {`
`199`	`199`	`$this->injectLogger($definition);`
`200`	`200`	`}`
`201`	`201`
`@@ -219,7 +219,7 @@ protected function loadMultipleConsumers()`
`219`	`219`	`}`
`220`	`220`
`221`	`221`	`foreach ($consumer['queues'] as $queueName => $queueOptions) {`
`222`		`- $queues[$queueOptions['name']] = $queueOptions;`
	`222`	`+ $queues[$queueOptions['name']] = $queueOptions;`
`223`	`223`	`$queues[$queueOptions['name']]['callback'] = array(new Reference($queueOptions['callback']), 'execute');`
`224`	`224`	`$callbacks[] = new Reference($queueOptions['callback']);`
`225`	`225`	`}`
`@@ -246,7 +246,7 @@ protected function loadMultipleConsumers()`
`246`	`246`	`));`
`247`	`247`	`}`
`248`	`248`
`249`		`- if(isset($consumer['idle_timeout'])) {`
	`249`	`+ if (isset($consumer['idle_timeout'])) {`
`250`	`250`	`$definition->addMethodCall('setIdleTimeout', array($consumer['idle_timeout']));`
`251`	`251`	`}`
`252`	`252`	`if (!$consumer['auto_setup_fabric']) {`
`@@ -258,7 +258,7 @@ protected function loadMultipleConsumers()`
`258`	`258`	`$this->injectLoggedChannel($definition, $key, $consumer['connection']);`
`259`	`259`	`}`
`260`	`260`
`261`		`- if ($consumer['audit']) {`
	`261`	`+ if ($consumer['enable_logger']) {`
`262`	`262`	`$this->injectLogger($definition);`
`263`	`263`	`}`
`264`	`264`
`@@ -272,18 +272,18 @@ protected function loadMultipleConsumers()`
`272`	`272`	`}`
`273`	`273`	`}`
`274`	`274`	`}`
`275`		`-`
	`275`	`+`
`276`	`276`	`protected function loadDynamicConsumers()`
`277`		`- {`
	`277`	`+ {`
`278`	`278`	`foreach ($this->config['dynamic_consumers'] as $key => $consumer) {`
`279`		`-`
	`279`	`+`
`280`	`280`	`if (empty($consumer['queue_options_provider'])) {`
`281`	`281`	`throw new InvalidConfigurationException(`
`282`	`282`	`"Error on loading $key dynamic consumer. " .`
`283`	`283`	`"'queue_provider' parameter should be defined."`
`284`	`284`	`);`
`285`	`285`	`}`
`286`		`-`
	`286`	`+`
`287`	`287`	`$definition = new Definition('%old_sound_rabbit_mq.dynamic_consumer.class%');`
`288`	`288`	`$definition`
`289`	`289`	`->addTag('old_sound_rabbit_mq.base_amqp')`
`@@ -299,13 +299,13 @@ protected function loadDynamicConsumers()`
`299`	`299`	`$consumer['qos_options']['global']`
`300`	`300`	`));`
`301`	`301`	`}`
`302`		`-`
	`302`	`+`
`303`	`303`	`$definition->addMethodCall(`
`304`		`- 'setQueueOptionsProvider',`
`305`		`- array(new Reference($consumer['queue_options_provider']))`
`306`		`- );`
`307`		`-`
`308`		`- if(isset($consumer['idle_timeout'])) {`
	`304`	`+ 'setQueueOptionsProvider',`
	`305`	`+ array(new Reference($consumer['queue_options_provider']))`
	`306`	`+ );`
	`307`	`+`
	`308`	`+ if (isset($consumer['idle_timeout'])) {`
`309`	`309`	`$definition->addMethodCall('setIdleTimeout', array($consumer['idle_timeout']));`
`310`	`310`	`}`
`311`	`311`	`if (!$consumer['auto_setup_fabric']) {`
`@@ -317,7 +317,7 @@ protected function loadDynamicConsumers()`
`317`	`317`	`$this->injectLoggedChannel($definition, $key, $consumer['connection']);`
`318`	`318`	`}`
`319`	`319`
`320`		`- if ($consumer['audit']) {`
	`320`	`+ if ($consumer['enable_logger']) {`
`321`	`321`	`$this->injectLogger($definition);`
`322`	`322`	`}`
`323`	`323`
`@@ -456,7 +456,7 @@ protected function loadRpcServers()`
`456`	`456`
`457`	`457`	`protected function injectLoggedChannel(Definition $definition, $name, $connectionName)`
`458`	`458`	`{`
`459`		`- $id = sprintf('old_sound_rabbit_mq.channel.%s', $name);`
	`459`	`+ $id = sprintf('old_sound_rabbit_mq.channel.%s', $name);`
`460`	`460`	`$channel = new Definition('%old_sound_rabbit_mq.logged.channel.class%');`
`461`	`461`	`$channel`
`462`	`462`	`->setPublic(false)`
`@@ -487,12 +487,12 @@ public function getAlias()`
`487`	`487`	`*/`
`488`	`488`	`protected function addDequeuerAwareCall($callback, $name)`
`489`	`489`	`{`
`490`		`- if (! $this->container->has($callback)) {`
	`490`	`+ if (!$this->container->has($callback)) {`
`491`	`491`	`return;`
`492`	`492`	`}`
`493`	`493`
`494`	`494`	`$callbackDefinition = $this->container->findDefinition($callback);`
`495`		`- $refClass = new \ReflectionClass($callbackDefinition->getClass());`
	`495`	`+ $refClass = new \ReflectionClass($callbackDefinition->getClass());`
`496`	`496`	`if ($refClass->implementsInterface('OldSound\RabbitMqBundle\RabbitMq\DequeuerAwareInterface')) {`
`497`	`497`	`$callbackDefinition->addMethodCall('setDequeuer', array(new Reference($name)));`
`498`	`498`	`}`
`@@ -503,5 +503,8 @@ private function injectLogger(Definition $definition)`
`503`	`503`	`$definition->addTag('monolog.logger', array(`
`504`	`504`	`'channel' => 'phpamqplib'`
`505`	`505`	`));`
	`506`	`+ if ($this->container->has('logger')) {`
	`507`	`+ $definition->addMethodCall('setLogger', array(new Reference('logger')));`
	`508`	`+ }`
`506`	`509`	`}`
`507`	`510`	`}`
Original file line number	Diff line number	Diff line change
`@@ -807,10 +807,10 @@ public function testProducerWithoutExplicitExchangeOptionsConnectsToAMQPDefault(`
`807`	`807`
`808`	`808`	`public function testProducersWithLogger()`
`809`	`809`	`{`
`810`		`- $container = $this->getContainer('config_with_audit.yml');`
	`810`	`+ $container = $this->getContainer('config_with_enable_logger.yml');`
	`811`	`+ $definition = $container->getDefinition('old_sound_rabbit_mq.default_consumer_consumer');`
`811`	`812`	`$this->assertTrue(`
`812`		`- $container->getDefinition('old_sound_rabbit_mq.default_consumer_consumer')->hasTag('monolog.logger'),`
`813`		`- 'service should be marked for logger'`
	`813`	`+ $definition->hasTag('monolog.logger'), 'service should be marked for logger'`
`814`	`814`	`);`
`815`	`815`	`}`
`816`	`816`