WIP - starting work on Geocoder 4.0 compatibility

Author: mikebronner

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 17 Jun 2017
+### Added
+- caching functionality for `geocode()` and `reverse()` methods.
+- `cache-duration` variable to geocoder config.
+
 ## [1.0.2] - 20 Mar 2017
 ### Added
 - unit test for reverse-geocoding.

README.md

@@ -53,7 +53,7 @@ If you are upgrading from a pre-1.x version of this package, please keep the
         ```php
         use Geocoder\Laravel\Facades\Geocoder;
         ```
-  
+
 6. Update your query statements to use `->get()` (to retrieve a collection of
  GeoCoder objects) or `->all()` (to retrieve an array of arrays), then iterate
  to process each result.
@@ -71,6 +71,11 @@ See the [Geocoder documentation](http://geocoder-php.org/Geocoder/) for a list
  of available adapters and providers.
 
 ### Default Settings
+If you are upgrading and do not update your config file with the `cache-duraction`
+ variable, cache will by default be disabled (it will have a `0` cache duration).
+ The default cache duration provided by the config file is `999999999` minutes,
+ essentially forever.
+
 By default, the configuration specifies a Chain Provider as the first provider,
  containing GoogleMaps and FreeGeoIp providers. The first to return a result
  will be returned. After the Chain Provider, we have added the BingMaps provider
@@ -80,6 +85,7 @@ By default, the configuration specifies a Chain Provider as the first provider,
  there just to illustrate this point (and is used by the PHPUnit tests).
 ```php
 return [
+    'cache-duraction' => 999999999,
     'providers' => [
         Chain::class => [
             GoogleMaps::class => [

composer.json

@@ -24,9 +24,14 @@
     ],
     "require": {
         "php": ">=5.4",
+        "geocoder-php/common-http": "dev-master@dev",
+        "geocoder-php/google-maps-provider": "dev-master@dev",
+        "guzzlehttp/guzzle": "^6.2",
         "illuminate/cache": "~5.0",
         "illuminate/support": "~5.0",
-        "willdurand/geocoder": "~3.3"
+        "php-http/guzzle6-adapter": "^1.1",
+        "php-http/message": "^1.5",
+        "willdurand/geocoder": "dev-master@dev"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",
@@ -56,7 +61,11 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0.0-dev"
+            "dev-master": "1.2.0-dev"
         }
+    },
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true
     }
 }

config/geocoder.php

@@ -9,36 +9,35 @@
  * file that was distributed with this source code.
  */
 
-use Ivory\HttpAdapter\CurlHttpAdapter;
-use Ivory\HttpAdapter\Guzzle6HttpAdapter;
-use Geocoder\Provider\Chain;
-use Geocoder\Provider\BingMaps;
-use Geocoder\Provider\FreeGeoIp;
-use Geocoder\Provider\GoogleMaps;
-use Geocoder\Provider\MaxMindBinary;
+use Http\Adapter\Guzzle6\Client;
+// use Geocoder\Provider\Chain;
+// use Geocoder\Provider\BingMaps;
+// use Geocoder\Provider\FreeGeoIp;
+use Geocoder\Provider\GoogleMaps\Model\GoogleAddress;
+// use Geocoder\Provider\MaxMindBinary;
 
 return [
     'cache-duraction' => 999999999,
     'providers' => [
-        Chain::class => [
-            GoogleMaps::class => [
-                'en',
-                'us',
-                true,
-                env('GOOGLE_MAPS_API_KEY'),
-            ],
-            FreeGeoIp::class  => [],
-        ],
-        BingMaps::class => [
-            'en-US',
-            env('BING_MAPS_API_KEY'),
-        ],
-        GoogleMaps::class => [
+        // Chain::class => [
+        //     GoogleMaps::class => [
+        //         'en',
+        //         'us',
+        //         true,
+        //         env('GOOGLE_MAPS_API_KEY'),
+        //     ],
+        //     FreeGeoIp::class  => [],
+        // ],
+        // BingMaps::class => [
+        //     'en-US',
+        //     env('BING_MAPS_API_KEY'),
+        // ],
+        GoogleAddress::class => [
             'en',
             'us',
             true,
             env('GOOGLE_MAPS_API_KEY'),
         ],
     ],
-    'adapter'  => CurlHttpAdapter::class,
+    'adapter'  => Client::class,
 ];

src/GeocoderProviderAggregatorAdapter.php

@@ -0,0 +1,90 @@
+<?php namespace Geocoder\Laravel;
+
+/**
+ * This file is part of the GeocoderLaravel library.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Geocoder\ProviderAggregator;
+
+/**
+ * @author Mike Bronner <[email protected]>
+ */
+class GeocoderProviderAggregatorAdapter
+{
+    protected $aggregator;
+
+    public function __construct(int $limit = Geocoder::DEFAULT_RESULT_LIMIT)
+    {
+        $this->aggregator = new ProviderAggregator($limit);
+    }
+
+    public function geocodeQuery($query)
+    {
+        return $this->aggregator->geocodeQuery($query);
+    }
+
+    public function reverseQuery($query)
+    {
+        return $this->aggregator->reverseQuery($query);
+    }
+
+    public function getName()
+    {
+        return $this->aggregator->getName();
+    }
+
+    public function geocode($value)
+    {
+        return $this->aggregator->geocode($value);
+    }
+
+    public function reverse(float $latitude, float $longitude)
+    {
+        return $this->aggregator->reverse($latitude, $longitude);
+    }
+
+    public function limit($limit)
+    {
+        $this->aggregator->limit($limit);
+
+        return $this;
+    }
+
+    public function getLimit()
+    {
+        return $this->aggregator->getLimit();
+    }
+
+    public function registerProvider($provider)
+    {
+        $this->aggregator->registerProvider($provider);
+
+        return $this;
+    }
+
+    public function registerProviders($providers = [])
+    {
+        $this->aggregator->registerProviders($providers);
+
+        return $this;
+    }
+
+    public function using($name)
+    {
+        $this->aggregator->using($name);
+
+        return $this;
+    }
+
+    public function getProviders()
+    {
+        return $this->aggregator->getProviders();
+    }
+
+    protected function getProvider()
+    {
+        return $this->aggregator->getProvider();
+    }
+}

src/ProviderAndDumperAggregator.php

@@ -15,33 +15,35 @@
 use Geocoder\Dumper\Wkt;
 use Geocoder\Geocoder;
 use Geocoder\Laravel\Exceptions\InvalidDumperException;
+use Geocoder\Laravel\ProviderAndDumperAggregator;
 use Geocoder\ProviderAggregator;
+use Geocoder\Model\AddressCollection;
 use Illuminate\Support\Collection;
 
 /**
  * @author Mike Bronner <[email protected]>
  */
-class ProviderAndDumperAggregator extends ProviderAggregator implements Geocoder
+class ProviderAndDumperAggregator
 {
-    /**
-     * @var \Geocoder\Model\AddressCollection
-     */
     protected $results;
+    protected $aggregator;
 
-    /**
-     * @return array
-     */
-    public function all()
+    public function __construct(int $limit = Geocoder::DEFAULT_RESULT_LIMIT)
+    {
+        $this->aggregator = new ProviderAggregator($limit);
+    }
+
+    public function all() : array
     {
         return $this->results->all();
     }
 
-    /**
-     * @param $dumper
-     * @return Collection
-     * @throws InvalidDumperException
-     */
-    public function dump($dumper)
+    public function get() : AddressCollection
+    {
+        return $this->results;
+    }
+
+    public function dump($dumper) : Collection
     {
         $dumperClasses = collect([
             'geojson' => GeoJson::class,
@@ -68,48 +70,89 @@ public function dump($dumper)
         });
     }
 
-    /**
-     * @param string
-     * @return ProviderAndDumperAggregator
-     */
-    public function geocode($value)
+    public function geocodeQuery($query)
+    {
+        return $this->aggregator->geocodeQuery($query);
+    }
+
+    public function reverseQuery($query)
+    {
+        return $this->aggregator->reverseQuery($query);
+    }
+
+    public function getName()
+    {
+        return $this->aggregator->getName();
+    }
+
+    public function geocode(string $value) : self
     {
         $cacheId = str_slug($value);
         $this->results = cache()->remember(
             "geocoder-{$cacheId}",
             config('geocoder.cache-duraction', 0),
             function () use ($value) {
-                return parent::geocode($value);
+                return $this->aggregator->geocode($value);
             }
         );
 
         return $this;
     }
 
-    /**
-     * @return \Geocoder\Model\AddressCollection
-     */
-    public function get()
-    {
-        return $this->results;
-    }
-
-    /**
-     * @param float
-     * @param float
-     * @return ProviderAndDumperAggregator
-     */
-    public function reverse($latitude, $longitude)
+    public function reverse(float $latitude, float $longitude) : self
     {
         $cacheId = str_slug("{$latitude}-{$longitude}");
         $this->results = cache()->remember(
             "geocoder-{$cacheId}",
             config('geocoder.cache-duraction', 0),
             function () use ($latitude, $longitude) {
-                return parent::reverse($latitude, $longitude);
+                return $this->aggregator->reverse($latitude, $longitude);
             }
         );
 
         return $this;
     }
+
+    public function limit($limit)
+    {
+        $this->aggregator->limit($limit);
+
+        return $this;
+    }
+
+    public function getLimit()
+    {
+        return $this->aggregator->getLimit();
+    }
+
+    public function registerProvider($provider)
+    {
+        $this->aggregator->registerProvider($provider);
+
+        return $this;
+    }
+
+    public function registerProviders($providers = [])
+    {
+        $this->aggregator->registerProviders($providers);
+
+        return $this;
+    }
+
+    public function using($name)
+    {
+        $this->aggregator->using($name);
+
+        return $this;
+    }
+
+    public function getProviders()
+    {
+        return $this->aggregator->getProviders();
+    }
+
+    protected function getProvider()
+    {
+        return $this->aggregator->getProvider();
+    }
 }

src/Providers/GeocoderService.php

@@ -48,12 +48,9 @@ public function register()
     {
         $this->app->alias('Geocoder', Geocoder::class);
         $this->app->singleton('geocoder', function () {
-            $geocoder = new ProviderAndDumperAggregator();
-            $geocoder->registerProviders(
+            return (new ProviderAndDumperAggregator)->registerProviders(
                 $this->getProviders(collect(config('geocoder.providers')))
             );
-
-            return $geocoder;
         });
     }