tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

data/lib/tilia/v_object/time_zone_data.rb

@@ -1,5 +1,6 @@
 module Tilia
   module VObject
+    # Namespace of the shipped time zone data
     module TimeZoneData
       require 'tilia/v_object/time_zone_data/exchange_zones'
       require 'tilia/v_object/time_zone_data/lotus_zones'

data/lib/tilia/v_object/time_zone_util.rb

@@ -104,10 +104,10 @@ module Tilia
       # Alternatively, if fail_if_uncertain is set to true, it will throw an
       # exception if we cannot accurately determine the timezone.
       #
-      # @param string tzid
-      # @param Sabre\VObject\Component vcalendar
+      # @param [String] tzid
+      # @param [Component] vcalendar
       #
-      # @return DateTimeZone
+      # @return [ActiveSupport::TimeZone]
       def self.time_zone(tzid, vcalendar = nil, fail_if_uncertain = false)
         # First we will just see if the tzid is a support timezone identifier.
         #
@@ -198,9 +198,9 @@ module Tilia
         return @map if @map
 
         @map = TimeZoneData::PhpZones.list
-        @map.merge! TimeZoneData::ExchangeZones.list
-        @map.merge! TimeZoneData::LotusZones.list
-        @map.merge! TimeZoneData::WindowsZones.list
+        @map.merge!(TimeZoneData::ExchangeZones.list)
+        @map.merge!(TimeZoneData::LotusZones.list)
+        @map.merge!(TimeZoneData::WindowsZones.list)
         @map
       end
 

data/lib/tilia/v_object/uuid_util.rb

@@ -12,7 +12,7 @@ module Tilia
       #
       # @see http://www.php.net/manual/en/function.uniqid.php#94959
       #
-      # @return string
+      # @return [String]
       def self.uuid
         format(
           '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
@@ -41,8 +41,8 @@ module Tilia
 
       # Checks if a string is a valid UUID.
       #
-      # @param string $uuid
-      # @return bool
+      # @param [String] $uuid
+      # @return [Boolean]
       def self.validate_uuid(uuid)
         uuid =~ /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i
       end

data/lib/tilia/v_object/v_card_converter.rb

@@ -17,8 +17,8 @@ module Tilia
       #
       # If input and output version are identical, a clone is returned.
       #
-      # @param Component\VCard input
-      # @param int target_version
+      # @param [Component::VCard] input
+      # @param [Fixnum] target_version
       def convert(input, target_version)
         input_version = input.document_type
         return input.dup if input_version == target_version
@@ -34,6 +34,9 @@ module Tilia
 
         output = Tilia::VObject::Component::VCard.new('VERSION' => new_version)
 
+        # We might have generated a default UID. Remove it!
+        output.delete('UID')
+
         input.children.each do |property|
           convert_property(input, output, property, target_version)
         end
@@ -45,12 +48,12 @@ module Tilia
 
       # Handles conversion of a single property.
       #
-      # @param Component\VCard input
-      # @param Component\VCard output
-      # @param Property property
-      # @param int target_version
+      # @param [Component::VCard] input
+      # @param [Component::VCard] output
+      # @param [Property] property
+      # @param [Fixnum] target_version
       #
-      # @return void
+      # @return [void]
       def convert_property(input, output, property, target_version)
         # Skipping these, those are automatically added.
         return nil if %w(VERSION PRODID).include?(property.name)
@@ -204,12 +207,12 @@ module Tilia
       #
       # vCard 4.0 no longer supports BINARY properties.
       #
-      # @param Component\VCard output
-      # @param Tilia::VObject::Property::Uri property The input property.
-      # @param parameters List of parameters that will eventually be added to
-      #                    the new property.
+      # @param [Component::VCard] output
+      # @param [Tilia::VObject::Property::Uri] property The input property.
+      # @param [Hash] parameters List of parameters that will eventually be added to
+      #                          the new property.
       #
-      # @return Tilia::VObject::Property::Uri
+      # @return [Tilia::VObject::Property::Uri]
       def convert_binary_to_uri(output, new_property, parameters)
         value = new_property.value
         new_property = output.create_property(
@@ -251,10 +254,10 @@ module Tilia
       # be valid in vCard 3.0 as well, we should convert those to BINARY if
       # possible, to improve compatibility.
       #
-      # @param Component\VCard output
-      # @param Tilia::VObject::Property::Uri property The input property.
+      # @param [Component::VCard] output
+      # @param [Property::Uri] property The input property.
       #
-      # @return Tilia::VObject::Property::Binary|null
+      # @return [Property::Binary, nil]
       def convert_uri_to_binary(output, new_property)
         value = new_property.value
 
@@ -291,10 +294,10 @@ module Tilia
 
       # Adds parameters to a new property for vCard 4.0.
       #
-      # @param Property new_property
-      # @param array parameters
+      # @param [Property] new_property
+      # @param [Hash] parameters
       #
-      # @return void
+      # @return [void]
       def convert_parameters40(new_property, parameters)
         # Adding all parameters.
         parameters.each do |_, param|
@@ -322,10 +325,10 @@ module Tilia
 
       # Adds parameters to a new property for vCard 3.0.
       #
-      # @param Property new_property
-      # @param array parameters
+      # @param [Property] new_property
+      # @param [Hash] parameters
       #
-      # @return void
+      # @return [void]
       def convert_parameters30(new_property, parameters)
         # Adding all parameters.
         parameters.each do |_, param|

data/lib/tilia/v_object/version.rb

@@ -3,7 +3,7 @@ module Tilia
     # This class contains the version number for the VObject package.
     class Version
       # Full version number.
-      VERSION = '4.0.0-alpha5'
+      VERSION = '4.0.2'.freeze
     end
   end
 end

data/lib/tilia/v_object/writer.rb

@@ -8,28 +8,28 @@ module Tilia
     class Writer
       # Serializes a vCard or iCalendar object.
       #
-      # @param Component component
+      # @param [Component] component
       #
-      # @return string
+      # @return [String]
       def self.write(component)
         component.serialize
       end
 
       # Serializes a jCal or jCard object.
       #
-      # @param Component component
-      # @param int options
+      # @param [Component] component
+      # @param [Fixnum] options
       #
-      # @return string
+      # @return [String]
       def self.write_json(component)
         component.json_serialize.to_json
       end
 
       # Serializes a xCal or xCard object.
       #
-      # @param Component component
+      # @param [Component] component
       #
-      # @return string
+      # @return [String]
       def self.write_xml(component)
         writer = Tilia::Xml::Writer.new
         writer.open_memory

data/test/test_helper.rb

@@ -16,9 +16,9 @@ require 'minitest/autorun'
 #   #
 #   # CALSCALE will automatically get removed if it's set to GREGORIAN.
 #   #
-#   # @param resource|string|Component expected
-#   # @param resource|string|Component actual
-#   # @param string message
+#   # @param [resource|string|Component] expected
+#   # @param [resource|string|Component] actual
+#   # @param [String] message
 #   self.obj = lambda do |input|
 #     if input.respond_to?(:readlines)
 #       input = input.readlines.join("\n")

data/test/v_object/birthday_calendar_generator_test.rb

@@ -20,6 +20,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:19850407
 RRULE:FREQ=YEARLY
@@ -63,6 +65,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:19850407
 RRULE:FREQ=YEARLY
@@ -70,6 +74,8 @@ TRANSP:TRANSPARENT
 X-SABRE-BDAY;X-SABRE-VCARD-UID=foo;X-SABRE-VCARD-FN=Forrest Gump:BDAY
 END:VEVENT
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:John Doe's Birthday
 DTSTART;VALUE=DATE:19820210
 RRULE:FREQ=YEARLY
@@ -114,6 +120,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:19850407
 RRULE:FREQ=YEARLY
@@ -121,6 +129,8 @@ TRANSP:TRANSPARENT
 X-SABRE-BDAY;X-SABRE-VCARD-UID=foo;X-SABRE-VCARD-FN=Forrest Gump:BDAY
 END:VEVENT
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:John Doe's Birthday
 DTSTART;VALUE=DATE:19820210
 RRULE:FREQ=YEARLY
@@ -154,6 +164,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:19850407
 RRULE:FREQ=YEARLY
@@ -199,6 +211,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:19850407
 RRULE:FREQ=YEARLY
@@ -206,6 +220,8 @@ TRANSP:TRANSPARENT
 X-SABRE-BDAY;X-SABRE-VCARD-UID=foo;X-SABRE-VCARD-FN=Forrest Gump:BDAY
 END:VEVENT
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:John Doe's Birthday
 DTSTART;VALUE=DATE:19820210
 RRULE:FREQ=YEARLY
@@ -237,6 +253,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:20000407
 RRULE:FREQ=YEARLY
@@ -268,6 +286,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Birthday
 DTSTART;VALUE=DATE:20000407
 RRULE:FREQ=YEARLY
@@ -346,6 +366,8 @@ VCF
 BEGIN:VCALENDAR
 VERSION:2.0
 BEGIN:VEVENT
+UID:**ANY**
+DTSTAMP:**ANY**
 SUMMARY:Forrest Gump's Geburtstag
 DTSTART;VALUE=DATE:19850407
 RRULE:FREQ=YEARLY

data/test/v_object/component/v_alarm_test.rb

@@ -128,7 +128,9 @@ module Tilia
         vjournal = calendar.create_component('VJOURNAL')
         vjournal.add(valarm)
 
-        assert_raises(RuntimeError) { valarm.in_time_range?(Time.zone.parse('2012-02-25 01:00:00'), Time.zone.parse('2012-03-05 01:00:00')) }
+        assert_raises(InvalidDataException) do
+          valarm.in_time_range?(Time.zone.parse('2012-02-25 01:00:00'), Time.zone.parse('2012-03-05 01:00:00'))
+        end
       end
 
       # This bug was found and reported on the mailing list.

data/test/v_object/component/v_calendar_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Tilia
   module VObject
-    class VCalendarTest < Minitest::Test
+    class VCalendarTest < TestCase
       def assert_validate(ics, options, expected_level, expected_message = nil)
         vcal = Tilia::VObject::Reader.read(ics)
         result = vcal.validate(options)
@@ -96,6 +96,40 @@ END:VCALENDAR
 
         tests << [input, output]
 
+        # Removing timezone info from sub-components. See Issue #278
+        input = 'BEGIN:VCALENDAR
+CALSCALE:GREGORIAN
+VERSION:2.0
+BEGIN:VTIMEZONE
+TZID:Europe/Paris
+END:VTIMEZONE
+BEGIN:VEVENT
+UID:bla4
+SUMMARY:RemoveTZ info
+DTSTART;TZID=Europe/Paris:20111203T130102
+BEGIN:VALARM
+TRIGGER;VALUE=DATE-TIME;TZID=America/New_York:20151209T133200
+END:VALARM
+END:VEVENT
+END:VCALENDAR
+'
+
+        output = 'BEGIN:VCALENDAR
+CALSCALE:GREGORIAN
+VERSION:2.0
+BEGIN:VEVENT
+UID:bla4
+SUMMARY:RemoveTZ info
+DTSTART:20111203T120102Z
+BEGIN:VALARM
+TRIGGER;VALUE=DATE-TIME:20151209T183200Z
+END:VALARM
+END:VEVENT
+END:VCALENDAR
+'
+
+        tests << [input, output]
+
         # Recurrence rule
         input = 'BEGIN:VCALENDAR
 CALSCALE:GREGORIAN
@@ -297,7 +331,7 @@ END:VCALENDAR
           vcal = Tilia::VObject::Reader.read(input)
           time_zone = ActiveSupport::TimeZone.new(time_zone)
 
-          vcal.expand(
+          vcal = vcal.expand(
             Time.zone.parse(start),
             Time.zone.parse(ending),
             time_zone
@@ -306,7 +340,7 @@ END:VCALENDAR
           # This will normalize the output
           output = Tilia::VObject::Reader.read(output).serialize
 
-          assert_equal(output, vcal.serialize)
+          assert_v_obj_equals(output, vcal.serialize)
         end
       end
 
@@ -322,7 +356,9 @@ END:VCALENDAR
 '
         vcal = Tilia::VObject::Reader.read(input)
 
-        assert_raises(RuntimeError) { vcal.expand(Time.zone.parse('2011-12-01'), Time.zone.parse('2011-12-31')) }
+        assert_raises(InvalidDataException) do
+          vcal.expand(Time.zone.parse('2011-12-01'), Time.zone.parse('2011-12-31'))
+        end
       end
 
       def test_get_document_type

data/test/v_object/component/v_card_test.rb

@@ -42,7 +42,7 @@ module Tilia
           [
             'VERSION MUST appear exactly once in a VCARD component'
           ],
-          "BEGIN:VCARD\r\nVERSION:3.0\r\nFN:John Doe\r\nUID:foo\r\nEND:VCARD\r\n"
+          "BEGIN:VCARD\r\nVERSION:4.0\r\nFN:John Doe\r\nUID:foo\r\nEND:VCARD\r\n"
         ]
 
         # Unknown version

data/test/v_object/component_test.rb

@@ -295,9 +295,11 @@ module Tilia
       def test_serialize_children
         comp = Tilia::VObject::Component::VCalendar.new({}, false)
         event = comp.add(comp.create_component('VEVENT'))
-        event.delete 'DTSTAMP'
-        event.delete 'UID'
-        comp.add(comp.create_component('VTODO'))
+        event.delete('DTSTAMP')
+        event.delete('UID')
+        todo = comp.add(comp.create_component('VTODO'))
+        todo.delete('DTSTAMP')
+        todo.delete('UID')
 
         str = comp.serialize
 

data/test/v_object/date_time_parser_test.rb

@@ -267,7 +267,9 @@ module Tilia
       end
 
       def test_parse_i_calendar_duration_fail
-        assert_raises(RuntimeError) { Tilia::VObject::DateTimeParser.parse_duration('P1X', true) }
+        assert_raises(InvalidDataException) do
+          Tilia::VObject::DateTimeParser.parse_duration('P1X', true)
+        end
       end
 
       def test_parse_i_calendar_date_time
@@ -279,7 +281,9 @@ module Tilia
       end
 
       def test_parse_i_calendar_date_time_bad_format
-        assert_raises(RuntimeError) { Tilia::VObject::DateTimeParser.parse_date_time('20100316T141405 ') }
+        assert_raises(InvalidDataException) do
+          Tilia::VObject::DateTimeParser.parse_date_time('20100316T141405 ')
+        end
       end
 
       def test_parse_i_calendar_date_time_utc
@@ -338,7 +342,9 @@ module Tilia
       end
 
       def test_parse_i_calendar_date_bad_format
-        assert_raises(RuntimeError) { Tilia::VObject::DateTimeParser.parse_date('20100316T141405') }
+        assert_raises(InvalidDataException) do
+          Tilia::VObject::DateTimeParser.parse_date('20100316T141405')
+        end
       end
 
       def test_v_card_date
@@ -349,11 +355,15 @@ module Tilia
       end
 
       def test_bad_v_card_date
-        assert_raises(ArgumentError) { Tilia::VObject::DateTimeParser.parse_v_card_date_time('1985---01') }
+        assert_raises(InvalidDataException) do
+          Tilia::VObject::DateTimeParser.parse_v_card_date_time('1985---01')
+        end
       end
 
       def test_bad_v_card_time
-        assert_raises(ArgumentError) { Tilia::VObject::DateTimeParser.parse_v_card_time('23:12:166') }
+        assert_raises(InvalidDataException) do
+          Tilia::VObject::DateTimeParser.parse_v_card_time('23:12:166')
+        end
       end
 
       def test_date_and_or_time_date_with_year_month_day