[Feature] Add multi-pagination support

lindyhopchris · lindyhopchris · commit 916f1b63d19a · 2023-01-31T21:35:27.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## Unreleased
+
+### Added
+
+- New `MultiPaginator` that allows a schema to offer multiple different pagination strategies.
+
 ## [2.5.2] - 2023-01-25
 
 ### Fixed
diff --git a/composer.json b/composer.json
@@ -26,14 +26,15 @@
         "php": "^7.4|^8.0",
         "ext-json": "*",
         "laravel-json-api/core": "^2.4",
-        "laravel-json-api/eloquent": "^2.2.1",
+        "laravel-json-api/eloquent": "dev-release/2.3.0 as 2.3.0",
         "laravel-json-api/encoder-neomerx": "^2.0.1",
         "laravel-json-api/exceptions": "^1.1.1",
         "laravel-json-api/spec": "^1.2",
         "laravel-json-api/validation": "^2.1.2",
         "laravel/framework": "^8.76|^9.0"
     },
     "require-dev": {
+        "laravel-json-api/cursor-pagination": "^2.1",
         "laravel-json-api/testing": "^1.1.2",
         "orchestra/testbench": "^6.23|^7.0",
         "phpunit/phpunit": "^9.5.10"
diff --git a/tests/dummy/app/JsonApi/V1/Posts/PostSchema.php b/tests/dummy/app/JsonApi/V1/Posts/PostSchema.php
@@ -20,6 +20,7 @@
 namespace App\JsonApi\V1\Posts;
 
 use App\Models\Post;
+use LaravelJsonApi\CursorPagination\CursorPagination;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
 use LaravelJsonApi\Eloquent\Fields\Relations\BelongsTo;
@@ -32,14 +33,14 @@
 use LaravelJsonApi\Eloquent\Filters\Scope;
 use LaravelJsonApi\Eloquent\Filters\Where;
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
+use LaravelJsonApi\Eloquent\Pagination\MultiPagination;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Schema;
 use LaravelJsonApi\Eloquent\SoftDeletes;
 use LaravelJsonApi\Eloquent\Sorting\SortCountable;
 
 class PostSchema extends Schema
 {
-
     use SoftDeletes;
 
     /**
@@ -112,9 +113,11 @@ public function sortables(): iterable
     /**
      * @inheritDoc
      */
-    public function pagination(): PagePagination
+    public function pagination(): MultiPagination
     {
-        return PagePagination::make()->withoutNestedMeta();
+        return new MultiPagination(
+            PagePagination::make()->withoutNestedMeta(),
+            CursorPagination::make($this->id())->withoutNestedMeta(),
+        );
     }
-
 }
diff --git a/tests/dummy/tests/Api/V1/Posts/IndexTest.php b/tests/dummy/tests/Api/V1/Posts/IndexTest.php
@@ -79,7 +79,7 @@ public function testWithUser(): void
         $response->assertFetchedMany($expected);
     }
 
-    public function testPaginated(): void
+    public function testPagePagination(): void
     {
         $posts = Post::factory()->count(5)->create();
 
@@ -116,7 +116,51 @@ public function testPaginated(): void
             ->page(['number' => 1, 'size' => 3])
             ->get('/api/v1/posts');
 
-        $response->assertFetchedMany($expected)
+        $response
+            ->assertFetchedMany($expected)
+            ->assertMeta($meta)
+            ->assertLinks($links);
+    }
+
+    public function testCursorPagination(): void
+    {
+        $posts = Post::factory()->count(5)->create([
+            'created_at' => fn() => fake()->dateTime(),
+        ])->sortByDesc('created_at')->values();
+
+        $expected = $this->identifiersFor('posts', $posts->take(3));
+
+        $meta = [
+            'from' => $expected[0]['id'],
+            'hasMore' => true,
+            'perPage' => 3,
+            'to' => $expected[2]['id'],
+        ];
+
+        $links = [
+            'first' => 'http://localhost/api/v1/posts?' . Arr::query([
+                    'page' => ['limit' => 3],
+                    'sort' => '-createdAt',
+                ]),
+            'next' => 'http://localhost/api/v1/posts?' . Arr::query([
+                    'page' => ['after' => $expected[2]['id'], 'limit' => 3],
+                    'sort' => '-createdAt',
+                ]),
+            'prev' => 'http://localhost/api/v1/posts?' . Arr::query([
+                    'page' => ['before' => $expected[0]['id'], 'limit' => 3],
+                    'sort' => '-createdAt',
+                ]),
+        ];
+
+        $response = $this
+            ->withoutExceptionHandling()
+            ->jsonApi()
+            ->expects('posts')
+            ->page(['limit' => 3])
+            ->get('/api/v1/posts');
+
+        $response
+            ->assertFetchedMany($expected)
             ->assertMeta($meta)
             ->assertLinks($links);
     }
