pagy 5.2.2 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb4539d68931db35f7f2f8c9d53d9e8a63541f402f23621b92a51e6a2e77386
-  data.tar.gz: 4adbae6e3d5213c6628bec8a35a26c5e44ce09546fa6fdd74541d5bbf2feb63b
+  metadata.gz: 32d028f5c02fafb87cc0bb10f1b28ebf1f49b89babf4cfcf2099367b69cf88af
+  data.tar.gz: c5cf934095bfaed81c66afab017340855b8d7dcc1af5cc80c620e8fb62c70054
 SHA512:
-  metadata.gz: 277754cc4da9b7bd70c173ad052c87658eda48c7a42ad28675e1b5ce3eafae09932bf3c2a1682715890bbb4039ce3484f0a1adc7f7223e6bd3702e3cfb9b0eab
-  data.tar.gz: 9cb4995ece3b2fe8ab5625646cb1118080d27f52ce63af8efe5fd5178a6f8e8e77e9196a7f851780057fb315368622961f70eb65f808c460d011d5d890ff69bd
+  metadata.gz: 361df59b13de017f9bc99c7d4ed9c2316c265f0f50514fef3623c33f05095dbdbd8eee4be208bb420a3857ca4070dbebd75e6b30c0fc9ae827b1a7563e288aca
+  data.tar.gz: ba1ca8e50d010dea86cd05d65969f1815d9056e845dd0f23a17a78df6e59d7692619ae4c6899fd356bf14a8d0a5ff9dbd9ffb8ab545bad3653a10e8de0662823

data/lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (5.2.2)
+# Pagy initializer file (5.4.0)
 # Customize only what you really need and notice that Pagy works also without any of the following lines.
 # Should you just cherry pick part of this file, please maintain the require-order of the extras
 
@@ -22,6 +22,7 @@
 # See https://ddnexus.github.io/pagy/api/pagy#other-variables
 # Pagy::DEFAULT[:size]       = [1,4,4,1]                       # default
 # Pagy::DEFAULT[:page_param] = :page                           # default
+# The :params can be also set as a lambda e.g ->(params){ params.exclude('useless').merge!('custom' => 'useful') }
 # Pagy::DEFAULT[:params]     = {}                              # default
 # Pagy::DEFAULT[:fragment]   = '#fragment'                     # example
 # Pagy::DEFAULT[:link_extra] = 'data-remote="true"'            # example
@@ -42,14 +43,12 @@
 # Calendar extra: Paginate a collection by calendar Time unit (year, month, week or day)
 # See https://ddnexus.github.io/pagy/extras/calendar
 # require 'pagy/extras/calendar'
-# Pagy::DEFAULT[:local_minmax] = []          # Min and max local Time period must be set by the user (better not not as default)
-# Pagy::DEFAULT[:unit]         = :month      # Time unit allowed %i[year month week day]
-# Pagy::DEFAULT[:week_offset]  = 0           # Day offset from Sunday (0: Sunday; 1: Monday;... 6: Saturday)
-# Pagy::DEFAULT[:order]         = :asc        # Time direction of pagination
-# Pagy::DEFAULT[:year_format]  = '%Y'        # strftime format for :year unit
-# Pagy::DEFAULT[:month_format] = '%Y-%m'     # strftime format for :month unit
-# Pagy::DEFAULT[:week_format]  = '%Y-%W'     # strftime format for :week unit
-# Pagy::DEFAULT[:day_format]   = '%Y-%m-%d'  # strftime format for :day unit
+# DEFAULT[:year_format]  = '%Y'        # strftime format for :year unit
+# DEFAULT[:month_format] = '%Y-%m'     # strftime format for :month unit
+# DEFAULT[:week_format]  = '%Y-%W'     # strftime format for :week unit
+# DEFAULT[:day_format]   = '%Y-%m-%d'  # strftime format for :day unit
+# DEFAULT[:week_offset]  = 0           # Day offset from Sunday (0: Sunday; 1: Monday;... 6: Saturday)
+# DEFAULT[:time_order]   = :asc        # Time direction of pagination
 
 # Countless extra: Paginate without any count, saving one query per rendering
 # See https://ddnexus.github.io/pagy/extras/countless

data/lib/javascripts/pagy.js

@@ -1,9 +1,11 @@
 // See the Pagy documentation: https://ddnexus.github.io/pagy/extras#javascript
 
+// This code should be OK also with very old browsers
+
 // Container of the whole pagy stuff
 function Pagy(){}
 
-Pagy.version = '5.2.2'
+Pagy.version = '5.4.0'
 
 // Used by the waitForMe function
 Pagy.delay = 100
@@ -23,10 +25,11 @@ Pagy.init =
 
 // Power the pagy*_nav_js helpers
 Pagy.nav =
-  function(pagyEl, tags, sequels, trimParam) {
-    var lastWidth,
-        pageREg = new RegExp(/__pagy_page__/g),
-        widths  = []
+  function(pagyEl, tags, sequels, label_sequels, trimParam ) {
+    label_sequels = (label_sequels === null) ? sequels : label_sequels
+    var widths = [], lastWidth,
+        fill   = function(string, item, label) { return string.replace(/__pagy_page__/g, item)
+                                                              .replace(/__pagy_label__/g, label) }
     for (var width in sequels) {
       if (sequels.hasOwnProperty(width)) { widths.push(parseInt(width, 10)) }
     }
@@ -40,13 +43,15 @@ Pagy.nav =
         }
         if (width !== lastWidth) {
           var html   = tags.before,
-              series = sequels[width]
+              series = sequels[width],
+              labels = label_sequels[width]
           for (i = 0, len = series.length; i < len; i++) {
-            var item = series[i]
-            if (typeof(trimParam) === 'string' && item === 1) { html += Pagy.trim(tags.link.replace(pageREg, item), trimParam) }
-            else if (typeof(item) === 'number') { html += tags.link.replace(pageREg, item) }
+            var item  = series[i],
+                label = labels[i]
+            if (typeof(trimParam) === 'string' && item === 1) { html += Pagy.trim(fill(tags.link, item, label), trimParam) }
+            else if (typeof(item) === 'number') { html += fill(tags.link, item, label) }
             else if (item === 'gap') { html += tags.gap }
-            else if (typeof(item) === 'string') { html += tags.active.replace(pageREg, item) }
+            else if (typeof(item) === 'string') { html += fill(tags.active, item, label) }
           }
           html += tags.after
           this.insertAdjacentHTML('afterbegin', html)

data/lib/pagy/calendar.rb

@@ -5,144 +5,183 @@ require 'pagy'
 require 'date'
 
 class Pagy # :nodoc:
-  DEFAULT[:local_minmax] = []          # Min and max Time period must be set by the user
-  DEFAULT[:unit]         = :month      # Time unit allowed %i[year month week day]
-  DEFAULT[:week_offset]  = 0           # Day offset from Sunday (0: Sunday; 1: Monday;... 6: Saturday)
-  DEFAULT[:order]        = :asc        # Time direction of pagination
   DEFAULT[:year_format]  = '%Y'        # strftime format for :year unit
   DEFAULT[:month_format] = '%Y-%m'     # strftime format for :month unit
   DEFAULT[:week_format]  = '%Y-%W'     # strftime format for :week unit
   DEFAULT[:day_format]   = '%Y-%m-%d'  # strftime format for :day unit
+  DEFAULT[:week_offset]  = 0           # Day offset from Sunday (0: Sunday; 1: Monday;... 6: Saturday)
+  DEFAULT[:time_order]   = :asc        # Time direction of pagination
 
-  # Paginate a Time period by units (year, month, week or day)
+  # Base class for time units subclasses (Year, Month, Week, Day)
   class Calendar < Pagy
-    attr_reader :utc_from, :utc_to, :unit, :week_offset, :order
-    attr_writer :count, :in
+    DAY  = 60 * 60 * 24
+    WEEK = DAY * 7
+
+    attr_reader :utc_from, :utc_to, :time_order
+
+    # Create a subclass instance
+    def self.create(unit, vars)
+      raise InternalError, "unit must be in #{UNITS.keys.inspect}; got #{unit}" unless UNITS.key?(unit)
+
+      UNITS[unit].new(vars)
+    end
 
     # Merge and validate the options, do some simple arithmetic and set a few instance variables
     def initialize(vars) # rubocop:disable Lint/MissingSuper
+      raise InternalError, 'Pagy::Calendar is a base class; use one of its subclasses.' if instance_of?(Pagy::Calendar)
+
       normalize_vars(vars)
-      setup_vars(page: 1, week_offset: 0)
+      setup_vars(page: 1)
       setup_unit_vars
+      setup_params_var
       raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
 
       @prev = (@page - 1 unless @page == 1)
       @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
     end
 
-    # Generate a label for each page, with the specific `Time` period it refers to
-    def page_label(num = @page, format = nil)
-      snap = snap(num.to_i)
-      format ||= @vars[:"#{@unit}_format"]
-      case @unit
-      when :year  then new_time(@initial.year + snap)
-      when :month then bump_month(@initial, snap)
-      when :week  then @initial + (snap * WEEK)
-      when :day   then @initial + (snap * DAY)
-      else raise InternalError, "expected @unit to be in [:year, :month, :week, :day]; got #{@unit.inspect}"
-      end.strftime(format)
+    # The label for the current page (it can pass along the I18n gem opts when it's used with the i18n extra)
+    def label(**opts)
+      label_for(@page, **opts)
     end
 
-    def current_page_label(format = nil)
-      page_label(@page, format)
+    # Return the minmax of the current page/unit (used by the extra for the next level minmax)
+    def current_unit_minmax
+      [@utc_from.getlocal(@utc_offset), @utc_to.getlocal(@utc_offset)]
     end
 
-    DAY  = 60 * 60 * 24
-    WEEK = DAY * 7
-
     protected
 
-    def setup_unit_vars
-      (units = %i[year month week day]).each do |unit|
-        raise VariableError.new(self, :format, 'to be a strftime format', @vars[:"#{unit}_format"]) \
-              unless @vars[:"#{unit}_format"].is_a?(String)
-      end
-      raise VariableError.new(self, :unit, "to be in #{units.inspect}", @unit) \
-            unless units.include?(@unit = @vars[:unit])
-      raise VariableError.new(self, :order, 'to be in [:asc, :desc]', @order) \
-            unless %i[asc desc].include?(@order = @vars[:order])
-
-      min, max = @vars[:local_minmax]
-      raise VariableError.new(self, :local_minmax, 'to be a an Array of min and max local Time instances', @vars[:local_minmax]) \
-            unless min.is_a?(Time) && max.is_a?(Time) && !min.utc? && !min.utc? && min <= max \
+    def setup_unit_vars(format)
+      raise VariableError.new(self, format, 'to be a strftime format', @vars[format]) unless @vars[format].is_a?(String)
+      raise VariableError.new(self, :time_order, 'to be in [:asc, :desc]', @time_order) \
+            unless %i[asc desc].include?(@time_order = @vars[:time_order])
+
+      min, max = @vars[:minmax]
+      raise VariableError.new(self, :minmax, 'to be a an Array of min and max local Time instances', @vars[:minmax]) \
+            unless min.is_a?(Time) && max.is_a?(Time) && !min.utc? && !max.utc? && min <= max \
                    && (@utc_offset = min.utc_offset) == max.utc_offset
 
-      send :"setup_#{@unit}_vars", min, max
+      [min, max]
     end
 
-    # IMPORTANT: all the Time objects created and passed as arguments MUST be local!
-
-    # @initial:  beginning of the first day of the period that encloses the min local time
-    # @final:    beginning of the first day of the NEXT period AFTER the period that encloses the max local time
-    # @utc_from: beginning of the first day of the period of the current page as UTC time
-    # @utc_to:   beginning of the first day of the NEXT period AFTER the current page as UTC time
-
-    # Setup the calendar vars when the unit is :year
-    def setup_year_vars(min, max)
-      @initial  = new_time(min.year)
-      @final    = new_time(max.year + 1)
-      @pages    = @last = @final.year - @initial.year
-      @utc_from = new_time(@initial.year + snap).utc
-      @utc_to   = new_time(@initial.year + snap + 1).utc
+    # Apply the strftime format to the time (overridden by the i18n extra when localization is required)
+    def localize(time, opts)
+      time.strftime(opts[:format])
     end
 
-    # Setup the calendar vars when the unit is :month
-    def setup_month_vars(min, max)
-      @initial  = new_time(min.year, min.month)
-      @final    = bump_month(max)
-      @pages    = @last = months(@final) - months(@initial)
-      @utc_from = bump_month(@initial, snap).utc
-      @utc_to   = bump_month(@initial, snap + 1).utc
+    # Simple trick to snap the page into its ordered position, without actually reordering anything in the internal structure
+    def snap(page = @page)
+      @time_order == :asc ? page - 1 : @pages - page
     end
 
-    # Setup the calendar vars when the unit is :week
-    def setup_week_vars(min, max)
-      @initial  = week_start(min)
-      @final    = week_start(max) + WEEK
-      @pages    = @last = (@final - @initial).to_i / WEEK
-      @utc_from = (@initial + (snap * WEEK)).utc
-      @utc_to   = @utc_from + WEEK
+    # Create a new local time at the beginning of the day
+    def new_time(year, month = 1, day = 1)
+      Time.new(year, month, day, 0, 0, 0, @utc_offset)
     end
 
-    # Setup the calendar vars when the unit is :day
-    def setup_day_vars(min, max)
-      @initial  = new_time(min.year, min.month, min.day)
-      @final    = new_time(max.year, max.month, max.day) + DAY
-      @pages    = @last = (@final - @initial).to_i / DAY
-      @utc_from = (@initial + (snap * DAY)).utc
-      @utc_to   = @utc_from + DAY
+    # Calendar year subclass
+    class Year < Calendar
+      # Setup the calendar vars when the unit is :year
+      def setup_unit_vars
+        min, max  = super(:year_format)
+        @initial  = new_time(min.year)
+        @final    = new_time(max.year + 1)
+        @pages    = @last = @final.year - @initial.year
+        @utc_from = new_time(@initial.year + snap).utc
+        @utc_to   = new_time(@initial.year + snap + 1).utc
+      end
+
+      # Generate a label for each page (it can pass along the I18n gem opts when it's used with the i18n extra)
+      def label_for(page, **opts)
+        opts[:format] ||= @vars[:year_format]
+        localize(new_time(@initial.year + snap(page.to_i)), **opts)
+      end
     end
 
-    private
+    # Calendar month subclass
+    class Month < Calendar
+      # Setup the calendar vars when the unit is :month
+      def setup_unit_vars
+        min, max  = super(:month_format)
+        @initial  = new_time(min.year, min.month)
+        @final    = bump_month(max)
+        @pages    = @last = months(@final) - months(@initial)
+        @utc_from = bump_month(@initial, snap).utc
+        @utc_to   = bump_month(@initial, snap + 1).utc
+      end
 
-    # Simple trick to snap the page into its ordered position,
-    # without actually reordering anything in the internal structure
-    def snap(page = @page)
-      @order == :asc ? page - 1 : @pages - page
-    end
+      # Generate a label for each page (it can pass along the I18n gem opts when it's used with the i18n extra)
+      def label_for(page, **opts)
+        opts[:format] ||= @vars[:month_format]
+        localize(bump_month(@initial, snap(page.to_i)), **opts)
+      end
 
-    # Create a new local time at the beginning of the day
-    def new_time(year, month = 1, day = 1)
-      Time.new(year, month, day, 0, 0, 0, @utc_offset)
-    end
+      private
+
+      # Months in local time
+      def months(time)
+        (time.year * 12) + time.month
+      end
 
-    # Months in local time
-    def months(time)
-      (time.year * 12) + time.month
+      # Add 1 or more months to local time
+      def bump_month(time, months = 1)
+        months += months(time)
+        year  = months / 12
+        month = months % 12
+        month.zero? ? new_time(year - 1, 12) : new_time(year, month)
+      end
     end
 
-    # Add 1 or more months to local time
-    def bump_month(time, months = 1)
-      months += months(time)
-      year  = months / 12
-      month = months % 12
-      month.zero? ? new_time(year - 1, 12) : new_time(year, month)
+    # Calendar week subclass
+    class Week < Calendar
+      attr_reader :week_offset
+
+      # Setup the calendar vars when the unit is :week
+      def setup_unit_vars
+        setup_vars(week_offset: 0)
+        min, max  = super(:week_format)
+        @initial  = week_start(min)
+        @final    = week_start(max) + WEEK
+        @pages    = @last = (@final - @initial).to_i / WEEK
+        @utc_from = (@initial + (snap * WEEK)).utc
+        @utc_to   = @utc_from + WEEK
+      end
+
+      # Generate a label for each page (it can pass along the I18n gem opts when it's used with the i18n extra)
+      def label_for(page, **opts)
+        opts[:format] ||= @vars[:week_format]
+        localize(@initial + (snap(page.to_i) * WEEK), **opts)
+      end
+
+      private
+
+      # Return the start of the week for local time
+      def week_start(time)
+        start = time - (((time.wday - @week_offset) * DAY) % WEEK)
+        new_time(start.year, start.month, start.day)
+      end
     end
 
-    # Return the start of the week for local time
-    def week_start(time)
-      start = time - (((time.wday - @week_offset) * DAY) % WEEK)
-      new_time(start.year, start.month, start.day)
+    # Calendar day subclass
+    class Day < Calendar
+      # Setup the calendar vars when the unit is :day
+      def setup_unit_vars
+        min, max  = super(:day_format)
+        @initial  = new_time(min.year, min.month, min.day)
+        @final    = new_time(max.year, max.month, max.day) + DAY
+        @pages    = @last = (@final - @initial).to_i / DAY
+        @utc_from = (@initial + (snap * DAY)).utc
+        @utc_to   = @utc_from + DAY
+      end
+
+      # Generate a label for each page (it can pass along the I18n gem opts when it's used with the i18n extra)
+      def label_for(page, **opts)
+        opts[:format] ||= @vars[:day_format]
+        localize(@initial + (snap(page.to_i) * DAY), **opts)
+      end
     end
+    # After all the subclasses are defined
+    UNITS = { year: Year, month: Month, week: Week, day: Day }.freeze
   end
 end

data/lib/pagy/countless.rb

@@ -11,6 +11,7 @@ class Pagy
       normalize_vars(vars)
       setup_vars(page: 1, outset: 0)
       setup_items_var
+      setup_params_var
       @offset = (@items * (@page - 1)) + @outset
     end
 
@@ -29,7 +30,7 @@ class Pagy
 
     # Override the original series.
     # Return nil if :countless_minimal is enabled
-    def series(_size = @vars[:size])
+    def series(*)
       super unless @vars[:countless_minimal]
     end
   end

data/lib/pagy/extras/bootstrap.rb

@@ -1,20 +1,20 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/extras/bootstrap
 # frozen_string_literal: true
 
-require 'pagy/extras/shared'
+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 << 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
                   %(<li class="page-item">#{link.call item}</li>)
@@ -30,17 +30,17 @@ class Pagy # :nodoc:
     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, pagy_id: nil, link_extra: '', steps: nil)
+    def pagy_bootstrap_nav_js(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}))
       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>)
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(**vars)), 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

data/lib/pagy/extras/bulma.rb

@@ -1,26 +1,26 @@
 # 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 # :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: '')
+    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
-                  %(<li>#{link.call item, item, %(class="pagination-link" aria-label="goto page #{item}")}</li>)
+                  %(<li>#{link.call item, pagy.label_for(item), %(class="pagination-link" aria-label="goto page #{item}")}</li>)
                 when String
-                  %(<li>#{link.call item, item,
+                  %(<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>)
@@ -30,21 +30,20 @@ class Pagy # :nodoc:
       html << %(</ul></nav>)
     end
 
-    def pagy_bulma_nav_js(pagy, pagy_id: nil, link_extra: '', steps: nil)
+    def pagy_bulma_nav_js(pagy, pagy_id: nil, link_extra: '', **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,
+               'link'   => %(<li>#{link.call PAGE_PLACEHOLDER, LABEL_PLACEHOLDER,
                                              %(class="pagination-link" aria-label="goto page #{PAGE_PLACEHOLDER}")}</li>),
-               'active' => %(<li>#{link.call PAGE_PLACEHOLDER, PAGE_PLACEHOLDER,
+               '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-njs pagy-bulma-nav-js pagination is-centered" aria-label="pagination" #{
+        pagy_json_attr(pagy, :nav, tags, (sequels = pagy.sequels(**vars)), 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

data/lib/pagy/extras/calendar.rb

@@ -4,43 +4,74 @@
 require 'pagy/calendar'
 
 class Pagy # :nodoc:
-  # Paginate based on calendar periods (year month week day)
+  # Paginate based on calendar periods (year month week day) plus the regular pagination
   module CalendarExtra
     # Additions for the Backend module
     module Backend
+      CONF_KEYS = %i[year month week day pagy skip].freeze
+
       private
 
-      # Return Pagy object and items
-      def pagy_calendar(collection, vars = {})
-        pagy = Calendar.new(pagy_calendar_get_vars(collection, vars))
-        [pagy, pagy_calendar_get_items(collection, pagy)]
+      # Take a collection and a conf Hash with keys in [:year, :month: week, :day, :pagy]  and Hash values of pagy variables
+      # Return a hash with 3 items:
+      # 0. Array of pagy calendar unit objects
+      # 1. Pagy object
+      # 2. Array of 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 == :skip }
+          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
+        calendar, collection = pagy_setup_calendar(collection, conf) unless conf[:skip]
+        pagy, result         = send(conf[:pagy][:backend] || :pagy, collection, conf[:pagy])  # use backend: :pagy when omitted
+        [calendar, pagy, result]
       end
 
-      # Sub-method called only by #pagy_calendar: here for easy customization of variables by overriding.
-      # You may want to override it in order to implement the dynamic set of the :minmax variable.
-      def pagy_calendar_get_vars(_collection, vars)
-        # vars[:minmax] ||= your_own_method_to_get_the_period_from(collection)
-        vars[:page] ||= params[vars[:page_param] || DEFAULT[:page_param]]
-        vars
+      # Setup the calendar objects and return them with the filtered collection
+      def pagy_setup_calendar(collection, conf)
+        units = Calendar::UNITS.keys & conf.keys
+        page_param = conf[:pagy][:page_param] || DEFAULT[:page_param]
+        units.each do |unit|  # set all the :page_param vars for later deletion
+          unit_page_param = :"#{unit}_#{page_param}"
+          conf[unit][:page_param] = unit_page_param
+          conf[unit][:page]       = params[unit_page_param]
+        end
+        calendar      = {}
+        last_calendar = nil
+        last_minmax   = minmax = pagy_calendar_minmax(collection)
+        units.each_with_index do |unit, index|
+          params_to_delete    = units[(index + 1), units.size].map { |sub| conf[sub][:page_param] } + [page_param]
+          conf[unit][:params] = lambda do |params|  # delete page_param from the sub-units
+                                  params_to_delete.each { |p| params.delete(p.to_s) } # except implemented after 2.5
+                                  params
+                                end
+          conf[unit][:minmax] = [[minmax.first, last_minmax.first].max, [minmax.last, last_minmax.last].min]
+          calendar[unit]      = last_calendar = Calendar.create(unit, conf[unit])
+          last_minmax         = calendar[unit].current_unit_minmax # set the minmax for the next unit
+        end
+        filtered = pagy_calendar_filtered(collection, last_calendar.utc_from, last_calendar.utc_to)
+        [calendar, filtered]
       end
 
-      # This method should be implemented in the application and should return the records
-      # for the unit by selecting the records with DateTime from pagy.from to pagy.to
-      def pagy_calendar_get_items(_collection, _pagy)
-        # collection.your_own_method_to_get_the_items_with(pagy.from, pagy.to)
-        raise NoMethodError, 'The pagy_calendar_get_items method must be implemented in the application and must return ' \
-                             'the items for the unit by selecting the records with Time from pagy.from to pagy.to'
+      # This method must be implemented by the application.
+      # It must return an Array with the minimum and maximum Time objects from the collection,
+      # converted to the local time of the user
+      def pagy_calendar_minmax(*)
+        # collection.your_own_method_to_get_the_minmax
+        raise NoMethodError, 'the pagy_calendar_minmax method must be implemented by the application and must return ' \
+                             'an Array with the minimum and maximum local Time objects of the collection'
       end
-    end
 
-    # Additions for the Frontend module
-    module Frontend
-      # Change the text shown in the nav bar links to the actual unit of each page.
-      def pagy_labeler(pagy, num)
-        pagy.is_a?(Calendar) ? pagy.page_label(num) : num
+      # This method must be implemented by the application.
+      # It receives the main collection argument and must return a filtered version of it.
+      # The filter logic must be equivalent to {utc_time >= pagy.utc_from && utc_time < pagy.utc_to}
+      def pagy_calendar_filtered(*)
+        # collection.your_own_method_to_filter_with(pagy.utc_from, pagy.utc_to)
+        raise NoMethodError, 'the pagy_calendar_filtered method must be implemented by the application and must return the ' \
+                             'collection filtered by a logic equivalent to {utc_time >= pagy.utc_from && utc_time < pagy.utc_to}'
       end
     end
   end
   Backend.prepend CalendarExtra::Backend
-  Frontend.prepend CalendarExtra::Frontend
 end