pagy 4.11.0 → 6.0.0

data/lib/pagy/extras/elasticsearch_rails.rb

@@ -1,61 +1,80 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/elasticsearch_rails
 # frozen_string_literal: true
 
-class Pagy
+class Pagy # :nodoc:
+  DEFAULT[:elasticsearch_rails_search]      ||= :search
+  DEFAULT[:elasticsearch_rails_pagy_search] ||= :pagy_search
 
-  VARS[:elasticsearch_rails_search_method] ||= :pagy_search
+  # Paginate ElasticsearchRails response objects
+  module ElasticsearchRailsExtra
+    module_function
 
-  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
+    # Get the count from different version of ElasticsearchRails
+    def total_count(response)
+      total = if response.respond_to?(:raw_response)
+                response.raw_response['hits']['total']
+              else
+                response.response['hits']['total']
+              end
+      total.is_a?(Hash) ? total['value'] : total
     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={})
-    vars[:items] = response.search.options[:size] || 10
-    vars[:page]  = (response.search.options[:from] || 0) / vars[:items] + 1
-    total        = response.respond_to?(:raw_response) ? response.raw_response['hits']['total'] : response.response['hits']['total']
-    vars[:count] = total.is_a?(Hash) ? total['value'] : total
-    new(vars)
-  end
 
-  # Add specialized backend methods to paginate ElasticsearchRails searches
-  module Backend
-    private
-
-    # Return Pagy object and items
-    def pagy_elasticsearch_rails(pagy_search_args, vars={})
-      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
-      return pagy_elasticsearch_rails(pagy_search_args, vars.merge(page: pagy.page)) \
-             if defined?(Pagy::UseOverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
-
-      [ pagy, called.empty? ? response : response.send(*called) ]
+    module ElasticsearchRails # :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_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 Pagy::DEFAULT[:elasticsearch_rails_pagy_search], :pagy_elasticsearch_rails
     end
 
-    # Sub-method called only by #pagy_elasticsearch_rails: here for easy customization of variables by overriding
-    # the _collection argument is not available when the method is called
-    def pagy_elasticsearch_rails_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
+    # Additions for the Pagy class
+    module Pagy
+      # Create a Pagy object from an Elasticsearch::Model::Response::Response object
+      def new_from_elasticsearch_rails(response, vars = {})
+        vars[:items] = response.search.options[:size] || 10
+        vars[:page]  = ((response.search.options[:from] || 0) / vars[:items]) + 1
+        vars[:count] = ElasticsearchRailsExtra.total_count(response)
+        new(vars)
+      end
     end
 
+    # Add specialized backend methods to paginate ElasticsearchRails searches
+    module Backend
+      private
+
+      # Return Pagy object and items
+      def pagy_elasticsearch_rails(pagy_search_args, vars = {})
+        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.send(DEFAULT[:elasticsearch_rails_search], query_or_payload, **options)
+        vars[:count]     = ElasticsearchRailsExtra.total_count(response)
+
+        pagy = ::Pagy.new(vars)
+        # with :last_page overflow we need to re-run the method in order to get the hits
+        return pagy_elasticsearch_rails(pagy_search_args, vars.merge(page: pagy.page)) \
+               if defined?(::Pagy::OverflowExtra) && pagy.overflow? && pagy.vars[:overflow] == :last_page
+
+        [pagy, called.empty? ? response : response.send(*called)]
+      end
+
+      # Sub-method called only by #pagy_elasticsearch_rails: here for easy customization of variables by overriding
+      # the _collection argument is not available when the method is called
+      def pagy_elasticsearch_rails_get_vars(_collection, vars)
+        pagy_set_items_from_params(vars) if defined?(ItemsExtra)
+        vars[:items] ||= DEFAULT[:items]
+        vars[:page]  ||= (params[vars[:page_param] || DEFAULT[:page_param]] || 1).to_i
+        vars
+      end
+    end
   end
+  ElasticsearchRails = ElasticsearchRailsExtra::ElasticsearchRails
+  extend ElasticsearchRailsExtra::Pagy
+  Backend.prepend ElasticsearchRailsExtra::Backend
 end

data/lib/pagy/extras/foundation.rb

@@ -1,86 +1,90 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/foundation
 # 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 FoundationExtra
     # Pagination for Foundation: it returns the html with the series of links to the pages
-    def pagy_foundation_nav(pagy, pagy_id: nil, link_extra: '')
+    def pagy_foundation_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 = +%(<nav#{p_id} class="pagy-foundation-nav" aria-label="Pagination"><ul class="pagination">)
       html << pagy_foundation_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>#{link.call item}</li>)                        # page link
-                when String  then %(<li class="current">#{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
       end
       html << pagy_foundation_next_html(pagy, link)
       html << %(</ul></nav>)
     end
 
-    # Javascript pagination for foundation: it returns a nav and a JSON tag used by the Pagy.nav javascript
-    def pagy_foundation_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 foundation: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_foundation_nav_js(pagy, pagy_id: nil, link_extra: '', **vars)
+      sequels = pagy.sequels(**vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: link_extra)
       tags = { 'before' => %(<ul class="pagination">#{pagy_foundation_prev_html pagy, link}),
-               'link'   => %(<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>)
+      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-foundation-nav-js" aria-label="Pagination" #{
+        pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
     end
 
-    # Javascript combo pagination for Foundation: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
-    def pagy_foundation_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 Foundation: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_foundation_combo_nav_js(pagy, pagy_id: nil, link_extra: '')
       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 class="input-group-field cell shrink" type="number" min="1" max="#{p_pages}" value="#{p_page}" style="width: #{p_pages.to_s.length+1}rem; padding: 0 0.3rem; margin: 0 0.3rem;">)
+      input   = %(<input class="input-group-field cell shrink" type="number" min="1" max="#{
+                    p_pages}" value="#{p_page}" style="width: #{
+                    p_pages.to_s.length + 1}rem; padding: 0 0.3rem; margin: 0 0.3rem;">)
 
       %(<nav#{p_id} class="pagy-foundation-combo-nav-js" aria-label="Pagination"><div class="input-group" #{
-          pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
-      }>#{
+          pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
           if (p_prev  = pagy.prev)
-            link.call p_prev, pagy_t('pagy.nav.prev'), 'style="margin-bottom: 0" aria-label="previous" class="prev button primary"'
+            link.call p_prev, pagy_t('pagy.nav.prev'),
+                      'style="margin-bottom: 0" aria-label="previous" class="prev button primary"'
           else
             %(<a style="margin-bottom: 0" class="prev button primary disabled" href="#">#{pagy_t 'pagy.nav.prev'}</a>)
           end
-      }<span class="input-group-label">#{pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages}</span>#{
+        }<span class="input-group-label">#{pagy_t 'pagy.combo_nav_js', page_input: input, count: p_page, pages: p_pages}</span>#{
           if (p_next  = pagy.next)
             link.call p_next, pagy_t('pagy.nav.next'), 'style="margin-bottom: 0" aria-label="next" class="next button primary"'
           else
             %(<a style="margin-bottom: 0" class="next button primary disabled" href="#">#{pagy_t 'pagy.nav.next'}</a>)
           end
-      }</div></nav>)
+        }</div></nav>)
     end
 
     private
 
-      def pagy_foundation_prev_html(pagy, link)
-        if (p_prev = pagy.prev)
-          %(<li class="prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
-        else
-          %(<li class="prev disabled">#{pagy_t 'pagy.nav.prev' }</li>)
-        end
+    def pagy_foundation_prev_html(pagy, link)
+      if (p_prev = pagy.prev)
+        %(<li class="prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+      else
+        %(<li class="prev disabled">#{pagy_t 'pagy.nav.prev'}</li>)
       end
+    end
 
-      def pagy_foundation_next_html(pagy, link)
-        if (p_next = pagy.next)
-          %(<li class="next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
-        else
-          %(<li class="next disabled">#{pagy_t 'pagy.nav.next'}</li>)
-        end
+    def pagy_foundation_next_html(pagy, link)
+      if (p_next = pagy.next)
+        %(<li class="next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
+      else
+        %(<li class="next disabled">#{pagy_t 'pagy.nav.next'}</li>)
       end
-
+    end
   end
+  Frontend.prepend FoundationExtra
 end

data/lib/pagy/extras/frontend_helpers.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+class Pagy # :nodoc:
+  DEFAULT[:steps] = false # default false will use {0 => @vars[:size]}
+
+  # Private module documented in the main classes
+  module FrontendHelpers
+    # Additions for the Pagy class
+    module Pagy
+      # `Pagy` instance method used by the `pagy*_nav_js` helpers.
+      # It returns the sequels of width/series generated from the :steps hash
+      # Example:
+      # >> pagy = Pagy.new(count:1000, page: 20, steps: {0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3]})
+      # >> pagy.sequels
+      # #=> { "0"   => [1, :gap, 18, 19, "20", 21, 22, :gap, 50],
+      #       "350" => [1, 2, :gap, 17, 18, 19, "20", 21, 22, 23, :gap, 49, 50],
+      #       "550" => [1, 2, 3, :gap, 16, 17, 18, 19, "20", 21, 22, 23, 24, :gap, 48, 49, 50] }
+      # Notice: if :steps is false it will use the single {0 => @vars[:size]} size
+      def sequels(steps: @vars[:steps] || { 0 => @vars[:size] }, **_)
+        raise VariableError.new(self, :steps, 'to define the 0 width', steps) unless steps.key?(0)
+
+        {}.tap do |sequels|
+          steps.each { |width, step_size| sequels[width.to_s] = series(size: step_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
+    module Frontend
+      if defined?(Oj)
+        # Return a data tag with the base64 encoded JSON-serialized args generated with the faster oj gem
+        # Base64 encoded JSON is smaller than HTML escaped JSON
+        def pagy_data(pagy, *args)
+          args << pagy.vars[:page_param] if pagy.vars[:trim_extra]
+          %(data-pagy="#{Base64.strict_encode64(Oj.dump(args, mode: :strict))}")
+        end
+      else
+        require 'json'
+        # Return a data tag with the base64 encoded JSON-serialized args generated with the slower to_json
+        # Base64 encoded JSON is smaller than HTML escaped JSON
+        def pagy_data(pagy, *args)
+          args << pagy.vars[:page_param] if pagy.vars[:trim_extra]
+          %(data-pagy="#{Base64.strict_encode64(args.to_json)}")
+        end
+      end
+
+      # Return the marked link to used by pagy.js
+      def pagy_marked_link(link)
+        link.call PAGE_PLACEHOLDER, '', 'style="display: none;"'
+      end
+    end
+  end
+  prepend FrontendHelpers::Pagy
+  Calendar.prepend FrontendHelpers::Calendar if defined?(Calendar)
+  Frontend.prepend FrontendHelpers::Frontend
+end

data/lib/pagy/extras/gearbox.rb

@@ -0,0 +1,54 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/gearbox
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  DEFAULT[:gearbox_extra] = true # extra enabled by default
+  DEFAULT[:gearbox_items] = [15, 30, 60, 100]
+
+  # Automatically change the number of items per page depending on the page number
+  # accepts an array as the :gearbox_items variable, that will determine the items for the first pages
+  module GearboxExtra
+    # Setup @items based on the :gearbox_items variable
+    def setup_items_var
+      return super if !@vars[:gearbox_extra] || @vars[:items_extra]
+
+      gearbox_items = @vars[:gearbox_items]
+      raise VariableError.new(self, :gearbox_items, 'to be an Array of positives', gearbox_items) \
+            unless gearbox_items.is_a?(Array) && gearbox_items.all? { |num| num.positive? rescue false } # rubocop:disable Style/RescueModifier
+
+      @items = gearbox_items[@page - 1] || gearbox_items.last
+    end
+
+    # Setup @pages and @last based on the :gearbox_items variable (not used by Pagy::Countless)
+    def setup_pages_var
+      return super if !@vars[:gearbox_extra] || @vars[:items_extra]
+
+      gearbox_items = @vars[:gearbox_items]
+      # This algorithm is thousands of times faster than the one in the geared_pagination gem
+      @pages = @last = (if @count > (sum = gearbox_items.sum)
+                          [((@count - sum).to_f / gearbox_items.last).ceil, 1].max + gearbox_items.count
+                        else
+                          pages     = 0
+                          remainder = @count
+                          while remainder.positive?
+                            pages     += 1
+                            remainder -= gearbox_items[pages - 1]
+                          end
+                          [pages, 1].max
+                        end)
+    end
+
+    # Setup @offset based on the :gearbox_items variable
+    def setup_offset_var
+      return super if !@vars[:gearbox_extra] || @vars[:items_extra]
+
+      gearbox_items = @vars[:gearbox_items]
+      @offset       = if @page <= gearbox_items.count
+                        gearbox_items[0, @page - 1].sum
+                      else
+                        gearbox_items.sum + (gearbox_items.last * (@page - gearbox_items.count - 1))
+                      end + @outset
+    end
+  end
+  prepend GearboxExtra
+end

data/lib/pagy/extras/headers.rb

@@ -1,43 +1,53 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/headers
 # frozen_string_literal: true
 
-class Pagy
-  # Add specialized backend methods to add pagination response headers
-  module Backend
-    private
+require 'pagy/url_helpers'
 
-    VARS[:headers] = { page: 'Current-Page', items: 'Page-Items', count: 'Total-Count', pages: 'Total-Pages' }
+class Pagy # :nodoc:
+  DEFAULT[:headers] = { page:  'Current-Page',
+                        items: 'Page-Items',
+                        count: 'Total-Count',
+                        pages: 'Total-Pages' }
+  # Add specialized backend methods to add pagination response headers
+  module HeadersExtra
+    include UrlHelpers
 
-    include Helpers
+    private
 
+    # Merge the pagy headers into the response.headers
     def pagy_headers_merge(pagy)
       response.headers.merge!(pagy_headers(pagy))
     end
 
+    # Generate a hash of RFC-8288 compliant http headers
     def pagy_headers(pagy)
       pagy_headers_hash(pagy).tap do |hash|
-        hash['Link'] = hash['Link'].map{|rel, link| %(<#{link}>; rel="#{rel}")}.join(', ')
+        hash['Link'] = hash['Link'].map { |rel, link| %(<#{link}>; rel="#{rel}") }.join(', ')
       end
     end
 
+    # Generates a hash structure of the headers
     def pagy_headers_hash(pagy)
-      countless = defined?(Pagy::Countless) && pagy.is_a?(Pagy::Countless)
-      rels = { 'first' => 1, 'prev' => pagy.prev, 'next' => pagy.next }
-      rels['last'] = pagy.last unless countless
-      url_str = pagy_url_for(pagy, PAGE_PLACEHOLDER, absolute: true)
-      hash    = { 'Link' => rels.map do |rel, num| # filter_map if ruby >=2.7
-                              next unless num
-                              [ rel, url_str.sub(PAGE_PLACEHOLDER, num.to_s) ]
-                            end.compact.to_h }
-      headers = pagy.vars[:headers]
-      hash[headers[:page]]  = pagy.page.to_s         if headers[:page]
-      hash[headers[:items]] = pagy.vars[:items].to_s if headers[:items]
+      countless             = defined?(Countless) && pagy.is_a?(Countless)
+      rel                   = { 'first' => 1, 'prev' => pagy.prev, 'next' => pagy.next }
+      rel['last']           = pagy.last unless countless
+      url_str               = pagy_url_for(pagy, PAGE_PLACEHOLDER, absolute: true)
+      link                  = rel.map do |r, num| # filter_map if ruby >=2.7
+                                next unless num # rubocop:disable Layout/EmptyLineAfterGuardClause
+                                [r, url_str.sub(PAGE_PLACEHOLDER, num.to_s)]
+                              end.compact.to_h
+      hash                  = { 'Link' => link }
+      headers               = pagy.vars[:headers]
+      hash[headers[:page]]  = pagy.page.to_s if headers[:page]
+      if headers[:items] && !(defined?(Calendar) && pagy.is_a?(Calendar))  # items is not for Calendar
+        hash[headers[:items]] = pagy.vars[:items].to_s
+      end
       unless countless
         hash[headers[:pages]] = pagy.pages.to_s if headers[:pages]
-        hash[headers[:count]] = pagy.count.to_s if headers[:count]
+        hash[headers[:count]] = pagy.count.to_s if pagy.count && headers[:count] # count may be nil with Calendar
       end
       hash
     end
-
   end
+  Backend.prepend HeadersExtra
 end

data/lib/pagy/extras/i18n.rb

@@ -1,24 +1,26 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/i18n
 # frozen_string_literal: true
 
-class Pagy
+class Pagy # :nodoc:
   # Use ::I18n gem
-  module Frontend
-
-    ::I18n.load_path += Dir[Pagy.root.join('locales', '*.yml')]
-
-    # unload the pagy default constant for efficiency
-    Pagy::I18n.clear.instance_eval do
-      undef :load
-      undef :t
-    end
-
-    module UseI18nGem
+  module I18nExtra
+    # Frontend overriding for translation
+    module Frontend
       def pagy_t(key, **opts)
         ::I18n.t(key, **opts)
       end
     end
-    prepend UseI18nGem
 
+    # Calendar overriding for localization (see also the block in the calendar section of the config/pagy.rb initializer)
+    module Calendar
+      def localize(time, opts)
+        ::I18n.l(time, **opts)
+      end
+    end
   end
+  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')]
 end

data/lib/pagy/extras/items.rb

@@ -1,52 +1,54 @@
 # 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
+class Pagy # :nodoc:
+  DEFAULT[:items_param] = :items
+  DEFAULT[:max_items]   = 100
+  DEFAULT[:items_extra] = true   # extra enabled by default
 
-  # Default variables for this extra
-  VARS[:items_param] = :items
-  VARS[:max_items]   = 100
-
-  VARS[:enable_items_extra] = true
-
-  ITEMS_PLACEHOLDER = '__pagy_items__'
-
-  module UseItemsExtra; end
-
-  module Backend
-    private
+  # Allow the client to request a custom number of items per page with an optional selector UI
+  module ItemsExtra
+    # Additions for the Backend module
+    module Backend
+      private
 
+      # Set the items variable considering the params and other pagy variables
       def pagy_set_items_from_params(vars)
-        return if vars[:items]
-        return unless vars.key?(:enable_item_extra) ? vars[:enable_item_extra] : VARS[:enable_items_extra]
-        return unless (items = params[vars[:items_param] || VARS[:items_param]])                               # :items from :items_param
-        vars[:items] = [items.to_i, vars.key?(:max_items) ? vars[:max_items] : VARS[:max_items]].compact.min   # :items capped to :max_items
-      end
+        return if vars[:items]                                                             # :items explicitly set
+        return unless vars.key?(:items_extra) ? vars[:items_extra] : DEFAULT[:items_extra] # :items_extra is false
+        return unless (items = params[vars[:items_param] || DEFAULT[:items_param]])        # no items from request params
 
-  end
-
-  module Frontend
-
-    # Return the items selector HTML. For example "Show [20] items per page"
-    def pagy_items_selector_js(pagy, deprecated_id=nil, pagy_id: nil, item_name: nil, i18n_key: nil, link_extra: '')
-      return '' unless pagy.vars[:enable_items_extra]
-      pagy_id        = Pagy.deprecated_arg(:id, deprecated_id, :pagy_id, pagy_id) if deprecated_id
-      p_id           = %( id="#{pagy_id}") if pagy_id
-      p_vars         = pagy.vars
-      p_items        = p_vars[:items]
-      p_vars[:items] = ITEMS_PLACEHOLDER
-      link           = pagy_marked_link(pagy_link_proc(pagy, link_extra: link_extra))
-      p_vars[:items] = p_items # restore the items
-
-      html  = +%(<span#{p_id} class="pagy-items-selector-js" #{pagy_json_attr pagy, :items_selector, pagy.from, link}>)
-      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:   item_name || pagy_t(i18n_key || p_vars[:i18n_key], count: p_items),
-                                               items_input: input,
-                                               count:       p_items)
-      html << %(</span>)
+        vars[:items] = [items.to_i, vars.key?(:max_items) ? vars[:max_items] : DEFAULT[:max_items]].compact.min
+      end
     end
 
+    # Additions for the Frontend module
+    module Frontend
+      ITEMS_PLACEHOLDER = '__pagy_items__'
+
+      # Return the items selector HTML. For example "Show [20] items per page"
+      def pagy_items_selector_js(pagy, pagy_id: nil, item_name: nil, i18n_key: nil, link_extra: '')
+        return '' unless pagy.vars[:items_extra]
+
+        p_id           = %( id="#{pagy_id}") if pagy_id
+        p_vars         = pagy.vars
+        p_items        = p_vars[:items]
+        p_vars[:items] = ITEMS_PLACEHOLDER
+        link           = pagy_marked_link(pagy_link_proc(pagy, link_extra: link_extra))
+        p_vars[:items] = p_items # restore the items
+
+        html  = +%(<span#{p_id} class="pagy-items-selector-js" #{pagy_data(pagy, :selector, pagy.from, link)}>)
+        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: item_name || pagy_t(i18n_key || p_vars[:i18n_key], count: p_items),
+                                                 items_input: input,
+                                                 count: p_items)
+        html << %(</span>)
+      end
+    end
   end
+  Backend.prepend ItemsExtra::Backend
+  Frontend.prepend ItemsExtra::Frontend
 end