Add configurable cache store

Author: mikebronner

CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.0.7] - 25 Mar 2018
+### Added
+- optional dedicated cache store.
+- hashed cache keys and hash collision prevention.
+- custom cache store configuration instructions.
+
 ## [4.0.6] - 9 Feb 2018
 ### Added
 - Laravel 5.6 compatibility.

README.md

@@ -56,6 +56,45 @@ Further, a special note on the GoogleMaps provider: if you are using an API key,
 See the [Geocoder documentation](http://geocoder-php.org/Geocoder/) for a list
  of available adapters and providers.
 
+### Dedicated Cache Store *Recommended*
+To implement the dedicated cache store, add another redis store entry in
+`config/database.php`, something like the following:
+```php
+ "redis" => [
+ // ...
+
+ "geocode-cache" => [ // choose an appropriate name
+ 'host' => env('REDIS_HOST', '192.168.10.10'),
+ 'password' => env('REDIS_PASSWORD', null),
+ 'port' => env('REDIS_PORT', 6379),
+ 'database' => 1, // be sure this number differs from your other redis databases
+ ],
+ ]
+```
+
+You will also need to add an entry in `config/cache.php` to point to this redis
+database:
+```php
+ "stores" => [
+ // ...
+
+ "geocode" => [
+ 'driver' => 'redis',
+ 'connection' => 'geocode-cache',
+ ],
+ ],
+```
+
+Finally, configure Geocoder for Laraver to use this store. Edit
+`config/geocoder.php`:
+```php
+ "cache" => [
+ "store" => "geocode",
+
+ // ...
+ ],
+```
+
 ### Providers
 If you are upgrading and have previously published the geocoder config file, you
  need to add the `cache-duration` variable, otherwise cache will be disabled

composer.json

@@ -41,9 +41,9 @@
  "geocoder-php/geoip2-provider": "^4.0",
  "geocoder-php/maxmind-binary-provider": "^4.0",
  "mockery/mockery": "0.9.*",
- "orchestra/database": "3.6.x-dev@dev",
- "orchestra/testbench": "^3.6.0",
- "orchestra/testbench-browser-kit": "3.6.x-dev@dev",
+ "orchestra/database": "3.6.*",
+ "orchestra/testbench": "3.6.*",
+ "orchestra/testbench-browser-kit": "3.6.*",
  "orchestra/testbench-dusk": "3.6.x-dev@dev",
  "php-coveralls/php-coveralls": "*",
  "phpunit/phpunit": "^7.0",

config/geocoder.php

@@ -6,25 +6,15 @@
 use Http\Client\Curl\Client;
 
 return [
-
- /*
- |--------------------------------------------------------------------------
- | Cache Settings
- |--------------------------------------------------------------------------
- |
- | Here you may define all of the cache settings.
- |
- */
-
  'cache' => [
 
  /*
- |--------------------------------------------------------------------------
+ |-----------------------------------------------------------------------
  | Cache Store
- |--------------------------------------------------------------------------
+ |-----------------------------------------------------------------------
  |
- | Specify the cache store to use for caching. The default value null will
- | use the default cache store specified in the cache.php cofig file.
+ | Specify the cache store to use for caching. The value "null" will use
+ | the default cache store specified in /config/cache.php file.
  |
  | Default: null
  |
@@ -33,13 +23,13 @@
  'store' => null,
 
  /*
- |--------------------------------------------------------------------------
+ |-----------------------------------------------------------------------
  | Cache Duration
- |--------------------------------------------------------------------------
+ |-----------------------------------------------------------------------
  |
- | Specify the cache duration in minutes. The default approximates a forever
- | cache, but there are certain issues with Laravel's forever caching
- | methods that prevent us from using them in this project.
+ | Specify the cache duration in minutes. The default approximates a
+ | "forever" cache, but there are certain issues with Laravel's forever
+ | caching methods that prevent us from using them in this project.
  |
  | Default: 9999999 (integer)
  |
@@ -49,9 +39,9 @@
  ],
 
  /*
- |--------------------------------------------------------------------------
+ |---------------------------------------------------------------------------
  | Providers
- |--------------------------------------------------------------------------
+ |---------------------------------------------------------------------------
  |
  | Here you may specify any number of providers that should be used to
  | perform geocaching operations. The `chain` provider is special,
@@ -76,9 +66,9 @@
  ],
 
  /*
- |--------------------------------------------------------------------------
+ |---------------------------------------------------------------------------
  | Adapter
- |--------------------------------------------------------------------------
+ |---------------------------------------------------------------------------
  |
  | You can specify which PSR-7-compliant HTTP adapter you would like to use.
  | There are multiple options at your disposal: CURL, Guzzle, and others.
@@ -92,9 +82,9 @@
  'adapter' => Client::class,
 
  /*
- |--------------------------------------------------------------------------
+ |---------------------------------------------------------------------------
  | Reader
- |--------------------------------------------------------------------------
+ |---------------------------------------------------------------------------
  |
  | You can specify a reader for specific providers, like GeoIp2, which
  | connect to a local file-database. The reader should be set to an