tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

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

@@ -18,16 +18,16 @@ module Tilia
       class FlatText < Property::Text
         # Field separator.
         #
-        # @var string
+        # @return [String]
         attr_accessor :delimiter
 
         # Sets the value as a quoted-printable encoded string.
         #
         # Overriding this so we're not splitting on a ; delimiter.
         #
-        # @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")

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

@@ -9,7 +9,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
 
         # Sets a raw value coming from a mimedir (iCalendar/vCard) file.
@@ -17,9 +17,9 @@ 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)
           val = val.split(@delimiter)
           val = val.map(&:to_f)
@@ -28,7 +28,7 @@ module Tilia
 
         # Returns a raw mime-dir representation of the value.
         #
-        # @return string
+        # @return [String]
         def raw_mime_dir_value
           parts.join(@delimiter)
         end
@@ -38,7 +38,7 @@ module Tilia
         # This corresponds to the VALUE= parameter. Every property also has a
         # 'default' valueType.
         #
-        # @return string
+        # @return [String]
         def value_type
           'FLOAT'
         end
@@ -47,7 +47,7 @@ module Tilia
         #
         # This method must always return an array.
         #
-        # @return array
+        # @return [array]
         def json_value
           val = parts.map(&:to_f)
 
@@ -63,9 +63,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.values if value.is_a?(Hash)
           value = value.map(&:to_f)
@@ -77,9 +77,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)
           # Special-casing the GEO property.
           #

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

@@ -1,6 +1,7 @@
 module Tilia
   module VObject
     class Property
+      # Namespace of the ICalendar Properties
       module ICalendar
         require 'tilia/v_object/property/i_calendar/cal_address'
         require 'tilia/v_object/property/i_calendar/date_time'

data/lib/tilia/v_object/property/i_calendar/cal_address.rb

@@ -9,7 +9,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.
@@ -17,7 +17,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'CAL-ADDRESS'
           end
@@ -29,7 +29,7 @@ module Tilia
           #
           # Evolution in particular tends to encode mailto: as MAILTO:.
           #
-          # @return string
+          # @return [String]
           def normalized_value
             input = value
             return input unless input.index(':')

data/lib/tilia/v_object/property/i_calendar/date_time.rb

@@ -15,16 +15,16 @@ 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
 
           # Sets a multi-valued property.
           #
           # You may also specify DateTime objects here.
           #
-          # @param array parts
+          # @param [array] parts
           #
-          # @return void
+          # @return [void]
           def parts=(parts)
             if parts[0].is_a?(::Time)
               self.date_times = parts
@@ -39,9 +39,9 @@ module Tilia
           #
           # Instead of strings, you may also use DateTime here.
           #
-          # @param string|array|DateTimeInterface value
+          # @param [String|array|DateTimeInterface] value
           #
-          # @return void
+          # @return [void]
           def value=(value)
             if value.is_a?(Array) && value[0].is_a?(::Time)
               self.date_times = value
@@ -57,23 +57,23 @@ 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.split(@delimiter)
           end
 
           # Returns a raw mime-dir representation of the value.
           #
-          # @return string
+          # @return [String]
           def raw_mime_dir_value
             parts.join(@delimiter)
           end
 
           # Returns true if this is a DATE-TIME value, false if it's a DATE.
           #
-          # @return bool
+          # @return [Boolean]
           def time?
             self['VALUE'].to_s.upcase != 'DATE'
           end
@@ -95,9 +95,9 @@ module Tilia
           # property or floating time, we will use the DateTimeZone argument to
           # figure out the exact date.
           #
-          # @param DateTimeZone time_zone
+          # @param [ActiveSupport::TimeZone] time_zone
           #
-          # @return DateTimeImmutable
+          # @return [Time]
           def date_time(time_zone = nil)
             dt = date_times(time_zone)
             return nil unless dt
@@ -111,10 +111,10 @@ module Tilia
           # property or floating time, we will use the DateTimeZone argument to
           # figure out the exact date.
           #
-          # @param DateTimeZone time_zone
+          # @param [ActiveSupport::TimeZone] time_zone
           #
-          # @return DateTimeImmutable[]
-          # @return \DateTime[]
+          # @return [DateTimeImmutable[]]
+          # @return [\DateTime[]]
           def date_times(time_zone = nil)
             # Does the property have a TZID?
             tzid = self['TZID']
@@ -130,10 +130,10 @@ module Tilia
 
           # Sets the property as a DateTime object.
           #
-          # @param DateTimeInterface dt
-          # @param bool isFloating If set to true, timezones will be ignored.
+          # @param [Time] dt
+          # @param [Boolean] isFloating If set to true, timezones will be ignored.
           #
-          # @return void
+          # @return [void]
           def date_time=(dt)
             self.date_times = [dt]
           end
@@ -143,10 +143,10 @@ module Tilia
           # The first value will be used as a reference for the timezones, and all
           # the otehr values will be adjusted for that timezone
           #
-          # @param DateTimeInterface[] dt
-          # @param bool isFloating If set to true, timezones will be ignored.
+          # @param [DateTimeInterface[]] dt
+          # @param [Boolean] isFloating If set to true, timezones will be ignored.
           #
-          # @return void
+          # @return [void]
           def date_times=(dt)
             update_date_times(dt)
           end
@@ -156,7 +156,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             time? ? 'DATE-TIME' : 'DATE'
           end
@@ -165,7 +165,7 @@ module Tilia
           #
           # This method must always return an array.
           #
-          # @return array
+          # @return [array]
           def json_value
             dts = date_times
 
@@ -185,9 +185,9 @@ module Tilia
           #
           # The value must always be an array.
           #
-          # @param array value
+          # @param [array] value
           #
-          # @return void
+          # @return [void]
           def json_value=(value)
             # dates and times in jCal have one difference to dates and times in
             # iCalendar. In jCal date-parts are separated by dashes, and
@@ -201,10 +201,10 @@ module Tilia
           # We need to intercept offsetSet, because it may be used to alter the
           # VALUE from DATE-TIME to DATE or vice-versa.
           #
-          # @param string name
-          # @param mixed value
+          # @param [String] name
+          # @param value
           #
-          # @return void
+          # @return [void]
           def []=(name, value)
             super
 
@@ -214,26 +214,7 @@ module Tilia
             update_date_times(date_times)
           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_type = self.value_type
@@ -250,7 +231,7 @@ module Tilia
                   Tilia::VObject::DateTimeParser.parse_date_time(value)
                 end
               end
-            rescue RuntimeError
+            rescue InvalidDataException
               messages << {
                 'level'   => 3,
                 'message' => "The supplied value (#{save_val}) is not a correct #[value_type}",
@@ -261,15 +242,6 @@ module Tilia
             messages
           end
 
-          protected
-
-          # Raw values of dates for post_processing
-          #
-          # @return [Array<TIME>]
-          attr_accessor :raw_values
-
-          public
-
           def initialize(*args)
             super
             @delimiter = ','

data/lib/tilia/v_object/property/i_calendar/duration.rb

@@ -11,7 +11,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
 
           # Sets a raw value coming from a mimedir (iCalendar/vCard) file.
@@ -19,16 +19,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.split(@delimiter)
           end
 
           # Returns a raw mime-dir representation of the value.
           #
-          # @return string
+          # @return [String]
           def raw_mime_dir_value
             parts.join(@delimiter)
           end
@@ -38,7 +38,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'DURATION'
           end
@@ -47,7 +47,7 @@ module Tilia
           #
           # If the property has more than one value, only the first is returned.
           #
-          # @return \DateInterval
+          # @return [\DateInterval]
           def date_interval
             parts = self.parts
             value = parts[0]

data/lib/tilia/v_object/property/i_calendar/period.rb

@@ -11,7 +11,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
 
           # Sets a raw value coming from a mimedir (iCalendar/vCard) file.
@@ -19,16 +19,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.split(@delimiter)
           end
 
           # Returns a raw mime-dir representation of the value.
           #
-          # @return string
+          # @return [String]
           def raw_mime_dir_value
             parts.join(@delimiter)
           end
@@ -38,7 +38,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'PERIOD'
           end
@@ -47,9 +47,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.values if value.is_a?(Hash)
             value = value.map do |item|
@@ -63,7 +63,7 @@ module Tilia
           #
           # This method must always return an array.
           #
-          # @return array
+          # @return [array]
           def json_value
             result = []
             parts.each do |item|
@@ -94,9 +94,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)
             writer.start_element(value_type.downcase)
 

data/lib/tilia/v_object/property/i_calendar/recur.rb

@@ -18,13 +18,10 @@ module Tilia
           #
           # This may be either a single, or multiple strings in an array.
           #
-          # @param string|array value
+          # @param [String|array] value
           #
-          # @return void
+          # @return [void]
           def value=(value)
-            # If we're getting the data from json, we'll be receiving an object
-            value = [value] if false # value.is_a?(Array) TODO
-
             if value.is_a?(Hash)
               new_val = {}
               value.each do |k, v|
@@ -33,6 +30,7 @@ module Tilia
 
                   # The value had multiple sub-values
                   v = v.split(',') if v.index(',')
+                  v = v.gsub(/[:\-]/, '') if k == 'until'
                 else
                   v = v.map { |val| val.is_a?(String) ? val.upcase : val }
                 end
@@ -56,7 +54,7 @@ module Tilia
           #
           # To get the correct multi-value version, use getParts.
           #
-          # @return string
+          # @return [String]
           def value
             out = []
             @value.each do |key, value|
@@ -67,9 +65,8 @@ module Tilia
 
           # Sets a multi-valued property.
           #
-          # @param array parts
-          #
-          # @return void
+          # @param [array] parts
+          # @return [void]
           def parts=(parts)
             self.value = parts
           end
@@ -79,7 +76,7 @@ module Tilia
           # This method always returns an array, if there was only a single value,
           # it will still be wrapped in an array.
           #
-          # @return array
+          # @return [array]
           def parts
             @value
           end
@@ -89,16 +86,15 @@ 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
-          #
-          # @return void
+          # @param [String] val
+          # @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
             value
           end
@@ -108,7 +104,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'RECUR'
           end
@@ -117,7 +113,7 @@ module Tilia
           #
           # This method must always return an array.
           #
-          # @return array
+          # @return [array]
           def json_value
             values = {}
             parts.each do |k, v|
@@ -131,9 +127,8 @@ 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.
-          #
-          # @return void
+          # @param [Xml\Writer] writer  XML writer.
+          # @return [void]
           def xml_serialize_value(writer)
             value_type = self.value_type.downcase
 
@@ -142,13 +137,10 @@ module Tilia
             end
           end
 
-          public
-
           # Parses an RRULE value string, and turns it into a struct-ish array.
           #
-          # @param string value
-          #
-          # @return array
+          # @param [String] value
+          # @return [array]
           def self.string_to_array(value)
             value = value.upcase
             new_value = {}