From 70375f81394f918a4c454b5f6bc982189b3013e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Munsch?= Date: Fri, 14 Aug 2026 12:02:13 +0200 Subject: [PATCH] feat(dto): implement PaginationDto for pagination metadata Added PaginationDto to handle pagination details and links for API responses. Updated related response classes to utilize the new PaginationDto. --- .../Api/V1/Contracts/ApiResponseDto.php | 7 ++- .../Api/V1/Dto/Employees/EmployeeDto.php | 8 +++ .../V1/Dto/Employees/PaginatedEmployee.php | 8 +++ .../Api/V1/Dto/IncoSheets/IncoSheetDto.php | 9 +++ .../V1/Dto/IncoSheets/IncoShortSheetDto.php | 8 +++ src/Presentation/Api/V1/Dto/PaginationDto.php | 58 +++++++++++++++++++ .../Employees/EmployeeShowResponse.php | 4 +- .../Employees/EmployeesIndexResponse.php | 35 +++-------- .../IncoSheets/IncoSheetsIndexResponse.php | 37 ++++-------- .../IncoSheets/IncoSheetsShowResponse.php | 4 +- .../Api/V1/Dto/PaginationDtoTest.php | 53 +++++++++++++++++ 11 files changed, 172 insertions(+), 59 deletions(-) create mode 100644 src/Presentation/Api/V1/Dto/PaginationDto.php create mode 100644 tests/Unit/Presentation/Api/V1/Dto/PaginationDtoTest.php diff --git a/src/Presentation/Api/V1/Contracts/ApiResponseDto.php b/src/Presentation/Api/V1/Contracts/ApiResponseDto.php index 415fd6f..be98788 100644 --- a/src/Presentation/Api/V1/Contracts/ApiResponseDto.php +++ b/src/Presentation/Api/V1/Contracts/ApiResponseDto.php @@ -4,6 +4,11 @@ declare(strict_types=1); namespace Presentation\Api\V1\Contracts; -interface ApiResponseDto +use Illuminate\Contracts\Support\Arrayable; + +/** + * @extends Arrayable + */ +interface ApiResponseDto extends Arrayable { } diff --git a/src/Presentation/Api/V1/Dto/Employees/EmployeeDto.php b/src/Presentation/Api/V1/Dto/Employees/EmployeeDto.php index bb40a05..8472cc9 100644 --- a/src/Presentation/Api/V1/Dto/Employees/EmployeeDto.php +++ b/src/Presentation/Api/V1/Dto/Employees/EmployeeDto.php @@ -36,4 +36,12 @@ final readonly class EmployeeDto implements ApiResponseDto plannedEndDate: $view->plannedEndDate?->format('Y-m-d'), ); } + + /** @return array */ + #[\Override] + public function toArray(): array + { + /** @var array */ + return get_object_vars($this); + } } diff --git a/src/Presentation/Api/V1/Dto/Employees/PaginatedEmployee.php b/src/Presentation/Api/V1/Dto/Employees/PaginatedEmployee.php index bfa5944..fce4c9e 100644 --- a/src/Presentation/Api/V1/Dto/Employees/PaginatedEmployee.php +++ b/src/Presentation/Api/V1/Dto/Employees/PaginatedEmployee.php @@ -36,4 +36,12 @@ final readonly class PaginatedEmployee implements ApiResponseDto plannedEndDate: $employee->plannedEndDate?->format('Y-m-d'), ); } + + /** @return array */ + #[\Override] + public function toArray(): array + { + /** @var array */ + return get_object_vars($this); + } } diff --git a/src/Presentation/Api/V1/Dto/IncoSheets/IncoSheetDto.php b/src/Presentation/Api/V1/Dto/IncoSheets/IncoSheetDto.php index 0d2a4ca..275d6a1 100644 --- a/src/Presentation/Api/V1/Dto/IncoSheets/IncoSheetDto.php +++ b/src/Presentation/Api/V1/Dto/IncoSheets/IncoSheetDto.php @@ -14,6 +14,7 @@ final readonly class IncoSheetDto implements ApiResponseDto { /** * @param array{allegations: array, health: array, nutrition: array, other: array} $allegations + * @param object $ingredients * @param array{lowPart: int, highPart: int, approximative: bool}|null $portions * @param array $allergens * @param array{code: string, label: string} $brand @@ -158,4 +159,12 @@ final readonly class IncoSheetDto implements ApiResponseDto updatedAt: $sheet->updatedAt?->format(\DateTimeInterface::ATOM), ); } + + /** @return array */ + #[\Override] + public function toArray(): array + { + /** @var array */ + return get_object_vars($this); + } } diff --git a/src/Presentation/Api/V1/Dto/IncoSheets/IncoShortSheetDto.php b/src/Presentation/Api/V1/Dto/IncoSheets/IncoShortSheetDto.php index 78f4fa4..7f3d56d 100644 --- a/src/Presentation/Api/V1/Dto/IncoSheets/IncoShortSheetDto.php +++ b/src/Presentation/Api/V1/Dto/IncoSheets/IncoShortSheetDto.php @@ -28,4 +28,12 @@ final readonly class IncoShortSheetDto implements ApiResponseDto updatedAt: $sheet->updatedAt?->format(\DateTimeInterface::ATOM), ); } + + /** @return array */ + #[\Override] + public function toArray(): array + { + /** @var array */ + return get_object_vars($this); + } } diff --git a/src/Presentation/Api/V1/Dto/PaginationDto.php b/src/Presentation/Api/V1/Dto/PaginationDto.php new file mode 100644 index 0000000..87571f5 --- /dev/null +++ b/src/Presentation/Api/V1/Dto/PaginationDto.php @@ -0,0 +1,58 @@ + 0 ? (int) ceil($totalItems / $pageSize) : 1; + + $firstUrl = (string) $baseUri->withQuery(http_build_query(['page' => 1, 'pageSize' => $pageSize])); + $lastUrl = (string) $baseUri->withQuery(http_build_query(['page' => $totalPages, 'pageSize' => $pageSize])); + $selfUrl = (string) $baseUri->withQuery(http_build_query(['page' => $page, 'pageSize' => $pageSize])); + $prevUrl = $page > 1 ? (string) $baseUri->withQuery(http_build_query(['page' => $page - 1, 'pageSize' => $pageSize])) : null; + $nextUrl = $page < $totalPages ? (string) $baseUri->withQuery(http_build_query(['page' => $page + 1, 'pageSize' => $pageSize])) : null; + + return new self( + page: $page, + pageSize: $pageSize, + totalItems: $totalItems, + totalPages: $totalPages, + links: [ + 'self' => $selfUrl, + 'first' => $firstUrl, + 'prev' => $prevUrl, + 'next' => $nextUrl, + 'last' => $lastUrl, + ], + ); + } + + /** @return array */ + #[\Override] + public function toArray(): array + { + /** @var array $vars */ + $vars = get_object_vars($this); + + return $vars; + } +} diff --git a/src/Presentation/Api/V1/Http/Responses/Employees/EmployeeShowResponse.php b/src/Presentation/Api/V1/Http/Responses/Employees/EmployeeShowResponse.php index 4c0cf48..52476c3 100644 --- a/src/Presentation/Api/V1/Http/Responses/Employees/EmployeeShowResponse.php +++ b/src/Presentation/Api/V1/Http/Responses/Employees/EmployeeShowResponse.php @@ -25,10 +25,8 @@ final readonly class EmployeeShowResponse implements ApiResponse #[\Override] public function present(): JsonResponse { - $dto = EmployeeDto::fromView($this->view); - return response()->json([ - 'employee' => get_object_vars($dto), + 'employee' => EmployeeDto::fromView($this->view), ]); } } diff --git a/src/Presentation/Api/V1/Http/Responses/Employees/EmployeesIndexResponse.php b/src/Presentation/Api/V1/Http/Responses/Employees/EmployeesIndexResponse.php index 1dcae08..0b3e1c8 100644 --- a/src/Presentation/Api/V1/Http/Responses/Employees/EmployeesIndexResponse.php +++ b/src/Presentation/Api/V1/Http/Responses/Employees/EmployeesIndexResponse.php @@ -9,6 +9,7 @@ use Illuminate\Http\JsonResponse; use League\Uri\Http; use Presentation\Api\V1\Contracts\ApiResponse; use Presentation\Api\V1\Dto\Employees\PaginatedEmployee as PaginatedEmployeeDto; +use Presentation\Api\V1\Dto\PaginationDto; use Presentation\Api\V1\Presenters\Employees\EmployeesIndexView; final readonly class EmployeesIndexResponse implements ApiResponse @@ -28,37 +29,19 @@ final readonly class EmployeesIndexResponse implements ApiResponse #[\Override] public function present(): JsonResponse { - $page = $this->view->page; - $pageSize = $this->view->perPage; - $totalItems = $this->view->total; - $totalPages = $pageSize > 0 ? (int) ceil($totalItems / $pageSize) : 1; - - $firstUrl = (string) $this->baseUri->withQuery(http_build_query(['page' => 1, 'pageSize' => $pageSize])); - $lastUrl = (string) $this->baseUri->withQuery(http_build_query(['page' => $totalPages, 'pageSize' => $pageSize])); - $selfUrl = (string) $this->baseUri->withQuery(http_build_query(['page' => $page, 'pageSize' => $pageSize])); - $prevUrl = $page > 1 ? (string) $this->baseUri->withQuery(http_build_query(['page' => $page - 1, 'pageSize' => $pageSize])) : null; - $nextUrl = $page < $totalPages ? (string) $this->baseUri->withQuery(http_build_query(['page' => $page + 1, 'pageSize' => $pageSize])) : null; + $pagination = PaginationDto::create( + page: $this->view->page, + pageSize: $this->view->perPage, + totalItems: $this->view->total, + baseUri: $this->baseUri, + ); return response()->json([ 'employees' => array_map( - static fn (PaginatedEmployee $employee): array => get_object_vars( - PaginatedEmployeeDto::fromUsecase($employee) - ), + static fn (PaginatedEmployee $employee): array => PaginatedEmployeeDto::fromUsecase($employee)->toArray(), $this->view->employees ), - 'pagination' => [ - 'page' => $page, - 'pageSize' => $pageSize, - 'totalItems' => $totalItems, - 'totalPages' => $totalPages, - 'links' => [ - 'self' => $selfUrl, - 'first' => $firstUrl, - 'prev' => $prevUrl, - 'next' => $nextUrl, - 'last' => $lastUrl, - ], - ], + 'pagination' => $pagination, ]); } } diff --git a/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsIndexResponse.php b/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsIndexResponse.php index f6ac506..d8dd943 100644 --- a/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsIndexResponse.php +++ b/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsIndexResponse.php @@ -11,6 +11,7 @@ use League\Uri\Http; use Presentation\Api\V1\Contracts\ApiResponse; use Presentation\Api\V1\Dto\IncoSheets\IncoSheetDto; use Presentation\Api\V1\Dto\IncoSheets\IncoShortSheetDto; +use Presentation\Api\V1\Dto\PaginationDto; use Presentation\Api\V1\Presenters\IncoSheets\IncoSheetsIndexView; final readonly class IncoSheetsIndexResponse implements ApiResponse @@ -30,39 +31,23 @@ final readonly class IncoSheetsIndexResponse implements ApiResponse #[\Override] public function present(): JsonResponse { - $page = $this->view->page; - $pageSize = $this->view->perPage; - $totalItems = $this->view->total; - $totalPages = $pageSize > 0 ? (int) ceil($totalItems / $pageSize) : 1; - - $firstUrl = (string) $this->baseUri->withQuery(http_build_query(['page' => 1, 'pageSize' => $pageSize])); - $lastUrl = (string) $this->baseUri->withQuery(http_build_query(['page' => $totalPages, 'pageSize' => $pageSize])); - $selfUrl = (string) $this->baseUri->withQuery(http_build_query(['page' => $page, 'pageSize' => $pageSize])); - $prevUrl = $page > 1 ? (string) $this->baseUri->withQuery(http_build_query(['page' => $page - 1, 'pageSize' => $pageSize])) : null; - $nextUrl = $page < $totalPages ? (string) $this->baseUri->withQuery(http_build_query(['page' => $page + 1, 'pageSize' => $pageSize])) : null; + $pagination = PaginationDto::create( + page: $this->view->page, + pageSize: $this->view->perPage, + totalItems: $this->view->total, + baseUri: $this->baseUri, + ); $items = array_map( - fn (PaginatedIncoSheet | PaginatedShortIncoSheet $sheet): array => $sheet instanceof PaginatedShortIncoSheet - ? get_object_vars(IncoShortSheetDto::fromPaginatedShortIncoSheet($sheet)) - : get_object_vars(IncoSheetDto::fromPaginatedIncoSheet($sheet)), + fn (PaginatedIncoSheet|PaginatedShortIncoSheet $sheet): array => $sheet instanceof PaginatedShortIncoSheet + ? IncoShortSheetDto::fromPaginatedShortIncoSheet($sheet)->toArray() + : IncoSheetDto::fromPaginatedIncoSheet($sheet)->toArray(), $this->view->incoSheets ); return response()->json([ 'incoSheets' => $items, - 'pagination' => [ - 'page' => $page, - 'pageSize' => $pageSize, - 'totalItems' => $totalItems, - 'totalPages' => $totalPages, - 'links' => [ - 'self' => $selfUrl, - 'first' => $firstUrl, - 'prev' => $prevUrl, - 'next' => $nextUrl, - 'last' => $lastUrl, - ], - ], + 'pagination' => $pagination, ]); } } diff --git a/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsShowResponse.php b/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsShowResponse.php index 113a560..dd3514e 100644 --- a/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsShowResponse.php +++ b/src/Presentation/Api/V1/Http/Responses/IncoSheets/IncoSheetsShowResponse.php @@ -25,10 +25,8 @@ final readonly class IncoSheetsShowResponse implements ApiResponse #[\Override] public function present(): JsonResponse { - $dto = IncoSheetDto::fromFindOutput($this->view->output); - return response()->json([ - 'incoSheet' => get_object_vars($dto), + 'incoSheet' => IncoSheetDto::fromFindOutput($this->view->output), ]); } } diff --git a/tests/Unit/Presentation/Api/V1/Dto/PaginationDtoTest.php b/tests/Unit/Presentation/Api/V1/Dto/PaginationDtoTest.php new file mode 100644 index 0000000..078af24 --- /dev/null +++ b/tests/Unit/Presentation/Api/V1/Dto/PaginationDtoTest.php @@ -0,0 +1,53 @@ +page)->toBe(2) + ->and($dto->pageSize)->toBe(10) + ->and($dto->totalItems)->toBe(35) + ->and($dto->totalPages)->toBe(4) + ->and($dto->links['self'])->toBe('http://localhost/api/v1/employees?page=2&pageSize=10') + ->and($dto->links['first'])->toBe('http://localhost/api/v1/employees?page=1&pageSize=10') + ->and($dto->links['prev'])->toBe('http://localhost/api/v1/employees?page=1&pageSize=10') + ->and($dto->links['next'])->toBe('http://localhost/api/v1/employees?page=3&pageSize=10') + ->and($dto->links['last'])->toBe('http://localhost/api/v1/employees?page=4&pageSize=10'); + }); + + it('handles first page correctly with null prev link', function (): void { + // GIVEN + $baseUri = Http::new('http://localhost/api/v1/employees'); + + // WHEN + $dto = PaginationDto::create( + page: 1, + pageSize: 10, + totalItems: 15, + baseUri: $baseUri, + ); + + // THEN + expect($dto->links['prev'])->toBeNull() + ->and($dto->links['next'])->toBe('http://localhost/api/v1/employees?page=2&pageSize=10'); + }); +});