Improve PaginatorInterface and ReadableDataInterface

[vjik]

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	✔️
Fixed issues	-

• Extract withLimit() from ReadableDataInterface to LimitableDataInterface.
• PaginatorInterface extends ReadableDataInterface

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f30a971) 100.00% compared to head (acb18a4) 100.00%.

Additional details and impacted files

@@             Coverage Diff             @@
##              master      #150   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       249       254    +5     
===========================================
  Files             35        35           
  Lines            615       634   +19     
===========================================
+ Hits             615       634   +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[what-the-diff]

PR Summary

This Pull Request focuses on improving the functionality and efficiency of both the KeysetPaginator.php and OffsetPaginator.php classes along with updating their dependencies.

• Updated Psalm Configuration Files
  The psalm-php80.xml and psalm.xml configuration files have been updated to better find unused data entries and to disable the detection of unused code.

• Improved Paginator System
  Both KeysetPaginator.php and OffsetPaginator.php classes are updated to use LimitableDataInterface which brings new validation and exception handling mechanisms. A new method readOne() has been added to further facilitate data reading.

• PaginatorInterface Enhancement
  The PaginatorInterface.php now extends ReadableDataInterface, enhancing its capabilities and bringing it up-to-date with recent technologies.

• Introduced LimitableDataInterface
  A new interface, LimitableDataInterface.php, has been introduced, which brings more refinement to how the system handles data reading limitations.

• ReadableDataInterface Update
  The withLimit method from ReadableDataInterface.php has been removed, which suggests changes to how data reading limits are handled in the future.

• DataReaderInterface Dependency Update
  The DataReaderInterface.php now uses LimitableDataInterface, reinforcing the system's ability to handle data reading limitations.

[roxblnfk]

Too many changes for one PR. You should consider breaking it down into several

[roxblnfk]

I'm not sure that BC is necessary for this package

[roxblnfk]

Are you sure that PaginatorInterface::read() and ReaderInterface::read() are compatible in the meaning?

    /**
     * Get iterable for the data set.
     *
     * @return iterable Iterable for the data.
     * @psalm-return iterable<TKey, TValue>
     */
    public function read(): iterable;

    /**
     * Get iterator that could be used to read currently active page items.
     *
     * @throws PaginatorException If page specified is not found.
     *
     * @return iterable Iterator with items for the current page.
     * @psalm-return iterable<TKey, TValue>
     */
    public function read(): iterable;

[roxblnfk]

By the way, this was the main reason why the Paginator didn't implement the DataReaderInterface from the very beginning.
This could lead to confusion and unexpected behavior. One user might expect that passing a Paginator would read all the data, while another user might expect it to read only one page.

[vjik]

I don't understand reason. You talk about implementation details. For users of ReadableDataInterface it doesn't matter.

[vjik]

Too many changes for one PR. You should consider breaking it down into several

This is related changes that don't make sense individually.

I'm not sure that BC is necessary for this package

These changes cannot be made without breack BC.

[roxblnfk]

It would be nice to add "extends ReadableInterface" there