tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

data/lib/tilia/v_object/i_tip/i_tip_exception.rb

@@ -2,7 +2,7 @@ module Tilia
   module VObject
     module ITip
       # This message is emitted in case of serious problems with iTip messages.
-      class ITipException < Exception
+      class ITipException < StandardError
       end
     end
   end

data/lib/tilia/v_object/i_tip/message.rb

@@ -10,23 +10,23 @@ module Tilia
       class Message
         # The object's UID.
         #
-        # @var string
+        # @return [String]
         attr_accessor :uid
 
         # The component type, such as VEVENT.
         #
-        # @var string
+        # @return [String]
         attr_accessor :component
 
         # Contains the ITip method, which is something like REQUEST, REPLY or
         # CANCEL.
         #
-        # @var string
+        # @return [String]
         attr_accessor :method
 
         # The current sequence number for the event.
         #
-        # @var int
+        # @return [Fixnum]
         attr_accessor :sequence
 
         # The senders' email address.
@@ -35,24 +35,24 @@ module Tilia
         # if the message is sent by email. It may also be populated in Reply-To:
         # or not at all.
         #
-        # @var string
+        # @return [String]
         attr_accessor :sender
 
         # The name of the sender. This is often populated from a CN parameter from
         # either the ORGANIZER or ATTENDEE, depending on the message.
         #
-        # @var string|null
+        # @return [String, nil]
         attr_accessor :sender_name
 
         # The recipient's email address.
         #
-        # @var string
+        # @return [String]
         attr_accessor :recipient
 
         # The name of the recipient. This is usually populated with the CN
         # parameter from the ATTENDEE or ORGANIZER property, if it's available.
         #
-        # @var string|null
+        # @return [String, nil]
         attr_accessor :recipient_name
 
         # After the message has been delivered, this should contain a string such
@@ -63,12 +63,12 @@ module Tilia
         # See:
         # http://tools.ietf.org/html/rfc6638#section-7.3
         #
-        # @var string
+        # @return [String]
         attr_accessor :schedule_status
 
         # The iCalendar / iTip body.
         #
-        # @var \Sabre\VObject\Component\VCalendar
+        # @return [Component::VCalendar]
         attr_accessor :message
 
         # This will be set to true, if the iTip broker considers the change
@@ -82,7 +82,7 @@ module Tilia
         # To see the list of properties that are considered 'significant', check
         # out Sabre\VObject\ITip\Broker::significant_change_properties.
         #
-        # @var bool
+        # @return [Boolean]
         attr_accessor :significant_change
 
         # Returns the schedule status as a string.
@@ -90,7 +90,7 @@ module Tilia
         # For example:
         # 1.2
         #
-        # @return mixed bool|string
+        # @return [String, false]
         def schedule_status
           if !@schedule_status
             false
@@ -99,7 +99,7 @@ module Tilia
           end
         end
 
-        # TODO: document
+        # Initialize instance variables
         def initialize
           @significant_change = true
         end

data/lib/tilia/v_object/invalid_data_exception.rb

@@ -0,0 +1,8 @@
+module Tilia
+  module VObject
+    # This exception is thrown whenever an invalid value is found anywhere in a
+    # iCalendar or vCard object.
+    class InvalidDataException < StandardError
+    end
+  end
+end

data/lib/tilia/v_object/node.rb

@@ -27,34 +27,29 @@ module Tilia
 
       # Reference to the parent object, if this is not the top object.
       #
-      # @var Node
+      # @return [Node]
       attr_accessor :parent
 
-      # The root document.
-      #
-      # @var Component
-      # RUBY: attr_accessor :root
-
       # Serializes the node into a mimedir format.
       #
-      # @return string
+      # @return [String]
       def serialize
       end
 
       # 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
       end
 
       # This method serializes the data into XML. This is used to create xCard or
       # xCal documents.
       #
-      # @param Xml\Writer writer  XML writer.
+      # @param [Xml\Writer] writer  XML writer.
       #
-      # @return void
-      def xml_serialize(_writer)
+      # @return [void]
+      def xml_serialize(writer)
       end
 
       # Call this method on a document if you're done using it.
@@ -62,7 +57,7 @@ module Tilia
       # It's intended to remove all circular references, so PHP can easily clean
       # it up.
       #
-      # @return void
+      # @return [void]
       def destroy
         @parent = nil
         @root = nil
@@ -85,16 +80,16 @@ module Tilia
       #   2 - An inconsequential issue
       #   3 - A severe issue.
       #
-      # @param int options
+      # @param [Fixnum] options
       #
-      # @return array
+      # @return [array]
       def validate(_options = 0)
         []
       end
 
       # Returns the iterator for this object.
       #
-      # @return ElementList
+      # @return [ElementList]
       def iterator
         return @iterator if @iterator
 
@@ -105,14 +100,14 @@ module Tilia
       #
       # Note that this is not actually part of the iterator interface
       #
-      # @param ElementList $iterator
+      # @param [ElementList] $iterator
       #
-      # @return void
+      # @return [void]
       attr_writer :iterator
 
       # Returns the number of elements.
       #
-      # @return int
+      # @return [Fixnum]
       def size
         it = iterator
         it.size
@@ -124,9 +119,9 @@ module Tilia
       #
       # This method just forwards the request to the inner iterator
       #
-      # @param int $offset
+      # @param [Fixnum] $offset
       #
-      # @return bool
+      # @return [Boolean]
       def key?(offset)
         iterator = self.iterator
         iterator.key?(offset)
@@ -136,9 +131,9 @@ module Tilia
       #
       # This method just forwards the request to the inner iterator
       #
-      # @param int $offset
+      # @param [Fixnum] $offset
       #
-      # @return mixed
+      # @return [mixed]
       def [](offset)
         iterator = self.iterator
         iterator[offset]
@@ -148,10 +143,10 @@ module Tilia
       #
       # This method just forwards the request to the inner iterator
       #
-      # @param int $offset
-      # @param mixed $value
+      # @param [Fixnum] $offset
+      # @param $value
       #
-      # @return void
+      # @return [void]
       def []=(offset, value)
         iterator = self.iterator
         iterator[offset] = value
@@ -161,9 +156,9 @@ module Tilia
       #
       # This method just forwards the request to the inner iterator
       #
-      # @param int $offset
+      # @param [Fixnum] $offset
       #
-      # @return void
+      # @return [void]
       def delete(offset)
         iterator = self.iterator
         iterator.delete(offset)

data/lib/tilia/v_object/parameter.rb

@@ -9,27 +9,27 @@ module Tilia
     class Parameter < Node
       # Parameter name.
       #
-      # @var string
+      # @return [String]
       attr_accessor :name
 
       # vCard 2.1 allows parameters to be encoded without a name.
       #
       # We can deduce the parameter name based on it's value.
       #
-      # @var bool
+      # @return [Boolean]
       attr_accessor :no_name
 
       # Parameter value.
       #
-      # @var string
+      # @return [String]
       # RUBY: attr_accessor :value
 
       # Sets up the object.
       #
       # It's recommended to use the create:: factory method instead.
       #
-      # @param string name
-      # @param string value
+      # @param [String] name
+      # @param [String] value
       def initialize(root, name, value = nil)
         @no_name = false
         @name = (name || '').upcase
@@ -59,9 +59,9 @@ module Tilia
       # these are rather silly in 2014 and would probably rarely be
       # used, but we like to be complete.
       #
-      # @param string value
+      # @param [String] value
       #
-      # @return string
+      # @return [String]
       def self.guess_parameter_name_by_value(value)
         value ||= ''
         case value.upcase
@@ -148,9 +148,9 @@ 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]
       attr_writer :value
 
       # Returns the current value.
@@ -158,7 +158,7 @@ module Tilia
       # This method will always return a string, or null. If there were multiple
       # values, it will automatically concatenate them (separated by comma).
       #
-      # @return string|null
+      # @return [String, nil]
       def value
         if @value.is_a?(Array)
           @value.join(',')
@@ -169,9 +169,9 @@ module Tilia
 
       # Sets multiple values for this parameter.
       #
-      # @param array value
+      # @param [array] value
       #
-      # @return void
+      # @return [void]
       def parts=(value)
         @value = value
       end
@@ -180,7 +180,7 @@ module Tilia
       #
       # If there were no values, an empty array will be returned.
       #
-      # @return array
+      # @return [array]
       def parts
         if @value.is_a?(Array)
           @value
@@ -196,9 +196,9 @@ module Tilia
       # If the argument is specified as an array, all items will be added to the
       # parameter value list.
       #
-      # @param string|array part
+      # @param [String|array] part
       #
-      # @return void
+      # @return [void]
       def add_value(part)
         if @value.nil?
           @value = part
@@ -215,9 +215,9 @@ module Tilia
       # instance the TYPE parameter, to see if it contains a keyword such as
       # 'WORK' or 'FAX'.
       #
-      # @param string value
+      # @param [String] value
       #
-      # @return bool
+      # @return [Boolean]
       def has(value)
         value = value.downcase
         results = (@value.is_a?(Array) ? @value : [@value]).select do |entry|
@@ -228,7 +228,7 @@ module Tilia
 
       # Turns the object back into a serialized blob.
       #
-      # @return string
+      # @return [String]
       def serialize
         value = parts
 
@@ -278,7 +278,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
         @value
       end
@@ -286,9 +286,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 [Xml\Writer] writer  XML writer.
       #
-      # @return void
+      # @return [void]
       def xml_serialize(writer)
         @value.split(',').each do |value|
           writer.write_element('text', value)
@@ -297,7 +297,7 @@ module Tilia
 
       # Called when this object is being cast to a string.
       #
-      # @return string
+      # @return [String]
       def to_s
         value.to_s
       end

data/lib/tilia/v_object/parse_exception.rb

@@ -1,7 +1,7 @@
 module Tilia
   module VObject
     # Exception thrown by Reader if an invalid object was attempted to be parsed.
-    class ParseException < Exception
+    class ParseException < StandardError
     end
   end
 end

data/lib/tilia/v_object/parser.rb

@@ -1,5 +1,6 @@
 module Tilia
   module VObject
+    # Namespace of the parser components
     module Parser
       require 'tilia/v_object/parser/parser'
       require 'tilia/v_object/parser/mime_dir'

data/lib/tilia/v_object/parser/json.rb

@@ -6,16 +6,6 @@ module Tilia
       #
       # This parser parses both the jCal and jCard formats.
       class Json < Parser
-        # The input data.
-        #
-        # @var array
-        # RUBY: attr_accessor :input
-
-        # Root component.
-        #
-        # @var Document
-        # RUBY: attr_accessor :root
-
         # This method starts the parsing process.
         #
         # If the input was not supplied during construction, it's possible to pass
@@ -23,10 +13,10 @@ module Tilia
         #
         # If either input or options are not supplied, the defaults will be used.
         #
-        # @param resource|string|array|null input
-        # @param int options
+        # @param [String, #read, nil] input
+        # @param [Fixnum] options
         #
-        # @return Sabre\VObject\Document
+        # @return [Document]
         def parse(input = nil, options = 0)
           self.input = input unless input.nil?
           if @input.nil?
@@ -61,9 +51,9 @@ module Tilia
 
         # Parses a component.
         #
-        # @param array j_comp
+        # @param [Array] j_comp
         #
-        # @return \Sabre\VObject\Component
+        # @return [Component]
         def parse_component(j_comp)
           properties = j_comp[1].map do |j_prop|
             parse_property(j_prop)
@@ -86,9 +76,9 @@ module Tilia
 
         # Parses properties.
         #
-        # @param array j_prop
+        # @param [Array] j_prop
         #
-        # @return \Sabre\VObject\Property
+        # @return [\Sabre\VObject\Property]
         def parse_property(j_prop)
           (
               property_name,
@@ -134,9 +124,9 @@ module Tilia
 
         # Sets the input data.
         #
-        # @param resource|string|array input
+        # @param [String, #read] input
         #
-        # @return void
+        # @return [void]
         def input=(input)
           input = input.read unless input.is_a?(String)
           input = JSON.parse(input)