pagy 3.11.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cadf66aafed63e69474727fab67e77da2038ad95e9a1430d5546da2b5f9d1a2
-  data.tar.gz: 6a716cef53d59459b3406e0e330d44536b8f5ec738d0661140d3fd805ef613ec
+  metadata.gz: 66ae2dcfec4f4aefaa0a2531b5abe5e0d18b92a835edf6549251c0073ce2f38f
+  data.tar.gz: 295ca05e50dc171da7c184d7d3e8dd9e3b7eaed1cf7387959471a3f758f6d169
 SHA512:
-  metadata.gz: 563e233579eab779aa3210751143c617369d3e0f34bd5365a7e50ed6bd07346b1aa052a3a2fec8b25b375dbc6d837836639915ab01160aff857938fbac515412
-  data.tar.gz: 02a8a1d45a18b5ea644e24c3fa50b6d4cdb48c3fd27fb135ece5fd981ea246da568759427f1daba2cf29705fe1dbcaf6e52f97f8cca84744fd285bee0cca4338
+  metadata.gz: d96430c17d8936a27942e3da7c0fbcff4d80372afd1f99b7a0c12b4ed5eb694aa1921404d31b77889078dc0fc59b4bbc5bfb0e4a6c418f3ae50837436bc17262
+  data.tar.gz: d7349c4e47d8b33cdadea01168d8a122ef36c6283164cf895dbcf197aca0f07c44437abce7e7d72b29d358f4d95b80586157d5bd5eeb4515e32b7001031329b8

data/lib/config/pagy.rb

@@ -1,7 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-# Pagy initializer file (3.11.0)
+# Pagy initializer file (4.3.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
 
@@ -23,13 +22,18 @@
 
 # Elasticsearch Rails extra: Paginate `ElasticsearchRails::Results` objects
 # See https://ddnexus.github.io/pagy/extras/elasticsearch_rails
+# default :pagy_search method: change only if you use
+# also the searchkick extra that defines the same
+# VARS[:elasticsearch_rails_search_method] = :pagy_search
 # require 'pagy/extras/elasticsearch_rails'
 
 # Searchkick extra: Paginate `Searchkick::Results` objects
 # See https://ddnexus.github.io/pagy/extras/searchkick
+# default :pagy_search method: change only if you use
+# also the elasticsearch_rails extra that defines the same
+# VARS[:searchkick_search_method] = :pagy_search
 # require 'pagy/extras/searchkick'
 
-
 # Frontend Extras
 
 # Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination
@@ -100,7 +104,9 @@
 # Trim extra: Remove the page=1 param from links
 # See https://ddnexus.github.io/pagy/extras/trim
 # require 'pagy/extras/trim'
-
+# after requiring it will trim by default
+# set to false if you want to make :trim an opt-in variable
+# Pagy::VARS[:trim] = true # default
 
 
 # Pagy Variables

data/lib/javascripts/pagy.js

@@ -2,7 +2,7 @@
 
 function Pagy(){}
 
-Pagy.version = '3.11.0';
+Pagy.version = '4.3.0';
 
 Pagy.init = function(arg){
               var target   = arg instanceof Event || arg === undefined ? document : arg,

data/lib/locales/bs.yml

@@ -0,0 +1,24 @@
+# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+bs:
+  pagy:
+
+    item_name:
+      one: "stavka"
+      few: "stavke"
+      many: "stavki"
+      other: "stavki"
+
+    nav:
+      prev: "‹ Prethodna"
+      next: "Sljedeća  ›"
+      gap: "…"
+
+    info:
+      no_items: "Nije pronađena %{item_name}"
+      single_page: "Prikazuje se <b>%{count}</b> %{item_name}"
+      multiple_pages: "Prikaz %{item_name} <b>%{from}-%{to}</b> od <b>%{count}</b> ukupno"
+
+    combo_nav_js: "Stranica %{page_input} od %{pages}"
+
+    items_selector_js: "Prikaži %{items_input} %{item_name} po stranici"

data/lib/locales/hr.yml

@@ -0,0 +1,24 @@
+# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+hr:
+  pagy:
+
+    item_name:
+      one: "stavka"
+      few: "stavke"
+      many: "stavki"
+      other: "stavki"
+
+    nav:
+      prev: "‹ Prethodna"
+      next: "Sljedeća  ›"
+      gap: "…"
+
+    info:
+      no_items: "Nije pronađena %{item_name}"
+      single_page: "Prikazuje se <b>%{count}</b> %{item_name}"
+      multiple_pages: "Prikaz %{item_name} <b>%{from}-%{to}</b> od <b>%{count}</b> ukupno"
+
+    combo_nav_js: "Stranica %{page_input} od %{pages}"
+
+    items_selector_js: "Prikaži %{items_input} %{item_name} po stranici"

data/lib/locales/sr.yml

@@ -0,0 +1,23 @@
+# :east_slavic pluralization (see https://github.com/ddnexus/pagy/blob/master/lib/locales/utils/p11n.rb)
+
+sr:
+  pagy:
+    item_name:
+      one: "ставка"
+      few: "ставкe"
+      many: "ставки"
+      other: "ставки"
+
+    nav:
+      prev: "‹ Претходна"
+      next: "Следећa  ›"
+      gap: "…"
+
+    info:
+      no_items: "Нema пронађених %{item_name}"
+      single_page: "Приказује се <b>%{count}</b> %{item_name}"
+      multiple_pages: "Приказ %{item_name} <b>%{from}-%{to}</b> од <b>%{count}</b> укупно"
+
+    combo_nav_js: "Страниca %{page_input} од %{pages}"
+
+    items_selector_js: "Прикажи %{items_input} %{item_name} по страниcи"

data/lib/locales/utils/i18n.rb

@@ -1,25 +1,17 @@
 # See https://ddnexus.github.io/pagy/api/frontend#i18n
-# encoding: utf-8
 # frozen_string_literal: true
 
 # this file returns the I18n hash used as default alternative to the i18n gem
 
-Pagy::DEPRECATED_LOCALES = {'pt-br' =>'pt-BR', 'se' => 'sv-SE'}
-
 Hash.new{|h,_| h.first[1]}.tap do |i18n_hash|   # first loaded locale used as default
   i18n_hash.define_singleton_method(:load) do |*load_args|
     # eval: we don't need to keep the loader proc in memory
     eval(Pagy.root.join('locales', 'utils', 'loader.rb').read).call(i18n_hash, *load_args)   #rubocop:disable Security/Eval
   end
-  i18n_hash.define_singleton_method(:t) do |locale, path, vars={}|
-    if Pagy::DEPRECATED_LOCALES.key?(locale)
-      new_locale = Pagy::DEPRECATED_LOCALES[locale]
-      $stderr.puts("WARNING: the Pagy locale '#{locale}' is deprecated; use '#{new_locale}' instead")
-      locale = new_locale
-    end
+  i18n_hash.define_singleton_method(:t) do |locale, key, **opts|
     data, pluralize = self[locale]
-    translate = data[path] || vars[:count] && data[path+=".#{pluralize.call(vars[:count])}"] or return %([translation missing: "#{path}"])
-    translate.call(vars)
+    translate = data[key] || opts[:count] && data[key+=".#{pluralize.call(opts[:count])}"] or return %([translation missing: "#{key}"])
+    translate.call(opts)
   end
   i18n_hash.load(locale: 'en')
 end

data/lib/locales/utils/loader.rb

@@ -1,18 +1,20 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 # the whole file will be eval'ed/executed and gc-collected after returning/executing the loader proc
 
 # eval: no need for the whole file in memory
-plurals, _ = eval(Pagy.root.join('locales', 'utils', 'p11n.rb').read)   #rubocop:disable Security/Eval
+plurals, = eval Pagy.root.join('locales', 'utils', 'p11n.rb').read   # rubocop:disable Security/Eval
 
 # flatten the dictionary file nested keys
 # convert each value to a simple ruby interpolation proc
 flatten = lambda do |hash, key=''|
             hash.each.reduce({}) do |h, (k, v)|
-              v.is_a?(Hash) \
-                ? h.merge!(flatten.call(v, "#{key}#{k}."))
-                : h.merge!(eval %({"#{key}#{k}" => lambda{|vars|"#{v.gsub(/%{[^}]+?}/){|m| "\#{vars[:#{m[2..-2]}]||'#{m}'}" }}"}})) #rubocop:disable Security/Eval
+              if v.is_a?(Hash)
+                h.merge! flatten.call(v, "#{key}#{k}.")
+              else
+                code = %({"#{key}#{k}" => lambda{|vars|"#{v.gsub(/%{[^}]+?}/){|m| "\#{vars[:#{m[2..-2]}]||'#{m}'}" }}"}})
+                h.merge! eval(code) # rubocop:disable Security/Eval
+              end
             end
           end
 
@@ -20,11 +22,6 @@ flatten = lambda do |hash, key=''|
 lambda do |i18n, *args|
   i18n.clear
   args.each do |arg|
-    if Pagy::DEPRECATED_LOCALES.key?(arg[:locale])
-      new_locale = Pagy::DEPRECATED_LOCALES[arg[:locale]]
-      $stderr.puts("WARNING: the Pagy locale '#{arg[:locale]}' is deprecated; use '#{new_locale}' instead")
-      arg[:locale] = new_locale
-    end
     arg[:filepath]  ||= Pagy.root.join('locales', "#{arg[:locale]}.yml")
     arg[:pluralize] ||= plurals[arg[:locale]]
     hash = YAML.load(File.read(arg[:filepath], encoding: 'UTF-8')) #rubocop:disable Security/YAMLLoad

data/lib/locales/utils/p11n.rb

@@ -1,5 +1,4 @@
 # See https://ddnexus.github.io/pagy/api/frontend#i18n
-# encoding: utf-8
 # frozen_string_literal: true
 
 # This file adds support for multiple built-in plualization types.
@@ -18,46 +17,51 @@ from12to14 = [12,13,14].freeze
 # Each proc may apply to one or more locales below.
 # Pluralization logic adapted from https://github.com/svenfuchs/rails-i18n
 p11n = {
-  one_other: lambda {|n| n == 1 ? 'one' : 'other'},    # default
+  one_other: -> (n){ n == 1 ? 'one' : 'other' },    # default
 
   east_slavic: lambda do |n|
     n ||= 0
     mod10 = n % 10
     mod100 = n % 100
 
-    if    mod10 == 1 && mod100 != 11                                            ; 'one'
-    elsif from2to4.include?(mod10) && !from12to14.include?(mod100)              ; 'few'
-    elsif mod10 == 0 || from5to9.include?(mod10) || from11to14.include?(mod100) ; 'many'
-    else                                                                          'other'
+    case
+    when mod10 == 1 && mod100 != 11                                            then 'one'
+    when from2to4.include?(mod10) && !from12to14.include?(mod100)              then 'few'
+    when mod10 == 0 || from5to9.include?(mod10) || from11to14.include?(mod100) then 'many' # rubocop:disable Style/NumericPredicate
+    else                                                                            'other'
     end
   end,
 
   west_slavic: lambda do |n|
-     if n == 1                    ; 'one'
-     elsif [2, 3, 4].include?(n)  ; 'few'
-     else                         ; 'other'
-     end
+    case n
+    when 1       then 'one'
+    when 2, 3, 4 then 'few'
+    else              'other'
+    end
   end,
 
   one_two_other: lambda do |n|
-    if n == 1    ; 'one'
-    elsif n == 2 ; 'two'
-    else           'other'
+    case n
+    when 1 then 'one'
+    when 2 then 'two'
+    else        'other'
     end
   end,
 
-  one_upto_two_other: lambda {|n| n && n >= 0 && n < 2 ? 'one' : 'other'},
+  one_upto_two_other: -> (n){ n && n >= 0 && n < 2 ? 'one' : 'other' },
 
-  other: Proc.new { 'other' },
+  other: -> (*){ 'other' },
 
   polish: lambda do |n|
     n ||= 0
-    mod10 = n % 10
+    mod10  = n % 10
     mod100 = n % 100
-    if n == 1                                                                  ; 'one'
-    elsif from2to4.include?(mod10) && !from12to14.include?(mod100)             ; 'few'
-    elsif (from0to1 + from5to9).include?(mod10) || from12to14.include?(mod100) ; 'many'
-    else                                                                         'other'
+
+    case
+    when n == 1                                                               then 'one'
+    when from2to4.include?(mod10) && !from12to14.include?(mod100)             then 'few'
+    when (from0to1 + from5to9).include?(mod10) || from12to14.include?(mod100) then 'many'
+    else                                                                           'other'
     end
   end
 }
@@ -67,14 +71,17 @@ p11n = {
 # The default pluralization for locales not explicitly listed here
 # is the :one_other pluralization proc (used for English)
 plurals = Hash.new(p11n[:one_other]).tap do |hash|
+  hash['bs']    = p11n[:east_slavic]
   hash['cs']    = p11n[:west_slavic]
   hash['id']    = p11n[:other]
   hash['fr']    = p11n[:one_upto_two_other]
+  hash['hr']    = p11n[:east_slavic]
   hash['ja']    = p11n[:other]
   hash['km']    = p11n[:other]
   hash['ko']    = p11n[:other]
   hash['pl']    = p11n[:polish]
   hash['ru']    = p11n[:east_slavic]
+  hash['sr']    = p11n[:east_slavic]
   hash['sv']    = p11n[:one_two_other]
   hash['sv-SE'] = p11n[:one_two_other]
   hash['tr']    = p11n[:other]

data/lib/pagy.rb

@@ -1,48 +1,70 @@
 # See Pagy API documentation: https://ddnexus.github.io/pagy/api/pagy
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'pathname'
 
-class Pagy ; VERSION = '3.11.0'
+# main class
+class Pagy
+  VERSION = '4.3.0'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
-  def self.root; @root ||= Pathname.new(__FILE__).dirname.freeze end
+  def self.root
+    @root ||= Pathname.new(__dir__).freeze
+  end
 
   # default vars
-  VARS = { page:1, items:20, outset:0, size:[1,4,4,1], page_param: :page, params:{}, anchor:'', link_extra:'', i18n_key:'pagy.item_name', cycle:false }
+  VARS = { page: 1, items: 20, outset: 0, size: [1, 4, 4, 1], page_param: :page,              # rubocop:disable Style/MutableConstant
+           params: {}, anchor: '', link_extra: '', i18n_key: 'pagy.item_name', cycle: false }
 
   attr_reader :count, :page, :items, :vars, :pages, :last, :offset, :from, :to, :prev, :next
 
+  INSTANCE_VARS_MIN = { count: 0, items: 1, page: 1, outset: 0 }.freeze
+
   # Merge and validate the options, do some simple arithmetic and set the instance variables
   def initialize(vars)
-    @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })               # default vars + cleaned vars
-    { count:0, items:1, outset:0, page:1 }.each do |k,min|                     # validate instance variables
-      (@vars[k] && instance_variable_set(:"@#{k}", @vars[k].to_i) >= min) \
-         or raise(VariableError.new(self), "expected :#{k} >= #{min}; got #{@vars[k].inspect}")
+    @vars = VARS.merge( vars.delete_if{|_,v| v.nil? || v == '' } )
+
+    INSTANCE_VARS_MIN.each do |name,min|
+      raise VariableError.new(self), "expected :#{name} >= #{min}; got #{@vars[name].inspect}" \
+            unless @vars[name] && instance_variable_set(:"@#{name}", @vars[name].to_i) >= min
     end
-    @pages = @last = [(@count.to_f / @items).ceil, 1].max                      # cardinal and ordinal meanings
-    @page <= @last or raise(OverflowError.new(self), "expected :page in 1..#{@last}; got #{@page.inspect}")
-    @offset = @items * (@page - 1) + @outset                                   # pagination offset + outset (initial offset)
-    @items  = @count - ((@pages-1) * @items) if @page == @last && @count > 0   # adjust items for last non-empty page
-    @from   = @count == 0 ? 0 : @offset+1 - @outset                            # page begins from item
-    @to     = @count == 0 ? 0 : @offset + @items - @outset                     # page ends to item
-    @prev   = (@page-1 unless @page == 1)                                      # nil if no prev page
-    @next   = @page == @last ? (1 if @vars[:cycle]) : @page+1                  # nil if no next page, 1 if :cycle
+    @pages = @last = [(@count.to_f / @items).ceil, 1].max
+    raise OverflowError.new(self), "expected :page in 1..#{@last}; got #{@page.inspect}" \
+          if @page > @last
+
+    @offset = @items * (@page - 1) + @outset
+    @items  = @count - ((@pages - 1) * @items) if @page == @last && @count.positive?
+    @from   = @count.zero? ? 0 : @offset + 1 - @outset
+    @to     = @count.zero? ? 0 : @offset + @items - @outset
+    @prev   = (@page - 1 unless @page == 1)
+    @next   = @page == @last ? (1 if @vars[:cycle]) : @page + 1
   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])
-    (series = []) and size.empty? and return series
-    4.times{|i| (size[i]>=0 rescue nil) or raise(VariableError.new(self), "expected 4 items >= 0 in :size; got #{size.inspect}")}
-    [*0..size[0], *@page-size[1]..@page+size[2], *@last-size[3]+1..@last+1].sort!.each_cons(2) do |a, b|
-      if    a<0 || a==b || a>@last                                        # skip out of range and duplicates
-      elsif a+1 == b; series.push(a)                                      # no gap     -> no additions
-      elsif a+2 == b; series.push(a, a+1)                                 # 1 page gap -> fill with missing page
-      else            series.push(a, :gap)                                # n page gap -> add gap
-      end                                                                 # skip the end boundary (last+1)
-    end                                                                   # shift the start boundary (0) and
-    series.shift; series[series.index(@page)] = @page.to_s; series        # convert the current page to String
+    return [] if size.empty?
+    raise VariableError.new(self), "expected 4 items >= 0 in :size; got #{size.inspect}" \
+          unless size.size == 4 && size.all?{ |num| !num.negative? rescue false }  # rubocop:disable Style/RescueModifier
+    # This algorithm is up to ~5x faster and ~2.3x lighter than the previous one (pagy < 4.3)
+    left_gap_start  =     1 + size[0]
+    left_gap_end    = @page - size[1] - 1
+    right_gap_start = @page + size[2] + 1
+    right_gap_end   = @last - size[3]
+    left_gap_end    = right_gap_end  if left_gap_end   > right_gap_end
+    right_gap_start = left_gap_start if left_gap_start > right_gap_start
+    series = []
+    start  = 1
+    if (left_gap_end - left_gap_start).positive?
+      series.push(*start..(left_gap_start - 1), :gap)
+      start = left_gap_end + 1
+    end
+    if (right_gap_end - right_gap_start).positive?
+      series.push(*start..(right_gap_start - 1), :gap)
+      start = right_gap_end + 1
+    end
+    series.push(*start..@last)
+    series[series.index(@page)] = @page.to_s
+    series
   end
 
 end

data/lib/pagy/backend.rb

@@ -1,5 +1,4 @@
 # See Pagy::Backend API documentation: https://ddnexus.github.io/pagy/api/backend
-# encoding: utf-8
 # frozen_string_literal: true
 
 class Pagy
@@ -8,12 +7,14 @@ class Pagy
 
   # See also the extras if you need specialized methods to paginate Arrays or other collections
 
-  module Backend ; private         # the whole module is private so no problem with including it in a controller
+
+  module Backend
+    private         # the whole module is private so no problem with including it in a controller
 
     # Return Pagy object and items
     def pagy(collection, vars={})
       pagy = Pagy.new(pagy_get_vars(collection, vars))
-      return pagy, pagy_get_items(collection, pagy)
+      [ pagy, pagy_get_items(collection, pagy) ]
     end
 
     # Sub-method called only by #pagy: here for easy customization of variables by overriding

data/lib/pagy/countless.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'pagy'
@@ -7,25 +6,29 @@ class Pagy
 
   class Countless < Pagy
 
+    INSTANCE_VARS_MIN = { items: 1, page: 1, outset: 0 }.freeze
+
     # Merge and validate the options, do some simple arithmetic and set a few instance variables
-    def initialize(vars={})
+    def initialize(vars={})  # rubocop:disable Lint/MissingSuper
       @vars = VARS.merge(vars.delete_if{|_,v| v.nil? || v == '' })      # default vars + cleaned vars (can be overridden)
-      { items:1, outset:0, page:1 }.each do |k,min|                     # validate instance variables
-        (@vars[k] && instance_variable_set(:"@#{k}", @vars[k].to_i) >= min) \
-         or raise(VariableError.new(self), "expected :#{k} >= #{min}; got #{@vars[k].inspect}")
+      INSTANCE_VARS_MIN.each do |k,min|                                 # validate instance variables
+        raise VariableError.new(self), "expected :#{k} >= #{min}; got #{@vars[k].inspect}" \
+              unless @vars[k] && instance_variable_set(:"@#{k}", @vars[k].to_i) >= min
       end
       @offset = @items * (@page - 1) + @outset                          # pagination offset + outset (initial offset)
     end
 
     # Finalize the instance variables based on the fetched items
     def finalize(fetched)
-      fetched == 0 && @page > 1 and raise(OverflowError.new(self), "page #{@page} got no items")
+      raise OverflowError.new(self), "page #{@page} got no items" \
+            if fetched.zero? && @page > 1
+
       @pages = @last = (fetched > @items ? @page + 1 : @page)         # set the @pages and @last
-      @items = fetched if fetched < @items && fetched > 0             # adjust items for last non-empty page
-      @from  = fetched == 0 ? 0 : @offset+1 - @outset                 # page begins from item
-      @to    = fetched == 0 ? 0 : @offset + @items - @outset          # page ends to item
+      @items = fetched if fetched < @items && fetched.positive?       # adjust items for last non-empty page
+      @from  = fetched.zero? ? 0 : @offset + 1 - @outset              # page begins from item
+      @to    = fetched.zero? ? 0 : @offset + @items - @outset         # page ends to item
       @prev  = (@page-1 unless @page == 1)                            # nil if no prev page
-      @next  = @page == @last ? (1 if @vars[:cycle]) : @page+1        # nil if no next page, 1 if :cycle
+      @next  = @page == @last ? (1 if @vars[:cycle]) : @page + 1      # nil if no next page, 1 if :cycle
       self
     end