tilia-vobject 4.0.0.pre.alpha2

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

@@ -0,0 +1,114 @@
+module Tilia
+  module VObject
+    class Component
+      # VAlarm component.
+      #
+      # This component contains some additional functionality specific for VALARMs.
+      class VAlarm < Component
+        # Returns a DateTime object when this alarm is going to trigger.
+        #
+        # This ignores repeated alarm, only the first trigger is returned.
+        #
+        # @return DateTimeImmutable
+        def effective_trigger_time
+          trigger = self['TRIGGER']
+          if !trigger.key?('VALUE') || trigger['VALUE'].to_s.upcase == 'DURATION'
+            trigger_duration = DateTimeParser.parse_duration(self['TRIGGER'])
+            related = (trigger.key?('RELATED') && trigger['RELATED'].to_s.upcase == 'END') ? 'END' : 'START'
+
+            parent_component = parent
+            if related == 'START'
+              if parent_component.name == 'VTODO'
+                prop_name = 'DUE'
+              else
+                prop_name = 'DTSTART'
+              end
+
+              effective_trigger = parent_component[prop_name].date_time
+              effective_trigger += trigger_duration
+            else
+              if parent_component.name == 'VTODO'
+                end_prop = 'DUE'
+              elsif parent_component.name == 'VEVENT'
+                end_prop = 'DTEND'
+              else
+                fail 'time-range filters on VALARM components are only supported when they are a child of VTODO or VEVENT'
+              end
+
+              if parent_component.key?(end_prop)
+                effective_trigger = parent_component[end_prop].date_time
+                effective_trigger += trigger_duration
+              elsif parent_component.key?('DURATION')
+                effective_trigger = parent_component['DTSTART'].date_time
+                duration = DateTimeParser.parse_duration(parent_component['DURATION'])
+                effective_trigger += duration
+                effective_trigger += trigger_duration
+              else
+                effective_trigger = parent_component['DTSTART'].date_time
+                effective_trigger += trigger_duration
+              end
+            end
+          else
+            effective_trigger = trigger.date_time
+          end
+
+          effective_trigger
+        end
+
+        # Returns true or false depending on if the event falls in the specified
+        # time-range. This is used for filtering purposes.
+        #
+        # The rules used to determine if an event falls within the specified
+        # time-range is based on the CalDAV specification.
+        #
+        # @param DateTime start
+        # @param DateTime ending
+        #
+        # @return bool
+        def in_time_range?(start, ending)
+          effective_trigger = effective_trigger_time
+
+          if key?('DURATION')
+            duration = DateTimeParser.parse_duration(self['DURATION'])
+            repeat = self['repeat']
+            repeat = 1 if repeat.blank?
+
+            occurrence = effective_trigger
+            repeat.to_s.to_i.times do |_i|
+              return true if start <= occurrence && ending > occurrence
+              occurrence += duration
+            end
+            return false
+          else
+            start <= effective_trigger && ending > effective_trigger
+          end
+        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
+        def validation_rules
+          {
+            'ACTION'  => 1,
+            'TRIGGER' => 1,
+
+            'DURATION' => '?',
+            'REPEAT'   => '?',
+
+            'ATTACH' => '?'
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+module Tilia
+  module VObject
+    class Component
+      # The VAvailability component.
+      #
+      # This component adds functionality to a component, specific for VAVAILABILITY
+      # components.
+      class VAvailability < Component
+        # Returns true or false depending on if the event falls in the specified
+        # time-range. This is used for filtering purposes.
+        #
+        # The rules used to determine if an event falls within the specified
+        # time-range is based on:
+        #
+        # https://tools.ietf.org/html/draft-daboo-calendar-availability-05#section-3.1
+        #
+        # @param DateTimeInterface start
+        # @param DateTimeInterface ending
+        #
+        # @return bool
+        def in_time_range?(start, ending)
+          (effective_start, effective_end) = effective_start_end
+          (effective_start.nil? || start < effective_end) &&
+            (effective_end.nil? || ending > effective_start)
+        end
+
+        # Returns the 'effective start' and 'effective end' of this VAVAILABILITY
+        # component.
+        #
+        # We use the DTSTART and DTEND or DURATION to determine this.
+        #
+        # The returned value is an array containing DateTimeImmutable instances.
+        # If either the start or end is 'unbounded' its value will be null
+        # instead.
+        #
+        # @return array
+        def effective_start_end
+          effective_start = nil
+          effective_end = nil
+
+          effective_start = self['DTSTART'].date_time if key?('DTSTART')
+
+          if key?('DTEND')
+            effective_end = self['DTEND'].date_time
+          elsif effective_start && key?('DURATION')
+            effective_end = effective_start + Tilia::VObject::DateTimeParser.parse_duration(self['DURATION'])
+          end
+
+          [effective_start, effective_end]
+        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
+        def validation_rules
+          {
+            'UID'     => 1,
+            'DTSTAMP' => 1,
+
+            'BUSYTYPE'      => '?',
+            'CLASS'         => '?',
+            'CREATED'       => '?',
+            'DESCRIPTION'   => '?',
+            'DTSTART'       => '?',
+            'LAST-MODIFIED' => '?',
+            'ORGANIZER'     => '?',
+            'PRIORITY'      => '?',
+            'SEQUENCE'      => '?',
+            'SUMMARY'       => '?',
+            'URL'           => '?',
+            'DTEND'         => '?',
+            'DURATION'      => '?',
+
+            'CATEGORIES' => '*',
+            'COMMENT'    => '*',
+            'CONTACT'    => '*'
+          }
+        end
+
+        # Validates the node for correctness.
+        #
+        # The following options are supported:
+        #   Node::REPAIR - May attempt to automatically repair the problem.
+        #   Node::PROFILE_CARDDAV - Validate the vCard for CardDAV purposes.
+        #   Node::PROFILE_CALDAV - Validate the iCalendar for CalDAV purposes.
+        #
+        # 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 - A warning.
+        #   3 - An error.
+        #
+        # @param int options
+        #
+        # @return array
+        def validate(options = 0)
+          result = super(options)
+
+          if key?('DTEND') && key?('DURATION')
+            result << {
+              'level'   => 3,
+              'message' => 'DTEND and DURATION cannot both be present',
+              'node'    => self
+            }
+          end
+
+          result
+        end
+      end
+    end
+  end
+end