rubyredrick-ri_cal 0.8.2 → 0.8.4

data/lib/ri_cal/property_value/recurrence_rule/enumerator.rb

@@ -17,7 +17,7 @@ module RiCal
           @setpos_list = setpos_list
           @setpos = 1
           @next_occurrence_count = 0
-          @incrementer = YearlyIncrementer.from_rrule(recurrence_rule, start_time)
+          @incrementer = recurrence_rule.incrementer_from_start_time(start_time)
         end
 
         def self.for(recurrence_rule, component, setpos_list) # :nodoc:

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer.rb

@@ -0,0 +1,134 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+
+        attr_accessor :sub_cycle_incrementer, :current_occurrence, :outer_range
+        attr_accessor :outer_incrementers
+        attr_accessor :contains_daily_incrementer, :contains_weeknum_incrementer
+        attr_reader :leaf_iterator
+        parent_path = "ri_cal/property_value/recurrence_rule/occurrence_incrementer"
+
+        autoload :ByDayIncrementer, "#{parent_path}/by_day_incrementer.rb"
+        autoload :ByHourIncrementer, "#{parent_path}/by_hour_incrementer.rb"
+        autoload :ByMinuteIncrementer, "#{parent_path}/by_minute_incrementer.rb"
+        autoload :ByMonthIncrementer, "#{parent_path}/by_month_incrementer.rb"
+        autoload :ByMonthdayIncrementer, "#{parent_path}/by_monthday_incrementer.rb"
+        autoload :ByNumberedDayIncrementer, "#{parent_path}/by_numbered_day_incrementer.rb"
+        autoload :BySecondIncrementer, "#{parent_path}/by_second_incrementer.rb"
+        autoload :ByYeardayIncrementer, "#{parent_path}/by_yearday_incrementer.rb"
+        autoload :ByWeekNoIncrementer, "#{parent_path}/by_weekno_incrementer.rb"
+        autoload :DailyIncrementer, "#{parent_path}/daily_incrementer.rb"
+        autoload :FrequencyIncrementer, "#{parent_path}/frequency_incrementer.rb"
+        autoload :HourlyIncrementer, "#{parent_path}/hourly_incrementer.rb"
+        autoload :ListIncrementer, "#{parent_path}/list_incrementer.rb"
+        autoload :MinutelyIncrementer, "#{parent_path}/minutely_incrementer.rb"
+        autoload :MonthlyIncrementer, "#{parent_path}/monthly_incrementer.rb"
+        autoload :NullSubCycleIncrementer, "#{parent_path}/null_sub_cycle_incrementer.rb"
+        autoload :SecondlyIncrementer, "#{parent_path}/secondly_incrementer.rb"
+        autoload :WeeklyIncrementer, "#{parent_path}/weekly_incrementer.rb"
+        autoload :YearlyIncrementer, "#{parent_path}/yearly_incrementer.rb"
+
+        include RecurrenceRule::TimeManipulation
+
+        def initialize(rrule, sub_cycle_incrementer)
+          self.sub_cycle_incrementer = sub_cycle_incrementer
+          @outermost = true
+          self.outer_incrementers = []
+          if sub_cycle_incrementer
+            self.contains_daily_incrementer = sub_cycle_incrementer.daily_incrementer? ||
+              sub_cycle_incrementer.contains_daily_incrementer?
+            self.contains_weeknum_incrementer = sub_cycle_incrementer.weeknum_incrementer?||
+              sub_cycle_incrementer.contains_weeknum_incrementer?
+            sub_cycle_incrementer.add_outer_incrementer(self)
+          else
+            self.sub_cycle_incrementer = NullSubCycleIncrementer
+          end
+        end
+
+        def self.from_rrule(recurrence_rule, start_time)
+          YearlyIncrementer.from_rrule(recurrence_rule, start_time)
+        end
+
+        def add_outer_incrementer(incrementer)
+          @outermost = false
+          self.outer_incrementers << incrementer
+          sub_cycle_incrementer.add_outer_incrementer(incrementer)
+        end
+
+        def outermost?
+          @outermost
+        end
+
+        def to_s
+          if sub_cycle_incrementer
+            "#{self.short_name}->#{sub_cycle_incrementer}"
+          else
+            self.short_name
+          end
+        end
+
+        def short_name
+          @short_name ||= self.class.name.split("::").last
+        end
+
+        # Return the next time after previous_occurrence generated by this incrementer
+        # But the occurrence is outside the current cycle of any outer incrementer(s) return
+        # nil which will cause the outer incrementer to step to its next cycle.
+        def next_time(previous_occurrence)
+          if current_occurrence
+            sub_occurrence = sub_cycle_incrementer.next_time(previous_occurrence)
+          else #first time
+            sub_occurrence = sub_cycle_incrementer.first_sub_occurrence(previous_occurrence, update_cycle_range(previous_occurrence))
+          end
+          if sub_occurrence
+            candidate = sub_occurrence
+          else
+            candidate = next_cycle(previous_occurrence)
+          end
+          if in_outer_cycle?(candidate)
+            candidate
+          else
+            nil
+          end
+        end
+
+        def update_cycle_range(date_time)
+          self.current_occurrence = date_time
+          (date_time..end_of_occurrence(date_time))
+        end
+
+        def in_outer_cycle?(candidate)
+          candidate && (outer_range.nil? || (outer_range.first <= candidate && outer_range.last >= candidate))
+        end
+
+        def first_sub_occurrence(previous_occurrence, outer_cycle_range)
+          first_within_outer_cycle(previous_occurrence, outer_cycle_range)
+        end
+
+        # Advance to the next cycle, if the result is within the current cycles of all outer incrementers
+        def next_cycle(previous_occurrence)
+          raise "next_cycle is a subclass responsibility"
+        end
+
+        def contains_daily_incrementer?
+          @contains_daily_incrementer
+        end
+
+        def daily_incrementer?
+          false
+        end
+
+        def contains_weeknum_incrementer?
+          @contains_weeknum_incrementer
+        end
+
+        def weeknum_incrementer?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_day_incrementer.rb

@@ -0,0 +1,82 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+        class ByDayIncrementer < ListIncrementer #:nodoc:
+
+          def initialize(rrule, list, by_monthday_list, by_yearday_list, parent)
+            super(rrule, list, parent)
+            @monthday_filters = by_monthday_list
+            @yearday_filters = by_yearday_list
+            @by_day_scope = rrule.by_day_scope
+
+            case rrule.by_day_scope
+            when :yearly
+              @cycle_advance_proc = lambda {|date_time| first_day_of_year(advance_year(date_time))}
+              @current_proc = lambda {|date_time| same_year?(current, date_time)}
+              @first_day_proc = lambda {|date_time| first_day_of_year(date_time)}
+            when :monthly
+              @cycle_advance_proc = lambda {|date_time| first_day_of_month(advance_month(date_time))}
+              @current_proc = lambda {|date_time| same_month?(current, date_time)}
+              @first_day_proc = lambda {|date_time| first_day_of_month(date_time)}
+            when :weekly
+              @cycle_advance_proc = lambda {|date_time| first_day_of_week(rrule.wkst_day, advance_week(date_time))}
+              @current_proc = lambda {|date_time| same_week?(rrule.wkst_day, current, date_time)}
+              @first_day_proc = lambda {|date_time| first_day_of_week(rrule.wkst_day, date_time)}
+            else
+              raise "Invalid recurrence rule, byday needs to be scoped by month, week or year"
+            end
+          end
+
+          def self.for_rrule(rrule)
+            list = rrule.by_rule_list(:byday)
+            if list
+              sub_cycle_incrementer = OccurrenceIncrementer::DailyIncrementer.for_rrule(rrule)
+              new(rrule, list, rrule.by_rule_list(:bymonthday), rrule.by_rule_list(:byyearday), sub_cycle_incrementer)
+            else
+              OccurrenceIncrementer::ByYeardayIncrementer.for_rrule(rrule)
+            end
+          end
+
+          def daily_incrementer?
+            true
+          end
+
+          def start_of_cycle(date_time)
+            @first_day_proc.call(date_time)
+          end
+
+          def occurrences_for(date_time)
+            first_day = start_of_cycle(date_time)
+            result = list.map {|recurring_day| recurring_day.matches_for(first_day)}.flatten.uniq.sort
+            if @monthday_filters
+              result = result.select {|occurrence| @monthday_filters.any? {|recurring_day| recurring_day.include?(occurrence)}}
+            end
+            if @yearday_filters
+              result = result.select {|occurrence| @yearday_filters.any? {|recurring_day| recurring_day.include?(occurrence)}}
+            end
+            result
+          end
+
+          def candidate_acceptible?(candidate)
+            list.any? {|recurring_day| recurring_day.include?(candidate)}
+          end
+
+          def varying_time_attribute
+            :day
+          end
+
+          def advance_cycle(date_time)
+            @cycle_advance_proc.call(date_time)
+          end
+
+          def end_of_occurrence(date_time)
+            date_time.end_of_day
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_hour_incrementer.rb

@@ -0,0 +1,31 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+        class ByHourIncrementer < ListIncrementer #:nodoc:
+          def self.for_rrule(rrule)
+            conditional_incrementer(rrule, :byhour, HourlyIncrementer)
+          end
+
+          def start_of_cycle(date_time)
+            date_time.change(:hour => 0)
+          end
+
+          def varying_time_attribute
+            :hour
+          end
+
+          def advance_cycle(date_time)
+            first_hour_of_day(advance_day(date_time))
+          end
+
+          def end_of_occurrence(date_time)
+            date_time.end_of_hour
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_minute_incrementer.rb

@@ -0,0 +1,32 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+        class ByMinuteIncrementer < ListIncrementer #:nodoc:
+          def self.for_rrule(rrule)
+            conditional_incrementer(rrule, :byminute, MinutelyIncrementer)
+          end
+
+          def advance_cycle(date_time)
+            date_time.advance(:hours => 1).start_of_hour
+          end
+
+          def start_of_cycle(date_time)
+            date_time.change(:min => 0)
+          end
+
+          def end_of_occurrence(date_time)
+            date_time.end_of_minute
+          end
+
+          def varying_time_attribute
+            :min
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_month_incrementer.rb

@@ -0,0 +1,52 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+        class ByMonthIncrementer < ListIncrementer #:nodoc:
+
+          def self.for_rrule(rrule)
+            conditional_incrementer(rrule, :bymonth, MonthlyIncrementer)
+          end
+
+          def occurrences_for(date_time)
+            if contains_daily_incrementer?
+              list.map {|value| date_time.change(:month => value, :day => 1)}
+            else
+              list.map {|value| date_time.in_month(value)}
+            end
+          end
+
+          def range_advance(date_time)
+            advance_year(date_time)
+          end
+
+          def start_of_cycle(date_time)
+            if contains_daily_incrementer?
+              date_time.change(:month => 1, :day => 1)
+            else
+              date_time.change(:month => 1)
+            end
+          end
+
+          def varying_time_attribute
+            :month
+          end
+
+          def advance_cycle(date_time)
+            if contains_daily_incrementer?
+              first_day_of_year(advance_year(date_time))
+            else
+              advance_year(date_time).change(:month => 1)
+            end
+          end
+
+          def end_of_occurrence(date_time)
+            date_time.end_of_month
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_monthday_incrementer.rb

@@ -0,0 +1,31 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+        class ByMonthdayIncrementer < ByNumberedDayIncrementer #:nodoc:
+          def self.for_rrule(rrule)
+            conditional_incrementer(rrule, :bymonthday, DailyIncrementer)
+          end
+
+          def scope_of(date_time)
+            date_time.month
+          end
+
+          def start_of_cycle(date_time)
+            date_time.change(:day => 1)
+          end
+
+          def advance_cycle(date_time)
+            first_day_of_month(advance_month(date_time))
+          end
+
+          def end_of_occurrence(date_time)
+            date_time.end_of_day
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_numbered_day_incrementer.rb

@@ -0,0 +1,34 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+        class ByNumberedDayIncrementer < ListIncrementer #:nodoc:
+
+          def daily_incrementer?
+            true
+          end
+
+          def occurrences_for(date_time)
+            if occurrences && @scoping_value == scope_of(date_time)
+               occurrences
+            else
+              @scoping_value = scope_of(date_time)
+              self.occurrences = list.map {|numbered_day| numbered_day.target_date_time_for(date_time)}.uniq.sort
+              occurrences
+            end
+          end
+
+          def end_of_occurrence(date_time)
+            date_time.end_of_day
+          end
+
+          def candidate_acceptible?(candidate)
+            list.any? {|by_part| by_part.include?(candidate)}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule/occurrence_incrementer/by_second_incrementer.rb

@@ -0,0 +1,32 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class OccurrenceIncrementer # :nodoc:
+         class BySecondIncrementer < ListIncrementer #:nodoc:
+
+          def self.for_rrule(rrule)
+            conditional_incrementer(rrule, :bysecond, SecondlyIncrementer)
+          end
+
+          def varying_time_attribute
+            :sec
+          end
+
+          def start_of_cycle(date_time)
+            date_time.start_of_minute
+          end
+
+          def advance_cycle(date_time)
+            date_time.advance(:minutes => 1).start_of_minute
+          end
+
+          def end_of_occurrence(date_time)
+            date_time
+          end
+        end
+      end
+    end
+  end
+end