Merge pull request #532 from francoism90/master

Add LengthAwarePaginator to QueryBuilder

Author: freekmurze

src/QueryBuilder.php

@@ -7,6 +7,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Traits\ForwardsCalls;
 use Spatie\QueryBuilder\Concerns\AddsFieldsToQuery;
@@ -113,6 +114,10 @@ public function __call($name, $arguments)
             $this->addAppendsToResults($result);
         }
 
+        if ($result instanceof LengthAwarePaginator) {
+            $this->addAppendsToResults(collect($result->items()));
+        }
+
         return $result;
     }
 

tests/AppendTest.php

@@ -2,7 +2,10 @@
 
 namespace Spatie\QueryBuilder\Tests;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Collection;
 use Spatie\QueryBuilder\Exceptions\InvalidAppendQuery;
 use Spatie\QueryBuilder\QueryBuilder;
 use Spatie\QueryBuilder\Tests\TestClasses\Models\AppendModel;
@@ -48,6 +51,28 @@ public function it_can_append_case_insensitive()
         $this->assertAttributeLoaded($model, 'fullname');
     }
 
+    /** @test */
+    public function it_can_append_collections()
+    {
+        $models = $this
+            ->createQueryFromAppendRequest('FullName')
+            ->allowedAppends('fullname')
+            ->get();
+
+        $this->assertCollectionAttributeLoaded($models, 'fullname');
+    }
+
+    /** @test */
+    public function it_can_append_paginates()
+    {
+        $models = $this
+            ->createQueryFromAppendRequest('FullName')
+            ->allowedAppends('fullname')
+            ->paginate();
+
+        $this->assertPaginateAttributeLoaded($models, 'fullname');
+    }
+
     /** @test */
     public function it_guards_against_invalid_appends()
     {
@@ -114,4 +139,24 @@ protected function assertAttributeLoaded(AppendModel $model, string $attribute)
     {
         $this->assertTrue(array_key_exists($attribute, $model->toArray()));
     }
+
+    protected function assertCollectionAttributeLoaded(Collection $collection, string $attribute)
+    {
+        $hasModelWithoutAttributeLoaded = $collection
+            ->contains(function (Model $model) use ($attribute) {
+                return ! array_key_exists($attribute, $model->toArray());
+            });
+
+        $this->assertFalse($hasModelWithoutAttributeLoaded, "The `{$attribute}` attribute was expected but not loaded.");
+    }
+
+    protected function assertPaginateAttributeLoaded(LengthAwarePaginator $collection, string $attribute)
+    {
+        $hasModelWithoutAttributeLoaded = $collection
+            ->contains(function (Model $model) use ($attribute) {
+                return ! array_key_exists($attribute, $model->toArray());
+            });
+
+        $this->assertFalse($hasModelWithoutAttributeLoaded, "The `{$attribute}` attribute was expected but not loaded.");
+    }
 }