icalendar 0.95

data/lib/icalendar/component/alarm.rb

@@ -0,0 +1,35 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar 
+  # An Alarm calendar component is a grouping of component
+  # properties that is a reminder or alarm for an event or a
+  # to-do. For example, it may be used to define a reminder for a
+  # pending Event or an overdue Todo.  
+  class Alarm < Component
+  
+    # Single properties
+    ical_property :action
+    ical_property :trigger
+    
+    # Single but must appear together
+    ical_property :duration
+    ical_property :repeat
+    
+    # Single and only occurring once
+    ical_property :attach, :attachment
+    
+    def initialize()
+      super("VALARM")
+      
+    end
+
+    def to_ical
+      print_string {}
+    end
+  end
+end

data/lib/icalendar/component/event.rb

@@ -0,0 +1,68 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+module Icalendar
+  # A Event calendar component is a grouping of component
+  # properties, and possibly including Alarm calendar components, that
+  # represents a scheduled amount of time on a calendar. For example, it
+  # can be an activity; such as a one-hour long, department meeting from
+  # 8:00 AM to 9:00 AM, tomorrow. Generally, an event will take up time
+  # on an individual calendar.
+  class Event < Component
+    attr_accessor :alarms
+
+    # Single properties
+    ical_property :klass, nil, :class
+    ical_property :created
+    ical_property :description
+    ical_property :dtstart, :start
+    ical_property :geo
+    ical_property :last_mod, :last_modification
+    ical_property :location
+    ical_property :organizer
+    ical_property :priority
+    ical_property :dtstamp, :timestamp
+    ical_property :seq, :sequence
+    ical_property :status
+    ical_property :summary
+    ical_property :transp, :transparency
+    ical_property :uid, :user_id
+    ical_property :url
+    ical_property :recurid, :recurrence_id
+
+    # Single but mutually exclusive TODO: not testing anything yet
+    ical_property :dtend, :end
+    ical_property :duration
+
+    # Multi-properties
+    ical_multi_property :attach, :attachment, :attachments
+    ical_multi_property :attendee, :attendee, :attendees
+    ical_multi_property :categories, :category, :categories
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :contact, :contact, :contacts
+    ical_multi_property :exdate, :exception_date, :exception_dates
+    ical_multi_property :exrule, :exception_rule, :exception_rules
+    ical_multi_property :rstatus, :request_status, :request_statuses
+    ical_multi_property :related_to, :related_to, :related_tos
+    ical_multi_property :resources, :resource, :resources
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+    
+    def initialize()
+      super("VEVENT")
+      
+      @alarms = []
+    end
+
+    def to_ical
+      print_string do |s| 
+        @alarms.each { |alarm| s << alarm.to_ical } 
+      end
+    end
+  end
+end

data/lib/icalendar/component/freebusy.rb

@@ -0,0 +1,35 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+    # A Freebusy calendar component is a grouping of
+    # component properties that represents either a request for, a reply to
+    # a request for free or busy time information or a published set of
+    # busy time information.
+    class Freebusy < Component
+      
+          # Single properties
+    ical_property :contact
+    ical_property :dtstart, :start
+    ical_property :dtend, :end
+    ical_property :dtstamp, :timestamp
+    ical_property :duration
+    ical_property :organizer
+    ical_property :uid, :user_id
+    ical_property :url
+    
+    # Multi-properties
+    ical_multi_property :attendee, :attendee, :attendees
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :freebusy, :freebusy, :freebusys
+    ical_multi_property :rstatus, :request_status, :request_statuses
+   
+      def initialize()
+        super("VFREEBUSY")
+      end
+    end
+  end

data/lib/icalendar/component/journal.rb

@@ -0,0 +1,61 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Journal calendar component is a grouping of
+  # component properties that represent one or more descriptive text
+  # notes associated with a particular calendar date. The "DTSTART"
+  # property is used to specify the calendar date that the journal entry
+  # is associated with. Generally, it will have a DATE value data type,
+  # but it can also be used to specify a DATE-TIME value data type.
+  # Examples of a journal entry include a daily record of a legislative
+  # body or a journal entry of individual telephone contacts for the day
+  # or an ordered list of accomplishments for the day. The Journal
+  # calendar component can also be used to associate a document with a
+  # calendar date.
+  class Journal < Component
+
+    # Single properties
+    ical_property :klass, nil, :class
+    ical_property :created
+    ical_property :description
+    ical_property :dtstart, :start
+    ical_property :last_mod, :last_modification
+    ical_property :organizer
+    ical_property :dtstamp, :timestamp
+    ical_property :seq, :sequence
+    ical_property :status
+    ical_property :summary
+    ical_property :uid, :user_id
+    ical_property :url
+    ical_property :recurid, :recurrence_id
+
+    # Multi-properties
+    ical_multi_property :attach, :attachment, :attachments
+    ical_multi_property :attendee, :attendee, :attendees
+    ical_multi_property :categories, :category, :categories
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :contact, :contact, :contacts
+    ical_multi_property :exdate, :exception_date, :exception_dates
+    ical_multi_property :exrule, :exception_rule, :exception_rules
+    ical_multi_property :rstatus, :request_status, :request_statuses
+    ical_multi_property :related_to, :related_to, :related_tos
+    ical_multi_property :resources, :resource, :resources
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+
+    def initialize()
+      super("VJOURNAL")
+    end
+
+    def to_ical
+      print_string { }
+    end
+
+  end
+end
+

data/lib/icalendar/component/timezone.rb

@@ -0,0 +1,43 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Timezone is unambiguously defined by the set of time
+  # measurement rules determined by the governing body for a given
+  # geographic area. These rules describe at a minimum the base offset
+  # from UTC for the time zone, often referred to as the Standard Time
+  # offset. Many locations adjust their Standard Time forward or backward
+  # by one hour, in order to accommodate seasonal changes in number of
+  # daylight hours, often referred to as Daylight  Saving Time. Some
+  # locations adjust their time by a fraction of an hour. Standard Time
+  # is also known as Winter Time. Daylight Saving Time is also known as
+  # Advanced Time, Summer Time, or Legal Time in certain countries. The
+  # following table shows the changes in time zone rules in effect for
+  # New York City starting from 1967. Each line represents a description
+  # or rule for a particular observance.
+  class Timezone < Component
+    
+    # Single properties
+    ical_property :dtstart, :start
+    ical_property :tzoffsetto, :timezone_offset_to
+    ical_property :tzoffsetfrom, :timezone_offset_from
+    
+    # Multi-properties
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+    
+    def initialize()
+      super("VTIMEZONE")
+      @components = components
+    end
+
+    def to_ical
+      super.to_s { |s| s << @components.each { |component| component.to_s } }
+    end
+  end
+end

data/lib/icalendar/component/todo.rb

@@ -0,0 +1,65 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+module Icalendar
+  # A Todo calendar component is a grouping of component
+  # properties and possibly Alarm calendar components that represent
+  # an action-item or assignment. For example, it can be used to
+  # represent an item of work assigned to an individual; such as "turn in
+  # travel expense today".
+  class Todo < Component
+    attr_reader :alarms
+
+    # Single properties
+    ical_property :klass, nil, :class
+    ical_property :completed
+    ical_property :created
+    ical_property :description
+    ical_property :dtstamp, :timestamp
+    ical_property :dtstart, :start
+    ical_property :geo
+    ical_property :last_mod, :last_modification
+    ical_property :location
+    ical_property :organizer
+    ical_property :percent
+    ical_property :priority
+    ical_property :recurid, :recurrence_id
+    ical_property :seq, :sequence
+    ical_property :status
+    ical_property :summary
+    ical_property :uid, :user_id
+    ical_property :url
+    
+    # Single but mutually exclusive TODO: not testing anything yet
+    ical_property :due
+    ical_property :duration
+
+    # Multi-properties
+    ical_multi_property :attach, :attachment, :attachments
+    ical_multi_property :attendee, :attendee, :attendees
+    ical_multi_property :categories, :category, :categories
+    ical_multi_property :comment, :comment, :comments
+    ical_multi_property :contact, :contact, :contacts
+    ical_multi_property :exdate, :exception_date, :exception_dates
+    ical_multi_property :exrule, :exception_rule, :exception_rules
+    ical_multi_property :rstatus, :request_status, :request_statuses
+    ical_multi_property :related_to, :related_to, :related_tos
+    ical_multi_property :resources, :resource, :resources
+    ical_multi_property :rdate, :recurrence_date, :recurrence_dates
+    ical_multi_property :rrule, :recurrence_rule, :recurrence_rules
+    
+    def initialize()
+      super("VTODO")
+      
+      @alarms = alarms
+    end
+
+    def to_ical
+      print_string { |s| @alarms.each { |alarm| alarm.to_s } }
+    end      
+  end
+end

data/lib/icalendar/conversions.rb

@@ -0,0 +1,115 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+require 'date'
+
+### Add some to_ical methods to classes
+
+# class Object
+#   def to_ical
+#     raise(NotImplementedError, "This object does not implement the to_ical method!")
+#   end
+# end
+
+class String
+  def to_ical
+    "#{self}"
+  end
+end
+
+class Fixnum
+  def to_ical
+    "#{self}"
+  end
+end
+
+class Float
+  def to_ical
+    "#{self}"
+  end
+end
+
+class Array
+  def to_ical
+    map{|elem| elem.to_ical}.join ','
+  end
+end
+
+class DateTime < Date
+  def to_ical(utc = false)
+    s = ""
+    
+    # 4 digit year
+    s << self.year.to_s
+    
+    # Double digit month
+    s << "0" unless self.month > 9 
+    s << self.month.to_s
+    
+    # Double digit day
+    s << "0" unless self.day > 9 
+    s << self.day.to_s
+
+    s << "T"
+        
+    # Double digit hour
+    s << "0" unless self.hour > 9 
+    s << self.hour.to_s
+    
+    # Double digit minute
+    s << "0" unless self.min > 9 
+    s << self.min.to_s
+    
+    # Double digit second
+    s << "0" unless self.sec > 9 
+    s << self.sec.to_s
+
+    # UTC time gets a Z suffix
+    if utc
+      s << "Z"
+    end
+  end
+end
+
+class Date
+  def to_ical(utc = false)
+    s = ""
+        
+    # 4 digit year
+    s << self.year.to_s
+    
+    # Double digit month
+    s << "0" unless self.month > 9 
+    s << self.month.to_s
+    
+    # Double digit day
+    s << "0" unless self.day > 9 
+    s << self.day.to_s
+  end
+end
+
+class Time
+  def to_ical(utc = false)
+    # Double digit hour
+    s << "0" unless self.hour > 9 
+    s << self.hour.to_s
+    
+    # Double digit minute
+    s << "0" unless self.min > 9 
+    s << self.min.to_s
+    
+    # Double digit second
+    s << "0" unless self.sec > 9 
+    s << self.sec.to_s
+
+    # UTC time gets a Z suffix
+    if utc
+      s << "Z"
+    end
+  end
+end

data/lib/icalendar/helpers.rb

@@ -0,0 +1,109 @@
+=begin
+  Copyright (C) 2005 Jeff Rose
+  Copyright (C) 2005 Sam Roberts
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+module Icalendar
+  module DateProp
+    # date = date-fullyear date-month date-mday
+    # date-fullyear = 4 DIGIT
+    # date-month = 2 DIGIT
+    # date-mday = 2 DIGIT
+    DATE = '(\d\d\d\d)(\d\d)(\d\d)'
+
+    # time = time-hour [":"] time-minute [":"] time-second [time-secfrac] [time-zone]
+    # time-hour = 2 DIGIT
+    # time-minute = 2 DIGIT
+    # time-second = 2 DIGIT
+    # time-secfrac = "," 1*DIGIT
+    # time-zone = "Z" / time-numzone
+    # time-numzome = sign time-hour [":"] time-minute
+    #  TIME = '(\d\d)(\d\d)(\d\d)(Z)?'
+    TIME = '(\d\d)(\d\d)(\d\d)'
+
+    # This method is called automatically when the module is mixed in.
+    # I guess you have to do this to mixin class methods rather than instance methods.
+    def self.append_features(base)
+      super
+      klass.extend(ClassMethods)
+    end
+
+    # This is made a sub-module just so it can be added as class 
+    # methods rather than instance methods.
+    module ClassMethods
+      def date_property(dp, alias_name = nil)
+        dp = "#{dp}".strip.downcase
+        getter = dp
+        setter = "#{dp}="
+        query = "#{dp}?"
+
+        unless instance_methods.include? getter
+          code = <<-code
+            def #{getter}(*a)
+              if a.empty?
+                @properties[#{dp.upcase}]
+              else
+                self.#{dp} = a.first
+              end 
+            end
+          code
+
+          module_eval code
+        end
+           
+        unless instance_methods.include? setter
+          code = <<-code
+            def #{setter} a
+              @properties[#{dp.upcase}] = a
+            end
+          code
+
+          module_eval code
+        end
+
+        unless instance_methods.include? query
+          code = <<-code
+            def #{query}
+              @properties.has_key?(#{dp.upcase})
+            end
+          code
+
+          module_eval code
+        end
+
+        # Define the getter
+        getter = "get#{property.to_s.capitalize}"
+        define_method(getter.to_sym) do
+          puts "inside getting..."
+          getDateProperty(property.to_s.upcase)  
+        end
+        
+        # Define the setter
+        setter = "set#{property.to_s.capitalize}"        
+        define_method(setter.to_sym) do |*params|
+          date = params[0]
+          utc = params[1]
+          puts "inside setting..."
+          setDateProperty(property.to_s.upcase, date, utc)
+        end
+
+        # Create aliases if a name was specified
+#         if not aliasName.nil?
+#           gasym = "get#{aliasName.to_s.capitalize}".to_sym 
+#           gsym = getter.to_sym
+#           alias gasym gsym 
+          
+#           sasym = "set#{aliasName.to_s.capitalize}".to_sym 
+#           ssym = setter.to_sym
+#           alias sasym ssym 
+#        end
+      end
+
+    end
+    
+  end
+end