Calendar::OutOfRangeError can be internally rescued to the first or…

… last page of the collection passing `rescue: true` to the page_at and pagy_calendar_url_at methods

apps/pagy_calendar_app.ru

@@ -112,7 +112,8 @@ __END__
   <% else %>
     <a href="?skip=true" >Hide Calendar</a>
     <br>
-    <a href="<%= pagy_calendar_url_at(@calendar, Time.zone.now) %>">Go to current Page</a>
+    <a href="<%= pagy_calendar_url_at(@calendar, Time.zone.parse('2022-03-03')) %>">Go to the 2022-03 Page</a>
+    <!-- You can use Time.zone.now to find the current page if your time period include today -->
     <% end %>
   </p>
 

docs/extras/calendar.md

@@ -270,13 +270,14 @@ You can use the calendar objects with any `pagy_*nav` and `pagy_*nav_js` helpers
 
 The `pagy_*combo_nav_js` keeps into account only page numbers and not labels, so it is not very useful (if at all) with `Pagy::Calendar::*` objects.
 
-==- `pagy_calendar_url_at(@calendar, time)`
+==- `pagy_calendar_url_at(@calendar, time, **opts)`
 
 This helper takes the `@calendar` and a `TimeWithZone` objects and returns the url complete with all the params for the pages in each bars that include the passed time.
 
 For example: `pagy_calendar_url_at(@calendar, Time.zone.now)` will select the the bars pointing to today. You can see a working example in the [pagy_calendar_app.ru](https://github.com/ddnexus/pagy/blob/master/apps/pagy_calendar_app.ru) file.
 
-If `time` is outside the pagination range it raises a `Pagy::Calendar::OutOfRangeError`.
+If `time` is outside the pagination range it raises a `Pagy::Calendar::OutOfRangeError`, however you can pass the option `rescue: true` to avoid the error and get the url to the first or last page of the collection (depending on the reative time of the out-of-range).
+
 ===
 
 ### Label format

lib/pagy/calendar.rb

@@ -13,7 +13,7 @@ class Pagy # :nodoc:
   # Base class for time units subclasses (Year, Quarter, Month, Week, Day)
   class Calendar < Pagy
     # Specific out of range error
-    class OutOfRangeError < StandardError; end
+    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
@@ -49,10 +49,25 @@ def label_for(page, opts = {})
     protected
 
     # The page that includes time
-    def page_at(time)
-      raise OutOfRangeError unless time.between?(@initial, @final)
-
-      offset = page_offset_at(time)   # offset starts from 0
+    # Return the first page when the time requested is before the initial time
+    # Return the last page when the time requested is after the final time
+    def page_at(time, **opts)
+      adjusted_time = time
+      before_final  = @final - 1
+      unless time.between?(@initial, before_final)
+        raise OutOfRangeError.new(self, :time, "between #{@initial} and #{before_final}", time) \
+              unless opts[:rescue]
+
+        if time < @final
+          adjusted_time = @initial
+          ordinal       = 'first'
+        else
+          adjusted_time = before_final
+          ordinal       = 'last'
+        end
+        Warning.warn "Pagy::Calendar#page_at: Rescued #{time} out of range by returning the #{ordinal} page."
+      end
+      offset = page_offset_at(adjusted_time)   # offset starts from 0
       @order == :asc ? offset + 1 : @pages - offset
     end
 

lib/pagy/calendar/helper.rb

@@ -44,13 +44,13 @@ def init(conf, period, params)
         [replace(calendar), object.from, object.to]
       end
 
-      def last_object_at(time)
+      def last_object_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)
+                              = 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])

lib/pagy/extras/calendar.rb

@@ -28,8 +28,8 @@ def pagy_calendar(collection, conf)
         [calendar, pagy, results]
       end
 
-      def pagy_calendar_url_at(calendar, time)
-        pagy_url_for(calendar.send(:last_object_at, time), 1)
+      def pagy_calendar_url_at(calendar, time, **opts)
+        pagy_url_for(calendar.send(:last_object_at, time, **opts), 1)
       end
 
       # This method must be implemented by the application

test/coverage_setup.rb

@@ -12,6 +12,7 @@
     command_name "Task##{$PROCESS_ID}"
     merge_timeout 20
     enable_coverage :branch
+    add_filter "/test/"
     add_group 'Core', %w[ lib/pagy.rb
                           lib/pagy/backend.rb
                           lib/pagy/console.rb
@@ -21,7 +22,7 @@
                           lib/pagy/i18n.rb
                           lib/pagy/url_helpers.rb ]
     add_group 'Extras', 'lib/pagy/extras'
-    add_group 'Tests', 'test'
+    # add_group 'Tests', 'test'
   end
 
   SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter unless ENV.fetch('HTML_REPORTS', nil) == 'true'

test/pagy/calendar_test.rb

@@ -277,72 +277,102 @@ def pagy(unit: :month, **vars)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21, 13, 18, 23, 0))).must_equal 1
       _(p.send(:page_at, Time.zone.local(2022, 1, 1, 13, 18, 23, 0))).must_equal 2
       _(p.send(:page_at, Time.zone.local(2023, 11, 13, 15, 43, 40, 0))).must_equal 3
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 3
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 1
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
     it 'returns the page number for :year desc' do
       p = pagy(unit: :year, order: :desc)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21, 13, 18, 23, 0))).must_equal 3
       _(p.send(:page_at, Time.zone.local(2022, 1, 1, 13, 18, 23, 0))).must_equal 2
       _(p.send(:page_at, Time.zone.local(2023, 11, 13, 15, 43, 40, 0))).must_equal 1
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 1
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 3
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
 
     it 'returns the page number for :quarter' do
       p = pagy(unit: :quarter)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21, 13, 18, 23, 0))).must_equal 1
       _(p.send(:page_at, Time.zone.local(2022, 1, 1, 13, 18, 23, 0))).must_equal 2
       _(p.send(:page_at, Time.zone.local(2023, 11, 13, 15, 43, 40, 0))).must_equal 9
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 9
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 1
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
     it 'returns the page number for :quarter desc' do
       p = pagy(unit: :quarter, order: :desc)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21, 13, 18, 23, 0))).must_equal 9
       _(p.send(:page_at, Time.zone.local(2022, 1, 1, 13, 18, 23, 0))).must_equal 8
       _(p.send(:page_at, Time.zone.local(2023, 11, 13, 15, 43, 40, 0))).must_equal 1
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 1
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 9
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
     it 'returns the page number for :month' do
       p = pagy(unit: :month)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21, 13, 18, 23, 0))).must_equal 1
       _(p.send(:page_at, Time.zone.local(2022, 1, 1, 13, 18, 23, 0))).must_equal 4
       _(p.send(:page_at, Time.zone.local(2023, 11, 13, 15, 43, 40, 0))).must_equal 26
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 26
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 1
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
     it 'returns the page number for :month desc' do
       p = pagy(unit: :month, order: :desc)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21, 13, 18, 23, 0))).must_equal 26
       _(p.send(:page_at, Time.zone.local(2022, 1, 1, 13, 18, 23, 0))).must_equal 23
       _(p.send(:page_at, Time.zone.local(2023, 11, 13, 15, 43, 40, 0))).must_equal 1
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 1
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 26
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
 
     it 'returns the page number for :week' do
       p = pagy(unit: :week)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21))).must_equal 1
       _(p.send(:page_at, Time.zone.local(2021, 10, 26))).must_equal 2
       _(p.send(:page_at, Time.zone.local(2023, 11, 13))).must_equal 109
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 109
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 1
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
-    it 'returns the page number for :day desc' do
+    it 'returns the page number for :week desc' do
       p = pagy(unit: :week, order: :desc)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21))).must_equal 109
       _(p.send(:page_at, Time.zone.local(2021, 10, 26))).must_equal 108
       _(p.send(:page_at, Time.zone.local(2023, 11, 13))).must_equal 1
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 1
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 109
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
     it 'returns the page number for :day' do
       p = pagy(unit: :day)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21))).must_equal 1
       _(p.send(:page_at, Time.zone.local(2021, 10, 26))).must_equal 6
       _(p.send(:page_at, Time.zone.local(2023, 11, 13))).must_equal 754
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 754
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 1
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
     it 'returns the page number for :day desc' do
       p = pagy(unit: :day, order: :desc)
       _(p.send(:page_at, Time.zone.local(2021, 10, 21))).must_equal 754
       _(p.send(:page_at, Time.zone.local(2021, 10, 26))).must_equal 749
       _(p.send(:page_at, Time.zone.local(2023, 11, 13))).must_equal 1
-      _ { p.send(:page_at, Time.zone.local(2030)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _(p.send(:page_at, Time.zone.local(2100), rescue: true)).must_equal 1
+      _(p.send(:page_at, Time.zone.local(2000), rescue: true)).must_equal 754
+      _ { p.send(:page_at, Time.zone.local(2100)) }.must_raise Pagy::Calendar::OutOfRangeError
+      _ { p.send(:page_at, Time.zone.local(2000)) }.must_raise Pagy::Calendar::OutOfRangeError
     end
   end
 

test/pagy/extras/calendar_extra_test.rb

@@ -228,11 +228,17 @@ def app(**opts)
       _(app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2023, 11, 10)))
         .must_equal  "/foo?page=1&year_page=3&month_page=11"
 
-      _ { app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2024, 1, 10)) }
-        .must_raise  Pagy::Calendar::OutOfRangeError
+      _(app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2100), rescue: true))
+        .must_equal "/foo?page=1&year_page=3&month_page=11"
 
-      _ { app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2021, 9, 10)) }
-        .must_raise  Pagy::Calendar::OutOfRangeError
+      _(app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2000), rescue: true))
+        .must_equal "/foo?page=1&year_page=1&month_page=1"
+
+      _ { app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2100)) }
+        .must_raise Pagy::Calendar::OutOfRangeError
+
+      _ { app.send(:pagy_calendar_url_at, calendar, Time.zone.local(2000)) }
+        .must_raise Pagy::Calendar::OutOfRangeError
     end
   end
 end

test/test_helper.rb

@@ -15,3 +15,14 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'pagy'
 require 'minitest/autorun'
+
+module PagyCalendarWarningFilter
+  def warn(message, category: nil, **kwargs)
+    if message.match?('Calendar#page_at')
+      # ignore
+    else
+      super
+    end
+  end
+end
+Warning.extend PagyCalendarWarningFilter