pagy 43.4.4 → 43.5.1

data/lib/pagy/toolbox/helpers/bulma/series_nav.rb

@@ -7,7 +7,6 @@ class Pagy
   module NumericHelpers
     private
 
-    # Pagination for bulma: it returns the html with the series of links to the pages
     def bulma_series_nav(classes: 'pagination', **)
       a_lambda = a_lambda(**)
 

data/lib/pagy/toolbox/helpers/bulma/series_nav_js.rb

@@ -7,7 +7,6 @@ class Pagy
   module NumericHelpers
     private
 
-    # Javascript pagination for bulma: it returns a nav with a data-pagy attribute used by the Pagy.nav javascript
     def bulma_series_nav_js(classes: 'pagination', **)
       a_lambda = a_lambda(**)
 

data/lib/pagy/toolbox/helpers/headers_hash.rb

@@ -2,7 +2,7 @@
 
 require_relative 'urls_hash'
 
-# Add pagination response headers
+# Handle pagination response headers
 class Pagy
   DEFAULT_HEADERS_MAP = { page:  'current-page',
                           limit: 'page-limit',

data/lib/pagy/toolbox/helpers/info_tag.rb

@@ -2,8 +2,8 @@
 
 class Pagy
   module NumericHelpers
-    # Instances with count return "Displaying items 41-60 of 324 in total" or "Displaying Products 41-60 of 324 in total"
-    # Instances with no count return only page info: "Page 3 of 100"
+    # Instances with count return "Displaying items 41-60 of 324 in total" or "Displaying Products 41-60 of 324 in total".
+    # Instances with no count return only page info: "Page 3 of 100".
     def info_tag(id: nil, item_name: nil)
       i18n_key  = if @count.nil?
                     'pagy.info_tag.no_count'

data/lib/pagy/toolbox/helpers/input_nav_js.rb

@@ -4,7 +4,6 @@ require_relative 'support/wrap_input_nav_js'
 
 class Pagy
   module NumericHelpers
-    # JavaScript input pagination: it returns a nav with a data-pagy attribute used by the pagy.js file
     def input_nav_js(style = nil, **)
       return send(:"#{style}_input_nav_js", **) if style && style.to_s != 'pagy'
 

data/lib/pagy/toolbox/helpers/limit_tag_js.rb

@@ -4,11 +4,10 @@ require_relative 'support/data_pagy_attribute'
 
 class Pagy
   module NumericHelpers
-    # Return the limit selector HTML. For example "Show [20] items per page"
-    def limit_tag_js(id: nil, item_name: nil, client_max_limit: @options[:client_max_limit], **)
-      raise OptionError.new(self, :client_max_limit, 'to be truthy', client_max_limit) unless client_max_limit
+    def limit_tag_js(id: nil, item_name: nil, max_limit: @options[:max_limit], **)
+      raise OptionError.new(self, :max_limit, 'to be truthy', max_limit) unless max_limit
 
-      limit_input = %(<input name="limit" type="number" min="1" max="#{client_max_limit}" value="#{
+      limit_input = %(<input name="limit" type="number" min="1" max="#{max_limit}" value="#{
                       @limit}" style="padding: 0; text-align: center; width: #{@limit.to_s.length + 1}rem;">#{A_TAG})
 
       url_token = compose_page_url(PAGE_TOKEN, limit: LIMIT_TOKEN)

data/lib/pagy/toolbox/helpers/loaders.rb

@@ -2,7 +2,7 @@
 
 class Pagy
   # The aliaser defines loader methods and aliases them.
-  # When a method is called for the first time, its loader will load the full implementation
+  # When a method is called for the first time, its loader will load the full implementation,
   # which will overwrite the alias and will be executed.
   # Subsequent calls will run the full implementation directly.
   aliaser = lambda do |receiver, paths|

data/lib/pagy/toolbox/helpers/page_url.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 class Pagy
-  # Return the page url for any page
   def page_url(page, **)
     target = case page
              when :first          then nil

data/lib/pagy/toolbox/helpers/series_nav.rb

@@ -4,7 +4,6 @@ require_relative 'support/wrap_series_nav'
 
 class Pagy
   module NumericHelpers
-    # Return the HTML with the series of links to the pages
     def series_nav(style = nil, **)
       return send(:"#{style}_series_nav", **) if style && style.to_s != 'pagy'
 

data/lib/pagy/toolbox/helpers/series_nav_js.rb

@@ -4,7 +4,6 @@ require_relative 'support/wrap_series_nav_js'
 
 class Pagy
   module NumericHelpers
-    # Return a nav with a data-pagy attribute used by the pagy.js file
     def series_nav_js(style = nil, **)
       return send(:"#{style}_series_nav_js", **) if style && style.to_s != 'pagy'
 

data/lib/pagy/toolbox/helpers/support/a_lambda.rb

@@ -3,7 +3,6 @@
 class Pagy
   protected
 
-  # Label for any page. Allow the customization of the output
   def page_label(page, **options)
     return page.to_s unless calendar?
 
@@ -11,8 +10,8 @@ class Pagy
     localize(starting_time_for(page.to_i), **options)  # page could be a string
   end
 
-  # Return a performance optimized lambda to generate the anchor tag
-  # Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails' link_to
+  # Return a performance optimized lambda to generate the anchor tag.
+  # Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails' link_to.
   def a_lambda(anchor_string: @options[:anchor_string], **)
     left, right = %(<a href="#{compose_page_url(PAGE_TOKEN, **)}"#{
                     %( #{anchor_string}) if anchor_string}).split(PAGE_TOKEN, 2)

data/lib/pagy/toolbox/helpers/support/data_pagy_attribute.rb

@@ -3,7 +3,6 @@
 require 'json'
 require_relative '../../../modules/b64'
 
-# Relegate internal functions. Make overriding navs easier.
 class Pagy
   private
 

data/lib/pagy/toolbox/helpers/support/nav_aria_label_attribute.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-# Relegate internal functions. Make overriding navs easier.
 class Pagy
   private
 
-  # Compose the aria label attribute for the nav
   def nav_aria_label_attribute(aria_label: nil)
     aria_label ||= I18n.translate('pagy.aria_label.nav', count: @last)
     %(aria-label="#{aria_label}")

data/lib/pagy/toolbox/helpers/support/series.rb

@@ -5,7 +5,7 @@ class Pagy
 
   protected
 
-  # Return the array of page numbers and :gap e.g. [1, :gap, 8, "9", 10, :gap, 36]
+  # The array of page numbers and :gap e.g. [1, :gap, 8, "9", 10, :gap, 36]
   def series(slots: @options[:slots] || SERIES_SLOTS, compact: @options[:compact], **)
     raise OptionError.new(self, :slots, 'to be an Integer >= 0', slots) unless slots.is_a?(Integer) && slots >= 0
     return [] if slots.zero?
@@ -14,7 +14,7 @@ class Pagy
       if slots >= @last
         series.push(*1..@last)
       else
-        half  = (slots - 1) / 2                       # the left half might be 1 page shorter when the slots are even
+        half  = (slots - 1) / 2                       # even slots makes the left half shorter by 1
         start = if @page <= half                      # @page in the first half
                   1
                 elsif @page > (@last - slots + half)  # @page in the last half

data/lib/pagy/toolbox/helpers/support/wrap_input_nav_js.rb

@@ -4,11 +4,10 @@ require_relative 'nav_aria_label_attribute'
 require_relative 'data_pagy_attribute'
 require_relative 'a_lambda' # inherited use
 
-# Relegate internal functions. Make overriding navs easier.
 class Pagy
   private
 
-  # Build the input_nav_js tag, with the specific inner html for the style
+  # Common input_nav_js logic
   def wrap_input_nav_js(html, nav_classes, id: nil, aria_label: nil, **)
     %(<nav#{%( id="#{id}") if id} class="#{nav_classes}" #{
       nav_aria_label_attribute(aria_label:)} #{

data/lib/pagy/toolbox/helpers/support/wrap_series_nav.rb

@@ -5,11 +5,10 @@ require_relative 'nav_aria_label_attribute'
 require_relative 'data_pagy_attribute'
 require_relative 'a_lambda' # inherited use
 
-# Relegate internal functions. Make overriding navs easier.
 class Pagy
   private
 
-  # Build the nav tag, with the specific inner html for the style
+  # Common series_nav logic
   def wrap_series_nav(html, nav_classes, id: nil, aria_label: nil, **)
     data = %( #{data_pagy_attribute(:k, @update)}) if keynav?
 

data/lib/pagy/toolbox/helpers/support/wrap_series_nav_js.rb

@@ -9,7 +9,7 @@ require_relative 'a_lambda' # inherited use
 class Pagy
   private
 
-  # Return the reverse sorted array of widths, series, and labels generated from the :steps hash
+  # The reverse-sorted array of widths, series, and labels generated from the :steps hash.
   # If :steps is false it will use the single {0 => @options[:slots]} length
   def sequels(steps: @options[:steps] || { 0 => @options[:slots] || SERIES_SLOTS }, **)
     raise OptionError.new(self, :steps, 'to define the 0 width', steps) unless steps.key?(0)
@@ -18,7 +18,7 @@ class Pagy
     [widths, series, page_labels(series)]
   end
 
-  # Support for the Calendar API
+  # Support the Calendar API
   def page_labels(series)
     return unless calendar?
 
@@ -27,7 +27,7 @@ class Pagy
     end
   end
 
-  # Build the nav_js tag, with the specific tokens for the style
+  # Common series_nav_js logic
   def wrap_series_nav_js(tokens, nav_classes, id: nil, aria_label: nil, **)
     sequels     = sequels(**)
     nav_classes = "pagy-rjs #{nav_classes}" if sequels[0].size > 1

data/lib/pagy/toolbox/helpers/urls_hash.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 class Pagy
-  # Generate the hash of the pagination links
   def urls_hash(**)
     template = compose_page_url(PAGE_TOKEN, **)
 

data/lib/pagy/toolbox/paginators/calendar.rb

@@ -4,7 +4,7 @@ class Pagy
   module CalendarPaginator
     module_function
 
-    # Take a collection and a configuration Hash and return an array with 3 items: [calendar, pagy, results]
+    # Take a collection and a config Hash and return [calendar, pagy, results]
     def paginate(context, collection, config)
       context.instance_eval do
         allowed_options = Calendar::UNITS + %i[offset disabled request]

data/lib/pagy/toolbox/paginators/countish.rb

@@ -6,7 +6,6 @@ class Pagy
   module CountishPaginator
     module_function
 
-    # Return the Offset::Countish instance and records
     def paginate(collection, options)
       options[:page] ||= options[:request].resolve_page(force_integer: false)
 

data/lib/pagy/toolbox/paginators/countless.rb

@@ -4,7 +4,6 @@ class Pagy
   module CountlessPaginator
     module_function
 
-    # Return the Offset::Countless instance and records
     def paginate(collection, options)
       options[:page] ||= options[:request].resolve_page(force_integer: false) # accept nil and strings
 

data/lib/pagy/toolbox/paginators/elasticsearch_rails.rb

@@ -6,7 +6,6 @@ class Pagy
   module ElasticsearchRailsPaginator
     module_function
 
-    # Paginate from the search object
     def paginate(search, options)
       if search.is_a?(Search::Arguments)  # Active mode
 
@@ -33,7 +32,7 @@ class Pagy
       end
     end
 
-    # Get from and size params from the response object, supporting different versions of ElasticsearchRails
+    # Support different versions of ElasticsearchRails
     def pagination_params_from(response_object)
       definition = response_object.search.definition
       definition = definition.to_hash if definition.respond_to?(:to_hash)
@@ -45,7 +44,7 @@ class Pagy
       [from, size]
     end
 
-    # Get the count from the response object, supporting different versions of ElasticsearchRails
+    # Support different versions of ElasticsearchRails
     def total_count_from(response_object)
       total = response_object.instance_eval do
                 respond_to?(:response) ? response['hits']['total'] : raw_response['hits']['total']

data/lib/pagy/toolbox/paginators/keynav_js.rb

@@ -6,8 +6,6 @@ class Pagy
   module KeynavJsPaginator
     module_function
 
-    # Return the Pagy::Keyset::Keynav instance and paginated records.
-    # Fall back to :countless if the :page has no client data.
     def paginate(set, options)
       page = options[:request].resolve_page(force_integer: false) # allow nil
 

data/lib/pagy/toolbox/paginators/keyset.rb

@@ -4,7 +4,6 @@ class Pagy
   module KeysetPaginator
     module_function
 
-    # Return Pagy::Keyset instance and paginated records
     def paginate(set, options)
       options[:page] ||= options[:request].resolve_page(force_integer: false) # allow nil
       options[:limit]  = options[:request].resolve_limit

data/lib/pagy/toolbox/paginators/meilisearch.rb

@@ -6,7 +6,6 @@ class Pagy
   module MeilisearchPaginator
     module_function
 
-    # Paginate from the search object
     def paginate(search, options)
       if search.is_a?(Search::Arguments) # Active mode
 

data/lib/pagy/toolbox/paginators/method.rb

@@ -29,7 +29,7 @@ class Pagy
                            end
 
                options[:root_key]  = 'page' if options[:jsonapi] # enforce 'page' root_key for JSON:API
-               options[:request] ||= request                     # user set request or self.request
+               options[:request] ||= request                     # custom request Hash or self.request
                options[:request]   = Request.new(options)        # Pagy::Request
 
                Pagy.const_get(paginators[paginator]).paginate(*arguments)

data/lib/pagy/toolbox/paginators/offset.rb

@@ -6,7 +6,6 @@ class Pagy
   module OffsetPaginator
     module_function
 
-    # Return the Pagy::Offset instance and results
     def paginate(collection, options)
       options[:page]  ||= options[:request].resolve_page
       options[:limit]   = options[:request].resolve_limit

data/lib/pagy/toolbox/paginators/searchkick.rb

@@ -6,7 +6,6 @@ class Pagy
   module SearchkickPaginator
     module_function
 
-    # Paginate from the search object
     def paginate(search, options)
       if search.is_a?(Search::Arguments) # Active mode
 

data/lib/pagy/toolbox/paginators/typesense_rails.rb

@@ -6,7 +6,6 @@ class Pagy
   module TypesenseRailsPaginator
     module_function
 
-    # Paginate from the search object
     def paginate(search, options)
       if search.is_a?(Search::Arguments) # Active mode
 

data/lib/pagy.rb

@@ -7,10 +7,9 @@ require_relative 'pagy/modules/abilities/linkable'
 require_relative 'pagy/modules/abilities/configurable'
 require_relative 'pagy/toolbox/helpers/loaders'
 
-# Top superclass: it defines only what's common to all the subclasses
-# noinspection RubyMismatchedArgumentType
+# Top superclass
 class Pagy
-  VERSION     = '43.4.4'
+  VERSION     = '43.5.1'
   ROOT        = Pathname.new(__dir__).parent.freeze
   DEFAULT     = { limit: 20, limit_key: 'limit', page_key: 'page' }.freeze
   PAGE_TOKEN  = EscapedValue.new('P ')
@@ -34,12 +33,6 @@ class Pagy
 
   OPTIONS = {} # rubocop:disable Style/MutableConstant
 
-  def self.options
-    OPTIONS.tap do
-      warn "[PAGY] 'Pagy.options' is deprecated: use 'Pagy::OPTIONS directly'"
-    end
-  end
-
   extend Configurable
   include Linkable
   include HelperLoader
@@ -48,7 +41,7 @@ class Pagy
 
   protected
 
-  # Define the hierarchical identity methods, overridden by the respective classes
+  # Instance identity methods, overridden by the respective classes
   def offset?    = false
   def countless? = false
   def calendar?  = false
@@ -56,7 +49,7 @@ class Pagy
   def keyset?    = false
   def keynav?    = false
 
-  # Validates and assign the passed options: they must be present and value.to_i must be >= min
+  # Validate presence and min value of options
   def assign_and_check(name_min)
     name_min.each do |name, min|
       value = @options[name]
@@ -71,11 +64,6 @@ class Pagy
 
   # Merge all the DEFAULT constants of the class hierarchy with the options
   def assign_options(**options)
-    if options.key?(:max_pages)
-      warn "[PAGY] the ':max_pages' option is deprecated: " \
-           'use https://ddnexus.github.io/pagy/guides/how-to/#paginate-only-max-records instead.'
-    end
-
     @request = options.delete(:request) # internal object
     default  = {}
     current  = self.class
@@ -95,3 +83,5 @@ class Pagy
     include NumericHelperLoader
   end
 end
+
+require_relative ENV['PAGY_NEXT'] == 'true' ? 'pagy/next' : 'pagy/deprecated'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 43.4.4
+  version: 43.5.1
 platform: ruby
 authors:
 - Domizio Demichelis
@@ -98,6 +98,7 @@ files:
 - lib/pagy/classes/request.rb
 - lib/pagy/cli.rb
 - lib/pagy/console.rb
+- lib/pagy/deprecated.rb
 - lib/pagy/modules/abilities/configurable.rb
 - lib/pagy/modules/abilities/countable.rb
 - lib/pagy/modules/abilities/linkable.rb
@@ -115,6 +116,7 @@ files:
 - lib/pagy/modules/i18n/p11n/polish.rb
 - lib/pagy/modules/i18n/p11n/west_slavic.rb
 - lib/pagy/modules/searcher.rb
+- lib/pagy/next.rb
 - lib/pagy/tasks/sync.rb
 - lib/pagy/toolbox/helpers/anchor_tags.rb
 - lib/pagy/toolbox/helpers/bootstrap/input_nav_js.rb
@@ -191,7 +193,6 @@ files:
 - locales/zh-CN.yml
 - locales/zh-HK.yml
 - locales/zh-TW.yml
-- sig/pagy.rbs
 - stylesheets/pagy-tailwind.css
 - stylesheets/pagy.css
 homepage: https://github.com/ddnexus/pagy
@@ -211,14 +212,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: "Pagy \U0001F438 The Leaping Gem!"
 test_files: []