Merge pull request #40 from defrag/feature/fake-listener-priotity

Fake ip priority configurable

Author: willdurand

DependencyInjection/BazingaGeocoderExtension.php

@@ -36,11 +36,13 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
 
-        if (isset($config['fake_ip'])) {
-            $container
-                ->getDefinition('bazinga_geocoder.event_listener.fake_request')
-                ->replaceArgument(0, $config['fake_ip'])
-                ;
+        if (isset($config['fake_ip']) && !empty($config['fake_ip'])) {
+            $definition = $container->getDefinition('bazinga_geocoder.event_listener.fake_request');
+            $definition->replaceArgument(0, $config['fake_ip']['ip']);
+
+            $tag = current($definition->getTag('kernel.event_listener'));
+            $tag['priority'] = $config['fake_ip']['priority'];
+            $definition->setTags(array($tag));            
         }
 
         if (isset($config['adapter']['class']) && !empty($config['adapter']['class'])) {

DependencyInjection/Configuration.php

@@ -30,7 +30,16 @@ public function getConfigTreeBuilder()
 
         $rootNode
             ->children()
-            ->scalarNode('fake_ip')->defaultNull()->end()
+            ->arrayNode('fake_ip')
+                ->beforeNormalization()
+                ->ifString()
+                    ->then(function($value) { return array('ip' => $value); })
+                ->end()
+                ->children()
+                    ->scalarNode('ip')->defaultNull()->end()
+                    ->scalarNode('priority')->defaultValue(0)->end()
+                ->end()
+            ->end()            
             ->arrayNode('adapter')
                 ->children()
                     ->scalarNode('class')->defaultNull()->end()

EventListener/FakeRequestListener.php

@@ -38,4 +38,9 @@ public function onKernelRequest(GetResponseEvent $event)
             $event->getRequest()->server->set('REMOTE_ADDR', $this->fakeIp);
         }
     }
+
+    public function getFakeIp()
+    {
+        return $this->fakeIp;
+    }
 }

README.md

@@ -39,4 +39,4 @@ License
 This bundle is released under the MIT license. See the complete license in the
 bundle:
 
-    Resources/meta/LICENSE
+    Resources/meta/LICENSE

Resources/doc/index.md

@@ -90,7 +90,7 @@ information in your development environment, for instance:
 In the example, we'll retrieve information from the user's IP address, and 5
 objects nears him.
 But it won't work on your local environment, that's why this bundle provides
-an easy way to fake this behavior by using a `fake_ip` parameter.
+an easy way to fake this behavior by using a `fake_ip` configuration.
 
 ``` yaml
 # app/config/config_dev.yml
@@ -100,6 +100,19 @@ bazinga_geocoder:
 
 If set, the parameter will replace the `REMOTE_ADDR` value by the given one.
 
+
+Additionally if it interferes with your current
+listeners, You can set up different fake ip listener priority.
+
+
+``` yaml
+# app/config/config_dev.yml
+bazinga_geocoder:
+    fake_ip: 
+        ip: 123.345.643.133
+        priority: 128
+```
+
 ### Dumpers
 
 If you need to dump your geocoded data to a specific format, you can use the

Tests/DependencyInjection/BazingaGeocoderExtensionTest.php

@@ -34,6 +34,9 @@ public function testLoad()
             'Bazinga\Bundle\GeocoderBundle\EventListener\FakeRequestListener',
             $container->get('bazinga_geocoder.event_listener.fake_request')
         );
+        $this->assertNotNull(
+            $container->get('bazinga_geocoder.event_listener.fake_request')->getFakeIp()
+        );
 
         $dumperManager = $container->get('bazinga_geocoder.dumper_manager');
         foreach (array('geojson', 'gpx', 'kmp', 'wkb', 'wkt') as $name) {
@@ -68,4 +71,30 @@ public function testLoad()
             $this->assertInstanceOf($class, $providers[$name], sprintf('-> Assert that %s is instance of %s', $name, $class));
         }
     }
+
+    public function testLoadingFakeIpOldWay()
+    {
+        $configs   = Yaml::parse(file_get_contents(__DIR__.'/Fixtures/old_fake_ip.yml'));
+        $container = new ContainerBuilder();
+        $extension = new BazingaGeocoderExtension();
+
+        $container->setParameter('fixtures_dir', __DIR__ . '/Fixtures');
+
+        $container->set('doctrine.apc.cache', new ArrayCache());
+
+        $container->addCompilerPass(new AddDumperPass());
+        $container->addCompilerPass(new AddProvidersPass());
+
+        $extension->load($configs, $container);
+        $container->compile();
+
+        $this->assertInstanceOf(
+            'Bazinga\Bundle\GeocoderBundle\EventListener\FakeRequestListener',
+            $container->get('bazinga_geocoder.event_listener.fake_request')
+        );
+
+        $this->assertNotNull(
+            $container->get('bazinga_geocoder.event_listener.fake_request')->getFakeIp()
+        );
+    }
 }

Tests/DependencyInjection/Fixtures/config.yml

@@ -1,5 +1,7 @@
 bazinga_geocoder:
-    fake_ip: 33.33.33.11
+    fake_ip:
+        ip: 33.33.33.11
+        priority: 128
     adapter:
         class: Geocoder\HttpAdapter\CurlHttpAdapter
     providers:

Tests/DependencyInjection/Fixtures/old_fake_ip.yml

@@ -0,0 +1,2 @@
+bazinga_geocoder:
+    fake_ip: 33.33.33.01