demingfactor-ri_cal 0.9.0

data/lib/ri_cal/parser.rb

@@ -0,0 +1,148 @@
+module RiCal
+  #- ©2009 Rick DeNatale
+  #- All rights reserved. Refer to the file README.txt for the license
+  #
+  class Parser # :nodoc:
+    attr_reader :last_line_str #:nodoc:
+    def next_line #:nodoc:
+      result = nil
+      begin
+        result = buffer_or_line
+        @buffer = nil
+        while /^\s/ =~ buffer_or_line
+          result = "#{result}#{@buffer[1..-1]}"
+          @buffer = nil
+        end
+      rescue EOFError
+        return nil
+      ensure
+        return result
+      end
+    end
+
+    def self.parse_params(string) #:nodoc:
+      if string
+        string.split(";").inject({}) { |result, val|
+          m = /^(.+)=(.+)$/.match(val)
+          raise "Invalid parameter value #{val.inspect}" unless m
+          #TODO - The gsub below is a simplest fix for http://rick_denatale.lighthouseapp.com/projects/30941/tickets/19
+          #       it may need further examination if more pathological cases show up.
+          param_val = m[2].sub(/^\"(.*)\"$/, '\1') 
+          result[m[1]] = param_val
+          result 
+        }
+      else
+        nil
+      end
+    end
+
+    def self.params_and_value(string, optional_initial_semi = false) #:nodoc:
+      string = string.sub(/^:/,'')
+      return [{}, string] unless optional_initial_semi || string.match(/^;/)
+      segments = string.sub(';','').split(":", -1)
+      return [{}, string] if segments.length < 2
+      quote_count = 0
+      gathering_params = true
+      params = []
+      values = []
+      segments.each do |segment|
+        if gathering_params
+          params << segment
+          quote_count += segment.count("\"")
+          gathering_params = (1 == quote_count % 2)
+        else
+          values << segment
+        end
+      end
+      [parse_params(params.join(":")), values.join(":")]
+    end
+    
+    def separate_line(string) #:nodoc:
+      match = string.match(/^([^;:]*)(.*)$/)
+      name = match[1]
+      @last_line_str = string
+      params, value = *Parser.params_and_value(match[2])
+      {
+        :name => name,
+        :params => params,
+        :value => value,
+      }
+    end
+
+    def next_separated_line #:nodoc:
+      line = next_line
+      line ? separate_line(line) : nil
+    end
+
+    def buffer_or_line #:nodoc:
+      @buffer ||= @io.readline.chomp
+    end
+
+    def initialize(io = StringIO.new("")) #:nodoc:
+      @io = io
+    end
+
+    def self.parse(io = StringIO.new("")) #:nodoc:
+      new(io).parse
+    end
+
+    def invalid #:nodoc:
+      raise InvalidIcalendarFileError.new("Invalid icalendar file")
+    end
+
+    def still_in(component, separated_line) #:nodoc:
+      invalid unless separated_line
+      separated_line[:value] != component || separated_line[:name] != "END"
+    end
+
+    def parse #:nodoc:
+      result = []
+      while start_line = next_line
+        @parent_stack = []
+        component = parse_one(start_line, nil)
+        result << component if component
+      end
+      result
+    end
+
+    # TODO: Need to parse non-standard component types (iana-token or x-name)
+    def parse_one(start, parent_component) #:nodoc:
+
+      @parent_stack << parent_component
+      if Hash === start
+        first_line = start
+      else
+        first_line = separate_line(start)
+      end
+      invalid unless first_line[:name] == "BEGIN"
+      entity_name = first_line[:value]
+      result = case entity_name
+      when "VCALENDAR"
+        RiCal::Component::Calendar.from_parser(self, parent_component, entity_name)
+      when "VEVENT"
+        RiCal::Component::Event.from_parser(self, parent_component, entity_name)
+      when "VTODO"
+        RiCal::Component::Todo.from_parser(self, parent_component, entity_name)
+      when "VJOURNAL"
+        RiCal::Component::Journal.from_parser(self, parent_component, entity_name)
+      when "VFREEBUSY"
+        RiCal::Component::Freebusy.from_parser(self, parent_component, entity_name)
+      when "VTIMEZONE"
+        RiCal::Component::Timezone.from_parser(self, parent_component, entity_name)
+      when "VALARM"
+        RiCal::Component::Alarm.from_parser(self, parent_component, entity_name)
+      when "DAYLIGHT"
+        RiCal::Component::Timezone::DaylightPeriod.from_parser(self, parent_component, entity_name)
+      when "STANDARD"
+        RiCal::Component::Timezone::StandardPeriod.from_parser(self, parent_component, entity_name)
+      else
+        RiCal::Component::NonStandard.from_parser(self, parent_component, entity_name)
+      end
+      @parent_stack.pop
+      result
+    end
+  end
+
+  class InvalidICalendarFile < LoadError 
+  end
+end

data/lib/ri_cal/properties/alarm.rb

@@ -0,0 +1,390 @@
+module RiCal
+  module Properties #:nodoc:
+    #- ©2009 Rick DeNatale
+    #- All rights reserved. Refer to the file README.txt for the license
+    #
+    # Properties::Alarm provides property accessing methods for the Alarm class
+    # This source file is generated by the  rical:gen_propmodules rake tasks, DO NOT EDIT
+    module Alarm
+
+      # return the the ACTION property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property defines the action to be invoked when an alarm is triggered
+      # 
+      # see RFC 2445 4.8.6.1 p 126
+      def action_property
+        @action_property
+      end
+
+      # set the ACTION property
+      # property value should be an instance of RiCal::PropertyValueText
+      def action_property=(property_value)
+        @action_property = property_value
+      end
+
+      # set the value of the ACTION property
+      def action=(ruby_value)
+        self.action_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
+      end
+
+      # return the value of the ACTION property
+      # which will be an instance of String
+      def action
+        action_property ? action_property.ruby_value : nil
+      end
+
+      def action_property_from_string(line) # :nodoc:
+        @action_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      # return the the DESCRIPTION property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property provides a more complete description of the calendar component, than that provided by the "SUMMARY" property.
+      # 
+      # see RFC 2445 4.8.1.5 pp 81-82
+      def description_property
+        @description_property
+      end
+
+      # set the DESCRIPTION property
+      # property value should be an instance of RiCal::PropertyValueText
+      def description_property=(property_value)
+        @description_property = property_value
+      end
+
+      # set the value of the DESCRIPTION property
+      def description=(ruby_value)
+        self.description_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
+      end
+
+      # return the value of the DESCRIPTION property
+      # which will be an instance of String
+      def description
+        description_property ? description_property.ruby_value : nil
+      end
+
+      def description_property_from_string(line) # :nodoc:
+        @description_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      # return the the TRIGGER property
+      # which will be an instances of RiCal::PropertyValueDuration
+      # 
+      # [purpose (from RFC 2445)]
+      # This property specifies when an alarm will trigger.
+      # 
+      # see RFC 2445 4.8.6.3 p 127-129
+      def trigger_property
+        @trigger_property
+      end
+
+      # set the TRIGGER property
+      # property value should be an instance of RiCal::PropertyValueDuration
+      def trigger_property=(property_value)
+        @trigger_property = property_value
+      end
+
+      # set the value of the TRIGGER property
+      def trigger=(ruby_value)
+        self.trigger_property= RiCal::PropertyValue::Duration.convert(self, ruby_value)
+      end
+
+      # return the value of the TRIGGER property
+      # which will be an instance of Duration
+      def trigger
+        trigger_property ? trigger_property.ruby_value : nil
+      end
+
+      def trigger_property_from_string(line) # :nodoc:
+        @trigger_property = RiCal::PropertyValue::Duration.new(self, line)
+      end
+
+
+      # return the the DURATION property
+      # which will be an instances of RiCal::PropertyValueDuration
+      # 
+      # [purpose (from RFC 2445)]
+      # This property specifies a positive duration of time.
+      # 
+      # see RFC 2445 4.8.2.5 pp 94-95
+      def duration_property
+        @duration_property
+      end
+
+      # set the DURATION property
+      # property value should be an instance of RiCal::PropertyValueDuration
+      def duration_property=(property_value)
+        @duration_property = property_value
+      end
+
+      # set the value of the DURATION property
+      def duration=(ruby_value)
+        self.duration_property= RiCal::PropertyValue::Duration.convert(self, ruby_value)
+      end
+
+      # return the value of the DURATION property
+      # which will be an instance of Duration
+      def duration
+        duration_property ? duration_property.ruby_value : nil
+      end
+
+      def duration_property_from_string(line) # :nodoc:
+        @duration_property = RiCal::PropertyValue::Duration.new(self, line)
+      end
+
+
+      # return the the REPEAT property
+      # which will be an instances of RiCal::PropertyValueInteger
+      # 
+      # [purpose (from RFC 2445)]
+      # This property defines the number of times the alarm should be repeated, after the initial trigger.
+      # 
+      # see RFC 2445 4.8.6.2 p 126-127
+      def repeat_property
+        @repeat_property
+      end
+
+      # set the REPEAT property
+      # property value should be an instance of RiCal::PropertyValueInteger
+      def repeat_property=(property_value)
+        @repeat_property = property_value
+      end
+
+      # set the value of the REPEAT property
+      def repeat=(ruby_value)
+        self.repeat_property= RiCal::PropertyValue::Integer.convert(self, ruby_value)
+      end
+
+      # return the value of the REPEAT property
+      # which will be an instance of Integer
+      def repeat
+        repeat_property ? repeat_property.ruby_value : nil
+      end
+
+      def repeat_property_from_string(line) # :nodoc:
+        @repeat_property = RiCal::PropertyValue::Integer.new(self, line)
+      end
+
+
+      # return the the SUMMARY property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property defines a short summary or subject for the calendar component.
+      # 
+      # see RFC 2445 4.8.1.12 pp 89-90
+      def summary_property
+        @summary_property
+      end
+
+      # set the SUMMARY property
+      # property value should be an instance of RiCal::PropertyValueText
+      def summary_property=(property_value)
+        @summary_property = property_value
+      end
+
+      # set the value of the SUMMARY property
+      def summary=(ruby_value)
+        self.summary_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
+      end
+
+      # return the value of the SUMMARY property
+      # which will be an instance of String
+      def summary
+        summary_property ? summary_property.ruby_value : nil
+      end
+
+      def summary_property_from_string(line) # :nodoc:
+        @summary_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      # return the the ATTENDEE property
+      # which will be an array of instances of RiCal::PropertyValueCalAddress
+      # 
+      # [purpose (from RFC 2445)]
+      # The property defines an 'Attendee' within a calendar component.
+      # 
+      # see RFC 2445 4.8.4.1 pp 102-104
+      def attendee_property
+        @attendee_property ||= []
+      end
+
+      # set the the ATTENDEE property
+      # one or more instances of RiCal::PropertyValueCalAddress may be passed to this method
+      def attendee_property=(*property_values)
+        @attendee_property= property_values
+      end
+
+      # set the value of the ATTENDEE property to multiple values
+      # one or more instances of CalAddress may be passed to this method
+      def attendees=(ruby_values)
+        @attendee_property = ruby_values.map {|val| RiCal::PropertyValue::CalAddress.convert(self, val)}
+      end
+
+      # set the value of the ATTENDEE property to a single value
+      # one instance of CalAddress may be passed to this method
+      def attendee=(ruby_value)
+        @attendee_property = [RiCal::PropertyValue::CalAddress.convert(self, ruby_value)]
+      end
+
+      # add one or more values to the ATTENDEE property
+      # one or more instances of CalAddress may be passed to this method
+      def  add_attendees(*ruby_values)
+       ruby_values.each {|val|  self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, val)}
+      end
+
+      # add one value to the ATTENDEE property
+      # one instances of CalAddress may be passed to this method
+      def  add_attendee(ruby_value)
+       self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, ruby_value)
+      end
+
+      # remove one or more values from the ATTENDEE property
+      # one or more instances of CalAddress may be passed to this method
+      def  remove_attendees(*ruby_values)
+       ruby_values.each {|val|  self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, val))}
+      end
+
+      # remove one value from the ATTENDEE property
+      # one instances of CalAddress may be passed to this method
+      def  remove_attendee(ruby_value)
+       self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, ruby_value))
+      end
+
+      # return the value of the ATTENDEE property
+      # which will be an array of instances of CalAddress
+      def attendee
+        attendee_property.map {|prop| prop ? prop.ruby_value : prop}
+      end
+
+      def attendee_property_from_string(line) # :nodoc:
+        attendee_property << RiCal::PropertyValue::CalAddress.new(self, line)
+      end
+
+      # return the the ATTACH property
+      # which will be an array of instances of RiCal::PropertyValueUri
+      # 
+      # [purpose (from RFC 2445)]
+      # The property provides the capability to associate a document object with a calendar component.
+      # 
+      # see RFC 2445 4.8.1.1 pp 77-78
+      def attach_property
+        @attach_property ||= []
+      end
+
+      # set the the ATTACH property
+      # one or more instances of RiCal::PropertyValueUri may be passed to this method
+      def attach_property=(*property_values)
+        @attach_property= property_values
+      end
+
+      # set the value of the ATTACH property to multiple values
+      # one or more instances of Uri may be passed to this method
+      def attachments=(ruby_values)
+        @attach_property = ruby_values.map {|val| RiCal::PropertyValue::Uri.convert(self, val)}
+      end
+
+      # set the value of the ATTACH property to a single value
+      # one instance of Uri may be passed to this method
+      def attach=(ruby_value)
+        @attach_property = [RiCal::PropertyValue::Uri.convert(self, ruby_value)]
+      end
+
+      # add one or more values to the ATTACH property
+      # one or more instances of Uri may be passed to this method
+      def  add_attachments(*ruby_values)
+       ruby_values.each {|val|  self.attach_property << RiCal::PropertyValue::Uri.convert(self, val)}
+      end
+
+      # add one value to the ATTACH property
+      # one instances of Uri may be passed to this method
+      def  add_attach(ruby_value)
+       self.attach_property << RiCal::PropertyValue::Uri.convert(self, ruby_value)
+      end
+
+      # remove one or more values from the ATTACH property
+      # one or more instances of Uri may be passed to this method
+      def  remove_attachments(*ruby_values)
+       ruby_values.each {|val|  self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, val))}
+      end
+
+      # remove one value from the ATTACH property
+      # one instances of Uri may be passed to this method
+      def  remove_attach(ruby_value)
+       self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, ruby_value))
+      end
+
+      # return the value of the ATTACH property
+      # which will be an array of instances of Uri
+      def attach
+        attach_property.map {|prop| prop ? prop.ruby_value : prop}
+      end
+
+      def attach_property_from_string(line) # :nodoc:
+        attach_property << RiCal::PropertyValue::Uri.new(self, line)
+      end
+
+      def export_properties_to(export_stream) #:nodoc:
+        export_prop_to(export_stream, "DURATION", @duration_property)
+        export_prop_to(export_stream, "ATTENDEE", @attendee_property)
+        export_prop_to(export_stream, "TRIGGER", @trigger_property)
+        export_prop_to(export_stream, "DESCRIPTION", @description_property)
+        export_prop_to(export_stream, "SUMMARY", @summary_property)
+        export_prop_to(export_stream, "REPEAT", @repeat_property)
+        export_prop_to(export_stream, "ATTACH", @attach_property)
+        export_prop_to(export_stream, "ACTION", @action_property)
+      end
+
+      def ==(o) #:nodoc:
+        if o.class == self.class
+        (duration_property == o.duration_property) &&
+        (attendee_property == o.attendee_property) &&
+        (trigger_property == o.trigger_property) &&
+        (description_property == o.description_property) &&
+        (summary_property == o.summary_property) &&
+        (repeat_property == o.repeat_property) &&
+        (attach_property == o.attach_property) &&
+        (action_property == o.action_property)
+        else
+           super
+        end
+      end
+
+      def initialize_copy(o) #:nodoc:
+        super
+        duration_property = duration_property && duration_property.dup
+        attendee_property = attendee_property && attendee_property.dup
+        trigger_property = trigger_property && trigger_property.dup
+        description_property = description_property && description_property.dup
+        summary_property = summary_property && summary_property.dup
+        repeat_property = repeat_property && repeat_property.dup
+        attach_property = attach_property && attach_property.dup
+        action_property = action_property && action_property.dup
+      end
+
+      def add_date_times_to(required_timezones) #:nodoc:
+      end
+
+      module ClassMethods #:nodoc:
+        def property_parser #:nodoc:
+          {"ACTION"=>:action_property_from_string, "REPEAT"=>:repeat_property_from_string, "ATTENDEE"=>:attendee_property_from_string, "TRIGGER"=>:trigger_property_from_string, "ATTACH"=>:attach_property_from_string, "SUMMARY"=>:summary_property_from_string, "DESCRIPTION"=>:description_property_from_string, "DURATION"=>:duration_property_from_string}
+        end
+      end
+
+      def self.included(mod) #:nodoc:
+        mod.extend ClassMethods
+      end
+
+      def mutual_exclusion_violation #:nodoc:
+        false
+      end
+    end
+  end
+end

data/lib/ri_cal/properties/calendar.rb

@@ -0,0 +1,164 @@
+module RiCal
+  module Properties #:nodoc:
+    #- ©2009 Rick DeNatale
+    #- All rights reserved. Refer to the file README.txt for the license
+    #
+    # Properties::Calendar provides property accessing methods for the Calendar class
+    # This source file is generated by the  rical:gen_propmodules rake tasks, DO NOT EDIT
+    module Calendar
+
+      # return the the CALSCALE property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property defines the calendar scale used for the calendar information specified in the calendar object.
+      # 
+      # see RFC 2445 4.7.1 p 73
+      def calscale_property
+        @calscale_property ||= RiCal::PropertyValue::Text.convert(self, "GREGORIAN")
+      end
+
+      # return the value of the CALSCALE property
+      # which will be an instance of String
+      def calscale
+        calscale_property ? calscale_property.ruby_value : nil
+      end
+
+      def calscale_property_from_string(line) # :nodoc:
+        @calscale_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      # return the the METHOD property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property defines the iCalendar object method associated with the calendar object
+      # 
+      # see RFC 2445 4.7.2 p 74-75
+      def method_property
+        @method_property
+      end
+
+      # set the METHOD property
+      # property value should be an instance of RiCal::PropertyValueText
+      def method_property=(property_value)
+        @method_property = property_value
+      end
+
+      # set the value of the METHOD property
+      def icalendar_method=(ruby_value)
+        self.method_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
+      end
+
+      # return the value of the METHOD property
+      # which will be an instance of String
+      def icalendar_method
+        method_property ? method_property.ruby_value : nil
+      end
+
+      def method_property_from_string(line) # :nodoc:
+        @method_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      # return the the PRODID property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property specifies the identifier for the product that created the iCalendar object.
+      # 
+      # see RFC 2445 4.7.3 pp 75-76
+      def prodid_property
+        @prodid_property ||= RiCal::PropertyValue::Text.convert(self, "-//com.denhaven2/NONSGML ri_cal gem//EN")
+      end
+
+      # set the PRODID property
+      # property value should be an instance of RiCal::PropertyValueText
+      def prodid_property=(property_value)
+        @prodid_property = property_value
+      end
+
+      # set the value of the PRODID property
+      def prodid=(ruby_value)
+        self.prodid_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
+      end
+
+      # return the value of the PRODID property
+      # which will be an instance of String
+      def prodid
+        prodid_property ? prodid_property.ruby_value : nil
+      end
+
+      def prodid_property_from_string(line) # :nodoc:
+        @prodid_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      # return the the VERSION property
+      # which will be an instances of RiCal::PropertyValueText
+      # 
+      # [purpose (from RFC 2445)]
+      # This property specifies the identifier corresponding to thehighest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object.
+      # 
+      # see RFC 2445 4.7.4 pp 76-77
+      def version_property
+        @version_property ||= RiCal::PropertyValue::Text.convert(self, "2.0")
+      end
+
+      # return the value of the VERSION property
+      # which will be an instance of String
+      def version
+        version_property ? version_property.ruby_value : nil
+      end
+
+      def version_property_from_string(line) # :nodoc:
+        @version_property = RiCal::PropertyValue::Text.new(self, line)
+      end
+
+
+      def export_properties_to(export_stream) #:nodoc:
+        export_prop_to(export_stream, "CALSCALE", @calscale_property)
+        export_prop_to(export_stream, "PRODID", @prodid_property)
+        export_prop_to(export_stream, "VERSION", @version_property)
+        export_prop_to(export_stream, "METHOD", @method_property)
+      end
+
+      def ==(o) #:nodoc:
+        if o.class == self.class
+        (calscale_property == o.calscale_property) &&
+        (prodid_property == o.prodid_property) &&
+        (version_property == o.version_property) &&
+        (method_property == o.method_property)
+        else
+           super
+        end
+      end
+
+      def initialize_copy(o) #:nodoc:
+        super
+        calscale_property = calscale_property && calscale_property.dup
+        prodid_property = prodid_property && prodid_property.dup
+        version_property = version_property && version_property.dup
+        method_property = method_property && method_property.dup
+      end
+
+      def add_date_times_to(required_timezones) #:nodoc:
+      end
+
+      module ClassMethods #:nodoc:
+        def property_parser #:nodoc:
+          {"METHOD"=>:method_property_from_string, "VERSION"=>:version_property_from_string, "PRODID"=>:prodid_property_from_string, "CALSCALE"=>:calscale_property_from_string}
+        end
+      end
+
+      def self.included(mod) #:nodoc:
+        mod.extend ClassMethods
+      end
+
+      def mutual_exclusion_violation #:nodoc:
+        false
+      end
+    end
+  end
+end