Add option to use Faker library for FakeIpPlugin

Author: qdequippe

DependencyInjection/BazingaGeocoderExtension.php

@@ -53,7 +53,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         if ($config['fake_ip']['enabled']) {
             $definition = $container->getDefinition(FakeIpPlugin::class);
-            $definition->replaceArgument(1, $config['fake_ip']['ip']);
+            $definition->replaceArgument(1, $config['fake_ip']['ip'], $config['use_faker']);
         } else {
             $container->removeDefinition(FakeIpPlugin::class);
         }

DependencyInjection/Configuration.php

@@ -87,6 +87,7 @@ public function getConfigTreeBuilder()
                 ->canBeEnabled()
                 ->children()
                     ->scalarNode('ip')->defaultNull()->end()
+                    ->booleanNode('user_faker')->defaultFalse()->end()
                 ->end()
             ->end();
 

Plugin/FakeIpPlugin.php

@@ -12,6 +12,7 @@
 
 namespace Bazinga\GeocoderBundle\Plugin;
 
+use Faker\Factory;
 use Geocoder\Plugin\Plugin;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\Query;
@@ -33,10 +34,16 @@ class FakeIpPlugin implements Plugin
      */
     private $replacement;
 
-    public function __construct(string $needle, string $replacement)
+    /**
+     * @var bool
+     */
+    private $useFaker;
+
+    public function __construct(string $needle, string $replacement = null, bool $useFaker = false)
     {
         $this->needle = $needle;
         $this->replacement = $replacement;
+        $this->useFaker = $useFaker;
     }
 
     /**
@@ -48,7 +55,14 @@ public function handleQuery(Query $query, callable $next, callable $first)
             return $next($query);
         }
 
-        $text = str_replace($this->needle, $this->replacement, $query->getText(), $count);
+        $replacement = $this->replacement;
+
+        if ($this->useFaker) {
+            $faker = Factory::create();
+            $replacement = $faker->ipv4;
+        }
+
+        $text = str_replace($this->needle, $replacement, $query->getText(), $count);
         if ($count > 0) {
             $query = $query->withText($text);
         }

Resources/doc/index.md

@@ -207,6 +207,13 @@ bazinga_geocoder:
 
 If set, the parameter will replace all instances of "127.0.0.1" in your queries and replace them with the given one.
 
+You can also let [Faker](https://github.com/fzaninotto/Faker) generates fake ip for you.
+
+```yaml
+bazinga_geocoder:
+    fake_ip:
+        user_faker: true # default false
+```
 
 ### Cache Results
 

Tests/DependencyInjection/ConfigurationTest.php

@@ -35,6 +35,7 @@ public function testGetConfigTreeBuilder()
         $this->assertTrue($config['profiling']['enabled']);
         $this->assertTrue($config['fake_ip']['enabled']);
         $this->assertEquals('33.33.33.11', $config['fake_ip']['ip']);
+        $this->assertFalse($config['fake_ip']['use_faker']);
     }
 
     public function testGetConfigTreeBuilderNoDebug()

composer.json

@@ -22,6 +22,7 @@
   "require-dev": {
     "doctrine/cache": "~1.3",
     "doctrine/orm": "~2.3",
+    "fzaninotto/faker": "^1.8",
     "geocoder-php/algolia-places-provider": "^0.1.1",
     "geocoder-php/arcgis-online-provider": "^4.0",
     "geocoder-php/bing-maps-provider": "^4.0",