Add jsonPaginate to Builder (query builder) + tests

Author: d8vjork

.gitignore

@@ -1,3 +1,4 @@
 /vendor/
 composer.lock
 .phpunit.result.cache
+phpunit.xml

phpunit.xml.dist

@@ -24,5 +24,7 @@
   </testsuites>
   <php>
     <ini name="memory_limit" value="2048M"/>
+    <server name="DB_CONNECTION" value="sqlite" force="true"/>
+    <server name="DB_DATABASE" value=":memory:" force="true"/>
   </php>
 </phpunit>

src/Builder.php

@@ -2,30 +2,30 @@
 
 namespace SkoreLabs\JsonApi;
 
+/**
+ * @mixin \Illuminate\Database\Query\Builder
+ */
 class Builder
 {
-    /**
-     * Paginate the given query using Json API.
-     *
-     * @param array $columns
-     *
-     * @throws \InvalidArgumentException
-     *
-     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
-     */
     public function jsonPaginate()
     {
+        /**
+         * Paginate the given query using JSON:API.
+         *
+         * @param int|string $perPage
+         * @param array $columns
+         *
+         * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+         */
         return function ($perPage = null, $columns = ['*']) {
-            return function () use ($columns, $perPage) {
-                $perPage = $perPage ?: $this->model->getPerPage();
-                $clientPerPage = (int) request('page.size', config('json-api.pagination.default_size'));
+            $perPage = $perPage ?: $this->model->getPerPage();
+            $clientPerPage = (int) request('page.size', config('json-api.pagination.default_size'));
+            
+            if (!$perPage || $perPage < $clientPerPage) {
+                $perPage = $clientPerPage;
+            }
 
-                if (!$perPage || $perPage < $clientPerPage) {
-                    $perPage = $clientPerPage;
-                }
-
-                return $this->paginate($perPage, $columns, 'page[number]', (int) request('page.number'));
-            };
+            return $this->paginate($perPage, $columns, 'page[number]', (int) request('page.number'));
         };
     }
 }

src/JsonApiServiceProvider.php

@@ -2,7 +2,7 @@
 
 namespace SkoreLabs\JsonApi;
 
-use Illuminate\Database\Query\Builder;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Foundation\Testing\TestResponse;
 use Illuminate\Support\ServiceProvider;
 use SkoreLabs\JsonApi\Builder as JsonApiBuilder;
@@ -22,8 +22,6 @@ public function boot()
                 __DIR__.'/../config/json-api.php' => config_path('json-api.php'),
             ], 'config');
         }
-
-        Builder::mixin(new JsonApiBuilder());
     }
 
     /**
@@ -33,6 +31,8 @@ public function boot()
      */
     public function register()
     {
+        Builder::mixin(new JsonApiBuilder());
+
         $this->mergeConfigFrom(__DIR__.'/../config/json-api.php', 'json-api');
 
         if (class_exists(TestResponse::class)) {

src/Testing/Assert.php

@@ -65,6 +65,7 @@ public static function fromTestResponse($response)
     {
         try {
             $content = json_decode($response->getContent(), true);
+            PHPUnit::assertArrayHasKey('data', $content);
             $data = $content['data'];
             $collection = [];
 

tests/JsonApiCollectionTest.php

@@ -59,6 +59,7 @@ public function testCollectionsAtHasAttribute()
     {
         $this->get('/', ['Accept' => 'application/json'])->assertJsonApi(function (Assert $json) {
             $json->at(0)->hasAttribute('title', 'Test Title');
+
             $json->at(1)->hasAttribute('title', 'Test Title 2');
         });
     }

tests/JsonApiPaginationTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace SkoreLabs\JsonApi\Tests;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Route;
+use SkoreLabs\JsonApi\Http\Resources\JsonApiCollection;
+use SkoreLabs\JsonApi\Testing\Assert;
+use SkoreLabs\JsonApi\Tests\Fixtures\Post;
+
+/**
+ * @group requiresDatabase
+ */
+class JsonApiPaginationTest extends TestCase
+{
+    use RefreshDatabase;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        Route::get('/posts', function () {
+            Post::create(['title' => 'Test Title']);
+            Post::create(['title' => 'Test Title 2']);
+            Post::create(['title' => 'Test Title 3']);
+            Post::create(['title' => 'Test Title 4']);
+
+            return JsonApiCollection::make(Post::jsonPaginate(1), true);
+        });
+    }
+
+    protected function defineDatabaseMigrations()
+    {
+        $this->loadMigrationsFrom(__DIR__ . '/database/migrations');
+    }
+
+    public function testJsonApiPaginationWithPageSize()
+    {
+        $response = $this->getJson('/posts?page[size]=2');
+        
+        $response->assertJsonApi(function (Assert $json) {
+            $json->hasSize(2);
+        });
+
+        $response->assertStatus(200);
+    }
+}

tests/database/migrations/0000_00_00_000000_create_posts_table.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreatePostsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('posts', static function (Blueprint $table) {
+            $table->bigInteger('id')->primary();
+            $table->string('title');
+            $table->unsignedBigInteger('parent_id')->nullable();
+            $table->timestamps();
+
+            $table->foreign('parent_id')->references('id')->on('posts');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('posts');
+    }
+}