Merge pull request #255 from qdequippe/master

Add option to use Faker for FakeIpPlugin

Author: norkunas

DependencyInjection/BazingaGeocoderExtension.php

@@ -18,6 +18,7 @@
 use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
 use Bazinga\GeocoderBundle\ProviderFactory\PluginProviderFactory;
 use Bazinga\GeocoderBundle\ProviderFactory\ProviderFactoryInterface;
+use Faker\Generator;
 use Geocoder\Dumper\Dumper;
 use Geocoder\Plugin\Plugin\CachePlugin;
 use Geocoder\Plugin\Plugin\LimitPlugin;
@@ -55,6 +56,11 @@ 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(2, $config['fake_ip']['use_faker']);
+
+            if ($config['fake_ip']['use_faker'] && !class_exists(Generator::class)) {
+                throw new \LogicException('To enable this option, you must install fzaninotto/faker package.');
+            }
         } else {
             $container->removeDefinition(FakeIpPlugin::class);
         }

DependencyInjection/Configuration.php

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

Plugin/FakeIpPlugin.php

@@ -12,6 +12,8 @@
 
 namespace Bazinga\GeocoderBundle\Plugin;
 
+use Faker\Generator;
+use Faker\Provider\Internet;
 use Geocoder\Plugin\Plugin;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\Query;
@@ -33,10 +35,26 @@ class FakeIpPlugin implements Plugin
      */
     private $replacement;
 
-    public function __construct(string $needle, string $replacement)
+    /**
+     * @var bool
+     */
+    private $useFaker;
+
+    /**
+     * @var Generator|null
+     */
+    private $faker;
+
+    public function __construct(string $needle, string $replacement = null, bool $useFaker = false)
     {
         $this->needle = $needle;
         $this->replacement = $replacement;
+        $this->useFaker = $useFaker;
+
+        if ($useFaker) {
+            $this->faker = new Generator();
+            $this->faker->addProvider(new Internet($this->faker));
+        }
     }
 
     /**
@@ -48,7 +66,13 @@ 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 (null !== $this->faker) {
+            $replacement = $this->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) generate fake ip for you.
+
+```yaml
+bazinga_geocoder:
+    fake_ip:
+        use_faker: true # default false
+```
 
 ### Cache Results
 

Tests/Plugin/FakeIpPluginTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Tests\Plugin;
+
+use Bazinga\GeocoderBundle\Plugin\FakeIpPlugin;
+use Geocoder\Query\GeocodeQuery;
+use Geocoder\Query\Query;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Quentin Dequippe <quentin@dequippe.tech
+ */
+class FakeIpPluginTest extends TestCase
+{
+    public function testSimpleHandleQuery()
+    {
+        $fakeIpPlugin = new FakeIpPlugin('127.0.0.1', '123.123.123.123');
+        $query = GeocodeQuery::create('127.0.0.1');
+
+        /** @var Query $query */
+        $query = $fakeIpPlugin->handleQuery($query, function (Query $query) { return $query; }, function () {});
+
+        $this->assertSame($query->getText(), '123.123.123.123');
+    }
+
+    public function testHandleQueryUsingFaker()
+    {
+        $fakeIpPlugin = new FakeIpPlugin('127.0.0.1', '192.168.1.1', true);
+        $query = GeocodeQuery::create('127.0.0.1');
+
+        /** @var Query $query */
+        $query = $fakeIpPlugin->handleQuery($query, function (Query $query) { return $query; }, function () {});
+
+        $this->assertNotSame($query->getText(), '192.168.1.1');
+    }
+}

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",