pagy 8.6.3 → 9.3.4

data/lib/pagy/extras/jsonapi.rb

@@ -18,16 +18,25 @@ class Pagy # :nodoc:
 
     # Module overriding Backend
     module BackendOverride
-      private
-
       include UrlHelpers
 
+      private(*UrlHelpers.instance_methods)
+
+      private
+
       # Return the jsonapi links
       def pagy_jsonapi_links(pagy, **opts)
-        { first: pagy_url_for(pagy, 1,         **opts),
-          last:  pagy_url_for(pagy, pagy.last, **opts),
-          prev:  pagy.prev ? pagy_url_for(pagy, pagy.prev, **opts) : nil,
-          next:  pagy.next ? pagy_url_for(pagy, pagy.next, **opts) : nil }
+        if defined?(::Pagy::Keyset) && pagy.is_a?(Keyset)
+          { first: pagy_url_for(pagy, nil, **opts),
+            last: nil,
+            prev: nil,
+            next:  pagy.next ? pagy_url_for(pagy, pagy.next, **opts) : nil }
+        else
+          { first: pagy_url_for(pagy, 1, **opts),
+            last:  pagy_url_for(pagy, pagy.last, **opts),
+            prev:  pagy.prev ? pagy_url_for(pagy, pagy.prev, **opts) : nil,
+            next:  pagy.next ? pagy_url_for(pagy, pagy.next, **opts) : nil }
+        end
       end
 
       # Should skip the jsonapi
@@ -38,40 +47,40 @@ class Pagy # :nodoc:
       end
 
       # Override the Backend method
-      def pagy_get_page(vars)
-        return super if pagy_skip_jsonapi?(vars)
-        return 1 if params[:page].nil?
+      def pagy_get_page(vars, force_integer: true)
+        return super if pagy_skip_jsonapi?(vars) || params[:page].nil?
 
-        [params[:page][vars[:page_param] || DEFAULT[:page_param]].to_i, 1].max
+        page = params[:page][vars[:page_param] || DEFAULT[:page_param]]
+        force_integer ? (page || 1).to_i : page
       end
     end
     Backend.prepend BackendOverride
 
-    # Module overriding ItemsExtra
-    module ItemsExtraOverride
+    # Module overriding LimitExtra
+    module LimitExtraOverride
       private
 
-      # Override the ItemsExtra::Backend method
-      def pagy_get_items_size(vars)
+      # Override the LimitExtra::Backend method
+      def pagy_get_limit_param(vars)
         return super if pagy_skip_jsonapi?(vars)
-        return if params[:page].nil?
+        return unless params[:page]
 
-        params[:page][vars[:items_param] || DEFAULT[:items_param]]
+        params[:page][vars[:limit_param] || DEFAULT[:limit_param]]
       end
     end
     # :nocov:
-    ItemsExtra::BackendAddOn.prepend ItemsExtraOverride if defined?(ItemsExtra::BackendAddOn)
+    LimitExtra::BackendAddOn.prepend LimitExtraOverride if defined?(::Pagy::LimitExtra::BackendAddOn)
     # :nocov:
 
     # Module overriding UrlHelper
     module UrlHelperOverride
       # Override UrlHelper method
-      def pagy_set_query_params(page, vars, params)
+      def pagy_set_query_params(page, vars, query_params)
         return super unless vars[:jsonapi]
 
-        params['page'] ||= {}
-        params['page'][vars[:page_param].to_s]  = page
-        params['page'][vars[:items_param].to_s] = vars[:items] if vars[:items_extra]
+        query_params['page'] ||= {}
+        query_params['page'][vars[:page_param].to_s]  = page
+        query_params['page'][vars[:limit_param].to_s] = vars[:limit] if vars[:limit_extra]
       end
     end
     UrlHelpers.prepend UrlHelperOverride

data/lib/pagy/extras/keyset.rb

@@ -0,0 +1,30 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/keyset
+# frozen_string_literal: true
+
+require_relative '../keyset'
+
+class Pagy # :nodoc:
+  # Add keyset pagination
+  module KeysetExtra
+    private
+
+    # Return Pagy::Keyset object and paginated records
+    def pagy_keyset(set, **vars)
+      vars[:page]  ||= pagy_get_page(vars, force_integer: false) # allow nil
+      vars[:limit] ||= pagy_get_limit(vars)
+      pagy = Keyset.new(set, **vars)
+      [pagy, pagy.records]
+    end
+
+    # Return the URL string for the first page
+    def pagy_keyset_first_url(pagy, **vars)
+      pagy_url_for(pagy, nil, **vars)
+    end
+
+    # Return the URL string for the next page or nil
+    def pagy_keyset_next_url(pagy, **vars)
+      pagy_url_for(pagy, pagy.next, **vars) if pagy.next
+    end
+  end
+  Backend.prepend KeysetExtra
+end

data/lib/pagy/extras/limit.rb

@@ -0,0 +1,63 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/limit
+# frozen_string_literal: true
+
+require_relative 'js_tools'
+
+class Pagy # :nodoc:
+  DEFAULT[:limit_param] = :limit
+  DEFAULT[:limit_max]   = 100
+  DEFAULT[:limit_extra] = true   # extra enabled by default
+
+  # Allow the client to request a custom limit per page with an optional selector UI
+  module LimitExtra
+    # Additions for the Backend module
+    module BackendAddOn
+      private
+
+      # Set the limit variable considering the params and other pagy variables
+      def pagy_get_limit(vars)
+        return super unless vars.key?(:limit_extra) ? vars[:limit_extra] : DEFAULT[:limit_extra] # :limit_extra is false
+        return super unless (limit_count = pagy_get_limit_param(vars))                            # no limit from request params
+
+        vars[:limit] = [limit_count.to_i, vars.key?(:limit_max) ? vars[:limit_max] : DEFAULT[:limit_max]].compact.min
+      end
+
+      # Get the limit count from the params
+      # Overridable by the jsonapi extra
+      def pagy_get_limit_param(vars)
+        params[vars[:limit_param] || DEFAULT[:limit_param]]
+      end
+    end
+    Backend.prepend LimitExtra::BackendAddOn
+
+    # Additions for the Frontend module
+    module FrontendAddOn
+      LIMIT_TOKEN = '__pagy_limit__'
+
+      # Return the limit selector HTML. For example "Show [20] items per page"
+      def pagy_limit_selector_js(pagy, id: nil, item_name: nil)
+        return '' unless pagy.vars[:limit_extra]
+
+        id           = %( id="#{id}") if id
+        vars         = pagy.vars
+        limit        = vars[:limit]
+        vars[:limit] = LIMIT_TOKEN
+        url_token    = pagy_url_for(pagy, PAGE_TOKEN)
+        vars[:limit] = limit # restore the limit
+
+        limit_input = %(<input name="limit" type="number" min="1" max="#{vars[:limit_max]}" value="#{
+                          limit}" style="padding: 0; text-align: center; width: #{limit.to_s.length + 1}rem;">#{JSTools::A_TAG})
+
+        %(<span#{id} class="pagy limit-selector-js" #{
+            pagy_data(pagy, :selector, pagy.from, url_token)
+          }><label>#{
+            pagy_t('pagy.limit_selector_js',
+                   item_name: item_name || pagy_t('pagy.item_name', count: limit),
+                   limit_input:,
+                   count: limit)
+          }</label></span>)
+      end
+    end
+    Frontend.prepend LimitExtra::FrontendAddOn
+  end
+end

data/lib/pagy/extras/meilisearch.rb

@@ -20,12 +20,12 @@ class Pagy # :nodoc:
     # Extension for the Pagy class
     module PagyExtension
       # Create a Pagy object from a Meilisearch results
-      def new_from_meilisearch(results, vars = {})
-        vars[:items] = results.raw_answer['hitsPerPage']
+      def new_from_meilisearch(results, **vars)
+        vars[:limit] = results.raw_answer['hitsPerPage']
         vars[:page]  = results.raw_answer['page']
         vars[:count] = results.raw_answer['totalHits']
 
-        new(vars)
+        new(**vars)
       end
     end
     Pagy.extend PagyExtension
@@ -35,30 +35,22 @@ class Pagy # :nodoc:
       private
 
       # Return Pagy object and results
-      def pagy_meilisearch(pagy_search_args, vars = {})
+      def pagy_meilisearch(pagy_search_args, **vars)
+        vars[:page]  ||= pagy_get_page(vars)
+        vars[:limit] ||= pagy_get_limit(vars)
         model, term, options    = pagy_search_args
-        vars                    = pagy_meilisearch_get_vars(nil, vars)
-        options[:hits_per_page] = vars[:items]
+        options[:hits_per_page] = vars[:limit]
         options[:page]          = vars[:page]
         results                 = model.send(:ms_search, term, options)
         vars[:count]            = results.raw_answer['totalHits']
 
-        pagy                    = ::Pagy.new(vars)
+        pagy                    = ::Pagy.new(**vars)
         # with :last_page overflow we need to re-run the method in order to get the hits
-        return pagy_meilisearch(pagy_search_args, vars.merge(page: pagy.page)) \
+        return pagy_meilisearch(pagy_search_args, **vars, page: pagy.page) \
                if defined?(::Pagy::OverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
 
         [pagy, results]
       end
-
-      # Sub-method called only by #pagy_meilisearch: here for easy customization of variables by overriding.
-      # The _collection argument is not available when the method is called.
-      def pagy_meilisearch_get_vars(_collection, vars)
-        pagy_set_items_from_params(vars) if defined?(ItemsExtra)
-        vars[:items] ||= DEFAULT[:items]
-        vars[:page]  ||= pagy_get_page(vars)
-        vars
-      end
     end
     Backend.prepend BackendAddOn
   end

data/lib/pagy/extras/metadata.rb

@@ -5,7 +5,7 @@ require_relative '../url_helpers'
 
 class Pagy # :nodoc:
   DEFAULT[:metadata] = %i[ scaffold_url first_url prev_url page_url next_url last_url
-                           count page items vars pages last in from to prev next series ]
+                           count page limit vars pages last in from to prev next series ]
 
   # Add a specialized backend method for pagination metadata
   module MetadataExtra
@@ -17,8 +17,8 @@ class Pagy # :nodoc:
     def pagy_metadata(pagy, absolute: nil)
       scaffold_url = pagy_url_for(pagy, PAGE_TOKEN, absolute:)
       {}.tap do |metadata|
-        keys = if defined?(Calendar::Unit) && pagy.is_a?(Calendar::Unit)
-                 pagy.vars[:metadata] - %i[count items]
+        keys = if defined?(::Pagy::Calendar::Unit) && pagy.is_a?(Calendar::Unit)
+                 pagy.vars[:metadata] - %i[count limit]
                else
                  pagy.vars[:metadata]
                end

data/lib/pagy/extras/overflow.rb

@@ -14,7 +14,7 @@ class Pagy # :nodoc:
       end
 
       # Add rescue clause for different behaviors
-      def initialize(vars)
+      def initialize(**vars)
         @overflow ||= false                            # still true if :last_page re-run the method after an overflow
         super
       rescue OverflowError
@@ -24,14 +24,14 @@ class Pagy # :nodoc:
           raise                                        # same as without the extra
         when :last_page
           requested_page = @vars[:page]                # save the requested page (even after re-run)
-          initialize vars.merge!(page: @last)          # re-run with the last page
+          initialize(**vars, page: @last)              # re-run with the last page
           @vars[:page] = requested_page                # restore the requested page
         when :empty_page
-          @offset = @items = @in = @from = @to = 0     # vars relative to the actual page
-          if defined?(Calendar::Unit) \
+          @in = @from = @to = 0                        # vars relative to the actual page
+          if defined?(::Pagy::Calendar::Unit) \
               && is_a?(Calendar::Unit)                 # only for Calendar::Units instances
             edge = @order == :asc ? @final : @initial  # get the edge of the overflow side (neat, but any time would do)
-            @from = @to = edge                         # set both to the edge utc time (a >=&&< query will get no records)
+            @from = @to = edge                         # set both to the edge time (a >=&&< query will get no records)
           end
           @prev = @last                                # prev relative to the actual page
           extend Series                                # special series for :empty_page
@@ -52,12 +52,12 @@ class Pagy # :nodoc:
       end
     end
     Pagy.prepend PagyOverride
-    Pagy::Calendar::Unit.prepend PagyOverride if defined?(Calendar::Unit)
+    Pagy::Calendar::Unit.prepend PagyOverride if defined?(::Pagy::Calendar::Unit)
 
     # Support for Pagy::Countless class
     module CountlessOverride
       # Add rescue clause for different behaviors
-      def finalize(items)
+      def finalize(fetched_size)
         @overflow = false
         super
       rescue OverflowError
@@ -66,7 +66,7 @@ class Pagy # :nodoc:
         when :exception
           raise                                        # same as without the extra
         when :empty_page
-          @offset = @items = @from = @to = 0           # vars relative to the actual page
+          @offset = @limit = @from = @to = 0           # vars relative to the actual page
           @vars[:size] = 0                             # no page in the series
           self
         else
@@ -75,7 +75,7 @@ class Pagy # :nodoc:
       end
     end
     # :nocov:
-    Pagy::Countless.prepend CountlessOverride if defined?(Countless)
+    Pagy::Countless.prepend CountlessOverride if defined?(::Pagy::Countless)
     # :nocov:
   end
 end

data/lib/pagy/extras/pagy.rb

@@ -12,7 +12,7 @@ class Pagy # :nodoc:
     def pagy_nav_js(pagy, id: nil, aria_label: nil, **vars)
       sequels = pagy.sequels(**vars)
       id      = %( id="#{id}") if id
-      a       = pagy_anchor(pagy)
+      a       = pagy_anchor(pagy, **vars)
       tokens  = { 'before'  => prev_a(pagy, a),
                   'a'       => a.(PAGE_TOKEN, LABEL_TOKEN),
                   'current' => %(<a class="current" role="link" aria-current="page" aria-disabled="true">#{
@@ -27,9 +27,9 @@ class Pagy # :nodoc:
     end
 
     # Javascript combo pagination: it returns a nav with a data-pagy attribute used by the pagy.js file
-    def pagy_combo_nav_js(pagy, id: nil, aria_label: nil)
+    def pagy_combo_nav_js(pagy, id: nil, aria_label: nil, **vars)
       id    = %( id="#{id}") if id
-      a     = pagy_anchor(pagy)
+      a     = pagy_anchor(pagy, **vars)
       pages = pagy.pages
 
       page_input = %(<input name="page" type="number" min="1" max="#{pages}" value="#{pagy.page}" aria-current="page" ) <<
@@ -37,7 +37,7 @@ class Pagy # :nodoc:
 
       %(<nav#{id} class="pagy combo-nav-js" #{
           nav_aria_label(pagy, aria_label:)} #{
-          pagy_data(pagy, :combo, pagy_url_for(pagy, PAGE_TOKEN))}>#{
+          pagy_data(pagy, :combo, pagy_url_for(pagy, PAGE_TOKEN, **vars))}>#{
           prev_a(pagy, a)
         }<label>#{
           pagy_t('pagy.combo_nav_js', page_input:, pages:)
@@ -47,35 +47,35 @@ class Pagy # :nodoc:
     end
 
     # Return the previous page URL string or nil
-    def pagy_prev_url(pagy, absolute: false)
-      pagy_url_for(pagy, pagy.prev, absolute:) if pagy.prev
+    def pagy_prev_url(pagy, **vars)
+      pagy_url_for(pagy, pagy.prev, **vars) if pagy.prev
     end
 
     # Return the next page URL string or nil
-    def pagy_next_url(pagy, absolute: false)
-      pagy_url_for(pagy, pagy.next, absolute:) if pagy.next
+    def pagy_next_url(pagy, **vars)
+      pagy_url_for(pagy, pagy.next, **vars) if pagy.next
     end
 
     # Return the enabled/disabled previous page anchor tag
-    def pagy_prev_a(pagy, text: pagy_t('pagy.prev'), aria_label: pagy_t('pagy.aria_label.prev'))
-      a = pagy_anchor(pagy)
+    def pagy_prev_a(pagy, text: pagy_t('pagy.prev'), aria_label: pagy_t('pagy.aria_label.prev'), **vars)
+      a = pagy_anchor(pagy, **vars)
       prev_a(pagy, a, text:, aria_label:)
     end
 
     # Return the enabled/disabled next page anchor tag
-    def pagy_next_a(pagy, text: pagy_t('pagy.next'), aria_label: pagy_t('pagy.aria_label.next'))
-      a = pagy_anchor(pagy)
+    def pagy_next_a(pagy, text: pagy_t('pagy.next'), aria_label: pagy_t('pagy.aria_label.next'), **vars)
+      a = pagy_anchor(pagy, **vars)
       next_a(pagy, a, text:, aria_label:)
     end
 
     # Conditionally return the previous page link tag
-    def pagy_prev_link(pagy, absolute: false)
-      %(<link href="#{pagy_url_for(pagy, pagy.prev, absolute:)}"/>) if pagy.prev
+    def pagy_prev_link(pagy, **vars)
+      %(<link href="#{pagy_url_for(pagy, pagy.prev, **vars)}"/>) if pagy.prev
     end
 
     # Conditionally return the next page link tag
-    def pagy_next_link(pagy, absolute: false)
-      %(<link href="#{pagy_url_for(pagy, pagy.next, absolute:)}"/>) if pagy.next
+    def pagy_next_link(pagy, **vars)
+      %(<link href="#{pagy_url_for(pagy, pagy.next, **vars)}"/>) if pagy.next
     end
   end
   Frontend.prepend PagyExtra

data/lib/pagy/extras/searchkick.rb

@@ -23,11 +23,11 @@ class Pagy # :nodoc:
     # Additions for the Pagy class
     module PagyExtension
       # Create a Pagy object from a Searchkick::Results object
-      def new_from_searchkick(results, vars = {})
-        vars[:items] = results.options[:per_page]
+      def new_from_searchkick(results, **vars)
+        vars[:limit] = results.options[:per_page]
         vars[:page]  = results.options[:page]
         vars[:count] = results.total_count
-        new(vars)
+        new(**vars)
       end
     end
     Pagy.extend PagyExtension
@@ -37,30 +37,22 @@ class Pagy # :nodoc:
       private
 
       # Return Pagy object and results
-      def pagy_searchkick(pagy_search_args, vars = {})
+      def pagy_searchkick(pagy_search_args, **vars)
+        vars[:page]  ||= pagy_get_page(vars)
+        vars[:limit] ||= pagy_get_limit(vars)
         model, term, options, block, *called = pagy_search_args
-        vars               = pagy_searchkick_get_vars(nil, vars)
-        options[:per_page] = vars[:items]
+        options[:per_page] = vars[:limit]
         options[:page]     = vars[:page]
         results            = model.send(DEFAULT[:searchkick_search], term, **options, &block)
         vars[:count]       = results.total_count
 
-        pagy = ::Pagy.new(vars)
+        pagy = ::Pagy.new(**vars)
         # with :last_page overflow we need to re-run the method in order to get the hits
-        return pagy_searchkick(pagy_search_args, vars.merge(page: pagy.page)) \
+        return pagy_searchkick(pagy_search_args, **vars, page: pagy.page) \
                if defined?(::Pagy::OverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
 
         [pagy, called.empty? ? results : results.send(*called)]
       end
-
-      # Sub-method called only by #pagy_searchkick: here for easy customization of variables by overriding
-      # the _collection argument is not available when the method is called
-      def pagy_searchkick_get_vars(_collection, vars)
-        pagy_set_items_from_params(vars) if defined?(ItemsExtra)
-        vars[:items] ||= DEFAULT[:items]
-        vars[:page]  ||= pagy_get_page(vars)
-        vars
-      end
     end
     Backend.prepend BackendAddOn
   end

data/lib/pagy/extras/size.rb

@@ -5,7 +5,7 @@ class Pagy # :nodoc:
   # Implement the legacy bar using the array size.
   # Unless you have very specific requirements, use the faster and better looking default bar.
   module SizeExtra
-    # Setup @items based on the :gearbox_items variable
+    # Implements the old series algorithm
     def series(size: @vars[:size], **_)
       return super unless size.is_a?(Array)
       return [] if size == []

data/lib/pagy/extras/standalone.rb

@@ -12,10 +12,6 @@ class Pagy # :nodoc:
     module QueryUtils
       module_function
 
-      def escape(str)
-        URI.encode_www_form_component(str)
-      end
-
       def build_nested_query(value, prefix = nil)
         case value
         when Array
@@ -32,13 +28,17 @@ class Pagy # :nodoc:
           "#{escape(prefix)}=#{escape(value)}"
         end
       end
+
+      def escape(str)
+        URI.encode_www_form_component(str)
+      end
     end
     # :nocov:
 
     # Return the URL for the page. If there is no pagy.vars[:url]
     # it works exactly as the regular #pagy_url_for, relying on the params method and Rack.
     # If there is a defined pagy.vars[:url] variable it does not need the params method nor Rack.
-    def pagy_url_for(pagy, page, absolute: false, **_)
+    def pagy_url_for(pagy, page, fragment: nil, **_)
       return super unless pagy.vars[:url]
 
       vars         = pagy.vars
@@ -46,7 +46,7 @@ class Pagy # :nodoc:
       pagy_set_query_params(page, vars, params)
       params       = vars[:params].(params) if vars[:params].is_a?(Proc)
       query_string = "?#{QueryUtils.build_nested_query(params)}"
-      "#{vars[:url]}#{query_string}#{vars[:fragment]}"
+      "#{vars[:url]}#{query_string}#{fragment}"
     end
   end
   UrlHelpers.prepend StandaloneExtra

data/lib/pagy/extras/trim.rb

@@ -6,9 +6,9 @@ class Pagy # :nodoc:
 
   # Remove the page=1 param from the first page link
   module TrimExtra
-    # Override the original pagy_a_proc.
+    # Override the original pagy_anchor.
     # Call the pagy_trim method for page 1 if the trim_extra is enabled
-    def pagy_anchor(pagy)
+    def pagy_anchor(pagy, **_)
       a_proc = super
       return a_proc unless pagy.vars[:trim_extra]
 
@@ -20,7 +20,7 @@ class Pagy # :nodoc:
       end
     end
 
-    # Remove the the :page_param param from the first page anchor
+    # Remove the :page_param param from the first page anchor
     def pagy_trim(pagy, a)
       a.sub!(/[?&]#{pagy.vars[:page_param]}=1\b(?!&)|\b#{pagy.vars[:page_param]}=1&/, '')
     end

data/lib/pagy/frontend.rb

@@ -1,8 +1,8 @@
 # See Pagy::Frontend API documentation: https://ddnexus.github.io/pagy/docs/api/frontend
 # frozen_string_literal: true
 
-require_relative 'url_helpers'
 require_relative 'i18n'
+require_relative 'url_helpers'
 
 class Pagy
   # Used for search and replace, hardcoded also in the pagy.js file
@@ -14,26 +14,17 @@ class Pagy
   module Frontend
     include UrlHelpers
 
-    # Generic pagination: it returns the html with the series of links to the pages
-    def pagy_nav(pagy, id: nil, aria_label: nil, **vars)
-      id = %( id="#{id}") if id
-      a  = pagy_anchor(pagy)
-
-      html = %(<nav#{id} class="pagy nav" #{nav_aria_label(pagy, aria_label:)}>#{
-                 prev_a(pagy, a)})
-      pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-        html << case item
-                when Integer
-                  a.(item)
-                when String
-                  %(<a role="link" aria-disabled="true" aria-current="page" class="current">#{pagy.label_for(item)}</a>)
-                when :gap
-                  %(<a role="link" aria-disabled="true" class="gap">#{pagy_t('pagy.gap')}</a>)
-                else
-                  raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
-                end
+    # Return a performance optimized lambda to generate the HTML anchor element (a tag)
+    # Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails' link_to
+    def pagy_anchor(pagy, anchor_string: nil, **vars)
+      anchor_string &&= %( #{anchor_string})
+      left, right = %(<a#{anchor_string} href="#{pagy_url_for(pagy, PAGE_TOKEN, **vars)}").split(PAGE_TOKEN, 2)
+      # lambda used by all the helpers
+      lambda do |page, text = pagy.label_for(page), classes: nil, aria_label: nil|
+        classes    = %( class="#{classes}") if classes
+        aria_label = %( aria-label="#{aria_label}") if aria_label
+        %(#{left}#{page}#{right}#{classes}#{aria_label}>#{text}</a>)
       end
-      html << %(#{next_a(pagy, a)}</nav>)
     end
 
     # Return examples: "Displaying items 41-60 of 324 in total" or "Displaying Products 41-60 of 324 in total"
@@ -54,24 +45,32 @@ class Pagy
         }</span>)
     end
 
-    # Return a performance optimized lambda to generate the HTML anchor element (a tag)
-    # Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails' link_to
-    def pagy_anchor(pagy)
-      a_string    = pagy.vars[:anchor_string]
-      a_string    = %( #{a_string}) if a_string
-      left, right = %(<a#{a_string} href="#{pagy_url_for(pagy, PAGE_TOKEN)}").split(PAGE_TOKEN, 2)
-      # lambda used by all the helpers
-      lambda do |page, text = pagy.label_for(page), classes: nil, aria_label: nil|
-        classes    = %( class="#{classes}") if classes
-        aria_label = %( aria-label="#{aria_label}") if aria_label
-        %(#{left}#{page}#{right}#{classes}#{aria_label}>#{text}</a>)
+    # Generic pagination: it returns the html with the series of links to the pages
+    def pagy_nav(pagy, id: nil, aria_label: nil, **vars)
+      id = %( id="#{id}") if id
+      a  = pagy_anchor(pagy, **vars)
+
+      html = %(<nav#{id} class="pagy nav" #{nav_aria_label(pagy, aria_label:)}>#{
+                 prev_a(pagy, a)})
+      pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+        html << case item
+                when Integer
+                  a.(item)
+                when String
+                  %(<a role="link" aria-disabled="true" aria-current="page" class="current">#{pagy.label_for(item)}</a>)
+                when :gap
+                  %(<a role="link" aria-disabled="true" class="gap">#{pagy_t('pagy.gap')}</a>)
+                else
+                  raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
+                end
       end
+      html << %(#{next_a(pagy, a)}</nav>)
     end
 
     # Similar to I18n.t: just ~18x faster using ~10x less memory
     # (@pagy_locale explicitly initialized in order to avoid warning)
-    def pagy_t(key, opts = {})
-      Pagy::I18n.translate(@pagy_locale ||= nil, key, opts)
+    def pagy_t(key, **opts)
+      Pagy::I18n.translate(@pagy_locale ||= nil, key, **opts)
     end
 
     private

data/lib/pagy/i18n.rb

@@ -113,12 +113,13 @@ class Pagy
                  hash['zh-CN'] = RULE[:other]
                  hash['zh-HK'] = RULE[:other]
                  hash['zh-TW'] = RULE[:other]
+                 hash['dz']    = RULE[:other]
                end.freeze
     end
 
     # Stores the i18n DATA structure for each loaded locale
     # default on the first locale DATA
-    DATA = Hash.new { |hash, _| hash.first[1] }
+    DATA = Hash.new { |hash,| hash.first[1] }
 
     private
 
@@ -154,7 +155,7 @@ class Pagy
     end
 
     # Translate and pluralize the key with the locale DATA
-    def translate(locale, key, opts = {})
+    def translate(locale, key, **opts)
       data, pluralize = DATA[locale]
       translation = data[key] || (opts[:count] && data[key += ".#{pluralize.call(opts[:count])}"]) \
                       or return %([translation missing: "#{key}"])