Added functionality to not cache requests by using doNotCache().

mikebronner · mikebronner · commit 47665e473db4 · 2020-06-20T12:49:57.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.3.3] - 2020-06-20
+### Added
+- functionality to not cache requests by using `doNotCache()`.
+
 ## [4.3.0] - 2020-02-29
 ### Added
 - Laravel 7 compatibility.
diff --git a/README.md b/README.md
@@ -95,6 +95,15 @@ Finally, configure Geocoder for Laraver to use this store. Edit
     ],
 ```
 
+#### Disabling Caching on a Query-Basis
+You can disable caching on a query-by-query basis as needed, like so:
+```php
+    $results = app("geocoder")
+        ->doNotCache()
+        ->geocode('Los Angeles, CA')
+        ->get();
+```
+
 ### 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
diff --git a/src/ProviderAndDumperAggregator.php b/src/ProviderAndDumperAggregator.php
@@ -32,6 +32,7 @@ class ProviderAndDumperAggregator
     protected $aggregator;
     protected $limit;
     protected $results;
+    protected $isCaching = true;
 
     public function __construct()
     {
@@ -59,6 +60,13 @@ public function toJson() : string
             ->first();
     }
 
+    public function doNotCache() : self
+    {
+        $this->isCaching = false;
+
+        return $this;
+    }
+
     public function dump(string $dumper) : Collection
     {
         $dumperClasses = collect([
@@ -181,6 +189,10 @@ public function using(string $name) : self
 
     protected function cacheRequest(string $cacheKey, array $queryElements, string $queryType)
     {
+        if (! $this->isCaching) {
+            return collect($this->aggregator->{$queryType}(...$queryElements));
+        }
+
         $hashedCacheKey = sha1($cacheKey);
         $duration = config("geocoder.cache.duration", 0);
         $store = config('geocoder.cache.store');
diff --git a/tests/Feature/Providers/GeocoderServiceTest.php b/tests/Feature/Providers/GeocoderServiceTest.php
@@ -313,4 +313,17 @@ public function testEmptyResultsAreNotCached()
 
         $this->assertFalse(app('cache')->has("geocoder-{$cacheKey}"));
     }
+
+    public function testCachingCanBeDisabled()
+    {
+        $results = app("geocoder")
+            ->doNotCache()
+            ->geocode('Los Angeles, CA')
+            ->get();
+
+        $this->assertEquals(
+            "Los Angeles, CA, USA",
+            $results->first()->getFormattedAddress()
+        );
+    }
 }
