tilia-vobject 4.0.0.pre.alpha5 → 4.0.2

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

@@ -11,7 +11,7 @@ module Tilia
           # This corresponds to the VALUE= parameter. Every property also has a
           # 'default' valueType.
           #
-          # @return string
+          # @return [String]
           def value_type
             'DATE-TIME'
           end

data/lib/tilia/v_object/property/v_card/language_tag.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
           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
             'LANGUAGE-TAG'
           end

data/lib/tilia/v_object/property/v_card/time_stamp.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
             'TIMESTAMP'
           end
@@ -26,7 +26,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)
 
@@ -51,9 +51,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)
             # xCard is the only XML and JSON format that has the same date and time
             # format than vCard.

data/lib/tilia/v_object/reader.rb

@@ -20,12 +20,13 @@ module Tilia
       #
       # You can either supply a string, or a readable stream for input.
       #
-      # @param string|resource data
-      # @param int options
-      #
-      # @return Document
-      def self.read(data, options = 0)
+      # @param [String, #read] data
+      # @param [Fixnum] options
+      # @param [String] charset
+      # @return [Document]
+      def self.read(data, options = 0, charset = 'UTF-8')
         parser = Parser::MimeDir.new
+        parser.charset = charset
         result = parser.parse(data, options)
 
         result
@@ -40,10 +41,10 @@ module Tilia
       # Specifying the array is useful if json_decode was already called on the
       # input.
       #
-      # @param string|resource|array data
-      # @param int options
+      # @param [String, |resource|array] data
+      # @param [Fixnum] options
       #
-      # @return Document
+      # @return [Document]
       def self.read_json(data, options = 0)
         parser = Parser::Json.new
         result = parser.parse(data, options)
@@ -58,10 +59,10 @@ module Tilia
       #
       # You can either supply a string, or a readable stream for input.
       #
-      # @param string|resource data
-      # @param int options
+      # @param [String|resource] data
+      # @param [Fixnum] options
       #
-      # @return Document
+      # @return [Document]
       def self.read_xml(data, options = 0)
         parser = Parser::Xml.new
         result = parser.parse(data, options)

data/lib/tilia/v_object/recur.rb

@@ -1,6 +1,8 @@
 module Tilia
   module VObject
+    # Namespace of the recurrence functionality
     module Recur
+      require 'tilia/v_object/recur/max_instances_exceeded_exception'
       require 'tilia/v_object/recur/no_instances_exception'
       require 'tilia/v_object/recur/event_iterator'
       require 'tilia/v_object/recur/r_date_iterator'

data/lib/tilia/v_object/recur/event_iterator.rb

@@ -44,12 +44,12 @@ module Tilia
       class EventIterator
         # Reference timeZone for floating dates and times.
         #
-        # @var DateTimeZone
+        # @return [ActiveSupport::TimeZone]
         # RUBY: attr_accessor :time_zone
 
         # True if we're iterating an all-day event.
         #
-        # @var bool
+        # @return [Boolean]
         # RUBY: attr_accessor :all_day
 
         # Creates the iterator.
@@ -65,9 +65,9 @@ module Tilia
         #
         # The uid parameter is only required for the first method.
         #
-        # @param Component|array input
-        # @param string|null uid
-        # @param DateTimeZone time_zone Reference timezone for floating dates and
+        # @param [Component|array] input
+        # @param [String, nil] uid
+        # @param [ActiveSupport::TimeZone] time_zone Reference timezone for floating dates and
         #                               times.
         def initialize(input, uid = nil, time_zone = nil)
           @overridden_events = []
@@ -161,14 +161,12 @@ module Tilia
 
           rewind
 
-          unless valid
-            fail Recur::NoInstancesException, 'This recurrence rule does not generate any valid instances'
-          end
+          fail Recur::NoInstancesException, 'This recurrence rule does not generate any valid instances' unless valid
         end
 
         # Returns the date for the current position of the iterator.
         #
-        # @return DateTimeImmutable
+        # @return [Time]
         def current
           @current_date.clone if @current_date
         end
@@ -176,7 +174,7 @@ module Tilia
         # This method returns the start date for the current iteration of the
         # event.
         #
-        # @return DateTimeImmutable
+        # @return [Time]
         def dt_start
           @current_date.clone if @current_date
         end
@@ -184,7 +182,7 @@ module Tilia
         # This method returns the end date for the current iteration of the
         # event.
         #
-        # @return DateTimeImmutable
+        # @return [Time]
         def dt_end
           return nil unless valid
 
@@ -196,7 +194,7 @@ module Tilia
         # This VEVENT will have a recurrence id, and it's DTSTART and DTEND
         # altered.
         #
-        # @return VEvent
+        # @return [VEvent]
         def event_object
           return @current_overridden_event if @current_overridden_event
 
@@ -234,7 +232,7 @@ module Tilia
         #
         # This is for us simply a 0-based index.
         #
-        # @return int
+        # @return [Fixnum]
         def key
           # The counter is always 1 ahead.
           @counter - 1
@@ -243,9 +241,14 @@ module Tilia
         # This is called after next, to see if the iterator is still at a valid
         # position, or if it's at the end.
         #
-        # @return bool
+        # @return [Boolean]
         def valid
-          !!@current_date
+          if @counter > Settings.max_recurrences &&
+             Settings.max_recurrences != -1
+            fail MaxInstancesExceededException, "Recurring events are only allowed to generate #{Settings.max_recurrences}"
+          end
+
+          !@current_date.nil?
         end
 
         # Sets the iterator back to the starting point.
@@ -270,7 +273,7 @@ module Tilia
 
         # Advances the iterator with one step.
         #
-        # @return void
+        # @return [void]
         def next
           @current_overridden_event = nil
           @counter += 1
@@ -318,21 +321,21 @@ module Tilia
 
         # Quickly jump to a date in the future.
         #
-        # @param DateTimeInterface date_time
+        # @param [Time] date_time
         def fast_forward(date_time)
           self.next while valid && dt_end < date_time
         end
 
         # Returns true if this recurring event never ends.
         #
-        # @return bool
+        # @return [Boolean]
         def infinite?
           @recur_iterator.infinite?
         end
 
         # RRULE parser.
         #
-        # @var RRuleIterator
+        # @return [RRuleIterator]
         # RUBY: attr_accessor :recur_iterator
 
         # The duration, in seconds, of the master event.
@@ -342,12 +345,12 @@ module Tilia
 
         # A reference to the main (master) event.
         #
-        # @var VEVENT
+        # @return [VEVENT]
         # RUBY: attr_accessor :master_event
 
         # List of overridden events.
         #
-        # @var array
+        # @return [array]
         # RUBY: attr_accessor :overridden_events
 
         # Overridden event index.
@@ -355,28 +358,28 @@ module Tilia
         # Key is timestamp, value is the index of the item in the overridden_event
         # property.
         #
-        # @var array
+        # @return [array]
         # RUBY: attr_accessor :overridden_events_index
 
         # A list of recurrence-id's that are either part of EXDATE, or are
         # overridden.
         #
-        # @var array
+        # @return [array]
         # RUBY: attr_accessor :exceptions
 
         # Internal event counter.
         #
-        # @var int
+        # @return [Fixnum]
         # RUBY: attr_accessor :counter
 
         # The very start of the iteration process.
         #
-        # @var DateTimeImmutable
+        # @return [Time]
         # RUBY: attr_accessor :start_date
 
         # Where we are currently in the iteration process.
         #
-        # @var DateTimeImmutable
+        # @return [Time]
         # RUBY: attr_accessor :current_date
 
         # The next date from the rrule parser.
@@ -384,7 +387,7 @@ module Tilia
         # Sometimes we need to temporary store the next date, because an
         # overridden event came before.
         #
-        # @var DateTimeImmutable
+        # @return [Time]
         # RUBY: attr_accessor :next_date
 
         def to_a

data/lib/tilia/v_object/recur/max_instances_exceeded_exception.rb

@@ -0,0 +1,10 @@
+module Tilia
+  module VObject
+    module Recur
+      # This exception will get thrown when a recurrence rule generated more than
+      # the maximum number of instances.
+      class MaxInstancesExceededException < StandardError
+      end
+    end
+  end
+end

data/lib/tilia/v_object/recur/no_instances_exception.rb

@@ -4,7 +4,7 @@ module Tilia
       # This exception gets thrown when a recurrence iterator produces 0 instances.
       #
       # This may happen when every occurence in a rrule is also in EXDATE.
-      class NoInstancesException < Exception
+      class NoInstancesException < StandardError
       end
     end
   end

data/lib/tilia/v_object/recur/r_date_iterator.rb

@@ -13,8 +13,8 @@ module Tilia
 
         # Creates the Iterator.
         #
-        # @param string|array rrule
-        # @param DateTimeInterface start
+        # @param [String|array] rrule
+        # @param [Time] start
         def initialize(rrule, start)
           @counter = 0
           @dates = []
@@ -30,7 +30,7 @@ module Tilia
 
         # Returns the current item number.
         #
-        # @return int
+        # @return [Fixnum]
         def key
           @counter
         end
@@ -38,14 +38,14 @@ module Tilia
         # Returns whether the current item is a valid item for the recurrence
         # iterator.
         #
-        # @return bool
+        # @return [Boolean]
         def valid
           @counter <= @dates.size
         end
 
         # Resets the iterator.
         #
-        # @return void
+        # @return [void]
         def rewind
           @current_date = @start_date.clone
           @counter = 0
@@ -53,20 +53,21 @@ module Tilia
 
         # Goes on to the next iteration.
         #
-        # @return void
+        # @return [void]
         def next
           @counter += 1
 
           return nil unless valid
 
           @current_date = DateTimeParser.parse(
-            @dates[@counter - 1]
+            @dates[@counter - 1],
+            @start_date.time_zone
           )
         end
 
         # Returns true if this recurring event never ends.
         #
-        # @return bool
+        # @return [Boolean]
         def infinite?
           false
         end
@@ -74,58 +75,31 @@ module Tilia
         # This method allows you to quickly go to the next occurrence after the
         # specified date.
         #
-        # @param DateTimeInterface dt
+        # @param [Time] dt
         #
-        # @return void
+        # @return [void]
         def fast_forward(dt)
           self.next while valid && @current_date < dt
         end
 
-        # The reference start date/time for the rrule.
-        #
-        # All calculations are based on this initial date.
-        #
-        # @var DateTimeInterface
-        # RUBY: attr_accessor :start_date
-
-        # The date of the current iteration. You can get this by calling
-        # .current.
-        #
-        # @var DateTimeInterface
-        # RUBY: attr_accessor :protected current_date
-
-        # The current item in the list.
-        #
-        # You can get this number with the key method.
-        #
-        # @var int
-        # RUBY: attr_accessor :counter
-
         protected
 
         # This method receives a string from an RRULE property, and populates this
         # class with all the values.
         #
-        # @param string|array rrule
+        # @param [String|array] rrule
         #
-        # @return void
+        # @return [void]
         def parse_r_date(rdate)
           rdate = rdate.split(',') if rdate.is_a?(String)
 
           @dates = rdate
         end
 
-        # TODO
-        #
-        # TODO
-        #
-        # @var TODO
-        # RUBY: attr_accessor :dates
-
         def each
-          m = [@start_date]
+          m = [@start_date.clone]
           n = @dates.map do |d|
-            DateTimeParser.parse(d)
+            DateTimeParser.parse(d, @start_date.time_zone)
           end
           m.concat n
           m.each do |d|