v1.1.0

[ewilan-riviere]

• Add OpdsPaging::class based on Paging information for pre-paginated feeds #40 from @mikespub to handle manual pagination for issue [Bug]: Paginator revisited #38
• OpdsConfig::class can have nullable updated attribute
• Opds method send() have now a new parameter bool $exit = false to control if the script should exit after sending the response to replace bool $mock = false parameter. By default, send() will not exit the script.

[codecov]

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (d6ef3bd) 99.43% compared to head (ae90bbd) 99.13%.

Files	Patch %	Lines
src/Engine/Paginate/OpdsPaginate.php	97.97%	2 Missing ⚠️
src/Engine/OpdsEngine.php	87.50%	1 Missing ⚠️
src/OpdsConfig.php	83.33%	1 Missing ⚠️
src/OpdsResponse.php	87.50%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main      #43      +/-   ##
============================================
- Coverage     99.43%   99.13%   -0.31%     
- Complexity      259      313      +54     
============================================
  Files            10       12       +2     
  Lines           890     1042     +152     
============================================
+ Hits            885     1033     +148     
- Misses            5        9       +4     

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

[ewilan-riviere]

@mikespub
To help for transparency, I offer to add a method pagination() or paginate() (tell me the one your like) to update pagination system.

If pagination() method have no param automatic pagination will be executed on it (previous pagination system) but with param, a OpdsPaging::class instance (you can see current OpdsPagingTest.php), manual pagination will be executed. The aim is to merge two systems of pagination.

And usePagination and useAutoPagination will be removed from OpdsConfig.

What do you think about this?
And can you tell me if current handle of manual pagination is like you want?

[mikespub]

Hi @ewilan-riviere I'm fine with re-using paginate() if that's what you want, but I assume you'll somehow want to combine the functionality of the original paginate() with the new paging() I added then?

The reason I'm asking is because the paging() I used in the PR deals with "opaque" URLs as strings coming from the application, and then uses those directly in the feeds - which is why I used some random variations with f=.., n=.., p=.., l=... params for each in the Paging Test. It's not at all what the links actually look like in COPS, but it shouldn't matter :-)

While the original paginate() tries to count items, pages, previous & next numbers etc. as integers, and then truncates the feed(s) and generates URL links for them - something completely different...

[ewilan-riviere]

@mikespub Thanks for quick answer!

Yes, it's exactly what you done in your PR, I just update it with a new class to handle this with an object, like in your test OpdsPagingTest.

The aim is to combine two paginations yes.

// no pagination
$opds = Opds::make(getConfig())
        ->feeds(manyFeeds())
        ->get();

// with pagination (automatic)
$opds = Opds::make(getConfig())
        ->feeds(manyFeeds())
        ->pagination()
        ->get();

// with pagination (manual)
$opds = Opds::make(getConfig())
        ->feeds(manyFeeds())
        ->pagination(new OpdsPaging(
            currentPage: $page,
            totalItems: $total,
            firstUrl: 'http://localhost:8080/opds?f=1',
            lastUrl: 'http://localhost:8080/opds?l=42',
            previousUrl: 'http://localhost:8080/opds?p=1',
            nextUrl: 'http://localhost:8080/opds?n=3',
        ))
        ->get();

This is an example, for now pagination auto is into OpdsConfig and your new method paging() allow to use manual pagination. But it should be possible to combine two paginations.

EDIT
Tell me if I'm not clear

[ewilan-riviere]

@mikespub
It's done, can you tell me if it's ok for you?

[mikespub]

Ah yes, now I see - thanks, that's good for me too :-)