pagy 8.4.5 → 8.6.1

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

@@ -3,7 +3,7 @@
 
 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
@@ -29,11 +29,14 @@ class Pagy
       @next = @page == @last ? (1 if @vars[:cycle]) : @page + 1
       self
     end
+  end
 
+  module SeriesOverride # :nodoc:
     # Override the original series.
     # Return nil if :countless_minimal is enabled
     def series(*, **)
       super unless @vars[:countless_minimal]
     end
   end
+  prepend SeriesOverride
 end

data/lib/pagy/extras/calendar.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require_relative '../calendar'
-require_relative '../calendar/helper'
 
 class Pagy # :nodoc:
   # Add pagination filtering by calendar unit (:year, :quarter, :month, :week, :day) to the regular pagination
@@ -20,8 +19,13 @@ class Pagy # :nodoc:
 
         conf[:pagy] ||= {}
         unless conf.key?(:active) && !conf[:active]
-          calendar, from, to = Calendar::Helper.send(:init, conf, pagy_calendar_period(collection), params)
-          collection         = pagy_calendar_filter(collection, from, to)
+          calendar, from, to = Calendar.send(:init, conf, pagy_calendar_period(collection), params)
+          if respond_to?(:pagy_calendar_counts)
+            calendar.each_key do |unit|
+              calendar[unit].vars[:counts] = pagy_calendar_counts(collection, unit, *calendar[unit].vars[:period])
+            end
+          end
+          collection = pagy_calendar_filter(collection, from, to)
         end
         pagy, results = send(conf[:pagy][:backend] || :pagy, collection, conf[:pagy])  # use backend: :pagy when omitted
         [calendar, pagy, results]
@@ -40,6 +44,32 @@ class Pagy # :nodoc:
       end
     end
 
+    # Override the pagy_anchor
+    module FrontendOverride
+      # Consider the vars[:count]
+      def pagy_anchor(pagy)
+        return super unless (counts = pagy.vars[:counts])
+
+        a_string    = pagy.vars[:anchor_string]
+        a_string    = %( #{a_string}) if a_string
+        left, right = %(<a#{a_string} href="#{pagy_url_for(pagy, PAGE_TOKEN)}").split(PAGE_TOKEN, 2)
+        # lambda used by all the helpers
+        lambda do |page, text = pagy.label_for(page), classes: nil, aria_label: nil|
+          count     = counts[page - 1]
+          item_name = pagy_t('pagy.item_name', count:)
+          if count.zero?
+            classes = "#{classes && (classes + ' ')}empty-page"
+            title   = %( title="#{pagy_t('pagy.info.no_items', item_name:, count:)}")
+          else
+            title   = %( title="#{pagy_t('pagy.info.single_page', item_name:, count:)}")
+          end
+          classes    = %( class="#{classes}") if classes
+          aria_label = %( aria-label="#{aria_label}") if aria_label
+          %(#{left}#{page}#{right}#{title}#{classes}#{aria_label}>#{text}</a>)
+        end
+      end
+    end
+
     # Additions for the Frontend module
     module UrlHelperAddOn
       # Return the url for the calendar page at time
@@ -49,5 +79,5 @@ class Pagy # :nodoc:
     end
   end
   Backend.prepend CalendarExtra::BackendAddOn, CalendarExtra::UrlHelperAddOn
-  Frontend.prepend CalendarExtra::UrlHelperAddOn
+  Frontend.prepend CalendarExtra::UrlHelperAddOn, CalendarExtra::FrontendOverride
 end

data/lib/pagy/extras/i18n.rb

@@ -19,7 +19,7 @@ class Pagy # :nodoc:
       end
     end
   end
-  Calendar.prepend I18nExtra::CalendarOverride if defined?(Calendar)
+  Calendar::Unit.prepend I18nExtra::CalendarOverride if defined?(Calendar::Unit)
 
   # Add the pagy locales to the I18n.load_path
   ::I18n.load_path += Dir[Pagy.root.join('locales', '*.yml')]

data/lib/pagy/extras/js_tools.rb

@@ -42,7 +42,7 @@ class Pagy # :nodoc:
         end
       end
     end
-    Calendar.prepend CalendarOverride if defined?(Calendar)
+    Calendar::Unit.prepend CalendarOverride if defined?(Calendar::Unit)
 
     # Additions for the Frontend
     module FrontendAddOn

data/lib/pagy/extras/metadata.rb

@@ -17,7 +17,11 @@ class Pagy # :nodoc:
     def pagy_metadata(pagy, absolute: nil)
       scaffold_url = pagy_url_for(pagy, PAGE_TOKEN, absolute:)
       {}.tap do |metadata|
-        keys = defined?(Calendar) && pagy.is_a?(Calendar) ? pagy.vars[:metadata] - %i[count items] : pagy.vars[:metadata]
+        keys = if defined?(Calendar::Unit) && pagy.is_a?(Calendar::Unit)
+                 pagy.vars[:metadata] - %i[count items]
+               else
+                 pagy.vars[:metadata]
+               end
         keys.each do |key|
           metadata[key] = case key
                           when :scaffold_url then scaffold_url

data/lib/pagy/extras/overflow.rb

@@ -28,7 +28,8 @@ class Pagy # :nodoc:
           @vars[:page] = requested_page                # restore the requested page
         when :empty_page
           @offset = @items = @in = @from = @to = 0     # vars relative to the actual page
-          if defined?(Calendar) && is_a?(Calendar)     # only for Calendar instances
+          if defined?(Calendar::Unit) \
+              && is_a?(Calendar::Unit)                 # only for Calendar::Units instances
             edge = @order == :asc ? @final : @initial  # get the edge of the overflow side (neat, but any time would do)
             @from = @to = edge                         # set both to the edge utc time (a >=&&< query will get no records)
           end
@@ -51,7 +52,7 @@ class Pagy # :nodoc:
       end
     end
     Pagy.prepend PagyOverride
-    Pagy::Calendar.prepend PagyOverride if defined?(Calendar)
+    Pagy::Calendar::Unit.prepend PagyOverride if defined?(Calendar::Unit)
 
     # Support for Pagy::Countless class
     module CountlessOverride

data/lib/pagy/extras/size.rb

@@ -0,0 +1,40 @@
+# See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/size
+# frozen_string_literal: true
+
+class Pagy # :nodoc:
+  # Implement the legacy bar using the array size.
+  # Unless you have very specific requirements, use the faster and better looking default bar.
+  module SizeExtra
+    # Setup @items based on the :gearbox_items variable
+    def series(size: @vars[:size], **_)
+      return super unless size.is_a?(Array)
+      return [] if size == []
+      raise VariableError.new(self, :size, 'to be an Array of 4 Integers or []', size) \
+            unless size.is_a?(Array) && size.size == 4 && size.all? { |num| !num.negative? rescue false } # rubocop:disable Style/RescueModifier
+
+      [].tap do |series|
+        # This algorithm is up to ~5x faster and ~2.3x lighter than the previous one (pagy < 4.3)
+        # However the behavior of the legacy nav bar was taken straight from WillPaginate and Kaminari:
+        # it's ill-concieved and complicates the experience of devs and users.
+        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
+        start           = 1
+        if (left_gap_end - left_gap_start).positive?
+          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, :gap)
+          start = right_gap_end + 1
+        end
+        series.push(*start..@last)
+        series[series.index(@page)] = @page.to_s
+      end
+    end
+  end
+  prepend SizeExtra
+end

data/lib/pagy/frontend.rb

@@ -20,7 +20,7 @@ class Pagy
       a  = pagy_anchor(pagy)
 
       html = %(<nav#{id} class="pagy nav" #{nav_aria_label(pagy, aria_label:)}>#{
-                prev_a(pagy, a)})
+                 prev_a(pagy, a)})
       pagy.series(**vars).each do |item| # series example: [1, :gap, 7, 8, "9", 10, 11, :gap, 36]
         html << case item
                 when Integer

data/lib/pagy.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 # Core class
 class Pagy
-  VERSION = '8.4.5'
+  VERSION = '8.6.1'
 
   # Gem root pathname to get the path of Pagy files stylesheets, javascripts, apps, locales, etc.
   def self.root
@@ -17,6 +17,7 @@ class Pagy
               items:      20,
               outset:     0,
               size:       7,
+              ends:       true,
               count_args: [:all],  # AR friendly
               page_param: :page }
 
@@ -39,46 +40,35 @@ class Pagy
     @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]
+  # Return the array of page numbers and :gap items e.g. [1, :gap, 8, "9", 10, :gap, 36]
   def series(size: @vars[:size], **_)
-    series = []
-    if size.is_a?(Array) && 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
-      start           = 1
-      if (left_gap_end - left_gap_start).positive?
-        series.push(*start...left_gap_start, :gap)
-        start = left_gap_end + 1
+    raise VariableError.new(self, :size, 'to be an Integer >= 0', size) \
+          unless size.is_a?(Integer)
+    return [] if size.zero?
+
+    [].tap do |series|
+      if size >= @last
+        series.push(*1..@last)
+      else
+        left  = ((size - 1) / 2.0).floor             # left half might be 1 page shorter for even size
+        start = if @page <= left                     # beginning pages
+                  1
+                elsif @page > @last - (size - left)  # end pages
+                  @last - size + 1
+                else                                 # intermediate pages
+                  @page - left
+                end
+        series.push(*start...start + size)
+        # Insert first and last ends plus gaps when needed
+        if vars[:ends] && size >= 7
+          series[0]  = 1     unless series[0]  == 1
+          series[1]  = :gap  unless series[1]  == 2
+          series[-2] = :gap  unless series[-2] == @last - 1
+          series[-1] = @last unless series[-1] == @last
+        end
       end
-      if (right_gap_end - right_gap_start).positive?
-        series.push(*start...right_gap_start, :gap)
-        start = right_gap_end + 1
-      end
-      series.push(*start..@last)
-    elsif size.is_a?(Integer) && size.positive?    # only central series
-      # The simplest and fastest algorithm
-      size  = @last if size > @last                # reduce the max size to @last
-      left  = ((size - 1) / 2.0).floor             # left half might be 1 page shorter for even size
-      start = if @page <= left                     # beginning pages
-                1
-              elsif @page > @last - (size - left)  # end pages
-                @last - size + 1
-              else                                 # intermediate pages
-                @page - left
-              end
-      series = (start..start + size - 1).to_a
-    else
-      return [] if size.empty?
-
-      raise VariableError.new(self, :size, 'to be a single positive Integer or an Array of 4', size)
+      series[series.index(@page)] = @page.to_s
     end
-    series[series.index(@page)] = @page.to_s
-    series
   end
 
   # Label for any page. Allow the customization of the output (overridden by the calendar extra)
@@ -124,6 +114,7 @@ class Pagy
   end
 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'

data/locales/ar.yml

@@ -2,14 +2,12 @@
 ar:
   pagy:
     aria_label:
-      # please add a comment in the https://github.com/ddnexus/pagy/issues/577
-      # posting the translation of the following  "Page"/"Pages" with the plurals for this locale
-      nav: "Pages"
-#        zero: ""
-#        two: ""
-#        few: ""
-#        many: ""
-#        other: ""
+      nav:
+        zero: "لا يوجد صفحات"
+        one: "صفحة"
+        two: "صفحتين"
+        few: "صفحات"
+        many: "صفحات"
       prev: "السابق"
       next: "التالي"
     prev: "<"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagy
 version: !ruby/object:Gem::Version
-  version: 8.4.5
+  version: 8.6.1
 platform: ruby
 authors:
 - Domizio Demichelis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies: []
 description: Agnostic pagination in plain ruby. It does it all. Better.
 email:
@@ -23,6 +23,11 @@ files:
 - apps/demo.ru
 - apps/rails.ru
 - apps/repro.ru
+- apps/tmp/calendar.sqlite3
+- apps/tmp/calendar.sqlite3-shm
+- apps/tmp/calendar.sqlite3-wal
+- apps/tmp/local_secret.txt
+- apps/tmp/pagy-rails.sqlite3
 - bin/pagy
 - config/pagy.rb
 - javascripts/pagy-module.js
@@ -36,9 +41,9 @@ files:
 - lib/pagy/backend.rb
 - lib/pagy/calendar.rb
 - lib/pagy/calendar/day.rb
-- lib/pagy/calendar/helper.rb
 - lib/pagy/calendar/month.rb
 - lib/pagy/calendar/quarter.rb
+- lib/pagy/calendar/unit.rb
 - lib/pagy/calendar/week.rb
 - lib/pagy/calendar/year.rb
 - lib/pagy/console.rb
@@ -65,6 +70,7 @@ files:
 - lib/pagy/extras/pagy.rb
 - lib/pagy/extras/searchkick.rb
 - lib/pagy/extras/semantic.rb
+- lib/pagy/extras/size.rb
 - lib/pagy/extras/standalone.rb
 - lib/pagy/extras/trim.rb
 - lib/pagy/extras/uikit.rb

data/lib/pagy/calendar/helper.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-class Pagy # :nodoc:
-  class Calendar # :nodoc:
-    # Initializes the calendar objects, reducing complexity in the extra
-    # The returned calendar is a simple hash of units/objects
-    class Helper < Hash
-      class << self
-        private
-
-        def init(conf, period, params)
-          new.send(:init, conf, period, params)
-        end
-      end
-
-      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
-
-      # 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
-
-      public
-
-      # Return the current time of the smallest time unit shown
-      def showtime
-        self[@units.last].from
-      end
-    end
-  end
-end