WIP: Better Calendar paginator

Author: ddnexus

gem/lib/pagy/backend/paginators/calendar.rb

@@ -2,16 +2,14 @@
 
 class Pagy
   # Add pagination filtering by calendar unit (:year, :quarter, :month, :week, :day) to the regular pagination
-  # Additions for the Backend module
-  module CalendarBackendAddOn
-    CALENDAR_CONF_KEYS = (Offset::Calendar::UNITS + %i[pagy active]).freeze
-
+  Backend.module_eval do
     private
 
     # Take a collection and a conf Hash with keys in CONF_KEYS and return an array with 3 items: [calendar, pagy, results]
     def pagy_calendar(collection, conf)
-      raise ArgumentError, "keys must be in #{CALENDAR_CONF_KEYS.inspect}" \
-            unless conf.is_a?(Hash) && (conf.keys - CALENDAR_CONF_KEYS).empty?
+      conf_keys = Offset::Calendar::UNITS + %i[pagy active]
+      raise ArgumentError, "keys must be in #{conf_keys.inspect}" \
+            unless conf.is_a?(Hash) && (conf.keys - conf_keys).empty?
 
       conf[:pagy] ||= {}
       unless conf.key?(:active) && !conf[:active]
@@ -36,39 +34,4 @@ def pagy_calendar_filter(*)
                            '(see https://ddnexus.github.io/pagy/docs/extras/calendar/#pagy-calendar-filter-collection-from-to)'
     end
   end
-  Backend.prepend CalendarBackendAddOn
-
-  # Override the pagy_anchor
-  module CalendarFrontendOverride
-    # Consider the vars[:counts]
-    def pagy_anchor(pagy, anchor_string: nil, **vars)
-      return super unless (counts = pagy.vars[:counts])
-
-      anchor_string &&= %( #{anchor_string})
-      left, right = %(<a#{anchor_string} href="#{pagy_page_url(pagy, PAGE_TOKEN, **vars)}").split(PAGE_TOKEN, 2)
-      # lambda used by all the helpers
-      lambda do |page, text = pagy.label(page: page), classes: nil, aria_label: nil|
-        count = counts[page - 1]
-        if count.zero?
-          classes  = "#{classes && (classes + ' ')}empty-page"
-          info_key = 'pagy.info.no_items'
-        else
-          info_key = 'pagy.info.single_page'
-        end
-        title        = %( title="#{pagy_t(info_key, item_name: pagy_t('pagy.item_name', count:), count:)}")
-        classes    &&= %( class="#{classes}")
-        aria_label &&= %( aria-label="#{aria_label}")
-        %(#{left}#{page}#{right}#{title}#{classes}#{aria_label}>#{text}</a>)
-      end
-    end
-  end
-  Frontend.prepend CalendarFrontendOverride
-
-  # Additions for the Frontend module
-  Url.module_eval do
-    # Return the url for the calendar page at time
-    def pagy_calendar_url_at(calendar, time, **)
-      pagy_page_url(calendar.send(:calendar_at, time, **), 1, **)
-    end
-  end
 end

gem/lib/pagy/frontend.rb

@@ -11,13 +11,27 @@ module Frontend
     # Return a performance optimized lambda to generate the HTML anchor element (a tag)
     # Benchmarked on a 20 link nav: it is ~22x faster and uses ~18x less memory than rails' link_to
     def pagy_anchor(pagy, anchor_string: nil, **vars)
+      if (counts = pagy.vars[:calendar_counts]) # only set if pagy_calendar_counts is defined
+        calendar_augmentation = lambda do |page, classes|
+                                  count = counts[page - 1]
+                                  if count.zero?
+                                    classes  = classes ? "#{classes} empty-page" : 'empty-page'
+                                    info_key = 'pagy.info.no_items'
+                                  else
+                                    info_key = 'pagy.info.single_page'
+                                  end
+                                  title = %( title="#{pagy_t(info_key, item_name: pagy_t('pagy.item_name', count:), count:)}")
+                                  [classes, title]
+                                end
+      end
       anchor_string &&= %( #{anchor_string})
       left, right     = %(<a#{anchor_string} href="#{pagy_page_url(pagy, PAGE_TOKEN, **vars)}").split(PAGE_TOKEN, 2)
       # lambda used by all the helpers
       lambda do |page, text = pagy.label(page: page), classes: nil, aria_label: nil|
-        classes    &&= %( class="#{classes}")
-        aria_label &&= %( aria-label="#{aria_label}")
-        %(#{left}#{page}#{right}#{classes}#{aria_label}>#{text}</a>)
+        classes, title = calendar_augmentation.(page, classes) if calendar_augmentation
+        classes      &&= %( class="#{classes}")
+        aria_label   &&= %( aria-label="#{aria_label}")
+        %(#{left}#{page}#{right}#{title}#{classes}#{aria_label}>#{text}</a>)
       end
     end
 

gem/lib/pagy/modules/url.rb

@@ -62,5 +62,10 @@ def pagy_page_url(pagy, page, absolute: false, fragment: nil, **)
 
       "#{request.base_url if absolute}#{vars[:request_path] || request.path}#{query_string}#{fragment}"
     end
+
+    # Return the url for the calendar page at time
+    def pagy_calendar_url_at(calendar, time, **)
+      pagy_page_url(calendar.send(:calendar_at, time, **), 1, **)
+    end
   end
 end

gem/lib/pagy/offset/calendar.rb

@@ -68,10 +68,10 @@ def init(conf, period, params)
           conf[unit][:period] = object&.send(:active_period) || @period
           conf[unit][:page]   = @params[:"#{unit}_#{@page_sym}"] # requested page
           # :nocov:
-          conf[unit][:counts] = yield(unit, conf[unit][:period]) if block_given?  # nocov doesn't need to fail block_given?
+          # simplecov doesn't need to fail block_given?
+          conf[unit][:calendar_counts] = yield(unit, conf[unit][:period]) if block_given?
           # :nocov:
-          calendar[unit]      = object \
-                              = Calendar.send(:create, unit, **conf[unit])
+          calendar[unit] = object = Calendar.send(:create, unit, **conf[unit])
         end
         [replace(calendar), object.from, object.to]
       end

test/pagy/offset/overflow_test.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require_relative '../../test_helper'
-require 'pagy/backend/paginators/calendar'   # to avoid to load AR support
+
+# Lazy trick to load ActiveSupport and crap while silencing the warnings
+calendar = Pagy::Offset::Calendar
+puts calendar
 
 Time.zone = 'EST'
 Date.beginning_of_week = :sunday