icalendar 0.95 → 0.96

data/README

@@ -56,8 +56,8 @@ Now for some examples:
    # Create a calendar with a single event (Method 3)
    cal3 = Icalendar::Calendar.new
    cal3.event do
-   user_id "joe-bob@somewhere.net"
-   event.timestamp DateTime.now 
+     user_id "joe-bob@somewhere.net"
+     timestamp DateTime.now 
    end
   
    # We can output the calendars as strings to write to a file, 
@@ -88,17 +88,22 @@ Now for some examples:
 
   begin
     require 'rubygems'
-    require_gem 'icalendar', ">= 0.95"
+    require_gem 'icalendar', ">= 0.96"
   rescue LoadError
     require 'icalendar'
   end
 
 == Download
 
-The latest version of this library can be found at
+The latest release version of this library can be found at
 
 * http://rubyforge.org/projects/icalendar/
 
+If you would like to help with development or use the most current version
+you can check out the tree from the subversion repository:
+
+* svn co https://rosejn.net/svn/icalendar icalendar
+
 Documentation can be found at
 
 * http://icalendar.rubyforge.org/

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-PKG_VERSION = "0.95"
+PKG_VERSION = "0.96"
 
 $VERBOSE = nil
 TEST_CHANGES_SINCE = Time.now - 600 # Recent tests = changed in last 10 minutes
@@ -47,8 +47,9 @@ Rake::RDocTask.new(:doc) { |rdoc|
   rdoc.rdoc_files.include('GPL', 'COPYING')
   rdoc.rdoc_dir = 'docs/api'
   rdoc.title    = "iCalendar -- Internet Calendaring for Ruby"
-  rdoc.options << "--include examples/ --line-numbers --inline-source "
-  rdoc.options << ""
+  rdoc.options << "--include examples/ --line-numbers --inline-source --diagram "
+  #rdoc.options << "--accessor=ical_property=iCalendar property,ical_multi_property=iCalendar property where multiple instances can occur"
+  rdoc.options << "--accessor=ical_property,ical_multi_property"
 }
 
 Gem::manage_gems 

data/docs/examples/parse_cal.rb

@@ -5,7 +5,7 @@ require 'icalendar'
 require 'date'
   
 # Open a file or string to parse
-cal_file = File.open("single_event.ics")
+cal_file = File.open("../../test/life.ics")
 
 # Parser returns an array of calendars because a single file
 # can have multiple calendar objects.

data/lib/icalendar/calendar.rb

@@ -8,37 +8,29 @@
 
 module Icalendar
 
-  
   class Calendar < Component
-    attr_accessor :events, :todos, :journals, :freebusys, :timezones
+    ical_component :events, :todos, :journals, :freebusys, :timezones
 
     ical_property :calscale, :calendar_scale
     ical_property :prodid, :product_id
     ical_property :version
     ical_property :method
-    
+
     def initialize()
       super("VCALENDAR")
       @properties = {}
       @property_params = {}
-      
-      @events = []
-      @todos = []
-      @journals = []
-      @freebusys = []
-      @timezones = []
-      
+
       # Set some defaults
       self.calscale = "GREGORIAN"    # Who knows, but this is the only one in the spec.
       self.prodid = "iCalendar-Ruby" # Current product... Should be overwritten
       self.version = "2.0" # Version of the specification
-
     end
 
     def event(&block)
       e = Event.new
-      self.add e
-      
+      self.add_component e
+
       e.instance_eval &block if block
 
       e
@@ -46,8 +38,8 @@ module Icalendar
 
     def todo(&block)
       e = Todo.new
-      self.add e
-      
+      self.add_component e
+
       e.instance_eval &block if block
 
       e
@@ -55,8 +47,8 @@ module Icalendar
 
     def journal(&block)
       e = Journal.new
-      self.add e
-      
+      self.add_component e
+
       e.instance_eval &block if block
 
       e
@@ -64,8 +56,8 @@ module Icalendar
 
     def freebusy(&block)
       e = Freebusy.new
-      self.add e
-      
+      self.add_component e
+
       e.instance_eval &block if block
 
       e
@@ -73,40 +65,12 @@ module Icalendar
 
     def timezone(&block)
       e = Timezone.new
-      self.add e
-      
+      self.add_component e
+
       e.instance_eval &block if block
 
       e
     end
+  end # class Calendar
 
-
-    #TODO: Implement the rest of these ^ methods for todo etc...
-
-    def add(component)
-      if component.is_a? Event
-          @events << component
-        elsif component.is_a? Todo
-          @todos << component
-        elsif component.is_a? Journal
-          @journals << component
-        elsif component.is_a? Freebusy
-          @freebusys << component
-        elsif component.is_a? Timezone
-          @timezones << component
-        else
-          raise InvalidComponentClass
-      end
-    end
-    
-    def to_ical
-      print_string do |s|
-        @events.each { |event| s << event.to_ical }
-        @todos.each { |todo| s << todo.to_ical }
-        @journals.each { |journal| s << journal.to_ical }
-        @freebusys.each { |freebusy| s << freebusy.to_ical }
-        @timezones.each { |timezone| s << timezone.to_ical }
-      end
-    end
-  end
-end
+end # module Icalendar

data/lib/icalendar/component.rb

@@ -6,6 +6,8 @@
   details.
 =end
 
+require 'breakpoint'
+
 module Icalendar
   # The body of the iCalendar object consists of a sequence of calendar
   # properties and one or more calendar components. The calendar
@@ -22,15 +24,35 @@ module Icalendar
 
     def initialize(name)
       @name = name
+      @components = Hash.new([])
       @properties = {}
       @property_params = {}
 
       @@logger.info("New #{@name[1,@name.size].capitalize}...")
     end
-    
+
+    # Add a sub-component to the current component object.
+    def add_component(component)
+      key = (component.class.to_s.downcase + 's').gsub('icalendar::', '').to_sym
+
+      unless @components.has_key? key
+        @components[key] = []
+      end
+
+      @components[key] << component
+    end
+
+    def to_ical
+      print_string do |s|
+        @components.each_value do |comps|
+          comps.each { |component| s << component.to_ical }
+        end
+      end
+    end
+
     def print_string
       s = ""
-      
+
       # Begin a new component
       s << "BEGIN:#{@name.upcase}\r\n"
 
@@ -39,14 +61,14 @@ module Icalendar
       @properties.each do |key,value| 
         # Property name
         s << "#{key.upcase}"
-        
+
         # Possible parameters
         if @property_params.has_key?(key) 
           params = @property_params[key]
           params.each do |key,val|
             s << ";#{key}"
             val = [ val ] unless val.respond_to?(:to_ary)
-            
+
             # Possible parameter values
             unless val.empty?
               s << "="
@@ -67,7 +89,7 @@ module Icalendar
 
       # Any custom body of the derived component
       yield(s)
-      
+
       # End of this component
       s << "END:#{@name.upcase}\r\n"
     end
@@ -81,9 +103,41 @@ module Icalendar
       @@multi_properties.has_key?(name)
     end
 
+    private
+
+    def Component.hash_reader(hash, syms)
+      syms.each do |id|
+        class_eval <<-"stop"
+    def #{id.to_s.downcase}
+      return @#{hash.to_s}[:#{id.to_s.downcase}]
+    end
+        stop
+        puts "Creating method: #{id.to_s.downcase}"
+      end
+    end
+
+    def Component.hash_writer(hash, syms)
+      syms.each do |id|
+        class_eval <<-"stop"
+    def #{id.to_s.downcase}=(val)
+      return @#{hash.to_s}[:#{id.to_s.downcase}] = val
+    end
+        stop
+      end
+    end
+
+    def Component.hash_attr(hash, syms)
+      hash_reader(hash, syms)
+      hash_writer(hash, syms)
+    end
+
     # Make it protected so we can monitor usage...
     protected
 
+    def Component.ical_component(*syms)
+      hash_attr :components, syms
+    end
+    
     # Define a set of methods supporting a new property
     def Component.ical_property(property, alias_name = nil, prop_name = nil)
       property = "#{property}".strip.downcase
@@ -94,7 +148,7 @@ module Icalendar
 
       # If a prop_name was given then we use that for the actual storage
       property = "#{prop_name}".strip.upcase unless prop_name.nil?
-      
+
       # Change underscores in property name to a dash
       property[/_/] = '-' if property =~ /_/
 
@@ -112,35 +166,35 @@ module Icalendar
             end
         code
 
-        class_eval code, "component.rb", 124
+        class_eval code, "component.rb", 155
 
         alias_method("#{alias_name}", "#{getter}") unless alias_name.nil?
       end
 
       unless instance_methods.include? setter
         code = <<-code
-            def #{setter} a
-              unless a.respond_to?(:to_ical)
+            def #{setter}(val)
+              unless val.respond_to?(:to_ical)
                 raise(NotImplementedError, "Property value does not support to_ical method!")
               end
-              
-              @properties["#{property}"] = a
+
+              @properties["#{property}"] = val
             end
         code
-            
-        class_eval code, "component.rb", 134
+
+        class_eval code, "component.rb", 171
 
         alias_method("#{alias_name}=", "#{setter}") unless alias_name.nil?
       end
-          
+
       unless instance_methods.include? query
         code = <<-code
             def #{query}
               @properties.has_key?("#{property}")
             end
         code
-            
-        class_eval code, "component.rb", 144
+
+        class_eval code, "component.rb", 183
 
         alias_method("#{alias_name}\?", "#{query}") unless alias_name.nil?
       end    
@@ -195,16 +249,16 @@ module Icalendar
 
                 @properties["#{property}"] = a.to_ary
 
-                
+
               else
                 raise ArgumentError, "#{getter} is a multi-property that must be an array! Use the #{adder} method to add single entries."
               end
             end
         code
-            
+
         class_eval code, "component.rb", 198
       end
-          
+
       # Query for any of these properties
       unless instance_methods.include? query
         code = <<-code
@@ -212,7 +266,7 @@ module Icalendar
               @properties.has_key?("#{property}")
             end
         code
-            
+
         class_eval code, "component.rb", 210
       end
 
@@ -223,7 +277,7 @@ module Icalendar
               unless a.respond_to?(:to_ical)
                 raise(NotImplementedError, "Property value object does not support to_ical method!")
               end
-              
+
               if @properties.has_key?("#{property}")
                 @properties["#{property}"] << a
               else

data/lib/icalendar/component/event.rb

@@ -14,55 +14,104 @@ module Icalendar
   # 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
+    ical_component :alarms
 
-    # Single properties
-    ical_property :klass, nil, :class
+    ## Single instance properties
+
+    # Access classification (PUBLIC, PRIVATE, CONFIDENTIAL...)
+    ical_property :klass, nil, :class 
+
+    # Date & time of creation
     ical_property :created
+
+    # Complete description of the calendar component
     ical_property :description
+
+    # Specifies date-time when calendar component begins
     ical_property :dtstart, :start
+
+    # Latitude & longitude for specified activity
     ical_property :geo
+ 
+    # Date & time this item was last modified
     ical_property :last_mod, :last_modification
+
+    # Specifies the intended venue for this activity
     ical_property :location
+
+    # Defines organizer of this item
     ical_property :organizer
+
+    # Defines relative priority for this item (1-9... 1 = best)
     ical_property :priority
+
+    # Indicate date & time when this item was created
     ical_property :dtstamp, :timestamp
+
+    # Revision sequence number for this item
     ical_property :seq, :sequence
+
+    # Defines overall status or confirmation of this item
     ical_property :status
     ical_property :summary
     ical_property :transp, :transparency
+
+    # Defines a persistent, globally unique id for this item
     ical_property :uid, :user_id
+
+    # Defines a URL associated with this item
     ical_property :url
     ical_property :recurid, :recurrence_id
 
-    # Single but mutually exclusive TODO: not testing anything yet
+    ## Single but mutually exclusive properties (Not testing though)
+    
+    # Specifies a date and time that this item ends
     ical_property :dtend, :end
+
+    # Specifies a positive duration time
     ical_property :duration
 
-    # Multi-properties
+    ## Multi-instance properties
+
+    # Associates a URI or binary blob with this item
     ical_multi_property :attach, :attachment, :attachments
+
+    # Defines an attendee for this calendar item
     ical_multi_property :attendee, :attendee, :attendees
+    
+    # Defines the categories for a calendar component (school, work...)
     ical_multi_property :categories, :category, :categories
+
+    # Simple comment for the calendar user.
     ical_multi_property :comment, :comment, :comments
+
+    # Contact information associated with this item.
     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
+
+    # Used to represent a relationship between two calendar items
     ical_multi_property :related_to, :related_to, :related_tos
     ical_multi_property :resources, :resource, :resources
+
+    # Used with the UID & SEQUENCE to identify a specific instance of a
+    # recurring calendar item.
     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
+    def alarm(&block)
+      a = Alarm.new
+      self.add a
+
+      a.instance_eval &block if block
+
+      a
     end
+
   end
 end