pagy 5.4.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32d028f5c02fafb87cc0bb10f1b28ebf1f49b89babf4cfcf2099367b69cf88af
-  data.tar.gz: c5cf934095bfaed81c66afab017340855b8d7dcc1af5cc80c620e8fb62c70054
+  metadata.gz: a5d3090b61a9b11c0763a7c2d103ee36f4a36f0618e7e99b32357bab408a29bc
+  data.tar.gz: d5c3c376deda1c84558bbcff43809c9235cb2fc9ced7492ecdfe8df6397c873e
 SHA512:
-  metadata.gz: 361df59b13de017f9bc99c7d4ed9c2316c265f0f50514fef3623c33f05095dbdbd8eee4be208bb420a3857ca4070dbebd75e6b30c0fc9ae827b1a7563e288aca
-  data.tar.gz: ba1ca8e50d010dea86cd05d65969f1815d9056e845dd0f23a17a78df6e59d7692619ae4c6899fd356bf14a8d0a5ff9dbd9ffb8ab545bad3653a10e8de0662823
+  metadata.gz: 6591de1571e9b6bdf1a26668cf730dcbba4c83ef9f2d3727b3a1bec5f98c49a69ae2d55aab363444d85a3310e3de65fe119fb3606ca63cfdf56202c14c591568
+  data.tar.gz: 02fea4991aab7911107460e58e73a66f507f9fff990261f1536fddf016b9523003165ed0dfd024013282ef43fec221cb7fcfa27b7f6b23c60a742f175adc0eae

data/lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (5.4.0)
+# Pagy initializer file (5.6.1)
 # 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
 
@@ -40,15 +40,33 @@
 # See https://ddnexus.github.io/pagy/extras/array
 # require 'pagy/extras/array'
 
-# Calendar extra: Paginate a collection by calendar Time unit (year, month, week or day)
+# Calendar extra: Add pagination filtering by calendar time unit (year, quartr, month, week, day)
 # See https://ddnexus.github.io/pagy/extras/calendar
 # require 'pagy/extras/calendar'
-# 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
+# Default for each unit
+# Pagy::Calendar::Year::DEFAULT[:order]     = :asc        # Time direction of pagination
+# Pagy::Calendar::Year::DEFAULT[:format]    = '%Y'        # strftime format
+#
+# Pagy::Calendar::Quarter::DEFAULT[:order]  = :asc        # Time direction of pagination
+# Pagy::Calendar::Quarter::DEFAULT[:format] = '%Y-Q%q'    # strftime format
+#
+# Pagy::Calendar::Month::DEFAULT[:order]    = :asc        # Time direction of pagination
+# Pagy::Calendar::Month::DEFAULT[:format]   = '%Y-%m'     # strftime format
+#
+# Pagy::Calendar::Week::DEFAULT[:order]     = :asc        # Time direction of pagination
+# Pagy::Calendar::Week::DEFAULT[:format]    = '%Y-%W'     # strftime format
+# Pagy::Calendar::Week::DEFAULT[:offset]    = 0           # Day offset from Sunday (0: Sunday; 1: Monday;... 6: Saturday)
+#
+# Pagy::Calendar::Day::DEFAULT[:order]      = :asc        # Time direction of pagination
+# Pagy::Calendar::Day::DEFAULT[:format]     = '%Y-%m-%d'  # strftime format
+#
+# Uncomment the following block, if you need calendar localization without using the I18n extra
+# module LocalizePagyCalendar
+#   def localize(time, opts)
+#     ::I18n.l(time, **opts)
+#   end
+# end
+# Pagy::Calendar.prepend LocalizePagyCalendar
 
 # Countless extra: Paginate without any count, saving one query per rendering
 # See https://ddnexus.github.io/pagy/extras/countless
@@ -217,6 +235,5 @@
 # Pagy::DEFAULT[:i18n_key] = 'pagy.item_name'   # default
 
 
-# When you are done setting your own defaults freeze it,
-# so it will not changed accidentally
+# When you are done setting your own default freeze it, so it will not get changed accidentally
 Pagy::DEFAULT.freeze

data/lib/javascripts/pagy.js

@@ -5,7 +5,7 @@
 // Container of the whole pagy stuff
 function Pagy(){}
 
-Pagy.version = '5.4.0'
+Pagy.version = '5.6.1'
 
 // Used by the waitForMe function
 Pagy.delay = 100

data/lib/pagy/calendar/day.rb

@@ -0,0 +1,29 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar day subclass
+    class Day < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-%m-%d' }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = new_time(@starting.year, @starting.month, @starting.day)
+        @final   = new_time(@ending.year, @ending.month, @ending.day) + DAY
+        @pages   = @last = (@final - @initial).to_i / DAY
+        @from    = start_for(@page)
+        @to      = @from + DAY
+      end
+
+      # Time for the page
+      def start_for(page)
+        @initial + (snap(page) * DAY)
+      end
+    end
+  end
+end

data/lib/pagy/calendar/month.rb

@@ -0,0 +1,16 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+require_relative 'month_mixin'
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar month subclass
+    class Month < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-%m' }
+      MONTHS  = 1  # number of months in the unit
+      include MonthMixin
+    end
+  end
+end

data/lib/pagy/calendar/month_mixin.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Pagy
+  class Calendar
+    # Mixin for month based unit periods
+    # It is used for month and quarter, but you could use it to implement less common unit of 6, 4, 2 months
+    # (see the https://ddnexus.github.io/pagy/api/calendar#custom-units sections for details).
+    # The class that includes it needs to set the MONTH duration for the unit and the usual DEFAULT.
+    module MonthMixin
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @months  = self.class::MONTHS  # number of months in the unit
+        @initial = new_time(@starting.year, beginning_month(@starting.month))
+        @final   = add_to(new_time(@ending.year, beginning_month(@ending.month)), @months)
+        @pages   = @last = (months_in(@final) - months_in(@initial)) / @months
+        @from    = start_for(@page)
+        @to      = add_to(@from, @months)
+      end
+
+      # Time for the page
+      def start_for(page)
+        add_to(@initial, snap(page) * @months)
+      end
+
+      # Return the beginning month for the unit (e.g. quarter) that includes the month argument
+      def beginning_month(month)
+        (@months * ((month - 1) / @months)) + 1
+      end
+
+      private
+
+      # Months in time
+      def months_in(time)
+        (time.year * 12) + time.month
+      end
+
+      # Add months to time
+      def add_to(time, months)
+        months += months_in(time)
+        year  = months / 12
+        month = months % 12
+        month.zero? ? new_time(year - 1, 12) : new_time(year, month)
+      end
+    end
+  end
+end

data/lib/pagy/calendar/quarter.rb

@@ -0,0 +1,23 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+require_relative 'month_mixin'
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar quarter subclass
+    class Quarter < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-Q%q' } # '%q' token
+      MONTHS  = 3  # number of months of the unit
+      include MonthMixin
+
+      # The label for any page, with the substitution of the '%q' token
+      def label_for(page, opts = {})
+        start_time    = start_for(page.to_i)
+        opts[:format] = (opts[:format] || @vars[:format]).gsub('%q') { (start_time.month / 4) + 1 }
+        localize(start_time, opts)
+      end
+    end
+  end
+end

data/lib/pagy/calendar/week.rb

@@ -0,0 +1,39 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar week subclass
+    class Week < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-%W',
+                  offset: 0 }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        setup_vars(offset: 0)
+        super
+        @initial = week_start(@starting)
+        @final   = week_start(@ending) + WEEK
+        @pages   = @last = (@final - @initial).to_i / WEEK
+        @from    = start_for(@page)
+        @to      = @from + WEEK
+      end
+
+      # Time for the page
+      def start_for(page)
+        @initial + (snap(page) * WEEK)
+      end
+
+      private
+
+      # Return the start of the week for time
+      def week_start(time)
+        start = time - (((time.wday - @offset) * DAY) % WEEK)
+        new_time(start.year, start.month, start.day)
+      end
+    end
+  end
+end

data/lib/pagy/calendar/year.rb

@@ -0,0 +1,29 @@
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  class Calendar # :nodoc:
+    # Calendar year subclass
+    class Year < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y' }
+
+      protected
+
+      # Setup the calendar variables
+      def setup_unit_vars
+        super
+        @initial = new_time(@starting.year)
+        @final   = new_time(@ending.year + 1)
+        @pages   = @last = @final.year - @initial.year
+        @from    = start_for(@page)
+        @to      = new_time(@from.year + 1)
+      end
+
+      # Time for the page
+      def start_for(page)
+        new_time(@initial.year + snap(page))
+      end
+    end
+  end
+end

data/lib/pagy/calendar.rb

@@ -2,35 +2,23 @@
 # frozen_string_literal: true
 
 require 'pagy'
-require 'date'
 
 class Pagy # :nodoc:
-  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
-
-  # Base class for time units subclasses (Year, Month, Week, Day)
+  # Base class for time units subclasses (Year, Quarter, Month, Week, Day)
   class Calendar < Pagy
-    DAY  = 60 * 60 * 24
-    WEEK = DAY * 7
+    # List of units in desc order of duration. It can be used for custom units.
+    UNITS = %i[year quarter month week day]  # rubocop:disable Style/MutableConstant
+    DAY   = 60 * 60 * 24  # One day in seconds
+    WEEK  = DAY * 7       # One week in seconds
 
-    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
+    attr_reader :order
 
     # 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)
+      raise InternalError, 'Pagy::Calendar is a base class; use one of its subclasses' if instance_of?(Pagy::Calendar)
 
-      normalize_vars(vars)
+      vars = self.class::DEFAULT.merge(vars)  # subclass specific default
+      normalize_vars(vars)                    # general default
       setup_vars(page: 1)
       setup_unit_vars
       setup_params_var
@@ -41,28 +29,33 @@ class Pagy # :nodoc:
     end
 
     # 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)
+    def label(opts = {})
+      label_for(@page, opts)
     end
 
-    # 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)]
+    # The label for any 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[:format]
+      localize(start_for(page.to_i), opts)
     end
 
-    protected
+    # Period of the active page (used for nested units)
+    def active_period
+      [[@starting, @from].max, [@to - 1, @ending].min] # -1 sec: include only last unit day
+    end
 
-    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])
+    protected
 
-      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
+    # Base class method for the setup of the unit variables
+    def setup_unit_vars
+      raise VariableError.new(self, :format, 'to be a strftime format', @vars[:format]) unless @vars[:format].is_a?(String)
+      raise VariableError.new(self, :order, 'to be in [:asc, :desc]', @order) \
+            unless %i[asc desc].include?(@order = @vars[:order])
 
-      [min, max]
+      @starting, @ending = @vars[:period]
+      raise VariableError.new(self, :period, 'to be a an Array of min and max local Time instances', @vars[:period]) \
+            unless @starting.is_a?(Time) && @ending.is_a?(Time) && !@starting.utc? && !@ending.utc? && @starting <= @ending \
+                   && (@utc_offset = @starting.utc_offset) == @ending.utc_offset
     end
 
     # Apply the strftime format to the time (overridden by the i18n extra when localization is required)
@@ -70,9 +63,9 @@ class Pagy # :nodoc:
       time.strftime(opts[:format])
     end
 
-    # 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
+    # Simple trick to snap the page to its ordered start, without actually reordering anything in the internal structure
+    def snap(page)
+      @order == :asc ? page - 1 : @pages - page
     end
 
     # Create a new local time at the beginning of the day
@@ -80,108 +73,17 @@ class Pagy # :nodoc:
       Time.new(year, month, day, 0, 0, 0, @utc_offset)
     end
 
-    # 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
+    class << self
+      # Create a subclass instance by unit name (internal use)
+      def create(unit, vars)
+        raise InternalError, "unit must be in #{UNITS.inspect}; got #{unit}" unless UNITS.include?(unit)
 
-      # 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)
+        name    = unit.to_s
+        name[0] = name[0].capitalize
+        Object.const_get("Pagy::Calendar::#{name}").new(vars)
       end
     end
-
-    # 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
-
-      # 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
-
-      private
-
-      # Months in local time
-      def months(time)
-        (time.year * 12) + time.month
-      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)
-      end
-    end
-
-    # 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
-
-    # 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
+
+  Calendar::UNITS.each { |unit| require "pagy/calendar/#{unit}" }
 end

data/lib/pagy/extras/calendar.rb

@@ -8,68 +8,67 @@ class Pagy # :nodoc:
   module CalendarExtra
     # Additions for the Backend module
     module Backend
-      CONF_KEYS = %i[year month week day pagy skip].freeze
+      CONF_KEYS = (Calendar::UNITS + %i[pagy active]).freeze
 
       private
 
-      # Take a collection and a conf Hash with keys in [:year, :month: week, :day, :pagy]  and Hash values of pagy variables
+      # Take a collection and a conf Hash with keys in [:year, :quarter, :month: week, :day, :pagy: :active];
+      # The calendar is active by default, but it can be explicitly inactivated with `active: false`
       # 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 }
+        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
-        calendar, collection = pagy_setup_calendar(collection, conf) unless conf[:skip]
+        calendar, collection = pagy_setup_calendar(collection, conf) unless conf.key?(:active) && !conf[:active]
         pagy, result         = send(conf[:pagy][:backend] || :pagy, collection, conf[:pagy])  # use backend: :pagy when omitted
         [calendar, pagy, result]
       end
 
-      # Setup the calendar objects and return them with the filtered collection
+      # Setup and return the calendar objects and the filtered collection
       def pagy_setup_calendar(collection, conf)
-        units = Calendar::UNITS.keys & conf.keys
+        units      = Calendar::UNITS & conf.keys # get the units in time length desc order
         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)
+        calendar = {}
+        period   = pagy_calendar_period(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_to_delete.each { |p| params.delete(p.to_s) } # Hash#except missing from 2.5 baseline
                                   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
+          conf[unit][:period] = period
+          calendar[unit]      = Calendar.send(:create, unit, conf[unit])
+          period              = calendar[unit].active_period # set the period for the next unit
         end
-        filtered = pagy_calendar_filtered(collection, last_calendar.utc_from, last_calendar.utc_to)
-        [calendar, filtered]
+        [calendar, pagy_calendar_filter(collection, calendar[units.last].from, calendar[units.last].to)]
       end
 
       # 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'
+      # It must return the the starting and ending local Time objects defining the calendar :period
+      def pagy_calendar_period(*)
+        # return_period_array_using(collection)
+        raise NoMethodError, 'the pagy_calendar_period method must be implemented by the application and must return ' \
+                             'the starting and ending local Time objects array defining the calendar :period'
       end
 
       # 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}'
+      # It receives the main collection and must return a filtered version of it.
+      # The filter logic must be equivalent to {storage_time >= from && storage_time < to}
+      def pagy_calendar_filter(*)
+        # return_filtered_collection_using(collection, from, to)
+        raise NoMethodError, 'the pagy_calendar_filter method must be implemented by the application and must return the ' \
+                             'collection filtered by a logic equivalent to '\
+                             '{storage_time >= from && storage_time < to}'
       end
     end
   end

data/lib/pagy/extras/overflow.rb

@@ -15,25 +15,25 @@ class Pagy # :nodoc:
 
       # Add rescue clause for different behaviors
       def initialize(vars)
-        @overflow ||= false                                 # still true if :last_page re-run the method after an overflow
+        @overflow ||= false                            # still true if :last_page re-run the method after an overflow
         super
       rescue OverflowError
-        @overflow = true                                    # add the overflow flag
+        @overflow = true                               # add the overflow flag
         case @vars[:overflow]
         when :exception
-          raise                                             # same as without the extra
+          raise                                        # same as without the extra
         when :last_page
-          requested_page = @vars[:page]                     # save the requested page (even after re-run)
-          initialize vars.merge!(page: @last)               # re-run with the last page
-          @vars[:page] = requested_page                     # restore the requested page
+          requested_page = @vars[:page]                # save the requested page (even after re-run)
+          initialize vars.merge!(page: @last)          # re-run with the last page
+          @vars[:page] = requested_page                # restore the requested page
         when :empty_page
-          @offset = @items = @from = @to = 0                # vars relative to the actual page
-          if defined?(Calendar) && is_a?(Calendar)          # only for Calendar instances
-            edge = @time_order == :asc ? @final : @initial  # get the edge of the overflow side (neat, but any time would do)
-            @utc_from = @utc_to = edge.getutc               # set both to the edge utc time (a >=&&< query will get no records)
+          @offset = @items = @from = @to = 0           # vars relative to the actual page
+          if defined?(Calendar) && is_a?(Calendar)     # only for Calendar instances
+            edge = @order == :asc ? @final : @initial  # get the edge of the overflow side (neat, but any time would do)
+            @from = @to = edge                         # set both to the edge utc time (a >=&&< query will get no records)
           end
-          @prev = @last                                     # prev relative to the actual page
-          extend Series                                     # special series for :empty_page
+          @prev = @last                                # prev relative to the actual page
+          extend Series                                # special series for :empty_page
         else
           raise VariableError.new(self, :overflow, 'to be in [:last_page, :empty_page, :exception]', @vars[:overflow])
         end
@@ -43,7 +43,7 @@ class Pagy # :nodoc:
       module Series
         def series(*)
           @page = @last                                # series for last page
-          super.tap do |s|                       # call original series
+          super.tap do |s|                             # call original series
             s[s.index(@page.to_s)] = @page             # string to integer (i.e. no current page)
             @page = @vars[:page]                       # restore the actual page
           end
@@ -63,7 +63,7 @@ class Pagy # :nodoc:
         when :exception
           raise                                        # same as without the extra
         when :empty_page
-          @offset = @items = @from = @to = 0            # vars relative to the actual page
+          @offset = @items = @from = @to = 0           # vars relative to the actual page
           @vars[:size] = []                            # no page in the series
           self
         else

data/lib/pagy.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 # Core class
 class Pagy
-  VERSION = '5.4.0'
+  VERSION = '5.6.1'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root

data/lib/templates/bootstrap_nav.html.erb

@@ -5,7 +5,7 @@
   The link variable is set to a proc that returns the link tag.
   Usage: link.call( page_number [, text [, extra_attributes_string ]])
 -%>
-<% link = pagy_link_proc(pagy, 'class="page-link"') -%>
+<% link = pagy_link_proc(pagy, link_extra: 'class="page-link"') -%>
 <%#                            -%><nav aria-label="pager"  class="pagy-bootstrap-nav" role="navigation">
 <%#                            -%>  <ul class="pagination">
 <% if pagy.prev                -%>    <li class="page-item prev"><%== link.call(pagy.prev, pagy_t('pagy.nav.prev'), 'aria-label="previous"') %></li>

data/lib/templates/bootstrap_nav.html.haml

@@ -4,7 +4,7 @@
 -# The link variable is set to a proc that returns the link tag.
 -# Usage: link.call( page_number [, text [, extra_attributes_string ]])
 
-- link = pagy_link_proc(pagy, 'class="page-link"')
+- link = pagy_link_proc(pagy, link_extra: 'class="page-link"')
 
 %nav.pagy-bootstrap-nav{"aria-label" => "pager", :role => "navigation"}
 

data/lib/templates/bootstrap_nav.html.slim

@@ -4,7 +4,7 @@
 / The link variable is set to a proc that returns the link tag.
 / Usage: link.call( page_number [, text [, extra_attributes_string ]])
 
-- link = pagy_link_proc(pagy, 'class="page-link"')
+- link = pagy_link_proc(pagy, link_extra: 'class="page-link"')
 
 nav.pagy-bootstrap-nav role="navigation" aria-label="pager"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-28 00:00:00.000000000 Z
 dependencies: []
 description: Agnostic pagination in plain ruby. It does it all. Better.
 email:
@@ -54,6 +54,12 @@ files:
 - lib/pagy.rb
 - lib/pagy/backend.rb
 - lib/pagy/calendar.rb
+- lib/pagy/calendar/day.rb
+- lib/pagy/calendar/month.rb
+- lib/pagy/calendar/month_mixin.rb
+- lib/pagy/calendar/quarter.rb
+- lib/pagy/calendar/week.rb
+- lib/pagy/calendar/year.rb
 - lib/pagy/console.rb
 - lib/pagy/countless.rb
 - lib/pagy/exceptions.rb