pagy 6.0.0 → 7.0.0

data/lib/locales/sv.yml

@@ -1,23 +1,21 @@
-# :one_two_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 sv:
   pagy:
-
+    aria_label:
+      nav:
+        one: "Sida"
+        other: "Sidor"
+      prev: "Föregående"
+      next: "Nästa"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name:
       one: "resultat"
-      two: "resultat"
       other: "resultat"
-
-    nav:
-      prev: "‹ Föregående"
-      next: "Nästa ›"
-      gap: "…"
-
     info:
       no_items: "Inga %{item_name} hittade"
       single_page: "Visar <b>%{count}</b> %{item_name}"
       multiple_pages: "Visar %{item_name} <b>%{from}-%{to}</b> av <b>%{count}</b> totalt"
-
     combo_nav_js: "<label>Sida %{page_input} av %{pages}</label>"
-
     items_selector_js: "<label>Visa %{items_input} %{item_name} per sida</label>"

data/lib/locales/sw.yml

@@ -1,22 +1,23 @@
-# :one_other pluralization
-
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 sw:
   pagy:
-
+    # please add a comment in the https://github.com/ddnexus/pagy/issues/603
+    # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
+    aria_label:
+      nav: "Pages"
+#        one: ""
+#        other: ""
+      prev: "Awali"
+      next: "Ifuatayo"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name:
       one: "kifaa"
       other: "vifaa"
-
-    nav:
-      prev: "‹ Awali"
-      next: "Ifuatayo ›"
-      gap: "…"
-
     info:
       no_items: "Hamna %{item_name} vilivyopatikana"
       single_page: "Inaonyesha %{item_name} <b>%{count}</b>"
       multiple_pages: "Inaonyesha %{item_name} <b>%{from}-%{to}</b> ya <b>%{count}</b> kwa jumla"
-
     combo_nav_js: "<label>Kurasa %{page_input} ya %{pages}</label>"
-
     items_selector_js: "<label>Onyesha %{items_input} %{item_name} kwa kila ukurasa</label>"

data/lib/locales/ta.yml

@@ -1,22 +1,23 @@
-# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :one_other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 ta:
   pagy:
-
+    aria_label:
+      # please add a comment in the https://github.com/ddnexus/pagy/issues/604
+      # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
+      nav: "Pages"
+#        one: ""
+#        other: ""
+      prev: "முந்தையது"
+      next: "அடுத்தது"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name:
       one: "பதிவு"
       other: "பதிவுகள்"
-
-    nav:
-      prev: "‹ முந்தையது"
-      next: "அடுத்தது ›"
-      gap: "…"
-
     info:
       no_items: "%{item_name} கிடைக்கவில்லை"
       single_page: "<b>%{count}</b> %{item_name} காட்டப்படுகின்றது"
       multiple_pages: "மொத்தம் <b>%{count}</b> %{item_name}, காட்டப்படுபவை <b>%{from}-%{to}</b>"
-
     combo_nav_js: "<label>%{pages}-இல் %{page_input}-வது பக்கம்</label>"
-
     items_selector_js: "<label>ஒரு பக்கத்திற்கு %{items_input} %{item_name} காட்டு</label>"

data/lib/locales/tr.yml

@@ -1,20 +1,19 @@
-# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 tr:
   pagy:
-
+    aria_label:
+      # please add a comment in the https://github.com/ddnexus/pagy/issues/605
+      # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
+      nav: "Pages"
+      prev: "Önceki"
+      next: "Sonraki"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name: "kayıt"
-
-    nav:
-      prev: "‹ Önceki"
-      next: "Sonraki ›"
-      gap: "…"
-
     info:
       no_items: "Hiç %{item_name} bulunamadı"
       single_page: "Toplam <b>%{count}</b> %{item_name} gösteriliyor"
       multiple_pages: "<b>%{count}</b> %{item_name} içerisinden <b>%{from}-%{to}</b> kadarı gösteriliyor"
-
     combo_nav_js: "<label>Sayfa %{page_input} / %{pages}</label>"
-
     items_selector_js: "<label>Sayfada %{items_input} %{item_name} göster</label>"

data/lib/locales/uk.yml

@@ -1,24 +1,25 @@
-# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 uk:
   pagy:
-
+    aria_label:
+      nav:
+        one: "Сторінка"
+        few: "Сторінки"
+        many: "Сторінок"
+        other: "Сторінки"
+      prev: "Назад"
+      next: "Далі"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name:
       one: "запис"
       few: "записів"
       many: "записів"
       other: "записів"
-
-    nav:
-      prev: "‹ Назад"
-      next: "Далі ›"
-      gap: "…"
-
     info:
       no_items: "Більше %{item_name} немає"
       single_page: "<b>%{count}</b> %{item_name}"
       multiple_pages: "Загалом <b>%{count}</b> %{item_name}, показані з <b>%{from}</b> по <b>%{to}</b>"
-
     combo_nav_js: "<label>Сторінка %{page_input} з %{pages}</label>"
-
     items_selector_js: "<label>Показати %{items_input} %{item_name} на сторінці</label>"

data/lib/locales/vi.yml

@@ -0,0 +1,17 @@
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
+vi:
+  pagy:
+    aria_label:
+      nav: "Trang"
+      prev: "Trang trước"
+      next: "Trang sau"
+    prev: "<"
+    next: ">"
+    gap: "…"
+    item_name: "kết quả"
+    info:
+      no_items: "Không tìm thấy %{item_name} nào"
+      single_page: "<b>%{count}</b> %{item_name}"
+      multiple_pages: "Đang hiển thị <b>%{from}-%{to}</b> trong tổng số <b>%{count} %{item_name}</b>"
+    combo_nav_js: "<label>Trang %{page_input} trên %{pages}</label>"
+    items_selector_js: "<label>Hiển thị %{items_input} %{item_name} mỗi trang</label>"

data/lib/locales/zh-CN.yml

@@ -1,20 +1,19 @@
-# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 zh-CN:
   pagy:
-
+    aria_label:
+      # please add a comment in the https://github.com/ddnexus/pagy/issues/608
+      # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
+      nav: "Pages"
+      prev: "上一页"
+      next: "下一页"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name: ""
-
-    nav:
-      prev: "‹ 上一页"
-      next: "下一页 ›"
-      gap: "…"
-
     info:
       no_items: "项目未找到"
       single_page: "显示<b>%{count}</b> 项%{item_name}"
       multiple_pages: "共 <b>%{count}</b> 项%{item_name}，显示 <b>%{from}-%{to}</b>"
-
     combo_nav_js: "<label>第 %{page_input} / %{pages} 页</label>"
-
     items_selector_js: "<label>每页显示 %{items_input} 条%</label>"

data/lib/locales/zh-HK.yml

@@ -1,20 +1,19 @@
-# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 zh-HK:
   pagy:
-
+    aria_label:
+      # please add a comment in the https://github.com/ddnexus/pagy/issues/609
+      # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
+      nav: "Pages"
+      prev: "上一頁"
+      next: "下一頁"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name: ""
-
-    nav:
-      prev: "‹ 上一頁"
-      next: "下一頁 ›"
-      gap: "…"
-
     info:
       no_items: "記錄未搵到"
       single_page: "顯示 <b>%{count}</b> %{item_name}"
       multiple_pages: "共 <b>%{count}</b>  %{item_name}，顯示 <b>%{from}-%{to}</b>"
-
     combo_nav_js: "<label>第 %{page_input} / %{pages} 頁</label>"
-
     items_selector_js: "<label>每頁顯示 %{items_input} 記錄</label>"

data/lib/locales/zh-TW.yml

@@ -1,20 +1,19 @@
-# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
-
+# :other pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/pagy/i18n.rb)
 zh-TW:
   pagy:
-
+    aria_label:
+      # please add a comment in the https://github.com/ddnexus/pagy/issues/610
+      # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
+      nav: "Pages"
+      prev: "上一頁"
+      next: "下一頁"
+    prev: "<"
+    next: ">"
+    gap: "…"
     item_name: ""
-
-    nav:
-      prev: "‹ 上一頁"
-      next: "下一頁 ›"
-      gap: "…"
-
     info:
       no_items: "沒找到項"
       single_page: "顯示 <b>%{count}</b> 項%{item_name}"
       multiple_pages: "共 <b>%{count}</b> 項%{item_name}，顯示 <b>%{from}-%{to}</b>"
-
     combo_nav_js: "<label>第 %{page_input} / %{pages} 頁</label>"
-
     items_selector_js: "<label>每頁顯示 %{items_input} 項%{item_name}</label>"

data/lib/pagy/backend.rb

@@ -1,8 +1,8 @@
-# See Pagy::Backend API documentation: https://ddnexus.github.io/pagy/api/backend
+# See Pagy::Backend API documentation: https://ddnexus.github.io/pagy/docs/api/backend
 # frozen_string_literal: true
 
 class Pagy
-  # Define a few generic methods to paginate an ORM collection out of the box,
+  # Define a few generic methods to paginate a collection out of the box,
   # or any collection by overriding pagy_get_items and/or pagy_get_vars in your controller
   # See also the extras if you need specialized methods to paginate Arrays or other collections
   module Backend
@@ -18,11 +18,17 @@ class Pagy
     # You may need to override the count call for non AR collections
     def pagy_get_vars(collection, vars)
       pagy_set_items_from_params(vars) if defined?(ItemsExtra)
-      vars[:count] ||= (count = collection.count(:all)).is_a?(Hash) ? count.size : count
-      vars[:page]  ||= params[vars[:page_param] || DEFAULT[:page_param]]
+      vars[:count] ||= (count = collection.count(*vars[:count_args])).is_a?(Hash) ? count.size : count
+      vars[:page]  ||= pagy_get_page(vars)
       vars
     end
 
+    # Get the page integer from the params
+    # Overridable by the jsonapi extra
+    def pagy_get_page(vars)
+      (params[vars[:page_param] || DEFAULT[:page_param]] || 1).to_i
+    end
+
     # Sub-method called only by #pagy: here for easy customization of record-extraction by overriding
     # You may need to override this method for collections without offset|limit
     def pagy_get_items(collection, pagy)

data/lib/pagy/calendar/day.rb

@@ -1,12 +1,13 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/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' }
+      DEFAULT = { size:   31,   # rubocop:disable Style/MutableConstant
+                  order:  :asc,
+                  format: '%d' }
 
       protected
 

data/lib/pagy/calendar/helper.rb

@@ -3,8 +3,7 @@
 class Pagy # :nodoc:
   class Calendar # :nodoc:
     # Initializes the calendar objects, reducing complexity in the extra
-    # The returned calendar is a simple hash of units/objects with an added helper
-    # returning the last_object_at(time) used in the extra
+    # The returned calendar is a simple hash of units/objects
     class Helper < Hash
       class << self
         private
@@ -16,14 +15,15 @@ class Pagy # :nodoc:
 
       private
 
+      # Create the calendar
       def init(conf, period, params)
-        @units = Calendar::UNITS & conf.keys # get the units in time length desc order
+        @conf  = Marshal.load(Marshal.dump(conf))  # store a copy
+        @units = Calendar::UNITS & @conf.keys # get the units in time length desc order
         raise ArgumentError, 'no calendar unit found in pagy_calendar @configuration' if @units.empty?
 
         @period     = period
         @params     = params
         @page_param = conf[:pagy][:page_param] || DEFAULT[:page_param]
-        @conf       = Marshal.load(Marshal.dump(conf))  # store a copy
         @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
@@ -33,29 +33,33 @@ class Pagy # :nodoc:
         object   = nil
         @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 |unit_params|  # delete page_param from the sub-units
-                                  # Hash#except missing from ruby 2.5 baseline
-                                  params_to_delete.each { |p| unit_params.delete(p.to_s) }
-                                  unit_params
-                                end
+          conf[unit][:params] = lambda { |up| up.except(*params_to_delete.map(&:to_s)) } # rubocop:disable Style/Lambda
           conf[unit][:period] = object&.send(:active_period) || @period
           calendar[unit]      = object = Calendar.send(:create, unit, conf[unit])
         end
         [replace(calendar), object.from, object.to]
       end
 
-      def last_object_at(time)
+      # Return the calendar object at time
+      def calendar_at(time, **opts)
         conf        = Marshal.load(Marshal.dump(@conf))
         page_params = {}
         @units.inject(nil) do |object, unit|
           conf[unit][:period] = object&.send(:active_period) || @period
           conf[unit][:page]   = page_params[:"#{unit}_#{@page_param}"] \
-                              = Calendar.send(:create, unit, conf[unit]).send(:page_at, time)
+                              = Calendar.send(:create, unit, conf[unit]).send(:page_at, time, **opts)
           conf[unit][:params] ||= {}
           conf[unit][:params].merge!(page_params)
           Calendar.send(:create, unit, conf[unit])
         end
       end
+
+      public
+
+      # Return the current time of the smallest time unit shown
+      def showtime
+        self[@units.last].from
+      end
     end
   end
 end

data/lib/pagy/calendar/month.rb

@@ -1,12 +1,13 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/calendar
 # frozen_string_literal: true
 
 class Pagy # :nodoc:
   class Calendar # :nodoc:
     # Calendar month subclass
     class Month < Calendar
-      DEFAULT = { order: :asc, # rubocop:disable Style/MutableConstant
-                  format: '%Y-%m' }
+      DEFAULT = { size: 12,   # rubocop:disable Style/MutableConstant
+                  order: :asc,
+                  format: '%b' }
 
       protected
 

data/lib/pagy/calendar/quarter.rb

@@ -1,12 +1,13 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/calendar
 # frozen_string_literal: true
 
 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
+      DEFAULT = { size:   4,      # rubocop:disable Style/MutableConstant
+                  order:  :asc,
+                  format: 'Q%q' } # '%q' token
 
       # The label for any page, with the substitution of the '%q' token
       def label_for(page, opts = {})

data/lib/pagy/calendar/week.rb

@@ -1,4 +1,4 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/calendar
 # frozen_string_literal: true
 
 class Pagy # :nodoc:

data/lib/pagy/calendar/year.rb

@@ -1,11 +1,12 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/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
+      DEFAULT = { size:   10,   # rubocop:disable Style/MutableConstant
+                  order:  :asc,
                   format: '%Y' }
 
       protected

data/lib/pagy/calendar.rb

@@ -1,4 +1,4 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/calendar
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/calendar
 # frozen_string_literal: true
 
 require 'active_support'
@@ -13,12 +13,12 @@ class Pagy # :nodoc:
   # Base class for time units subclasses (Year, Quarter, Month, Week, Day)
   class Calendar < Pagy
     # Specific out of range error
-    class OutOfRangeError < StandardError; end
+    class OutOfRangeError < VariableError; end
 
     # 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
 
-    attr_reader :order
+    attr_reader :order, :from, :to
 
     # Merge and validate the options, do some simple arithmetic and set a few instance variables
     def initialize(vars) # rubocop:disable Lint/MissingSuper
@@ -49,10 +49,24 @@ class Pagy # :nodoc:
     protected
 
     # The page that includes time
-    def page_at(time)
-      raise OutOfRangeError unless time.between?(@initial, @final)
-
-      offset = page_offset_at(time)   # offset starts from 0
+    # In case of out of range time, the :fit_time option avoids the outOfRangeError
+    # and returns the closest page to the passed time argument (first or last page)
+    def page_at(time, **opts)
+      fit_time  = time
+      fit_final = @final - 1
+      unless time.between?(@initial, fit_final)
+        raise OutOfRangeError.new(self, :time, "between #{@initial} and #{fit_final}", time) unless opts[:fit_time]
+
+        if time < @final
+          fit_time = @initial
+          ordinal  = 'first'
+        else
+          fit_time = fit_final
+          ordinal  = 'last'
+        end
+        Warning.warn "Pagy::Calendar#page_at: Rescued #{time} out of range by returning the #{ordinal} page."
+      end
+      offset = page_offset_at(fit_time)   # offset starts from 0
       @order == :asc ? offset + 1 : @pages - offset
     end
 
@@ -84,6 +98,18 @@ class Pagy # :nodoc:
       [[@starting, @from].max, [@to - 1, @ending].min] # -1 sec: include only last unit day
     end
 
+    # :nocov:
+    # This method must be implemented by the unit subclass
+    def starting_time_for(*)
+      raise NoMethodError, 'the starting_time_for method must be implemented by the unit subclass'
+    end
+
+    # This method must be implemented by the unit subclass
+    def page_offset_at(*)
+      raise NoMethodError, 'the page_offset_at method must be implemented by the unit subclass'
+    end
+    # :nocov:
+
     class << self
       # Create a subclass instance by unit name (internal use)
       def create(unit, vars)

data/lib/pagy/console.rb

@@ -1,4 +1,4 @@
-# See Pagy::Console API documentation: https://ddnexus.github.io/pagy/api/console
+# See Pagy::Console API documentation: https://ddnexus.github.io/pagy/docs/api/console
 # frozen_string_literal: true
 
 require 'pagy'  # so you can require just the extra in the console

data/lib/pagy/countless.rb

@@ -1,4 +1,4 @@
-# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/api/countless
+# See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/countless
 # frozen_string_literal: true
 
 require 'pagy'

data/lib/pagy/exceptions.rb

@@ -10,7 +10,7 @@ class Pagy
       @pagy     = pagy
       @variable = variable
       @value    = value
-      super "expected :#{@variable} #{description}; got #{@value.inspect}"
+      super("expected :#{@variable} #{description}; got #{@value.inspect}")
     end
   end
 

data/lib/pagy/extras/arel.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/arel
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/arel
 # frozen_string_literal: true
 
 class Pagy # :nodoc:

data/lib/pagy/extras/array.rb

@@ -1,4 +1,4 @@
-# See the Pagy documentation: https://ddnexus.github.io/pagy/extras/array
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/array
 # frozen_string_literal: true
 
 class Pagy # :nodoc: