Add optional precision argument (#204)

* Add cache_precision to BazingaGeoCoderExtension

* Update docs

Author: samybasset

DependencyInjection/BazingaGeocoderExtension.php

@@ -111,7 +111,7 @@ public function configureProviderPlugins(ContainerBuilder $container, array $con
             }
         }
 
-        if (isset($config['cache']) || isset($config['cache_lifetime'])) {
+        if (isset($config['cache']) || isset($config['cache_lifetime']) || isset($config['cache_precision'])) {
             if (null === $cacheServiceId = $config['cache']) {
                 if (!$container->has('app.cache')) {
                     throw new \LogicException('You need to specify a service for cache.');
@@ -121,7 +121,7 @@ public function configureProviderPlugins(ContainerBuilder $container, array $con
             $plugins[] = $providerServiceId.'.cache';
             $container->register($providerServiceId.'.cache', CachePlugin::class)
                 ->setPublic(false)
-                ->setArguments([new Reference($cacheServiceId), (int) $config['cache_lifetime']]);
+                ->setArguments([new Reference($cacheServiceId), (int) $config['cache_lifetime'], $config['cache_precision']]);
         }
 
         if (isset($config['limit'])) {

DependencyInjection/Configuration.php

@@ -98,6 +98,10 @@ private function getProvidersNode()
                     ->variableNode('options')->defaultValue([])->end()
                     ->scalarNode('cache')->defaultNull()->end()
                     ->scalarNode('cache_lifetime')->defaultNull()->end()
+                    ->scalarNode('cache_precision')
+                        ->defaultNull()
+                        ->info('Precision of the coordinates to cache.')
+                        ->end()
                     ->scalarNode('limit')->defaultNull()->end()
                     ->scalarNode('locale')->defaultNull()->end()
                     ->scalarNode('logger')->defaultNull()->end()

Resources/doc/cache.md

@@ -14,8 +14,13 @@ bazinga_geocoder:
       factory: Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsFactory
       cache: 'any.psr16.service'
       cache_lifetime: 3600
+      cache_precision: ~
 ```
 
+If you do a lot of reverse queries it can be useful to cache them with less precision. So if you are interested in only the city,
+you don't want to query for every exact coordinate. Instead, you want to remove some precision of the coordinates. For example: 
+reversing `52.3705273, 4.891031` will be cached as `52.3705, 4.8910`. 
+
 You may use any [PSR16](http://www.php-fig.org/psr/psr-16/) cache [implementation](https://packagist.org/providers/psr/simple-cache-implementation).
 The `CachePlugin` helps you to cache all responses. 
 
@@ -79,6 +84,7 @@ bazinga_geocoder:
       factory: Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsFactory
       cache: 'app.simple_cache'
       cache_lifetime: 3600
+      cache_precision: 4
 ```
 
 For older Symfony version, you can use a bridge between PSR-6 and PSR-16. Install the 

Resources/doc/index.md

@@ -265,6 +265,7 @@ bazinga_geocoder:
             factory:  ~           # Required
             cache: 'app.cache'
             cache_lifetime: 3600
+            cache_precision: 4    # Precision of the coordinates to cache.
             limit: 5
             locale: 'sv'
             logger: 'logger'

Tests/Functional/config/cache.yml

@@ -6,6 +6,7 @@ bazinga_geocoder:
     acme:
       factory: Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsFactory
       cache_lifetime: 10
+      cache_precision: 4
       cache: acme.cache
 
 services: