Skip to content

Commit b9dc865

Browse files
mikebronnermikebronner
authored
Merge pull request #123 from msschl/feature_SpecifyingCacheStoreToUse
Specify which cache store should be used
2 parents 8487330 + 3cc763a commit b9dc865

File tree

4 files changed

+59
-28
lines changed

4 files changed

+59
-28
lines changed

‎config/geocoder.php

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,44 @@
99

1010
/*
1111
|--------------------------------------------------------------------------
12-
| Cache Duration
12+
| Cache Settings
1313
|--------------------------------------------------------------------------
1414
|
15-
| Specify the cache duration in minutes. The default approximates a forever
16-
| cache, but there are certain issues with Laravel's forever caching
17-
| methods that prevent us from using them in this project.
18-
|
19-
| Default: 9999999 (integer)
15+
| Here you may define all of the cache settings.
2016
|
2117
*/
22-
'cache-duration' => 9999999,
18+
19+
'cache' => [
20+
21+
/*
22+
|--------------------------------------------------------------------------
23+
| Cache Store
24+
|--------------------------------------------------------------------------
25+
|
26+
| Specify the cache store to use for caching. The default value null will
27+
| use the default cache store specified in the cache.php cofig file.
28+
|
29+
| Default: null
30+
|
31+
*/
32+
33+
'store' => null,
34+
35+
/*
36+
|--------------------------------------------------------------------------
37+
| Cache Duration
38+
|--------------------------------------------------------------------------
39+
|
40+
| Specify the cache duration in minutes. The default approximates a forever
41+
| cache, but there are certain issues with Laravel's forever caching
42+
| methods that prevent us from using them in this project.
43+
|
44+
| Default: 9999999 (integer)
45+
|
46+
*/
47+
48+
'duration' => 9999999,
49+
],
2350

2451
/*
2552
|--------------------------------------------------------------------------

‎src/ProviderAndDumperAggregator.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ public function dump(string $dumper) : Collection
7979

8080
public function geocodeQuery(GeocodeQuery $query) : self
8181
{
82-
$cacheKey = serialize($query);
83-
$this->results = app('cache')->remember(
82+
$cacheKey = md5(serialize($query));
83+
$this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
8484
"geocoder-{$cacheKey}",
85-
config('geocoder.cache-duration', 0),
85+
config('geocoder.cache.duration', 0),
8686
function () use ($query) {
8787
return collect($this->aggregator->geocodeQuery($query));
8888
}
@@ -95,10 +95,10 @@ function () use ($query) {
9595

9696
public function reverseQuery(ReverseQuery $query) : self
9797
{
98-
$cacheKey = serialize($query);
99-
$this->results = app('cache')->remember(
98+
$cacheKey = md5(serialize($query));
99+
$this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
100100
"geocoder-{$cacheKey}",
101-
config('geocoder.cache-duration', 0),
101+
config('geocoder.cache.duration', 0),
102102
function () use ($query) {
103103
return collect($this->aggregator->reverseQuery($query));
104104
}
@@ -116,10 +116,10 @@ public function getName() : string
116116

117117
public function geocode(string $value) : self
118118
{
119-
$cacheKey = str_slug(strtolower(urlencode($value)));
120-
$this->results = app('cache')->remember(
119+
$cacheKey = md5(str_slug(strtolower(urlencode($value))));
120+
$this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
121121
"geocoder-{$cacheKey}",
122-
config('geocoder.cache-duration', 0),
122+
config('geocoder.cache.duration', 0),
123123
function () use ($value) {
124124
return collect($this->aggregator->geocode($value));
125125
}
@@ -132,10 +132,10 @@ function () use ($value) {
132132

133133
public function reverse(float $latitude, float $longitude) : self
134134
{
135-
$cacheKey = str_slug(strtolower(urlencode("{$latitude}-{$longitude}")));
136-
$this->results = app('cache')->remember(
135+
$cacheKey = md5(str_slug(strtolower(urlencode("{$latitude}-{$longitude}"))));
136+
$this->results = app('cache')->store(config('geocoder.cache.store', null))->remember(
137137
"geocoder-{$cacheKey}",
138-
config('geocoder.cache-duration', 0),
138+
config('geocoder.cache.duration', 0),
139139
function () use ($latitude, $longitude) {
140140
return collect($this->aggregator->reverse($latitude, $longitude));
141141
}
@@ -264,7 +264,7 @@ protected function getAdapterClass(string $provider) : string
264264

265265
protected function removeEmptyCacheEntry(string $cacheKey)
266266
{
267-
$result = app('cache')->get($cacheKey);
267+
$result = app('cache')->store(config('geocoder.cache.store', null))->get($cacheKey);
268268

269269
if ($result && $result->isEmpty()) {
270270
app('cache')->forget($cacheKey);

‎tests/Feature/Providers/GeocoderServiceTest.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ public function testItThrowsAnExceptionForInvalidDumper()
141141

142142
public function testConfig()
143143
{
144-
$this->assertEquals(999999999, config('geocoder.cache-duration'));
144+
$this->assertEquals(null, config('geocoder.cache.store'));
145+
$this->assertEquals(999999999, config('geocoder.cache.duration'));
145146
$this->assertTrue(is_array($providers = $this->app['config']->get('geocoder.providers')));
146147
$this->assertCount(3, $providers);
147148
$this->assertArrayHasKey(GoogleMaps::class, $providers[Chain::class]);
@@ -164,13 +165,13 @@ public function testGeocoder()
164165

165166
public function testCacheIsUsed()
166167
{
167-
$cacheKey = str_slug(strtolower(urlencode('1600 Pennsylvania Ave NW, Washington, DC 20500, USA')));
168+
$cacheKey = md5(str_slug(strtolower(urlencode('1600 Pennsylvania Ave NW, Washington, DC 20500, USA'))));
168169

169170
$result = app('geocoder')->geocode('1600 Pennsylvania Ave NW, Washington, DC 20500, USA')
170171
->get();
171172

172-
$this->assertTrue(app('cache')->has("geocoder-{$cacheKey}"));
173-
$this->assertEquals($result, app('cache')->get("geocoder-{$cacheKey}"));
173+
$this->assertTrue(app('cache')->store(config('geocoder.cache.store', null))->has("geocoder-{$cacheKey}"));
174+
$this->assertEquals($result, app('cache')->store(config('geocoder.cache.store', null))->get("geocoder-{$cacheKey}"));
174175
}
175176

176177
/**
@@ -264,14 +265,14 @@ public function testGetProvider()
264265

265266
public function testJapaneseCharacterGeocoding()
266267
{
267-
$cacheKey = str_slug(strtolower(urlencode('108-0075 東京都港区港南２丁目１６－３')));
268+
$cacheKey = md5(str_slug(strtolower(urlencode('108-0075 東京都港区港南２丁目１６－３'))));
268269

269270
app('geocoder')->geocode('108-0075 東京都港区港南２丁目１６－３')
270271
->get();
271272

272273
$this->assertEquals(
273274
$cacheKey,
274-
'108-0075e69db1e4baace983bde6b8afe58cbae6b8afe58d97efbc92e4b881e79baeefbc91efbc96efbc8defbc93'
275+
md5('108-0075e69db1e4baace983bde6b8afe58cbae6b8afe58d97efbc92e4b881e79baeefbc91efbc96efbc8defbc93')
275276
);
276277
$this->assertTrue(app('cache')->has("geocoder-{$cacheKey}"));
277278
}
@@ -303,7 +304,7 @@ public function testItHandlesOnlyCityAndState()
303304

304305
public function testEmptyResultsAreNotCached()
305306
{
306-
$cacheKey = str_slug(strtolower(urlencode('_')));
307+
$cacheKey = md5(str_slug(strtolower(urlencode('_'))));
307308

308309
Geocoder::geocode('_')->get();
309310

‎tests/config/testConfig.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
use Http\Client\Curl\Client;
1717

1818
return [
19-
'cache-duration' => 999999999,
19+
'cache' => [
20+
'store' => null,
21+
'duration' => 999999999,
22+
],
2023
'providers' => [
2124
Chain::class => [
2225
GeoIP2::class => [],

0 commit comments

Comments
 (0)