ri_cal 0.5.0

data/lib/ri_cal/property_value/date_time/additive_methods.rb

@@ -0,0 +1,44 @@
+module RiCal
+  class PropertyValue
+    class DateTime
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      # Methods for DateTime which support adding or subtracting another DateTime or Duration
+      module AdditiveMethods
+        #  if end_time is nil => nil
+        #  otherwise convert end_time to a DateTime and compute the difference
+        def duration_until(end_time) # :nodoc:
+          end_time  && RiCal::PropertyValue::Duration.from_datetimes(timezone_finder, to_datetime, end_time.to_datetime)
+        end
+
+        # Double-dispatch method for subtraction.
+        def subtract_from_date_time_value(dtvalue) #:nodoc:
+          RiCal::PropertyValue::Duration.from_datetimes(timezone_finder, to_datetime,dtvalue.to_datetime)
+        end
+
+        # Double-dispatch method for addition.
+        def add_to_date_time_value(date_time_value) #:nodoc:
+          raise ArgumentError.new("Cannot add #{date_time_value} to #{self}")
+        end
+
+        # Return the difference between the receiver and other
+        #
+        # The parameter other should be either a RiCal::PropertyValue::Duration or a RiCal::PropertyValue::DateTime
+        #
+        # If other is a Duration, the result will be a DateTime, if it is a DateTime the result will be a Duration
+        def -(other)
+          other.subtract_from_date_time_value(self)
+        end
+
+        # Return the sum of the receiver and duration
+        #
+        # The parameter other duration should be  a RiCal::PropertyValue::Duration
+        #
+        # The result will be an RiCal::PropertyValue::DateTime
+        def +(duration)
+          duration.add_to_date_time_value(self)
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/date_time/time_machine.rb

@@ -0,0 +1,181 @@
+module RiCal
+  class PropertyValue
+    class DateTime
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      # Methods for DateTime which support getting values at different point in time.
+      module TimeMachine
+        def compute_change(d, options) # :nodoc:
+          ::DateTime.civil(
+          options[:year]  || d.year,
+          options[:month] || d.month,
+          options[:day]   || d.day,
+          options[:hour]  || d.hour,
+          options[:min]   || (options[:hour] ? 0 : d.min),
+          options[:sec]   || ((options[:hour] || options[:min]) ? 0 : d.sec),
+          options[:offset]  || d.offset,
+          options[:start]  || d.start
+          )
+        end
+
+        def compute_advance(d, options) # :nodoc:
+          d = d >> options[:years] * 12 if options[:years]
+          d = d >> options[:months]     if options[:months]
+          d = d +  options[:weeks] * 7  if options[:weeks]
+          d = d +  options[:days]       if options[:days]
+          datetime_advanced_by_date = compute_change(@date_time_value, :year => d.year, :month => d.month, :day => d.day)
+          seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
+          seconds_to_advance == 0 ? datetime_advanced_by_date : datetime_advanced_by_date + Rational(seconds_to_advance.round, 86400)
+        end
+
+        def advance(options) # :nodoc:
+          PropertyValue::DateTime.new(timezone_finder,
+          :value => compute_advance(@date_time_value, options),
+          :tzid => @tzid,
+          :params =>(params ? params.dup : nil)
+          )
+        end
+
+        def change(options) # :nodoc:
+          PropertyValue::DateTime.new(timezone_finder,
+          :value => compute_change(@date_time_value, options),
+          :tzid => @tzid,
+          :params => (params ? params.dup : nil)
+          )
+        end
+
+        def change_sec(new_sec) #:nodoc:
+          PropertyValue::DateTime.civil(self.year, self.month, self.day, self.hour, self.min, sec, self.offset, self.start, params)
+        end
+
+        def change_min(new_min) #:nodoc:
+          PropertyValue::DateTime.civil(self.year, self.month, self.day, self.hour, new_min, self.sec, self.offset, self.start, params)
+        end
+
+        def change_hour(new_hour) #:nodoc:
+          PropertyValue::DateTime.civil(self.year, self.month, self.day, new_hour, self.min, self.sec, self.offset, self.start, params)
+        end
+
+        def change_day(new_day) #:nodoc:
+          PropertyValue::DateTime.civil(self.year, self.month, new_day, self.hour, self.min, self.sec, self.offset, self.start, params)
+        end
+
+        def change_month(new_month) #:nodoc:
+          PropertyValue::DateTime.civil(self.year, new_month, self.day, self.hour, self.min, self.sec, self.offset, self.start, params)
+        end
+
+        def change_year(new_year) #:nodoc:
+          PropertyValue::DateTime.civil(new_year, self.month, self.day, self.hour, self.min, self.sec, self.offset, self.start, params)
+        end
+
+        # Return a DATE-TIME property representing the receiver on a different day (if necessary) so that
+        # the result is within the 7 days starting with date
+        def in_week_starting?(date)
+          wkst_jd = date.jd
+          @date_time_value.jd.between?(wkst_jd, wkst_jd + 6)
+        end
+
+        # Return a DATE-TIME property representing the receiver on a different day (if necessary) so that
+        # the result is the first day of the ISO week starting on the wkst day containing the receiver.
+        def at_start_of_week_with_wkst(wkst)
+          date = @date_time_value.start_of_week_with_wkst(wkst)
+          change(:year => date.year, :month => date.month, :day => date.day)
+        end
+        # Return a DATE_TIME value representing the first second of the minute containing the receiver
+        def start_of_minute
+          change(:sec => 0)
+        end
+
+        # Return a DATE_TIME value representing the last second of the minute containing the receiver
+        def end_of_minute
+          change(:sec => 59)
+        end
+
+        # Return a DATE_TIME value representing the first second of the hour containing the receiver
+        def start_of_hour
+          change(:min => 0, :sec => 0)
+        end
+
+        # Return a DATE_TIME value representing the last second of the hour containing the receiver
+        def end_of_hour
+          change(:min => 59, :sec => 59)
+        end
+
+        # Return a DATE_TIME value representing the first second of the day containing the receiver
+        def start_of_day
+          change(:hour => 0, :min => 0, :sec => 0)
+        end
+
+        # Return a DATE_TIME value representing the last second of the day containing the receiver
+        def end_of_day
+          change(:hour => 23, :min => 59, :sec => 59)
+        end
+
+        # Return a Ruby Date representing the first day of the ISO week starting with wkst containing the receiver
+        def start_of_week_with_wkst(wkst)
+          @date_time_value.start_of_week_with_wkst(wkst)
+        end
+
+        # Return a DATE_TIME value representing the last second of the ISO week starting with wkst containing the receiver
+        def end_of_week_with_wkst(wkst)
+          date = at_start_of_week_with_wkst(wkst).advance(:days => 6).end_of_day
+        end
+
+        # Return a DATE_TIME value representing the first second of the month containing the receiver
+        def start_of_month
+          change(:day => 1, :hour => 0, :min => 0, :sec => 0)
+        end
+
+        # Return a DATE_TIME value representing the last second of the month containing the receiver
+        def end_of_month
+          change(:day => days_in_month, :hour => 23, :min => 59, :sec => 59)
+        end
+
+        # Return a DATE_TIME value representing the first second of the month containing the receiver
+        def start_of_year
+          change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0)
+        end
+
+        # Return a DATE_TIME value representing the last second of the month containing the receiver
+        def end_of_year
+          change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59)
+        end
+
+        # Return a DATE_TIME value representing the same time on the first day of the ISO year with weeks
+        # starting on wkst containing the receiver
+        def at_start_of_iso_year(wkst)
+          start_of_year = @date_time_value.iso_year_start(wkst)
+          change(:year => start_of_year.year, :month => start_of_year.month, :day => start_of_year.day)
+        end
+
+        # Return a DATE_TIME value representing the same time on the last day of the ISO year with weeks
+        # starting on wkst containing the receiver
+        def at_end_of_iso_year(wkst)
+          num_weeks = @date_time_value.iso_weeks_in_year(wkst)
+          at_start_of_iso_year(wkst).advance(:weeks => (num_weeks - 1), :days => 6)
+        end
+
+        # Return a DATE_TIME value representing the same time on the first day of the ISO year with weeks
+        # starting on wkst after the ISO year containing the receiver
+        def at_start_of_next_iso_year(wkst)
+          num_weeks = @date_time_value.iso_weeks_in_year(wkst)
+          at_start_of_iso_year(wkst).advance(:weeks => num_weeks)
+        end
+
+        # Return a DATE_TIME value representing the last second of the last day of the ISO year with weeks
+        # starting on wkst containing the receiver
+        def end_of_iso_year(wkst)
+          at_end_of_iso_year(wkst).end_of_day
+        end
+
+        # Return a DATE-TIME representing the same time, on the same day of the month in month.
+        # If the month of the receiver has more days than the target month the last day of the target month
+        # will be used.
+        def in_month(month)
+          first = change(:day => 1, :month => month)
+          first.change(:day => [first.days_in_month, day].min)
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/date_time/timezone_support.rb

@@ -0,0 +1,96 @@
+module RiCal
+  class PropertyValue
+    class DateTime
+      #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+      #
+      # Time zone related methods for DateTime
+      module TimezoneSupport
+        # Return the timezone id of the receiver, or nil if it is a floating time
+        def tzid
+          @tzid  == :floating ? nil : @tzid
+        end
+
+        def tzid=(timezone_id) #:nodoc:
+          timezone_id = default_tzid if timezone_id == :default
+          @tzid = timezone_id
+          @timezone = nil
+        end
+
+        def find_timezone #:nodoc:
+          if @tzid == :floating
+            FloatingTimezone
+          else
+            timezone_finder.find_timezone(@tzid)
+          end
+        end
+
+        def timezone #:nodoc:
+          @timezone ||= find_timezone
+        end
+
+        # Determine if the receiver has a local time zone, i.e. it is not a floating time or a UTC time
+        def has_local_timezone?
+          tzid && tzid.upcase != "UTC"
+        end
+
+        # Return the receiver if it has a floating time zone already,
+        # otherwise return a DATETIME property with the same time as the receiver but with a floating time zone
+        def with_floating_timezone
+          if @tzid == nil
+            self
+          else
+            @date_time_value.with_floating_timezone.to_ri_cal_date_time_value
+          end
+        end
+
+        # Returns a instance that represents the time in UTC.
+        def utc
+          if has_local_timezone?
+            timezone.local_to_utc(self)
+          else  # Already local or a floating time
+            self
+          end
+        end
+
+        def rational_tz_offset #:nodoc:
+          if has_local_timezone?
+            timezone.rational_utc_offset(@date_time_value)
+          else
+            Rational(0,24)
+          end
+        end
+
+        # Predicate indicating whether or not the instance represents a ZULU time
+        def utc?
+          tzid == "UTC"
+        end
+
+        # Predicate indicating whether or not the instance represents a floating time
+        def floating?
+          tzid.nil?
+        end
+        
+        def has_valid_tzinfo_tzid? #:nodoc:
+          if tzid && tzid != :floating
+            TZInfo::Timezone.get(tzid) rescue false
+          else
+            false
+          end
+        end
+
+        # Returns the simultaneous time in the specified zone.
+        def in_time_zone(new_zone)
+          new_zone = timezone_finder.find_timezone(new_zone)
+          return self if tzid == new_zone.identifier
+          if has_local_timezone?
+            new_zone.utc_to_local(utc)
+          elsif utc?
+            new_zone.utc_to_local(self)
+          else # Floating time
+            DateTime.new(timezone_finder, :value => @date_time_value, :tzid => new_zone.identifier)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ri_cal/property_value/duration.rb

@@ -0,0 +1,110 @@
+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 Duration property value
+    # which is defined in 
+    # rfc 2445 section 4.3.6 p 37
+    class Duration < PropertyValue
+
+      def self.value_part(unit, diff) # :nodoc:
+        (diff == 0) ? nil : "#{diff}#{unit}"
+      end
+
+      def self.from_datetimes(parent, start, finish, sign='+') # :nodoc:
+        if start > finish
+          from_datetimes(self, finish, start, '-')
+        else
+          diff = finish - start
+          days_diff = diff.to_i
+          hours = (diff - days_diff) * 24
+          hour_diff = hours.to_i
+          minutes = (hours - hour_diff) * 60
+          min_diff = minutes.to_i
+          seconds = (minutes - min_diff) * 60
+          sec_diff = seconds.to_i
+
+          day_part = value_part('D',days_diff)
+          hour_part = value_part('H', hour_diff)
+          min_part = value_part('M', min_diff)
+          sec_part = value_part('S', sec_diff)
+          t_part = (hour_diff.abs + min_diff.abs + sec_diff.abs) == 0 ? "" : "T"
+          new(parent, :value => "#{sign}P#{day_part}#{t_part}#{hour_part}#{min_part}#{sec_part}")        
+        end
+      end
+
+      def self.convert(parent, ruby_object) # :nodoc:
+        ruby_object.to_ri_cal_duration_value.for_parent(parent)
+      end
+
+      def value=(string) # :nodoc:
+        super
+        match = /([+-])?P(.*)$/.match(string)
+        @days = @hours = @minutes = @seconds = @weeks = 0
+        if match
+          @sign = match[1] == '-' ? -1 : 1
+          match[2].scan(/(\d+)([DHMSW])/) do |digits, unit|
+            number = digits.to_i
+            case unit
+            when 'D'
+              @days = number
+            when 'H'
+              @hours = number
+            when 'M'
+              @minutes = number
+            when 'S'
+              @seconds = number
+            when 'W'
+              @weeks = number
+            end
+          end
+        end
+      end
+      
+      def self.valid_string?(string) #:nodoc:
+        string =~  /^[+-]?P((\d+)[DHMSW])+$/
+      end
+
+      def days # :nodoc:
+        @days * @sign
+      end
+
+      def weeks # :nodoc:
+        @weeks * @sign
+      end
+
+      def hours # :nodoc:
+        @hours * @sign
+      end
+
+      def minutes # :nodoc:
+        @minutes * @sign
+      end
+
+      def seconds # :nodoc:
+        @seconds * @sign
+      end
+
+      # Determine whether another object is an equivalent RiCal::PropertyValue::Duration
+      def ==(other)
+        other.kind_of?(PropertyValue::Duration) && value == other.value
+      end
+
+      # Returns the receiver
+      def to_ri_cal_duration_value
+        self
+      end
+
+      # Double-dispatch method to support RiCal::PropertyValue::DateTime.-
+      def subtract_from_date_time_value(date_time_value)
+        date_time_value.advance(:weeks => -weeks, :days => -days, :hours => -hours, :minutes => -minutes, :seconds => -seconds)
+      end
+
+      # Double-dispatch method to support RiCal::PropertyValue::DateTime.+
+      def add_to_date_time_value(date_time_value)
+        date_time_value.advance(:weeks => weeks, :days => days, :hours => hours, :minutes => minutes, :seconds => seconds)
+      end
+
+    end
+  end
+end

data/lib/ri_cal/property_value/geo.rb

@@ -0,0 +1,11 @@
+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 Duration property value
+    # which is defined in 
+    # rfc 2445 section 4.8.1.6 pp 82-83
+    class Geo < PropertyValue
+    end
+  end
+end

data/lib/ri_cal/property_value/integer.rb

@@ -0,0 +1,12 @@
+module RiCal
+  class PropertyValue
+    #- ©2009 Rick DeNatale, All rights reserved. Refer to the file README.txt for the license
+    #
+    class Integer < PropertyValue # :nodoc:
+
+      def value=(string)
+        @value = string.to_i 
+      end
+    end
+  end
+end