Add precision argument in CachePlugin (#883)

samybasset · Nyholm · commit 637979c357a8 · 2018-09-14T07:33:14.000-07:00
diff --git a/Plugin/CachePlugin.php b/Plugin/CachePlugin.php
@@ -12,8 +12,10 @@
 
 namespace Geocoder\Plugin\Plugin;
 
+use Geocoder\Model\Coordinates;
 use Geocoder\Plugin\Plugin;
 use Geocoder\Query\Query;
+use Geocoder\Query\ReverseQuery;
 use Psr\SimpleCache\CacheInterface;
 
 /**
@@ -35,14 +37,21 @@ class CachePlugin implements Plugin
      */
     private $lifetime;
 
+    /**
+     * @var int|null
+     */
+    private $precision;
+
     /**
      * @param CacheInterface $cache
-     * @param int            $lifetime
+     * @param int|null       $lifetime
+     * @param int|null       $precision
      */
-    public function __construct(CacheInterface $cache, int $lifetime = null)
+    public function __construct(CacheInterface $cache, int $lifetime = null, int $precision = null)
     {
         $this->cache = $cache;
         $this->lifetime = $lifetime;
+        $this->precision = $precision;
     }
 
     /**
@@ -68,6 +77,13 @@ public function handleQuery(Query $query, callable $next, callable $first)
      */
     private function getCacheKey(Query $query): string
     {
+        if (null !== $this->precision && $query instanceof ReverseQuery) {
+            $query = $query->withCoordinates(new Coordinates(
+                number_format($query->getCoordinates()->getLatitude(), $this->precision),
+                number_format($query->getCoordinates()->getLongitude(), $this->precision)
+            ));
+        }
+
         // Include the major version number of the geocoder to avoid issues unserializing.
         return 'v4'.sha1((string) $query);
     }
diff --git a/Tests/Plugin/CachePluginTest.php b/Tests/Plugin/CachePluginTest.php
@@ -13,9 +13,12 @@
 namespace Geocoder\Plugin\Tests\Plugin;
 
 use Cache\Adapter\Void\VoidCachePool;
+use Generator;
+use Geocoder\Model\Coordinates;
 use Geocoder\Plugin\Plugin\CachePlugin;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\Query;
+use Geocoder\Query\ReverseQuery;
 use PHPUnit\Framework\TestCase;
 
 class CachePluginTest extends TestCase
@@ -50,18 +53,31 @@ public function testPluginMiss()
         $this->assertEquals('result', $plugin->handleQuery($query, $next, $first));
     }
 
-    public function testPluginHit()
+    public function getQueryProvider(): Generator
     {
         $query = GeocodeQuery::create('foo');
-        $queryString = sha1($query->__toString());
+        $key = sha1($query->__toString());
+        yield [$query, $key];
+
+        $query = ReverseQuery::create(new Coordinates(12.123456, 12.123456));
+        $lessPreciseQuery = $query->withCoordinates(new Coordinates(12.1235, 12.1235));
+        $key = sha1((string) $lessPreciseQuery);
+        yield [$query, $key];
+    }
+
+    /**
+     * @dataProvider getQueryProvider
+     */
+    public function testPluginHit(Query $query, string $key)
+    {
         $cache = $this->getMockBuilder(VoidCachePool::class)
             ->disableOriginalConstructor()
             ->setMethods(['get', 'set'])
             ->getMock();
 
         $cache->expects($this->once())
             ->method('get')
-            ->with('v4'.$queryString)
+            ->with('v4'.$key)
             ->willReturn('result');
         $cache->expects($this->never())->method('set');
 
@@ -72,7 +88,7 @@ public function testPluginHit()
             $this->fail('Plugin not call $next on cache hit');
         };
 
-        $plugin = new CachePlugin($cache);
+        $plugin = new CachePlugin($cache, 0, 4);
         $this->assertEquals('result', $plugin->handleQuery($query, $next, $first));
     }
 }
