icalendar2 0.1.0

data/lib/icalendar2/property/base.rb

@@ -0,0 +1,80 @@
+module Icalendar2
+  module Property
+    class Base
+      MAX_LINE_LENGTH = 75
+      LIST_SEPARATOR = /(?<!\\),/
+
+      attr_reader :value, :parameters
+
+      class << self; attr_reader :value_types end
+      class << self; attr_reader :value_factories end
+
+      def self.value(options = {})
+        if !options[:types].respond_to?(:map)
+          raise ":types option must be enumberable, was #{options[:types]}"
+        end
+        @value_types = options[:types]
+        @value_factories = options[:types].map { |t| Value.get_factory(t) }
+        define_method(:list?) do
+          options[:list]
+        end
+      end
+
+      def self.name(str)
+        define_method(:name) { str }
+      end
+
+      def initialize(value, parameters = {})
+        @value = if list?
+          value_list = value.respond_to?(:map) ? value : value.split(LIST_SEPARATOR)
+          value_list.map { |v| value_object(v) }
+        else
+          value_object(value)
+        end
+        if @value.nil?
+          raise "Invalid value for #{self.class}: '#{value}'. Must be one of these types: #{self.class.value_types}"
+        end
+        @parameters = parameters || {}
+        validate
+      end
+
+      def name
+        raise "Must define name attribute in Property sublcass #{self.class}."
+      end
+
+      def valid?
+        @valid
+      end
+
+      def to_ical
+        parameters_str = @parameters.map { |k, v| "#{k}=#{v}" }.join(";")
+        parameters_str = ";#{parameters_str}" if parameters_str != ""
+        str = fold("#{name}#{parameters_str}:#{value}")
+        str << Tokens::CRLF
+      end
+
+      private
+
+      def validate
+        @valid = if @value.is_a? Array
+          @value.all?(&:valid?)
+        else
+          @value.valid?
+        end
+      end
+
+      def value_object(value)
+        self.class.value_factories.each do |f|
+          obj = f.new(value)
+          return obj if obj.valid?
+        end
+
+        nil
+      end
+
+      def fold(str)
+        str.scan(/.{1,#{MAX_LINE_LENGTH}}/).join("#{Tokens::CRLF} ")
+      end
+    end
+  end
+end

data/lib/icalendar2/property/categories.rb

@@ -0,0 +1,10 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.2
+    class Categories < Base
+      PLURAL = "categories_properties"
+      name "CATEGORIES"
+      value :types => [:text], :list => true
+    end
+  end
+end

data/lib/icalendar2/property/class.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.3
+    class Klass < Base
+      name "CLASS"
+      value :types => [:text]
+    end
+  end
+end

data/lib/icalendar2/property/comment.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.4
+    class Comment < Base
+      PLURAL = "comments"
+    end
+  end
+end

data/lib/icalendar2/property/contact.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.4.2
+    class Contact < Base
+      PLURAL = "contacts"
+    end
+  end
+end

data/lib/icalendar2/property/description.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.5
+    class Description < Base
+      name "DESCRIPTION"
+      value :types => [:text]
+    end
+  end
+end

data/lib/icalendar2/property/dtend.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.2.2
+    class Dtend < Base
+      name "DTEND"
+      value :types => [:date, :date_time]
+    end
+  end
+end

data/lib/icalendar2/property/dtstamp.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.7.2
+    class Dtstamp < Base
+      name "DTSTAMP"
+      value :types => [:date_time]
+    end
+  end
+end

data/lib/icalendar2/property/dtstart.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.2.4
+    class Dtstart < Base
+      name "DTSTART"
+      value :types => [:date_time, :date]
+    end
+  end
+end

data/lib/icalendar2/property/exdate.rb

@@ -0,0 +1,10 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.5.1
+    class Exdate < Base
+      PLURAL = "exdates"
+      name "EXDATE"
+      value :types => [:date_time, :date], :list => true
+    end
+  end
+end

data/lib/icalendar2/property/geo.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.6
+    class Geo < Base
+      name "GEO"
+      value :types => [:lat_lon]
+    end
+  end
+end

data/lib/icalendar2/property/last_mod.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.7.3
+    class LastMod < Base
+      name "LAST-MODIFIED"
+      value :types => [:date_time]
+    end
+  end
+end

data/lib/icalendar2/property/location.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.7
+    class Location < Base
+      name "LOCATION"
+      value :types => [:text]
+    end
+  end
+end

data/lib/icalendar2/property/nil.rb

@@ -0,0 +1,13 @@
+module Icalendar2
+  module Property
+    class Nil
+      def value
+        nil
+      end
+
+      def to_ical
+        ""
+      end
+    end
+  end
+end

data/lib/icalendar2/property/organizer.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.4.3
+    class Organizer < Base
+      name "ORGANIZER"
+      value :types => [:cal_address]
+    end
+  end
+end

data/lib/icalendar2/property/priority.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.9
+    class Priority < Base
+      name "PRIORITY"
+      value :types => [:integer]
+    end
+  end
+end

data/lib/icalendar2/property/rdate.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.5.2
+    class Rdate < Base
+      PLURAL = "rdates"
+    end
+  end
+end

data/lib/icalendar2/property/related_to.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.4.5
+    class RelatedTo < Base
+      PLURAL = "relateds"
+    end
+  end
+end

data/lib/icalendar2/property/resources.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.10
+    class Resources < Base
+      PLURAL = "resources"
+    end
+  end
+end

data/lib/icalendar2/property/rrule.rb

@@ -0,0 +1,10 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.5.3
+    class Rrule < Base
+      PLURAL = "rrules"
+      name "RRULE"
+      value :types => [:recur]
+    end
+  end
+end

data/lib/icalendar2/property/rstatus.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.8.3
+    class Rstatus < Base
+      PLURAL = "rstatuses"
+    end
+  end
+end

data/lib/icalendar2/property/sequence.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.7.4
+    class Sequence < Base
+      name "SEQUENCE"
+      value :types => [:integer]
+    end
+  end
+end

data/lib/icalendar2/property/summary.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.1.12
+    class Summary < Base
+      name "SUMMARY"
+      value :types => [:text]
+    end
+  end
+end

data/lib/icalendar2/property/uid.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    # See http://tools.ietf.org/html/rfc5545#section-3.8.4.7
+    class Uid < Base
+      name "UID"
+      value :types => [:text]
+    end
+  end
+end

data/lib/icalendar2/property.rb

@@ -0,0 +1,9 @@
+module Icalendar2
+  module Property
+    def self.get_factory(property_sym)
+      # :foo => "Foo", :bar_baz => "BarBaz", etc.
+      property_name = property_sym.to_s.split(/_/).map(&:capitalize).join('')
+      const_get(property_name, false)
+    end
+  end
+end

data/lib/icalendar2/tokens.rb

@@ -0,0 +1,32 @@
+module Icalendar2
+  module Tokens
+    COMPONENT_BEGIN =    "BEGIN"
+    COMPONENT_END =      "END"
+    CRLF =               "\r\n"
+    HTAB =               /\t/
+    DQUOTE =             /"/
+    SOLIDUS =            /\//
+    ALPHA =              /[a-zA-Z]/
+    DIGIT =              /[0-9]/
+    CONTROL_CHARS =      "\x00-\x08\x0A-\x1F\x7F"
+    CONTROL =            /[#{CONTROL_CHARS}]/
+    QSAFE_CHAR =         /[^"#{CONTROL_CHARS}]/
+    SAFE_CHAR =          /[^"#{CONTROL_CHARS};:,]/
+    VALUE_CHAR =         /[^#{CONTROL_CHARS}]/
+    NON_US_ASCII_CHARS = "\x80-\xFF".force_encoding("UTF-8")
+    QUOTED_STRING =      /#{DQUOTE}(?:#{SAFE_CHAR})*#{DQUOTE}/
+    PARAM_VALUE =        "(?:#{SAFE_CHAR})*|#{QUOTED_STRING}"
+    IANA_TOKEN =         "[-a-zA-Z0-9]+"
+    VENDORID =           "[a-zA-Z0-9]{3}"
+    X_NAME =             "X-(?:#{VENDORID}-)?#{IANA_TOKEN}"
+
+    DATE =               /\d{4}(?:0[1-9]|1[012])(?:0[1-9]|[12][0-9]|3[01])/
+    TIME =               /(?:[01][0-9]|2[0-3])(?:[0-5][0-9])(?:[0-5][0-9]|60)Z?/
+    DATE_TIME =          /#{DATE}T#{TIME}/
+
+    # URI components
+    SCHEME =             "#{ALPHA}(?:#{ALPHA}|#{DIGIT}|[-+.])*"
+    HIER_PART =          '[^"<>]+'
+    URI =                "#{SCHEME}:#{HIER_PART}"
+  end
+end

data/lib/icalendar2/value/binary_value.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.1
+  class BinaryValue < Value
+    B_CHAR = "[a-z0-9+/]"
+    B_END = "#{B_CHAR}#{B_CHAR}==|#{B_CHAR}#{B_CHAR}#{B_CHAR}="
+    matches /^(?:#{B_CHAR}#{B_CHAR}#{B_CHAR}#{B_CHAR})*(?:#{B_END})?$/i
+  end
+end

data/lib/icalendar2/value/boolean_value.rb

@@ -0,0 +1,6 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.2
+  class BooleanValue < Value
+    matches /^true$|^false$/i
+  end
+end

data/lib/icalendar2/value/cal_address_value.rb

@@ -0,0 +1,6 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.3
+  class CalAddressValue < Value
+    matches /^#{Tokens::URI}$/
+  end
+end

data/lib/icalendar2/value/date_time_value.rb

@@ -0,0 +1,14 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.5
+  class DateTimeValue < Value
+    matches /^#{Tokens::DATE_TIME}$/
+
+    def initialize(value)
+      if value.is_a?(DateTime)
+        super(value.strftime('%Y%m%dT%H%M%S'))
+      else
+        super(value)
+      end
+    end
+  end
+end

data/lib/icalendar2/value/date_value.rb

@@ -0,0 +1,14 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.4
+  class DateValue < Value
+    matches /^#{Tokens::DATE}$/
+
+    def initialize(value)
+      if value.is_a?(Date)
+        super(value.strftime('%Y%m%d'))
+      else
+        super(value)
+      end
+    end
+  end
+end

data/lib/icalendar2/value/duration_value.rb

@@ -0,0 +1,14 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.6
+  class DurationValue < Value
+    DUR_DAY = "\\d+D"
+    DUR_SECOND = "\\d{1,2}S"
+    DUR_MINUTE = "\\d{1,2}M(?:#{DUR_SECOND})?"
+    DUR_HOUR = "\\d{1,2}H(?:#{DUR_MINUTE})?"
+    DUR_TIME = "T(?:#{DUR_HOUR}|#{DUR_MINUTE}|#{DUR_SECOND})"
+    DUR_DATE = "#{DUR_DAY}(?:#{DUR_TIME})?"
+    DUR_WEEK = "\\d+W"
+    BASE_FORMAT = "P(?:#{DUR_DATE}|#{DUR_TIME}|#{DUR_WEEK})"
+    matches /^(?:\+?|-)#{BASE_FORMAT}$/
+  end
+end

data/lib/icalendar2/value/float_value.rb

@@ -0,0 +1,7 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.7
+  class FloatValue < Value
+    BASE_FORMAT = '(?:\+?|-)\d+(?:\.\d+)?'
+    matches /^#{BASE_FORMAT}$/
+  end
+end

data/lib/icalendar2/value/integer_value.rb

@@ -0,0 +1,6 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.8
+  class IntegerValue < Value
+    matches /^(?:\+?|-)\d+$/
+  end
+end

data/lib/icalendar2/value/lat_lon_value.rb

@@ -0,0 +1,6 @@
+module Icalendar2
+  # Made up of two floats separated by a semicolon.
+  class LatLonValue < Value
+    matches /^#{FloatValue::BASE_FORMAT};#{FloatValue::BASE_FORMAT}$/
+  end
+end

data/lib/icalendar2/value/period_value.rb

@@ -0,0 +1,8 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.9
+  class PeriodValue < Value
+    PERIOD_EXPLICIT = "(?:#{Tokens::DATE_TIME}/#{Tokens::DATE_TIME})"
+    PERIOD_START = "(?:#{Tokens::DATE_TIME}/#{DurationValue::BASE_FORMAT})"
+    matches /^#{PERIOD_EXPLICIT}|#{PERIOD_START}$/
+  end
+end

data/lib/icalendar2/value/recur_value.rb

@@ -0,0 +1,39 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.10
+  class RecurValue < Value
+    FREQ = "(?:SECONDLY|MINUTELY|HOURLY|DAILY|WEEKLY|MONTHLY|YEARLY)"
+    ENDDATE = "(?:#{Tokens::DATE}|#{Tokens::DATE_TIME})"
+
+    SECONDS =         "(?:\d{1,2})"
+    BYSECLIST =       "(?:#{SECONDS}(?:,#{SECONDS})*)"
+
+    MINUTES =         "(?:\d{1,2})"
+    BYMINLIST =       "(?:#{MINUTES}(?:,#{MINUTES})*)"
+
+    HOURS =           "(?:\d{1,2})"
+    BYHRLIST =      "(?:#{HOURS}(?:,#{HOURS})*)"
+
+    ORDWK =           "(?:\d{1,2})"
+    WEEKDAY =         "(?:SU|MO|TU|WE|TH|FR|SA)"
+    WEEKDAYNUM =      "(?:[-+]?#{ORDWK}?#{WEEKDAY})"
+    BYWDAYLIST =      "(?:#{WEEKDAYNUM}(?:,#{WEEKDAYNUM})*)"
+
+    MONTHDAYNUM =     "(?:[-+]?\d{1,2})"
+    BYMODAYLIST =     "(?:#{MONTHDAYNUM}(?:,#{MONTHDAYNUM})*)"
+
+    YEARDAYNUM =      "(?:[-+]?\d{1,2})"
+    BYYRDAYLIST =     "(?:#{YEARDAYNUM}(?:,#{YEARDAYNUM})*)"
+
+    WEEKNUM =         "(?:[-+]?\d{1,2})"
+    BYWKNOLIST =      "(?:#{WEEKNUM}(?:,#{WEEKNUM})*)"
+
+    MONTHNUM =        "(?:\d{1,2})"
+    BYMOLIST =        "(?:#{MONTHNUM}(?:,#{MONTHNUM})*)"
+
+    BYSPLIST =        "(?:#{YEARDAYNUM}(?:,#{YEARDAYNUM})*)"
+
+    RECUR_RULE_PART = "FREQ=#{FREQ}|UNTIL=#{ENDDATE}|COUNT=\d+|INTERVAL=\d+|BYSECOND=#{BYSECLIST}|BYMINUTE=#{BYMINLIST}|BYHOUR=#{BYHRLIST}|BYDAY=#{BYWDAYLIST}|BYMONTHDAY=#{BYMODAYLIST}|BYYEARDAY=#{BYYRDAYLIST}|BYWEEKNO=#{BYWKNOLIST}|BYMONTH=#{BYMOLIST}|BYSETPOS=#{BYSPLIST}|WKST=#{WEEKDAY}"
+
+    matches /^#{RECUR_RULE_PART}(?:;#{RECUR_RULE_PART})*$/
+  end
+end

data/lib/icalendar2/value/text_value.rb

@@ -0,0 +1,17 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.11
+  # This will escape text passed in, so do not escape it first!
+  class TextValue < Value
+
+    def initialize(value)
+      replacements = {
+        '\\' =>     '\\\\',
+        ';' =>      '\;',
+        ',' =>      '\,',
+        "\r\n" =>   "\n",
+        "\r" =>     "\n"
+      }
+      super(value.respond_to?(:gsub) ? value.gsub(/\\|;|,|\r\n|\r/, replacements) : value)
+    end
+  end
+end

data/lib/icalendar2/value/time_value.rb

@@ -0,0 +1,6 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.12
+  class TimeValue < Value
+    matches /^#{Tokens::TIME}$/
+  end
+end

data/lib/icalendar2/value/uri_value.rb

@@ -0,0 +1,6 @@
+module Icalendar2
+  # See http://tools.ietf.org/html/rfc5545#section-3.3.13
+  class UriValue < Value
+    matches /^#{Tokens::URI}$/
+  end
+end

data/lib/icalendar2/value.rb

@@ -0,0 +1,45 @@
+module Icalendar2
+  class Value
+
+    class << self; attr_reader :format_matcher end
+    @format_matcher = nil
+
+    attr_reader :value
+
+    def self.matches(matcher)
+      @format_matcher = matcher
+    end
+
+    def self.get_factory(value_sym)
+      # :foo => "Foo", :bar_baz => "BarBaz", etc.
+      value_name = value_sym.to_s.split(/_/).map(&:capitalize).join('')
+      Icalendar2.const_get("#{value_name}Value", false)
+    end
+
+    def initialize(value)
+      @valid = true
+      @value = value
+      validate
+    end
+
+    def valid?
+      @valid
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    private
+
+    def validate
+      unless self.class.format_matcher.nil?
+        if value.respond_to?(:to_s) && (val = value.to_s).respond_to?(:match)
+          @valid = !!val.match(self.class.format_matcher)
+        else
+          @valid = false
+        end
+      end
+    end
+  end
+end

data/lib/icalendar2/version.rb

@@ -0,0 +1,3 @@
+module Icalendar2
+  VERSION = "0.1.0"
+end