pagy 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c5f4f4ffd2a294e465f0a026d9795c9ae8e5efe58b968a97df08fa9163bab28
-  data.tar.gz: 8dc70a9adb26aa4da11f42f1903478d62b3aaff7a17e0bd57163c4b340ffd91e
+  metadata.gz: a1345a70a6c730b386f155905f1f64821d0843704a378906cec76a27a68f77bc
+  data.tar.gz: b067a51f4178b84cf164374382b41e061e4d0e257819961abb2ef8d3e516c83d
 SHA512:
-  metadata.gz: c3b6c77ae8ec22c135f6acc127884a4fe334e811b310ffa464bacae46d842a57a1d3c98faac019935c14900fe78aff2aeb0ebf72fef82822bea8dee9fc1943eb
-  data.tar.gz: 43b8b9aa866735df4ac4cca43b22f04aaa5c08ef9140c3d6b04b4ed0e132681e40f0ef224111dc788c0e558d3b8ac3d5e283d5a42ad24abc4c152a452b5ed5c5
+  metadata.gz: 8aa6a995fff4c56eade45efb978ad63beb36f2ee10152dbf89365cf18d66911f89a7f84f36b35ce94b4228a286f18b6343a6c30c80434bd9ad6a12c177b47b3e
+  data.tar.gz: 4a9288306aff02bfc789a3198f38c02ed6b7d038d2caddf1eba1d3b4102e4f1f61c111eefd60c126c6a4f5c2e3b88dd745802732324d506bed8bbd118361027f

data/lib/config/pagy.rb

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

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

data/lib/pagy/countless.rb

@@ -16,8 +16,7 @@ class Pagy
 
     # Finalize the instance variables based on the fetched items
     def finalize(fetched)
-      raise OverflowError.new(self), "page #{@page} got no items" \
-            if fetched.zero? && @page > 1
+      raise OverflowError.new(self, :page, "to be < #{@page}") if fetched.zero? && @page > 1
 
       @pages = @last = (fetched > @items ? @page + 1 : @page)
       @in    = [fetched, @items].min
@@ -27,5 +26,9 @@ class Pagy
       @next  = @page == @last ? (1 if @vars[:cycle]) : @page + 1
       self
     end
+
+    def series(_size = @vars[:size])
+      super unless @vars[:countless_minimal]
+    end
   end
 end

data/lib/pagy/exceptions.rb

@@ -3,23 +3,24 @@
 class Pagy
   # Generic variable error
   class VariableError < ArgumentError
-    attr_reader :pagy
+    attr_reader :pagy, :variable, :value
 
-    def initialize(pagy)
-      super
-      @pagy = pagy
-    end
-
-    def variable
-      message =~ /expected :(\w+)/
-      Regexp.last_match(1)&.to_sym
-    end
-
-    def value
-      pagy.vars[variable]
+    def initialize(pagy, variable, description, value = nil)
+      @pagy     = pagy
+      @variable = variable
+      @value    = value
+      message   = +"expected :#{@variable} #{description}"
+      message  << "; got #{@value.inspect}" if value
+      super message
     end
   end
 
   # Specific overflow error
   class OverflowError < VariableError; end
+
+  # I18n configuration error
+  class I18nError < StandardError; end
+
+  # Generic internal error
+  class InternalError < StandardError; end
 end

data/lib/pagy/extras/bootstrap.rb

@@ -20,6 +20,7 @@ class Pagy
                   %(<li class="page-item active">#{link.call item}</li>)
                 when :gap
                   %(<li class="page-item gap disabled"><a href="#" class="page-link">#{pagy_t 'pagy.nav.gap'}</a></li>)
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_bootstrap_next_html(pagy, link)

data/lib/pagy/extras/bulma.rb

@@ -22,6 +22,7 @@ class Pagy
                                     %(class="pagination-link is-current" aria-label="page #{item}" aria-current="page")}</li>)
                 when :gap
                   %(<li><span class="pagination-ellipsis">#{pagy_t 'pagy.nav.gap'}</span></li>)
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << %(</ul></nav>)

data/lib/pagy/extras/foundation.rb

@@ -17,6 +17,7 @@ class Pagy
                 when Integer then %(<li>#{link.call item}</li>)                        # page link
                 when String  then %(<li class="current">#{item}</li>)                  # active page
                 when :gap    then %(<li class="ellipsis gap" aria-hidden="true"></li>) # page gap
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_foundation_next_html(pagy, link)

data/lib/pagy/extras/gearbox.rb

@@ -13,7 +13,7 @@ class Pagy
       return super if !@vars[:gearbox_extra] || @vars[:items_extra]
 
       gearbox_items = @vars[:gearbox_items]
-      raise VariableError.new(self), "expected :gearbox_items to be an Array of positives; got #{gearbox_items.inspect}" \
+      raise VariableError.new(self, :gearbox_items, 'to be an Array of positives', gearbox_items) \
             unless gearbox_items.is_a?(Array) && gearbox_items.all? { |num| num.positive? rescue false } # rubocop:disable Style/RescueModifier
 
       @items = gearbox_items[@page - 1] || gearbox_items.last

data/lib/pagy/extras/materialize.rb

@@ -17,6 +17,7 @@ class Pagy
                 when Integer then %(<li class="waves-effect">#{link.call item}</li>)                           # page link
                 when String  then %(<li class="active">#{link.call item}</li>)                                 # active page
                 when :gap    then %(<li class="gap disabled"><a href="#">#{pagy_t 'pagy.nav.gap'}</a></li>)    # page gap
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_materialize_next_html(pagy, link)

data/lib/pagy/extras/metadata.rb

@@ -4,44 +4,20 @@
 require 'pagy/url_helpers'
 
 class Pagy
+  DEFAULT[:metadata] = %i[ scaffold_url first_url prev_url page_url next_url last_url
+                           count page items vars pages last in from to prev next series ]
+
   # Add a specialized backend method for pagination metadata
   module MetadataExtra
     private
 
-    # Store the array of all the internal variable names usable as METADATA
-    METADATA = %i[ scaffold_url
-                   first_url
-                   prev_url
-                   page_url
-                   next_url
-                   last_url
-                   count page
-                   items
-                   vars
-                   pages
-                   last
-                   in
-                   from
-                   to
-                   prev
-                   next
-                   series ].tap { |m| m << :sequels if DEFAULT.key?(:steps) }.freeze
-
-    # Set the default metadata variable
-    Pagy::DEFAULT[:metadata] = METADATA.dup
-
     include UrlHelpers
 
     # Return the metadata hash
     def pagy_metadata(pagy, absolute: nil)
-      names   = pagy.vars[:metadata]
-      unknown = names - METADATA
-      raise VariableError.new(pagy), "expected :metadata to be in #{DEFAULT[:metadata].inspect}, got #{unknown.inspect} unknown" \
-            unless unknown.empty?
-
       scaffold_url = pagy_url_for(pagy, PAGE_PLACEHOLDER, absolute: absolute)
       {}.tap do |metadata|
-        names.each do |key|
+        pagy.vars[:metadata].each do |key|
           metadata[key] = case key
                           when :scaffold_url then scaffold_url
                           when :first_url    then scaffold_url.sub(PAGE_PLACEHOLDER, 1.to_s)
@@ -51,6 +27,8 @@ class Pagy
                           when :last_url     then scaffold_url.sub(PAGE_PLACEHOLDER, pagy.last.to_s)
                           else pagy.send(key)
                           end
+        rescue NoMethodError
+          raise VariableError.new(pagy, :metadata, 'to contain known keys', key)
         end
       end
     end

data/lib/pagy/extras/overflow.rb

@@ -31,8 +31,7 @@ class Pagy
           @prev = @last                             # prev relative to the actual page
           extend Series                             # special series for :empty_page
         else
-          raise VariableError.new(self), \
-                "expected :overflow to be in [:last_page, :empty_page, :exception]; got #{@vars[:overflow].inspect}"
+          raise VariableError.new(self, :overflow, 'to be in [:last_page, :empty_page, :exception]', @vars[:overflow])
         end
       end
 
@@ -63,8 +62,7 @@ class Pagy
           @vars[:size] = []                     # no page in the series
           self
         else
-          raise VariableError.new(self), \
-                "expected :overflow to be in [:empty_page, :exception]; got #{@vars[:overflow].inspect}"
+          raise VariableError.new(self, :overflow, 'to be in [:empty_page, :exception]', @vars[:overflow])
         end
       end
     end

data/lib/pagy/extras/semantic.rb

@@ -17,6 +17,7 @@ class Pagy
                 when Integer then link.call item                                                 # page link
                 when String  then %(<a class="item active">#{item}</a>)                          # current page
                 when :gap    then %(<div class="disabled item">#{pagy_t 'pagy.nav.gap'}</div>)   # page gap
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_semantic_next_html(pagy, link)

data/lib/pagy/extras/shared.rb

@@ -19,8 +19,7 @@ class Pagy
       # Notice: if :steps is false it will use the single {0 => @vars[:size]} size
       def sequels(steps = nil)
         steps ||= @vars[:steps] || { 0 => @vars[:size] }
-        raise VariableError.new(self), "expected :steps to define the 0 width; got #{steps.inspect}" \
-              unless steps.key?(0)
+        raise VariableError.new(self, :steps, 'to define the 0 width', steps) unless steps.key?(0)
 
         {}.tap do |sequels|
           steps.each { |width, size| sequels[width.to_s] = series(size) }

data/lib/pagy/extras/standalone.rb

@@ -40,7 +40,7 @@ class Pagy
       params[p_vars[:page_param].to_s]  = page
       params[p_vars[:items_param].to_s] = p_vars[:items] if defined?(ItemsExtra)
       # no Rack required in standalone mode
-      query_string = "?#{QueryUtils.build_nested_query(pagy_massage_params(params))}" unless params.empty?
+      query_string = "?#{QueryUtils.build_nested_query(pagy_massage_params(params))}"
       "#{url}#{query_string}#{p_vars[:fragment]}"
     end
   end

data/lib/pagy/extras/uikit.rb

@@ -16,6 +16,7 @@ class Pagy
                 when Integer then %(<li>#{link.call item}</li>)
                 when String  then %(<li class="uk-active"><span>#{item}</span></li>)
                 when :gap    then %(<li class="uk-disabled"><span>#{pagy_t 'pagy.nav.gap'}</span></li>)
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << pagy_uikit_next_html(pagy, link)

data/lib/pagy/frontend.rb

@@ -31,6 +31,7 @@ class Pagy
                 when Integer then %(<span class="page">#{link.call item}</span> )               # page link
                 when String  then %(<span class="page active">#{item}</span> )                  # current page
                 when :gap    then %(<span class="page gap">#{pagy_t('pagy.nav.gap')}</span> )   # page gap
+                else raise InternalError, "expected item types in series to be Integer, String or :gap; got #{item.inspect}"
                 end
       end
       html << if p_next

data/lib/pagy/i18n.rb

@@ -130,7 +130,7 @@ class Pagy
         locale[:filepath]  ||= Pagy.root.join('locales', "#{locale[:locale]}.yml")
         locale[:pluralize] ||= P11n::LOCALE[locale[:locale]]
         dictionary = YAML.safe_load(File.read(locale[:filepath], encoding: 'UTF-8'))
-        raise VariableError, %(expected :locale "#{locale[:locale]}" not found in :filepath "#{locale[:filepath].inspect}") \
+        raise I18nError, %(expected :locale "#{locale[:locale]}" not found in :filepath "#{locale[:filepath].inspect}") \
               unless dictionary.key?(locale[:locale])
 
         DATA[locale[:locale]] = [flatten(dictionary[locale[:locale]]), locale[:pluralize]]

data/lib/pagy/url_helpers.rb

@@ -10,7 +10,7 @@ class Pagy
       params[p_vars[:page_param].to_s]  = page
       params[p_vars[:items_param].to_s] = p_vars[:items] if defined?(ItemsExtra)
       # we rely on Rack by default: use the standalone extra in non rack environments
-      query_string = "?#{Rack::Utils.build_nested_query(pagy_massage_params(params))}" unless params.empty?
+      query_string = "?#{Rack::Utils.build_nested_query(pagy_massage_params(params))}"
       "#{request.base_url if absolute}#{request.path}#{query_string}#{p_vars[:fragment]}"
     end
 

data/lib/pagy.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 # Core class
 class Pagy
-  VERSION = '5.0.0'
+  VERSION = '5.0.1'
 
   # Root pathname to get the path of Pagy files like templates or dictionaries
   def self.root
@@ -32,8 +32,7 @@ class Pagy
     setup_vars(count: 0, page: 1, outset: 0)
     setup_items_var
     setup_pages_var
-    raise OverflowError.new(self), "expected :page in 1..#{@last}; got #{@page.inspect}" \
-          if @page > @last
+    raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
 
     @offset = (@items * (@page - 1)) + @outset
     @from   = [@offset - @outset + 1, @count].min
@@ -46,7 +45,7 @@ class Pagy
   # 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])
     return [] if size.empty?
-    raise VariableError.new(self), "expected 4 items >= 0 in :size; got #{size.inspect}" \
+    raise VariableError.new(self, :size, 'to contain 4 items >= 0', size) \
           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)
@@ -81,7 +80,7 @@ class Pagy
   # Setup and validates the passed vars: var must be present and value.to_i must be >= to min
   def setup_vars(name_min)
     name_min.each do |name, min|
-      raise VariableError.new(self), "expected :#{name} >= #{min}; got #{@vars[name].inspect}" \
+      raise VariableError.new(self, name, ">= #{min}", @vars[name]) \
             unless @vars[name] && instance_variable_set(:"@#{name}", @vars[name].to_i) >= min
     end
   end

metadata

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