pagy 5.5.1 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e23922e820d30e39dee31d0b1931e79da25f9fd6fa4ee4c5f75a25f383ca99bc
-  data.tar.gz: 863360e18514c2250c2746d7fdfac4b11e65e0b04488150bee078466877a8b33
+  metadata.gz: 4a62cb4c6decfdc1013da6d14b38220aa361246637301a8d92b2d781440397bc
+  data.tar.gz: 2555195198def80d6ec002928da8cef07419a76da9a196d8971d50e7fb5095e2
 SHA512:
-  metadata.gz: 27819f1864544b94b0c916cca3d4d43a7bfd051c41a7a202b30818e9b5730fd754c2034247c912d48bb046d90ce46f95f4a18a636b2b75e8ed6b06203f1ddc81
-  data.tar.gz: '031559fa58448415d4555613c76cb16f3e5f1b1262400d6ea928c0817dd45a6902a28014052860aa1ac74f6da59d2313d142226635fd6d351578f12477e34439'
+  metadata.gz: f665f63cb281c25d6fcf430c12888def46ea46911e45a566fd52cb4943763efe775b094015d3b658b8322ade23a9a43a5888c60f10471bd567f000d5a67352c7
+  data.tar.gz: 8c22ab2ad5efc0bd91b648d89217d1b71d77fbf669e1153b015954b79c2506c8f5ffe29d80e7d5988bea76b4bed35e7a76bb9c3657f60de0db3cde84b38e62e2

data/lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (5.5.1)
+# Pagy initializer file (5.6.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
 

data/lib/javascripts/pagy.js

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

data/lib/pagy/calendar/month.rb

@@ -1,44 +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' }
-
-      protected
-
-      # Setup the calendar variables
-      def setup_unit_vars
-        super
-        @initial = new_time(@starting.year, @starting.month)
-        @final   = bump_month(@ending)
-        @pages   = @last = months(@final) - months(@initial)
-        @from    = start_for(@page)
-        @to      = bump_month(@from)
-      end
-
-      # Time for the page
-      def start_for(page)
-        bump_month(@initial, snap(page))
-      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
+      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,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 quarter subclass
+    class Quarter < Calendar
+      DEFAULT = { order:  :asc,      # rubocop:disable Style/MutableConstant
+                  format: '%Y-Q%q' }
+      MONTHS  = 3  # number of months of the unit
+      include MonthMixin
+    end
+  end
+end

data/lib/pagy/calendar/week.rb

@@ -29,7 +29,7 @@ class Pagy # :nodoc:
 
       private
 
-      # Return the start of the week for local time
+      # 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)

data/lib/pagy/calendar.rb

@@ -4,10 +4,12 @@
 require 'pagy'
 
 class Pagy # :nodoc:
-  # 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 :order
 
@@ -15,8 +17,8 @@ class Pagy # :nodoc:
     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)
-      @vars = self.class::DEFAULT.merge(@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
@@ -34,12 +36,14 @@ class Pagy # :nodoc:
     # 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)
+      start = start_for(page.to_i)
+      opts[:format] = opts[:format].gsub('%q') { (start.month / 4) + 1 }
+      localize(start, **opts)
     end
 
     # Period of the active page (used for nested units)
     def active_period
-      [[@starting, @from].max, [@to - DAY, @ending].min] # include only last unit day
+      [[@starting, @from].max, [@to - 1, @ending].min] # -1 sec: include only last unit day
     end
 
     protected
@@ -61,7 +65,7 @@ class Pagy # :nodoc:
       time.strftime(opts[:format])
     end
 
-    # Simple trick to snap the page to its ordered start, without actually reordering anything in the internal structure.
+    # 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
@@ -70,20 +74,18 @@ class Pagy # :nodoc:
     def new_time(year, month = 1, day = 1)
       Time.new(year, month, day, 0, 0, 0, @utc_offset)
     end
-  end
-  require 'pagy/calendar/year'
-  require 'pagy/calendar/month'
-  require 'pagy/calendar/week'
-  require 'pagy/calendar/day'
-
-  class Calendar # :nodoc:
-    UNITS = { year: Year, month: Month, week: Week, day: Day }.freeze
 
-    # Create a subclass instance by unit name (internal use)
-    def self.create(unit, vars)
-      raise InternalError, "unit must be in #{UNITS.keys.inspect}; got #{unit}" unless UNITS.key?(unit)
+    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)
 
-      UNITS[unit].new(vars)
+        name    = unit.to_s
+        name[0] = name[0].capitalize
+        Object.const_get("Pagy::Calendar::#{name}").new(vars)
+      end
     end
   end
+
+  Calendar::UNITS.each { |unit| require "pagy/calendar/#{unit}" }
 end

data/lib/pagy/extras/calendar.rb

@@ -8,11 +8,11 @@ class Pagy # :nodoc:
   module CalendarExtra
     # Additions for the Backend module
     module Backend
-      CONF_KEYS = %i[year month week day pagy active].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: :active];
+      # 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
@@ -31,7 +31,7 @@ class Pagy # :nodoc:
 
       # 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}"
@@ -47,7 +47,7 @@ class Pagy # :nodoc:
                                   params
                                 end
           conf[unit][:period] = period
-          calendar[unit]      = Calendar.create(unit, conf[unit])
+          calendar[unit]      = Calendar.send(:create, unit, conf[unit])
           period              = calendar[unit].active_period # set the period for the next unit
         end
         [calendar, pagy_calendar_filter(collection, calendar[units.last].from, calendar[units.last].to)]

data/lib/pagy.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 5.5.1
+  version: 5.6.0
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies: []
 description: Agnostic pagination in plain ruby. It does it all. Better.
 email:
@@ -56,6 +56,8 @@ files:
 - 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