Updated Buildable trait to parse out Expressions to strings when generating cache keys

Author: Josh Ralph

src/Traits/Buildable.php

@@ -1,5 +1,6 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Traits;
 
+use Illuminate\Database\Query\Expression;
 use Illuminate\Pagination\Paginator;
 
 /**
@@ -13,11 +14,16 @@ public function avg($column)
             return parent::avg($column);
         }
 
-        $cacheKey = $this->makeCacheKey(["*"], null, "-avg_{$column}");
+        $cacheKey = $this->makeCacheKey(["*"], null, "-avg_{$this->expressionToString($column)}");
 
         return $this->cachedValue(func_get_args(), $cacheKey);
     }
 
+    public function average($column)
+    {
+        return $this->avg($column);
+    }
+
     public function count($columns = "*")
     {
         if (! $this->isCachable()) {
@@ -215,7 +221,7 @@ public function sum($column)
             return parent::sum($column);
         }
 
-        $cacheKey = $this->makeCacheKey(["*"], null, "-sum_{$column}");
+        $cacheKey = $this->makeCacheKey(["*"], null, "-sum_{$this->expressionToString($column)}");
 
         return $this->cachedValue(func_get_args(), $cacheKey);
     }
@@ -333,4 +339,13 @@ function () use ($arguments, $cacheKey, $method) {
                 }
             );
     }
+
+    private function expressionToString(Expression|string $value): string
+    {
+        if (is_string($value)) {
+            return $value;
+        }
+
+        return $value->getValue($this->query->getGrammar());
+    }
 }

tests/Integration/CachedBuilderTest.php

@@ -5,6 +5,7 @@
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Http\Resources\Author as AuthorResource;
 use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+use Illuminate\Database\Query\Expression;
 use Illuminate\Support\Str;
 
 /**
@@ -180,6 +181,27 @@ public function testAvgModelResultsCreatesCache()
         $this->assertEquals($liveResult, $cachedResult);
     }
 
+    public function testRawAvgModelResultsCreatesCache()
+    {
+        $authorId = (new Author)->with('books', 'profile')
+            ->avg(new Expression('id + id'));
+        $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:authors:genealabslaravelmodelcachingtestsfixturesauthor-authors.deleted_at_null-testing:{$this->testingSqlitePath}testing.sqlite:books-testing:{$this->testingSqlitePath}testing.sqlite:profile-avg_id + id");
+        $tags = [
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesauthor",
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesbook",
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesprofile",
+        ];
+
+        $cachedResult = $this->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+        $liveResult = (new UncachedAuthor)->with('books', 'profile')
+            ->avg(new Expression('id + id'));
+
+        $this->assertEquals($authorId, $cachedResult);
+        $this->assertEquals($liveResult, $cachedResult);
+    }
+
     public function testChunkModelResultsCreatesCache()
     {
         $chunkedAuthors = [];
@@ -356,6 +378,26 @@ public function testSumModelResultsCreatesCache()
         $this->assertEquals($liveResult, $cachedResult);
     }
 
+    public function testRawSumModelResultsCreatesCache()
+    {
+        $authorId = (new Author)->with('books', 'profile')
+            ->sum(new Expression('`id` + `id`'));
+        $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:authors:genealabslaravelmodelcachingtestsfixturesauthor-authors.deleted_at_null-testing:{$this->testingSqlitePath}testing.sqlite:books-testing:{$this->testingSqlitePath}testing.sqlite:profile-sum_`id` + `id`");
+        $tags = [
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesauthor",
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesbook",
+            "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesprofile",
+        ];
+
+        $cachedResult = $this->cache()->tags($tags)
+            ->get($key)['value'];
+        $liveResult = (new UncachedAuthor)->with('books', 'profile')
+            ->sum(new Expression('`id` + `id`'));
+
+        $this->assertEquals($authorId, $cachedResult);
+        $this->assertEquals($liveResult, $cachedResult);
+    }
+
     public function testValueModelResultsCreatesCache()
     {
         $authorName = (new Author)->with('books', 'profile')