Merge branch 'feature/multi-pagination' into develop

Author: lindyhopchris

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

composer.json

@@ -26,7 +26,7 @@
         "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",

tests/dummy/app/JsonApi/V1/Posts/PostSchema.php

@@ -32,14 +32,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 +112,15 @@ public function sortables(): iterable
     /**
      * @inheritDoc
      */
-    public function pagination(): PagePagination
+    public function pagination(): MultiPagination
     {
-        return PagePagination::make()->withoutNestedMeta();
+        return new MultiPagination(
+            PagePagination::make()->withoutNestedMeta(),
+            PagePagination::make()
+                ->withoutNestedMeta()
+                ->withSimplePagination()
+                ->withPageKey('current-page')
+                ->withPerPageKey('per-page')
+        );
     }
-
 }

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,9 +116,52 @@ public function testPaginated(): void
             ->page(['number' => 1, 'size' => 3])
             ->get('/api/v1/posts');
 
-        $response->assertFetchedMany($expected)
+        $response
+            ->assertFetchedMany($expected)
             ->assertMeta($meta)
-            ->assertLinks($links);
+            ->assertExactLinks($links);
+    }
+
+    public function testMultiPagination(): void
+    {
+        $posts = Post::factory()->count(6)->create([
+            'created_at' => fn() => fake()->dateTime(),
+        ])->sortByDesc('created_at')->values();
+
+        $expected = $this->identifiersFor('posts', $posts->skip(2)->take(2));
+
+        $meta = [
+            'currentPage' => 2,
+            'from' => 3,
+            'perPage' => 2,
+            'to' => 4,
+        ];
+
+        $links = [
+            'first' => 'http://localhost/api/v1/posts?' . Arr::query([
+                    'page' => ['current-page' => 1, 'per-page' => 2],
+                    'sort' => '-createdAt',
+                ]),
+            'next' => 'http://localhost/api/v1/posts?' . Arr::query([
+                    'page' => ['current-page' => 3, 'per-page' => 2],
+                    'sort' => '-createdAt',
+                ]),
+            'prev' => 'http://localhost/api/v1/posts?' . Arr::query([
+                    'page' => ['current-page' => 1, 'per-page' => 2],
+                    'sort' => '-createdAt',
+                ]),
+        ];
+
+        $response = $this
+            ->jsonApi()
+            ->expects('posts')
+            ->page(['current-page' => 2, 'per-page' => 2])
+            ->get('/api/v1/posts');
+
+        $response
+            ->assertFetchedMany($expected)
+            ->assertMeta($meta)
+            ->assertExactLinks($links);
     }
 
     public function testIncludeAuthor(): void