pagy 8.4.0 → 9.0.0

data/javascripts/pagy.mjs

@@ -0,0 +1,100 @@
+const Pagy = (() => {
+  const rjsObserver = new ResizeObserver((entries) => entries.forEach((e) => e.target.querySelectorAll(".pagy-rjs").forEach((el) => el.pagyRender())));
+  const initNav = (el, [tokens, sequels, labelSequels, trimParam]) => {
+    const container = el.parentElement ?? el;
+    const widths = Object.keys(sequels).map((w) => parseInt(w)).sort((a, b) => b - a);
+    let lastWidth = -1;
+    const fillIn = (a, page, label) => a.replace(/__pagy_page__/g, page).replace(/__pagy_label__/g, label);
+    (el.pagyRender = function() {
+      const width = widths.find((w) => w < container.clientWidth) || 0;
+      if (width === lastWidth) {
+        return;
+      }
+      let html = tokens.before;
+      const series = sequels[width.toString()];
+      const labels = labelSequels?.[width.toString()] ?? series.map((l) => l.toString());
+      series.forEach((item, i) => {
+        const label = labels[i];
+        let filled;
+        if (typeof item === "number") {
+          filled = fillIn(tokens.a, item.toString(), label);
+        } else if (item === "gap") {
+          filled = tokens.gap;
+        } else {
+          filled = fillIn(tokens.current, item, label);
+        }
+        html += typeof trimParam === "string" && item == 1 ? trim(filled, trimParam) : filled;
+      });
+      html += tokens.after;
+      el.innerHTML = "";
+      el.insertAdjacentHTML("afterbegin", html);
+      lastWidth = width;
+    })();
+    if (el.classList.contains("pagy-rjs")) {
+      rjsObserver.observe(container);
+    }
+  };
+  const initCombo = (el, [url_token, trimParam]) => initInput(el, (inputValue) => [inputValue, url_token.replace(/__pagy_page__/, inputValue)], trimParam);
+  const initSelector = (el, [from, url_token, trimParam]) => {
+    initInput(el, (inputValue) => {
+      const page = Math.max(Math.ceil(from / parseInt(inputValue)), 1).toString();
+      const url = url_token.replace(/__pagy_page__/, page).replace(/__pagy_limit__/, inputValue);
+      return [page, url];
+    }, trimParam);
+  };
+  const initInput = (el, getVars, trimParam) => {
+    const input = el.querySelector("input");
+    const link = el.querySelector("a");
+    const initial = input.value;
+    const action = function() {
+      if (input.value === initial) {
+        return;
+      }
+      const [min, val, max] = [input.min, input.value, input.max].map((n) => parseInt(n) || 0);
+      if (val < min || val > max) {
+        input.value = initial;
+        input.select();
+        return;
+      }
+      let [page, url] = getVars(input.value);
+      if (typeof trimParam === "string" && page === "1") {
+        url = trim(url, trimParam);
+      }
+      link.href = url;
+      link.click();
+    };
+    ["change", "focus"].forEach((e) => input.addEventListener(e, () => input.select()));
+    input.addEventListener("focusout", action);
+    input.addEventListener("keypress", (e) => {
+      if (e.key === "Enter") {
+        action();
+      }
+    });
+  };
+  const trim = (a, param) => a.replace(new RegExp(`[?&]${param}=1\\b(?!&)|\\b${param}=1&`), "");
+  return {
+    version: "9.0.0",
+    init(arg) {
+      const target = arg instanceof Element ? arg : document;
+      const elements = target.querySelectorAll("[data-pagy]");
+      for (const el of elements) {
+        try {
+          const uint8array = Uint8Array.from(atob(el.getAttribute("data-pagy")), (c) => c.charCodeAt(0));
+          const [keyword, ...args] = JSON.parse(new TextDecoder().decode(uint8array));
+          if (keyword === "nav") {
+            initNav(el, args);
+          } else if (keyword === "combo") {
+            initCombo(el, args);
+          } else if (keyword === "selector") {
+            initSelector(el, args);
+          } else {
+            console.warn("Skipped Pagy.init() for: %o\nUnknown keyword '%s'", el, keyword);
+          }
+        } catch (err) {
+          console.warn("Skipped Pagy.init() for: %o\n%s", el, err);
+        }
+      }
+    }
+  };
+})();
+export default Pagy;

data/lib/optimist.rb

@@ -137,7 +137,7 @@ module Optimist
     ## There's one ambiguous case to be aware of: when +:multi+: is true and a
     ## +:default+ is set to an array (of something), it's ambiguous whether this
     ## is a multi-value argument as well as a multi-occurrence argument.
-    ## In thise case, Optimist assumes that it's not a multi-value argument.
+    ## In this case, Optimist assumes that it's not a multi-value argument.
     ## If you want a multi-value, multi-occurrence argument with a default
     ## value, you must specify +:type+ as well.
 

data/lib/pagy/b64.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  # Cheap Base64 specialized methods to avoid dependencies
+  module B64
+    module_function
+
+    def encode(bin)
+      [bin].pack('m0')
+    end
+
+    def decode(str)
+      str.unpack1('m0')
+    end
+
+    def urlsafe_encode(bin)
+      str = encode(bin)
+      str.chomp!('==') or str.chomp!('=')
+      str.tr!('+/', '-_')
+      str
+    end
+
+    def urlsafe_decode(str)
+      if !str.end_with?('=') && str.length % 4 != 0
+        str = str.ljust((str.length + 3) & ~3, '=')
+        str.tr!('-_', '+/')
+      else
+        str = str.tr('-_', '+/')
+      end
+      decode(str)
+    end
+  end
+end

data/lib/pagy/backend.rb

@@ -8,37 +8,41 @@ class Pagy
   module Backend
     private
 
-    # Return Pagy object and paginated items/results
-    def pagy(collection, vars = {})
-      pagy = Pagy.new(pagy_get_vars(collection, vars))
+    # Return Pagy object and paginated results
+    def pagy(collection, **vars)
+      pagy = Pagy.new(**pagy_get_vars(collection, vars))
       [pagy, pagy_get_items(collection, pagy)]
     end
 
-    # Sub-method called only by #pagy: here for easy customization of variables by overriding
-    # You may need to override the count call for non AR collections
-    def pagy_get_vars(collection, vars)
-      pagy_set_items_from_params(vars) if defined?(ItemsExtra)
-      vars[:count] ||= pagy_get_count(collection, vars)
-      vars[:page]  ||= pagy_get_page(vars)
-      vars
-    end
-
     # Get the count from the collection
     def pagy_get_count(collection, vars)
       count_args = vars[:count_args] || DEFAULT[:count_args]
       (count     = collection.count(*count_args)).is_a?(Hash) ? count.size : count
     end
 
+    # Sub-method called only by #pagy: here for easy customization of fetching by overriding
+    # You may need to override this method for collections without offset|limit
+    def pagy_get_items(collection, pagy)
+      collection.offset(pagy.offset).limit(pagy.limit)
+    end
+
+    # Override for limit extra
+    def pagy_get_limit(vars); end
+
     # Get the page integer from the params
     # Overridable by the jsonapi extra
     def pagy_get_page(vars)
-      [params[vars[:page_param] || DEFAULT[:page_param]].to_i, 1].max
+      params[vars[:page_param] || DEFAULT[:page_param]]
     end
 
-    # Sub-method called only by #pagy: here for easy customization of record-extraction by overriding
-    # You may need to override this method for collections without offset|limit
-    def pagy_get_items(collection, pagy)
-      collection.offset(pagy.offset).limit(pagy.in)
+    # Sub-method called only by #pagy: here for easy customization of variables by overriding
+    # You may need to override the count call for non AR collections
+    def pagy_get_vars(collection, vars)
+      vars.tap do |v|
+        v[:count] ||= pagy_get_count(collection, v)
+        v[:limit] ||= pagy_get_limit(v)
+        v[:page]  ||= pagy_get_page(v)
+      end
     end
   end
 end

data/lib/pagy/calendar/day.rb

@@ -3,16 +3,17 @@
 
 class Pagy # :nodoc:
   class Calendar # :nodoc:
-    # Calendar day subclass
-    class Day < Calendar
+    # Day unit subclass
+    class Day < Unit
       DEFAULT = { size:   31,   # rubocop:disable Style/MutableConstant
+                  ends: false,
                   order:  :asc,
                   format: '%d' }
 
       protected
 
       # Setup the calendar variables
-      def setup_unit_vars
+      def assign_unit_vars
         super
         @initial = @starting.beginning_of_day
         @final   = @ending.tomorrow.beginning_of_day

data/lib/pagy/calendar/month.rb

@@ -3,16 +3,17 @@
 
 class Pagy # :nodoc:
   class Calendar # :nodoc:
-    # Calendar month subclass
-    class Month < Calendar
+    # Month unit subclass
+    class Month < Unit
       DEFAULT = { size: 12,   # rubocop:disable Style/MutableConstant
+                  ends: false,
                   order: :asc,
                   format: '%b' }
 
       protected
 
       # Setup the calendar variables
-      def setup_unit_vars
+      def assign_unit_vars
         super
         @initial = @starting.beginning_of_month
         @final   = @ending.next_month.beginning_of_month

data/lib/pagy/calendar/quarter.rb

@@ -3,9 +3,10 @@
 
 class Pagy # :nodoc:
   class Calendar # :nodoc:
-    # Calendar quarter subclass
-    class Quarter < Calendar
+    # Quarter unit subclass
+    class Quarter < Unit
       DEFAULT = { size:   4,      # rubocop:disable Style/MutableConstant
+                  ends: false,
                   order:  :asc,
                   format: 'Q%q' } # '%q' token
 
@@ -19,7 +20,7 @@ class Pagy # :nodoc:
       protected
 
       # Setup the calendar variables
-      def setup_unit_vars
+      def assign_unit_vars
         super
         @initial = @starting.beginning_of_quarter
         @final   = @ending.next_quarter.beginning_of_quarter

data/lib/pagy/calendar/unit.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/time'
+require 'active_support/core_ext/date_and_time/calculations'
+require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/integer/time'
+
+class Pagy # :nodoc:
+  class Calendar < Hash # :nodoc:
+    # Base class for time units subclasses (Year, Quarter, Month, Week, Day)
+    class Unit < Pagy
+      attr_reader :order, :from, :to
+
+      # Merge and validate the options, do some simple arithmetic and set a few instance variables
+      def initialize(**vars)    # rubocop:disable Lint/MissingSuper
+        raise InternalError, 'Pagy::Calendar::Unit is a base class; use one of its subclasses' \
+            if instance_of?(Pagy::Calendar::Unit)
+
+        assign_vars({ **Pagy::DEFAULT, **self.class::DEFAULT }, vars)
+        assign_and_check(page: 1)
+        assign_unit_vars
+        check_overflow
+        assign_prev_and_next
+      end
+
+      # The label for the current page (it can pass along the I18n gem opts when it's used with the i18n extra)
+      def label(opts = {})
+        label_for(@page, opts)
+      end
+
+      # The label for any page (it can pass along the I18n gem opts when it's used with the i18n extra)
+      def label_for(page, opts = {})
+        opts[:format] ||= @vars[:format]
+        localize(starting_time_for(page.to_i), opts)  # page could be a string
+      end
+
+      protected
+
+      # The page that includes time
+      # In case of out of range time, the :fit_time option avoids the outOfRangeError
+      # and returns the closest page to the passed time argument (first or last page)
+      def page_at(time, **opts)
+        fit_time  = time
+        fit_final = @final - 1
+        unless time.between?(@initial, fit_final)
+          raise OutOfRangeError.new(self, :time, "between #{@initial} and #{fit_final}", time) unless opts[:fit_time]
+
+          if time < @final
+            fit_time = @initial
+            ordinal  = 'first'
+          else
+            fit_time = fit_final
+            ordinal  = 'last'
+          end
+          warn "Pagy::Calendar#page_at: Rescued #{time} out of range by returning the #{ordinal} page."
+        end
+        offset = page_offset_at(fit_time)   # offset starts from 0
+        @order == :asc ? offset + 1 : @last - offset
+      end
+
+      # Base class method for the setup of the unit variables (subclasses must implement it and call super)
+      def assign_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) \
+        unless %i[asc desc].include?(@order = @vars[:order])
+
+        @starting, @ending = @vars[:period]
+        raise VariableError.new(self, :period, 'to be a an Array of min and max TimeWithZone instances', @vars[:period]) \
+        unless @starting.is_a?(ActiveSupport::TimeWithZone) \
+        && @ending.is_a?(ActiveSupport::TimeWithZone) && @starting <= @ending
+      end
+
+      # Apply the strftime format to the time (overridden by the i18n extra when localization is required)
+      def localize(time, opts)
+        time.strftime(opts[:format])
+      end
+
+      # Number of time units to offset from the @initial time, in order to get the ordered starting time for the page.
+      # Used in starting_time_for(page) where page starts from 1 (e.g. page to starting_time means subtracting 1)
+      def time_offset_for(page)
+        @order == :asc ? page - 1 : @last - page
+      end
+
+      # Period of the active page (used internally for nested units)
+      def active_period
+        [[@starting, @from].max, [@to - 1, @ending].min] # -1 sec: include only last unit day
+      end
+
+      # :nocov:
+      # This method must be implemented by the unit subclass
+      def starting_time_for(*)
+        raise NoMethodError, 'the starting_time_for method must be implemented by the unit subclass'
+      end
+
+      # This method must be implemented by the unit subclass
+      def page_offset_at(*)
+        raise NoMethodError, 'the page_offset_at method must be implemented by the unit subclass'
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/pagy/calendar/week.rb

@@ -3,15 +3,15 @@
 
 class Pagy # :nodoc:
   class Calendar # :nodoc:
-    # Calendar week subclass
-    class Week < Calendar
+    # Week unit subclass
+    class Week < Unit
       DEFAULT  = { order:  :asc,      # rubocop:disable Style/MutableConstant
                    format: '%Y-%W' }
 
       protected
 
       # Setup the calendar variables
-      def setup_unit_vars
+      def assign_unit_vars
         super
         @initial = @starting.beginning_of_week
         @final   = @ending.next_week.beginning_of_week

data/lib/pagy/calendar/year.rb

@@ -3,16 +3,17 @@
 
 class Pagy # :nodoc:
   class Calendar # :nodoc:
-    # Calendar year subclass
-    class Year < Calendar
+    # Year unit subclass
+    class Year < Unit
       DEFAULT = { size:   10,   # rubocop:disable Style/MutableConstant
+                  ends: false,
                   order:  :asc,
                   format: '%Y' }
 
       protected
 
       # Setup the calendar variables
-      def setup_unit_vars
+      def assign_unit_vars
         super
         @initial = @starting.beginning_of_year
         @final   = @ending.next_year.beginning_of_year

data/lib/pagy/calendar.rb

@@ -1,122 +1,79 @@
 # See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/calendar
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext/time'
-require 'active_support/core_ext/date_and_time/calculations'
-require 'active_support/core_ext/numeric/time'
-require 'active_support/core_ext/integer/time'
-
 require_relative '../pagy'
+require_relative 'calendar/unit'
 
 class Pagy # :nodoc:
-  # Base class for time units subclasses (Year, Quarter, Month, Week, Day)
-  class Calendar < Pagy
+  # Calendar class
+  class Calendar < Hash
     # Specific out of range error
     class OutOfRangeError < VariableError; end
 
     # List of units in desc order of duration. It can be used for custom units.
     UNITS = %i[year quarter month week day]  # rubocop:disable Style/MutableConstant
 
-    attr_reader :order, :from, :to
-
-    # Merge and validate the options, do some simple arithmetic and set a few instance variables
-    def initialize(vars) # rubocop:disable Lint/MissingSuper
-      raise InternalError, 'Pagy::Calendar is a base class; use one of its subclasses' if instance_of?(Pagy::Calendar)
-
-      vars = self.class::DEFAULT.merge(vars)  # subclass specific default
-      normalize_vars(vars)                    # general default
-      setup_vars(page: 1)
-      setup_unit_vars
-      raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
-
-      @prev = (@page - 1 unless @page == 1)
-      @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
-    end
-
-    # The label for the current page (it can pass along the I18n gem opts when it's used with the i18n extra)
-    def label(opts = {})
-      label_for(@page, opts)
-    end
-
-    # The label for any page (it can pass along the I18n gem opts when it's used with the i18n extra)
-    def label_for(page, opts = {})
-      opts[:format] ||= @vars[:format]
-      localize(starting_time_for(page.to_i), opts)  # page could be a string
-    end
-
-    protected
+    class << self
+      private
 
-    # The page that includes time
-    # In case of out of range time, the :fit_time option avoids the outOfRangeError
-    # and returns the closest page to the passed time argument (first or last page)
-    def page_at(time, **opts)
-      fit_time  = time
-      fit_final = @final - 1
-      unless time.between?(@initial, fit_final)
-        raise OutOfRangeError.new(self, :time, "between #{@initial} and #{fit_final}", time) unless opts[:fit_time]
+      # Create a unit subclass instance by using the unit name (internal use)
+      def create(unit, **vars)
+        raise InternalError, "unit must be in #{UNITS.inspect}; got #{unit}" unless UNITS.include?(unit)
 
-        if time < @final
-          fit_time = @initial
-          ordinal  = 'first'
-        else
-          fit_time = fit_final
-          ordinal  = 'last'
-        end
-        Warning.warn "Pagy::Calendar#page_at: Rescued #{time} out of range by returning the #{ordinal} page."
+        name    = unit.to_s
+        name[0] = name[0].capitalize
+        Object.const_get("Pagy::Calendar::#{name}").new(**vars)
       end
-      offset = page_offset_at(fit_time)   # offset starts from 0
-      @order == :asc ? offset + 1 : @last - offset
-    end
 
-    # 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) \
-            unless %i[asc desc].include?(@order = @vars[:order])
-
-      @starting, @ending = @vars[:period]
-      raise VariableError.new(self, :period, 'to be a an Array of min and max TimeWithZone instances', @vars[:period]) \
-            unless @starting.is_a?(ActiveSupport::TimeWithZone) \
-                && @ending.is_a?(ActiveSupport::TimeWithZone) && @starting <= @ending
-    end
-
-    # Apply the strftime format to the time (overridden by the i18n extra when localization is required)
-    def localize(time, opts)
-      time.strftime(opts[:format])
-    end
-
-    # Number of time units to offset from the @initial time, in order to get the ordered starting time for the page.
-    # Used in starting_time_for(page) where page starts from 1 (e.g. page to starting_time means subtracting 1)
-    def time_offset_for(page)
-      @order == :asc ? page - 1 : @last - page
-    end
-
-    # Period of the active page (used internally for nested units)
-    def active_period
-      [[@starting, @from].max, [@to - 1, @ending].min] # -1 sec: include only last unit day
+      # Return calendar, from, to
+      def init(conf, period, params)
+        new.send(:init, conf, period, params)
+      end
     end
 
-    # :nocov:
-    # This method must be implemented by the unit subclass
-    def starting_time_for(*)
-      raise NoMethodError, 'the starting_time_for method must be implemented by the unit subclass'
+    # Return the current time of the smallest time unit shown
+    def showtime
+      self[@units.last].from
     end
 
-    # This method must be implemented by the unit subclass
-    def page_offset_at(*)
-      raise NoMethodError, 'the page_offset_at method must be implemented by the unit subclass'
+    private
+
+    # Create the calendar
+    def init(conf, period, params)
+      @conf  = Marshal.load(Marshal.dump(conf))  # store a copy
+      @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?
+
+      @period     = period
+      @params     = params
+      @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}"
+        conf[unit][:page_param] = unit_page_param
+        conf[unit][:page]       = @params[unit_page_param]
+      end
+      calendar = {}
+      object   = nil
+      @units.each_with_index do |unit, index|
+        params_to_delete    = @units[(index + 1), @units.size].map { |sub| conf[sub][:page_param] } + [@page_param]
+        conf[unit][:params] = lambda { |up| up.except(*params_to_delete.map(&:to_s)) } # rubocop:disable Style/Lambda
+        conf[unit][:period] = object&.send(:active_period) || @period
+        calendar[unit]      = object = Calendar.send(:create, unit, **conf[unit])
+      end
+      [replace(calendar), object.from, object.to]
     end
-    # :nocov:
 
-    class << self
-      # Create a subclass instance by unit name (internal use)
-      def create(unit, vars)
-        raise InternalError, "unit must be in #{UNITS.inspect}; got #{unit}" unless UNITS.include?(unit)
-
-        name    = unit.to_s
-        name[0] = name[0].capitalize
-        Object.const_get("Pagy::Calendar::#{name}").new(vars)
+    # Return the calendar object at time
+    def calendar_at(time, **opts)
+      conf        = Marshal.load(Marshal.dump(@conf))
+      page_params = {}
+      @units.inject(nil) do |object, unit|
+        conf[unit][:period] = object&.send(:active_period) || @period
+        conf[unit][:page]   = page_params[:"#{unit}_#{@page_param}"] \
+                            = Calendar.send(:create, unit, **conf[unit]).send(:page_at, time, **opts)
+        conf[unit][:params] ||= {}
+        conf[unit][:params].merge!(page_params)
+        Calendar.send(:create, unit, **conf[unit])
       end
     end
   end

data/lib/pagy/countless.rb

@@ -1,39 +1,38 @@
 # See Pagy::Countless API documentation: https://ddnexus.github.io/pagy/docs/api/countless
 # frozen_string_literal: true
 
-require_relative '../pagy'
-
-class Pagy
+class Pagy # :nodoc:
   # No need to know the count to paginate
   class Countless < Pagy
     # Merge and validate the options, do some simple arithmetic and set a few instance variables
-    def initialize(vars = {}) # rubocop:disable Lint/MissingSuper
-      normalize_vars(vars)
-      setup_vars(page: 1, outset: 0)
-      setup_items_var
-      setup_offset_var
+    def initialize(**vars) # rubocop:disable Lint/MissingSuper
+      assign_vars(DEFAULT, vars)
+      assign_and_check(page: 1, outset: 0)
+      assign_limit
+      assign_offset
     end
 
     # Finalize the instance variables based on the fetched size
     def finalize(fetched_size)
       raise OverflowError.new(self, :page, "to be < #{@page}", @page) if fetched_size.zero? && @page > 1
 
-      @last = fetched_size > @items ? @page + 1 : @page
-      @last = vars[:max_pages] if vars[:max_pages] && @last > vars[:max_pages]
-      raise OverflowError.new(self, :page, "in 1..#{@last}", @page) if @page > @last
-
-      @in   = [fetched_size, @items].min
+      @last = fetched_size > @limit ? @page + 1 : @page
+      @last = @vars[:max_pages] if @vars[:max_pages] && @last > @vars[:max_pages]
+      check_overflow
+      @in   = [fetched_size, @limit].min
       @from = @in.zero? ? 0 : @offset - @outset + 1
       @to   = @offset - @outset + @in
-      @prev = (@page - 1 unless @page == 1)
-      @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
+      assign_prev_and_next
       self
     end
+  end
 
+  module SeriesOverride # :nodoc:
     # Override the original series.
     # Return nil if :countless_minimal is enabled
-    def series(*, **)
+    def series(**)
       super unless @vars[:countless_minimal]
     end
   end
+  prepend SeriesOverride
 end