Merge pull request ice-cube-ruby#258 from wvengen/issues/50-from_ical-rebased

Issues/50 from ical, cleaned up

Author: seejohnrun

lib/ice_cube.rb

@@ -18,6 +18,7 @@ module IceCube
 
   autoload :HashParser, 'ice_cube/parsers/hash_parser'
   autoload :YamlParser, 'ice_cube/parsers/yaml_parser'
+  autoload :IcalParser, 'ice_cube/parsers/ical_parser'
 
   autoload :CountExceeded, 'ice_cube/errors/count_exceeded'
   autoload :UntilExceeded, 'ice_cube/errors/until_exceeded'

lib/ice_cube/parsers/hash_parser.rb

@@ -53,15 +53,19 @@ def apply_end_time(schedule, data)
     def apply_rrules(schedule, data)
       return unless data[:rrules]
       data[:rrules].each do |h|
-        schedule.rrule(IceCube::Rule.from_hash(h))
+        rrule = h.is_a?(IceCube::Rule) ? h : IceCube::Rule.from_hash(h)
+
+        schedule.rrule(rrule)
       end
     end
 
     def apply_exrules(schedule, data)
       return unless data[:exrules]
       warn "IceCube: :exrules is deprecated, and will be removed in a future release. at: #{ caller[0] }"
       data[:exrules].each do |h|
-        schedule.exrule(IceCube::Rule.from_hash(h))
+        rrule = h.is_a?(IceCube::Rule) ? h : IceCube::Rule.from_hash(h)
+
+        schedule.exrule(rrule)
       end
     end
 

lib/ice_cube/parsers/ical_parser.rb

@@ -0,0 +1,89 @@
+module IceCube
+  class IcalParser
+    def self.schedule_from_ical(ical_string, options = {})
+      data = {}
+      ical_string.each_line do |line|
+        (property, value) = line.split(':')
+        (property, tzid) = property.split(';')
+        case property
+        when 'DTSTART'
+          data[:start_time] = Time.parse(value)
+        when 'DTEND'
+          data[:end_time] = Time.parse(value)
+        when 'EXDATE'
+          data[:extimes] ||= []
+          data[:extimes] += value.split(',').map{|v| Time.parse(v)}
+        when 'DURATION'
+          data[:duration] # FIXME
+        when 'RRULE'
+          data[:rrules] = [rule_from_ical(value)]
+        end
+      end
+      Schedule.from_hash data
+    end
+
+    def self.rule_from_ical(ical)
+      params = { validations: { } }
+
+      ical.split(';').each do |rule|
+        (name, value) = rule.split('=')
+        value.strip!
+        case name
+        when 'FREQ'
+          params[:freq] = value.downcase
+        when 'INTERVAL'
+          params[:interval] = value.to_i
+        when 'COUNT'
+          params[:count] = value.to_i
+        when 'UNTIL'
+          params[:until] = Time.parse(value).utc
+        when 'WKST'
+          params[:wkst] = TimeUtil.ical_day_to_symbol(value)
+        when 'BYSECOND'
+          params[:validations][:second_of_minute] = value.split(',').collect{ |v| v.to_i }
+        when "BYMINUTE"
+          params[:validations][:minute_of_hour] = value.split(',').collect{ |v| v.to_i }
+        when "BYHOUR"
+          params[:validations][:hour_of_day] = value.split(',').collect{ |v| v.to_i }
+        when "BYDAY"
+          dows = {}
+          days = []
+          value.split(',').each do |expr|
+              day = TimeUtil.ical_day_to_symbol(expr.strip[-2..-1])
+              if expr.strip.length > 2  # day with occurence
+                occ = expr[0..-3].to_i
+                dows[day].nil? ? dows[day] = [occ] : dows[day].push(occ)
+                days.delete(TimeUtil.sym_to_wday(day))
+              else
+                days.push TimeUtil.sym_to_wday(day) if dows[day].nil?
+              end
+          end
+          params[:validations][:day_of_week] = dows unless dows.empty?
+          params[:validations][:day] = days unless days.empty?
+        when "BYMONTHDAY"
+          params[:validations][:day_of_month] = value.split(',').collect{ |v| v.to_i }
+        when "BYMONTH"
+          params[:validations][:month_of_year] = value.split(',').collect{ |v| v.to_i }
+        when "BYYEARDAY"
+          params[:validations][:day_of_year] = value.split(',').collect{ |v| v.to_i }
+        when "BYSETPOS"
+        else
+          raise "Invalid or unsupported rrule command : #{name}"
+        end
+      end
+
+      params[:interval] ||= 1
+      # WKST only valid for weekly rules
+      params.delete(:wkst) unless params[:freq] == 'weekly'
+
+      rule = Rule.send(*params.values_at(:freq, :interval, :wkst).compact)
+      rule.count(params[:count]) if params[:count]
+      rule.until(params[:until]) if params[:until]
+      params[:validations].each do |key, value|
+        value.is_a?(Array) ? rule.send(key, *value) : rule.send(key, value)
+      end
+
+      rule
+    end
+  end
+end

lib/ice_cube/rule.rb

@@ -27,6 +27,11 @@ def to_ical
       raise MethodNotImplemented, "Expected to be overrridden by subclasses"
     end
 
+    # Convert from ical string and create a rule
+    def self.from_ical(ical)
+      IceCube::IcalParser.rule_from_ical(ical)
+    end
+
     # Yaml implementation
     def to_yaml(*args)
       YAML::dump(to_hash, *args)

lib/ice_cube/schedule.rb

@@ -332,6 +332,11 @@ def to_ical(force_utc = false)
       pieces.join("\n")
     end
 
+    # Load the schedule from ical
+    def self.from_ical(ical, options = {})
+      IcalParser.schedule_from_ical(ical, options)
+    end
+
     # Convert the schedule to yaml
     def to_yaml(*args)
       YAML::dump(to_hash, *args)

lib/ice_cube/time_util.rb

@@ -11,6 +11,11 @@ module TimeUtil
       :thursday => 4, :friday => 5, :saturday => 6
     }
 
+    ICAL_DAYS = {
+      'SU' => :sunday, 'MO' => :monday, 'TU' => :tuesday, 'WE' => :wednesday,
+      'TH' => :thursday, 'FR' => :friday, 'SA' => :saturday
+    }
+
     MONTHS = {
       :january => 1, :february => 2, :march => 3, :april => 4, :may => 5,
       :june => 6, :july => 7, :august => 8, :september => 9, :october => 10,
@@ -147,12 +152,25 @@ def self.wday_to_sym(wday)
       end
     end
 
+    # Convert a symbol to an ical day (SU, MO)
+    def self.week_start(sym)
+      raise ArgumentError, "Invalid day: #{str}" unless DAYS.keys.include?(sym)
+      day = sym.to_s.upcase[0..1]
+      day
+    end
+
     # Convert weekday from base sunday to the schedule's week start.
     def self.normalize_wday(wday, week_start)
       (wday - sym_to_wday(week_start)) % 7
     end
     deprecated_alias :normalize_weekday, :normalize_wday
 
+    def self.ical_day_to_symbol(str)
+      day = ICAL_DAYS[str]
+      raise ArgumentError, "Invalid day: #{str}" if day.nil?
+      day
+    end
+
     # Return the count of the number of times wday appears in the month,
     # and which of those time falls on
     def self.which_occurrence_in_month(time, wday)

lib/ice_cube/validations/lock.rb

@@ -0,0 +1,95 @@
+module IceCube
+
+  # This validation mixin is used by the various "fixed-time" (e.g. day,
+  # day_of_month, hour_of_day) Validation and ScheduleLock::Validation modules.
+  # It is not a standalone rule validation like the others.
+  #
+  # Given the including Validation's defined +type+ field, it will lock
+  # to the specified +value+ or else the corresponding time unit from the
+  # schedule's start_time
+  #
+  module Validations::Lock
+
+    INTERVALS = {:min => 60, :sec => 60, :hour => 24, :month => 12, :wday => 7}
+
+    def validate(time, schedule)
+      case type
+      when :day  then validate_day_lock(time, schedule)
+      when :hour then validate_hour_lock(time, schedule)
+      else validate_interval_lock(time, schedule)
+      end
+    end
+
+    private
+
+    # Validate if the current time unit matches the same unit from the schedule
+    # start time, returning the difference to the interval
+    #
+    def validate_interval_lock(time, schedule)
+      t0 = starting_unit(schedule.start_time)
+      t1 = time.send(type)
+      t0 >= t1 ? t0 - t1 : INTERVALS[type] - t1 + t0
+    end
+
+    # Lock the hour if explicitly set by hour_of_day, but allow for the nearest
+    # hour during DST start to keep the correct interval.
+    #
+    def validate_hour_lock(time, schedule)
+      h0 = starting_unit(schedule.start_time)
+      h1 = time.hour
+      if h0 >= h1
+        h0 - h1
+      else
+        if dst_offset = TimeUtil.dst_change(time)
+          h0 - h1 + dst_offset
+        else
+          24 - h1 + h0
+        end
+      end
+    end
+
+    # For monthly rules that have no specified day value, the validation relies
+    # on the schedule start time and jumps to include every month even if it
+    # has fewer days than the schedule's start day.
+    #
+    # Negative day values (from month end) also include all months.
+    #
+    # Positive day values are taken literally so months with fewer days will
+    # be skipped.
+    #
+    def validate_day_lock(time, schedule)
+      days_in_month = TimeUtil.days_in_month(time)
+      date = Date.new(time.year, time.month, time.day)
+
+      if value && value < 0
+        start = TimeUtil.day_of_month(value, date)
+        month_overflow = days_in_month - TimeUtil.days_in_next_month(time)
+      elsif value && value > 0
+        start = value
+        month_overflow = 0
+      else
+        start = TimeUtil.day_of_month(schedule.start_time.day, date)
+        month_overflow = 0
+      end
+
+      sleeps = start - date.day
+
+      if value && value > 0
+        until_next_month = days_in_month + sleeps
+      else
+        until_next_month = start < 28 ? days_in_month : TimeUtil.days_to_next_month(date)
+        until_next_month += sleeps - month_overflow
+      end
+
+      sleeps >= 0 ? sleeps : until_next_month
+    end
+
+    def starting_unit(start_time)
+      start = value || start_time.send(type)
+      start += INTERVALS[type] while start < 0
+      start
+    end
+
+  end
+
+end