Merge branch 'dev'

ddnexus · Jul 20, 2024 · f818189 · f818189
2 parents b7bac8d + d3c5a9a
commit f818189
Show file tree

Hide file tree

Showing 33 changed files with 136 additions and 70 deletions.
diff --git a/.github/ISSUE_TEMPLATE/Code.yml b/.github/ISSUE_TEMPLATE/Code.yml
@@ -19,7 +19,7 @@ body:
     attributes:
       label: 👀 Before submitting...
       options:
-        - label: I upgraded to pagy version 9.0.1
+        - label: I upgraded to pagy version 9.0.2
           required: true
         - label: I searched through the [Documentation](https://ddnexus.github.io/pagy/)
           required: true

diff --git a/.github/latest_release_body.md b/.github/latest_release_body.md
@@ -6,11 +6,13 @@
 - See the [Changelog](https://ddnexus.github.io/pagy/changelog) for possible breaking changes
 <!-- whats_new_end -->
 
-### Changes in 9.0.1
+### Changes in 9.0.2
 
 <!-- changes_start -->
-- Fix countless executing the count query
-- Rename row_comparison > tuple_comparison; ignore mixed orders
+- Rename and document the link header to pagy_link_header
+- Add first and next url helpers to the keyset extra; add the keyset section to config/pagy.rb
+- Fix nil page in keyset URL not overriding the params page
+- Extracted shared method
 <!-- changes_end -->
 
 [CHANGELOG](https://ddnexus.github.io/pagy/changelog)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,13 @@ If you upgrade from version `< 9.0.0` see the following:
 - None
 <hr>
 
+## Version 9.0.2
+
+- Rename and document the link header to pagy_link_header
+- Add first and next url helpers to the keyset extra; add the keyset section to config/pagy.rb
+- Fix nil page in keyset URL not overriding the params page
+- Extracted shared method
+
 ## Version 9.0.1
 
 - Fix countless executing the count query

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: gem
   specs:
-    pagy (9.0.1)
+    pagy (9.0.2)
 
 GEM
   remote: https://rubygems.org/

diff --git a/README.md b/README.md
diff --git a/bun.lockb b/bun.lockb
diff --git a/docs/extras/countless.md b/docs/extras/countless.md
@@ -9,6 +9,10 @@ categories:
 
 Paginate without the need of any count, saving one query per rendering.
 
+!!!success
+If you don't need any frontend you should consider the [Pagy::Keyset pagination](/docs/api/keyset.md) that is even faster than countless, especially with big data
+!!!
+
 ## Setup
 
 ```ruby pagy.rb (initializer)

diff --git a/docs/extras/headers.md b/docs/extras/headers.md
@@ -76,18 +76,11 @@ If you are replacing any of the existing API-pagination gems in some already wor
 names so you will not have to change the client app that consumes them. You can do so by using the `:headers` variable _(
 see [variables](#variables) below)_
 
-### Countless Pagination
+!!!warning Countless and Keyset Pagination
 
-If your requirements allow to save one count-query per rendering by using the `pagy_countless` constructor, the headers will
-not have the `rel="last"` link, the `total-count` and the `total-pages` that are unknown with countless pagination.
+If you use the `headers` extra with the [contless](countless.md) or [keyset](keyset.md) extras, a few heder will not be available (e.g. the last link)
+!!!
 
-Example of HTTP headers produced from a `Pagy::Countless` object:
-
-```text
-Link <https://example.com:8080/foo?page=1>; rel="first", <https://example.com:8080/foo?page=2>; rel="prev", <https://example.com:8080/foo?page=4>; rel="next"
-current-page 3
-page-items 20
-```
 
 ## Variables
 
@@ -133,3 +126,9 @@ This method generates a hash of [RFC-8288](https://tools.ietf.org/html/rfc8288)
 response. It is internally used by the `pagy_headers_merge` method, so you usually don't need to use it directly. However, if you
 need to edit the headers that pagy generates (for example adding extra `link` headers), you can override it in your own
 controller.
+
+==- `pagy_link_header(pagy)`
+
+Return only the `link` header as a single key Hash.
+
+===
diff --git a/docs/extras/keyset.md b/docs/extras/keyset.md
@@ -65,7 +65,15 @@ of `records` pulled from the DB.
 ==- `pagy_keyset_get_vars(vars)`
 
 This sub-method is internally called only by the `pagy_keyset` method. It automatically sets the `:page` variable and - if you 
-use the [limit extra](/docs/extras/limit.md) also the `:limit` variables from the request `params`. Documented only for 
+use the [limit extra](limit.md) also the `:limit` variables from the request `params`. Documented only for 
 overriding.
 
+==- `pagy_keyset_first_url(pagy, absolute: false)`
+
+Return the first page URL string. (See also the [headers](headers.md) and [jsonapi](jsonapi.md) extras for more complete solutions)
+
+==- `pagy_keyset_next_url(pagy, absolute: false)`
+
+Return the next page URL string or nil. (See also the [headers](headers.md) and [jsonapi](jsonapi.md) extras for more complete solutions)
+
 ===
diff --git a/docs/extras/pagy.md b/docs/extras/pagy.md
@@ -70,7 +70,7 @@ bar links (e.g. `countless` extra).
 
 ==- `pagy_next_url(pagy, absolute: false)`
 
-Return the previous page URL string or nil. Useful to build minimalistic UIs that don't use nav bar
+Return the next page URL string or nil. Useful to build minimalistic UIs that don't use nav bar
 links (e.g. `countless` extra).
 
 ==- `pagy_prev_a(pagy, **vars)`

diff --git a/e2e/snapshots.js b/e2e/snapshots.js
diff --git a/gem/apps/calendar.ru b/gem/apps/calendar.ru
@@ -15,7 +15,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#5-calendar-app
 
-VERSION = '9.0.1'
+VERSION = '9.0.2'
 
 # Gemfile
 require 'bundler/inline'

diff --git a/gem/apps/demo.ru b/gem/apps/demo.ru
@@ -18,7 +18,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#3-demo-app
 
-VERSION = '9.0.1'
+VERSION = '9.0.2'
 
 require 'bundler/inline'
 require 'bundler'

diff --git a/gem/apps/rails.ru b/gem/apps/rails.ru
@@ -15,7 +15,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#2-rails-app
 
-VERSION = '9.0.1'
+VERSION = '9.0.2'
 
 # Gemfile
 require 'bundler/inline'

diff --git a/gem/apps/repro.ru b/gem/apps/repro.ru
@@ -15,7 +15,7 @@
 # DOC
 #    https://ddnexus.github.io/pagy/playground/#1-repro-app
 
-VERSION = '9.0.1'
+VERSION = '9.0.2'
 
 require 'bundler/inline'
 require 'bundler'

diff --git a/gem/bin/pagy b/gem/bin/pagy
@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-VERSION = '9.0.1'
+VERSION = '9.0.2'
 APPS    = %w[repro rails demo calendar keyset_ar keyset_s].freeze
 LINUX   = RbConfig::CONFIG['host_os'].include?('linux')
 HOST    = '0.0.0.0'

diff --git a/gem/config/pagy.rb b/gem/config/pagy.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (9.0.1)
+# Pagy initializer file (9.0.2)
 # Customize only what you really need and notice that the core Pagy works also without any of the following lines.
 # Should you just cherry pick part of this file, please maintain the require-order of the extras
 
@@ -79,6 +79,10 @@
 #                            count: 'Total-Count',
 #                            pages: 'Total-Pages' }     # default
 
+# Keyset extra: Paginate with the Pagy keyset pagination technique
+# See http://ddnexus.github.io/pagy/extras/keyset
+# require 'pagy/extras/keyset'
+
 # Meilisearch extra: Paginate `Meilisearch` result objects
 # See https://ddnexus.github.io/pagy/docs/extras/meilisearch
 # Default :pagy_search method: change only if you use also

diff --git a/gem/javascripts/pagy.min.js b/gem/javascripts/pagy.min.js