Add support for cursor pagination

Author: AlexVanderbist

src/Concerns/AppendsAttributesToResults.php

@@ -3,6 +3,7 @@
 namespace Spatie\QueryBuilder\Concerns;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Pagination\Cursor;
 use Illuminate\Support\Collection;
 use Spatie\QueryBuilder\Exceptions\InvalidAppendQuery;
 
@@ -29,6 +30,13 @@ protected function addAppendsToResults(Collection $results)
         });
     }
 
+    protected function addAppendsToCursor( $results)
+    {
+        return $results->each(function (Model $result) {
+            return $result->append($this->request->appends()->toArray());
+        });
+    }
+
     protected function ensureAllAppendsExist()
     {
         $appends = $this->request->appends();

src/QueryBuilder.php

@@ -3,6 +3,7 @@
 namespace Spatie\QueryBuilder;
 
 use ArrayAccess;
+use Illuminate\Contracts\Pagination\CursorPaginator;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
@@ -125,7 +126,7 @@ public function __call($name, $arguments)
             $this->addAppendsToResults($result);
         }
 
-        if ($result instanceof LengthAwarePaginator || $result instanceof Paginator) {
+        if ($result instanceof LengthAwarePaginator || $result instanceof Paginator || $result instanceof CursorPaginator) {
             $this->addAppendsToResults(collect($result->items()));
         }
 

tests/AppendTest.php

@@ -73,6 +73,28 @@ public function it_can_append_paginates()
         $this->assertPaginateAttributeLoaded($models, 'FullName');
     }
 
+    /** @test */
+    public function it_can_append_simple_paginates()
+    {
+        $models = $this
+            ->createQueryFromAppendRequest('FullName')
+            ->allowedAppends('FullName')
+            ->simplePaginate();
+
+        $this->assertPaginateAttributeLoaded($models, 'FullName');
+    }
+
+    /** @test */
+    public function it_can_append_cursor_paginates()
+    {
+        $models = $this
+            ->createQueryFromAppendRequest('FullName')
+            ->allowedAppends('FullName')
+            ->cursorPaginate();
+
+        $this->assertPaginateAttributeLoaded($models, 'FullName');
+    }
+
     /** @test */
     public function it_guards_against_invalid_appends()
     {
@@ -150,7 +172,11 @@ protected function assertCollectionAttributeLoaded(Collection $collection, strin
         $this->assertFalse($hasModelWithoutAttributeLoaded, "The `{$attribute}` attribute was expected but not loaded.");
     }
 
-    protected function assertPaginateAttributeLoaded(LengthAwarePaginator $collection, string $attribute)
+    /**
+     * @param \Illuminate\Pagination\LengthAwarePaginator|\Illuminate\Contracts\Pagination\Paginator $collection
+     * @param string $attribute
+     */
+    protected function assertPaginateAttributeLoaded($collection, string $attribute)
     {
         $hasModelWithoutAttributeLoaded = $collection
             ->contains(function (Model $model) use ($attribute) {