Add tests, update readme to note that lazy-loaded relationships are not cached

Author: mikebronner

README.md

@@ -17,7 +17,7 @@ for me, and one that would let me cache custom queries, as well as cache model
 relationships. This package is an attempt to address those requirements.
 
 ## Features
--   automatic, self-invalidating relationship (both eager- and lazy-loaded) caching.
+-   automatic, self-invalidating relationship (only eager-loading) caching.
 -   automatic, self-invalidating model query caching.
 -   automatic use of cache tags for cache providers that support them (will
     flush entire cache for providers that don't).
@@ -148,6 +148,9 @@ This comes in handy when manually making updates to the database. You could also
 trigger this after making updates to the database from sources outside your
 Laravel app.
 
+## Planned Features
+- [ ] [caching of lazy-loaded relationships, see #127](https://github.com/GeneaLabs/laravel-model-caching/issues/127).
+
 ## Summary
 **That's all you need to do. All model queries and relationships are now
 cached!**

src/CacheKey.php

@@ -39,7 +39,7 @@ public function make(
         $key .= $this->getOffsetClause();
         $key .= $this->getLimitClause();
         $key .= $keyDifferentiator;
-
+dump($key);
         return $key;
     }
 

src/CacheTags.php

@@ -37,7 +37,7 @@ public function make() : array
             ->prepend($this->getTagName())
             ->values()
             ->toArray();
-
+// dump($tags);
         return $tags;
     }
 

tests/Fixtures/UncachedBook.php

@@ -28,6 +28,6 @@ public function publisher() : BelongsTo
 
     public function stores() : BelongsToMany
     {
-        return $this->belongsToMany(UncachedStore::class);
+        return $this->belongsToMany(UncachedStore::class, "book_store", "book_id", "store_id");
     }
 }

tests/Integration/CachedBuilder/LazyLoadTest.php

@@ -0,0 +1,49 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\CachedBuilder;
+
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Book;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Profile;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Publisher;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Store;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedBook;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedProfile;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedPublisher;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedStore;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Http\Resources\Author as AuthorResource;
+use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Collection;
+
+class LazyLoadTest extends IntegrationTestCase
+{
+    use RefreshDatabase;
+
+    /** @group test */
+    public function testLazyLoadingRelationshipQuery()
+    {
+        $key = sha1('genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesbook-id_<_5');
+        $tags = [
+            'genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesbook',
+        ];
+        $book = (new Book)
+            ->first();
+
+dump("start");
+        $stores = $book->stores;
+dump("end");
+        dd($stores);
+        $cachedResults = $this
+            ->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+        $liveResults = (new UncachedBook)
+            ->when(true, function ($query) {
+                $query->where("id", "<", 5);
+            })
+            ->get();
+
+        $this->assertEquals($liveResults->pluck("id"), $books->pluck("id"));
+        $this->assertEquals($liveResults->pluck("id"), $cachedResults->pluck("id"));
+    }
+}

tests/Integration/CachedBuilder/WhenTest.php

@@ -0,0 +1,47 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\CachedBuilder;
+
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Book;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Profile;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Publisher;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Store;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedBook;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedProfile;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedPublisher;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedStore;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Http\Resources\Author as AuthorResource;
+use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Collection;
+
+class WhenTest extends IntegrationTestCase
+{
+    use RefreshDatabase;
+
+    public function testWhenQuery()
+    {
+        $key = sha1('genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesbook-id_<_5');
+        $tags = [
+            'genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesbook',
+        ];
+
+        $books = (new Book)
+            ->when(true, function ($query) {
+                $query->where("id", "<", 5);
+            })
+            ->get();
+        $cachedResults = $this
+            ->cache()
+            ->tags($tags)
+            ->get($key)['value'];
+        $liveResults = (new UncachedBook)
+            ->when(true, function ($query) {
+                $query->where("id", "<", 5);
+            })
+            ->get();
+
+        $this->assertEquals($liveResults->pluck("id"), $books->pluck("id"));
+        $this->assertEquals($liveResults->pluck("id"), $cachedResults->pluck("id"));
+    }
+}

tests/Integration/CachedBuilder/WithTest.php

@@ -62,4 +62,30 @@ public function testMultiLevelWithQuery()
         $this->assertEquals($uncachedAuthor->books()->count(), $author->books()->count());
         $this->assertEquals($uncachedAuthor->id, $author->id);
     }
+
+    public function testWithBelongsToManyRelationshipQuery()
+    {
+        $key = sha1('genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesbook-books.id_=_3-stores-first');
+        $tags = [
+            'genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesbook',
+            'genealabs:laravel-model-caching:testing::memory::genealabslaravelmodelcachingtestsfixturesstore',
+        ];
+
+        $stores = (new Book)
+            ->with("stores")
+            ->find(3)
+            ->stores;
+        $cachedResults = $this
+            ->cache()
+            ->tags($tags)
+            ->get($key)['value']
+            ->stores;
+        $liveResults = (new UncachedBook)
+            ->with("stores")
+            ->find(3)
+            ->stores;
+
+        $this->assertEquals($liveResults->pluck("id"), $stores->pluck("id"));
+        $this->assertEquals($liveResults->pluck("id"), $cachedResults->pluck("id"));
+    }
 }