icalendar 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f4b5d7252174baceb4b7e37a64286aaa38523ff
-  data.tar.gz: bfa01a3b7d32a7216f82a63f3b216ddfc2bc8745
+  metadata.gz: 44c08a1f244a35efd4affc4705028dfe9798f707
+  data.tar.gz: f67a4772936897ed6fed5efd4d3d6d8f6c564ac9
 SHA512:
-  metadata.gz: a79833843dcf6a77bc4d4135e25b1bdaa436db93c4195ef76a40e3e8f00fc01dbf28c24871bac057bf362eea201b066b655a2fe16215da5a32576221d3393658
-  data.tar.gz: a2a2d04e8784be3f057cc9f23adcf45ec365282d035cb8655701fe6d08c531381dc7c0fceb8fb42948f8226042d20b1f7cee56a51e3d0ac46dcf1500cd387cfa
+  metadata.gz: 336fc24e516f61e887be407e55c5670475c965770a13e42be3b97fc1843cb02f5a21f40cba4aa76887f868c51637c0d9510548748f4dce34d8ff0d62579d0529
+  data.tar.gz: aeb52da8e30cea70b4faaa2b931b827e19952837f85c2403959859702fa2b80213a0ef4d05d0c7d45ac0ab99bc90b7fa6f96e36e5bc7d1c163d1f6ac4dca06ee

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.5.1 2014-02-27
+ * Check for dtend existence before setting timezone - Jonas Grau
+ * Clean up and refactor components - Kasper Timm Hansen
+
 === 1.5.0 2013-12-06
  * Support for custom x- properties - Jake Craige
 

data/README.md

@@ -6,6 +6,24 @@ iCalendar -- Internet calendaring, Ruby style
 
 <http://github.com/icalendar/icalendar>
 
+2.x Status
+---
+
+iCalendar 2.0 is under active development, and can be followed in the
+[2.0beta branch](https://github.com/icalendar/icalendar/tree/2.0beta).
+
+iCalendar 1.x (currently the master branch) will still survive for a
+while, but will only be accepting bug fixes from this point forward
+unless someone else wants to take over more active maintainership of
+the 1.x series.
+
+### 2.0 Goals ###
+
+* Implements [RFC 5545](http://tools.ietf.org/html/rfc5545)
+* More obvious access to parameters and values
+* Cleaner & easier timezone support
+
+
 DESCRIPTION
 ---
 
@@ -92,7 +110,7 @@ ALARMS
 
 ### Within an event ###
 
-    cal.event.do
+    cal.event do
       # ...other event properties
       alarm do
         action        "EMAIL"
@@ -186,6 +204,31 @@ TIMEZONES
     # END:STANDARD
     # END:VTIMEZONE
 
+iCalendar has some basic support for creating VTIMEZONE blocks from timezone information pulled from `tzinfo`. You must require `tzinfo` support manually to take advantage, and iCalendar only supports `tzinfo` with versions `~> 0.3`
+
+#### Example ####
+
+    require 'tzinfo'
+    require 'icalendar/tzinfo'
+    
+    cal = Calendar.new
+    
+    event_start = DateTime.new 2008, 12, 29, 8, 0, 0
+    event_end = DateTime.new 2008, 12, 29, 11, 0, 0
+    
+    tzid = "America/Chicago"
+    tz = TZInfo::Timezone.get tzid
+    timezone = tz.ical_timezone event_start
+    cal.add timezone
+  
+    cal.event do
+        dtstart     event_start.tap { |d| d.ical_params = {'TZID' => tzid} }
+        dtend       event_end.tap { |d| d.ical_params = {'TZID' => tzid} }
+        summary     "Meeting with the man."
+        description "Have a long lunch meeting and decide nothing..."
+    end
+
+
 Unicode
 ---
 

data/Rakefile

@@ -8,3 +8,11 @@ Rake::TestTask.new do |t|
 end
 
 task default: [:test, :build]
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'icalendar'
+  ARGV.clear
+  IRB.start
+end

data/lib/icalendar/base.rb

@@ -11,7 +11,7 @@ require 'logger'
 
 module Icalendar #:nodoc:
 
-  VERSION = '1.5.0'
+  VERSION = '1.5.1'
 
   # A simple error class to differentiate iCalendar library exceptions
   # from ruby language exceptions or others.

data/lib/icalendar/calendar.rb

@@ -25,88 +25,60 @@ module Icalendar
       self.version = "2.0" # Version of the specification
     end
 
-    def print_component
-      "BEGIN:#{@name.upcase}\r\n" +
-      "VERSION:#{version}\r\n" +
-
-      # Then the properties
-      print_properties(@properties.select { |k,v| k != 'version' }) +
-
-      # sub components
-      yield +
+    def print_headers
+      "VERSION:#{version}\r\n"
+    end
 
-      # End of this component
-      "END:#{@name.upcase}\r\n"
+    def properties_to_print
+      @properties.select { |k,v| k != 'version' }
     end
 
     def event(&block)
-      e = Event.new
-      # Note: I'm not sure this is the best way to pass this down, but it works
-      e.tzid = self.timezones[0].tzid if self.timezones.length > 0
-
-      self.add_component e
-
-      if block
-        e.instance_eval(&block)
-        if e.tzid
-          e.dtstart.ical_params = { "TZID" => e.tzid }
-          e.dtend.ical_params = { "TZID" => e.tzid }
+      calendar_tzid = timezone_id
+      build_component Event.new do
+        # Note: I'm not sure this is the best way to pass this down, but it works
+        self.tzid = calendar_tzid
+
+        if block
+          instance_eval(&block)
+          if tzid
+            dtstart.ical_params = { "TZID" => e.tzid }
+            dtend.ical_params = { "TZID" => e.tzid } unless dtend.nil?
+          end
         end
       end
-
-      e
     end
 
     def find_event(uid)
-      self.events.find {|e| e.uid == uid}
+      events.find {|e| e.uid == uid}
     end
 
     def todo(&block)
-      e = Todo.new
-      self.add_component e
-
-      e.instance_eval(&block) if block
-
-      e
+      build_component Todo.new, &block
     end
 
     def find_todo(uid)
-      self.todos.find {|t| t.uid == uid}
+      todos.find {|t| t.uid == uid}
     end
 
     def journal(&block)
-      e = Journal.new
-      self.add_component e
-
-      e.instance_eval(&block) if block
-
-      e
+      build_component Journal.new, &block
     end
 
     def find_journal(uid)
-      self.journals.find {|j| j.uid == uid}
+      journals.find {|j| j.uid == uid}
     end
 
     def freebusy(&block)
-      e = Freebusy.new
-      self.add_component e
-
-      e.instance_eval(&block) if block
-
-      e
+      build_component Freebusy.new, &block
     end
 
     def find_freebusy(uid)
-      self.freebusys.find {|f| f.uid == uid}
+      freebusys.find {|f| f.uid == uid}
     end
 
     def timezone(&block)
-      e = Timezone.new
-      self.add_component e
-
-      e.instance_eval(&block) if block
-
-      e
+      build_component Timezone.new, &block
     end
 
     # The "PUBLISH" method in a "VEVENT" calendar component is an
@@ -122,6 +94,17 @@ module Icalendar
       self.ip_method = "PUBLISH"
     end
 
+    private
+
+      def build_component(component, &block)
+        add_component component
+        component.instance_eval(&block) if block
+        component
+      end
+
+      def timezone_id
+        timezones[0].tzid if timezones.length > 0
+      end
   end # class Calendar
 
 end # module Icalendar

data/lib/icalendar/component.rb

@@ -49,7 +49,7 @@ module Icalendar
 
     def initialize(name)
       @name = name
-      @components = Hash.new([])
+      @components = Hash.new { |h, k| h[k] = [] }
       @properties = {}
 
       @@logger.info("New #{@name[1,@name.size].capitalize}...")
@@ -57,13 +57,7 @@ module Icalendar
 
     # 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
+      @components[component.key_name] << component
     end
 
     # Add a component to the calendar.
@@ -79,11 +73,7 @@ module Icalendar
     alias add_journal add_component
 
     def remove_component(component)
-      key = (component.class.to_s.downcase + 's').gsub('icalendar::', '').to_sym
-
-      if @components.has_key? key
-        @components[key].delete(component)
-      end
+      @components[component.key_name].delete(component)
     end
 
     # Remove a component from the calendar.
@@ -105,95 +95,82 @@ module Icalendar
 
     # Output in the icalendar format
     def to_ical
-      print_component do
-        s = ""
-        @components.each do |key, comps|
-          comps.each { |component| s << component.to_ical }
-        end
-        s
+      printer do
+        [print_headers,
+          print_properties,
+          print_subcomponents].join
       end
     end
 
     # Print this icalendar component
     def print_component
-      # Begin a new component
-      "BEGIN:#{@name.upcase}\r\n" +
-
-      # Then the properties
-      print_properties +
-
-      # sub components
-      yield +
+      to_ical
+    end
 
-      # End of this component
-      "END:#{@name.upcase}\r\n"
+    def print_subcomponents
+      @components.values.map do |component_parts|
+        Array(component_parts).map &:to_ical
+      end.join
     end
 
-    def print_properties(properties = @properties)
-      s = ""
+    def printer
+      ["BEGIN:#{@name.upcase}\r\n",
+      yield,
+      "END:#{@name.upcase}\r\n"].join
+    end
 
-      properties.sort.each do |key,val|
-        # Take out underscore for property names that conflicted
-        # with built-in words.
-        if key =~ /ip_.*/
-          key = key[3..-1]
+    def print_properties(properties = properties_to_print)
+      excludes = %w(geo rrule categories exdate)
+      properties.sort.map do |key, val|
+        property = fix_conflict_with_built_in(key)
+        prelude = property.gsub(/_/, '-').upcase
+        params = print_parameters(val)
+
+        value = ":#{val.to_ical}"
+        multiline = multiline_property?(property)
+        if multiline || (!multiline && !excludes.include?(property))
+          value = escape_chars(value)
         end
 
-        # Property name
-        if !multiline_property?(key)
-          prelude = "#{key.gsub(/_/, '-').upcase}#{print_parameters val}"
-
-          # Property value
-          value = ":#{val.to_ical}"
-          value = escape_chars(value) unless %w[geo rrule categories exdate].include?(key)
-          add_sliced_text(s, prelude + value)
-        else
-          prelude = "#{key.gsub(/_/, '-').upcase}"
-          val.each do |v|
-            params = print_parameters(v)
-            value = ":#{v.to_ical}"
-            value = escape_chars(value)
-            add_sliced_text(s, prelude + params + value)
-          end
-        end
-      end
-      s
+        chunk_lines(prelude + params + value)
+      end.join
+    end
+
+    # Take out underscore for property names that conflicted
+    # with built-in words.
+    def fix_conflict_with_built_in(key)
+      key.sub(/\Aip_/, '')
     end
 
     def escape_chars(value)
-      v = value.gsub("\\", "\\\\").gsub("\r\n", "\n").gsub("\r", "\n").gsub("\n", "\\n").gsub(",", "\\,").gsub(";", "\\;")
-      return v
-       # return value
+      value.gsub("\\", "\\\\").gsub("\r\n", "\n").gsub("\r", "\n").gsub("\n", "\\n").gsub(",", "\\,").gsub(";", "\\;")
     end
 
-    def add_sliced_text(add_to,escaped)
-      escaped = escaped.split('') # split is unicdoe-aware when `$KCODE = 'u'`
-      add_to << escaped.slice!(0,MAX_LINE_LENGTH).join << "\r\n " while escaped.length != 0 # shift(MAX_LINE_LENGTH) does not work with ruby 1.8.6
-      add_to.gsub!(/ *$/, '')
+    def chunk_lines(str, length = MAX_LINE_LENGTH, separator = "\r\n ")
+      chunks = str.scan(/.{1,#{length}}/)
+      lines = chunks.join(separator) << separator
+      lines.gsub(/ *$/, '')
     end
 
     # Print the parameters for a specific property.
     def print_parameters(value)
-      s = ""
-      return s unless value.respond_to?(:ical_params) && !value.ical_params.nil?
-
-      value.ical_params.each do |key, val|
-        s << ";#{key}"
-        val = [ val ] unless val.is_a?(Array)
-
-        # Possible parameter values
-        unless val.empty?
-          s << "="
-          s << val.map do |pval|
-            if pval.respond_to? :to_ical
-              param = pval.to_ical
-              param = %|"#{param}"| unless param =~ %r{\A#{Parser::QSTR}\z|\A#{Parser::PTEXT}\z}
-              param
-            end
-          end.compact.join(',')
-        end
-      end
-      s
+      return "" unless value.respond_to?(:ical_params)
+
+      Array(value.ical_params).map do |key, val|
+        val = Array(val)
+        next if val.empty?
+
+        escaped = val.map { |v| Parser.escape(v.to_ical) }.join(',')
+        ";#{key}=" << escaped
+      end.join
+    end
+
+    def properties_to_print
+      @properties # subclasses can exclude properties
+    end
+
+    def print_headers
+      "" # subclasses can specify headers
     end
 
     # TODO: Look into the x-property, x-param stuff...
@@ -214,6 +191,10 @@ module Icalendar
     # Make it protected so we can monitor usage...
     protected
 
+    def key_name
+      (self.class.to_s.downcase + 's').gsub('icalendar::', '').to_sym
+    end
+
     def self.ical_component(*syms)
       hash_accessor :@components, *syms
     end

data/lib/icalendar/component/event.rb

@@ -108,7 +108,7 @@ module Icalendar
 
       # Now doing some basic initialization
       sequence 0
-      timestamp DateTime.now
+      timestamp Time.now.utc.to_datetime.tap { |t| t.icalendar_tzid = 'UTC' }
       uid new_uid
     end
 

data/lib/icalendar/component/freebusy.rb

@@ -31,7 +31,7 @@ module Icalendar
     def initialize()
       super("VFREEBUSY")
 
-      timestamp DateTime.now
+      timestamp Time.now.utc.to_datetime.tap { |t| t.icalendar_tzid = 'UTC' }
       uid new_uid
     end
   end

data/lib/icalendar/component/journal.rb

@@ -52,7 +52,7 @@ module Icalendar
       super("VJOURNAL")
 
       sequence 0
-      timestamp DateTime.now
+      timestamp Time.now.utc.to_datetime.tap { |t| t.icalendar_tzid = 'UTC' }
       uid new_uid
     end
 

data/lib/icalendar/component/timezone.rb

@@ -45,19 +45,6 @@ module Icalendar
       @components[key] = component
     end
 
-    # Also need a custom to_ical because typically it iterates over an array
-    # of components.
-    def to_ical
-      print_component do
-      s = ""
-        @components.each_value do |comp|
-          s << comp.to_ical
-        end
-      s
-      end
-    end
-
-
     def initialize(name = "VTIMEZONE")
       super(name)
     end

data/lib/icalendar/component/todo.rb

@@ -56,7 +56,7 @@ module Icalendar
       super("VTODO")
 
       sequence 0
-      timestamp DateTime.now
+      timestamp Time.now.utc.to_datetime.tap { |t| t.icalendar_tzid = 'UTC' }
       uid new_uid
     end
 

data/lib/icalendar/parser.rb

@@ -65,6 +65,19 @@ module Icalendar
       @@logger.debug("New Calendar Parser: #{@file.inspect}")
     end
 
+    def self.escape(value)
+      if value =~ %r{\A#{Parser::QSTR}\z|\A#{Parser::PTEXT}\z}
+        value
+      else
+        stripped = value.gsub '"', "'"
+        if stripped =~ /\A#{Parser::PTEXT}\z/
+          stripped
+        else
+          %|"#{stripped}"|
+        end
+      end
+    end
+
     # Define next line for an IO object.
     # Works for strings now with StringIO
     def next_line

data/test/test_calendar.rb

@@ -45,6 +45,7 @@ class TestCalendar < Test::Unit::TestCase
 
    def test_create_multiple_event_calendar
        # Create a fresh calendar
+       Timecop.freeze DateTime.new(2013, 12, 26, 5, 0, 0, '+0000')
        cal = Calendar.new
        [1,2,3].each do |t|
            cal.event do
@@ -57,7 +58,49 @@ class TestCalendar < Test::Unit::TestCase
                self.summary = "test #{t} todo"
            end
        end
-       cal.to_ical
+       expected_no_uid = <<-EXPECTED.gsub("\n", "\r\n")
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+PRODID:iCalendar-Ruby
+BEGIN:VEVENT
+DTEND:19970901T190000Z
+DTSTAMP:20131226T050000Z
+SEQUENCE:0
+SUMMARY:This is summary 1
+END:VEVENT
+BEGIN:VEVENT
+DTEND:19970902T190000Z
+DTSTAMP:20131226T050000Z
+SEQUENCE:0
+SUMMARY:This is summary 2
+END:VEVENT
+BEGIN:VEVENT
+DTEND:19970903T190000Z
+DTSTAMP:20131226T050000Z
+SEQUENCE:0
+SUMMARY:This is summary 3
+END:VEVENT
+BEGIN:VTODO
+DTSTAMP:20131226T050000Z
+SEQUENCE:0
+SUMMARY:test 1 todo
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20131226T050000Z
+SEQUENCE:0
+SUMMARY:test 2 todo
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20131226T050000Z
+SEQUENCE:0
+SUMMARY:test 3 todo
+END:VTODO
+END:VCALENDAR
+       EXPECTED
+       actual_no_uid = cal.to_ical.gsub /^UID:.*\r\n(?: .*\r\n)*/, ''
+       Timecop.return
+       assert_equal expected_no_uid, actual_no_uid
    end
 
    def test_find

data/test/test_parameter.rb

@@ -40,9 +40,11 @@ class TestParameter < Test::Unit::TestCase
 
   def test_unquoted_property_parameters
     params = {'ALTREP' => ['"http://my.language.net"'],
-              'LANGUAGE' => ['SPANISH:CATILLAN']}
+              'LANGUAGE' => ['SPANISH:CATILLAN'],
+              'CN' => ['Joe "The Man" Tester']}
     expected_params = {'ALTREP' => ['"http://my.language.net"'],
-                       'LANGUAGE' => ['"SPANISH:CATILLAN"']}
+                       'LANGUAGE' => ['"SPANISH:CATILLAN"'],
+                       'CN' => ["Joe 'The Man' Tester"]}
     @event.summary('This is a test summary.', params)
 
     assert_equal params, @event.summary.ical_params

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalendar
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Ryan Ahearn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-07 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake