pagy.rb in pagy-9.0.0

- old
+ new

@@ -1,51 +1,102 @@
 # See Pagy API documentation: https://ddnexus.github.io/pagy/docs/api/pagy
 # frozen_string_literal: true
 
 require 'pathname'
 
-# Core class
+# Top superclass: it should define only what's common to all the subclasses
 class Pagy
-  VERSION = '8.6.3'
+  VERSION = '9.0.0'
 
+  # Core default: constant for easy access, but mutable for customizable defaults
+  DEFAULT = { count_args: [:all], # rubocop:disable Style/MutableConstant
+              ends:       true,
+              limit:      20,
+              outset:     0,
+              page:       1,
+              page_param: :page,
+              size:       7 }  # AR friendly
+
   # Gem root pathname to get the path of Pagy files stylesheets, javascripts, apps, locales, etc.
   def self.root
     @root ||= Pathname.new(__dir__).parent.freeze
   end
 
-  # Core default: constant for easy access, but mutable for customizable defaults
-  DEFAULT = { page:       1, # rubocop:disable Style/MutableConstant
-              items:      20,
-              outset:     0,
-              size:       7,
-              ends:       true,
-              count_args: [:all],  # AR friendly
-              page_param: :page }
+  # Shared with Keyset
+  module SharedMethods
+    attr_reader :page, :limit, :vars
 
-  attr_reader :count, :page, :items, :vars, :last, :offset, :in, :from, :to, :prev, :next
+    # Validates and assign the passed vars: var must be present and value.to_i must be >= to min
+    def assign_and_check(name_min)
+      name_min.each do |name, min|
+        raise VariableError.new(self, name, ">= #{min}", @vars[name]) \
+              unless @vars[name]&.respond_to?(:to_i) && \
+                     instance_variable_set(:"@#{name}", @vars[name].to_i) >= min
+      end
+    end
+
+    # Assign @limit (overridden by the gearbox extra)
+    def assign_limit
+      assign_and_check(limit: 1)
+    end
+
+    # Assign @vars
+    def assign_vars(default, vars)
+      @vars = { **default, **vars.delete_if { |k, v| default.key?(k) && (v.nil? || v == '') } }
+    end
+  end
+  include SharedMethods
+
+  attr_reader :count, :from, :in, :last, :next, :offset, :prev, :to
   alias pages last
 
   # Merge and validate the options, do some simple arithmetic and set the instance variables
-  def initialize(vars)
-    normalize_vars(vars)
-    setup_vars(count: 0, page: 1, outset: 0)
-    setup_items_var
-    setup_offset_var
-    setup_last_var
-    raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
-
+  def initialize(**vars)
+    assign_vars(DEFAULT, vars)
+    assign_and_check(count: 0, page: 1, outset: 0)
+    assign_limit
+    assign_offset
+    assign_last
+    check_overflow
     @from = [@offset - @outset + 1, @count].min
-    @to   = [@offset - @outset + @items, @count].min
+    @to   = [@offset - @outset + @limit, @count].min
     @in   = [@to - @from + 1, @count].min
+    assign_prev_and_next
+  end
+
+  # Setup @last (overridden by the gearbox extra)
+  def assign_last
+    @last = [(@count.to_f / @limit).ceil, 1].max
+    @last = @vars[:max_pages] if @vars[:max_pages] && @last > vars[:max_pages]
+  end
+
+  # Assign @offset (overridden by the gearbox extra)
+  def assign_offset
+    @offset = (@limit * (@page - 1)) + @outset  # may be already set from gear_box
+  end
+
+  # Assign @prev and @next
+  def assign_prev_and_next
     @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, 8, "9", 10, :gap, 36]
+  # Checks the @page <= @last
+  def check_overflow
+    raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
+  end
+
+  # Label for the current page. Allow the customization of the output (overridden by the calendar extra)
+  def label = @page.to_s
+
+  # Label for any page. Allow the customization of the output (overridden by the calendar extra)
+  def label_for(page) = page.to_s
+
+  # Return the array of page numbers and :gap e.g. [1, :gap, 8, "9", 10, :gap, 36]
   def series(size: @vars[:size], **_)
     raise VariableError.new(self, :size, 'to be an Integer >= 0', size) \
-          unless size.is_a?(Integer) && size >= 0
+    unless size.is_a?(Integer) && size >= 0
     return [] if size.zero?
 
     [].tap do |series|
       if size >= @last
         series.push(*1..@last)
@@ -68,53 +119,10 @@
         end
       end
       series[series.index(@page)] = @page.to_s
     end
   end
-
-  # Label for any page. Allow the customization of the output (overridden by the calendar extra)
-  def label_for(page)
-    page.to_s
-  end
-
-  # Label for the current page. Allow the customization of the output (overridden by the calendar extra)
-  def label
-    @page.to_s
-  end
-
-  protected
-
-  # Apply defaults, cleanup blanks and set @vars
-  def normalize_vars(vars)
-    @vars = DEFAULT.merge(vars.delete_if { |k, v| DEFAULT.key?(k) && (v.nil? || v == '') })
-  end
-
-  # 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, name, ">= #{min}", @vars[name]) \
-            unless @vars[name]&.respond_to?(:to_i) && instance_variable_set(:"@#{name}", @vars[name].to_i) >= min
-    end
-  end
-
-  # Setup @items (overridden by the gearbox extra)
-  def setup_items_var
-    setup_vars(items: 1)
-  end
-
-  # Setup @offset (overridden by the gearbox extra)
-  def setup_offset_var
-    @offset = (@items * (@page - 1)) + @outset  # may be already set from gear_box
-  end
-
-  # Setup @last (overridden by the gearbox extra)
-  def setup_last_var
-    @last = [(@count.to_f / @items).ceil, 1].max
-    @last = vars[:max_pages] if vars[:max_pages] && @last > vars[:max_pages]
-  end
-  alias setup_pages_var setup_last_var
 end
 
-require_relative 'pagy/extras/size' # will be opt in in v9.0
 require_relative 'pagy/backend'
 require_relative 'pagy/frontend'
 require_relative 'pagy/exceptions'