icalendar 1.5.4 → 2.0.0.beta.1

data/lib/icalendar/timezone.rb

@@ -0,0 +1,53 @@
+module Icalendar
+
+  class Timezone < Component
+    module TzProperties
+      def self.included(base)
+        base.class_eval do
+          required_property :dtstart, Icalendar::Values::DateTime
+          required_property :tzoffsetfrom, Icalendar::Values::UtcOffset
+          required_property :tzoffsetto, Icalendar::Values::UtcOffset
+
+          optional_property :rrule, Icalendar::Values::Recur, true
+          optional_property :comment
+          optional_property :rdate, Icalendar::Values::DateTime
+          optional_property :tzname
+        end
+      end
+    end
+    class Daylight < Component
+      include TzProperties
+
+      def initialize
+        super 'daylight', 'DAYLIGHT'
+      end
+    end
+    class Standard < Component
+      include TzProperties
+
+      def initialize
+        super 'standard', 'STANDARD'
+      end
+    end
+
+
+    required_property :tzid
+
+    optional_single_property :last_modified, Icalendar::Values::DateTime
+    optional_single_property :tzurl, Icalendar::Values::Uri
+
+    component :daylight, false, Icalendar::Timezone::Daylight
+    component :standard, false, Icalendar::Timezone::Standard
+
+    def initialize
+      super 'timezone'
+    end
+
+    def valid?(strict = false)
+      daylights.empty? && standards.empty? and return false
+      daylights.all? { |d| d.valid? strict } or return false
+      standards.all? { |s| s.valid? strict } or return false
+      super
+    end
+  end
+end

data/lib/icalendar/todo.rb

@@ -0,0 +1,52 @@
+module Icalendar
+
+  class Todo < Component
+    required_property :dtstamp, Icalendar::Values::DateTime
+    required_property :uid
+    # dtstart only required if duration is specified
+    required_property :dtstart, Icalendar::Values::DateTime,
+                      ->(todo, dtstart) { !(!todo.duration.nil? && dtstart.nil?) }
+
+    optional_single_property :due, Icalendar::Values::DateTime
+    optional_single_property :duration, Icalendar::Values::Duration
+    mutually_exclusive_properties :due, :duration
+
+    optional_single_property :ip_class
+    optional_single_property :completed, Icalendar::Values::DateTime
+    optional_single_property :created, Icalendar::Values::DateTime
+    optional_single_property :description
+    optional_single_property :geo, Icalendar::Values::Float
+    optional_single_property :last_modified, Icalendar::Values::DateTime
+    optional_single_property :location
+    optional_single_property :organizer, Icalendar::Values::CalAddress
+    optional_single_property :percent_complete, Icalendar::Values::Integer
+    optional_single_property :priority, Icalendar::Values::Integer
+    optional_single_property :recurrence_id, Icalendar::Values::DateTime
+    optional_single_property :sequence, Icalendar::Values::Integer
+    optional_single_property :status
+    optional_single_property :summary
+    optional_single_property :url, Icalendar::Values::Uri
+
+    optional_property :rrule, Icalendar::Values::Recur, true
+    optional_property :attach, Icalendar::Values::Uri
+    optional_property :attendee, Icalendar::Values::CalAddress
+    optional_property :categories
+    optional_property :comment
+    optional_property :contact
+    optional_property :exdate, Icalendar::Values::DateTime
+    optional_property :request_status
+    optional_property :related_to
+    optional_property :resources
+    optional_property :rdate, Icalendar::Values::DateTime
+
+    component :alarm, false
+
+    def initialize
+      super 'todo'
+      self.dtstamp = Icalendar::Values::DateTime.new Time.now.utc, 'tzid' => 'UTC'
+      self.uid = new_uid
+    end
+
+  end
+
+end

data/lib/icalendar/tzinfo.rb

@@ -38,22 +38,22 @@
 # seems to work fine (tested in Mozilla Thunderbird + Lightning).
 # Future goal would be making this better.
 
-# require "rubygems"
-# require "tzinfo"
+
+require 'tzinfo'
 
 module TZInfo
   class Timezone
     def ical_timezone(date, dst = Timezone.default_dst)
       period = period_for_local(date, dst)
       timezone = Icalendar::Timezone.new
-      timezone.timezone_id = identifier
+      timezone.tzid = identifier
       if period.start_transition.nil?
-        timezone.add period.single
+        timezone.add_component period.single
       elsif period.end_transition.nil?
-        timezone.add period.dst? ? period.daylight : period.standard
+        timezone.add_component period.dst? ? period.daylight : period.standard
       else
-        timezone.add period.daylight
-        timezone.add period.standard
+        timezone.add_component period.daylight
+        timezone.add_component period.standard
       end
       timezone
     end
@@ -73,7 +73,7 @@ module TZInfo
       # this is somewhat of a hack, but seems to work ok
       [sprintf(
         'FREQ=YEARLY;BYMONTH=%d;BYDAY=%d%s',
-        start.month, 
+        start.month,
         ((start.day - 1)/ 7).to_i + 1,
         start.strftime('%a').upcase[0,2]
       )]
@@ -93,46 +93,46 @@ module TZInfo
 
   class TimezonePeriod
     def daylight
-      Icalendar::Daylight.new.tap do |day|
+      Icalendar::Timezone::Daylight.new.tap do |day|
         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.tzname = abbreviation.to_s
+          day.tzoffsetfrom = start_transition.offset_from
+          day.tzoffsetto = start_transition.offset_to
           day.dtstart = start_transition.dtstart
-          day.recurrence_rules = start_transition.rrule unless end_transition.nil?
+          day.rrule = start_transition.rrule unless end_transition.nil?
         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.tzname = abbreviation.to_s.sub("ST","DT")
+          day.tzoffsetfrom = end_transition.offset_from
+          day.tzoffsetto = end_transition.offset_to
           day.dtstart = end_transition.dtstart
-          day.recurrence_rules = end_transition.rrule
+          day.rrule = end_transition.rrule
         end
       end
     end
 
     def standard
-      Icalendar::Standard.new.tap do |std|
+      Icalendar::Timezone::Standard.new.tap do |std|
         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.tzname = abbreviation.to_s.sub('DT', 'ST')
+          std.tzoffsetfrom = end_transition.offset_from
+          std.tzoffsetto = end_transition.offset_to
           std.dtstart = end_transition.dtstart
-          std.recurrence_rules = end_transition.rrule
+          std.rrule = 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.tzname = abbreviation.to_s
+          std.tzoffsetfrom = start_transition.offset_from
+          std.tzoffsetto = start_transition.offset_to
           std.dtstart = start_transition.dtstart
-          std.recurrence_rules = start_transition.rrule unless end_transition.nil?
+          std.rrule = start_transition.rrule unless end_transition.nil?
         end
       end
     end
 
     def single
-      Icalendar::Standard.new.tap do |std|
-        std.timezone_name = abbreviation.to_s
-        std.timezone_offset_from = offset.ical_offset
-        std.timezone_offset_to = offset.ical_offset
+      Icalendar::Timezone::Standard.new.tap do |std|
+        std.tzname = abbreviation.to_s
+        std.tzoffsetfrom = offset.ical_offset
+        std.tzoffsetto = offset.ical_offset
         std.dtstart = DateTime.new(1970).strftime '%Y%m%dT%H%M%S'
       end
     end

data/lib/icalendar/value.rb

@@ -0,0 +1,80 @@
+require 'delegate'
+
+module Icalendar
+
+  class Value < ::SimpleDelegator
+
+    attr_accessor :ical_params
+
+    def initialize(value, params = {})
+      @ical_params = params.dup
+      super value
+    end
+
+    def ical_param(key, value)
+      @ical_params[key.to_s] = value
+    end
+
+    def value
+      __getobj__
+    end
+
+    def to_ical(default_type)
+      ical_param 'value', self.class.value_type if needs_value_type?(default_type)
+      "#{params_ical}:#{value_ical}"
+    end
+
+    def params_ical
+      unless ical_params.empty?
+        ";#{ical_params.map { |name, value| param_ical name, value }.join ';'}"
+      end
+    end
+
+    def self.value_type
+      name.gsub(/\A.*::/, '').gsub(/(?<!\A)[A-Z]/, '-\0').upcase
+    end
+
+    private
+
+    def needs_value_type?(default_type)
+      self.class != default_type
+    end
+
+    def param_ical(name, param_value)
+      if param_value.is_a? Array
+        param_value = param_value.map { |v| escape_param_value v }.join ','
+      else
+        param_value = escape_param_value param_value
+      end
+      "#{name.to_s.gsub('_', '-').upcase}=#{param_value}"
+    end
+
+    def escape_param_value(value)
+      v = value.gsub '"', "'"
+      v =~ /[;:,]/ ? %("#{v}") : v
+    end
+
+  end
+
+end
+
+# helper; not actual iCalendar value type
+require_relative 'values/array'
+
+# iCalendar value types
+require_relative 'values/binary'
+require_relative 'values/boolean'
+require_relative 'values/date'
+require_relative 'values/date_time'
+require_relative 'values/duration'
+require_relative 'values/float'
+require_relative 'values/integer'
+require_relative 'values/period'
+require_relative 'values/recur'
+require_relative 'values/text'
+require_relative 'values/time'
+require_relative 'values/uri'
+require_relative 'values/utc_offset'
+
+# further refine above classes
+require_relative 'values/cal_address'

data/lib/icalendar/values/array.rb

@@ -0,0 +1,43 @@
+module Icalendar
+  module Values
+
+    class Array < Value
+
+      def initialize(value, klass, params = {}, options = {})
+        @value_delimiter = options[:delimiter] || ','
+        mapped = if value.is_a? ::Array
+                   value.map { |v| klass.new v, params }
+                 else
+                   [klass.new(value, params)]
+                 end
+        super mapped, params
+      end
+
+      def params_ical
+        value.each do |v|
+          ical_params.merge! v.ical_params
+        end
+        super
+      end
+
+      def value_ical
+        value.map do |v|
+          v.value_ical
+        end.join @value_delimiter
+      end
+
+      def valid?
+        klass = value.first.class
+        !value.all? { |v| v.class == klass }
+      end
+
+      private
+
+      def needs_value_type?(default_type)
+        value.first.class != default_type
+      end
+
+    end
+
+  end
+end

data/lib/icalendar/values/binary.rb

@@ -0,0 +1,31 @@
+require 'base64'
+
+module Icalendar
+  module Values
+
+    class Binary < Value
+
+      def params_ical
+        ical_param :value, 'BINARY'
+        ical_param :encoding, 'BASE64'
+        super
+      end
+
+      def value_ical
+        if base64?
+          value
+        else
+          Base64.strict_encode64 value
+        end
+      end
+
+      private
+
+      def base64?
+        value.is_a?(String) &&
+            value =~ /\A(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{4}|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)\z/
+      end
+    end
+
+  end
+end

data/lib/icalendar/values/boolean.rb

@@ -0,0 +1,17 @@
+module Icalendar
+  module Values
+
+    class Boolean < Value
+
+      def initialize(value, params = {})
+        super value.to_s.downcase == 'true', params
+      end
+
+      def value_ical
+        value ? 'TRUE' : 'FALSE'
+      end
+
+    end
+
+  end
+end

data/lib/icalendar/values/cal_address.rb

@@ -0,0 +1,8 @@
+module Icalendar
+  module Values
+
+    class CalAddress < Uri
+    end
+
+  end
+end

data/lib/icalendar/values/date.rb

@@ -0,0 +1,26 @@
+require 'date'
+
+module Icalendar
+  module Values
+
+    class Date < Value
+      FORMAT = '%Y%m%d'
+
+      def initialize(value, params = {})
+        if value.is_a? String
+          super ::Date.strptime(value, FORMAT), params
+        elsif value.respond_to? :to_date
+          super value.to_date, params
+        else
+          super
+        end
+      end
+
+      def value_ical
+        value.strftime FORMAT
+      end
+
+    end
+
+  end
+end

data/lib/icalendar/values/date_time.rb

@@ -0,0 +1,34 @@
+require 'date'
+require_relative 'time_with_zone'
+
+module Icalendar
+  module Values
+
+    class DateTime < Value
+      include TimeWithZone
+
+      FORMAT = '%Y%m%dT%H%M%S'
+
+      def initialize(value, params = {})
+        if value.is_a? String
+          params['tzid'] = 'UTC' if value.end_with? 'Z'
+          super ::DateTime.strptime(value, FORMAT), params
+        elsif value.respond_to? :to_datetime
+          super value.to_datetime, params
+        else
+          super
+        end
+      end
+
+      def value_ical
+        if tz_utc
+          "#{strftime FORMAT}Z"
+        else
+          strftime FORMAT
+        end
+      end
+
+    end
+
+  end
+end