pagy 6.0.0 → 7.0.0

data/lib/pagy/extras/bootstrap.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bootstrap
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/bootstrap
 # frozen_string_literal: true
 
 require 'pagy/extras/frontend_helpers'
@@ -8,84 +8,97 @@ class Pagy # :nodoc:
   # The resulting code may not look very elegant, but produces the best benchmarks
   module BootstrapExtra
     # Pagination for bootstrap: it returns the html with the series of links to the pages
-    def pagy_bootstrap_nav(pagy, pagy_id: nil, link_extra: '', **vars)
+    def pagy_bootstrap_nav(pagy, pagy_id: nil, link_extra: '',
+                           nav_aria_label: nil, nav_i18n_key: nil, **vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: %(class="page-link" #{link_extra}))
 
-      html = +%(<nav#{p_id} class="pagy-bootstrap-nav"><ul class="pagination">)
-      html << pagy_bootstrap_prev_html(pagy, link)
+      html = +%(<nav#{p_id} class="pagy-bootstrap-nav" #{
+                  nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}><ul class="pagination">)
+      html << bootstrap_prev_html(pagy, link)
       pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer
-                  %(<li class="page-item">#{link.call item}</li>)
+                  %(<li class="page-item">#{link.call(item)}</li>)
                 when String
-                  %(<li class="page-item active">#{link.call item}</li>)
+                  %(<li class="page-item active">#{link.call(item)}</li>)
                 when :gap
-                  %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.gap'}</a></li>)
+                  %(<li class="page-item gap disabled"><a href="#" class="page-link" aria-disabled="true">#{
+                      pagy_t 'pagy.gap'}</a></li>)
                 else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
-      html << pagy_bootstrap_next_html(pagy, link)
+      html << bootstrap_next_html(pagy, link)
       html << %(</ul></nav>)
     end
 
     # Javascript pagination for bootstrap: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_bootstrap_nav_js(pagy, pagy_id: nil, link_extra: '', **vars)
+    def pagy_bootstrap_nav_js(pagy, pagy_id: nil, link_extra: '',
+                              nav_aria_label: nil, nav_i18n_key: nil, **vars)
       sequels = pagy.sequels(**vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: %(class="page-link" #{link_extra}))
-      tags = { 'before' => %(<ul class="pagination">#{pagy_bootstrap_prev_html pagy, link}),
-               'link'   => %(<li class="page-item">#{mark = link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</li>),
-               'active' => %(<li class="page-item active">#{mark}</li>),
-               'gap'    => %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.gap'}</a></li>),
-               'after'  => %(#{pagy_bootstrap_next_html pagy, link}</ul>) }
+      tags = { 'before' => %(<ul class="pagination">#{bootstrap_prev_html pagy, link}),
+               'link'   => %(<li class="page-item">#{html = link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</li>),
+               'active' => %(<li class="page-item active">#{html}</li>),
+               'gap'    => %(<li class="page-item gap disabled"><a href="#" class="page-link" aria-disabled="true">#{
+                               pagy_t 'pagy.gap'}</a></li>),
+               'after'  => %(#{bootstrap_next_html pagy, link}</ul>) }
 
       %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-bootstrap-nav-js" #{
-        pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
+          nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)} #{
+          pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))
+        }></nav>)
     end
 
     # Javascript combo pagination for bootstrap: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_bootstrap_combo_nav_js(pagy, pagy_id: nil, link_extra: '')
+    def pagy_bootstrap_combo_nav_js(pagy, pagy_id: nil, link_extra: '',
+                                    nav_aria_label: nil, nav_i18n_key: nil)
       p_id    = %( id="#{pagy_id}") if pagy_id
-      link    = pagy_link_proc(pagy, link_extra: link_extra)
+      link    = pagy_link_proc(pagy, link_extra:)
       p_page  = pagy.page
       p_pages = pagy.pages
       input   = %(<input type="number" min="1" max="#{p_pages}" value="#{
-                    p_page}" class="text-primary" style="padding: 0; border: none; text-align: center; width: #{
-                    p_pages.to_s.length + 1}rem;">)
+                    p_page}" style="padding: 0; border: none; text-align: center; width: #{
+                    p_pages.to_s.length + 1}rem;" aria-current="page">)
 
-      %(<nav#{p_id} class="pagy-bootstrap-combo-nav-js pagination"><div class="btn-group" role="group" #{
+      %(<nav#{p_id} class="pagy-bootstrap-combo-nav-js pagination" #{
+          nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}><div class="btn-group" role="group" #{
           pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
           if (p_prev = pagy.prev)
-            link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous" class="prev btn btn-primary"'
+            link.call(p_prev, pagy_t('pagy.prev'), %(class="prev btn btn-primary" #{prev_aria_label_attr}))
           else
-            %(<a class="prev btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.prev')}</a>)
+            %(<a class="prev btn btn-primary disabled" href="#" aria-disabled="true" #{
+                prev_aria_label_attr}>#{pagy_t('pagy.prev')}</a>)
           end
-        }<div class="pagy-combo-input btn btn-primary disabled" style="white-space: nowrap;">#{
+        }<div class="pagy-combo-input btn btn-secondary" style="white-space: nowrap;">#{
           pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages}</div>#{
-          if (p_next  = pagy.next)
-            link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next" class="next btn btn-primary"'
+          if (p_next = pagy.next)
+            link.call(p_next, pagy_t('pagy.next'), %(class="next btn btn-primary" #{next_aria_label_attr}))
           else
-            %(<a class="next btn btn-primary disabled" href="#">#{pagy_t 'pagy.nav.next'}</a>)
+            %(<a class="next btn btn-primary disabled" href="#" aria-disabled="true" #{
+                next_aria_label_attr}>#{pagy_t 'pagy.next'}</a>)
           end
         }</div></nav>)
     end
 
     private
 
-    def pagy_bootstrap_prev_html(pagy, link)
+    def bootstrap_prev_html(pagy, link)
       if (p_prev = pagy.prev)
-        %(<li class="page-item prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+        %(<li class="page-item prev">#{link.call(p_prev, pagy_t('pagy.prev'), prev_aria_label_attr)}</li>)
       else
-        %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.prev'}</a></li>)
+        %(<li class="page-item prev disabled"><a href="#" class="page-link" aria-disabled="true" #{
+            prev_aria_label_attr}>#{pagy_t('pagy.prev')}</a></li>)
       end
     end
 
-    def pagy_bootstrap_next_html(pagy, link)
+    def bootstrap_next_html(pagy, link)
       if (p_next = pagy.next)
-        %(<li class="page-item next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
+        %(<li class="page-item next">#{link.call p_next, pagy_t('pagy.next'), next_aria_label_attr}</li>)
       else
-        %(<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.next'}</a></li>)
+        %(<li class="page-item next disabled"><a href="#" class="page-link" aria-disabled="true" #{
+            next_aria_label_attr}>#{pagy_t('pagy.next')}</a></li>)
       end
     end
   end

data/lib/pagy/extras/bulma.rb

@@ -1,29 +1,32 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bulma
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/bulma
 # frozen_string_literal: true
 
 require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
+  DEFAULT[:bulma_nav_classes] = 'is-centered'
+
   # Frontend modules are specially optimized for performance.
   # The resulting code may not look very elegant, but produces the best benchmarks
   module BulmaExtra
     # Pagination for bulma: it returns the html with the series of links to the pages
-    def pagy_bulma_nav(pagy, pagy_id: nil, link_extra: '', **vars)
+    def pagy_bulma_nav(pagy, pagy_id: nil, link_extra: '',
+                       nav_aria_label: nil, nav_i18n_key: nil, **vars)
       p_id = %( id="#{pagy_id}") if pagy_id
-      link = pagy_link_proc(pagy, link_extra: link_extra)
+      link = pagy_link_proc(pagy, link_extra:)
 
-      html = +%(<nav#{p_id} class="pagy-bulma-nav pagination is-centered" aria-label="pagination">)
-      html << pagy_bulma_prev_next_html(pagy, link)
+      html = +%(<nav#{p_id} class="pagy-bulma-nav pagination #{DEFAULT[:bulma_nav_classes]}" #{
+                  nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}>)
+      html << bulma_prev_next_html(pagy, link)
       html << %(<ul class="pagination-list">)
       pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer
-                  %(<li>#{link.call item, pagy.label_for(item), %(class="pagination-link" aria-label="goto page #{item}")}</li>)
+                  %(<li>#{link.call(item, pagy.label_for(item), %(class="pagination-link"))}</li>)
                 when String
-                  %(<li>#{link.call item, pagy.label_for(item),
-                                    %(class="pagination-link is-current" aria-label="page #{item}" aria-current="page")}</li>)
+                  %(<li>#{link.call(item, pagy.label_for(item), %(class="pagination-link is-current"))}</li>)
                 when :gap
-                  %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>)
+                  %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.gap'}</span></li>)
                 else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
@@ -31,62 +34,68 @@ class Pagy # :nodoc:
     end
 
     # Javascript pagination for bulma: it returns a nav and a JSON tag used by the Pagy.nav javascript
-    def pagy_bulma_nav_js(pagy, pagy_id: nil, link_extra: '', **vars)
+    def pagy_bulma_nav_js(pagy, pagy_id: nil, link_extra: '',
+                          nav_aria_label: nil, nav_i18n_key: nil, **vars)
       sequels = pagy.sequels(**vars)
       p_id = %( id="#{pagy_id}") if pagy_id
-      link = pagy_link_proc(pagy, link_extra: link_extra)
-      tags = { 'before' => %(#{pagy_bulma_prev_next_html(pagy, link)}<ul class="pagination-list">),
-               'link'   => %(<li>#{link.call PAGE_PLACEHOLDER, LABEL_PLACEHOLDER,
-                                             %(class="pagination-link" aria-label="goto page #{PAGE_PLACEHOLDER}")}</li>),
-               'active' => %(<li>#{link.call PAGE_PLACEHOLDER, LABEL_PLACEHOLDER,
-                                             %(class="pagination-link is-current" aria-current="page" aria-label="page #{
-                                                 PAGE_PLACEHOLDER}")}</li>),
-               'gap'    => %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>),
+      link = pagy_link_proc(pagy, link_extra:)
+      tags = { 'before' => %(#{bulma_prev_next_html(pagy, link)}<ul class="pagination-list">),
+               'link'   => %(<li>#{link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER, %(class="pagination-link"))}</li>),
+               'active' => %(<li>#{link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER, %(class="pagination-link is-current"))}</li>),
+               'gap'    => %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.gap'}</span></li>),
                'after'  => '</ul>' }
 
-      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-bulma-nav-js pagination is-centered" aria-label="pagination" #{
+      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-bulma-nav-js pagination #{DEFAULT[:bulma_nav_classes]}" #{
+        nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}#{
         pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
     end
 
     # Javascript combo pagination for bulma: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_bulma_combo_nav_js(pagy, pagy_id: nil, link_extra: '')
+    def pagy_bulma_combo_nav_js(pagy, pagy_id: nil, link_extra: '',
+                                nav_aria_label: nil, nav_i18n_key: nil)
       p_id    = %( id="#{pagy_id}") if pagy_id
-      link    = pagy_link_proc(pagy, link_extra: link_extra)
+      link    = pagy_link_proc(pagy, link_extra:)
       p_page  = pagy.page
       p_pages = pagy.pages
       input   = %(<input class="input" type="number" min="1" max="#{p_pages}" value="#{
-                    p_page}" style="padding: 0; text-align: center; width: #{p_pages.to_s.length + 1}rem; margin:0 0.3rem;">)
+                    p_page}" style="padding: 0; text-align: center; width: #{
+                    p_pages.to_s.length + 1}rem; margin:0 0.3rem;" aria-current="page">)
 
-      html = %(<nav#{p_id} class="pagy-bulma-combo-nav-js" aria-label="pagination">)
+      html = %(<nav#{p_id} class="pagy-bulma-combo-nav-js #{DEFAULT[:bulma_nav_classes]}" #{
+                nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}>)
       %(#{html}<div class="field is-grouped is-grouped-centered" role="group" #{
           pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
           if (p_prev  = pagy.prev)
-            %(<p class="control">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'class="button" aria-label="previous page"'}</p>)
+            %(<p class="control">#{link.call(p_prev, pagy_t('pagy.prev'), %(class="button" #{prev_aria_label_attr}))}</p>)
           else
-            %(<p class="control"><a class="button" disabled>#{pagy_t 'pagy.nav.prev'}</a></p>)
+            %(<p class="control"><a class="button" disabled aria-disabled="true" #{
+                prev_aria_label_attr}>#{pagy_t 'pagy.prev'}</a></p>)
           end
         }<div class="pagy-combo-input control level is-mobile">#{
           pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages}</div>#{
           if (p_next  = pagy.next)
-            %(<p class="control">#{link.call p_next, pagy_t('pagy.nav.next'), 'class="button" aria-label="next page"'}</p>)
+            %(<p class="control">#{link.call(p_next, pagy_t('pagy.next'), %(class="button" #{next_aria_label_attr}))}</p>)
           else
-            %(<p class="control"><a class="button" disabled>#{pagy_t 'pagy.nav.next'}</a></p>)
+            %(<p class="control"><a class="button" disabled aria-disabled="true"#{
+                next_aria_label_attr}>#{pagy_t 'pagy.next'}</a></p>)
           end
         }</div></nav>)
     end
 
     private
 
-    def pagy_bulma_prev_next_html(pagy, link)
+    def bulma_prev_next_html(pagy, link)
       html = +if (p_prev = pagy.prev)
-                link.call p_prev, pagy_t('pagy.nav.prev'), 'class="pagination-previous" aria-label="previous page"'
+                link.call(p_prev, pagy_t('pagy.prev'), %(#{prev_aria_label_attr} class="pagination-previous"))
               else
-                %(<a class="pagination-previous" disabled>#{pagy_t 'pagy.nav.prev'}</a>)
+                %(<a class="pagination-previous" disabled aria-disabled="true" #{
+                    prev_aria_label_attr}>#{pagy_t 'pagy.prev'}</a>)
               end
       html << if (p_next = pagy.next)
-                link.call p_next, pagy_t('pagy.nav.next'), 'class="pagination-next" aria-label="next page"'
+                link.call(p_next, pagy_t('pagy.next'), %(#{next_aria_label_attr} class="pagination-next"))
               else
-                %(<a class="pagination-next" disabled>#{pagy_t 'pagy.nav.next'}</a>)
+                %(<a class="pagination-next" disabled aria-disabled="true" #{
+                    next_aria_label_attr}>#{pagy_t('pagy.next')}</a>)
               end
     end
   end

data/lib/pagy/extras/calendar.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/calendar
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/calendar
 # frozen_string_literal: true
 
 require 'pagy/calendar'
@@ -8,18 +8,17 @@ class Pagy # :nodoc:
   # Add pagination filtering by calendar unit (:year, :quarter, :month, :week, :day) to the regular pagination
   module CalendarExtra
     # Additions for the Backend module
-    module Backend
+    module BackendAddOn
       CONF_KEYS = (Calendar::UNITS + %i[pagy active]).freeze
 
       private
 
       # Take a collection and a conf Hash with keys in CONF_KEYS and return an array with 3 items: [calendar, pagy, results]
       def pagy_calendar(collection, conf)
-        unless conf.is_a?(Hash) && (conf.keys - CONF_KEYS).empty? && conf.all? { |k, v| v.is_a?(Hash) || k == :active }
-          raise ArgumentError, "keys must be in #{CONF_KEYS.inspect} and object values must be Hashes; got #{conf.inspect}"
-        end
+        raise ArgumentError, "keys must be in #{CONF_KEYS.inspect}" \
+              unless conf.is_a?(Hash) && (conf.keys - CONF_KEYS).empty?
 
-        conf[:pagy] = {} unless conf[:pagy]  # use default Pagy object when omitted
+        conf[:pagy] ||= {}
         unless conf.key?(:active) && !conf[:active]
           calendar, from, to = Calendar::Helper.send(:init, conf, pagy_calendar_period(collection), params)
           collection         = pagy_calendar_filter(collection, from, to)
@@ -28,22 +27,27 @@ class Pagy # :nodoc:
         [calendar, pagy, results]
       end
 
-      def pagy_calendar_url_at(calendar, time)
-        pagy_url_for(calendar.send(:last_object_at, time), 1)
-      end
-
       # This method must be implemented by the application
       def pagy_calendar_period(*)
         raise NoMethodError, 'the pagy_calendar_period method must be implemented by the application ' \
-                             '(see https://ddnexus.github.io/pagy/extras/calendar#pagy_calendar_periodcollection)'
+                             '(see https://ddnexus.github.io/pagy/docs/extras/calendar/#pagy-calendar-period-collection)'
       end
 
       # This method must be implemented by the application
       def pagy_calendar_filter(*)
         raise NoMethodError, 'the pagy_calendar_filter method must be implemented by the application ' \
-                             '(see https://ddnexus.github.io/pagy/extras/calendar#pagy_calendar_filtercollection-from-to)'
+                             '(see https://ddnexus.github.io/pagy/docs/extras/calendar/#pagy-calendar-filter-collection-from-to)'
+      end
+    end
+
+    # Additions for the Frontend module
+    module UrlHelperAddOn
+      # Return the url for the calendar page at time
+      def pagy_calendar_url_at(calendar, time, **opts)
+        pagy_url_for(calendar.send(:calendar_at, time, **opts), 1, **opts)
       end
     end
   end
-  Backend.prepend CalendarExtra::Backend
+  Backend.prepend CalendarExtra::BackendAddOn, CalendarExtra::UrlHelperAddOn
+  Frontend.prepend CalendarExtra::UrlHelperAddOn
 end

data/lib/pagy/extras/countless.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/countless
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/countless
 # frozen_string_literal: true
 
 require 'pagy/countless'

data/lib/pagy/extras/elasticsearch_rails.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/elasticsearch_rails
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/elasticsearch_rails
 # frozen_string_literal: true
 
 class Pagy # :nodoc:
@@ -19,7 +19,7 @@ class Pagy # :nodoc:
       total.is_a?(Hash) ? total['value'] : total
     end
 
-    module ElasticsearchRails # :nodoc:
+    module ModelExtension # :nodoc:
       # Return an array used to delay the call of #search
       # after the pagination variables are merged to the options.
       # It also pushes to the same array an optional method call.
@@ -30,9 +30,10 @@ class Pagy # :nodoc:
       end
       alias_method Pagy::DEFAULT[:elasticsearch_rails_pagy_search], :pagy_elasticsearch_rails
     end
+    Pagy::ElasticsearchRails = ModelExtension
 
     # Additions for the Pagy class
-    module Pagy
+    module PagyAddOn
       # Create a Pagy object from an Elasticsearch::Model::Response::Response object
       def new_from_elasticsearch_rails(response, vars = {})
         vars[:items] = response.search.options[:size] || 10
@@ -41,9 +42,10 @@ class Pagy # :nodoc:
         new(vars)
       end
     end
+    Pagy.extend PagyAddOn
 
     # Add specialized backend methods to paginate ElasticsearchRails searches
-    module Backend
+    module BackendAddOn
       private
 
       # Return Pagy object and items
@@ -69,12 +71,10 @@ class Pagy # :nodoc:
       def pagy_elasticsearch_rails_get_vars(_collection, vars)
         pagy_set_items_from_params(vars) if defined?(ItemsExtra)
         vars[:items] ||= DEFAULT[:items]
-        vars[:page]  ||= (params[vars[:page_param] || DEFAULT[:page_param]] || 1).to_i
+        vars[:page]  ||= pagy_get_page(vars)
         vars
       end
     end
+    Backend.prepend BackendAddOn
   end
-  ElasticsearchRails = ElasticsearchRailsExtra::ElasticsearchRails
-  extend ElasticsearchRailsExtra::Pagy
-  Backend.prepend ElasticsearchRailsExtra::Backend
 end

data/lib/pagy/extras/foundation.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/foundation
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/foundation
 # frozen_string_literal: true
 
 require 'pagy/extras/frontend_helpers'
@@ -8,18 +8,24 @@ class Pagy # :nodoc:
   # The resulting code may not look very elegant, but produces the best benchmarks
   module FoundationExtra
     # Pagination for Foundation: it returns the html with the series of links to the pages
-    def pagy_foundation_nav(pagy, pagy_id: nil, link_extra: '', **vars)
+    def pagy_foundation_nav(pagy, pagy_id: nil, link_extra: '',
+                            nav_aria_label: nil, nav_i18n_key: nil, **vars)
       p_id = %( id="#{pagy_id}") if pagy_id
-      link = pagy_link_proc(pagy, link_extra: link_extra)
+      link = pagy_link_proc(pagy, link_extra:)
 
-      html = +%(<nav#{p_id} class="pagy-foundation-nav" aria-label="Pagination"><ul class="pagination">)
-      html << pagy_foundation_prev_html(pagy, link)
+      html = +%(<nav#{p_id} class="pagy-foundation-nav" #{
+                 nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}><ul class="pagination">)
+      html << foundation_prev_html(pagy, link)
       pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
-                when Integer then %(<li>#{link.call item}</li>)                        # page link
-                when String  then %(<li class="current">#{pagy.label_for(item)}</li>)                  # active page
-                when :gap    then %(<li class="ellipsis gap" aria-hidden="true"></li>) # page gap
-                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
+                when Integer
+                  %(<li>#{link.call item}</li>)
+                when String
+                  %(<li class="current" role="link" aria-current="page" aria-disabled="true">#{pagy.label_for(item)}</li>)
+                when :gap
+                  %(<li class="ellipsis gap"></li>)
+                else
+                  raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_foundation_next_html(pagy, link)
@@ -27,62 +33,71 @@ class Pagy # :nodoc:
     end
 
     # Javascript pagination for foundation: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_foundation_nav_js(pagy, pagy_id: nil, link_extra: '', **vars)
+    def pagy_foundation_nav_js(pagy, pagy_id: nil, link_extra: '',
+                               nav_aria_label: nil, nav_i18n_key: nil, **vars)
       sequels = pagy.sequels(**vars)
       p_id = %( id="#{pagy_id}") if pagy_id
-      link = pagy_link_proc(pagy, link_extra: link_extra)
-      tags = { 'before' => %(<ul class="pagination">#{pagy_foundation_prev_html pagy, link}),
+      link = pagy_link_proc(pagy, link_extra:)
+      tags = { 'before' => %(<ul class="pagination">#{foundation_prev_html pagy, link}),
                'link'   => %(<li>#{link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</li>),
-               'active' => %(<li class="current">#{LABEL_PLACEHOLDER}</li>),
-               'gap'    => %(<li class="ellipsis gap" aria-hidden="true"></li>),
+               'active' => %(<li class="current" role="link" aria-current="page" aria-disabled="true">#{LABEL_PLACEHOLDER}</li>),
+               'gap'    => %(<li class="ellipsis gap"></li>),
                'after'  => %(#{pagy_foundation_next_html pagy, link}</ul>) }
 
-      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-foundation-nav-js" aria-label="Pagination" #{
-        pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
+      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-foundation-nav-js" #{
+          nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)} #{
+          pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
     end
 
     # Javascript combo pagination for Foundation: it returns a nav and a JSON tag used by the pagy.js file
-    def pagy_foundation_combo_nav_js(pagy, pagy_id: nil, link_extra: '')
+    def pagy_foundation_combo_nav_js(pagy, pagy_id: nil, link_extra: '',
+                                     nav_aria_label: nil, nav_i18n_key: nil)
       p_id    = %( id="#{pagy_id}") if pagy_id
-      link    = pagy_link_proc(pagy, link_extra: link_extra)
+      link    = pagy_link_proc(pagy, link_extra:)
       p_page  = pagy.page
       p_pages = pagy.pages
       input   = %(<input class="input-group-field cell shrink" type="number" min="1" max="#{
                     p_pages}" value="#{p_page}" style="width: #{
-                    p_pages.to_s.length + 1}rem; padding: 0 0.3rem; margin: 0 0.3rem;">)
+                    p_pages.to_s.length + 1}rem; padding: 0 0.3rem; margin: 0 0.3rem;" aria-current="page">)
 
-      %(<nav#{p_id} class="pagy-foundation-combo-nav-js" aria-label="Pagination"><div class="input-group" #{
+      %(<nav#{p_id} class="pagy-foundation-combo-nav-js" #{
+          nav_aria_label_attr(pagy, nav_aria_label, nav_i18n_key)}><div class="input-group" #{
           pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
-          if (p_prev  = pagy.prev)
-            link.call p_prev, pagy_t('pagy.nav.prev'),
-                      'style="margin-bottom: 0" aria-label="previous" class="prev button primary"'
+          if (p_prev = pagy.prev)
+            link.call(p_prev, pagy_t('pagy.prev'),
+                      %(style="margin-bottom: 0" class="prev button primary" #{prev_aria_label_attr}))
           else
-            %(<a style="margin-bottom: 0" class="prev button primary disabled" href="#">#{pagy_t 'pagy.nav.prev'}</a>)
+            %(<a style="margin-bottom: 0" class="prev button primary disabled" role="link" aria-disabled="true" #{
+                prev_aria_label_attr}>#{pagy_t('pagy.prev')}</a>)
           end
-        }<span class="input-group-label">#{pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages}</span>#{
-          if (p_next  = pagy.next)
-            link.call p_next, pagy_t('pagy.nav.next'), 'style="margin-bottom: 0" aria-label="next" class="next button primary"'
+        }#{
+          pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)
+          .sub!('<label>', '<label class="input-group-label">')}#{ # add the class to the official dictionary string
+          if (p_next = pagy.next)
+            link.call(p_next, pagy_t('pagy.next'),
+                      %(style="margin-bottom: 0" class="next button primary" #{next_aria_label_attr}))
           else
-            %(<a style="margin-bottom: 0" class="next button primary disabled" href="#">#{pagy_t 'pagy.nav.next'}</a>)
+            %(<a style="margin-bottom: 0" class="next button primary disabled" role="link" aria-disabled="true" #{
+                next_aria_label_attr}>#{pagy_t 'pagy.next'}</a>)
           end
         }</div></nav>)
     end
 
     private
 
-    def pagy_foundation_prev_html(pagy, link)
+    def foundation_prev_html(pagy, link)
       if (p_prev = pagy.prev)
-        %(<li class="prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+        %(<li class="prev">#{link.call(p_prev, pagy_t('pagy.prev'), prev_aria_label_attr)}</li>)
       else
-        %(<li class="prev disabled">#{pagy_t 'pagy.nav.prev'}</li>)
+        %(<li class="prev disabled" role="link" aria-disabled="true" #{prev_aria_label_attr}>#{pagy_t('pagy.prev')}</li>)
       end
     end
 
     def pagy_foundation_next_html(pagy, link)
       if (p_next = pagy.next)
-        %(<li class="next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
+        %(<li class="next">#{link.call(p_next, pagy_t('pagy.next'), next_aria_label_attr)}</li>)
       else
-        %(<li class="next disabled">#{pagy_t 'pagy.nav.next'}</li>)
+        %(<li class="next disabled" role="link" aria-disabled="true" #{next_aria_label_attr}>#{pagy_t('pagy.next')}</li>)
       end
     end
   end

data/lib/pagy/extras/frontend_helpers.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'base64'
-
 class Pagy # :nodoc:
   DEFAULT[:steps] = false # default false will use {0 => @vars[:size]}
 
   # Private module documented in the main classes
   module FrontendHelpers
     # Additions for the Pagy class
-    module Pagy
+    module PagyAddOn
       # `Pagy` instance method used by the `pagy*_nav_js` helpers.
       # It returns the sequels of width/series generated from the :steps hash
       # Example:
@@ -29,9 +27,10 @@ class Pagy # :nodoc:
       # Support for the Calendar API
       def label_sequels(*); end
     end
+    Pagy.prepend PagyAddOn
 
     # Additions for Calendar class
-    module Calendar
+    module CalendarOverride
       def label_sequels(sequels = self.sequels)
         {}.tap do |label_sequels|
           sequels.each do |width, series|
@@ -40,15 +39,17 @@ class Pagy # :nodoc:
         end
       end
     end
+    Calendar.prepend CalendarOverride if defined?(Calendar)
 
     # Additions for the Frontend
-    module Frontend
+    module FrontendAddOn
       if defined?(Oj)
         # Return a data tag with the base64 encoded JSON-serialized args generated with the faster oj gem
         # Base64 encoded JSON is smaller than HTML escaped JSON
         def pagy_data(pagy, *args)
           args << pagy.vars[:page_param] if pagy.vars[:trim_extra]
-          %(data-pagy="#{Base64.strict_encode64(Oj.dump(args, mode: :strict))}")
+          strict_base64_encoded = [Oj.dump(args, mode: :strict)].pack('m0')
+          %(data-pagy="#{strict_base64_encoded}")
         end
       else
         require 'json'
@@ -56,17 +57,16 @@ class Pagy # :nodoc:
         # Base64 encoded JSON is smaller than HTML escaped JSON
         def pagy_data(pagy, *args)
           args << pagy.vars[:page_param] if pagy.vars[:trim_extra]
-          %(data-pagy="#{Base64.strict_encode64(args.to_json)}")
+          strict_base64_encoded = [args.to_json].pack('m0')
+          %(data-pagy="#{strict_base64_encoded}")
         end
       end
 
-      # Return the marked link to used by pagy.js
+      # Return the marked link used by pagy.js
       def pagy_marked_link(link)
         link.call PAGE_PLACEHOLDER, '', 'style="display: none;"'
       end
     end
+    Frontend.prepend FrontendAddOn
   end
-  prepend FrontendHelpers::Pagy
-  Calendar.prepend FrontendHelpers::Calendar if defined?(Calendar)
-  Frontend.prepend FrontendHelpers::Frontend
 end

data/lib/pagy/extras/gearbox.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/gearbox
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/gearbox
 # frozen_string_literal: true
 
 class Pagy # :nodoc: