pagy 5.6.3 → 5.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f567ea14d1f7bf5697ca416cf0cf1bc200986b804099f31aba5fd1ae6a946fa4
-  data.tar.gz: 8b09e574678ab6673c4e9d8fdc48eaf611657354d457da4856a70173d7194732
+  metadata.gz: 0d1bf851d5e0ceba5250106974dc79d90346224bd25b149e28f78c307980ad90
+  data.tar.gz: fd0c607bf907c917b0aa637c08c7f773d0a403b6662738f59e23e0aa197f6f49
 SHA512:
-  metadata.gz: 2cf7845ce5b8d668cfa0de512bb6fb7ed676e3586167a9b95fdfd6eebb8b9f7bfd5cb688ab523ef1e7e512ce5f5bb379e305beb4531dd00c609e755620bd0004
-  data.tar.gz: f79e860f496368e67bf328b3359f5860162801600452482cf4b1c0b06439b20f9fb296d5593159410c1817fff4576c4e03ef526f265dbb5f9aa4d8877e9c558b
+  metadata.gz: 6b971d9c936a082e73dab19ceb624be6a041e1e8646a3d88d5742ddd93d2fa701669e7dae8ee13450397e4dcc9a2c921788c081aaa545fddb628e975bb669661
+  data.tar.gz: 4e2d4ccd5a85264e2b4b85319ccbac120139ea2f1cbadb6a4bb35740e44498027cc353c1aa9ea03f9a6adc6ece776353f879c85745b0c1941b5005b344592537

data/lib/config/pagy.rb

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

@@ -1,135 +1 @@
-// 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.6.3'
-
-// Used by the waitForMe function
-Pagy.delay = 100
-
-// Scan the target for data-pagy-json elements and apply their functions
-Pagy.init =
-  function(arg) {
-    var target   = arg instanceof Event || arg === undefined ? document : arg,
-        elements = target.querySelectorAll('[data-pagy-json]')
-    for (var i = 0, len = elements.length; i < len; i++) {
-      var args  = JSON.parse(elements[i].getAttribute('data-pagy-json')),
-          fname = args.shift()
-      args.unshift(elements[i])
-      Pagy[fname].apply(null, args)
-    }
-  }
-
-// Power the pagy*_nav_js helpers
-Pagy.nav =
-  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)) }
-    }
-    widths.sort(function(a, b) { return b - a })
-
-    pagyEl.render =
-      function() {
-        var width, i, len
-        for (i = 0, len = widths.length; i < len; i++) {
-          if (this.parentElement.clientWidth > widths[i]) { width = widths[i]; break }
-        }
-        if (width !== lastWidth) {
-          var html   = tags.before,
-              series = sequels[width],
-              labels = label_sequels[width]
-          for (i = 0, len = series.length; i < len; i++) {
-            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 += fill(tags.active, item, label) }
-          }
-          html += tags.after
-          this.insertAdjacentHTML('afterbegin', html)
-          lastWidth = width
-        }
-      }.bind(pagyEl)
-    pagyEl.render()
-  }
-
-// Power the pagy*_combo_nav_js helpers
-Pagy.combo_nav =
-  function(pagyEl, page, link, trimParam) {
-    var input  = pagyEl.getElementsByTagName('input')[0],
-        toPage =
-          function() {
-            if (page !== input.value) {
-              var html = link.replace(/__pagy_page__/, input.value)
-              if (typeof (trimParam) === 'string' && input.value === '1') { html = Pagy.trim(html, trimParam) }
-              pagyEl.insertAdjacentHTML('afterbegin', html)
-              pagyEl.getElementsByTagName('a')[0].click()
-            }
-          }
-    Pagy.addInputEventListeners(input, toPage)
-  }
-
-// Power the pagy_items_selector_js helper
-Pagy.items_selector =
-  function(pagyEl, from, link, param) {
-    var input   = pagyEl.getElementsByTagName('input')[0],
-        current = input.value,
-        toPage  =
-          function() {
-            var items = input.value
-            if (items === 0 || items === '') { return }
-            if (current !== items) {
-              var page = Math.max(Math.ceil(from / items), 1),
-                  html = link.replace(/__pagy_page__/, page).replace(/__pagy_items__/, items)
-              if (typeof (param) === 'string' && page === 1) { html = Pagy.trim(html, param) }
-              pagyEl.insertAdjacentHTML('afterbegin', html)
-              pagyEl.getElementsByTagName('a')[0].click()
-            }
-          }
-    Pagy.addInputEventListeners(input, toPage)
-  }
-
-// Utility for input fields
-Pagy.addInputEventListeners =
-  function(input, toPage) {
-    // select the content on click: easier for typing a number
-    input.addEventListener('click', function() { this.select() })
-    // toPage when the input looses focus
-    input.addEventListener('focusout', toPage)
-    // … and when pressing enter inside the input
-    input.addEventListener('keyup', function(e) { if (e.which === 13) {toPage()} }.bind(this))
-  }
-
-// Power the trim extra for js helpers
-Pagy.trim =
-  function(html, param) {
-    var re = new RegExp('[?&]' + param + '=1\\b(?!&)|\\b' + param + '=1&')
-    return html.replace(re, '')
-  }
-
-// Render all *nav_js helpers
-Pagy.renderNavs =
-  function() {
-    var navs = document.getElementsByClassName('pagy-njs')  // 'pagy-njs' is common to all *nav_js helpers
-    for (var i = 0, len = navs.length; i < len; i++) { navs[i].render() }
-  }
-
-// Throttle to avoid to fire multiple time the renderNavs on resize
-Pagy.waitForMe =
-  function() {
-    if (typeof(Pagy.tid) === 'number') { clearTimeout(Pagy.tid) }
-    Pagy.tid = setTimeout(Pagy.renderNavs, Pagy.delay)
-  }
-
-// If there is a window object then add the event listener on resize
-if (typeof window !== 'undefined') {
-  window.addEventListener('resize', Pagy.waitForMe, true)
-}
+"use strict";function _toConsumableArray(a){return _arrayWithoutHoles(a)||_iterableToArray(a)||_unsupportedIterableToArray(a)||_nonIterableSpread()}function _nonIterableSpread(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}function _iterableToArray(a){if("undefined"!=typeof Symbol&&null!=a[Symbol.iterator]||null!=a["@@iterator"])return Array.from(a)}function _arrayWithoutHoles(a){if(Array.isArray(a))return _arrayLikeToArray(a)}function _createForOfIteratorHelper(a,b){var c="undefined"!=typeof Symbol&&a[Symbol.iterator]||a["@@iterator"];if(!c){if(Array.isArray(a)||(c=_unsupportedIterableToArray(a))||b&&a&&"number"==typeof a.length){c&&(a=c);var d=0,e=function(){};return{s:e,n:function n(){return d>=a.length?{done:!0}:{done:!1,value:a[d++]}},e:function e(a){throw a},f:e}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var f,g=!0,h=!1;return{s:function s(){c=c.call(a)},n:function n(){var a=c.next();return g=a.done,a},e:function e(a){h=!0,f=a},f:function f(){try{g||null==c["return"]||c["return"]()}finally{if(h)throw f}}}}function _unsupportedIterableToArray(a,b){if(a){if("string"==typeof a)return _arrayLikeToArray(a,b);var c=Object.prototype.toString.call(a).slice(8,-1);return"Object"===c&&a.constructor&&(c=a.constructor.name),"Map"===c||"Set"===c?Array.from(a):"Arguments"===c||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(c)?_arrayLikeToArray(a,b):void 0}}function _arrayLikeToArray(a,b){(null==b||b>a.length)&&(b=a.length);for(var c=0,d=Array(b);c<b;c++)d[c]=a[c];return d}var Pagy={version:"5.6.7",init:function init(a){var b,c=a instanceof HTMLElement?a:document,d=c.querySelectorAll("[data-pagy-json]"),e=_createForOfIteratorHelper(d);try{for(e.s();!(b=e.n()).done;){var f=b.value,g=f.getAttribute("data-pagy-json");if(null!==g){var h=JSON.parse(g),i=h.shift();"nav"===i?Pagy.nav.apply(Pagy,[f].concat(_toConsumableArray(h))):"combo_nav"===i?Pagy.combo_nav.apply(Pagy,[f].concat(_toConsumableArray(h))):"items_selector"===i&&Pagy.items_selector.apply(Pagy,[f].concat(_toConsumableArray(h)))}}}catch(a){e.e(a)}finally{e.f()}},nav:function nav(a,b,c,d,e){var f={};if(null===d)for(var k in c)f[k]=c[k].map(function(a){return a.toString()});else f=d;var g,h=Object.getOwnPropertyNames(c).map(function(a){return parseInt(a)}).sort(function(c,a){return a-c}),j=function(a,b,c){return a.replace(/__pagy_page__/g,b).replace(/__pagy_label__/g,c)};a.pagyRender=function(){var a,d=0,k=_createForOfIteratorHelper(h);try{for(k.s();!(a=k.n()).done;){var q=a.value;if(null!==this.parentElement&&this.parentElement.clientWidth>q){d=q;break}}}catch(a){k.e(a)}finally{k.f()}if(d!==g){var l=b.before,m=c[d.toString()],n=f[d.toString()];for(var r in m){var o=m[r],p=n[r];if("string"==typeof e&&1===o){var i=j(b.link,o.toString(),p);l+=Pagy.trim(i,e)}else l+="number"==typeof o?j(b.link,o.toString(),p):"gap"===o?b.gap:j(b.active,o,p)}l+=b.after,this.innerHTML="",this.insertAdjacentHTML("afterbegin",l),g=d}}.bind(a),a.pagyRender(),"undefined"!=typeof window&&window.addEventListener("resize",Pagy.throttleRenderNavs,!0)},throttleRenderNavsTID:0,throttleRenderNavsDelay:100,throttleRenderNavs:function throttleRenderNavs(){clearTimeout(Pagy.throttleRenderNavsTID),Pagy.throttleRenderNavsTID=setTimeout(Pagy.renderNavs,Pagy.throttleRenderNavsDelay)},renderNavs:function renderNavs(){var a,b=document.getElementsByClassName("pagy-njs"),c=_createForOfIteratorHelper(b);try{for(c.s();!(a=c.n()).done;){var d=a.value;d.pagyRender()}}catch(a){c.e(a)}finally{c.f()}},combo_nav:function combo_nav(a,b,c,d){var e=a.getElementsByTagName("input")[0];Pagy.addInputBehavior(e,function goToPage(){if(b!==e.value){var f=c.replace(/__pagy_page__/,e.value);"string"==typeof d&&"1"===e.value&&(f=Pagy.trim(f,d)),a.insertAdjacentHTML("afterbegin",f),a.getElementsByTagName("a")[0].click()}})},trim:function trim(a,b){var c=new RegExp("[?&]".concat(b,"=1\\b(?!&)|\\b").concat(b,"=1&"));return a.replace(c,"")},items_selector:function items_selector(a,b,c,d){var e=a.getElementsByTagName("input")[0],f=e.value;Pagy.addInputBehavior(e,function goToPage(){var g=Math.max,h=Math.ceil,i=e.value;if("0"!==i&&""!==i&&f!==i){var j=g(h(b/parseInt(i)),1).toString(),k=c.replace(/__pagy_page__/,j).replace(/__pagy_items__/,i);"string"==typeof d&&"1"===j&&(k=Pagy.trim(k,d)),a.insertAdjacentHTML("afterbegin",k),a.getElementsByTagName("a")[0].click()}})},addInputBehavior:function addInputBehavior(a,b){a.addEventListener("click",function(){this.select()}),a.addEventListener("focusout",function(){b()}),a.addEventListener("keypress",function(a){"Enter"===a.key&&b()}.bind(this))}};

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

@@ -4,7 +4,7 @@
 require 'pagy/calendar'
 
 class Pagy # :nodoc:
-  # Paginate based on calendar periods (year month week day) plus the regular pagination
+  # Add pagination filtering by calendar unit (:year, :quarter, :month, :week, :day) to the regular pagination
   module CalendarExtra
     # Additions for the Backend module
     module Backend
@@ -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/frontend_helpers.rb

@@ -18,7 +18,7 @@ class Pagy # :nodoc:
       #       "350" => [1, 2, :gap, 17, 18, 19, "20", 21, 22, 23, :gap, 49, 50],
       #       "550" => [1, 2, 3, :gap, 16, 17, 18, 19, "20", 21, 22, 23, 24, :gap, 48, 49, 50] }
       # Notice: if :steps is false it will use the single {0 => @vars[:size]} size
-      def sequels(steps: @vars[:steps] || { 0 => @vars[:size] })
+      def sequels(steps: @vars[:steps] || { 0 => @vars[:size] }, **_)
         raise VariableError.new(self, :steps, 'to define the 0 width', steps) unless steps.key?(0)
 
         {}.tap do |sequels|

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.3'
+  VERSION = '5.6.7'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root
@@ -44,7 +44,7 @@ class Pagy
   end
 
   # Return the array of page numbers and :gap items e.g. [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
-  def series(size: @vars[:size])
+  def series(size: @vars[:size], **_)
     return [] if size.empty?
     raise VariableError.new(self, :size, 'to contain 4 items >= 0', size) \
           unless size.is_a?(Array) && size.size == 4 && size.all? { |num| !num.negative? rescue false } # rubocop:disable Style/RescueModifier
@@ -59,11 +59,11 @@ class Pagy
     series          = []
     start           = 1
     if (left_gap_end - left_gap_start).positive?
-      series.push(*start..(left_gap_start - 1), :gap)
+      series.push(*start...left_gap_start, :gap)
       start = left_gap_end + 1
     end
     if (right_gap_end - right_gap_start).positive?
-      series.push(*start..(right_gap_start - 1), :gap)
+      series.push(*start...right_gap_start, :gap)
       start = right_gap_end + 1
     end
     series.push(*start..@last)
@@ -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.3
+  version: 5.6.7
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies: []
 description: Agnostic pagination in plain ruby. It does it all. Better.
 email:
@@ -111,6 +111,11 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/ddneus/pagy
+  documentation_uri: https://ddnexus.github.io/pagy
+  bug_tracker_uri: https://github.com/ddnexus/pagy/issues
+  changelog_uri: https://github.com/ddnexus/pagy/blob/master/CHANGELOG.md
+  live_support: https://gitter.im/ruby-pagy/Lobby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -126,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: The kick-ass pagination ruby gem