awallis-ri_cal 0.8.8

data/lib/ri_cal/property_value/period.rb

@@ -0,0 +1,86 @@
+module RiCal
+  class PropertyValue
+    #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+    #
+    # RiCal::PropertyValue::CalAddress represents an icalendar Period property value
+    # which is defined in 
+    # rfc 2445 section 4.3.9 p 39
+    #
+    # Known bugs.  This doesn't properly work when dtstart, dtend or duration are changed independently
+    class Period < PropertyValue
+
+      # The DATE-TIME on which the period starts
+      attr_accessor :dtstart
+      # The DATE-TIME on which the period ends
+      attr_accessor :dtend
+      # The DURATION of the period
+      attr_accessor :duration
+
+      def value=(string) # :nodoc:
+        starter, terminator = *string.split("/")
+        self.dtstart = PropertyValue::DateTime.new(self, :value => starter)
+        if /P/ =~ terminator
+          self.duration = PropertyValue::Duration.new(self, :value => terminator)
+          self.dtend = dtstart + duration
+        else
+          self.dtend   = PropertyValue::DateTime.new(self, :value => terminator)
+          self.duration = PropertyValue::Duration.from_datetimes(self, dtstart.to_datetime, dtend.to_datetime)        
+        end
+        @value = string
+      end
+      
+      def ruby_value
+        self
+      end
+      
+      def self.valid_string?(string) # :nodoc:
+        return false unless string.include?("/")
+        starter, terminator = *string.split("/")
+        return false unless PropertyValue::DateTime.valid_string?(starter)
+        if /P/ =~ terminator
+          return false unless PropertyValue::Duration.valid_string?(terminator)
+        else
+          return false unless PropertyValue::DateTime.valid_string?(terminator)
+        end
+        true
+      end
+      
+      # Nop to allow occurrence list to try to set it
+      def tzid=(val)#:nodoc:
+      end
+      
+      def tzid #:nodoc:
+        nil
+      end
+      
+      def for_parent(parent) #:nodoc:
+        if timezone_finder.nil
+          @timezone_finder = parent
+          self
+        elsif timezone_finder == parent
+          self
+        else
+          Period.new(parent, :value => value)
+        end
+      end
+      
+      def self.convert(parent, ruby_object) # :nodoc:
+        ruby_object.to_ri_cal_period_value.for_parent(parent)
+      end
+
+      # return the receiver
+      def to_ri_cal_period_value
+        self
+      end
+
+      def occurrence_period(default_duration) #:nodoc:
+        RiCal::OccurrencePeriod.new(self, (default_duration ? self + default_duration : nil))
+      end
+
+      def add_date_times_to(required_timezones) #:nodoc:
+        dtstart.add_date_times_to(required_timezones)
+        dtend.add_date_times_to(required_timezones)
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/recurrence_rule.rb

@@ -0,0 +1,154 @@
+module RiCal
+  class PropertyValue
+    #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+    #
+    # RiCal::PropertyValue::RecurrenceRule represents an icalendar Recurrence Rule property value
+    # which is defined in 
+    # rfc 2445 section 4.3.10 pp 40-45
+    class RecurrenceRule < PropertyValue
+      
+      autoload :EnumerationSupportMethods, "ri_cal/property_value/recurrence_rule/enumeration_support_methods.rb"
+      autoload :OccurrenceIncrementer,     "ri_cal/property_value/recurrence_rule/occurrence_incrementer.rb"
+      autoload :Enumerator, "ri_cal/property_value/recurrence_rule/enumerator.rb"
+      autoload :InitializationMethods, "ri_cal/property_value/recurrence_rule/initialization_methods.rb"
+      autoload :NegativeSetposEnumerator, "ri_cal/property_value/recurrence_rule/negative_setpos_enumerator.rb"
+      autoload :NumberedSpan, "ri_cal/property_value/recurrence_rule/numbered_span.rb"
+      autoload :RecurringDay, "ri_cal/property_value/recurrence_rule/recurring_day.rb"
+      autoload :RecurringMonthDay, "ri_cal/property_value/recurrence_rule/recurring_month_day.rb"
+      autoload :RecurringNumberedWeek, "ri_cal/property_value/recurrence_rule/recurring_numbered_week.rb"
+      autoload :RecurringYearDay, "ri_cal/property_value/recurrence_rule/recurring_year_day.rb"
+      autoload :TimeManipulation, "ri_cal/property_value/recurrence_rule/time_manipulation.rb"
+      autoload :Validations, "ri_cal/property_value/recurrence_rule/validations.rb"
+      
+      def initialize(parent, value_hash) # :nodoc:
+        @by_list_hash = {}
+        super
+        init_by_lists
+        @by_list_hash = nil
+      end
+      
+      def self.convert(parent, value) #:nodoc:
+        if String === value
+          result = new(parent, :value => value)
+        else
+          result = new(parent, value)
+        end
+        result
+      end
+      
+      include Validations
+      include InitializationMethods
+      include EnumerationSupportMethods
+
+      # The integer count value of the receiver, or nil
+      attr_reader :count
+      # The DATE-TIME value of until limit of the receiver, or nil
+      attr_reader :until
+
+      def value=(string) # :nodoc:
+        if string
+          @value = string
+          dup_hash = {}
+          string.split(";").each do |value_part|
+            initialize_from_value_part(value_part, dup_hash)
+          end
+        end
+      end
+
+      # Set the frequency of the recurrence rule
+      # freq_value:: a String which should be in %w[SECONDLY MINUTELY HOURLY DAILY WEEKLY MONTHLY YEARLY]
+      # 
+      # This method resets the receivers list of errors
+      def freq=(freq_value)
+        reset_errors
+        @freq = freq_value
+      end
+
+      # return the frequency of the rule which will be a string 
+      def freq
+        @freq.upcase
+      end
+
+      # return the starting week day for the recurrence rule, which for a valid instance will be one of
+      # "SU", "MO", "TU", "WE", "TH", "FR", or "SA"
+      def wkst
+        @wkst || 'MO'
+      end
+
+      def wkst_day # :nodoc:
+        @wkst_day ||= (%w{SU MO TU WE FR SA}.index(wkst) || 1)
+      end
+
+      # Set the starting week day for the recurrence rule, which should  be one of
+      # "SU", "MO", "TU", "WE", "TH", "FR", or "SA" for the instance to be valid.
+      # The parameter is however case-insensitive.
+      # 
+      # This method resets the receivers list of errors
+      def wkst=(value)
+        reset_errors
+        @wkst = value
+        @wkst_day = nil
+      end
+
+      # Set the count parameter of the recurrence rule, the count value will be converted to an integer using to_i
+      # 
+      # This method resets the receivers list of errors
+      
+      def count=(count_value)
+        reset_errors
+        @count = count_value
+        @until = nil unless @count.nil? || @by_list_hash
+      end
+
+      # Set the until parameter of the recurrence rule
+      #
+      # until_value:: the value to be set, this may be either a string in RFC 2446 Date or DateTime value format
+      # Or a Date, Time, DateTime, RiCal::PropertyValue::Date, or RiCal::PropertyValue::DateTime
+      #
+      def until=(until_value)
+        reset_errors
+        @until = until_value && until_value.to_ri_cal_date_or_date_time_value(timezone_finder)
+        @count = nil unless @count.nil? || @by_list_hash
+      end
+
+      # return the INTERVAL parameter of the recurrence rule
+      # This returns an Integer
+      def interval
+        @interval ||= 1
+      end
+
+      # Set the INTERVAL parameter of the recurrence rule
+      #
+      # interval_value:: an Integer
+      #
+      # This method resets the receivers list of errors
+      def interval=(interval_value)
+        reset_errors
+        @interval = interval_value
+      end
+      
+      def value #:nodoc:
+        @value || to_ical
+      end      
+
+      # Return a string containing the RFC 2445 representation of the recurrence rule
+      def to_ical
+        result = ["FREQ=#{freq}"]
+        result << "INTERVAL=#{interval}" unless interval == 1
+        result << "COUNT=#{count}" if count
+        result << "UNTIL=#{self.until.value}" if self.until
+        %w{bysecond byminute byhour byday bymonthday byyearday byweekno bymonth bysetpos}.each do |by_part|
+          val = by_list[by_part.to_sym]
+          result << "#{by_part.upcase}=#{[val].flatten.join(',')}" if val
+        end
+        result << "WKST=#{wkst}" unless wkst == "MO"
+        result.join(";")
+      end
+      
+      # Predicate to determine if the receiver generates a bounded or infinite set of occurrences
+      def bounded?
+        @count || @until
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      module EnumerationSupportMethods # :nodoc:
+
+        # if the recurrence rule has a bysetpos part we need to search starting with the
+        # first time in the frequency period containing the start time specified by DTSTART
+        def adjust_start(start_time) # :nodoc:
+          if by_list[:bysetpos]
+            case freq
+            when "SECONDLY"
+              start_time
+            when "MINUTELY"
+              start_time.change(:seconds => 0)
+            when "HOURLY"
+              start_time.change(
+              :minutes => 0,
+              :seconds => start_time.sec
+              )
+            when "DAILY"
+              start_time.change(
+              :hour => 0,
+              :minutes => start_time.min,
+              :seconds => start_time.sec
+              )
+            when "WEEKLY"
+              start_of_week(time)
+            when "MONTHLY"
+              start_time.change(
+              :day => 1,
+              :hour => start_time.hour,
+              :minutes => start_time.min,
+              :seconds => start_time.sec
+              )
+            when "YEARLY"
+              start_time.change(
+              :month => 1,
+              :day => start_time.day,
+              :hour => start_time.hour,
+              :minutes => start_time.min,
+              :seconds => start_time.sec
+              )
+            end
+          else
+            start_time
+          end
+        end
+
+        def enumerator(component) # :nodoc:
+          Enumerator.for(self, component, by_list[:bysetpos])
+        end
+
+        def exhausted?(count, time) # :nodoc:
+          (@count && count > @count) || (@until && (time > @until))
+        end
+
+        def in_same_set?(time1, time2) # :nodoc:
+          case freq
+          when "SECONDLY"
+            [time1.year, time1.month, time1.day, time1.hour, time1.min, time1.sec] ==
+            [time2.year, time2.month, time2.day, time2.hour, time2.min, time2.sec]
+          when "MINUTELY"
+            [time1.year, time1.month, time1.day, time1.hour, time1.min] ==
+            [time2.year, time2.month, time2.day, time2.hour, time2.min]
+          when "HOURLY"
+            [time1.year, time1.month, time1.day, time1.hour] ==
+            [time2.year, time2.month, time2.day, time2.hour]
+          when "DAILY"
+            [time1.year, time1.month, time1.day] ==
+            [time2.year, time2.month, time2.day]
+          when "WEEKLY"
+            sow1 = start_of_week(time1)
+            sow2 = start_of_week(time2)
+            [sow1.year, sow1.month, sow1.day] ==
+            [sow2.year, sow2.month, sow2.day]
+          when "MONTHLY"
+            [time1.year, time1.month] ==
+            [time2.year, time2.month]
+          when "YEARLY"
+            time1.year == time2.year
+          end
+        end
+
+         def by_rule_list(which) # :nodoc:
+          if @by_list
+            @by_list[which]
+          else
+            nil
+          end
+        end
+
+        def incrementer_from_start_time(start_time)
+          RecurrenceRule::OccurrenceIncrementer.from_rrule(self, start_time)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      class Enumerator # :nodoc:
+        # base_time gets changed everytime the time is updated by the recurrence rule's frequency
+        attr_accessor :start_time, :duration, :next_time, :recurrence_rule, :base_time
+        def initialize(recurrence_rule, component, setpos_list)
+          self.recurrence_rule = recurrence_rule
+          self.start_time = component.default_start_time
+          self.duration = component.default_duration
+          self.next_time = recurrence_rule.adjust_start(self.start_time)
+          self.base_time = next_time
+          @bounded = recurrence_rule.bounded?
+          @count = 0
+          @setpos_list = setpos_list
+          @setpos = 1
+          @next_occurrence_count = 0
+          @incrementer = recurrence_rule.incrementer_from_start_time(start_time)
+        end
+
+        def self.for(recurrence_rule, component, setpos_list) # :nodoc:
+          if !setpos_list || setpos_list.all? {|setpos| setpos > 1}
+            self.new(recurrence_rule, component, setpos_list)
+          else
+            NegativeSetposEnumerator.new(recurrence_rule, component, setpos_list)
+          end
+        end
+
+         def empty?
+          false
+        end
+
+        def bounded?
+          @bounded
+        end
+
+        def result_occurrence_period(date_time_value)
+          RiCal::OccurrencePeriod.new(date_time_value, nil)
+        end
+
+        def result_passes_setpos_filter?(result)
+          result_setpos = @setpos
+          if recurrence_rule.in_same_set?(result, next_time)
+            @setpos += 1
+          else
+            @setpos = 1
+          end
+          if (result == start_time) || (result > start_time && @setpos_list.include?(result_setpos))
+            return true
+          else
+            return false
+          end
+        end
+
+        def result_passes_filters?(result)
+          if @setpos_list
+            result_passes_setpos_filter?(result)
+          else
+            result >= start_time
+          end
+        end
+
+        def next_occurrence
+          while true
+            @next_occurrence_count += 1
+            result = next_time
+            self.next_time = @incrementer.next_time(result)
+            if result_passes_filters?(result)
+              @count += 1
+              return recurrence_rule.exhausted?(@count, result) ? nil : result_occurrence_period(result)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+module RiCal
+  class PropertyValue
+    class RecurrenceRule < PropertyValue
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      module InitializationMethods # :nodoc:
+        
+        attr_reader :by_day_scope
+        
+        def add_to_options_hash(options_hash, key, value)
+          options_hash[key] = value if value
+          options_hash
+        end
+        
+        def add_byrule_strings_to_options_hash(options_hash, key)
+          if (rules = by_list[key])
+            if rules.length == 1
+              options_hash[key] = rules.first.source
+            else
+              options_hash[key] = rules.map {|rule| rule.source}
+            end
+          end
+        end
+        
+        def to_options_hash
+          options_hash = {:freq => freq, :interval => interval}
+          options_hash[:params] = params unless params.empty?
+          add_to_options_hash(options_hash, :count, @count)
+          add_to_options_hash(options_hash, :until, @until)
+          add_to_options_hash(options_hash, :interval, @interval)
+          [:bysecond, :byminute, :byhour, :bymonth, :bysetpos].each do |bypart|
+              add_to_options_hash(options_hash, bypart, by_list[bypart])
+            end
+          [:byday, :bymonthday, :byyearday, :byweekno].each do |bypart|
+             add_byrule_strings_to_options_hash(options_hash, bypart)
+          end
+          options_hash
+        end
+
+        def initialize_from_value_part(part, dup_hash) # :nodoc:
+          part_name, value = part.split("=")
+          attribute = part_name.downcase
+          errors << "Repeated rule part #{attribute} last occurrence was used" if dup_hash[attribute]
+          case attribute
+          when "freq"
+            self.freq = value
+          when "wkst"
+            self.wkst = value
+          when "until"
+            @until = PropertyValue.date_or_date_time(self, :value => value)
+          when "count"
+            @count = value.to_i
+          when "interval"
+            self.interval = value.to_i
+          when "bysecond", "byminute", "byhour", "bymonthday", "byyearday", "byweekno", "bymonth", "bysetpos"
+            send("#{attribute}=", value.split(",").map {|int| int.to_i})
+          when "byday"
+            self.byday = value.split(",")
+          else
+            errors << "Invalid rule part #{part}"
+          end
+        end
+
+        def by_list
+          @by_list ||= {}
+        end
+        
+        def calc_by_day_scope
+          case freq
+          when "YEARLY"
+            scope = :yearly
+          when "MONTHLY"
+            scope = :monthly
+          when "WEEKLY"
+            scope = :weekly
+          else
+            scope = :daily
+          end
+          scope = :monthly if scope != :weekly && @by_list_hash[:bymonth]
+          scope = :weekly if scope != :daily && @by_list_hash[:byweekno]
+          @by_day_scope = scope
+        end
+        
+        def bysecond=(val)
+          @by_list_hash[:bysecond] = val
+        end
+
+        def byminute=(val)
+          @by_list_hash[:byminute] = val
+        end
+
+        def byhour=(val)
+          @by_list_hash[:byhour] = val
+        end
+
+        def bymonth=(val)
+          @by_list_hash[:bymonth] = val
+        end
+
+        def bysetpos=(val)
+          @by_list_hash[:bysetpos] = val
+        end
+
+        def byday=(val)
+          @by_list_hash[:byday] = val
+        end
+
+        def bymonthday=(val)
+          @by_list_hash[:bymonthday] = val
+        end
+
+        def byyearday=(val)
+          @by_list_hash[:byyearday] = val
+        end
+
+        def byweekno=(val)
+          @by_list_hash[:byweekno] = val
+        end
+
+        def init_by_lists
+          [:bysecond,
+            :byminute,
+            :byhour,
+            :bymonth,
+            :bysetpos
+            ].each do |which|
+              if val = @by_list_hash[which]
+                by_list[which] = [val].flatten.sort
+              end
+            end
+            if val = @by_list_hash[:byday]
+              byday_scope =  calc_by_day_scope 
+              by_list[:byday] = [val].flatten.map {|day| RecurringDay.new(day, self, byday_scope)}
+            end
+            if val = @by_list_hash[:bymonthday]
+              by_list[:bymonthday] = [val].flatten.map {|md| RecurringMonthDay.new(md)}
+            end
+            if val = @by_list_hash[:byyearday]
+              by_list[:byyearday] = [val].flatten.map {|yd| RecurringYearDay.new(yd)}
+            end
+            if val = @by_list_hash[:byweekno]
+              by_list[:byweekno] = [val].flatten.map {|wkno| RecurringNumberedWeek.new(wkno, self)}
+            end
+          end
+        end
+      end
+    end
+  end