Implemented compatibility with Geocoder 4.0

Author: mikebronner

CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.0.0-RC1] - 18 Jun 2017
+### Added
+- compatibility with Geocoder 4.0-dev.
+- caching to `geocodeQuery()` and `reverseQuery()` methods.
+
+### Updated
+- the geocoder `all()` method to be deprecated. Use `get()`.
+
 ## [1.1.0] - 17 Jun 2017
 ### Added
 - caching functionality for `geocode()` and `reverse()` methods.

README.md

@@ -8,18 +8,21 @@
 > If you still use **Laravel 4**, please check out the `0.4.x` branch
  [here](https://github.com/geocoder-php/GeocoderLaravel/tree/0.4.x).
 
-**Version 1.0.0 is a backwards-compatibility-breaking update. Please review
+**Version 2.0.0 is a backwards-compatibility-breaking update. Please review
  this documentation, especially the _Usage_ section before installing.**
 
 This package allows you to use [**Geocoder**](http://geocoder-php.org/Geocoder/)
  in [**Laravel 5**](http://laravel.com/).
 
+## Requirements
+- PHP >= 7.0.0
+- Laravel >= 5.0
+
 ## Installation
 1. Install the package via composer:
  ```sh
 composer require toin0u/geocoder-laravel
 ```
- _Once 1.0.0 is stable, we will update this command to reflect that. In the interest of getting it out and into your hands, a temporary RC build is best._
 
 2. Find the `providers` array key in `config/app.php` and register the **Geocoder Service Provider**:
  ```php
@@ -29,6 +32,31 @@ composer require toin0u/geocoder-laravel
 ```
 
 ## Upgrading
+### 1.x to 2.x
+The one change to keep in mind here is that the results returned from
+ `Geocoder for Laravel` are now using the Laravel-native Collections class
+ instead of returning and instance of `AddressCollection`. This should provide
+ greater versatility in manipulation of the results, and be inline with
+ expectations for working with Laravel. The existing `AddressCollection`
+ methods should map strait over to Laravel's `Collection` methods. But be sure
+ to double-check your results, if you have been using `getIterator()`, `count()`,
+ `first()`, `isEmpty()`, `slice()`, `has()`, `get()`, or `all()` on your results.
+
+**Alert:** if you have been using the `getIterator()` method, it is no longer
+ needed. Simply iterate over your results as you would any other Laravel
+ collection.
+
+**Deprecated:** the `all()` method on the geocoder is being deprecated in favor
+ of using `get()`, which will return a Laravel Collection. You can then run
+ `all()` on that. This method will be removed in version 3.0.0.
+
+**Added:** this version introduces a new way to create more complex queries:
+  - geocodeQuery()
+  - reverseQuery()
+ Please see the [Geocoder documentation](https://github.com/geocoder-php/Geocoder)
+ for more details.
+
+### 0.x to 1.x
 If you are upgrading from a pre-1.x version of this package, please keep the
  following things in mind:
 
@@ -128,11 +156,6 @@ The service provider initializes the `geocoder` service, accessible via the
 app('geocoder')->geocode('Los Angeles, CA')->get();
 ```
 
-#### Get Array of Addresses
-```php
-app('geocoder')->geocode('Los Angeles, CA')->all();
-```
-
 #### Reverse-Geocoding
 ```php
 app('geocoder')->reverse(43.882587,-103.454067)->get();

composer.json

@@ -24,8 +24,12 @@
     ],
     "require": {
         "php": ">=5.4",
+        "geocoder-php/bing-maps-provider": "dev-master@dev",
+        "geocoder-php/chain-provider": "dev-master@dev",
         "geocoder-php/common-http": "dev-master@dev",
+        "geocoder-php/free-geoip-provider": "dev-master@dev",
         "geocoder-php/google-maps-provider": "dev-master@dev",
+        "geocoder-php/maxmind-binary-provider": "dev-master@dev",
         "guzzlehttp/guzzle": "^6.2",
         "illuminate/cache": "~5.0",
         "illuminate/support": "~5.0",
@@ -61,7 +65,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.2.0-dev"
+            "dev-master": "2.0.0-RC1"
         }
     },
     "config": {

config/geocoder.php

@@ -2,40 +2,32 @@
 
 /**
  * This file is part of the GeocoderLaravel library.
- *
- * (c) Antoine Corcy <[email protected]>
- *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
 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;
+use Geocoder\Provider\BingMaps\BingMaps;
+use Geocoder\Provider\Chain\Chain;
+use Geocoder\Provider\FreeGeoIp\FreeGeoIp;
+use Geocoder\Provider\GoogleMaps\GoogleMaps;
 
 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'),
-        // ],
-        GoogleAddress::class => [
-            'en',
+        Chain::class => [
+            GoogleMaps::class => [
+                'en-US',
+                env('GOOGLE_MAPS_API_KEY'),
+            ],
+            FreeGeoIp::class  => [],
+        ],
+        BingMaps::class => [
+            'en-US',
+            env('BING_MAPS_API_KEY'),
+        ],
+        GoogleMaps::class => [
             'us',
-            true,
             env('GOOGLE_MAPS_API_KEY'),
         ],
     ],

src/ProviderAndDumperAggregator.php

@@ -1,10 +1,11 @@
 <?php namespace Geocoder\Laravel;
 
 /**
- * This file is part of the Geocoder package.
+ * This file is part of the Geocoder Laravel package.
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
+ * @author Mike Bronner <[email protected]>
  * @license    MIT License
  */
 
@@ -14,36 +15,37 @@
 use Geocoder\Dumper\Wkb;
 use Geocoder\Dumper\Wkt;
 use Geocoder\Geocoder;
+use Geocoder\Query\GeocodeQuery;
+use Geocoder\Query\ReverseQuery;
 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
 {
-    protected $results;
     protected $aggregator;
+    protected $results;
 
     public function __construct(int $limit = Geocoder::DEFAULT_RESULT_LIMIT)
     {
         $this->aggregator = new ProviderAggregator($limit);
+        $this->results = collect();
     }
 
+    /**
+     * @deprecated Use `get()` instead.
+     */
     public function all() : array
     {
         return $this->results->all();
     }
 
-    public function get() : AddressCollection
+    public function get() : Collection
     {
         return $this->results;
     }
 
-    public function dump($dumper) : Collection
+    public function dump(string $dumper) : Collection
     {
         $dumperClasses = collect([
             'geojson' => GeoJson::class,
@@ -70,29 +72,69 @@ public function dump($dumper) : Collection
         });
     }
 
-    public function geocodeQuery($query)
+    public function geocodeQuery(GeocodeQuery $query) : self
     {
-        return $this->aggregator->geocodeQuery($query);
+        $cacheKey = serialize($query);
+        $this->results = cache()->remember(
+            "geocoder-{$cacheKey}",
+            config('geocoder.cache-duraction', 0),
+            function () use ($query) {
+                $addresses = collect();
+                $addressCollection = $this->aggregator->geocodeQuery($query);
+
+                foreach ($addressCollection as $address) {
+                    $addresses->push($address);
+                }
+
+                return $addresses;
+            }
+        );
+
+        return $this;
     }
 
-    public function reverseQuery($query)
+    public function reverseQuery(ReverseQuery $query) : self
     {
-        return $this->aggregator->reverseQuery($query);
+        $cacheKey = serialize($query);
+        $this->results = cache()->remember(
+            "geocoder-{$cacheKey}",
+            config('geocoder.cache-duraction', 0),
+            function () use ($query) {
+                $addresses = collect();
+                $addressCollection = $this->aggregator->reverseQuery($query);
+
+                foreach ($addressCollection as $address) {
+                    $addresses->push($address);
+                }
+
+                return $addresses;
+            }
+        );
+
+        return $this;
     }
 
-    public function getName()
+    public function getName() : string
     {
         return $this->aggregator->getName();
     }
 
     public function geocode(string $value) : self
     {
-        $cacheId = str_slug($value);
+        $cacheKey = str_slug($value);
         $this->results = cache()->remember(
-            "geocoder-{$cacheId}",
+            "geocoder-{$cacheKey}",
             config('geocoder.cache-duraction', 0),
             function () use ($value) {
-                return $this->aggregator->geocode($value);
+
+                $addresses = collect();
+                $addressCollection = $this->aggregator->geocode($value);
+
+                foreach ($addressCollection as $address) {
+                    $addresses->push($address);
+                }
+
+                return $addresses;
             }
         );
 
@@ -106,47 +148,54 @@ public function reverse(float $latitude, float $longitude) : self
             "geocoder-{$cacheId}",
             config('geocoder.cache-duraction', 0),
             function () use ($latitude, $longitude) {
-                return $this->aggregator->reverse($latitude, $longitude);
+                $addresses = collect();
+                $addressCollection = $this->aggregator->reverse($latitude, $longitude);
+
+                foreach ($addressCollection as $address) {
+                    $addresses->push($address);
+                }
+
+                return $addresses;
             }
         );
 
         return $this;
     }
 
-    public function limit($limit)
+    public function limit(int $limit) : self
     {
         $this->aggregator->limit($limit);
 
         return $this;
     }
 
-    public function getLimit()
+    public function getLimit() : int
     {
         return $this->aggregator->getLimit();
     }
 
-    public function registerProvider($provider)
+    public function registerProvider(string $provider) : self
     {
         $this->aggregator->registerProvider($provider);
 
         return $this;
     }
 
-    public function registerProviders($providers = [])
+    public function registerProviders(array $providers = []) : self
     {
         $this->aggregator->registerProviders($providers);
 
         return $this;
     }
 
-    public function using($name)
+    public function using(string $name) : self
     {
         $this->aggregator->using($name);
 
         return $this;
     }
 
-    public function getProviders()
+    public function getProviders() : array
     {
         return $this->aggregator->getProviders();
     }