pagy 4.11.0 → 6.0.0

data/lib/pagy/extras/materialize.rb

@@ -1,82 +1,84 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/materialize
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
-
-class Pagy
-  module Frontend
+require 'pagy/extras/frontend_helpers'
 
+class Pagy # :nodoc:
+  # Frontend modules are specially optimized for performance.
+  # The resulting code may not look very elegant, but produces the best benchmarks
+  module MaterializeExtra
     # Pagination for materialize: it returns the html with the series of links to the pages
-    def pagy_materialize_nav(pagy, pagy_id: nil, link_extra: '')
+    def pagy_materialize_nav(pagy, pagy_id: nil, link_extra: '', **vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
 
-      html = +%(<div#{p_id} class="pagy-materialize-nav pagination" role="navigation" aria-label="pager"><ul class="pagination">)
+      html = +%(<div#{p_id} class="pagy-materialize-nav pagination" role="navigation"><ul class="pagination">)
       html << pagy_materialize_prev_html(pagy, link)
-      pagy.series.each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
+      pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer then %(<li class="waves-effect">#{link.call item}</li>)                           # page link
                 when String  then %(<li class="active">#{link.call item}</li>)                                 # active page
                 when :gap    then %(<li class="gap disabled"><a href="#">#{pagy_t 'pagy.nav.gap'}</a></li>)    # page gap
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_materialize_next_html(pagy, link)
       html << %(</ul></div>)
     end
 
-    # Javascript pagination for materialize: it returns a nav and a JSON tag used by the Pagy.nav javascript
-    def pagy_materialize_nav_js(pagy, deprecated_id=nil, pagy_id: nil, link_extra: '', steps: nil)
-      pagy_id = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
+    # Javascript pagination for materialize: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_materialize_nav_js(pagy, pagy_id: nil, link_extra: '', **vars)
+      sequels = pagy.sequels(**vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
 
       tags = { 'before' => %(<ul class="pagination">#{pagy_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>)
+      %(<div#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-materialize-nav-js" role="navigation" #{
+        pagy_data(pagy, :nav, tags, sequels, 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
-    def pagy_materialize_combo_nav_js(pagy, deprecated_id=nil, pagy_id: nil, link_extra: '')
-      pagy_id = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
+    # Javascript combo pagination for materialize: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_materialize_combo_nav_js(pagy, pagy_id: nil, link_extra: '')
       p_id    = %( id="#{pagy_id}") if pagy_id
       link    = pagy_link_proc(pagy, link_extra: link_extra)
       p_page  = pagy.page
       p_pages = pagy.pages
       style   = ' style="vertical-align: middle"'
-      input   = %(<input type="number" class="browser-default" min="1" max="#{p_pages}" value="#{p_page}" style="text-align: center; width: #{p_pages.to_s.length+1}rem;">)
+      input   = %(<input type="number" class="browser-default" min="1" max="#{p_pages}" value="#{
+                    p_page}" style="text-align: center; width: #{p_pages.to_s.length + 1}rem;">)
 
-      %(<ul#{p_id} class="pagy-materialize-combo-nav-js pagination chip" role="navigation" aria-label="pager" style="padding-right: 0" #{
-          pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
-      }>#{
-          pagy_materialize_prev_html pagy, link, style
-      }<li class="pagy-combo-input">#{
-          pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages
-      }</li>#{
-          pagy_materialize_next_html pagy, link, style
-      }</ul>)
+      html = %(<ul#{p_id} class="pagy-materialize-combo-nav-js pagination chip" role="navigation")
+      %(#{html} style="padding-right: 0" #{
+          pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
+          pagy_materialize_prev_html pagy, link, style}<li class="pagy-combo-input">#{
+          pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages}</li>#{
+          pagy_materialize_next_html pagy, link, style}</ul>)
     end
 
     private
 
-      def pagy_materialize_prev_html(pagy, link, style='')
-        if (p_prev = pagy.prev)
-          %(<li class="waves-effect prev"#{style}>#{link.call p_prev, '<i class="material-icons">chevron_left</i>', 'aria-label="previous"'}</li>)
-        else
-          %(<li class="prev disabled"#{style}><a href="#"><i class="material-icons">chevron_left</i></a></li>)
-        end
+    def pagy_materialize_prev_html(pagy, link, style = '')
+      if (p_prev = pagy.prev)
+        %(<li class="waves-effect prev"#{style}>#{
+            link.call p_prev, '<i class="material-icons">chevron_left</i>', 'aria-label="previous"'}</li>)
+      else
+        %(<li class="prev disabled"#{style}><a href="#"><i class="material-icons">chevron_left</i></a></li>)
       end
+    end
 
-      def pagy_materialize_next_html(pagy, link, style='')
-        if (p_next = pagy.next)
-          %(<li class="waves-effect next"#{style}>#{link.call p_next, '<i class="material-icons">chevron_right</i>', 'aria-label="next"'}</li>)
-        else
-          %(<li class="next disabled"#{style}><a href="#"><i class="material-icons">chevron_right</i></a></li>)
-        end
+    def pagy_materialize_next_html(pagy, link, style = '')
+      if (p_next = pagy.next)
+        %(<li class="waves-effect next"#{style}>#{
+            link.call p_next, '<i class="material-icons">chevron_right</i>', 'aria-label="next"'}</li>)
+      else
+        %(<li class="next disabled"#{style}><a href="#"><i class="material-icons">chevron_right</i></a></li>)
       end
-
+    end
   end
+  Frontend.prepend MaterializeExtra
 end

data/lib/pagy/extras/meilisearch.rb

@@ -1,55 +1,64 @@
 # frozen_string_literal: true
 
-class Pagy
+class Pagy # :nodoc:
+  DEFAULT[:meilisearch_search]      ||= :ms_search
+  DEFAULT[:meilisearch_pagy_search] ||= :pagy_search
 
-  VARS[:meilisearch_search_method] ||= :pagy_search
-
-  module Meilisearch
-    # returns an array used to delay the call of #search
-    # after the pagination variables are merged to the options
-    def pagy_meilisearch(term = nil, **vars)
-      [self, term, vars]
+  # Paginate Meilisearch results
+  module MeilisearchExtra
+    module Meilisearch # :nodoc:
+      # Return an array used to delay the call of #search
+      # after the pagination variables are merged to the options
+      def pagy_meilisearch(term = nil, **vars)
+        [self, term, vars]
+      end
+      alias_method DEFAULT[:meilisearch_pagy_search], :pagy_meilisearch
     end
-    alias_method VARS[:meilisearch_search_method], :pagy_meilisearch
-  end
 
-  # create a Pagy object from a Meilisearch results
-  def self.new_from_meilisearch(results, vars={})
-    vars[:items] = results.raw_answer['limit']
-    vars[:page]  = [results.raw_answer['offset'] / vars[:items], 1].max
-    vars[:count] = results.raw_answer['nbHits']
-    new(vars)
-  end
+    # Additions for the Pagy class
+    module Pagy
+      # Create a Pagy object from a Meilisearch results
+      def new_from_meilisearch(results, vars = {})
+        vars[:items] = results.raw_answer['hitsPerPage']
+        vars[:page]  = results.raw_answer['page']
+        vars[:count] = results.raw_answer['totalHits']
 
-  # Add specialized backend methods to paginate Meilisearch results
-  module Backend
-    private
-
-    # Return Pagy object and results
-    def pagy_meilisearch(pagy_search_args, vars = {})
-      model, term, options = pagy_search_args
-      vars             = pagy_meilisearch_get_vars(nil, vars)
-      options[:limit]  = vars[:items]
-      options[:offset] = (vars[:page] - 1) * vars[:items]
-      results          = model.search(term, **options)
-      vars[:count]     = results.raw_answer['nbHits']
-
-      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)) \
-        if defined?(Pagy::UseOverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
-
-      [ pagy, results ]
+        new(vars)
+      end
     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?(UseItemsExtra)
-      vars[:items] ||= VARS[:items]
-      vars[:page]  ||= (params[ vars[:page_param] || VARS[:page_param] ] || 1).to_i
-      vars
-    end
+    # Add specialized backend methods to paginate Meilisearch results
+    module Backend
+      private
 
+      # Return Pagy object and results
+      def pagy_meilisearch(pagy_search_args, vars = {})
+        model, term, options    = pagy_search_args
+        vars                    = pagy_meilisearch_get_vars(nil, vars)
+        options[:hits_per_page] = vars[:items]
+        options[:page]          = vars[:page]
+        results                 = model.send(:ms_search, term, **options)
+        vars[:count]            = results.raw_answer['totalHits']
+
+        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)) \
+               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]  ||= (params[vars[:page_param] || DEFAULT[:page_param]] || 1).to_i
+        vars
+      end
+    end
   end
+  Meilisearch = MeilisearchExtra::Meilisearch
+  extend MeilisearchExtra::Pagy
+  Backend.prepend MeilisearchExtra::Backend
 end

data/lib/pagy/extras/metadata.rb

@@ -1,31 +1,24 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/metadata
 # frozen_string_literal: true
 
-class Pagy
-  # Add a specialized backend method for pagination metadata
-  module Backend
-  private
-
-    METADATA = %i[ scaffold_url first_url prev_url page_url next_url last_url
-                   count page items vars pages last from to prev next series
-               ].tap do |metadata|
-                 metadata << :sequels if VARS.key?(:steps)  # :steps gets defined along with the #sequels method
-               end.freeze
+require 'pagy/url_helpers'
 
-    VARS[:metadata] = METADATA.dup
+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 ]
 
-    include Helpers
+  # Add a specialized backend method for pagination metadata
+  module MetadataExtra
+    private
 
-    def pagy_metadata(pagy, deprecated_url=nil, absolute: nil)
-      absolute = Pagy.deprecated_arg(:url, deprecated_url, :absolute, absolute) if deprecated_url
-      names   = pagy.vars[:metadata]
-      unknown = names - METADATA
-      raise VariableError.new(pagy), "unknown metadata #{unknown.inspect}" \
-            unless unknown.empty?
+    include UrlHelpers
 
+    # Return the metadata hash
+    def pagy_metadata(pagy, absolute: nil)
       scaffold_url = pagy_url_for(pagy, PAGE_PLACEHOLDER, absolute: absolute)
       {}.tap do |metadata|
-        names.each do |key|
+        keys = defined?(Calendar) && pagy.is_a?(Calendar) ? pagy.vars[:metadata] - %i[count items] : pagy.vars[:metadata]
+        keys.each do |key|
           metadata[key] = case key
                           when :scaffold_url then scaffold_url
                           when :first_url    then scaffold_url.sub(PAGE_PLACEHOLDER, 1.to_s)
@@ -35,9 +28,11 @@ class Pagy
                           when :last_url     then scaffold_url.sub(PAGE_PLACEHOLDER, pagy.last.to_s)
                           else pagy.send(key)
                           end
+        rescue NoMethodError
+          raise VariableError.new(pagy, :metadata, 'to contain known keys', key)
         end
       end
     end
-
   end
+  Backend.prepend MetadataExtra
 end

data/lib/pagy/extras/navs.rb

@@ -1,62 +1,63 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/navs
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
-
-class Pagy
-  module Frontend
-
-    # Javascript pagination: it returns a nav and a JSON tag used by the Pagy.nav javascript
-    def pagy_nav_js(pagy, deprecated_id=nil, pagy_id: nil, link_extra: '', steps: nil)
-      pagy_id = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
+require 'pagy/extras/frontend_helpers'
+
+class Pagy # :nodoc:
+  # Frontend modules are specially optimized for performance.
+  # The resulting code may not look very elegant, but produces the best benchmarks
+  module NavsExtra
+    # Javascript pagination: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_nav_js(pagy, pagy_id: nil, link_extra: '', **vars)
+      sequels = pagy.sequels(**vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
       tags = { 'before' => pagy_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>)
+      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-nav-js pagination" #{
+        pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
     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, deprecated_id=nil, pagy_id: nil, link_extra: '')
-      pagy_id = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
+    # Javascript combo pagination: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_combo_nav_js(pagy, pagy_id: nil, link_extra: '')
       p_id    = %( id="#{pagy_id}") if pagy_id
       link    = pagy_link_proc(pagy, link_extra: link_extra)
       p_page  = pagy.page
       p_pages = pagy.pages
-      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;">)
+      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;">)
 
-      %(<nav#{p_id} class="pagy-combo-nav-js pagination" aria-label="pager" #{
-          pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
-      }>#{
+      %(<nav#{p_id} class="pagy-combo-nav-js pagination" #{
+          pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
           pagy_nav_prev_html pagy, link
-      }<span class="pagy-combo-input" style="margin: 0 0.6rem;">#{
+        }<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> #{
+        }</span> #{
           pagy_nav_next_html pagy, link
-      }</nav>)
+        }</nav>)
     end
 
     private
 
-      def pagy_nav_prev_html(pagy, link)
-        if (p_prev = pagy.prev)
-          %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
-        else
-          %(<span class="page prev disabled">#{pagy_t 'pagy.nav.prev'}</span> )
-        end
+    def pagy_nav_prev_html(pagy, link)
+      if (p_prev = pagy.prev)
+        %(<span class="page prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</span> )
+      else
+        %(<span class="page prev disabled">#{pagy_t 'pagy.nav.prev'}</span> )
       end
+    end
 
-      def pagy_nav_next_html(pagy, link)
-        if (p_next = pagy.next)
-          %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
-        else
-          %(<span class="page next disabled">#{pagy_t 'pagy.nav.next'}</span>)
-        end
+    def pagy_nav_next_html(pagy, link)
+      if (p_next = pagy.next)
+        %(<span class="page next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</span>)
+      else
+        %(<span class="page next disabled">#{pagy_t 'pagy.nav.next'}</span>)
       end
-
+    end
   end
+  Frontend.prepend NavsExtra
 end

data/lib/pagy/extras/overflow.rb

@@ -1,77 +1,78 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/overflow
 # frozen_string_literal: true
 
-class Pagy
+class Pagy # :nodoc:
+  DEFAULT[:overflow] = :empty_page
 
-  module UseOverflowExtra
-    VARS[:overflow] = :empty_page
-
-    def overflow?
-      @overflow
-    end
-
-    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}"
+  # Handles OverflowError exceptions for different classes with different options
+  module OverflowExtra
+    # Support for Pagy class
+    module Pagy
+      # Is the requested page overflowing?
+      def overflow?
+        @overflow
       end
-    end
 
-    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
+      # Add rescue clause for different behaviors
+      def initialize(vars)
+        @overflow ||= false                            # still true 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
+          requested_page = @vars[:page]                # save the requested page (even after re-run)
+          initialize vars.merge!(page: @last)          # re-run with the last page
+          @vars[:page] = requested_page                # restore the requested page
+        when :empty_page
+          @offset = @items = @from = @to = 0           # vars relative to the actual page
+          if defined?(Calendar) && is_a?(Calendar)     # only for Calendar 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)
+          end
+          @prev = @last                                # prev relative to the actual page
+          extend Series                                # special series for :empty_page
+        else
+          raise VariableError.new(self, :overflow, 'to be in [:last_page, :empty_page, :exception]', @vars[:overflow])
         end
       end
-    end
-
-  end
-  prepend UseOverflowExtra
 
-
-  # support for Pagy::Countless
-  if defined?(Pagy::Countless)
-    class Countless
-
-      module UseOverflowExtra
-
-        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}"
+      # Special series for empty page
+      module Series
+        def series(*)
+          @page = @last                                # series for last page
+          super.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
-      prepend UseOverflowExtra
+    end
 
+    # Support for Pagy::Countless class
+    module Countless
+      # Add rescue clause for different behaviors
+      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, :overflow, 'to be in [:empty_page, :exception]', @vars[:overflow])
+        end
+      end
     end
   end
-
+  prepend OverflowExtra::Pagy
+  Calendar.prepend OverflowExtra::Pagy if defined?(Calendar)
+  Countless.prepend OverflowExtra::Countless if defined?(Countless)
 end

data/lib/pagy/extras/searchkick.rb

@@ -1,59 +1,67 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/searchkick
 # frozen_string_literal: true
 
-class Pagy
+class Pagy # :nodoc:
+  DEFAULT[:searchkick_search]      ||= :search
+  DEFAULT[:searchkick_pagy_search] ||= :pagy_search
 
-  VARS[:searchkick_search_method] ||= :pagy_search
+  # Paginate Searchkick::Results objects
+  module SearchkickExtra
+    module Searchkick # :nodoc:
+      # Return an array used to delay the call of #search
+      # after the pagination variables are merged to the options.
+      # It also pushes to the same array an optional method call.
+      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 Pagy::DEFAULT[:searchkick_pagy_search], :pagy_searchkick
+    end
 
-  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}
+    # Additions for the Pagy class
+    module Pagy
+      # Create a Pagy object from a Searchkick::Results object
+      def new_from_searchkick(results, vars = {})
+        vars[:items] = results.options[:per_page]
+        vars[:page]  = results.options[:page]
+        vars[:count] = results.total_count
+        new(vars)
       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={})
-    vars[:items] = results.options[:per_page]
-    vars[:page]  = results.options[:page]
-    vars[:count] = results.total_count
-    new(vars)
-  end
+    # Add specialized backend methods to paginate Searchkick::Results
+    module Backend
+      private
 
-  # Add specialized backend methods to paginate Searchkick::Results
-  module Backend
-    private
-
-    # Return Pagy object and results
-    def pagy_searchkick(pagy_search_args, vars={})
-      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
-      return pagy_searchkick(pagy_search_args, vars.merge(page: pagy.page)) \
-             if defined?(Pagy::UseOverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
-
-      [ pagy, called.empty? ? results : results.send(*called) ]
-    end
+      # Return Pagy object and results
+      def pagy_searchkick(pagy_search_args, vars = {})
+        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.send(DEFAULT[:searchkick_search], term, **options, &block)
+        vars[:count]       = results.total_count
 
-    # 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?(UseItemsExtra)
-      vars[:items] ||= VARS[:items]
-      vars[:page]  ||= (params[ vars[:page_param] || VARS[:page_param] ] || 1).to_i
-      vars
-    end
+        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)) \
+               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]  ||= (params[vars[:page_param] || DEFAULT[:page_param]] || 1).to_i
+        vars
+      end
+    end
   end
+  Searchkick = SearchkickExtra::Searchkick
+  extend SearchkickExtra::Pagy
+  Backend.prepend SearchkickExtra::Backend
 end