Fix whole-day skip with date inputs

Given a Date input, schedule will convert to the beginning of day based
on the schedule time zone. This fixes jumping by + 1 day for the next
occurrence, which should be + 1 second.

Author: avit

lib/ice_cube/schedule.rb

@@ -167,26 +167,28 @@ def each_occurrence(&block)
 
     # The next n occurrences after now
     def next_occurrences(num, from = nil)
-      from ||= TimeUtil.now(@start_time)
+      from = TimeUtil.match_zone(from, start_time) || TimeUtil.now(start_time)
       enumerate_occurrences(from + 1, nil).take(num)
     end
 
     # The next occurrence after now (overridable)
     def next_occurrence(from = nil)
-      from ||= TimeUtil.now(@start_time)
+      from = TimeUtil.match_zone(from, start_time) || TimeUtil.now(start_time)
       enumerate_occurrences(from + 1, nil).next
     rescue StopIteration
       nil
     end
 
     # The previous occurrence from a given time
     def previous_occurrence(from)
+      from = TimeUtil.match_zone(from, start_time) or raise ArgumentError, "Time required, got #{time.inspect}"
       return nil if from <= start_time
       enumerate_occurrences(start_time, from - 1).to_a.last
     end
 
     # The previous n occurrences before a given time
     def previous_occurrences(num, from)
+      from = TimeUtil.match_zone(from, start_time) or raise ArgumentError, "Time required, got #{time.inspect}"
       return [] if from <= start_time
       a = enumerate_occurrences(start_time, from - 1).to_a
       a.size > num ? a[-1*num,a.size] : a
@@ -231,14 +233,15 @@ def occurring_between?(opening_time, closing_time)
 
     # Return a boolean indicating if an occurrence falls on a certain date
     def occurs_on?(date)
-      date = TimeUtil.ensure_date date
+      date = TimeUtil.ensure_date(date)
       begin_time = TimeUtil.beginning_of_date(date, start_time)
       closing_time = TimeUtil.end_of_date(date, start_time)
       occurs_between?(begin_time, closing_time)
     end
 
     # Determine if the schedule is occurring at a given time
     def occurring_at?(time)
+      time = TimeUtil.match_zone(time, start_time) or raise ArgumentError, "Time required, got #{time.inspect}"
       if duration > 0
         return false if exception_time?(time)
         occurs_between?(time - duration + 1, time)

lib/ice_cube/time_util.rb

@@ -36,19 +36,20 @@ def self.build_in_zone(args, reference)
       end
     end
 
-    def self.match_zone(time, reference)
-      return unless time = ensure_time(time)
-      if reference.respond_to? :time_zone
-        time.in_time_zone(reference.time_zone)
-      else
-        if reference.utc?
-          time.utc
-        elsif reference.zone
-          time.getlocal
-        else
-          time.getlocal(reference.utc_offset)
-        end
-      end
+    def self.match_zone(input_time, reference)
+      return unless time = ensure_time(input_time)
+      time = if reference.respond_to? :time_zone
+               time.in_time_zone(reference.time_zone)
+             else
+               if reference.utc?
+                 time.utc
+               elsif reference.zone
+                 time.getlocal
+               else
+                 time.getlocal(reference.utc_offset)
+               end
+             end
+      (Date === input_time) ? beginning_of_date(time, reference) : time
     end
 
     # Ensure that this is either nil, or a time

spec/examples/schedule_spec.rb

@@ -33,6 +33,14 @@
       lambda { schedule.next_occurrence }.should_not raise_error
     end
 
+    it "should not skip ahead a day when called with a date" do
+      schedule = IceCube::Schedule.new(Time.utc(2014, 1, 1, 12, 34, 56)) do |s|
+        s.add_recurrence_rule IceCube::Rule.hourly
+      end
+      next_hour = schedule.next_occurrence(Date.new(2014, 1, 2))
+      expect( next_hour ).to eq Time.utc(2014, 1, 2, 00, 34 , 56)
+    end
+
   end
 
   describe :duration do
@@ -54,6 +62,20 @@
 
   end
 
+  describe :occurring_at? do
+
+    it "should not capture multiple days when called with a date" do
+      schedule = IceCube::Schedule.new do |s|
+        s.start_time = Time.utc(2013, 12, 31, 23, 59, 50)
+        s.duration = 20
+        s.add_recurrence_rule IceCube::Rule.daily(2)
+      end
+      expect( schedule.occurring_at?(Date.new(2014, 1, 1)) ).to eq true
+      expect( schedule.occurring_at?(Date.new(2014, 1, 2)) ).to eq false
+    end
+
+  end
+
   describe :recurrence_times do
 
     it 'should start empty' do
@@ -375,6 +397,15 @@
       schedule.next_occurrences(1).should be_empty
     end
 
+    it "should not skip ahead a day when called with a date" do
+      schedule = IceCube::Schedule.new(Time.utc(2014, 1, 1, 12, 34, 56)) do |s|
+        s.add_recurrence_rule IceCube::Rule.hourly
+      end
+      next_hours = schedule.next_occurrences(2, Date.new(2014, 1, 2))
+      expect( next_hours ).to eq [Time.utc(2014, 1, 2, 00, 34 , 56),
+                                  Time.utc(2014, 1, 2, 01, 34 , 56)]
+    end
+
   end
 
   describe :next_occurrence do
@@ -438,6 +469,14 @@
       previous.should be_nil
     end
 
+    it "should not skip back a day when called with a date" do
+      schedule = IceCube::Schedule.new(Time.utc(2014, 1, 1, 12, 34, 56)) do |s|
+        s.add_recurrence_rule IceCube::Rule.hourly
+      end
+      prev_hour = schedule.previous_occurrence(Date.new(2014, 1, 2))
+      expect( prev_hour ).to eq Time.utc(2014, 1, 1, 23, 34 , 56)
+    end
+
   end
 
   describe :previous_occurrences do
@@ -466,6 +505,15 @@
       previous.should == []
     end
 
+    it "should not skip back a day when called with a date" do
+      schedule = IceCube::Schedule.new(Time.utc(2014, 1, 1, 12, 34, 56)) do |s|
+        s.add_recurrence_rule IceCube::Rule.hourly
+      end
+      prev_hours = schedule.previous_occurrences(2, Date.new(2014, 1, 2))
+      expect( prev_hours ).to eq [Time.utc(2014, 1, 1, 22, 34 , 56),
+                                  Time.utc(2014, 1, 1, 23, 34 , 56)]
+    end
+
   end
 
   describe :last do

spec/examples/time_util_spec.rb

@@ -96,5 +96,28 @@ module IceCube
       end
     end
 
+    describe :match_zone do
+
+      let(:date) { Date.new(2014, 1, 1) }
+
+      WORLD_TIME_ZONES.each do |zone|
+        context "in #{zone}", :system_time_zone => zone do
+          let(:local_time) { Time.local(2014, 1, 1, 0, 0, 1) }
+
+          it 'converts Date to beginning of date of reference time' do
+            expect(TimeUtil.match_zone(date, local_time)).to eq local_time - 1
+          end
+        end
+      end
+
+      context "in UTC" do
+        let(:utc_time) { Time.utc(2014, 1, 1, 0, 0, 1) }
+
+        it 'converts Date to beginning of date of reference time' do
+          expect(TimeUtil.match_zone(date, utc_time)).to eq utc_time - 1
+        end
+      end
+    end
+
   end
 end