pagy 4.11.0 → 6.0.0

data/lib/pagy/countless.rb

@@ -1,38 +1,37 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/countless
 # frozen_string_literal: true
 
 require 'pagy'
 
 class Pagy
-
+  # No need to know the count to paginate
   class Countless < Pagy
-
-    INSTANCE_VARS_MIN = { items: 1, page: 1, outset: 0 }.freeze
-
     # Merge and validate the options, do some simple arithmetic and set a few instance variables
-    def initialize(vars={})  # rubocop:disable Lint/MissingSuper
-      @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })      # default vars + cleaned vars (can be overridden)
-      @vars[:fragment] = Pagy.deprecated_var(:anchor, @vars[:anchor], :fragment, @vars[:fragment]) if @vars[:anchor]
-
-      INSTANCE_VARS_MIN.each do |k,min|                                 # validate instance variables
-        raise VariableError.new(self), "expected :#{k} >= #{min}; got #{@vars[k].inspect}" \
-              unless @vars[k] && instance_variable_set(:"@#{k}", @vars[k].to_i) >= min
-      end
-      @offset = @items * (@page - 1) + @outset                          # pagination offset + outset (initial offset)
+    def initialize(vars = {}) # rubocop:disable Lint/MissingSuper
+      normalize_vars(vars)
+      setup_vars(page: 1, outset: 0)
+      setup_items_var
+      setup_offset_var
+      setup_params_var
     end
 
-    # Finalize the instance variables based on the fetched items
-    def finalize(fetched)
-      raise OverflowError.new(self), "page #{@page} got no items" \
-            if fetched.zero? && @page > 1
+    # Finalize the instance variables based on the fetched size
+    def finalize(fetched_size)
+      raise OverflowError.new(self, :page, "to be < #{@page}", @page) if fetched_size.zero? && @page > 1
 
-      @pages = @last = (fetched > @items ? @page + 1 : @page)         # set the @pages and @last
-      @items = fetched if fetched < @items && fetched.positive?       # adjust items for last non-empty page
-      @from  = fetched.zero? ? 0 : @offset + 1 - @outset              # page begins from item
-      @to    = fetched.zero? ? 0 : @offset + @items - @outset         # page ends to item
-      @prev  = (@page-1 unless @page == 1)                            # nil if no prev page
-      @next  = @page == @last ? (1 if @vars[:cycle]) : @page + 1      # nil if no next page, 1 if :cycle
+      @pages = @last = (fetched_size > @items ? @page + 1 : @page)
+      @in    = [fetched_size, @items].min
+      @from  = @in.zero? ? 0 : @offset - @outset + 1
+      @to    = @offset - @outset + @in
+      @prev  = (@page - 1 unless @page == 1)
+      @next  = @page == @last ? (1 if @vars[:cycle]) : @page + 1
       self
     end
 
+    # Override the original series.
+    # Return nil if :countless_minimal is enabled
+    def series(*, **)
+      super unless @vars[:countless_minimal]
+    end
   end
 end

data/lib/pagy/exceptions.rb

@@ -1,27 +1,25 @@
 # frozen_string_literal: true
 
 class Pagy
-
-  # generic variable error
+  # Generic variable error
   class VariableError < ArgumentError
-    attr_reader :pagy
-
-    def initialize(pagy)
-      super
-      @pagy = pagy
-    end
+    attr_reader :pagy, :variable, :value
 
-    def variable
-      message =~ /expected :(\w+)/
-      Regexp.last_match(1)&.to_sym
-    end
-
-    def value
-      pagy.vars[variable]
+    # Set the variables and prepare the message
+    def initialize(pagy, variable, description, value)
+      @pagy     = pagy
+      @variable = variable
+      @value    = value
+      super "expected :#{@variable} #{description}; got #{@value.inspect}"
     end
   end
 
-  # specific overflow error
+  # Specific overflow error
   class OverflowError < VariableError; end
 
+  # I18n configuration error
+  class I18nError < StandardError; end
+
+  # Generic internal error
+  class InternalError < StandardError; end
 end

data/lib/pagy/extras/arel.rb

@@ -1,22 +1,26 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/arel
 # frozen_string_literal: true
 
-class Pagy
-  module Backend
+class Pagy # :nodoc:
+  # Better performance of grouped ActiveRecord collections
+  module ArelExtra
     private
 
-    def pagy_arel(collection, vars={})
+    # Return Pagy object and paginated collection/results
+    def pagy_arel(collection, vars = {})
       pagy = Pagy.new(pagy_arel_get_vars(collection, vars))
-      [ pagy, pagy_get_items(collection, pagy) ]
+      [pagy, pagy_get_items(collection, pagy)]
     end
 
+    # Sub-method called only by #pagy_arel: here for easy customization of variables by overriding
     def pagy_arel_get_vars(collection, vars)
-      pagy_set_items_from_params(vars) if defined?(UseItemsExtra)
+      pagy_set_items_from_params(vars) if defined?(ItemsExtra)
       vars[:count] ||= pagy_arel_count(collection)
-      vars[:page]  ||= params[ vars[:page_param] || VARS[:page_param] ]
+      vars[:page]  ||= params[vars[:page_param] || DEFAULT[:page_param]]
       vars
     end
 
+    # Count using Arel when grouping
     def pagy_arel_count(collection)
       if collection.group_values.empty?
         # COUNT(*)
@@ -27,6 +31,6 @@ class Pagy
         collection.unscope(:order).limit(1).pluck(sql).first.to_i
       end
     end
-
   end
+  Backend.prepend ArelExtra
 end

data/lib/pagy/extras/array.rb

@@ -1,24 +1,24 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/array
 # frozen_string_literal: true
 
-class Pagy
-  # Add specialized backend methods to paginate array collections
-  module Backend
+class Pagy # :nodoc:
+  # Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding
+  module ArrayExtra
     private
 
-    # Return Pagy object and items
-    def pagy_array(array, vars={})
+    # Return Pagy object and paginated items
+    def pagy_array(array, vars = {})
       pagy = Pagy.new(pagy_array_get_vars(array, vars))
-      [ pagy, array[pagy.offset, pagy.items] ]
+      [pagy, array[pagy.offset, pagy.items]]
     end
 
     # Sub-method called only by #pagy_array: here for easy customization of variables by overriding
     def pagy_array_get_vars(array, vars)
-      pagy_set_items_from_params(vars) if defined?(UseItemsExtra)
+      pagy_set_items_from_params(vars) if defined?(ItemsExtra)
       vars[:count] ||= array.size
-      vars[:page]  ||= params[ vars[:page_param] || VARS[:page_param] ]
+      vars[:page]  ||= params[vars[:page_param] || DEFAULT[:page_param]]
       vars
     end
-
   end
+  Backend.prepend ArrayExtra
 end

data/lib/pagy/extras/bootstrap.rb

@@ -1,86 +1,93 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bootstrap
 # 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 BootstrapExtra
     # Pagination for bootstrap: it returns the html with the series of links to the pages
-    def pagy_bootstrap_nav(pagy, pagy_id: nil, link_extra: '')
+    def pagy_bootstrap_nav(pagy, pagy_id: nil, link_extra: '', **vars)
       p_id = %( id="#{pagy_id}") if pagy_id
       link = pagy_link_proc(pagy, link_extra: %(class="page-link" #{link_extra}))
 
-      html = +%(<nav#{p_id} class="pagy-bootstrap-nav" aria-label="pager"><ul class="pagination">)
+      html = +%(<nav#{p_id} class="pagy-bootstrap-nav"><ul class="pagination">)
       html << pagy_bootstrap_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="page-item">#{link.call item}</li>)
-                when String  then %(<li class="page-item active">#{link.call item}</li>)
-                when :gap    then %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.gap'}</a></li>)
+                when Integer
+                  %(<li class="page-item">#{link.call item}</li>)
+                when String
+                  %(<li class="page-item active">#{link.call item}</li>)
+                when :gap
+                  %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.gap'}</a></li>)
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_bootstrap_next_html(pagy, link)
       html << %(</ul></nav>)
     end
 
-    # Javascript pagination for bootstrap: it returns a nav and a JSON tag used by the Pagy.nav javascript
-    def pagy_bootstrap_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 bootstrap: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_bootstrap_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: %(class="page-link" #{link_extra}))
       tags = { 'before' => %(<ul class="pagination">#{pagy_bootstrap_prev_html pagy, link}),
-               'link'   => %(<li class="page-item">#{mark = link.call(PAGE_PLACEHOLDER)}</li>),
+               'link'   => %(<li class="page-item">#{mark = link.call(PAGE_PLACEHOLDER, LABEL_PLACEHOLDER)}</li>),
                'active' => %(<li class="page-item active">#{mark}</li>),
                'gap'    => %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.gap'}</a></li>),
                'after'  => %(#{pagy_bootstrap_next_html pagy, link}</ul>) }
 
-      %(<nav#{p_id} class="pagy-njs pagy-bootstrap-nav-js" aria-label="pager" #{pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></nav>)
+      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-bootstrap-nav-js" #{
+        pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
     end
 
-    # Javascript combo pagination for bootstrap: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
-    def pagy_bootstrap_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 bootstrap: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_bootstrap_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}" class="text-primary" style="padding: 0; border: none; text-align: center; width: #{p_pages.to_s.length+1}rem;">)
+      input   = %(<input type="number" min="1" max="#{p_pages}" value="#{
+                    p_page}" class="text-primary" style="padding: 0; border: none; text-align: center; width: #{
+                    p_pages.to_s.length + 1}rem;">)
 
-      %(<nav#{p_id} class="pagy-bootstrap-combo-nav-js pagination" aria-label="pager"><div class="btn-group" role="group" #{
-          pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
-      }>#{
+      %(<nav#{p_id} class="pagy-bootstrap-combo-nav-js pagination"><div class="btn-group" role="group" #{
+          pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
           if (p_prev = pagy.prev)
             link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous" class="prev btn btn-primary"'
           else
             %(<a class="prev btn btn-primary disabled" href="#">#{pagy_t('pagy.nav.prev')}</a>)
           end
-      }<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>#{
+        }<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>#{
           if (p_next  = pagy.next)
             link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next" class="next btn btn-primary"'
           else
-            %(<a class="next btn btn-primary disabled" href="#">#{pagy_t 'pagy.nav.next' }</a>)
+            %(<a class="next btn btn-primary disabled" href="#">#{pagy_t 'pagy.nav.next'}</a>)
           end
-      }</div></nav>)
+        }</div></nav>)
     end
 
     private
 
-      def pagy_bootstrap_prev_html(pagy, link)
-        if (p_prev = pagy.prev)
-          %(<li class="page-item prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
-        else
-          %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.prev'}</a></li>)
-        end
+    def pagy_bootstrap_prev_html(pagy, link)
+      if (p_prev = pagy.prev)
+        %(<li class="page-item prev">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"'}</li>)
+      else
+        %(<li class="page-item prev disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.prev'}</a></li>)
       end
+    end
 
-      def pagy_bootstrap_next_html(pagy, link)
-        if (p_next = pagy.next)
-          %(<li class="page-item next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
-        else
-          %(<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.next'}</a></li>)
-        end
+    def pagy_bootstrap_next_html(pagy, link)
+      if (p_next = pagy.next)
+        %(<li class="page-item next">#{link.call p_next, pagy_t('pagy.nav.next'), 'aria-label="next"'}</li>)
+      else
+        %(<li class="page-item next disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.next'}</a></li>)
       end
-
+    end
   end
+  Frontend.prepend BootstrapExtra
 end

data/lib/pagy/extras/bulma.rb

@@ -1,82 +1,94 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bulma
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+require 'pagy/extras/frontend_helpers'
 
-class Pagy
-  module Frontend
-
-    # Pagination for Bulma: it returns the html with the series of links to the pages
-    def pagy_bulma_nav(pagy, pagy_id: nil, link_extra: '')
+class Pagy # :nodoc:
+  # Frontend modules are specially optimized for performance.
+  # The resulting code may not look very elegant, but produces the best benchmarks
+  module BulmaExtra
+    # Pagination for bulma: it returns the html with the series of links to the pages
+    def pagy_bulma_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-bulma-nav pagination is-centered" aria-label="pagination">)
       html << pagy_bulma_prev_next_html(pagy, link)
       html << %(<ul class="pagination-list">)
-      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, item, %(class="pagination-link" aria-label="goto page #{item}") }</li>)                           # page link
-                when String  then %(<li>#{link.call item, item, %(class="pagination-link is-current" aria-label="page #{item}" aria-current="page")}</li>)  # active page
-                when :gap    then %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>)                                            # page gap
+                when Integer
+                  %(<li>#{link.call item, pagy.label_for(item), %(class="pagination-link" aria-label="goto page #{item}")}</li>)
+                when String
+                  %(<li>#{link.call item, pagy.label_for(item),
+                                    %(class="pagination-link is-current" aria-label="page #{item}" aria-current="page")}</li>)
+                when :gap
+                  %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>)
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << %(</ul></nav>)
     end
 
-    def pagy_bulma_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 bulma: it returns a nav and a JSON tag used by the Pagy.nav javascript
+    def pagy_bulma_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_bulma_prev_next_html(pagy, link)}<ul class="pagination-list">),
-               'link'   => %(<li>#{link.call PAGE_PLACEHOLDER, PAGE_PLACEHOLDER, %(class="pagination-link" aria-label="goto page #{PAGE_PLACEHOLDER}")}</li>),
-               '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>),
+               'link'   => %(<li>#{link.call PAGE_PLACEHOLDER, LABEL_PLACEHOLDER,
+                                             %(class="pagination-link" aria-label="goto page #{PAGE_PLACEHOLDER}")}</li>),
+               'active' => %(<li>#{link.call PAGE_PLACEHOLDER, LABEL_PLACEHOLDER,
+                                             %(class="pagination-link is-current" aria-current="page" aria-label="page #{
+                                                 PAGE_PLACEHOLDER}")}</li>),
+               'gap'    => %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>),
                'after'  => '</ul>' }
 
-      %(<nav#{p_id} class="pagy-njs pagy-bulma-nav-js pagination is-centered" aria-label="pagination" #{pagy_json_attr(pagy, :nav, tags, pagy.sequels(steps))}></nav>)
+      %(<nav#{p_id} class="#{'pagy-rjs ' if sequels.size > 1}pagy-bulma-nav-js pagination is-centered" aria-label="pagination" #{
+        pagy_data(pagy, :nav, tags, sequels, pagy.label_sequels(sequels))}></nav>)
     end
 
-    # Javascript combo pagination for Bulma: it returns a nav and a JSON tag used by the Pagy.combo_nav javascript
-    def pagy_bulma_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 bulma: it returns a nav and a JSON tag used by the pagy.js file
+    def pagy_bulma_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" 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;">)
+      input   = %(<input class="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;">)
 
-      %(<nav#{p_id} class="pagy-bulma-combo-nav-js" aria-label="pagination"><div class="field is-grouped is-grouped-centered" role="group" #{
-         pagy_json_attr pagy, :combo_nav, p_page, pagy_marked_link(link)
-      }>#{
+      html = %(<nav#{p_id} class="pagy-bulma-combo-nav-js" aria-label="pagination">)
+      %(#{html}<div class="field is-grouped is-grouped-centered" role="group" #{
+          pagy_data(pagy, :combo, pagy_marked_link(link))}>#{
           if (p_prev  = pagy.prev)
             %(<p class="control">#{link.call p_prev, pagy_t('pagy.nav.prev'), 'class="button" aria-label="previous page"'}</p>)
           else
             %(<p class="control"><a class="button" disabled>#{pagy_t 'pagy.nav.prev'}</a></p>)
           end
-      }<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>#{
+        }<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>#{
           if (p_next  = pagy.next)
             %(<p class="control">#{link.call p_next, pagy_t('pagy.nav.next'), 'class="button" aria-label="next page"'}</p>)
           else
             %(<p class="control"><a class="button" disabled>#{pagy_t 'pagy.nav.next'}</a></p>)
           end
-      }</div></nav>)
+        }</div></nav>)
     end
 
     private
 
-      def pagy_bulma_prev_next_html(pagy, link)
-        html  = +if (p_prev = pagy.prev)
-                  link.call p_prev, pagy_t('pagy.nav.prev'), 'class="pagination-previous" aria-label="previous page"'
-                else
-                  %(<a class="pagination-previous" disabled>#{pagy_t 'pagy.nav.prev'}</a>)
-                end
-        html << if (p_next = pagy.next)
-                  link.call p_next, pagy_t('pagy.nav.next'), 'class="pagination-next" aria-label="next page"'
-                else
-                  %(<a class="pagination-next" disabled>#{pagy_t 'pagy.nav.next' }</a>)
-                end
-      end
-
+    def pagy_bulma_prev_next_html(pagy, link)
+      html = +if (p_prev = pagy.prev)
+                link.call p_prev, pagy_t('pagy.nav.prev'), 'class="pagination-previous" aria-label="previous page"'
+              else
+                %(<a class="pagination-previous" disabled>#{pagy_t 'pagy.nav.prev'}</a>)
+              end
+      html << if (p_next = pagy.next)
+                link.call p_next, pagy_t('pagy.nav.next'), 'class="pagination-next" aria-label="next page"'
+              else
+                %(<a class="pagination-next" disabled>#{pagy_t 'pagy.nav.next'}</a>)
+              end
+    end
   end
+  Frontend.prepend BulmaExtra
 end

data/lib/pagy/extras/calendar.rb

@@ -0,0 +1,49 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/calendar
+# frozen_string_literal: true
+
+require 'pagy/calendar'
+require 'pagy/calendar/helper'
+
+class Pagy # :nodoc:
+  # Add pagination filtering by calendar unit (:year, :quarter, :month, :week, :day) to the regular pagination
+  module CalendarExtra
+    # Additions for the Backend module
+    module Backend
+      CONF_KEYS = (Calendar::UNITS + %i[pagy active]).freeze
+
+      private
+
+      # Take a collection and a conf Hash with keys in CONF_KEYS and return an array with 3 items: [calendar, pagy, results]
+      def pagy_calendar(collection, conf)
+        unless conf.is_a?(Hash) && (conf.keys - CONF_KEYS).empty? && conf.all? { |k, v| v.is_a?(Hash) || k == :active }
+          raise ArgumentError, "keys must be in #{CONF_KEYS.inspect} and object values must be Hashes; got #{conf.inspect}"
+        end
+
+        conf[:pagy] = {} unless conf[:pagy]  # use default Pagy object when omitted
+        unless conf.key?(:active) && !conf[:active]
+          calendar, from, to = Calendar::Helper.send(:init, conf, pagy_calendar_period(collection), params)
+          collection         = pagy_calendar_filter(collection, from, to)
+        end
+        pagy, results = send(conf[:pagy][:backend] || :pagy, collection, conf[:pagy])  # use backend: :pagy when omitted
+        [calendar, pagy, results]
+      end
+
+      def pagy_calendar_url_at(calendar, time)
+        pagy_url_for(calendar.send(:last_object_at, time), 1)
+      end
+
+      # This method must be implemented by the application
+      def pagy_calendar_period(*)
+        raise NoMethodError, 'the pagy_calendar_period method must be implemented by the application ' \
+                             '(see https://ddnexus.github.io/pagy/extras/calendar#pagy_calendar_periodcollection)'
+      end
+
+      # This method must be implemented by the application
+      def pagy_calendar_filter(*)
+        raise NoMethodError, 'the pagy_calendar_filter method must be implemented by the application ' \
+                             '(see https://ddnexus.github.io/pagy/extras/calendar#pagy_calendar_filtercollection-from-to)'
+      end
+    end
+  end
+  Backend.prepend CalendarExtra::Backend
+end

data/lib/pagy/extras/countless.rb

@@ -3,38 +3,35 @@
 
 require 'pagy/countless'
 
-class Pagy
+class Pagy # :nodoc:
+  DEFAULT[:countless_minimal] = false
 
-  VARS[:countless_minimal] = false
-
-  module Backend
-    private         # the whole module is private so no problem with including it in a controller
+  # Paginate without the need of any count, saving one query per rendering
+  module CountlessExtra
+    private
 
     # Return Pagy object and items
-    def pagy_countless(collection, vars={})
-      pagy = Pagy::Countless.new(pagy_countless_get_vars(collection, vars))
-      [ pagy, pagy_countless_get_items(collection, pagy) ]
+    def pagy_countless(collection, vars = {})
+      pagy = Countless.new(pagy_countless_get_vars(collection, vars))
+      [pagy, pagy_countless_get_items(collection, pagy)]
     end
 
     # Sub-method called only by #pagy_countless: here for easy customization of variables by overriding
     def pagy_countless_get_vars(_collection, vars)
-      pagy_set_items_from_params(vars) if defined?(UseItemsExtra)
-      vars[:page] ||= params[ vars[:page_param] || VARS[:page_param] ]
+      pagy_set_items_from_params(vars) if defined?(ItemsExtra)
+      vars[:page] ||= params[vars[:page_param] || DEFAULT[:page_param]]
       vars
     end
 
     # Sub-method called only by #pagy_countless: here for easy customization of record-extraction by overriding
+    # You may need to override this method for collections without offset|limit
     def pagy_countless_get_items(collection, pagy)
-      # This should work with ActiveRecord, Sequel, Mongoid...
       return collection.offset(pagy.offset).limit(pagy.items) if pagy.vars[:countless_minimal]
 
-      items      = collection.offset(pagy.offset).limit(pagy.items + 1).to_a
-      items_size = items.size
-      items.pop if items_size == pagy.items + 1
-      # finalize may adjust pagy.items, so must be used after checking the size
-      pagy.finalize(items_size)
-      items
+      fetched = collection.offset(pagy.offset).limit(pagy.items + 1).to_a # eager load items + 1
+      pagy.finalize(fetched.size)                                         # finalize the pagy object
+      fetched[0, pagy.items]                                              # ignore eventual extra item
     end
-
   end
+  Backend.prepend CountlessExtra
 end