Realign to schedule start time before enumerating

Author: avit

lib/ice_cube/schedule.rb

@@ -403,7 +403,7 @@ def enumerate_occurrences(opening_time, closing_time = nil, &block)
       opening_time = start_time if opening_time < start_time
       Enumerator.new do |yielder|
         reset
-        t1 = full_required? ? start_time : opening_time
+        t1 = full_required? ? start_time : realign(opening_time)
         loop do
           break unless (t0 = next_time(t1, closing_time))
           break if closing_time && t0 > closing_time
@@ -488,6 +488,28 @@ def wind_back_dst
       end
     end
 
+    # If any rule has validations for values within the period, (overriding the
+    # interval from start time, e.g.  `day[_of_week]`), and the opening time is
+    # offset from the interval multiplier such that it might miss the first
+    # correct occurrence (e.g. repeat is every N weeks, but selecting from end
+    # of week N-1, the first jump would go to end of week N and miss any
+    # earlier validations in the week). This realigns the opening time to
+    # the start of the interval's correct period (e.g. move to start of week N)
+    # TODO: check if this is needed for validations other than `:wday`
+    #
+    def realign(opening_time)
+      time = TimeUtil::TimeWrapper.new(opening_time)
+      recurrence_rules.each do |rule|
+        wday_validations = rule.other_interval_validations.select { |v| v.type == :wday } or next
+        interval = rule.base_interval_validation.validate(opening_time, self).to_i
+        offset = wday_validations
+          .map { |v| v.validate(opening_time, self).to_i }
+          .reduce(0) { |least, i| i > 0 && i <= interval && (i < least || least == 0) ? i : least }
+        time.add(rule.base_interval_type, 7 - time.to_time.wday) if offset > 0
+      end
+      time.to_time
+    end
+
   end
 
 end

lib/ice_cube/validated_rule.rb

@@ -30,10 +30,24 @@ class ValidatedRule < Rule
       :interval
     ]
 
+    attr_reader :validations
+
     def initialize(interval = 1, *)
       @validations = Hash.new
     end
 
+    def base_interval_validation
+      @validations[:interval].first
+    end
+
+    def other_interval_validations
+      Array(@validations[base_interval_validation.type])
+    end
+
+    def base_interval_type
+      base_interval_validation.type
+    end
+
     # Compute the next time after (or including) the specified time in respect
     # to the given schedule
     def next_time(time, schedule, closing_time)

spec/examples/regression_spec.rb

@@ -226,36 +226,37 @@ module IceCube
           time.usec.should == 0
         end
 
-        describe 'weekly schedule using occurs_between' do
-          let(:schedule) {Schedule.new('2014-01-08'.to_date)}
-          let(:expected_occurrence) {'2014-07-24'.to_date.to_time}
-          before :each do
-            schedule.add_recurrence_rule rule
-          end
-          context "with interval" do
-            let(:rule) {Rule.weekly(2).day([4,5,6])}
-            it "should include the expected date [#241]" do
-              expect(schedule.occurs_on?(expected_occurrence)).to be_true
-              expect(schedule.occurrences_between(expected_occurrence - 7.days, expected_occurrence + 7.days)).to include(expected_occurrence)
-              expect(schedule.occurrences_between(expected_occurrence - 1.day, expected_occurrence + 1.day)).to include(expected_occurrence)
-              expect(schedule.occurrences_between(expected_occurrence - 6.days, expected_occurrence + 6.days)).to include(expected_occurrence)
-              expect(schedule.occurrences_between(expected_occurrence - 5.days, expected_occurrence + 5.days)).to include(expected_occurrence)
-            end
-          end
-          context "without interval" do
-            let(:rule) {Rule.weekly(1).day([4,5,6])}
-            it "should include the expected date" do
-              expect(schedule.occurs_on?(expected_occurrence)).to be_true
-              expect(schedule.occurrences_between(expected_occurrence - 7.days, expected_occurrence + 7.days)).to include(expected_occurrence)
-              expect(schedule.occurrences_between(expected_occurrence - 1.day, expected_occurrence + 1.day)).to include(expected_occurrence)
-              expect(schedule.occurrences_between(expected_occurrence - 6.days, expected_occurrence + 6.days)).to include(expected_occurrence)
-              expect(schedule.occurrences_between(expected_occurrence - 5.days, expected_occurrence + 5.days)).to include(expected_occurrence)
-            end
-          end
+      end
+    end
 
+    describe 'weekly schedule using occurs_between' do
+      let(:schedule) {Schedule.new('2014-01-08'.to_date)}
+      let(:expected_occurrence) {'2014-07-24'.to_date.to_time}
+      before :each do
+        schedule.add_recurrence_rule rule
+      end
+
+      context "with interval" do
+        let(:rule) {Rule.weekly(2).day([4,5,6])}
+        it "should include the expected date [#241]" do
+          expect(schedule.occurrences_between(expected_occurrence - 7.days, expected_occurrence + 7.days)).to include(expected_occurrence)
+          expect(schedule.occurrences_between(expected_occurrence - 1.day, expected_occurrence + 1.day)).to include(expected_occurrence)
+          expect(schedule.occurrences_between(expected_occurrence - 6.days, expected_occurrence + 6.days)).to include(expected_occurrence)
+          expect(schedule.occurrences_between(expected_occurrence - 5.days, expected_occurrence + 5.days)).to include(expected_occurrence)
         end
+      end
 
+      context "without interval" do
+        let(:rule) {Rule.weekly(1).day([4,5,6])}
+        it "should include the expected date" do
+          expect(schedule.occurs_on?(expected_occurrence)).to be_true
+          expect(schedule.occurrences_between(expected_occurrence - 7.days, expected_occurrence + 7.days)).to include(expected_occurrence)
+          expect(schedule.occurrences_between(expected_occurrence - 1.day, expected_occurrence + 1.day)).to include(expected_occurrence)
+          expect(schedule.occurrences_between(expected_occurrence - 6.days, expected_occurrence + 6.days)).to include(expected_occurrence)
+          expect(schedule.occurrences_between(expected_occurrence - 5.days, expected_occurrence + 5.days)).to include(expected_occurrence)
+        end
       end
+
     end
 
   end