Merge pull request #69 from NizarBerjawi/main

Append query parameters to URLs when using cursor pagination

Author: freekmurze

.phpunit.result.cache

@@ -1 +1 @@
-{"version":1,"defects":{"\/Users\/alexandrumanase\/Documents\/repos\/laravel-json-api-paginate\/tests\/BuilderTest.php::it":4},"times":{"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_paginate_records":0.073,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_paginate_records_with_cursor":0.071,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_returns_the_amount_of_records_specified_in_the_config_file":0.005,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_returns_the_amount_of_records_specified_in_the_config_file_using_cursor":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_return_the_specified_amount_of_records":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_return_the_specified_amount_of_records_with_cursor":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_will_not_return_more_records_that_the_configured_maximum":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_set_a_custom_base_url_in_the_config_file":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_simple_pagination":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_cursor_pagination":0.005,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_base_query_builder":0.005,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_base_query_builder_with_cursor_pagination":0.004,"\/Users\/alexandrumanase\/Documents\/repos\/laravel-json-api-paginate\/tests\/BuilderTest.php::it":0.004,"\/Users\/alexandrumanase\/Documents\/repos\/laravel-json-api-paginate\/tests\/RequestTest.php::it":0.006}}
+{"version":1,"defects":{"\/Users\/alexandrumanase\/Documents\/repos\/laravel-json-api-paginate\/tests\/BuilderTest.php::it":4},"times":{"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_paginate_records":0.073,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_paginate_records_with_cursor":0.071,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_returns_the_amount_of_records_specified_in_the_config_file":0.005,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_returns_the_amount_of_records_specified_in_the_config_file_using_cursor":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_return_the_specified_amount_of_records":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_return_the_specified_amount_of_records_with_cursor":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_will_not_return_more_records_that_the_configured_maximum":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_set_a_custom_base_url_in_the_config_file":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_simple_pagination":0.004,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_cursor_pagination":0.005,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_base_query_builder":0.005,"Spatie\\JsonApiPaginate\\Test\\BuilderTest::it_can_use_base_query_builder_with_cursor_pagination":0.004,"\/Users\/alexandrumanase\/Documents\/repos\/laravel-json-api-paginate\/tests\/BuilderTest.php::it":0.004,"\/Users\/alexandrumanase\/Documents\/repos\/laravel-json-api-paginate\/tests\/RequestTest.php::it":0.006,"\/var\/www\/html\/tests\/BuilderTest.php::it":0.013,"\/var\/www\/html\/tests\/RequestTest.php::it":0.017}}

src/JsonApiPaginateServiceProvider.php

@@ -51,6 +51,7 @@ protected function registerMacro()
 
             $paginator = $paginationMethod === 'cursorPaginate'
                 ? $this->{$paginationMethod}($size, ['*'], $paginationParameter.'['.$cursorParameter.']', $cursor)
+                    ->appends(Arr::except(request()->input(), $paginationParameter.'.'.$cursorParameter))
                 : $this
                     ->{$paginationMethod}($size, ['*'], $paginationParameter.'.'.$numberParameter)
                     ->setPageName($paginationParameter.'['.$numberParameter.']')

tests/RequestTest.php

@@ -38,7 +38,10 @@
 
 it('will use the configured size parameter for cursor')
     ->get('cursor/?page[size]=10')
-    ->assertJsonFragment(['next_cursor' => 'eyJpZCI6MTAsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0']);
+    ->assertJsonFragment([
+        'per_page' => 10,
+        'next_cursor' => 'eyJpZCI6MTAsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0'
+    ]);
 
 it('will use default size when page size is 0', function () {
     $default_size = config('json-api-paginate.default_size');
@@ -63,3 +66,21 @@
 
     $response->assertJsonFragment(['per_page' => $default_size]);
 });
+
+it('will append other parameters to urls', function() {
+    $response = $this->get('/?page[size]=10&page[number]=3');
+
+    $response->assertJsonFragment([
+        'next_page_url' => url('/?page%5Bsize%5D=10&page%5Bnumber%5D=4'),
+        'prev_page_url' => url('/?page%5Bsize%5D=10&page%5Bnumber%5D=2'),
+    ]);
+});
+
+it('will append other parameters to urls for cursor', function() {
+    $response = $this->get('cursor/?page[size]=10&page[cursor]=eyJpZCI6MTAsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0');
+    
+    $response->assertJsonFragment([
+        'next_page_url' => url('cursor/?page%5Bsize%5D=10&page%5Bcursor%5D=eyJpZCI6MjAsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0'),
+        'prev_page_url' => url('cursor/?page%5Bsize%5D=10&page%5Bcursor%5D=eyJpZCI6MTEsIl9wb2ludHNUb05leHRJdGVtcyI6ZmFsc2V9'),
+    ]);
+});