OffsetPaginator::withToken() - Code Metrics - Inspection of "Introduce `PageToken` class (#159)" - yiisoft/data - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 91295c...febe3e )

by Sergei
created 2024-01-26 07:51 UTC
OffsetPaginator::withToken() A

↳ Parent: OffsetPaginator
Complexity

Conditions	2
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	2
Importance

Changes
Metric	Value
cc	2
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	2
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace Yiisoft\Data\Paginator;

use Generator;
use InvalidArgumentException;
use LogicException;
use Yiisoft\Data\Reader\CountableDataInterface;
use Yiisoft\Data\Reader\LimitableDataInterface;
use Yiisoft\Data\Reader\OffsetableDataInterface;
use Yiisoft\Data\Reader\ReadableDataInterface;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Data\Reader\SortableDataInterface;

use function ceil;
use function max;
use function sprintf;

/**
 * Offset paginator.
 *
 * Advantages:
 *
 * - Total number of pages is available
 * - Can get to specific page
 * - Data can be unordered
 *
 * Disadvantages:
 *
 * - Performance degrades with page number increase
 * - Insertions or deletions in the middle of the data are making results inconsistent
 *
 * @template TKey as array-key
 * @template TValue as array|object
 *
 * @implements PaginatorInterface<TKey, TValue>
 */
final class OffsetPaginator implements PaginatorInterface
{
    /**
     * @var PageToken Current page token
     */
    private PageToken $token;

    /**
     * @var int Maximum number of items per page.
     */
    private int $pageSize = self::DEFAULT_PAGE_SIZE;

    /**
     * Data reader being paginated.
     *
     * @psalm-var ReadableDataInterface<TKey, TValue>&LimitableDataInterface&OffsetableDataInterface&CountableDataInterface
     */
    private ReadableDataInterface $dataReader;

    /**
     * @param ReadableDataInterface $dataReader Data reader being paginated.
     * @psalm-param ReadableDataInterface<TKey, TValue>&LimitableDataInterface&OffsetableDataInterface&CountableDataInterface $dataReader
     * @psalm-suppress DocblockTypeContradiction Needed to allow validating `$dataReader`
     */
    public function __construct(ReadableDataInterface $dataReader)
    {
        if (!$dataReader instanceof OffsetableDataInterface) {
            throw new InvalidArgumentException(sprintf(
                'Data reader should implement "%s" in order to be used with offset paginator.',
                OffsetableDataInterface::class,
            ));
        }

        if (!$dataReader instanceof CountableDataInterface) {
            throw new InvalidArgumentException(sprintf(
                'Data reader should implement "%s" in order to be used with offset paginator.',
                CountableDataInterface::class,
            ));
        }

        if (!$dataReader instanceof LimitableDataInterface) {
            throw new InvalidArgumentException(sprintf(
                'Data reader should implement "%s" in order to be used with offset paginator.',
                LimitableDataInterface::class,
            ));
        }

        $this->dataReader = $dataReader;
        $this->token = PageToken::next('1');
    }

    public function withToken(?PageToken $token): static
    {
        return $this->withCurrentPage($token === null ? 1 : (int)$token->value);
    }

    public function withPageSize(int $pageSize): static
    {
        if ($pageSize < 1) {
            throw new PaginatorException('Page size should be at least 1.');
        }

        $new = clone $this;
        $new->pageSize = $pageSize;
        return $new;
    }

    /**
     * Get a new instance with the given current page number set.
     *
     * @param int $page Page number.
     *
     * @throws PaginatorException If current page is set incorrectly.
     *
     * @return self New instance.
     */
    public function withCurrentPage(int $page): self
    {
        if ($page < 1) {
            throw new PaginatorException('Current page should be at least 1.');
        }

        $new = clone $this;
        $new->token = PageToken::next((string) $page);
        return $new;
    }

    public function getToken(): PageToken
    {
        return $this->token;
    }

    public function getNextToken(): ?PageToken
    {
        return $this->isOnLastPage() ? null : PageToken::next((string) ($this->getCurrentPage() + 1));
    }

    public function getPreviousToken(): ?PageToken
    {
        return $this->isOnFirstPage() ? null : PageToken::next((string) ($this->getCurrentPage() - 1));
    }

    public function getPageSize(): int
    {
        return $this->pageSize;
    }

    /**
     * Get current page number.
     *
     * @return int Current page number.
     */
    public function getCurrentPage(): int
    {
        return (int) $this->token->value;
    }

    public function getCurrentPageSize(): int
    {
        $pages = $this->getInternalTotalPages();

        if ($pages === 1) {
            return $this->getTotalItems();
        }

        $currentPage = $this->getCurrentPage();

        if ($currentPage < $pages) {
            return $this->pageSize;
        }

        if ($currentPage === $pages) {
            return $this->getTotalItems() - $this->getOffset();
        }

        throw new PaginatorException('Page not found.');
    }

    /**
     * Get offset for the current page i.e. the number of items to skip before the current page is reached.
     *
     * @return int Offset.
     */
    public function getOffset(): int
    {
        return $this->pageSize * ($this->getCurrentPage() - 1);
    }

    /**
     * Get total number of items in the whole data reader being paginated.
     *
     * @return int Total items number.
     */
    public function getTotalItems(): int
    {
        return $this->dataReader->count();
        return $this->dataReader->/** @scrutinizer ignore-call */ count();
    }

    /**
     * Get total number of pages in a data reader being paginated.
     *
     * @return int Total pages number.
     */
    public function getTotalPages(): int
    {
        return (int) ceil($this->getTotalItems() / $this->pageSize);
    }

    public function isSortable(): bool
    {
        return $this->dataReader instanceof SortableDataInterface;
    }

    public function withSort(?Sort $sort): static
    {
        if (!$this->dataReader instanceof SortableDataInterface) {
            throw new LogicException('Data reader does not support sorting.');
        }

        $new = clone $this;
        $new->dataReader = $this->dataReader->withSort($sort);
        $new->dataReader = $this->dataReader->withSort($sort);
        return $new;
    }

    public function getSort(): ?Sort
    {
        return $this->dataReader instanceof SortableDataInterface ? $this->dataReader->getSort() : null;
        return $this->dataReader instanceof SortableDataInterface ? $this->dataReader->/** @scrutinizer ignore-call */ getSort() : null;
    }

    /**
     * @psalm-return Generator<TKey, TValue, mixed, null>
     */
    public function read(): iterable
    {
        if ($this->getCurrentPage() > $this->getInternalTotalPages()) {
            throw new PaginatorException('Page not found.');
        }

        yield from $this->dataReader
            ->withLimit($this->pageSize)
            ->/** @scrutinizer ignore-call */ withLimit($this->pageSize)
            ->withOffset($this->getOffset())
            ->read();
    }

    public function readOne(): array|object|null
    {
        return $this->dataReader
            ->withLimit(1)
            ->withOffset($this->getOffset())
            ->readOne();
    }

    public function isOnFirstPage(): bool
    {
        return $this->token->value === '1';
    }

    public function isOnLastPage(): bool
    {
        if ($this->getCurrentPage() > $this->getInternalTotalPages()) {
            throw new PaginatorException('Page not found.');
        }

        return $this->getCurrentPage() === $this->getInternalTotalPages();
    }

    public function isPaginationRequired(): bool
    {
        return $this->getTotalPages() > 1;
    }

    private function getInternalTotalPages(): int
    {
        return max(1, $this->getTotalPages());
    }
}

yiisoft / data

Push — master ( 91295c...febe3e )

OffsetPaginator::withToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
