tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

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

@@ -10,17 +10,19 @@ module Tilia
         #
         # This should be 'VCALENDAR' or 'VCARD'.
         #
-        # @var string
+        # @return [String]
         @default_name = 'VCARD'
 
-        # Caching the version number.
+        # This is a list of components, and which classes they should map to.
         #
-        # @var int
-        # RUBY: attr_accessor :version
+        # @return [Hash]
+        @component_map = {
+          'VCARD' => Component::VCard
+        }
 
         # List of value-types, and which classes they map to.
         #
-        # @var array
+        # @return [Hash]
         @value_map = {
           'BINARY'           => Property::Binary,
           'BOOLEAN'          => Property::Boolean,
@@ -42,7 +44,7 @@ module Tilia
 
         # List of properties, and which classes they map to.
         #
-        # @var array
+        # @return [Hash]
         @property_map = {
           # vCard 2.1 properties and up
           'N'       => Property::Text,
@@ -109,24 +111,24 @@ module Tilia
           'ORG-DIRECTORY' => Property::FlatText
         }
 
-        @component_map = {}
-
         # Returns the current document type.
         #
-        # @return int
+        # @return [Fixnum]
         def document_type
           unless @version
             version = self['VERSION'].to_s
 
             case version
             when '2.1'
-              @version = self.class::VCARD21
+              @version = VCARD21
             when '3.0'
-              @version = self.class::VCARD30
+              @version = VCARD30
             when '4.0'
-              @version = self.class::VCARD40
+              @version = VCARD40
             else
-              @version = self.class::UNKNOWN
+              # We don't want to cache the version if it's unknown,
+              # because we might get a version property in a bit.
+              return UNKNOWN
             end
           end
 
@@ -142,9 +144,9 @@ module Tilia
         #
         # If input and output version are identical, a clone is returned.
         #
-        # @param int target
+        # @param [Fixnum] target
         #
-        # @return VCard
+        # @return [VCard]
         def convert(target)
           converter = VCardConverter.new
           converter.convert(self, target)
@@ -155,33 +157,14 @@ module Tilia
         # If the VCARD doesn't know its version, 2.1 is assumed.
         DEFAULT_VERSION = VCARD21
 
-        # 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)
           warnings = []
 
           version_map = {
-            self.class::VCARD21 => '2.1',
-            self.class::VCARD30 => '3.0',
-            self.class::VCARD40 => '4.0'
+            VCARD21 => '2.1',
+            VCARD30 => '3.0',
+            VCARD40 => '4.0'
           }
 
           version = select('VERSION')
@@ -193,12 +176,12 @@ module Tilia
                 'message' => 'Only vcard version 4.0 (RFC6350), version 3.0 (RFC2426) or version 2.1 (icm-vcard-2.1) are supported.',
                 'node'    => self
               }
-              if options & self.class::REPAIR > 0
-                self['VERSION'] = version_map[self.class::DEFAULT_VERSION]
+              if options & REPAIR > 0
+                self['VERSION'] = version_map[DEFAULT_VERSION]
               end
             end
 
-            if version == '2.1' && options & self.class::PROFILE_CARDDAV > 0
+            if version == '2.1' && options & PROFILE_CARDDAV > 0
               warnings << {
                 'level'   => 3,
                 'message' => 'CardDAV servers are not allowed to accept vCard 2.1.',
@@ -209,7 +192,7 @@ module Tilia
 
           uid = select('UID')
           if uid.size == 0
-            if options & self.class::PROFILE_CARDDAV > 0
+            if options & PROFILE_CARDDAV > 0
               # Required for CardDAV
               warning_level = 3
               message = 'vCards on CardDAV servers MUST have a UID property.'
@@ -219,7 +202,7 @@ module Tilia
               message = 'Adding a UID to a vCard property is recommended.'
             end
 
-            if options & self.class::REPAIR > 0
+            if options & REPAIR > 0
               self['UID'] = UuidUtil.uuid
               warning_level = 1
             end
@@ -235,7 +218,7 @@ module Tilia
           if fn.size != 1
             repaired = false
 
-            if options & self.class::REPAIR > 0 && fn.size == 0
+            if options & REPAIR > 0 && fn.size == 0
               # We're going to try to see if we can use the contents of the
               # N property.
               if key?('N')
@@ -268,19 +251,7 @@ module Tilia
           w
         end
 
-        # A simple list of validation rules.
-        #
-        # This is simply a list of properties, and how many times they either
-        # must or must not appear.
-        #
-        # Possible values per property:
-        #   * 0 - Must not appear.
-        #   * 1 - Must appear exactly once.
-        #   * + - Must appear at least once.
-        #   * * - Can appear any number of times.
-        #   * ? - May appear, but not more than once.
-        #
-        # @var array
+        # (see Component#validation_rules)
         def validation_rules
           {
             'ADR'          => '*',
@@ -334,9 +305,9 @@ module Tilia
         # If neither of those parameters are specified, the first is returned, if
         # a field with that name does not exist, null is returned.
         #
-        # @param string field_name
+        # @param [String] field_name
         #
-        # @return VObject\Property|null
+        # @return [Property, nil]
         def preferred(property_name)
           preferred = nil
           last_pref = 101
@@ -362,11 +333,12 @@ module Tilia
 
         # This method should return a list of default property values.
         #
-        # @return array
+        # @return [Hash]
         def defaults
           {
-            'VERSION' => '3.0',
-            'PRODID'  => "-//Tilia//Tilia VObject #{Version::VERSION}//EN"
+            'VERSION' => '4.0',
+            'PRODID'  => "-//Tilia//Tilia VObject #{Version::VERSION}//EN",
+            'UID'     => "tilia-vobject-#{UuidUtil.uuid}"
           }
         end
 
@@ -375,7 +347,7 @@ module Tilia
         # This method returns an array, with the representation as it should be
         # encoded in json. This is used to create jCard or jCal documents.
         #
-        # @return array
+        # @return [Array]
         def json_serialize
           # A vcard does not have sub-components, so we're overriding this
           # method to remove that array element.
@@ -391,9 +363,9 @@ module Tilia
         # This method serializes the data into XML. This is used to create xCard or
         # xCal documents.
         #
-        # @param Xml\Writer writer  XML writer.
+        # @param [Tilia::Xml::Writer] writer  XML writer.
         #
-        # @return void
+        # @return [void]
         def xml_serialize(writer)
           properties_by_group = {}
 
@@ -433,22 +405,23 @@ module Tilia
 
         # Returns the default class for a property name.
         #
-        # @param string property_name
+        # @param [String] property_name
         #
-        # @return string
+        # @return [String]
         def class_name_for_property_name(property_name)
           class_name = super(property_name)
 
           # In vCard 4, BINARY no longer exists, and we need URI instead.
-          if class_name == Property::Binary && document_type == self.class::VCARD40
+          if class_name == Property::Binary && document_type == VCARD40
             return Property::Uri
           end
 
           class_name
         end
 
+        # sets instance variables
         def initialize(*args)
-          super(*args)
+          super
           @version = nil
         end
       end

data/lib/tilia/v_object/component/v_event.rb

@@ -11,10 +11,10 @@ module Tilia
         # The rules used to determine if an event falls within the specified
         # time-range is based on the CalDAV specification.
         #
-        # @param DateTimeInterface start
-        # @param DateTimeInterface end
+        # @param [Time] start
+        # @param [Time] end
         #
-        # @return bool
+        # @return [Boolean]
         def in_time_range?(start, ending)
           if self['RRULE']
             begin
@@ -63,7 +63,7 @@ module Tilia
 
         # This method should return a list of default property values.
         #
-        # @return array
+        # @return [Hash]
         def defaults
           {
             'UID'     => 'sabre-vobject-' + Tilia::VObject::UuidUtil.uuid,
@@ -73,19 +73,7 @@ module Tilia
 
         public
 
-        # A simple list of validation rules.
-        #
-        # This is simply a list of properties, and how many times they either
-        # must or must not appear.
-        #
-        # Possible values per property:
-        #   * 0 - Must not appear.
-        #   * 1 - Must appear exactly once.
-        #   * + - Must appear at least once.
-        #   * * - Can appear any number of times.
-        #   * ? - May appear, but not more than once.
-        #
-        # @var array
+        # (see Component#validation_rules)
         def validation_rules
           {
             'UID'           => 1,

data/lib/tilia/v_object/component/v_free_busy.rb

@@ -9,10 +9,10 @@ module Tilia
         # Checks based on the contained FREEBUSY information, if a timeslot is
         # available.
         #
-        # @param DateTimeInterface start
-        # @param DateTimeInterface end
+        # @param [Time] start
+        # @param [Time] end
         #
-        # @return bool
+        # @return [Boolean]
         def free?(start, ending)
           select('FREEBUSY').each do |freebusy|
             # We are only interested in FBTYPE=BUSY (the default),
@@ -45,19 +45,7 @@ module Tilia
           true
         end
 
-        # A simple list of validation rules.
-        #
-        # This is simply a list of properties, and how many times they either
-        # must or must not appear.
-        #
-        # Possible values per property:
-        #   * 0 - Must not appear.
-        #   * 1 - Must appear exactly once.
-        #   * + - Must appear at least once.
-        #   * * - Can appear any number of times.
-        #   * ? - May appear, but not more than once.
-        #
-        # @var array
+        # (see Component#validation_rules)
         def validation_rules
           {
             'UID'     => 1,

data/lib/tilia/v_object/component/v_journal.rb

@@ -11,10 +11,10 @@ module Tilia
         # The rules used to determine if an event falls within the specified
         # time-range is based on the CalDAV specification.
         #
-        # @param DateTimeInterface start
-        # @param DateTimeInterface end
+        # @param [Time] start
+        # @param [Time] end
         #
-        # @return bool
+        # @return [Boolean]
         def in_time_range?(start, ending)
           dtstart = key?('DTSTART') ? self['DTSTART'].date_time : nil
           if dtstart
@@ -27,19 +27,7 @@ module Tilia
           false
         end
 
-        # A simple list of validation rules.
-        #
-        # This is simply a list of properties, and how many times they either
-        # must or must not appear.
-        #
-        # Possible values per property:
-        #   * 0 - Must not appear.
-        #   * 1 - Must appear exactly once.
-        #   * + - Must appear at least once.
-        #   * * - Can appear any number of times.
-        #   * ? - May appear, but not more than once.
-        #
-        # @var array
+        # (see Component#validation_rules)
         def validation_rules
           {
             'UID'     => 1,
@@ -69,6 +57,18 @@ module Tilia
             'RDATE'       => '*'
           }
         end
+
+        protected
+
+        # This method should return a list of default property values.
+        #
+        # @return [array]
+        def defaults
+          {
+            'UID'     => "tilia-vobject-#{UuidUtil.uuid}",
+            'DTSTAMP' => Time.zone.now.strftime('%Y%m%dT%H%M%SZ')
+          }
+        end
       end
     end
   end

data/lib/tilia/v_object/component/v_time_zone.rb

@@ -11,24 +11,12 @@ module Tilia
         # If we can't accurately determine the timezone, this method will return
         # UTC.
         #
-        # @return \DateTimeZone
+        # @return [ActiveSupport::TimeZone]
         def time_zone
           Tilia::VObject::TimeZoneUtil.time_zone(self['TZID'].to_s, @root)
         end
 
-        # A simple list of validation rules.
-        #
-        # This is simply a list of properties, and how many times they either
-        # must or must not appear.
-        #
-        # Possible values per property:
-        #   * 0 - Must not appear.
-        #   * 1 - Must appear exactly once.
-        #   * + - Must appear at least once.
-        #   * * - Can appear any number of times.
-        #   * ? - May appear, but not more than once.
-        #
-        # @var array
+        # (see Component#validation_rules)
         def validation_rules
           {
             'TZID' => 1,

data/lib/tilia/v_object/component/v_todo.rb

@@ -11,10 +11,10 @@ module Tilia
         # The rules used to determine if an event falls within the specified
         # time-range is based on the CalDAV specification.
         #
-        # @param DateTimeInterface start
-        # @param DateTimeInterface end
+        # @param [Time] start
+        # @param [Time] end
         #
-        # @return bool
+        # @return [Boolean]
         def in_time_range?(start, ending)
           dtstart = key?('DTSTART') ? self['DTSTART'].date_time : nil
           duration = key?('DURATION') ? Tilia::VObject::DateTimeParser.parse_duration(self['DURATION']) : nil
@@ -46,19 +46,7 @@ module Tilia
           true
         end
 
-        # A simple list of validation rules.
-        #
-        # This is simply a list of properties, and how many times they either
-        # must or must not appear.
-        #
-        # Possible values per property:
-        #   * 0 - Must not appear.
-        #   * 1 - Must appear exactly once.
-        #   * + - Must appear at least once.
-        #   * * - Can appear any number of times.
-        #   * ? - May appear, but not more than once.
-        #
-        # @var array
+        # (see Component#validation_rules)
         def validation_rules
           {
             'UID'     => 1,
@@ -98,26 +86,7 @@ module Tilia
           }
         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)
           result = super(options)
           if key?('DUE') && key?('DTSTART')
@@ -141,6 +110,18 @@ module Tilia
 
           result
         end
+
+        protected
+
+        # This method should return a list of default property values.
+        #
+        # @return [Hash]
+        def defaults
+          {
+            'UID'     => "tilia-vobject-#{UuidUtil.uuid}",
+            'DTSTAMP' => Time.zone.now.strftime('%Y%m%dT%H%M%SZ')
+          }
+        end
       end
     end
   end