Added the ability to specify a cache store to use

Author: msschl

config/geocoder.php

@@ -9,17 +9,44 @@
 
  /*
  |--------------------------------------------------------------------------
- | Cache Duration
+ | Cache Settings
  |--------------------------------------------------------------------------
  |
- | 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)
+ | Here you may define all of the cache settings.
  |
  */
- 'cache-duration' => 9999999,
+
+ '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.
+ |
+ | Default: null
+ |
+ */
+
+ '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.
+ |
+ | Default: 9999999 (integer)
+ |
+ */
+
+ 'duration' => 9999999,
+ ],
 
  /*
  |--------------------------------------------------------------------------

src/ProviderAndDumperAggregator.php

@@ -80,9 +80,9 @@ public function dump(string $dumper) : Collection
  public function geocodeQuery(GeocodeQuery $query) : self
  {
  $cacheKey = serialize($query);
- $this->results = app('cache')->remember(
+ $this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
  "geocoder-{$cacheKey}",
- config('geocoder.cache-duration', 0),
+ config('geocoder.cache.duration', 0),
  function () use ($query) {
  return collect($this->aggregator->geocodeQuery($query));
  }
@@ -96,9 +96,9 @@ function () use ($query) {
  public function reverseQuery(ReverseQuery $query) : self
  {
  $cacheKey = serialize($query);
- $this->results = app('cache')->remember(
+ $this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
  "geocoder-{$cacheKey}",
- config('geocoder.cache-duration', 0),
+ config('geocoder.cache.duration', 0),
  function () use ($query) {
  return collect($this->aggregator->reverseQuery($query));
  }
@@ -117,9 +117,9 @@ public function getName() : string
  public function geocode(string $value) : self
  {
  $cacheKey = str_slug(strtolower(urlencode($value)));
- $this->results = app('cache')->remember(
+ $this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
  "geocoder-{$cacheKey}",
- config('geocoder.cache-duration', 0),
+ config('geocoder.cache.duration', 0),
  function () use ($value) {
  return collect($this->aggregator->geocode($value));
  }
@@ -133,9 +133,9 @@ function () use ($value) {
  public function reverse(float $latitude, float $longitude) : self
  {
  $cacheKey = str_slug(strtolower(urlencode("{$latitude}-{$longitude}")));
- $this->results = app('cache')->remember(
+ $this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
  "geocoder-{$cacheKey}",
- config('geocoder.cache-duration', 0),
+ config('geocoder.cache.duration', 0),
  function () use ($latitude, $longitude) {
  return collect($this->aggregator->reverse($latitude, $longitude));
  }
@@ -264,7 +264,7 @@ protected function getAdapterClass(string $provider) : string
 
  protected function removeEmptyCacheEntry(string $cacheKey)
  {
- $result = app('cache')->get($cacheKey);
+ $result = app('cache')->store(config('geocoder.cache.store', null))->get($cacheKey);
 
  if ($result && $result->isEmpty()) {
  app('cache')->forget($cacheKey);

tests/Feature/Providers/GeocoderServiceTest.php

@@ -141,7 +141,8 @@ public function testItThrowsAnExceptionForInvalidDumper()
 
  public function testConfig()
  {
- $this->assertEquals(999999999, config('geocoder.cache-duration'));
+ $this->assertEquals(null, config('geocoder.cache.store'));
+ $this->assertEquals(999999999, config('geocoder.cache.duration'));
  $this->assertTrue(is_array($providers = $this->app['config']->get('geocoder.providers')));
  $this->assertCount(3, $providers);
  $this->assertArrayHasKey(GoogleMaps::class, $providers[Chain::class]);
@@ -169,8 +170,8 @@ public function testCacheIsUsed()
  $result = app('geocoder')->geocode('1600 Pennsylvania Ave NW, Washington, DC 20500, USA')
  ->get();
 
- $this->assertTrue(app('cache')->has("geocoder-{$cacheKey}"));
- $this->assertEquals($result, app('cache')->get("geocoder-{$cacheKey}"));
+ $this->assertTrue(app('cache')->store(config('geocoder.cache.store', null))->has("geocoder-{$cacheKey}"));
+ $this->assertEquals($result, app('cache')->store(config('geocoder.cache.store', null))->get("geocoder-{$cacheKey}"));
  }
 
  /**

tests/config/testConfig.php

@@ -16,7 +16,10 @@
 use Http\Client\Curl\Client;
 
 return [
- 'cache-duration' => 999999999,
+ 'cache' => [
+ 'store' => null,
+ 'duration' => 999999999,
+ ],
  'providers' => [
  Chain::class => [
  GeoIP2::class => [],