paulsm-icalendar 1.1.0.4

data/lib/icalendar/rrule.rb

@@ -0,0 +1,126 @@
+=begin
+  Copyright (C) 2008 Rick (http://github.com/rubyredrick)
+
+  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'
+require 'uri'
+require 'stringio'
+
+module Icalendar
+
+  # This class is not yet fully functional..
+  #
+  # Gem versions < 1.1.0.0 used to return a string for the recurrence_rule component,
+  # but now it returns this Icalendar::RRule class. ie It's not backwards compatible!
+  #
+  # To get the original RRULE value from a parsed feed, use the 'orig_value' property.
+  #
+  # Example:
+  #   rules = event.recurrence_rules.map{ |rule| rule.orig_value }
+  
+  class RRule < Icalendar::Base
+    
+    class Weekday
+      def initialize(day, position)
+        @day, @position = day, position
+      end
+      
+      def to_s
+        "#{@position}#{@day}"
+      end
+    end
+    
+    def initialize(name, params, value, parser)
+      @value = value
+      frequency_match = value.match(/FREQ=(SECONDLY|MINUTELY|HOURLY|DAILY|WEEKLY|MONTHLY|YEARLY)/)
+      raise Icalendar::InvalidPropertyValue.new("FREQ must be specified for RRULE values") unless frequency_match
+      @frequency = frequency_match[1]
+      @until = parse_date_val("UNTIL", value)
+      @count = parse_int_val("COUNT", value)
+      raise Icalendar::InvalidPropertyValue.new("UNTIL and COUNT must not both be specified for RRULE values") if [@until, @count].compact.length > 1
+      @interval = parse_int_val("INTERVAL", value)
+      @by_list = {:bysecond => parse_int_list("BYSECOND", value)}
+      @by_list[:byminute] = parse_int_list("BYMINUTE",value)
+      @by_list[:byhour] = parse_int_list("BYHOUR", value)
+      @by_list[:byday] = parse_weekday_list("BYDAY", value)
+      @by_list[:bymonthday] = parse_int_list("BYMONTHDAY", value)
+      @by_list[:byyearday] = parse_int_list("BYYEARDAY", value)
+      @by_list[:byweekno] = parse_int_list("BYWEEKNO", value)
+      @by_list[:bymonth] = parse_int_list("BYMONTH", value)
+      @by_list[:bysetpos] = parse_int_list("BYSETPOS", value)
+      @wkst = parse_wkstart(value)
+    end
+    
+    # Returns the original pre-parsed RRULE value.
+    def orig_value
+      @value
+    end
+    
+    def to_ical
+      result = ["FREQ=#{@frequency}"]
+      result << ";UNTIL=#{@until.to_ical}" if @until
+      result << ";COUNT=#{@count}" if @count
+      result << ";INTERVAL=#{@interval}" if @interval
+      @by_list.each do |key, value|
+        result << ";#{key.to_s.upcase}=#{value}" if value
+      end
+      result << ";WKST=#{@wkst}" if @wkst
+      result.join
+    end
+    
+    def parse_date_val(name, string)
+      match = string.match(/;#{name}=(.*?)(;|$)/)
+      match ? DateTime.parse(match[1]) : nil
+    end
+    
+    def parse_int_val(name, string)
+      match = string.match(/;#{name}=(\d+)(;|$)/)
+      match ? match[1].to_i : nil
+    end
+    
+    def parse_int_list(name, string)
+      match = string.match(/;#{name}=([+-]?.*?)(;|$)/)
+      if match
+        match[1].split(",").map {|int| int.to_i}
+      else
+        nil
+      end
+    end
+    
+    def parse_weekday_list(name, string)
+      match = string.match(/;#{name}=(.*?)(;|$)/)
+      if match
+        match[1].split(",").map {|weekday| 
+          wd_match = weekday.match(/([+-]?\d*)(SU|MO|TU|WE|TH|FR|SA)/)
+          Weekday.new(wd_match[2], wd_match[1])
+          }
+      else
+        nil
+      end
+    end
+    
+    def parse_wkstart(string)
+      match = string.match(/;WKSTART=(SU|MO|TU|WE|TH|FR|SA)(;|$)/)
+      if match
+        %w{SU MO TU WE TH FR SA}.index(match[1])
+      else
+        nil
+      end
+    end
+    
+    # TODO: Incomplete
+    def occurrences_of_event_starting(event, datetime)
+      initial_start = event.dtstart
+      (0...@count).map {|day_offset| 
+              occurrence = event.clone
+              occurrence.dtstart = initial_start + day_offset
+              occurrence.clone
+              }
+    end
+  end
+
+end

data/lib/icalendar/tzinfo.rb

@@ -0,0 +1,121 @@
+=begin
+  Copyright (C) 2008 Sean Dague
+
+  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
+
+# The following adds a bunch of mixins to the tzinfo class, with the
+# intent on making it very easy to load in tzinfo data for generating
+# ical events.  With this you can do the following:
+#
+#   require "icalendar/tzinfo"
+#
+#   estart = DateTime.new(2008, 12, 29, 8, 0, 0)
+#   eend = DateTime.new(2008, 12, 29, 11, 0, 0)
+#   tstring = "America/Chicago"
+#
+#   tz = TZInfo::Timezone.get(tstring)
+#   cal = Calendar.new
+#   # the mixins now generate all the timezone info for the date in question
+#   timezone = tz.ical_timezone(estart)
+#   cal.add(timezone)
+#  
+#   cal.event do
+#       dtstart       estart
+#       dtend        eend
+#       summary     "Meeting with the man."
+#       description "Have a long lunch meeting and decide nothing..."
+#       klass       "PRIVATE"
+#   end
+#
+#   puts cal.to_ical
+#
+# The recurance rule calculations are hacky, and only start at the
+# beginning of the current dst transition.  I doubt this works for non
+# dst areas yet.  However, for a standard dst flipping zone, this
+# seems to work fine (tested in Mozilla Thunderbird + Lightning).
+# Future goal would be making this better.
+
+# require "rubygems"
+# require "tzinfo"
+
+module TZInfo
+    class Timezone
+        def ical_timezone(date)
+            period = period_for_local(date)
+            timezone = Icalendar::Timezone.new
+            timezone.timezone_id = identifier
+            timezone.add(period.daylight)
+            timezone.add(period.standard)
+            return timezone
+        end
+    end
+    
+    class TimezoneTransitionInfo
+        def offset_from
+            a = previous_offset.utc_total_offset
+            sprintf("%2.2d%2.2d", (a / 3600).to_i, ((a / 60) % 60).to_i)
+        end
+        
+        def offset_to
+            a = offset.utc_total_offset
+            sprintf("%2.2d%2.2d", (a / 3600).to_i, ((a / 60) % 60).to_i)
+        end
+        
+        def rrule 
+            start = local_start.to_datetime
+            # this is somewhat of a hack, but seems to work ok
+            [sprintf(
+                    "FREQ=YEARLY;BYMONTH=%d;BYDAY=%d%s",
+                    start.month, 
+                    ((start.day - 1)/ 7).to_i + 1,
+                    start.strftime("%a").upcase[0,2]
+                    )]
+        end
+        
+        def dtstart
+            local_start.to_datetime.strftime("%Y%m%dT%H%M%S")
+        end
+
+    end
+    
+    class TimezonePeriod
+        def daylight
+            day = Icalendar::Daylight.new
+            if dst?
+                day.timezone_name = abbreviation.to_s
+                day.timezone_offset_from = start_transition.offset_from
+                day.timezone_offset_to = start_transition.offset_to
+                day.dtstart = start_transition.dtstart
+                day.recurrence_rules = start_transition.rrule
+            else
+                day.timezone_name = abbreviation.to_s.sub("ST","DT")
+                day.timezone_offset_from = end_transition.offset_from
+                day.timezone_offset_to = end_transition.offset_to
+                day.dtstart = end_transition.dtstart
+                day.recurrence_rules = end_transition.rrule
+            end
+            return day
+        end
+        
+        def standard
+            std = Icalendar::Standard.new
+            if dst?
+                std.timezone_name = abbreviation.to_s.sub("DT","ST")
+                std.timezone_offset_from = end_transition.offset_from
+                std.timezone_offset_to = end_transition.offset_to
+                std.dtstart = end_transition.dtstart
+                std.recurrence_rules = end_transition.rrule
+            else
+                std.timezone_name = abbreviation.to_s
+                std.timezone_offset_from = start_transition.offset_from
+                std.timezone_offset_to = start_transition.offset_to
+                std.dtstart = start_transition.dtstart
+                std.recurrence_rules = start_transition.rrule
+            end
+            return std
+        end
+    end
+end

data/lib/meta.rb

@@ -0,0 +1,32 @@
+# A set of methods to help create meta-programming gizmos.
+class Object
+  # The metaclass is the singleton behind every object.  
+  def metaclass
+    class << self
+      self
+    end
+  end
+
+  # Evaluates the block in the context of the metaclass
+  def meta_eval &blk
+    metaclass.instance_eval &blk
+  end
+
+  # Acts like an include except it adds the module's methods
+  # to the metaclass so they act like class methods.
+  def meta_include mod
+    meta_eval do
+      include mod
+    end
+  end
+
+  # Adds methods to a metaclass
+  def meta_def name, &blk
+    meta_eval { define_method name, &blk }
+  end
+
+  # Defines an instance method within a class
+  def class_def name, &blk
+    class_eval { define_method name, &blk }
+  end
+end

data/test/calendar_test.rb

@@ -0,0 +1,71 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require 'icalendar'
+
+require 'date'
+
+class TestCalendar < Test::Unit::TestCase
+  include Icalendar
+   # Generate a calendar using the raw api, and then spit it out
+   # as a string.  Parse the string and make sure everything matches up.
+   def test_raw_generation    
+      # Create a fresh calendar
+      cal = Calendar.new
+
+      cal.calscale = "GREGORIAN"
+      cal.version = "3.2"
+      cal.prodid = "test-prodid"
+
+      # Now generate the string and then parse it so we can verify 
+      # that everything was set, generated and parsed correctly.
+      calString = cal.to_ical
+
+      cals = Parser.new(calString).parse
+
+      cal2 = cals.first
+      assert_equal("GREGORIAN", cal2.calscale)
+      assert_equal("3.2", cal2.version)
+      assert_equal("test-prodid", cal2.prodid)
+   end
+
+   def test_block_creation
+      cal = Calendar.new
+      cal.event do
+         self.dtend = "19970903T190000Z"
+         self.summary = "This is my summary"
+      end
+
+      event = cal.event
+      event.dtend "19970903T190000Z", {:TZID => "Europe/Copenhagen"}
+      event.summary "This is my summary"
+
+      ev = cal.events.each do |ev|
+         assert_equal("19970903T190000Z", ev.dtend)
+         assert_equal("This is my summary", ev.summary)
+      end
+   end
+
+   def test_find
+     cal = Calendar.new
+
+     # add some events so we actually have to search
+     10.times do 
+       cal.event
+       cal.todo 
+       cal.journal
+       cal.freebusy 
+     end
+     event = cal.events[5]
+     assert_equal(event, cal.find_event(event.uid))
+
+     todo = cal.todos[5]
+     assert_equal(todo, cal.find_todo(todo.uid))
+
+     journal = cal.journals[5]
+     assert_equal(journal, cal.find_journal(journal.uid))
+     
+     freebusy = cal.freebusys[5]
+     assert_equal(freebusy, cal.find_freebusy(freebusy.uid))
+   end
+end

data/test/component/event_test.rb

@@ -0,0 +1,256 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'test/unit'
+require 'icalendar'
+
+unless defined? 1.days
+  class Integer
+    def days
+      self * 60 * 60 * 24
+    end
+  end
+end
+
+# Define a test event
+testEvent = <<EOS
+BEGIN:VEVENT
+UID:19970901T130000Z-123401@host.com
+DTSTAMP:19970901T1300Z
+DTSTART:19970903T163000Z
+DTEND:19970903T190000Z
+SUMMARY:Annual Employee Review
+CLASS:PRIVATE
+CATEGORIES:BUSINESS,HUMAN RESOURCES
+END:VEVENT
+EOS
+
+class TestEvent < Test::Unit::TestCase
+
+  # Create a calendar with an event for each test.
+  def setup
+    @cal = Icalendar::Calendar.new
+    @event = Icalendar::Event.new
+  end
+
+  def test_new
+    assert(@event)
+  end
+  
+  # Properties that can only occur once per event
+  def test_single_properties
+    @event.ip_class = "PRIVATE"
+    
+    @cal.add_event(@event)
+    
+    cals = Icalendar::Parser.new(@cal.to_ical).parse
+    cal2 = cals.first
+    event2 = cal2.events.first
+    
+    assert_equal("PRIVATE", event2.ip_class)
+  end
+end
+
+class TestEventWithSpecifiedTimezone < Test::Unit::TestCase
+  
+  def setup
+    src = <<EOS
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+CALSCALE:GREGORIAN
+VERSION:2.0
+BEGIN:VEVENT
+UID:19970901T130000Z-123401@host.com
+DTSTAMP:19970901T1300Z
+DTSTART;TZID=America/Chicago:19970903T163000
+DTEND;TZID=America/Chicago:19970903T190000
+SUMMARY:Annual Employee Review
+CLASS:PRIVATE
+CATEGORIES:BUSINESS,HUMAN RESOURCES
+END:VEVENT
+END:VCALENDAR
+EOS
+    @calendar = Icalendar.parse(src).first
+    @event = @calendar.events.first
+  end
+  
+  def test_event_is_parsed
+    assert_not_nil(@event)
+  end
+  
+  def test_dtstart_should_understand_icalendar_tzid
+    assert_respond_to(@event.dtstart, :icalendar_tzid)
+  end
+  
+  def test_dtstart_tzid_should_be_correct
+    puts "#{@event.dtstart.icalendar_tzid} #{@event.dtstart}"
+    assert_equal("America/Chicago",@event.dtstart.icalendar_tzid)
+  end
+  
+  def test_dtend_tzid_should_be_correct
+    assert_equal("America/Chicago",@event.dtend.icalendar_tzid)
+  end
+  
+end
+
+class TestEventWithZuluTimezone < Test::Unit::TestCase
+  
+  def setup
+    src = <<EOS
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+CALSCALE:GREGORIAN
+VERSION:2.0
+BEGIN:VEVENT
+UID:19970901T130000Z-123401@host.com
+DTSTAMP:19970901T1300Z
+DTSTART:19970903T163000Z
+DTEND:19970903T190000Z
+SUMMARY:Annual Employee Review
+CLASS:PRIVATE
+CATEGORIES:BUSINESS,HUMAN RESOURCES
+END:VEVENT
+END:VCALENDAR
+EOS
+    @calendar = Icalendar.parse(src).first
+    @event = @calendar.events.first
+  end
+  
+  def test_event_is_parsed
+    assert_not_nil(@event)
+  end
+  
+  def test_dtstart_tzid_should_be_correct
+    puts "#{@event.dtstart.icalendar_tzid} #{@event.dtstart}"
+    assert_equal("UTC",@event.dtstart.icalendar_tzid)
+  end
+  
+  def test_dtend_tzid_should_be_correct
+    assert_equal("UTC",@event.dtend.icalendar_tzid)
+  end
+  
+end
+
+class TestEventWithFloatingTimezone < Test::Unit::TestCase
+  
+  def setup
+    src = <<EOS
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+CALSCALE:GREGORIAN
+VERSION:2.0
+BEGIN:VEVENT
+UID:19970901T130000Z-123401@host.com
+DTSTAMP:19970901T1300Z
+DTSTART:19970903T163000
+DTEND:19970903T190000
+SUMMARY:Annual Employee Review
+CLASS:PRIVATE
+CATEGORIES:BUSINESS,HUMAN RESOURCES
+END:VEVENT
+END:VCALENDAR
+EOS
+    @calendar = Icalendar.parse(src).first
+    @event = @calendar.events.first
+  end
+  
+  def test_event_is_parsed
+    assert_not_nil(@event)
+  end
+  
+  def test_dtstart_tzid_should_be_nil
+    puts "#{@event.dtstart.icalendar_tzid.inspect} #{@event.dtstart}"
+    assert_nil(@event.dtstart.icalendar_tzid)
+  end
+  
+  def test_dtend_tzid_should_be_nil
+    assert_nil(@event.dtend.icalendar_tzid)
+  end
+  
+end
+
+class TestAllDayEventWithoutTime < Test::Unit::TestCase
+  
+  def setup
+    src = <<EOS
+BEGIN:VCALENDAR
+VERSION:2.0
+X-WR-CALNAME:New Event
+PRODID:-//Apple Computer\, Inc//iCal 2.0//EN
+X-WR-RELCALID:3A016BE7-8932-4456-8ABD-C8F7EEC5963A
+X-WR-TIMEZONE:Europe/London
+CALSCALE:GREGORIAN
+METHOD:PUBLISH
+BEGIN:VEVENT
+DTSTART;VALUE=DATE:20090110
+DTEND;VALUE=DATE:20090111
+SUMMARY:New Event
+UID:3829F33C-F601-49AC-A3A5-C3AC4A6A3483
+SEQUENCE:4
+DTSTAMP:20090109T184719Z
+END:VEVENT
+END:VCALENDAR
+EOS
+    @calendar = Icalendar.parse(src).first
+    @event = @calendar.events.first
+  end
+  
+  def test_event_is_parsed
+    assert_not_nil(@event)
+  end
+  
+  def test_dtstart_set_correctly
+    assert_equal("20090110", @event.dtstart.to_ical)
+  end
+  
+end
+
+class TestRecurringEventWithCount < Test::Unit::TestCase 
+  # DTSTART;TZID=US-Eastern:19970902T090000
+  # RRULE:FREQ=DAILY;COUNT=10
+  # ==> (1997 9:00 AM EDT)September 2-11
+  
+  def setup
+    src = <<EOS
+BEGIN:VCALENDAR
+METHOD:PUBLISH
+CALSCALE:GREGORIAN
+VERSION:2.0
+BEGIN:VEVENT
+UID:19970901T130000Z-123401@host.com
+DTSTAMP:19970901T1300Z
+DTSTART:19970902T090000Z
+DTEND:19970902T100000Z
+RRULE:FREQ=DAILY;COUNT=10
+SUMMARY:Annual Employee Review
+CLASS:PRIVATE
+CATEGORIES:BUSINESS,HUMAN RESOURCES
+END:VEVENT
+END:VCALENDAR
+EOS
+    @calendar = Icalendar.parse(src).first
+    @event = @calendar.events.first
+  end
+  
+  def test_event_is_parsed
+    assert_not_nil(@event)
+  end
+  
+  def test_recurrence_rules_should_return_a_recurrence_rule_array
+    assert_equal 1, @event.recurrence_rules.length
+    assert_kind_of(Icalendar::RRule, @event.recurrence_rules.first)
+  end
+  
+  def test_occurrences_after_with_start_before_start_at_should_return_count_occurrences
+    assert_equal 10, @event.occurrences_starting(Time.utc(1997, 9, 2, 8, 30, 0, 0)).length
+  end
+                  
+#  def test_occurrences_after_with_start_before_start_at_should_return_an_event_with_the_dtstart_as_the_first_event
+#    assert_equal @event.dtstart.to_s, @event.occurrences_starting(Time.utc(1997, 9, 2, 8, 30, 0, 0)).first.dtstart.to_s
+#  end
+#  
+#  def test_occurrences_after_with_start_before_start_at_should_return_events_with_the_correct_dtstart_values
+#    expected = (0..9).map {|delta| (@event.dtstart + delta).to_s}
+#    assert_equal expected, @event.occurrences_starting(Time.utc(1997, 9, 2, 8, 30, 0, 0)).map {|occurence| occurence.dtstart.to_s}
+#  end
+end
+