pagy 3.11.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cadf66aafed63e69474727fab67e77da2038ad95e9a1430d5546da2b5f9d1a2
-  data.tar.gz: 6a716cef53d59459b3406e0e330d44536b8f5ec738d0661140d3fd805ef613ec
+  metadata.gz: 8abadf0305f4adce1cb070d5de45822a38cfeb02b8e0e4389e33dee2f926ff0c
+  data.tar.gz: 1fe429839b5f704a62e70ace80cd2a2c851d8f8e2eee2dc89fe84dd18a1a5c2e
 SHA512:
-  metadata.gz: 563e233579eab779aa3210751143c617369d3e0f34bd5365a7e50ed6bd07346b1aa052a3a2fec8b25b375dbc6d837836639915ab01160aff857938fbac515412
-  data.tar.gz: 02a8a1d45a18b5ea644e24c3fa50b6d4cdb48c3fd27fb135ece5fd981ea246da568759427f1daba2cf29705fe1dbcaf6e52f97f8cca84744fd285bee0cca4338
+  metadata.gz: 7ba816fa365290f6c7ca3850aca55cec280923f2a9f5340988373629526c6096206b31e66e053be8e7d968398b3d205468a9d4fad1978c6e984ef4b63f288197
+  data.tar.gz: 5caed0bfd335b497405a7665e8f74be8d99a9c8b2c1bf51090e49f99a60e68c770218d050815aaa82318d2b0b6891ed1f6ddc83ade1a88dd0d951da18280ceeb

data/lib/config/pagy.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-# Pagy initializer file (3.11.0)
+# Pagy initializer file (4.0.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
 
@@ -23,13 +23,18 @@
 
 # Elasticsearch Rails extra: Paginate `ElasticsearchRails::Results` objects
 # See https://ddnexus.github.io/pagy/extras/elasticsearch_rails
+# default :pagy_search method: change only if you use
+# also the searchkick extra that defines the same
+# VARS[:elasticsearch_rails_search_method] = :pagy_search
 # require 'pagy/extras/elasticsearch_rails'
 
 # Searchkick extra: Paginate `Searchkick::Results` objects
 # See https://ddnexus.github.io/pagy/extras/searchkick
+# default :pagy_search method: change only if you use
+# also the elasticsearch_rails extra that defines the same
+# VARS[:searchkick_search_method] = :pagy_search
 # require 'pagy/extras/searchkick'
 
-
 # Frontend Extras
 
 # Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination

data/lib/javascripts/pagy.js

@@ -2,7 +2,7 @@
 
 function Pagy(){}
 
-Pagy.version = '3.11.0';
+Pagy.version = '4.0.0';
 
 Pagy.init = function(arg){
               var target   = arg instanceof Event || arg === undefined ? document : arg,

data/lib/locales/utils/i18n.rb

@@ -4,22 +4,15 @@
 
 # this file returns the I18n hash used as default alternative to the i18n gem
 
-Pagy::DEPRECATED_LOCALES = {'pt-br' =>'pt-BR', 'se' => 'sv-SE'}
-
 Hash.new{|h,_| h.first[1]}.tap do |i18n_hash|   # first loaded locale used as default
   i18n_hash.define_singleton_method(:load) do |*load_args|
     # eval: we don't need to keep the loader proc in memory
     eval(Pagy.root.join('locales', 'utils', 'loader.rb').read).call(i18n_hash, *load_args)   #rubocop:disable Security/Eval
   end
-  i18n_hash.define_singleton_method(:t) do |locale, path, vars={}|
-    if Pagy::DEPRECATED_LOCALES.key?(locale)
-      new_locale = Pagy::DEPRECATED_LOCALES[locale]
-      $stderr.puts("WARNING: the Pagy locale '#{locale}' is deprecated; use '#{new_locale}' instead")
-      locale = new_locale
-    end
+  i18n_hash.define_singleton_method(:t) do |locale, key, **opts|
     data, pluralize = self[locale]
-    translate = data[path] || vars[:count] && data[path+=".#{pluralize.call(vars[:count])}"] or return %([translation missing: "#{path}"])
-    translate.call(vars)
+    translate = data[key] || opts[:count] && data[key+=".#{pluralize.call(opts[:count])}"] or return %([translation missing: "#{key}"])
+    translate.call(opts)
   end
   i18n_hash.load(locale: 'en')
 end

data/lib/locales/utils/loader.rb

@@ -20,11 +20,6 @@ flatten = lambda do |hash, key=''|
 lambda do |i18n, *args|
   i18n.clear
   args.each do |arg|
-    if Pagy::DEPRECATED_LOCALES.key?(arg[:locale])
-      new_locale = Pagy::DEPRECATED_LOCALES[arg[:locale]]
-      $stderr.puts("WARNING: the Pagy locale '#{arg[:locale]}' is deprecated; use '#{new_locale}' instead")
-      arg[:locale] = new_locale
-    end
     arg[:filepath]  ||= Pagy.root.join('locales', "#{arg[:locale]}.yml")
     arg[:pluralize] ||= plurals[arg[:locale]]
     hash = YAML.load(File.read(arg[:filepath], encoding: 'UTF-8')) #rubocop:disable Security/YAMLLoad

data/lib/pagy.rb

@@ -4,10 +4,10 @@
 
 require 'pathname'
 
-class Pagy ; VERSION = '3.11.0'
+class Pagy ; VERSION = '4.0.0'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
-  def self.root; @root ||= Pathname.new(__FILE__).dirname.freeze end
+  def self.root = @root ||= Pathname.new(__FILE__).dirname.freeze
 
   # default vars
   VARS = { page:1, items:20, outset:0, size:[1,4,4,1], page_param: :page, params:{}, anchor:'', link_extra:'', i18n_key:'pagy.item_name', cycle:false }
@@ -36,7 +36,7 @@ class Pagy ; VERSION = '3.11.0'
     (series = []) and size.empty? and return series
     4.times{|i| (size[i]>=0 rescue nil) or raise(VariableError.new(self), "expected 4 items >= 0 in :size; got #{size.inspect}")}
     [*0..size[0], *@page-size[1]..@page+size[2], *@last-size[3]+1..@last+1].sort!.each_cons(2) do |a, b|
-      if    a<0 || a==b || a>@last                                        # skip out of range and duplicates
+      if    a<0 || a==b || a>@last; next                                  # skip out of range and duplicates
       elsif a+1 == b; series.push(a)                                      # no gap     -> no additions
       elsif a+2 == b; series.push(a, a+1)                                 # 1 page gap -> fill with missing page
       else            series.push(a, :gap)                                # n page gap -> add gap

data/lib/pagy/countless.rb

@@ -8,7 +8,7 @@ class Pagy
   class Countless < Pagy
 
     # Merge and validate the options, do some simple arithmetic and set a few instance variables
-    def initialize(vars={})
+    def initialize(vars={})  # rubocop:disable Lint/MissingSuper
       @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })      # default vars + cleaned vars (can be overridden)
       { items:1, outset:0, page:1 }.each do |k,min|                     # validate instance variables
         (@vars[k] && instance_variable_set(:"@#{k}", @vars[k].to_i) >= min) \

data/lib/pagy/exceptions.rb

@@ -4,6 +4,7 @@ class Pagy
     attr_reader :pagy
 
     def initialize(pagy)
+      super
       @pagy = pagy
     end
 

data/lib/pagy/extras/bootstrap.rb

@@ -11,8 +11,8 @@ class Pagy
     def pagy_bootstrap_nav(pagy)
       link, p_prev, p_next = pagy_link_proc(pagy, 'class="page-link"'), pagy.prev, pagy.next
 
-      html = EMPTY + (p_prev ? %(<li class="page-item prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
-                             : %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev')}</a></li>))
+      html = (p_prev ? %(<li class="page-item prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+                     : %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.prev')}</a></li>))
       pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << if    item.is_a?(Integer); %(<li class="page-item">#{link.call item}</li>)                                                               # page link
                 elsif item.is_a?(String) ; %(<li class="page-item active">#{link.call item}</li>)                                                        # active page
@@ -34,7 +34,7 @@ class Pagy
                'gap'    => %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.gap')}</a></li>),
                'after'  => p_next ? %(<li class="page-item next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li></ul>)
                                   : %(<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t('pagy.nav.next')}</a></li></ul>) }
-      %(<nav id="#{id}" class="pagy-bootstrap-nav-js" role="navigation" aria-label="pager"></nav>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<nav id="#{id}" class="pagy-bootstrap-nav-js" role="navigation" aria-label="pager"></nav>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Javascript combo pagination for bootstrap: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
@@ -48,7 +48,7 @@ class Pagy
       html << %(<div class="pagy-combo-input btn btn-primary disabled" style="white-space: nowrap;">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</div>)
       html << (p_next ? link.call(p_next, pagy_t('pagy.nav.next'), 'aria-label="next" class="next btn btn-primary"')
                       : %(<a class="next btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.next')}</a>))
-      html << %(</div></nav>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</div></nav>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
 
   end

data/lib/pagy/extras/bulma.rb

@@ -38,7 +38,7 @@ class Pagy
                'active' => %(<li>#{link.call(PAGE_PLACEHOLDER, PAGE_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 id="#{id}" class="pagy-bulma-nav-js pagination is-centered" role="navigation" aria-label="pagination"></nav>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<nav id="#{id}" class="pagy-bulma-nav-js pagination is-centered" role="navigation" aria-label="pagination"></nav>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Javascript combo pagination for Bulma: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
@@ -53,7 +53,7 @@ class Pagy
       html << %(<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>)
       html << (p_next ? %(<p class="control">#{link.call(p_next, pagy_t('pagy.nav.next'), 'class="button" aria-label="next page"')}</p>)
                       : %(<p class="control"><a class="button" disabled>#{pagy_t('pagy.nav.next')}</a></p>))
-      html << %(</div></nav>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</div></nav>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
 
   end

data/lib/pagy/extras/countless.rb

@@ -6,9 +6,6 @@ require 'pagy/countless'
 
 class Pagy
 
-  # used by the items extra
-  COUNTLESS = true
-
   module Backend ; private         # the whole module is private so no problem with including it in a controller
 
     # Return Pagy object and items

data/lib/pagy/extras/elasticsearch_rails.rb

@@ -2,12 +2,21 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require 'pagy/extras/pagy_search'
-
 class Pagy
 
-  # used by the items extra
-  ELASTICSEARCH_RAILS = true
+  VARS[:elasticsearch_rails_search_method] ||= :pagy_search
+
+  module ElasticsearchRails
+    # returns 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 eventually called method
+    def pagy_elasticsearch_rails(query_or_payload, **options)
+      [self, query_or_payload, options].tap do |args|
+        args.define_singleton_method(:method_missing){|*a| args += a}
+      end
+    end
+    alias_method VARS[:elasticsearch_rails_search_method], :pagy_elasticsearch_rails
+  end
 
   # create a Pagy object from an Elasticsearch::Model::Response::Response object
   def self.new_from_elasticsearch_rails(response, vars={})
@@ -23,16 +32,16 @@ class Pagy
 
     # Return Pagy object and items
     def pagy_elasticsearch_rails(pagy_search_args, vars={})
-      model, search_args, _block, *called = pagy_search_args
-      vars                   = pagy_elasticsearch_rails_get_vars(nil, vars)
-      search_args[-1][:size] = vars[:items]
-      search_args[-1][:from] = vars[:items] * (vars[:page] - 1)
-      response               = model.search(*search_args)
-      total                  = response.respond_to?(:raw_response) ? response.raw_response['hits']['total'] : response.response['hits']['total']
-      vars[:count]           = total.is_a?(Hash) ? total['value'] : total
+      model, query_or_payload, options, *called = pagy_search_args
+      vars           = pagy_elasticsearch_rails_get_vars(nil, vars)
+      options[:size] = vars[:items]
+      options[:from] = vars[:items] * (vars[:page] - 1)
+      response       = model.search(query_or_payload, **options)
+      total          = response.respond_to?(:raw_response) ? response.raw_response['hits']['total'] : response.response['hits']['total']
+      vars[:count]   = total.is_a?(Hash) ? total['value'] : total
       pagy = Pagy.new(vars)
       # with :last_page overflow we need to re-run the method in order to get the hits
-      if defined?(OVERFLOW) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+      if defined?(Pagy::Overflow) && pagy.overflow? && pagy.vars[:overflow] == :last_page
         return pagy_elasticsearch_rails(pagy_search_args, vars.merge(page: pagy.page))
       end
       return pagy, called.empty? ? response : response.send(*called)

data/lib/pagy/extras/foundation.rb

@@ -11,8 +11,8 @@ class Pagy
     def pagy_foundation_nav(pagy)
       link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
 
-      html = EMPTY + (p_prev ? %(<li class="prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
-                             : %(<li class="prev disabled">#{pagy_t('pagy.nav.prev')}</li>))
+      html = +(p_prev ? %(<li class="prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+                      : %(<li class="prev disabled">#{pagy_t('pagy.nav.prev')}</li>))
       pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << if    item.is_a?(Integer); %(<li>#{link.call item}</li>)                        # page link
                 elsif item.is_a?(String) ; %(<li class="current">#{item}</li>)                  # active page
@@ -36,7 +36,7 @@ class Pagy
                'after'  => ( (p_next ? %(<li class="next">#{link.call(p_next, pagy_t('pagy.nav.next'), 'aria-label="next"')}</li>)
                                      : %(<li class="next disabled">#{pagy_t('pagy.nav.next')}</li>)) \
                            + '</ul>' ) }
-      %(<nav id="#{id}" class="pagy-foundation-nav-js" role="navigation" aria-label="Pagination"></nav>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<nav id="#{id}" class="pagy-foundation-nav-js" role="navigation" aria-label="Pagination"></nav>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Javascript combo pagination for Foundation: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
@@ -50,7 +50,7 @@ class Pagy
       html << %(<span class="input-group-label">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</span>)
       html << (p_next ? link.call(p_next, pagy_t('pagy.nav.next'), 'style="margin-bottom: 0px;" aria-label="next" class="next button primary"')
                       : %(<a style="margin-bottom: 0px;" class="next button primary disabled" href="#">#{pagy_t('pagy.nav.next')}</a>))
-      html << %(</div></nav>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</div></nav>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
 
   end

data/lib/pagy/extras/i18n.rb

@@ -10,16 +10,10 @@ class Pagy
 
     Pagy::I18n.clear.instance_eval { undef :load; undef :t } # unload the pagy default constant for efficiency
 
-    alias_method :pagy_without_i18n, :pagy_t
-    if Gem::Version.new(::I18n::VERSION) < Gem::Version.new('1.6.0')
-      def pagy_t_with_i18n(*args) ::I18n.t(*args) end
-    else
-      # keep 1.9 compatibility by hiding 2.0+ syntax in string
-      module_eval <<-RUBY
-        def pagy_t_with_i18n(key, **opts) ::I18n.t(key, **opts) end
-      RUBY
+    module I18n
+      def pagy_t(key, **opts) = ::I18n.t(key, **opts)
     end
-    alias_method :pagy_t, :pagy_t_with_i18n
+    prepend I18n
 
   end
 end

data/lib/pagy/extras/items.rb

@@ -12,40 +12,32 @@ class Pagy
 
   ITEMS_PLACEHOLDER = '__pagy_items__'
 
-  # Handle a custom number of :items from params
-  module Backend ; private
-
-    def pagy_with_items(vars)
-      vars[:items] ||= (items = params[vars[:items_param] || VARS[:items_param]]) &&                           # :items from :items_param
-                       [items.to_i, vars.key?(:max_items) ? vars[:max_items] : VARS[:max_items]].compact.min   # :items capped to :max_items
-    end
-
-    # add the pagy*_get_vars alias-chained methods for frontend, and defined/required extras
-    [nil, 'countless', 'elasticsearch_rails', 'searchkick'].each do |name|
-      prefix, if_start, if_end = "_#{name}", "if defined?(Pagy::#{name.upcase})", "end" if name
-      module_eval <<-RUBY
-        #{if_start}
-          alias_method :pagy#{prefix}_get_vars_without_items, :pagy#{prefix}_get_vars
-          def pagy#{prefix}_get_vars_with_items(collection, vars)
-            pagy_with_items(vars)
-            pagy#{prefix}_get_vars_without_items(collection, vars)
-          end
-          alias_method :pagy#{prefix}_get_vars, :pagy#{prefix}_get_vars_with_items  
-        #{if_end}
-      RUBY
+  module Items ; private
+
+    [:pagy_get_vars, :pagy_countless_get_vars, :pagy_elasticsearch_rails_get_vars, :pagy_searchkick_get_vars].each do |meth|
+      if Pagy::Backend.private_method_defined?(meth, true)
+        define_method(meth) do |collection, vars|
+          vars[:items] ||= (items = params[vars[:items_param] || VARS[:items_param]]) &&                           # :items from :items_param
+                           [items.to_i, vars.key?(:max_items) ? vars[:max_items] : VARS[:max_items]].compact.min   # :items capped to :max_items
+          super(collection, vars)
+        end
+      end
     end
 
   end
+  Backend.prepend Items
+
 
   module Frontend
 
-    alias_method :pagy_url_for_without_items, :pagy_url_for
-    def pagy_url_for_with_items(page, pagy, url=false)
-      p_vars = pagy.vars; params = request.GET.merge(p_vars[:params]); params[p_vars[:page_param].to_s] = page
-      params[p_vars[:items_param].to_s] = p_vars[:items]
-      "#{request.base_url if url}#{request.path}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}#{p_vars[:anchor]}"
+    module Items
+      def pagy_url_for(page, pagy, url=false)
+        p_vars = pagy.vars; params = request.GET.merge(p_vars[:params]); params[p_vars[:page_param].to_s] = page
+        params[p_vars[:items_param].to_s] = p_vars[:items]
+        "#{request.base_url if url}#{request.path}?#{Rack::Utils.build_nested_query(pagy_get_params(params))}#{p_vars[:anchor]}"
+      end
     end
-    alias_method :pagy_url_for, :pagy_url_for_with_items
+    prepend Items
 
     # Return the items selector HTML. For example "Show [20] items per page"
     def pagy_items_selector_js(pagy, id=pagy_id)
@@ -55,10 +47,10 @@ class Pagy
       link           = pagy_marked_link(pagy_link_proc(pagy))
       p_vars[:items] = p_items # restore the items
 
-      html = EMPTY + %(<span id="#{id}">)
+      html = %(<span id="#{id}">)
       input = %(<input type="number" min="1" max="#{p_vars[:max_items]}" value="#{p_items}" style="padding: 0; text-align: center; width: #{p_items.to_s.length+1}rem;">)
       html << %(#{pagy_t('pagy.items_selector_js', item_name: pagy_t(p_vars[:i18n_key], count: p_items), items_input: input, count: p_items)})
-      html << %(</span>#{pagy_json_tag(:items_selector, id, pagy.from, link, defined?(TRIM) && p_vars[:page_param])})
+      html << %(</span>#{pagy_json_tag(pagy, :items_selector, id, pagy.from, link)})
     end
 
   end

data/lib/pagy/extras/materialize.rb

@@ -10,8 +10,8 @@ class Pagy
     # Pagination for materialize: it returns the html with the series of links to the pages
     def pagy_materialize_nav(pagy)
       link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
-      html = EMPTY + (p_prev ? %(<li class="waves-effect prev">#{link.call p_prev, '<i class="material-icons">chevron_left</i>', 'aria-label="previous"'}</li>)
-                             : %(<li class="prev disabled"><a href="#"><i class="material-icons">chevron_left</i></a></li>))
+      html = (p_prev ? %(<li class="waves-effect prev">#{link.call p_prev, '<i class="material-icons">chevron_left</i>', 'aria-label="previous"'}</li>)
+                     : +%(<li class="prev disabled"><a href="#"><i class="material-icons">chevron_left</i></a></li>))
       pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << if    item.is_a?(Integer); %(<li class="waves-effect">#{link.call item}</li>)                                             # page link
                 elsif item.is_a?(String) ; %(<li class="active">#{link.call item}</li>)                                                   # active page
@@ -35,7 +35,7 @@ class Pagy
                'after'  => ( (p_next ? %(<li class="waves-effect next">#{link.call(p_next, '<i class="material-icons">chevron_right</i>', 'aria-label="next"')}</li>)
                                      : %(<li class="next disabled"><a href="#"><i class="material-icons">chevron_right</i></a></li>)) \
                            + '</ul>' ) }
-      %(<div id="#{id}" class="pagy-materialize-nav-js" role="navigation" aria-label="pager"></div>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<div id="#{id}" class="pagy-materialize-nav-js" role="navigation" aria-label="pager"></div>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Javascript combo pagination for materialize: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
@@ -52,7 +52,7 @@ class Pagy
       html << %(<div class="pagy-combo-input btn-flat" style="cursor: default; padding: 0px">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</div>)
       html << (p_next ? %(<li class="waves-effect next" #{li_style}>#{link.call p_next, '<i class="material-icons">chevron_right</i>', 'aria-label="next"'}</li>)
                       : %(<li class="next disabled" #{li_style}><a href="#"><i class="material-icons">chevron_right</i></a></li>))
-      html << %(</ul></div>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</ul></div>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
 
   end

data/lib/pagy/extras/navs.rb

@@ -17,21 +17,21 @@ class Pagy
                'gap'    => %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> ),
                'after'  => p_next ? %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
                                   : %(<span class="page next disabled">#{pagy_t('pagy.nav.next')}</span>) }
-      %(<nav id="#{id}" class="pagy-nav-js pagination" role="navigation" aria-label="pager"></nav>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<nav id="#{id}" class="pagy-nav-js pagination" role="navigation" aria-label="pager"></nav>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Javascript combo pagination: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
     def pagy_combo_nav_js(pagy, id=pagy_id)
       link, p_prev, p_next, p_page, p_pages = pagy_link_proc(pagy), pagy.prev, pagy.next, pagy.page, pagy.pages
 
-      html = EMPTY + %(<nav id="#{id}" class="pagy-combo-nav-js pagination" role="navigation" aria-label="pager">)
+      html = %(<nav id="#{id}" class="pagy-combo-nav-js pagination" role="navigation" aria-label="pager">)
       html << (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
                       : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> ))
       input = %(<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;">)
       html << %(<span class="pagy-combo-input" style="margin: 0 0.6rem;">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</span> )
       html << (p_next ? %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
                       : %(<span class="page next disabled">#{pagy_t('pagy.nav.next')}</span>))
-      html << %(</nav>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</nav>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
 
   end

data/lib/pagy/extras/overflow.rb

@@ -4,68 +4,71 @@
 
 class Pagy
 
-  OVERFLOW = true
+  module Overflow
+    VARS[:overflow] = :empty_page
 
-  VARS[:overflow] = :empty_page
+    def overflow? = @overflow
 
-  def overflow?; @overflow end
-
-  alias_method :initialize_without_overflow, :initialize
-  def initialize_with_overflow(vars)
-    @overflow ||= false                         # don't override if :last_page re-run the method after an overflow
-    initialize_without_overflow(vars)
-  rescue OverflowError
-    @overflow = true                            # add the overflow flag
-    case @vars[:overflow]
-    when :exception
-      raise                                     # same as without the extra
-    when :last_page
-      initial_page = @vars[:page]               # save the very initial page (even after re-run)
-      initialize(vars.merge!(page: @last))      # re-run with the last page
-      @vars[:page] = initial_page               # restore the inital page
-    when :empty_page
-      @offset = @items = @from = @to = 0        # vars relative to the actual page
-      @prev = @last                             # prev relative to the actual page
-      extend(Series)                            # special series for :empty_page
-    else
-      raise VariableError.new(self), "expected :overflow variable in [:last_page, :empty_page, :exception]; got #{@vars[:overflow].inspect}"
+    def initialize(vars)
+      @overflow ||= false                         # don't override if :last_page re-run the method after an overflow
+      super
+    rescue OverflowError
+      @overflow = true                            # add the overflow flag
+      case @vars[:overflow]
+      when :exception
+        raise                                     # same as without the extra
+      when :last_page
+        initial_page = @vars[:page]               # save the very initial page (even after re-run)
+        initialize(vars.merge!(page: @last))      # re-run with the last page
+        @vars[:page] = initial_page               # restore the inital page
+      when :empty_page
+        @offset = @items = @from = @to = 0        # vars relative to the actual page
+        @prev = @last                             # prev relative to the actual page
+        extend(Series)                            # special series for :empty_page
+      else
+        raise VariableError.new(self), "expected :overflow variable in [:last_page, :empty_page, :exception]; got #{@vars[:overflow].inspect}"
+      end
     end
-  end
-  alias_method :initialize, :initialize_with_overflow
 
-  module Series
-    def series(size=@vars[:size])
-      @page = @last                               # series for last page
-      super(size).tap do |s|                      # call original series
+    module Series
+      def series(size=@vars[:size])
+        @page = @last                             # series for last page
+        super(size).tap do |s|                    # call original series
         s[s.index(@page.to_s)] = @page            # string to integer (i.e. no current page)
         @page = @vars[:page]                      # restore the actual page
+        end
       end
     end
+
   end
+  prepend Overflow
 
 
   # support for Pagy::Countless
   if defined?(Pagy::Countless)
     class Countless
 
-      alias_method :finalize_without_overflow, :finalize
-      def finalize_with_overflow(items)
-        @overflow = false
-        finalize_without_overflow(items)
-      rescue OverflowError
-        @overflow = true                            # add the overflow flag
-        case @vars[:overflow]
-        when :exception
-          raise                                     # same as without the extra
-        when :empty_page
-          @offset = @items = @from = @to = 0        # vars relative to the actual page
-          @vars[:size] = []                         # no page in the series
-          self
-        else
-          raise VariableError.new(self), "expected :overflow variable in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
+      module Overflow
+
+        def finalize(items)
+          @overflow = false
+          super
+        rescue OverflowError
+          @overflow = true                            # add the overflow flag
+          case @vars[:overflow]
+          when :exception
+            raise                                     # same as without the extra
+          when :empty_page
+            @offset = @items = @from = @to = 0        # vars relative to the actual page
+            @vars[:size] = []                         # no page in the series
+            self
+          else
+            raise VariableError.new(self), "expected :overflow variable in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
+          end
         end
+
       end
-      alias_method :finalize, :finalize_with_overflow
+      prepend Overflow
 
     end
   end

data/lib/pagy/extras/searchkick.rb

@@ -2,12 +2,21 @@
 # encoding: utf-8
 # frozen_string_literal: true
 
-require 'pagy/extras/pagy_search'
-
 class Pagy
 
-  # used by the items extra
-  SEARCHKICK = true
+  VARS[:searchkick_search_method] ||= :pagy_search
+
+  module Searchkick
+    # returns 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 eventually called method
+    def pagy_searchkick(term = "*", **options, &block)
+      [self, term, options, block].tap do |args|
+        args.define_singleton_method(:method_missing){|*a| args += a}
+      end
+    end
+    alias_method VARS[:searchkick_search_method], :pagy_searchkick
+  end
 
   # create a Pagy object from a Searchkick::Results object
   def self.new_from_searchkick(results, vars={})
@@ -22,15 +31,15 @@ class Pagy
 
     # Return Pagy object and results
     def pagy_searchkick(pagy_search_args, vars={})
-      model, search_args, block, *called = pagy_search_args
-      vars                       = pagy_searchkick_get_vars(nil, vars)
-      search_args[-1][:per_page] = vars[:items]
-      search_args[-1][:page]     = vars[:page]
-      results                    = model.search(*search_args, &block)
-      vars[:count]               = results.total_count
+      model, term, options, block, *called = pagy_search_args
+      vars               = pagy_searchkick_get_vars(nil, vars)
+      options[:per_page] = vars[:items]
+      options[:page]     = vars[:page]
+      results            = model.search(term, **options, &block)
+      vars[:count]       = results.total_count
       pagy = Pagy.new(vars)
       # with :last_page overflow we need to re-run the method in order to get the hits
-      if defined?(OVERFLOW) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+      if defined?(Pagy::Overflow) && pagy.overflow? && pagy.vars[:overflow] == :last_page
         return pagy_searchkick(pagy_search_args, vars.merge(page: pagy.page))
       end
       return pagy, called.empty? ? results : results.send(*called)

data/lib/pagy/extras/semantic.rb

@@ -11,8 +11,8 @@ class Pagy
     def pagy_semantic_nav(pagy)
       link, p_prev, p_next = pagy_link_proc(pagy, 'class="item"'), pagy.prev, pagy.next
 
-      html = EMPTY + (p_prev ? %(#{link.call p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"'})
-                             : %(<div class="item disabled"><i class="left small chevron icon"></i></div>))
+      html = (p_prev ? %(#{link.call p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"'})
+                     : +%(<div class="item disabled"><i class="left small chevron icon"></i></div>))
       pagy.series.each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << if    item.is_a?(Integer); %(#{link.call item})                      # page link
                 elsif item.is_a?(String) ; %(<a class="item active">#{item}</a>)     # current page
@@ -34,21 +34,21 @@ class Pagy
                'gap'    => %(<div class="disabled item">#{pagy_t('pagy.nav.gap')}</div>),
                'after'  => (p_next ? %(#{link.call(p_next, '<i class="right small chevron icon"></i>', 'aria-label="next"')})
                                    : %(<div class="item disabled"><i class="right small chevron icon"></i></div>)) }
-      %(<div id="#{id}" class="pagy-semantic-nav-js ui pagination menu" role="navigation" aria-label="pager"></div>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<div id="#{id}" class="pagy-semantic-nav-js ui pagination menu" role="navigation" aria-label="pager"></div>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Combo pagination for semantic: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
     def pagy_semantic_combo_nav_js(pagy, id=pagy_id)
       link, p_prev, p_next, p_page, p_pages = pagy_link_proc(pagy, 'class="item"'), pagy.prev, pagy.next, pagy.page, pagy.pages
 
-      html = EMPTY + %(<div id="#{id}" class="pagy-semantic-combo-nav-js ui compact menu" role="navigation" aria-label="pager">)
+      html = %(<div id="#{id}" class="pagy-semantic-combo-nav-js ui compact menu" role="navigation" aria-label="pager">)
       html << (p_prev ? %(#{link.call p_prev, '<i class="left small chevron icon"></i>', 'aria-label="previous"'})
                       : %(<div class="item disabled"><i class="left small chevron icon"></i></div>))
       input = %(<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">)
       html << %(<div class="pagy-combo-input item">#{pagy_t('pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages)}</div> )
       html << (p_next ? %(#{link.call p_next, '<i class="right small chevron icon"></i>', 'aria-label="next"'})
                       : %(<div class="item disabled"><i class="right small chevron icon"></i></div>))
-      html << %(</div>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</div>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
 
   end

data/lib/pagy/extras/shared.rb

@@ -27,26 +27,24 @@ class Pagy
 
     if defined?(Oj)
       # it returns a script tag with the JSON-serialized args generated with the faster oj gem
-      def pagy_json_tag(*args)
+      def pagy_json_tag(pagy, *args)
+        args << ( defined?(Trim) && pagy.vars[:page_param] )
         %(<script type="application/json" class="pagy-json">#{Oj.dump(args, mode: :strict)}</script>)
       end
     else
       require 'json'
       # it returns a script tag with the JSON-serialized args generated with the slower to_json
-      def pagy_json_tag(*args)
+      def pagy_json_tag(pagy, *args)
+        args << ( defined?(Trim) && pagy.vars[:page_param] )
         %(<script type="application/json" class="pagy-json">#{args.to_json}</script>)
       end
     end
 
     # it returns the SHA1 (fastest on modern ruby) string used as default `id` attribute by all the `*_js` tags
-    def pagy_id
-      "pagy-#{Digest::SHA1.hexdigest(caller(2..2)[0].split(':in')[0])}"
-    end
+    def pagy_id = "pagy-#{Digest::SHA1.hexdigest(caller(2..2)[0].split(':in')[0])}"
 
     # it returns the marked link to used by pagy.js
-    def pagy_marked_link(link)
-      link.call(PAGE_PLACEHOLDER, '', 'style="display: none;"')
-    end
+    def pagy_marked_link(link) = link.call(PAGE_PLACEHOLDER, '', 'style="display: none;"')
 
   end
 

data/lib/pagy/extras/trim.rb

@@ -4,20 +4,16 @@
 
 class Pagy
 
-  module Frontend
-
-    TRIM = true   # boolean used by *_js helpers
-
-    alias_method :pagy_link_proc_without_trim, :pagy_link_proc
-    def pagy_link_proc_with_trim(pagy, link_extra='')
-      link_proc = pagy_link_proc_without_trim(pagy, link_extra)
+  module Trim
+    def pagy_link_proc(pagy, link_extra='')
+      link_proc = super(pagy, link_extra)
       re = /[?&]#{pagy.vars[:page_param]}=1\b(?!&)|\b#{pagy.vars[:page_param]}=1&/
       lambda do |n, text=n, extra=''|
         link = link_proc.call(n, text, extra)
         n == 1 ? link.sub(re, '') : link
       end
     end
-    alias_method :pagy_link_proc, :pagy_link_proc_with_trim
-
   end
+  Frontend.prepend Trim
+
 end

data/lib/pagy/extras/uikit.rb

@@ -12,8 +12,8 @@ class Pagy
       link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
 
       previous_span = "<span uk-pagination-previous>#{pagy_t('pagy.nav.prev')}</span>"
-      html = EMPTY + (p_prev ? %(<li>#{link.call p_prev, previous_span}</li>)
-                             : %(<li class="uk-disabled"><a href="#">#{previous_span}</a></li>))
+      html = (p_prev ? %(<li>#{link.call p_prev, previous_span}</li>)
+                     : %(<li class="uk-disabled"><a href="#">#{previous_span}</a></li>))
       pagy.series.each do |item|
         html << if    item.is_a?(Integer); %(<li>#{link.call item}</li>)
                 elsif item.is_a?(String) ; %(<li class="uk-active"><span>#{item}</span></li>)
@@ -38,7 +38,7 @@ class Pagy
                'gap'    => %(<li class="uk-disabled"><span>#{pagy_t('pagy.nav.gap')}</span></li>),
                'after'  => p_next ? %(<li>#{link.call p_next, next_span}</li>)
                                   : %(<li class="uk-disabled"><a href="#">#{next_span}</a></li>) }
-      %(<ul id="#{id}" class="pagy-uikit-nav-js uk-pagination uk-flex-center"></ul>#{pagy_json_tag(:nav, id, tags, pagy.sequels, defined?(TRIM) && pagy.vars[:page_param])})
+      %(<ul id="#{id}" class="pagy-uikit-nav-js uk-pagination uk-flex-center"></ul>#{pagy_json_tag(pagy, :nav, id, tags, pagy.sequels)})
     end
 
     # Javascript combo pagination for uikit: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
@@ -56,7 +56,7 @@ class Pagy
       html << (p_next ? link.call(p_next, pagy_t('pagy.nav.next'), 'class="uk-button uk-button-default"')
                       : %(<button class="uk-button uk-button-default" disabled>#{pagy_t('pagy.nav.next')}</button>))
 
-      html << %(</div>#{pagy_json_tag(:combo_nav, id, p_page, pagy_marked_link(link), defined?(TRIM) && pagy.vars[:page_param])})
+      html << %(</div>#{pagy_json_tag(pagy, :combo_nav, id, p_page, pagy_marked_link(link))})
     end
   end
 end

data/lib/pagy/frontend.rb

@@ -29,15 +29,12 @@ class Pagy
 
     include Helpers
 
-    EMPTY = ''               # EMPTY + 'string' is almost as fast as +'string' but is also 1.9 compatible
-    MARK  = PAGE_PLACEHOLDER # backward compatibility in case of helper-overriding in legacy apps
-
     # Generic pagination: it returns the html with the series of links to the pages
     def pagy_nav(pagy)
       link, p_prev, p_next = pagy_link_proc(pagy), pagy.prev, pagy.next
 
-      html = EMPTY + (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
-                             : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> ))
+      html = (p_prev ? %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
+                     : %(<span class="page prev disabled">#{pagy_t('pagy.nav.prev')}</span> ))
       pagy.series.each do |item|  # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << if    item.is_a?(Integer); %(<span class="page">#{link.call item}</span> )               # page link
                 elsif item.is_a?(String) ; %(<span class="page active">#{item}</span> )                  # current page
@@ -51,10 +48,10 @@ class Pagy
 
     # Return examples: "Displaying items 41-60 of 324 in total" of "Displaying Products 41-60 of 324 in total"
     def pagy_info(pagy, item_name=nil)
-      path = if (count = pagy.count) == 0 ; 'pagy.info.no_items'
+      key = if (count = pagy.count) == 0 ; 'pagy.info.no_items'
              else pagy.pages == 1 ? 'pagy.info.single_page' : 'pagy.info.multiple_pages'
              end
-      pagy_t(path, item_name: item_name || pagy_t(pagy.vars[:i18n_key], count: count), count: count, from: pagy.from, to: pagy.to)
+      pagy_t(key, item_name: item_name || pagy_t(pagy.vars[:i18n_key], count: count), count: count, from: pagy.from, to: pagy.to)
     end
 
     # Returns a performance optimized proc to generate the HTML links
@@ -69,7 +66,7 @@ class Pagy
 
     # Similar to I18n.t: just ~18x faster using ~10x less memory
     # (@pagy_locale explicitly initilized in order to avoid warning)
-    def pagy_t(path, vars={}) Pagy::I18n.t(@pagy_locale||=nil, path, vars) end
+    def pagy_t(key, **opts) = Pagy::I18n.t(@pagy_locale||=nil, key, **opts)
 
   end
 end

data/pagy.gemspec

@@ -12,5 +12,5 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/ddnexus/pagy'
   s.license       = 'MIT'
   s.files         = `git ls-files -z`.split("\x0").select{|f| f.start_with?('lib', 'pagy.gemspec', 'LICENSE') }
-  s.required_ruby_version = '>= 1.9'  # rubocop:disable Gemspec/RequiredRubyVersion
+  s.required_ruby_version = '>= 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies: []
 description: 'Agnostic pagination in plain ruby: it works with any framework, ORM
   and DB type, with all kinds of collections, even pre-paginated, scopes, Arrays,
@@ -70,7 +70,6 @@ files:
 - lib/pagy/extras/metadata.rb
 - lib/pagy/extras/navs.rb
 - lib/pagy/extras/overflow.rb
-- lib/pagy/extras/pagy_search.rb
 - lib/pagy/extras/searchkick.rb
 - lib/pagy/extras/semantic.rb
 - lib/pagy/extras/shared.rb
@@ -106,14 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: The Ultimate Pagination Ruby Gem

data/lib/pagy/extras/pagy_search.rb

@@ -1,18 +0,0 @@
-# Support module to capture search calls
-# encoding: utf-8
-# frozen_string_literal: true
-
-class Pagy
-  module Search
-    # returns 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 eventually called method and arguments
-    # the last search argument must be a hash option
-    def pagy_search(*search_args, &block)
-      search_args << {} unless search_args[-1].is_a?(Hash)
-      [self, search_args, block].tap do |args|
-        args.define_singleton_method(:method_missing){|*a| args += a}
-      end
-    end
-  end
-end