Applying Full Timezone Support ice-cube-ruby#335

Author: rbarrera87

ice_cube.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec', '~> 2.12.0')
   s.add_development_dependency('activesupport', '>= 3.0.0')
   s.add_development_dependency('tzinfo')
+  s.add_development_dependency('timecop')
 end

lib/ice_cube/builders/ical_builder.rb

@@ -32,15 +32,15 @@ def to_s
 
     def self.ical_utc_format(time)
       time = time.dup.utc
-      "#{time.strftime('%Y%m%dT%H%M%SZ')}" # utc time
+      IceCube::I18n.l(time, format: '%Y%m%dT%H%M%SZ') # utc time
     end
 
     def self.ical_format(time, force_utc)
-      time = time.dup.utc if force_utc
+      time = time.dup.utc if force_utc || !time.respond_to?('time_zone')
       if time.utc?
-        ":#{time.strftime('%Y%m%dT%H%M%SZ')}" # utc time
+        ":#{IceCube::I18n.l(time.utc, format: '%Y%m%dT%H%M%SZ')}" # utc time
       else
-        ";TZID=#{time.strftime('%Z:%Y%m%dT%H%M%S')}" # local time specified
+        ";TZID=#{time.time_zone.name}:#{IceCube::I18n.l(time, format: '%Y%m%dT%H%M%S')}" # local time specified
       end
     end
 

lib/ice_cube/parsers/ical_parser.rb

@@ -7,21 +7,32 @@ def self.schedule_from_ical(ical_string, options = {})
         (property, tzid) = property.split(';')
         case property
         when 'DTSTART'
-          data[:start_time] = Time.parse(value)
+          data[:start_time] = _parse_in_tzid(value, tzid)
         when 'DTEND'
-          data[:end_time] = Time.parse(value)
+          data[:end_time] = _parse_in_tzid(value, tzid)
         when 'EXDATE'
           data[:extimes] ||= []
-          data[:extimes] += value.split(',').map{|v| Time.parse(v)}
+          data[:extimes] += value.split(',').map do |v|
+            _parse_in_tzid(v, tzid)
+          end
         when 'DURATION'
           data[:duration] # FIXME
         when 'RRULE'
-          data[:rrules] = [rule_from_ical(value)]
+          data[:rrules] ||= []
+          data[:rrules] += [rule_from_ical(value)]
         end
       end
       Schedule.from_hash data
     end
 
+    def self._parse_in_tzid(value, tzid)
+      time_parser = Time
+      if tzid
+        time_parser = ActiveSupport::TimeZone.new(tzid.split('=')[1]) || Time
+      end
+      time_parser.parse(value)
+    end
+
     def self.rule_from_ical(ical)
       params = { validations: { } }
 

spec/examples/from_ical_spec.rb

@@ -94,15 +94,22 @@ module IceCube
 
   end
 
-  describe Schedule, 'from_ical' do
+  describe Schedule, 'from_ical', system_time_zone: "America/Chicago" do
 
     ical_string = <<-ICAL.gsub(/^\s*/, '')
   DTSTART:20130314T201500Z
   DTEND:20130314T201545Z
   RRULE:FREQ=WEEKLY;BYDAY=TH;UNTIL=20130531T100000Z
   ICAL
 
-    ical_string_woth_multiple_exdates = <<-ICAL.gsub(/^\s*/, '')
+  ical_string_with_time_zones = <<-ICAL.gsub(/^\s*/,'')
+  DTSTART;TZID=America/Denver:20130731T143000
+  DTEND:20130731T153000
+  RRULE:FREQ=WEEKLY
+  EXDATE;TZID=America/Chicago:20130823T143000
+  ICAL
+
+  ical_string_with_multiple_exdates = <<-ICAL.gsub(/^\s*/, '')
   DTSTART;TZID=America/Denver:20130731T143000
   DTEND;TZID=America/Denver:20130731T153000
   RRULE:FREQ=WEEKLY;UNTIL=20140730T203000Z;BYDAY=MO,WE,FR
@@ -111,6 +118,11 @@ module IceCube
   EXDATE;TZID=America/Denver:20130807T143000
   ICAL
 
+  ical_string_with_multiple_rules = <<-ICAL.gsub(/^\s*/, '' )
+  DTSTART;TZID=America/Denver:20151005T195541
+  RRULE:FREQ=WEEKLY;BYDAY=MO,TU
+  RRULE:FREQ=WEEKLY;INTERVAL=2;WKST=SU;BYDAY=FR
+    ICAL
 
     def sorted_ical(ical)
       ical.split(/\n/).sort.map { |field|
@@ -125,6 +137,43 @@ def sorted_ical(ical)
       it "loads an ICAL string" do
         expect(IceCube::Schedule.from_ical(ical_string)).to be_a(IceCube::Schedule)
       end
+
+      describe "parsing time zones" do
+        it "sets the time zone of the start time" do
+          schedule = IceCube::Schedule.from_ical(ical_string_with_time_zones)
+          expect(schedule.start_time.time_zone).to eq ActiveSupport::TimeZone.new("America/Denver")
+          expect(schedule.start_time.is_a?(Time)).to be true
+          expect(schedule.start_time.is_a?(ActiveSupport::TimeWithZone)).to be true
+        end
+
+        it "treats UTC as a Time rather than TimeWithZone" do
+          schedule = IceCube::Schedule.from_ical(ical_string)
+          expect(schedule.start_time.utc_offset).to eq 0
+          expect(schedule.start_time.is_a?(Time)).to be true
+          expect(schedule.start_time.is_a?(ActiveSupport::TimeWithZone)).to be false
+        end
+
+        it "uses the system time if a time zone is not explicity provided" do
+          schedule = IceCube::Schedule.from_ical(ical_string_with_time_zones)
+          expect(schedule.end_time).not_to respond_to :time_zone
+        end
+
+        it "sets the time zone of the exception times" do
+          schedule = IceCube::Schedule.from_ical(ical_string_with_time_zones)
+          expect(schedule.exception_times[0].time_zone).to eq ActiveSupport::TimeZone.new("America/Chicago")
+        end
+
+        it "adding the offset doesnt also change the time" do
+          schedule = IceCube::Schedule.from_ical(ical_string_with_time_zones)
+          expect(schedule.exception_times[0].hour).to eq 14
+        end
+
+        it "loads the ical DTSTART as output by IceCube to_ical method" do
+          now = Time.new(2016,5,9,12).in_time_zone("America/Los_Angeles")
+          schedule = IceCube::Schedule.from_ical(IceCube::Schedule.new(now).to_ical)
+          expect(schedule.start_time).to eq(now)
+        end
+      end
     end
 
     describe "daily frequency" do
@@ -235,7 +284,6 @@ def sorted_ical(ical)
     describe 'monthly frequency' do
       it 'matches simple monthly' do
         start_time = Time.now
-
         schedule = IceCube::Schedule.new(start_time)
         schedule.add_recurrence_rule(IceCube::Rule.monthly)
 
@@ -359,10 +407,17 @@ def sorted_ical(ical)
       end
 
       it 'handles multiple EXDATE lines' do
-        schedule = IceCube::Schedule.from_ical ical_string_woth_multiple_exdates
+        schedule = IceCube::Schedule.from_ical ical_string_with_multiple_exdates
         schedule.exception_times.count.should == 3
       end
     end
+
+    describe 'multiple rules' do
+      it 'handles multiple recurrence rules' do
+        schedule = IceCube::Schedule.from_ical ical_string_with_multiple_rules
+        schedule.recurrence_rules.count.should == 2
+      end
+    end
   end
 
 end

spec/examples/hourly_rule_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+re File.dirname(__FILE__) + '/../spec_helper'
 
 module IceCube
   describe HourlyRule do
@@ -39,13 +39,14 @@ module IceCube
       end
 
       it 'should not skip times in DST end hour' do
-        schedule = Schedule.new(t0 = Time.local(2013, 11, 3, 0, 0, 0))
+        tz = ActiveSupport::TimeZone["America/Vancouver"]
+        schedule = Schedule.new(t0 = tz.local(2013, 11, 3, 0, 0, 0))
         schedule.add_recurrence_rule Rule.hourly
-        schedule.first(4).should == [
-          Time.local(2013, 11, 3, 0, 0, 0),             # -0700
-          Time.local(2013, 11, 3, 1, 0, 0) - ONE_HOUR,  # -0700
-          Time.local(2013, 11, 3, 1, 0, 0),             # -0800
-          Time.local(2013, 11, 3, 2, 0, 0),             # -0800
+        expect(schedule.first(4)).to eq [
+          tz.local(2013, 11, 3, 0, 0, 0),             # -0700
+          tz.local(2013, 11, 3, 1, 0, 0),             # -0700
+          tz.local(2013, 11, 3, 2, 0, 0) - ONE_HOUR,  # -0800
+          tz.local(2013, 11, 3, 2, 0, 0),             # -0800
         ]
       end
 
@@ -55,7 +56,7 @@ module IceCube
       schedule = double(start_time: t0 = Time.now)
       rule = Rule.hourly(7)
       rule.interval(5)
-      rule.next_time(t0 + 1, schedule, nil).should == t0 + 5.hours
+      rule.next_time(t0 + 1, schedule, nil).should == t0 + 5 * ONE_HOUR
     end
 
     it 'should produce the correct days for @interval = 3' do