pagy 5.2.3 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 500b8bfdb84150bd2ec01036eb55b53eeadcb1b0ab1fdc0721cee5fdf7fed46e
-  data.tar.gz: 9a75dbbf42e34e1ef12106e4a567acb408d22600fdb34fd42137a4b0dd61c8f3
+  metadata.gz: b456869f0028668579c9839d1083b7baf7693d593fcbed24f371bc52dfff4467
+  data.tar.gz: ec4f4b71da52860950262812d2bfbbe9190b1f0a1c3836cbc8f316e0c04ecd0b
 SHA512:
-  metadata.gz: 7ee826ffb154387f67275568fef53b557e6b16879017a0658701999bfcb34934322a1c645aa26afc599fa7fc2fbc69743878582d8d5f0d21054609610d49e578
-  data.tar.gz: c0334539b13212ac107aaabab36d2a00460682693e75bab9519b320b2446942a8340f191542cab531ef0de6f9af2df3baf9d74a77b2f2c7154178954428b9616
+  metadata.gz: e16ea640c3cc34b506c02d585c48fa8365b1a5e67d3b487d69669aa9d700a1f930929844e92759929f3963e78f2d72c53b4ef2d4caefeb2adbbff262ff0dd54d
+  data.tar.gz: 3086cf995b60b71212b64b42d7998e2f2831883abf41d22f9952b0632143936871a4c50d16da6b1849e805ce90de190be555e96ba893b5ee28c01b8650af7e03

data/lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (5.2.3)
+# Pagy initializer file (5.3.0)
 # Customize only what you really need and notice that 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
 
@@ -22,6 +22,7 @@
 # See https://ddnexus.github.io/pagy/api/pagy#other-variables
 # Pagy::DEFAULT[:size]       = [1,4,4,1]                       # default
 # Pagy::DEFAULT[:page_param] = :page                           # default
+# The :params can be also set as a lambda e.g ->(params){ params.exclude('useless').merge!('custom' => 'useful') }
 # Pagy::DEFAULT[:params]     = {}                              # default
 # Pagy::DEFAULT[:fragment]   = '#fragment'                     # example
 # Pagy::DEFAULT[:link_extra] = 'data-remote="true"'            # example

data/lib/javascripts/pagy.js

@@ -1,9 +1,11 @@
 // See the Pagy documentation: https://ddnexus.github.io/pagy/extras#javascript
 
+// This code should be OK also with very old browsers
+
 // Container of the whole pagy stuff
 function Pagy(){}
 
-Pagy.version = '5.2.3'
+Pagy.version = '5.3.0'
 
 // Used by the waitForMe function
 Pagy.delay = 100
@@ -23,10 +25,11 @@ Pagy.init =
 
 // Power the pagy*_nav_js helpers
 Pagy.nav =
-  function(pagyEl, tags, sequels, trimParam) {
-    var lastWidth,
-        pageREg = new RegExp(/__pagy_page__/g),
-        widths  = []
+  function(pagyEl, tags, sequels, label_sequels, trimParam ) {
+    label_sequels = (label_sequels === null) ? sequels : label_sequels
+    var widths = [], lastWidth,
+        fill   = function(string, item, label) { return string.replace(/__pagy_page__/g, item)
+                                                              .replace(/__pagy_label__/g, label) }
     for (var width in sequels) {
       if (sequels.hasOwnProperty(width)) { widths.push(parseInt(width, 10)) }
     }
@@ -40,13 +43,15 @@ Pagy.nav =
         }
         if (width !== lastWidth) {
           var html   = tags.before,
-              series = sequels[width]
+              series = sequels[width],
+              labels = label_sequels[width]
           for (i = 0, len = series.length; i < len; i++) {
-            var item = series[i]
-            if (typeof(trimParam) === 'string' && item === 1) { html += Pagy.trim(tags.link.replace(pageREg, item), trimParam) }
-            else if (typeof(item) === 'number') { html += tags.link.replace(pageREg, item) }
+            var item  = series[i],
+                label = labels[i]
+            if (typeof(trimParam) === 'string' && item === 1) { html += Pagy.trim(fill(tags.link, item, label), trimParam) }
+            else if (typeof(item) === 'number') { html += fill(tags.link, item, label) }
             else if (item === 'gap') { html += tags.gap }
-            else if (typeof(item) === 'string') { html += tags.active.replace(pageREg, item) }
+            else if (typeof(item) === 'string') { html += fill(tags.active, item, label) }
           }
           html += tags.after
           this.insertAdjacentHTML('afterbegin', html)

data/lib/pagy/calendar.rb

@@ -24,6 +24,7 @@ class Pagy # :nodoc:
       normalize_vars(vars)
       setup_vars(page: 1, week_offset: 0)
       setup_unit_vars
+      setup_params_var
       raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
 
       @prev = (@page - 1 unless @page == 1)
@@ -31,20 +32,24 @@ class Pagy # :nodoc:
     end
 
     # Generate a label for each page, with the specific `Time` period it refers to
-    def page_label(num = @page, format = nil)
-      snap = snap(num.to_i)
-      format ||= @vars[:"#{@unit}_format"]
-      case @unit
-      when :year  then new_time(@initial.year + snap)
-      when :month then bump_month(@initial, snap)
-      when :week  then @initial + (snap * WEEK)
-      when :day   then @initial + (snap * DAY)
-      else raise InternalError, "expected @unit to be in [:year, :month, :week, :day]; got #{@unit.inspect}"
-      end.strftime(format)
+    # It can pass along the I18n gem opts when it's used with the i18n extra
+    def label_for(page, **opts)
+      snap = snap(page.to_i)
+      time = case @unit
+             when :year  then new_time(@initial.year + snap)
+             when :month then bump_month(@initial, snap)
+             when :week  then @initial + (snap * WEEK)
+             when :day   then @initial + (snap * DAY)
+             else raise InternalError, "expected @unit to be in [:year, :month, :week, :day]; got #{@unit.inspect}"
+             end
+      opts[:format] ||= @vars[:"#{@unit}_format"]
+      strftime(time, **opts)
     end
 
-    def current_page_label(format = nil)
-      page_label(@page, format)
+    # The label for the current page
+    # It can pass along the I18n gem opts when it's used with the i18n extra
+    def label(**opts)
+      label_for(@page, **opts)
     end
 
     DAY  = 60 * 60 * 24
@@ -113,6 +118,11 @@ class Pagy # :nodoc:
       @utc_to   = @utc_from + DAY
     end
 
+    # The last method in the labelling chain: it is overridden by the I18n when localization is required.
+    def strftime(time, **opts)
+      time.strftime(opts[:format])
+    end
+
     private
 
     # Simple trick to snap the page into its ordered position,

data/lib/pagy/countless.rb

@@ -11,6 +11,7 @@ class Pagy
       normalize_vars(vars)
       setup_vars(page: 1, outset: 0)
       setup_items_var
+      setup_params_var
       @offset = (@items * (@page - 1)) + @outset
     end
 

data/lib/pagy/extras/bootstrap.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bootstrap
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -34,13 +34,13 @@ class Pagy # :nodoc:
       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)}</li>),
+               '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>) }
 
       %(<nav#{p_id} class="pagy-njs pagy-bootstrap-nav-js" aria-label="pager" #{
-          pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></nav>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></nav>)
     end
 
     # Javascript combo pagination for bootstrap: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/extras/bulma.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bulma
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -18,9 +18,9 @@ class Pagy # :nodoc:
       pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer
-                  %(<li>#{link.call item, item, %(class="pagination-link" aria-label="goto page #{item}")}</li>)
+                  %(<li>#{link.call item, pagy.label_for(item), %(class="pagination-link" aria-label="goto page #{item}")}</li>)
                 when String
-                  %(<li>#{link.call item, item,
+                  %(<li>#{link.call item, pagy.label_for(item),
                                     %(class="pagination-link is-current" aria-label="page #{item}" aria-current="page")}</li>)
                 when :gap
                   %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>)
@@ -34,17 +34,16 @@ class Pagy # :nodoc:
       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, PAGE_PLACEHOLDER,
+               'link'   => %(<li>#{link.call PAGE_PLACEHOLDER, LABEL_PLACEHOLDER,
                                              %(class="pagination-link" aria-label="goto page #{PAGE_PLACEHOLDER}")}</li>),
-               'active' => %(<li>#{link.call PAGE_PLACEHOLDER, PAGE_PLACEHOLDER,
+               '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>),
                'after'  => '</ul>' }
 
-      %(<nav#{p_id} class="pagy-njs pagy-bulma-nav-js pagination is-centered" aria-label="pagination" #{pagy_json_attr(
-        pagy, :nav, tags, pagy.sequels(steps)
-      )}></nav>)
+      %(<nav#{p_id} class="pagy-njs pagy-bulma-nav-js pagination is-centered" aria-label="pagination" #{
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></nav>)
     end
 
     # Javascript combo pagination for Bulma: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/extras/calendar.rb

@@ -32,15 +32,6 @@ class Pagy # :nodoc:
                              'the items for the unit by selecting the records with Time from pagy.from to pagy.to'
       end
     end
-
-    # Additions for the Frontend module
-    module Frontend
-      # Change the text shown in the nav bar links to the actual unit of each page.
-      def pagy_labeler(pagy, num)
-        pagy.is_a?(Calendar) ? pagy.page_label(num) : num
-      end
-    end
   end
   Backend.prepend CalendarExtra::Backend
-  Frontend.prepend CalendarExtra::Frontend
 end

data/lib/pagy/extras/foundation.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/foundation
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -17,7 +17,7 @@ class Pagy # :nodoc:
       pagy.series.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_labeler(pagy, item)}</li>)                  # active page
+                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}"
                 end
@@ -31,13 +31,13 @@ class Pagy # :nodoc:
       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'   => %(<li>#{link.call PAGE_PLACEHOLDER}</li>),
-               'active' => %(<li class="current">#{pagy.page}</li>),
+               '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>),
                'after'  => %(#{pagy_foundation_next_html pagy, link}</ul>) }
 
       %(<nav#{p_id} class="pagy-njs pagy-foundation-nav-js" aria-label="Pagination" #{
-          pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></nav>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></nav>)
     end
 
     # Javascript combo pagination for Foundation: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/extras/{shared.rb → frontend_helpers.rb}

@@ -5,7 +5,8 @@ require 'digest'
 class Pagy # :nodoc:
   DEFAULT[:steps] = false # default false will use {0 => @vars[:size]}
 
-  module SharedExtra
+  # Private module documented in the main classes
+  module FrontendHelpers
     # Additions for the Pagy class
     module Pagy
       # `Pagy` instance method used by the `pagy*_nav_js` helpers.
@@ -25,6 +26,20 @@ class Pagy # :nodoc:
           steps.each { |width, size| sequels[width.to_s] = series(size) }
         end
       end
+
+      # Support for the Calendar API
+      def label_sequels(*); end
+    end
+
+    # Additions for Calendar class
+    module Calendar
+      def label_sequels(sequels = self.sequels)
+        {}.tap do |label_sequels|
+          sequels.each do |width, series|
+            label_sequels[width] = series.map { |item| item == :gap ? :gap : label_for(item) }
+          end
+        end
+      end
     end
 
     # Additions for the Frontend
@@ -50,6 +65,7 @@ class Pagy # :nodoc:
       end
     end
   end
-  prepend SharedExtra::Pagy
-  Frontend.prepend SharedExtra::Frontend
+  prepend FrontendHelpers::Pagy
+  Calendar.prepend FrontendHelpers::Calendar if defined?(Calendar)
+  Frontend.prepend FrontendHelpers::Frontend
 end

data/lib/pagy/extras/i18n.rb

@@ -4,11 +4,22 @@
 class Pagy # :nodoc:
   # Use ::I18n gem
   module I18nExtra
-    def pagy_t(key, **opts)
-      ::I18n.t(key, **opts)
+    # Frontend overriding
+    module Frontend
+      def pagy_t(key, **opts)
+        ::I18n.t(key, **opts)
+      end
+    end
+
+    # Calendar overriding
+    module Calendar
+      def strftime(time, **opts)
+        ::I18n.l(time, **opts)
+      end
     end
   end
-  Frontend.prepend I18nExtra
+  Frontend.prepend I18nExtra::Frontend
+  Calendar.prepend I18nExtra::Calendar if defined?(Calendar)
 
   # Add the pagy locales to the I18n.load_path
   ::I18n.load_path += Dir[Pagy.root.join('locales', '*.yml')]

data/lib/pagy/extras/items.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/items
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   DEFAULT[:items_param] = :items

data/lib/pagy/extras/materialize.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/materialize
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -32,13 +32,13 @@ class Pagy # :nodoc:
       link = pagy_link_proc(pagy, link_extra: link_extra)
 
       tags = { 'before' => %(<ul class="pagination">#{pagy_materialize_prev_html pagy, link}),
-               'link'   => %(<li class="waves-effect">#{mark = link.call(PAGE_PLACEHOLDER)}</li>),
+               'link'   => %(<li class="waves-effect">#{mark = link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</li>),
                'active' => %(<li class="active">#{mark}</li>),
                'gap'    => %(<li class="gap disabled"><a href="#">#{pagy_t 'pagy.nav.gap'}</a></li>),
                'after'  => %(#{pagy_materialize_next_html pagy, link}</ul>) }
 
       %(<div#{p_id} class="pagy-njs pagy-materialize-nav-js" role="navigation" aria-label="pager" #{
-          pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></div>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></div>)
     end
 
     # Javascript combo pagination for materialize: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/extras/navs.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/navs
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -12,13 +12,13 @@ class Pagy # :nodoc:
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
       tags = { 'before' => pagy_nav_prev_html(pagy, link),
-               'link'   => %(<span class="page">#{link.call(PAGE_PLACEHOLDER)}</span> ),
-               'active' => %(<span class="page active">#{pagy.page}</span> ),
+               'link'   => %(<span class="page">#{link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</span> ),
+               'active' => %(<span class="page active">#{LABEL_PLACEHOLDER}</span> ),
                'gap'    => %(<span class="page gap">#{pagy_t 'pagy.nav.gap'}</span> ),
                'after'  => pagy_nav_next_html(pagy, link) }
 
       %(<nav#{p_id} class="pagy-njs pagy-nav-js pagination" aria-label="pager" #{
-          pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></nav>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></nav>)
     end
 
     # Javascript combo pagination: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/extras/overflow.rb

@@ -63,7 +63,7 @@ class Pagy # :nodoc:
         when :exception
           raise                                        # same as without the extra
         when :empty_page
-          @offset = @in = @from = @to = 0              # vars relative to the actual page
+          @offset = @items = @from = @to = 0            # vars relative to the actual page
           @vars[:size] = []                            # no page in the series
           self
         else

data/lib/pagy/extras/semantic.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/semantic
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -17,7 +17,7 @@ class Pagy # :nodoc:
       pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer then link.call item
-                when String  then %(<a class="item active">#{pagy_labeler(pagy, item)}</a>)
+                when String  then %(<a class="item active">#{pagy.label_for(item)}</a>)
                 when :gap    then %(<div class="disabled item">#{pagy_t 'pagy.nav.gap'}</div>)
                 else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
@@ -31,13 +31,13 @@ class Pagy # :nodoc:
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: %(class="item" #{link_extra}))
       tags = { 'before' => pagy_semantic_prev_html(pagy, link),
-               'link'   => link.call(PAGE_PLACEHOLDER),
-               'active' => %(<a class="item active">#{pagy.page}</a>),
+               'link'   => link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER),
+               'active' => %(<a class="item active">#{LABEL_PLACEHOLDER}</a>),
                'gap'    => %(<div class="disabled item">#{pagy_t('pagy.nav.gap')}</div>),
                'after'  => pagy_semantic_next_html(pagy, link) }
 
       %(<div#{p_id} class="pagy-njs pagy-semantic-nav-js ui pagination menu" role="navigation" #{
-        pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></div>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></div>)
     end
 
     # Combo pagination for semantic: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/extras/standalone.rb

@@ -37,15 +37,18 @@ class Pagy # :nodoc:
     # 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: nil)
-      vars = pagy.vars
-      return super unless (url = vars[:url])
+      return super unless pagy.vars[:url]
 
-      params                     = vars[:params].clone  # safe when it gets reused
-      params[vars[:page_param]]  = page
-      params[vars[:items_param]] = vars[:items] if vars[:items_extra]
-
-      query_string = "?#{QueryUtils.build_nested_query(pagy_massage_params(params))}"
-      "#{url}#{query_string}#{vars[:fragment]}"
+      vars                = pagy.vars
+      page_param          = vars[:page_param].to_s
+      items_param         = vars[:items_param].to_s
+      params              = pagy.params.is_a?(Hash) ? pagy.params.clone : {}  # safe when it gets reused
+      params[page_param]  = page
+      params[items_param] = vars[:items] if vars[:items_extra]
+      query_string        = "?#{QueryUtils.build_nested_query(pagy_deprecated_params(pagy, params))}"  # remove in 6.0
+      # params              = pagy.params.call(params) if pagy.params.is_a?(Proc)                      # add in 6.0
+      # query_string        = "?#{Rack::Utils.build_nested_query(params)}"                             # add in 6.0
+      "#{vars[:url]}#{query_string}#{vars[:fragment]}"
     end
   end
   # In ruby 3+ `UrlHelpers.prepend StandaloneExtra` would be enough instead of using the next 2 lines

data/lib/pagy/extras/trim.rb

@@ -12,9 +12,9 @@ class Pagy # :nodoc:
       link_proc = super(pagy, link_extra: link_extra)
       return link_proc unless pagy.vars[:trim_extra]
 
-      lambda do |num, text = num, extra = ''|
-        link = +link_proc.call(num, text, extra)
-        return link unless num == 1
+      lambda do |page, text = pagy.label_for(page), extra = ''|
+        link = +link_proc.call(page, text, extra)
+        return link unless page == 1
 
         pagy_trim(pagy, link)
       end

data/lib/pagy/extras/uikit.rb

@@ -1,7 +1,7 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/uikit
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
 class Pagy # :nodoc:
   # Frontend modules are specially optimized for performance.
@@ -16,7 +16,7 @@ class Pagy # :nodoc:
       pagy.series.each do |item|
         html << case item
                 when Integer then %(<li>#{link.call item}</li>)
-                when String  then %(<li class="uk-active"><span>#{pagy_labeler(pagy, item)}</span></li>)
+                when String  then %(<li class="uk-active"><span>#{pagy.label_for(item)}</span></li>)
                 when :gap    then %(<li class="uk-disabled"><span>#{pagy_t 'pagy.nav.gap'}</span></li>)
                 else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
@@ -30,13 +30,13 @@ class Pagy # :nodoc:
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
       tags = { 'before' => pagy_uikit_prev_html(pagy, link),
-               'link'   => %(<li>#{link.call(PAGE_PLACEHOLDER)}</li>),
-               'active' => %(<li class="uk-active"><span>#{PAGE_PLACEHOLDER}</span></li>),
+               'link'   => %(<li>#{link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</li>),
+               'active' => %(<li class="uk-active"><span>#{LABEL_PLACEHOLDER}</span></li>),
                'gap'    => %(<li class="uk-disabled"><span>#{pagy_t 'pagy.nav.gap'}</span></li>),
                'after'  => pagy_uikit_next_html(pagy, link) }
 
       %(<ul#{p_id} class="pagy-njs pagy-uikit-nav-js uk-pagination uk-flex-center" #{
-        pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></ul>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(steps)), pagy.label_sequels(sequels))}></ul>)
     end
 
     # Javascript combo pagination for uikit: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript

data/lib/pagy/frontend.rb

@@ -6,7 +6,8 @@ require 'pagy/i18n'
 
 class Pagy
   # Used for search and replace, hardcoded also in the pagy.js file
-  PAGE_PLACEHOLDER = '__pagy_page__'
+  PAGE_PLACEHOLDER  = '__pagy_page__'
+  LABEL_PLACEHOLDER = '__pagy_label__'
 
   # Frontend modules are specially optimized for performance.
   # The resulting code may not look very elegant, but produces the best benchmarks
@@ -29,7 +30,7 @@ class Pagy
       pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer then %(<span class="page">#{link.call item}</span> )
-                when String  then %(<span class="page active">#{pagy_labeler(pagy, item)}</span> )
+                when String  then %(<span class="page active">#{pagy.label_for(item)}</span> )
                 when :gap    then %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> )
                 else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
@@ -64,20 +65,15 @@ class Pagy
       p_next      = pagy.next
       left, right = %(<a href="#{pagy_url_for pagy, PAGE_PLACEHOLDER}" #{
                         pagy.vars[:link_extra]} #{link_extra}).split(PAGE_PLACEHOLDER, 2)
-      lambda do |num, text = pagy_labeler(pagy, num), extra_attrs = ''|
-        %(#{left}#{num}#{right}#{ case num
-                                  when p_prev then ' rel="prev"'
-                                  when p_next then ' rel="next"'
-                                  else             ''
-                                  end } #{extra_attrs}>#{text}</a>)
+      lambda do |page, text = pagy.label_for(page), extra_attrs = ''|
+        %(#{left}#{page}#{right}#{ case page
+                                   when p_prev then ' rel="prev"'
+                                   when p_next then ' rel="next"'
+                                   else             ''
+                                   end } #{extra_attrs}>#{text}</a>)
       end
     end
 
-    # Allow customization of the output by overriding (used by the calendar extra)
-    def pagy_labeler(_pagy, num)
-      num
-    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)

data/lib/pagy/url_helpers.rb

@@ -7,18 +7,32 @@ class Pagy
     # It supports all Rack-based frameworks (Sinatra, Padrino, Rails, ...).
     # For non-rack environments you can use the standalone extra
     def pagy_url_for(pagy, page, absolute: nil)
-      vars                            = pagy.vars
-      params                          = request.GET.merge(vars[:params].transform_keys(&:to_s))
-      params[vars[:page_param].to_s]  = page
-      params[vars[:items_param].to_s] = vars[:items] if vars[:items_extra]
-
-      query_string = "?#{Rack::Utils.build_nested_query(pagy_massage_params(params))}"
+      vars                = pagy.vars
+      page_param          = vars[:page_param].to_s
+      items_param         = vars[:items_param].to_s
+      params              = pagy.params.is_a?(Hash) ? pagy.params.transform_keys(&:to_s) : {}
+      params              = request.GET.merge(params)
+      params[page_param]  = page
+      params[items_param] = vars[:items] if vars[:items_extra]
+      query_string        = "?#{Rack::Utils.build_nested_query(pagy_deprecated_params(pagy, params))}"  # remove in 6.0
+      # params              = pagy.params.call(params) if pagy.params.is_a?(Proc)                       # add in 6.0
+      # query_string        = "?#{Rack::Utils.build_nested_query(params)}"                              # add in 6.0
       "#{request.base_url if absolute}#{request.path}#{query_string}#{vars[:fragment]}"
     end
 
-    # Sub-method called only by #pagy_url_for: here for easy customization of params by overriding
-    def pagy_massage_params(params)
-      params
+    private
+
+    # Transitional code to handle params deprecations. It will be removed in version 6.0
+    def pagy_deprecated_params(pagy, params)   # remove in 6.0
+      if pagy.params.is_a?(Proc)                # new code
+        pagy.params.call(params)
+      elsif respond_to?(:pagy_massage_params)   # deprecated code
+        Warning.warn '[PAGY WARNING] The pagy_massage_params method has been deprecated and it will be ignored from version 6. ' \
+                     'Set the :params variable to a Proc with the same code as the pagy_massage_params method.'
+        pagy_massage_params(params)
+      else
+        params                                  # no massage params
+      end
     end
   end
 end

data/lib/pagy.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 # Core class
 class Pagy
-  VERSION = '5.2.3'
+  VERSION = '5.3.0'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root
@@ -24,7 +24,7 @@ class Pagy
               i18n_key:   'pagy.item_name',
               cycle:      false }
 
-  attr_reader :count, :page, :items, :vars, :pages, :last, :offset, :in, :from, :to, :prev, :next
+  attr_reader :count, :page, :items, :vars, :pages, :last, :offset, :in, :from, :to, :prev, :next, :params
 
   # Merge and validate the options, do some simple arithmetic and set the instance variables
   def initialize(vars)
@@ -32,6 +32,7 @@ class Pagy
     setup_vars(count: 0, page: 1, outset: 0)
     setup_items_var
     setup_pages_var
+    setup_params_var
     raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
 
     @offset = (@items * (@page - 1)) + @outset
@@ -70,6 +71,15 @@ class Pagy
     series
   end
 
+  # Allow the customization of the output (overridden by the calendar extra)
+  def label_for(page)
+    page.to_s
+  end
+
+  def label
+    @page.to_s
+  end
+
   protected
 
   # Apply defaults, cleanup blanks and set @vars
@@ -94,6 +104,12 @@ class Pagy
   def setup_pages_var
     @pages = @last = [(@count.to_f / @items).ceil, 1].max
   end
+
+  # Setup and validates the params
+  def setup_params_var
+    raise VariableError.new(self, :params, 'must be a Hash or a Proc', @params) \
+          unless (@params = @vars[:params]).is_a?(Hash) || @params.is_a?(Proc)
+  end
 end
 
 require 'pagy/backend'

data/lib/templates/foundation_nav.html.erb

@@ -13,7 +13,7 @@
 <% end                         -%>
 <% pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36] -%>
 <%   if    item.is_a?(Integer) -%>    <li><%== link.call(item) %></li>
-<%   elsif item.is_a?(String)  -%>    <li class="current"><%= pagy_labeler(pagy, item) %></li>
+<%   elsif item.is_a?(String)  -%>    <li class="current"><%= pagy.label_for(item) %></li>
 <%   elsif item == :gap        -%>    <li class="ellipsis gap" aria-hidden="true"></li>
 <%   end                       -%>
 <% end                         -%>

data/lib/templates/foundation_nav.html.haml

@@ -22,7 +22,7 @@
 
       - elsif item.is_a?(String)                      # current page
         %li.current
-          = pagy_labeler(pagy, item)
+          = pagy.label_for(item)
 
       - elsif item == :gap                            # page gap
         %li.ellipsis.gap{"aria-hidden" => true}

data/lib/templates/foundation_nav.html.slim

@@ -22,7 +22,7 @@ nav.pagy-foundation-nav role="navigation" aria-label="Pagination"
 
       - elsif item.is_a?(String)                 # current page
         li.current
-          = pagy_labeler(pagy, item)
+          = pagy.label_for(item)
 
       - elsif item == :gap                       # page gap
         li.ellipsis.gap aria-hidden="true"

data/lib/templates/uikit_nav.html.erb

@@ -5,7 +5,7 @@
 <% end                         -%>
 <% pagy.series.each do |item|  -%>
 <%   if    item.is_a?(Integer) -%>   <li><%== link.call(item) %></li>
-<%   elsif item.is_a?(String)  -%>   <li class="uk-active"><span><%== pagy_labeler(pagy, item) %></span></li>
+<%   elsif item.is_a?(String)  -%>   <li class="uk-active"><span><%== pagy.label_for(item) %></span></li>
 <%   elsif item == :gap        -%>   <li class="uk-disabled"><span><%== pagy_t('pagy.nav.gap') %></span></li>
 <%   end                       -%>
 <% end                         -%>

data/lib/templates/uikit_nav.html.haml

@@ -14,7 +14,7 @@
 
     - elsif item.is_a?(String)
       %li.uk-active
-        %span!= pagy_labeler(pagy, item)
+        %span!= pagy.label_for(item)
 
     - elsif item == :gap
       %li.uk-disabled

data/lib/templates/uikit_nav.html.slim

@@ -14,7 +14,7 @@ ul.uk-pagination.uk-flex-center
 
     - elsif item.is_a?(String)
       li.uk-active
-        span== pagy_labeler(pagy, item)
+        span== pagy.label_for(item)
 
     - elsif item == :gap
       li.uk-disabled

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 5.2.3
+  version: 5.3.0
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -65,6 +65,7 @@ files:
 - lib/pagy/extras/countless.rb
 - lib/pagy/extras/elasticsearch_rails.rb
 - lib/pagy/extras/foundation.rb
+- lib/pagy/extras/frontend_helpers.rb
 - lib/pagy/extras/gearbox.rb
 - lib/pagy/extras/headers.rb
 - lib/pagy/extras/i18n.rb
@@ -76,7 +77,6 @@ files:
 - lib/pagy/extras/overflow.rb
 - lib/pagy/extras/searchkick.rb
 - lib/pagy/extras/semantic.rb
-- lib/pagy/extras/shared.rb
 - lib/pagy/extras/standalone.rb
 - lib/pagy/extras/support.rb
 - lib/pagy/extras/trim.rb