pagy 5.6.4 → 5.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5436ee5b008a1f9db93ba52363fbae559f6444600c5925fcd87541b606e2a8ad
-  data.tar.gz: 6159c1b56724cf1e10af6c15c2a141200d1795ed3da6fa6655cb1e7ee3f7056c
+  metadata.gz: 3bc0ec346bfde6c907da343d7c3f7ad611cbb69f4ed8e36aa09b69b48276ecb6
+  data.tar.gz: 9d936c804c00f7eb530c9a7f5d1ecf763704daf84e35b9a3288eae2f88d3e3be
 SHA512:
-  metadata.gz: 6d2e0aa3e7a4a9bfee7b4360b1d6ae35d931a1aa7fd4959436adf78cb43c153149ebb80455d9a63f7ef36558c5d673191fcd5ad10ce7e4be2e75ca42be645d05
-  data.tar.gz: ee07cd90d3908f52c879cebf1956ee5cb1c12739b21e4a0519e7a8432e3ead0304a2bca94ca6a9444035e72563e2de2dd4a5191c279183fad39d22b7703babae
+  metadata.gz: a2e92a735ed04def206a2cdd81577ff39042cc03f98a4343b6e8889c008bb5ba8277bd76168b1d3f39067bc68b9e9b4b1805721cac9a12cded2a491b106023db
+  data.tar.gz: 825ad4c0c076d4dae52ba69772b0c827662181ddd9bd077c41ec5a167b0da506bf7153493a99ab5a704043f08918b1d0e460430c8fa7ee08d0675b1f3d1a5619

data/lib/config/pagy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Pagy initializer file (5.6.4)
+# Pagy initializer file (5.6.5)
 # Customize only what you really need and notice that the core 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 for the whole pagy stuff
 function Pagy(){}
 
-Pagy.version = '5.6.4'
+Pagy.version = '5.6.5'
 
 // Used by the waitForMe function
 Pagy.delay = 100

data/lib/pagy/backend.rb

@@ -8,7 +8,7 @@ class Pagy
   module Backend
     private
 
-    # Return Pagy object and items
+    # Return Pagy object and paginated items/results
     def pagy(collection, vars = {})
       pagy = Pagy.new(pagy_get_vars(collection, vars))
       [pagy, pagy_get_items(collection, pagy)]

data/lib/pagy/calendar.rb

@@ -41,7 +41,7 @@ class Pagy # :nodoc:
 
     protected
 
-    # Base class method for the setup of the unit variables
+    # Base class method for the setup of the unit variables (subclasses must implement it and call super)
     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) \
@@ -85,6 +85,6 @@ class Pagy # :nodoc:
       end
     end
   end
-
+  # Require the subclass files in UNITS (no custom unit at this point yet)
   Calendar::UNITS.each { |unit| require "pagy/calendar/#{unit}" }
 end

data/lib/pagy/extras/arel.rb

@@ -6,11 +6,13 @@ class Pagy # :nodoc:
   module ArelExtra
     private
 
+    # Return Pagy object and paginated collection/results
     def pagy_arel(collection, vars = {})
       pagy = Pagy.new(pagy_arel_get_vars(collection, vars))
       [pagy, pagy_get_items(collection, pagy)]
     end
 
+    # Sub-method called only by #pagy_arel: here for easy customization of variables by overriding
     def pagy_arel_get_vars(collection, vars)
       pagy_set_items_from_params(vars) if defined?(ItemsExtra)
       vars[:count] ||= pagy_arel_count(collection)
@@ -18,6 +20,7 @@ class Pagy # :nodoc:
       vars
     end
 
+    # Count using Arel when grouping
     def pagy_arel_count(collection)
       if collection.group_values.empty?
         # COUNT(*)

data/lib/pagy/extras/array.rb

@@ -6,7 +6,7 @@ class Pagy # :nodoc:
   module ArrayExtra
     private
 
-    # Return Pagy object and items
+    # Return Pagy object and paginated items
     def pagy_array(array, vars = {})
       pagy = Pagy.new(pagy_array_get_vars(array, vars))
       [pagy, array[pagy.offset, pagy.items]]

data/lib/pagy/extras/calendar.rb

@@ -26,7 +26,9 @@ class Pagy # :nodoc:
 
       # Setup and return the calendar objects and the filtered collection
       def pagy_setup_calendar(collection, conf)
-        units      = Calendar::UNITS & conf.keys # get the units in time length desc order
+        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?
+
         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}"

data/lib/pagy/extras/i18n.rb

@@ -4,14 +4,14 @@
 class Pagy # :nodoc:
   # Use ::I18n gem
   module I18nExtra
-    # Frontend overriding
+    # Frontend overriding for translation
     module Frontend
       def pagy_t(key, **opts)
         ::I18n.t(key, **opts)
       end
     end
 
-    # Calendar overriding
+    # Calendar overriding for localization (see also the block in the calendar section of the config/pagy.rb initializer)
     module Calendar
       def localize(time, opts)
         ::I18n.l(time, **opts)

data/lib/pagy/frontend.rb

@@ -77,7 +77,7 @@ class Pagy
     # Similar to I18n.t: just ~18x faster using ~10x less memory
     # (@pagy_locale explicitly initialized in order to avoid warning)
     def pagy_t(key, opts = {})
-      Pagy::I18n.t(@pagy_locale ||= nil, key, opts)
+      Pagy::I18n.translate(@pagy_locale ||= nil, key, opts)
     end
   end
 end

data/lib/pagy/i18n.rb

@@ -153,11 +153,12 @@ class Pagy
     end
 
     # Translate and pluralize the key with the locale DATA
-    def t(locale, key, opts = {})
+    def translate(locale, key, opts = {})
       data, pluralize = DATA[locale]
       translation = data[key] || (opts[:count] && data[key += ".#{pluralize.call(opts[:count])}"]) \
                       or return %([translation missing: "#{key}"])
       translation.gsub(/%{[^}]+?}/) { |match| opts[:"#{match[2..-2]}"] || match }
     end
+    alias t translate
   end
 end

data/lib/pagy.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 # Core class
 class Pagy
-  VERSION = '5.6.4'
+  VERSION = '5.6.5'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root
@@ -76,6 +76,7 @@ class Pagy
     page.to_s
   end
 
+  # Allow the customization of the output (overridden by the calendar extra)
   def label
     @page.to_s
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 5.6.4
+  version: 5.6.5
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies: []
 description: Agnostic pagination in plain ruby. It does it all. Better.
 email: