tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

data/lib/tilia/v_object/property/integer_value.rb

@@ -11,16 +11,16 @@ module Tilia
         # This has been 'unfolded', so only 1 line will be passed. Unescaping is
         # not yet done, but parameters are not included.
         #
-        # @param string val
+        # @param [String] val
         #
-        # @return void
+        # @return [void]
         def raw_mime_dir_value=(val)
           self.value = val.to_i
         end
 
         # Returns a raw mime-dir representation of the value.
         #
-        # @return string
+        # @return [String]
         def raw_mime_dir_value
           @value
         end
@@ -30,7 +30,7 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'INTEGER'
         end
@@ -39,7 +39,7 @@ module Tilia
         #
         # This method must always return an array.
         #
-        # @return array
+        # @return [array]
         def json_value
           [value.to_i]
         end
@@ -47,11 +47,11 @@ module Tilia
         # Hydrate data from a XML subtree, as it would appear in a xCard or xCal
         # object.
         #
-        # @param array value
+        # @param [array] value
         #
-        # @return void
+        # @return [void]
         def xml_value=(value)
-          value = value.map &:to_i
+          value = value.map(&:to_i)
           super(value)
         end
       end

data/lib/tilia/v_object/property/text.rb

@@ -8,12 +8,12 @@ module Tilia
         # In case this is a multi-value property. This string will be used as a
         # delimiter.
         #
-        # @var string
+        # @return [String]
         attr_accessor :delimiter
 
         # List of properties that are considered 'structured'.
         #
-        # @var array
+        # @return [array]
         # RUBY: attr_accessor :structured_values
 
         # Some text components have a minimum number of components.
@@ -21,7 +21,7 @@ module Tilia
         # N must for instance be represented as 5 components, separated by ;, even
         # if the last few components are unused.
         #
-        # @var array
+        # @return [array]
         # RUBY: attr_accessor :minimum_property_values
 
         # Creates the property.
@@ -30,13 +30,13 @@ module Tilia
         # parameters will automatically be created, or you can just pass a list of
         # Parameter objects.
         #
-        # @param Component root The root document
-        # @param string name
-        # @param string|array|null value
-        # @param array parameters List of parameters
-        # @param string group The vcard property group
+        # @param [Component] root The root document
+        # @param [String] name
+        # @param [String|array, nil] value
+        # @param [array] parameters List of parameters
+        # @param [String] group The vcard property group
         #
-        # @return void
+        # @return [void]
         def initialize(root, name, value = nil, parameters = [], group = nil)
           super(root, name, value, parameters, group)
 
@@ -70,18 +70,18 @@ module Tilia
         # This has been 'unfolded', so only 1 line will be passed. Unescaping is
         # not yet done, but parameters are not included.
         #
-        # @param string val
+        # @param [String] val
         #
-        # @return void
+        # @return [void]
         def raw_mime_dir_value=(val)
           self.value = Parser::MimeDir.unescape_value(val, @delimiter)
         end
 
         # Sets the value as a quoted-printable encoded string.
         #
-        # @param string val
+        # @param [String] val
         #
-        # @return void
+        # @return [void]
         def quoted_printable_value=(val)
           val = Mail::Encodings::QuotedPrintable.decode(val)
           val = val.gsub(/\n/, "\r\n").gsub(/\r\r/, "\r")
@@ -105,7 +105,7 @@ module Tilia
 
         # Returns a raw mime-dir representation of the value.
         #
-        # @return string
+        # @return [String]
         def raw_mime_dir_value
           val = parts
 
@@ -136,7 +136,7 @@ module Tilia
         #
         # This method must always return an array.
         #
-        # @return array
+        # @return [array]
         def json_value
           # Structured text values should always be returned as a single
           # array-item. Multi-value text should be returned as multiple items in
@@ -151,14 +151,14 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'TEXT'
         end
 
         # Turns the object back into a serialized blob.
         #
-        # @return string
+        # @return [String]
         def serialize
           # We need to kick in a special type of encoding, if it's a 2.1 vcard.
           return super unless @root.document_type == Document::VCARD21
@@ -240,9 +240,9 @@ module Tilia
         # This method serializes only the value of a property. This is used to
         # create xCard or xCal documents.
         #
-        # @param Xml\Writer writer  XML writer.
+        # @param [Xml\Writer] writer  XML writer.
         #
-        # @return void
+        # @return [void]
         def xml_serialize_value(writer)
           values = parts
 
@@ -308,22 +308,7 @@ module Tilia
 
         public
 
-        # Validates the node for correctness.
-        #
-        # The following options are supported:
-        #   - Node::REPAIR - If something is broken, and automatic repair may
-        #                    be attempted.
-        #
-        # An array is returned with warnings.
-        #
-        # Every item in the array has the following properties:
-        #    * level - (number between 1 and 3 with severity information)
-        #    * message - (human readable message)
-        #    * node - (reference to the offending node)
-        #
-        # @param int options
-        #
-        # @return array
+        # (see Component#validate)
         def validate(options = 0)
           warnings = super(options)
 
@@ -337,7 +322,7 @@ module Tilia
                 'node'    => self
               }
 
-              if options & self.class::REPAIR > 0
+              if options & REPAIR > 0
                 parts << '' while parts.size < minimum
                 self.parts = parts
               end

data/lib/tilia/v_object/property/time.rb

@@ -8,7 +8,7 @@ module Tilia
         # In case this is a multi-value property. This string will be used as a
         # delimiter.
         #
-        # @var string|null
+        # @return [String, nil]
         attr_accessor :delimiter
 
         # Returns the type of value.
@@ -16,16 +16,33 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'TIME'
         end
 
+        # Sets the JSON value, as it would appear in a jCard or jCal object.
+        #
+        # The value must always be an array.
+        #
+        # @param [array] value
+        # @return [void]
+        def json_value=(value)
+          # Removing colons from value.
+          value = value.map { |v| v.delete(':') }
+
+          if value.size == 1
+            self.value = value.first
+          else
+            self.value = value
+          end
+        end
+
         # Returns the value, in the format it should be encoded for json.
         #
         # This method must always return an array.
         #
-        # @return array
+        # @return [array]
         def json_value
           parts = DateTimeParser.parse_v_card_time(value)
           time_str = ''
@@ -57,7 +74,13 @@ module Tilia
           time_str += parts['second'] unless parts['second'].nil?
 
           # Timezone
-          time_str += parts['timezone'] unless parts['timezone'].nil?
+          unless parts['timezone'].nil?
+            if parts['timezone'] == 'Z'
+              time_str += 'Z'
+            else
+              time_str += parts['timezone'].gsub(/([0-9]{2})([0-9]{2})$/) { "#{Regexp.last_match(1)}:#{Regexp.last_match(2)}" }
+            end
+          end
 
           [time_str]
         end
@@ -65,9 +88,9 @@ module Tilia
         # Hydrate data from a XML subtree, as it would appear in a xCard or xCal
         # object.
         #
-        # @param array value
+        # @param [array] value
         #
-        # @return void
+        # @return [void]
         def xml_value=(value)
           value = value.map do |v|
             v.delete(':')

data/lib/tilia/v_object/property/unknown.rb

@@ -10,7 +10,7 @@ module Tilia
         #
         # This method must always return an array.
         #
-        # @return array
+        # @return [array]
         def json_value
           [raw_mime_dir_value]
         end
@@ -20,7 +20,7 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'UNKNOWN'
         end

data/lib/tilia/v_object/property/uri.rb

@@ -8,7 +8,7 @@ module Tilia
         # In case this is a multi-value property. This string will be used as a
         # delimiter.
         #
-        # @var string|null
+        # @return [String, nil]
         attr_accessor :delimiter
 
         # Returns the type of value.
@@ -16,19 +16,38 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'URI'
         end
 
+        # Returns an iterable list of children.
+        #
+        # @return [array]
+        def parameters
+          parameters = super
+          if !parameters.key?('VALUE') && ['URL', 'PHOTO'].include?(@name)
+            # If we are encoding a URI value, and this URI value has no
+            # VALUE=URI parameter, we add it anyway.
+            #
+            # This is not required by any spec, but both Apple iCal and Apple
+            # AddressBook (at least in version 10.8) will trip over this if
+            # this is not set, and so it improves compatibility.
+            #
+            # See Issue #227 and #235
+            parameters['VALUE'] = Parameter.new(@root, 'VALUE', 'URI')
+          end
+          parameters
+        end
+
         # Sets a raw value coming from a mimedir (iCalendar/vCard) file.
         #
         # This has been 'unfolded', so only 1 line will be passed. Unescaping is
         # not yet done, but parameters are not included.
         #
-        # @param string val
+        # @param [String] val
         #
-        # @return void
+        # @return [void]
         def raw_mime_dir_value=(val)
           # Normally we don't need to do any type of unescaping for these
           # properties, however.. we've noticed that Google Contacts
@@ -57,7 +76,7 @@ module Tilia
 
         # Returns a raw mime-dir representation of the value.
         #
-        # @return string
+        # @return [String]
         def raw_mime_dir_value
           if @value.is_a?(Array)
             value = @value[0]

data/lib/tilia/v_object/property/utc_offset.rb

@@ -8,7 +8,7 @@ module Tilia
         # In case this is a multi-value property. This string will be used as a
         # delimiter.
         #
-        # @var string|null
+        # @return [String, nil]
         attr_accessor :delimiter
 
         # Returns the type of value.
@@ -16,7 +16,7 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'UTC-OFFSET'
         end
@@ -25,9 +25,9 @@ module Tilia
         #
         # The value must always be an array.
         #
-        # @param array value
+        # @param [array] value
         #
-        # @return void
+        # @return [void]
         def json_value=(value)
           value = value.map do |v|
             v.delete(':')
@@ -39,7 +39,7 @@ module Tilia
         #
         # This method must always return an array.
         #
-        # @return array
+        # @return [array]
         def json_value
           super.map do |value|
             "#{value[0...-2]}:#{value[-2..-1]}"

data/lib/tilia/v_object/property/v_card.rb

@@ -1,6 +1,7 @@
 module Tilia
   module VObject
     class Property
+      # Namespace of the VCard Properties
       module VCard
         require 'tilia/v_object/property/v_card/date_and_or_time'
         require 'tilia/v_object/property/v_card/date'

data/lib/tilia/v_object/property/v_card/date.rb

@@ -11,16 +11,16 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'DATE'
           end
 
           # Sets the property as a DateTime object.
           #
-          # @param \DateTimeInterface dt
+          # @param [\DateTimeInterface] dt
           #
-          # @return void
+          # @return [void]
           def date_time=(dt)
             @value = dt.strftime('%Y%m%d')
           end

data/lib/tilia/v_object/property/v_card/date_and_or_time.rb

@@ -8,7 +8,7 @@ module Tilia
         class DateAndOrTime < Property
           # Field separator.
           #
-          # @var null|string
+          # @return [null|string]
           attr_accessor :delimiter
 
           # Returns the type of value.
@@ -16,7 +16,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'DATE-AND-OR-TIME'
           end
@@ -25,9 +25,9 @@ module Tilia
           #
           # You may also specify DateTime objects here.
           #
-          # @param array parts
+          # @param [array] parts
           #
-          # @return void
+          # @return [void]
           def parts=(parts)
             fail ArgumentError, 'Only one value allowed' if parts.size > 1
 
@@ -44,9 +44,9 @@ module Tilia
           #
           # Instead of strings, you may also use DateTime here.
           #
-          # @param string|array|\DateTime value
+          # @param [String|array|\DateTime] value
           #
-          # @return void
+          # @return [void]
           def value=(value)
             if value.is_a?(::Time)
               self.date_time = value
@@ -57,9 +57,9 @@ module Tilia
 
           # Sets the property as a DateTime object.
           #
-          # @param DateTimeInterface dt
+          # @param [Time] dt
           #
-          # @return void
+          # @return [void]
           def date_time=(dt)
             tz = dt.time_zone
             is_utc = ['UTC', 'GMT', 'Z'].include?(tz.name)
@@ -87,7 +87,7 @@ module Tilia
           # current values for those. So at the time of writing, if the year was
           # omitted, we would have filled in 2014.
           #
-          # @return DateTimeImmutable
+          # @return [Time]
           def date_time
             now = ::Time.zone.now
 
@@ -103,14 +103,21 @@ module Tilia
             end
 
             # Now follows a ruby Hack
-            offset = date_parts['timezone'][0..2].to_f + date_parts['timezone'][3..4].to_f / 100
-            tz = ActiveSupport::TimeZone.new(offset)
-            datetime = tz.parse("#{date_parts['year']}-#{date_parts['month']}-#{date_parts['date']} #{date_parts['hour']}:#{date_parts['minute']}:#{date_parts['second']}")
-            unless datetime.strftime('%z') == date_parts['timezone']
-              tz = ActiveSupport::TimeZone.new(offset - 1.0)
+            date_parts['timezone'] = '+0000' if date_parts['timezone'] == 'Z'
+            done = false
+            datetime = nil
+
+            ActiveSupport::TimeZone.all.each do |tz|
               datetime = tz.parse("#{date_parts['year']}-#{date_parts['month']}-#{date_parts['date']} #{date_parts['hour']}:#{date_parts['minute']}:#{date_parts['second']}")
+
+              next unless datetime.strftime('%z') == date_parts['timezone']
+
+              done = true
+              break
             end
-            # continue as usual
+
+            fail 'could not load correct time zone' unless done
+            # End ruby hack
 
             datetime.freeze
             datetime
@@ -120,7 +127,7 @@ module Tilia
           #
           # This method must always return an array.
           #
-          # @return array
+          # @return [array]
           def json_value
             parts = DateTimeParser.parse_v_card_date_time(value)
 
@@ -201,9 +208,9 @@ module Tilia
           # This method serializes only the value of a property. This is used to
           # create xCard or xCal documents.
           #
-          # @param Xml\Writer writer  XML writer.
+          # @param [Xml\Writer] writer  XML writer.
           #
-          # @return void
+          # @return [void]
           def xml_serialize_value(writer)
             value_type = self.value_type.downcase
             parts     = DateTimeParser.parse_v_card_date_and_or_time(value)
@@ -281,47 +288,28 @@ module Tilia
           # This has been 'unfolded', so only 1 line will be passed. Unescaping is
           # not yet done, but parameters are not included.
           #
-          # @param string val
+          # @param [String] val
           #
-          # @return void
+          # @return [void]
           def raw_mime_dir_value=(val)
             self.value = val
           end
 
           # Returns a raw mime-dir representation of the value.
           #
-          # @return string
+          # @return [String]
           def raw_mime_dir_value
             parts.join(@delimiter)
           end
 
-          # Validates the node for correctness.
-          #
-          # The following options are supported:
-          #   Node::REPAIR - May attempt to automatically repair the problem.
-          #
-          # This method returns an array with detected problems.
-          # Every element has the following properties:
-          #
-          #  * level - problem level.
-          #  * message - A human-readable string describing the issue.
-          #  * node - A reference to the problematic node.
-          #
-          # The level means:
-          #   1 - The issue was repaired (only happens if REPAIR was turned on)
-          #   2 - An inconsequential issue
-          #   3 - A severe issue.
-          #
-          # @param int options
-          #
-          # @return array
+          # (see Component#validate)
           def validate(options = 0)
             messages = super(options)
             value = self.value
 
             begin
               DateTimeParser.parse_v_card_date_time(value)
-            rescue ArgumentError
+            rescue InvalidDataException
               messages << {
                 'level'   => 3,
                 'message' => "The supplied value (#{value}) is not a correct DATE-AND-OR-TIME property",