ldc-mesbr-app/tests/Unit/Shared/Helpers/PaginationTest.php

<?php

declare(strict_types=1);

namespace Tests\Unit\Shared\Helpers;

use Shared\Helpers\Pagination;

describe('pagination', function (): void {
    it('creates a pagination from indexes', function (): void {
        // GIVEN
        $from = 10;
        $to   = 19;

        // WHEN
        $pagination = Pagination::ofIndexes($from, $to);

        // THEN
        expect($pagination->from())->toBe(10)
            ->and($pagination->to())->toBe(19)
            ->and($pagination->pageSize())->toBe(10);
    });

    it('normalizes a negative from index', function (): void {
        // GIVEN
        $from = -10;
        $to   = 19;

        // WHEN
        $pagination = Pagination::ofIndexes($from, $to);

        // THEN
        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(19);
    });

    it('creates a pagination from page number and page size', function (): void {
        // GIVEN
        $pageNumber = 1;
        $pageSize   = 25;

        // WHEN
        $pagination = Pagination::ofPage($pageNumber, $pageSize);

        // THEN
        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(24)
            ->and($pagination->pageSize())->toBe(25)
            ->and($pagination->pageNumber())->toBe(1);
    });

    it('creates the second page correctly', function (): void {
        // GIVEN
        $pageNumber = 2;
        $pageSize   = 25;

        // WHEN
        $pagination = Pagination::ofPage($pageNumber, $pageSize);

        // THEN
        expect($pagination->from())->toBe(25)
            ->and($pagination->to())->toBe(49)
            ->and($pagination->pageSize())->toBe(25)
            ->and($pagination->pageNumber())->toBe(2);
    });

    it('normalizes a page number below one', function (): void {
        // GIVEN
        $pageNumber = 0;
        $pageSize   = 25;

        // WHEN
        $pagination = Pagination::ofPage($pageNumber, $pageSize);

        // THEN
        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(24)
            ->and($pagination->pageNumber())->toBe(1);
    });

    it('normalizes a negative page number', function (): void {
        // GIVEN
        $pageNumber = -5;
        $pageSize   = 25;

        // WHEN
        $pagination = Pagination::ofPage($pageNumber, $pageSize);

        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(24)
            ->and($pagination->pageNumber())->toBe(1);
    });

    it('normalizes a page size below one', function (): void {
        // GIVEN
        $pageNumber = 1;
        $pageSize   = 0;

        // WHEN
        $pagination = Pagination::ofPage($pageNumber, $pageSize);

        // THEN
        expect($pagination->pageSize())->toBe(1)
            ->and($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(0);
    });

    it('limits the page size to the maximum page size', function (): void {
        // GIVEN
        $pageNumber = 1;
        $pageSize   = Pagination::MAX_PAGE_SIZE + 100;

        // WHEN
        $pagination = Pagination::ofPage($pageNumber, $pageSize);

        // THEN
        expect($pagination->pageSize())
            ->toBe(Pagination::MAX_PAGE_SIZE);
    });

    it('creates a pagination from offset and limit', function (): void {
        // GIVEN
        $pageNumber = 20;
        $pageSize   = 10;

        // WHEN
        $pagination = Pagination::ofOffsetAndLimit($pageNumber, $pageSize);

        // THEN
        expect($pagination->from())->toBe(20)
            ->and($pagination->to())->toBe(29)
            ->and($pagination->pageSize())->toBe(10);
    });

    it('normalizes a negative offset', function (): void {
        // GIVEN
        $pageNumber = -10;
        $pageSize   = 10;

        // WHEN
        $pagination = Pagination::ofOffsetAndLimit($pageNumber, $pageSize);

        // THEN
        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(9);
    });

    it('normalizes a limit below one', function (): void {
        // GIVEN
        $pageNumber = 10;
        $pageSize   = 0;

        // WHEN
        $pagination = Pagination::ofOffsetAndLimit($pageNumber, $pageSize);

        // THEN
        expect($pagination->from())->toBe(10)
            ->and($pagination->to())->toBe(10)
            ->and($pagination->pageSize())->toBe(1);
    });

    it('creates the first page with the default page size', function (): void {
        // GIVEN & WHEN
        $pagination = Pagination::firstPage();

        // THEN
        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(24)
            ->and($pagination->pageSize())->toBe(25)
            ->and($pagination->pageNumber())->toBe(1);
    });

    it('creates the first page with a custom page size', function (): void {
        // GIVEN
        $pageSize = 50;

        // WHEN
        $pagination = Pagination::firstPage($pageSize);

        // THEN
        expect($pagination->from())->toBe(0)
            ->and($pagination->to())->toBe(49)
            ->and($pagination->pageSize())->toBe(50);
    });

    it('returns its string representation', function (): void {
        // GIVEN
        $from = 10;
        $to   = 19;

        // WHEN
        $pagination = Pagination::ofIndexes($from, $to);

        // THEN
        expect((string) $pagination)
            ->toBe('Pagination{from=10, to=19}');
    });
});