Refactor BYSETPOS module to be more generic and more readable

Author: davidstosik

lib/ice_cube/rule.rb

@@ -58,6 +58,10 @@ def on?(time, schedule)
       next_time(time, schedule, time).to_i == time.to_i
     end
 
+    def interval_type
+      self.class.interval_type
+    end
+
     class << self
 
       # Convert from a hash and create a rule
@@ -90,6 +94,10 @@ def from_hash(original_hash)
         rule
       end
 
+      def interval_type
+        @_interval_type ||= self.name.split('::').last.sub(/Rule$/, '').downcase
+      end
+
       private
 
       def apply_validation(rule, name, args)

lib/ice_cube/validations/by_set_pos.rb

@@ -78,35 +78,43 @@ def occurrences_this_period
           )
         end
 
-        def period_type
-          case source_rule
-          when SecondlyRule
-            :second
-          when MinutelyRule
-            :minute
-          when HourlyRule
-            :hour
-          when DailyRule
-            :day
-          when WeeklyRule
-            :week
-          when MonthlyRule
-            :month
-          when YearlyRule
-            :year
+        def interval_type
+          if source_rule.interval_type == 'daily'
+            'day'
+          else
+            source_rule.interval_type.sub(/ly$/, '')
           end
         end
 
         def beginning_of_period
-          step_time.public_send("beginning_of_#{period_type}")
+          if interval_type == 'second'
+            fail 'boo'
+          else
+            step_time.public_send("beginning_of_#{interval_type}")
+          end
         end
 
         def end_of_period
-          step_time.public_send("end_of_#{period_type}")
+          if interval_type == 'second'
+            fail 'boo'
+          else
+            step_time.public_send("end_of_#{interval_type}")
+          end
         end
 
         def last_period
-          step_time.public_send("last_#{period_type}")
+          case interval_type
+          when 'second'
+            fail 'boo'
+          when 'minute'
+            step_time - ONE_MINUTE
+          when 'hour'
+            step_time - ONE_HOUR
+          when 'day'
+            step_time.yesterday
+          when 'week', 'month', 'year'
+            step_time.public_send("last_#{interval_type}")
+          end
         end
 
         def schedule_for_rule

spec/examples/from_ical_spec.rb

@@ -190,6 +190,16 @@ def sorted_ical(ical)
         expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
       end
 
+      it 'handles bysetpos' do
+        start_time = Time.now
+
+        schedule = IceCube::Schedule.new(start_time)
+        schedule.add_recurrence_rule(IceCube::Rule.weekly.day(:monday).by_set_pos(1, -1))
+
+        ical = schedule.to_ical
+        expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
+      end
+
     end
 
     describe 'weekly frequency' do
@@ -242,6 +252,16 @@ def sorted_ical(ical)
         ical = schedule.to_ical
         expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
       end
+
+      it 'handles bysetpos' do
+        start_time = Time.now
+
+        schedule = IceCube::Schedule.new(start_time)
+        schedule.add_recurrence_rule(IceCube::Rule.weekly.day(:monday).by_set_pos(1, -1))
+
+        ical = schedule.to_ical
+        expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
+      end
     end
 
     describe 'monthly frequency' do
@@ -284,6 +304,16 @@ def sorted_ical(ical)
         ical = schedule.to_ical
         expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
       end
+
+      it 'handles bysetpos' do
+        start_time = Time.now
+
+        schedule = IceCube::Schedule.new(start_time)
+        schedule.add_recurrence_rule(IceCube::Rule.monthly.day(:monday).by_set_pos(1, -1))
+
+        ical = schedule.to_ical
+        expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
+      end
     end
 
     describe 'yearly frequency' do
@@ -337,6 +367,16 @@ def sorted_ical(ical)
         expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
       end
 
+      it 'handles bysetpos' do
+        start_time = Time.now
+
+        schedule = IceCube::Schedule.new(start_time)
+        schedule.add_recurrence_rule(IceCube::Rule.yearly.month_of_year(:february).day(:monday).by_set_pos(1, -1))
+
+        ical = schedule.to_ical
+        expect(sorted_ical(IceCube::Schedule.from_ical(ical).to_ical)).to eq(sorted_ical(ical))
+      end
+
       it 'handles specific months' do
         start_time = Time.now
 

spec/examples/rfc_spec.rb

@@ -325,6 +325,24 @@
     expect(dates).to eq(expecation)
   end
 
+  it 'should ~ third instance into the month of one of Tuesday, Wednesday, or Thursday, for the next 3 months' do
+    start_time = Time.utc(1997, 9, 4, 9, 0, 0)
+    schedule = IceCube::Schedule.new(start_time)
+    schedule.add_recurrence_rule IceCube::Rule.monthly.count(3).day(:tuesday , :wednesday , :thursday).by_set_pos(3)
+    dates = schedule.all_occurrences
+    expectation = [Time.utc(1997, 9, 4, 9), Time.utc(1997, 10, 7, 9), Time.utc(1997, 11, 6, 9)]
+    expect(dates).to eq(expectation)
+  end
+
+  it 'should ~ second-to-last weekday of the month' do
+    start_time = Time.utc(1997, 9, 29, 9, 0, 0)
+    schedule = IceCube::Schedule.new(start_time)
+    schedule.add_recurrence_rule IceCube::Rule.monthly.day(:monday, :tuesday , :wednesday , :thursday, :friday).by_set_pos(-2)
+    next_dates = schedule.occurrences(Time.utc(1997, 12, 31))
+    expectation = [Time.utc(1997, 9, 29, 9), Time.utc(1997, 10, 30, 9), Time.utc(1997, 11, 27, 9), Time.utc(1997, 12, 30, 9)]
+    expect(next_dates).to eq(expectation)
+  end
+
 end
 
 def test_expectations(schedule, dates_array)