icalendar-recurrence 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd6d607af6031098dcd81c89886adb269c33cc75
+  data.tar.gz: 4e4958d4dcc5707113b7783693f19684350a4b58
+SHA512:
+  metadata.gz: 14fed0a81692c85a01a1fb71e004747fe4e2bc13811f40ee78ddbdfaf36bb94af14419e522b495eb3a07c578ec89e468e9d9de72efe6afe486dc1a0c4e735f20
+  data.tar.gz: 332faa2646e46d0fc995e3143a480eb1bb0932514adca086d0f5782804222432df461e954f7422ac8be27983658ca939aa7a5d4d657959dee6d50bc7762113da

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --format progress
-<%= "--format Nc" if RUBY_PLATFORM.match(/darwin/) %>

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# icalendar-recurrence CHANGELOG
+
+## 1.1.0 (July 8, 2015)
+
+- Add support for getting all occurrences (issue #7)
+  *Espen Antonsen (@espen)*
+- Delgate ical RRULE string parsing to IceCube (also, upgrade to 0.13.0)

data/icalendar-recurrence.gemspec

@@ -18,14 +18,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'icalendar', '~> 2.0'
-  spec.add_runtime_dependency 'ice_cube', '~> 0.11.1'
+  spec.add_runtime_dependency 'ice_cube', '~> 0.13.0'
 
+  spec.add_development_dependency 'activesupport', '~> 4.0.4'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2.8'
   spec.add_development_dependency 'rake', '~> 10.2.1'
   spec.add_development_dependency 'rspec', '~> 2.14.1'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'tzinfo', '~> 0.3'
   spec.add_development_dependency 'timecop', '~> 0.6.3'
-  spec.add_development_dependency 'guard-rspec', '~> 4.2.8'
-  spec.add_development_dependency 'activesupport', '~> 4.0.4'
-  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'tzinfo', '~> 0.3'
 end

data/lib/icalendar/recurrence/schedule.rb

@@ -40,6 +40,14 @@ module Icalendar
         end
       end
 
+      def all_occurrences
+        ice_cube_occurrences = ice_cube_schedule.all_occurrences
+
+        ice_cube_occurrences.map do |occurrence|
+          convert_ice_cube_occurrence(occurrence)
+        end
+      end
+
       def convert_ice_cube_occurrence(ice_cube_occurrence)
         if timezone
           begin
@@ -53,7 +61,7 @@ module Icalendar
 
         start_time ||= ice_cube_occurrence.start_time
         end_time ||= ice_cube_occurrence.end_time
-        
+
         Icalendar::Recurrence::Occurrence.new(start_time, end_time)
       end
 
@@ -63,7 +71,7 @@ module Icalendar
         schedule.end_time = end_time
 
         rrules.each do |rrule|
-          ice_cube_recurrence_rule = convert_rrule_to_ice_cube_recurrence_rule(rrule)
+          ice_cube_recurrence_rule = IceCube::Rule.from_ical(rrule.value_ical)
           schedule.add_recurrence_rule(ice_cube_recurrence_rule)
         end
 
@@ -74,88 +82,15 @@ module Icalendar
 
         schedule
       end
+    end
+    
+    def convert_duration_to_seconds(ical_duration)
+      return 0 unless ical_duration
 
-      def transform_byday_to_hash(byday_entries)
-        hashable_array = Array(byday_entries).map {|byday| convert_byday_to_ice_cube_day_of_week_hash(byday) }.flatten(1)
-        hash = Hash[*hashable_array]
-
-        if hash.values.include?([0]) # byday interval not specified (e.g., BYDAY=SA not BYDAY=1SA)
-          hash.keys
-        else
-          hash
-        end
-      end
-
-      # private
-
-
-      def convert_rrule_to_ice_cube_recurrence_rule(rrule)
-        ice_cube_recurrence_rule = base_ice_cube_recurrence_rule(rrule.frequency, rrule.interval)
-
-        ice_cube_recurrence_rule.tap do |r|
-          days = transform_byday_to_hash(rrule.by_day)
-
-          r.month_of_year(rrule.by_month) unless rrule.by_month.nil?
-          r.day_of_month(rrule.by_month_day.map(&:to_i)) unless rrule.by_month_day.nil?
-          r.day_of_week(days) if days.is_a?(Hash) and !days.empty?
-          r.day(days) if days.is_a?(Array) and !days.empty?
-          r.until(TimeUtil.to_time(rrule.until)) if rrule.until
-          r.count(rrule.count)
-        end
-
-        ice_cube_recurrence_rule
-      end
-
-      def base_ice_cube_recurrence_rule(frequency, interval)
-        interval ||= 1
-        if frequency == "DAILY"
-          IceCube::DailyRule.new(interval)
-        elsif frequency == "WEEKLY"
-          IceCube::WeeklyRule.new(interval)
-        elsif frequency == "MONTHLY"
-          IceCube::MonthlyRule.new(interval)
-        elsif frequency == "YEARLY"
-          IceCube::YearlyRule.new(interval)
-        else
-          raise "Unknown frequency: #{rrule.frequency}"
-        end
-      end
-
-      def convert_byday_to_ice_cube_day_of_week_hash(ical_byday)
-        data = parse_ical_byday(ical_byday)
-        day_code = data.fetch(:day_code)
-        position = data.fetch(:position)
-
-        day_symbol = case day_code.to_s
-        when "SU" then :sunday
-        when "MO" then :monday
-        when "TU" then :tuesday
-        when "WE" then :wednesday
-        when "TH" then :thursday
-        when "FR" then :friday
-        when "SA" then :saturday
-        else
-          raise ArgumentError.new "Unexpected ical_day: #{ical_day.inspect}"
-        end
-
-        [day_symbol, Array(position)]
-      end
-
-      # Parses ICAL BYDAY value to day and position array
-      # 1SA => {day_code: "SA", position: 1}
-      # MO  => {day_code: "MO", position: nil
-      def parse_ical_byday(ical_byday)
-        match = ical_byday.match(/(\d*)([A-Z]{2})/)
-        {day_code: match[2], position: match[1].to_i}
-      end
-
-      def convert_duration_to_seconds(ical_duration)
-        return 0 unless ical_duration
-
-        conversion_rates = { seconds: 1, minutes: 60, hours: 3600, days: 86400, weeks: 604800 }
-        seconds = conversion_rates.inject(0) { |sum, (unit, multiplier)| sum + ical_duration[unit] * multiplier }
-        seconds * (ical_duration.past ? -1 : 1)
-      end
+      conversion_rates = { seconds: 1, minutes: 60, hours: 3600, days: 86400, weeks: 604800 }
+      seconds = conversion_rates.inject(0) { |sum, (unit, multiplier)| sum + ical_duration[unit] * multiplier }
+      seconds * (ical_duration.past ? -1 : 1)
     end
+
   end
-end
+end

data/lib/icalendar/recurrence/time_util.rb

@@ -30,15 +30,15 @@ module Icalendar
         end
       end
 
-      # Calculates offset for given timezone ID (tzid). Optional, specify a 
+      # Calculates offset for given timezone ID (tzid). Optional, specify a
       # moment in time to calulcate this offset. If no moment is specified,
       # use the current time.
-      # 
+      #
       # # If done before daylight savings:
       # TimeUtil.timezone_offset("America/Los_Angeles") => -08:00
       # # Or after:
       # TimeUtil.timezone_offset("America/Los_Angeles", moment: Time.parse("2014-04-01")) => -07:00
-      # 
+      #
       def timezone_offset(tzid, options = {})
         tzid = Array(tzid).first
         options = {moment: Time.now}.merge(options)
@@ -64,7 +64,7 @@ module Icalendar
       end
 
       def supported_datetime_object?(time_object)
-        time_object.is_a?(Icalendar::Values::DateTime) 
+        time_object.is_a?(Icalendar::Values::DateTime)
       end
 
       def supported_time_object?(time_object)
@@ -72,7 +72,7 @@ module Icalendar
       end
 
       # Replaces the existing offset with one associated with given TZID. Does
-      # not change hour of day, only the offset. For example, if given a UTC 
+      # not change hour of day, only the offset. For example, if given a UTC
       # time of 8am, the returned time object will still be 8am but in another
       # timezone. See test for working examples.
       def force_zone(time, tzid)

data/lib/icalendar/recurrence/version.rb

@@ -1,5 +1,5 @@
 module Icalendar
   module Recurrence
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/spec/lib/schedule_spec.rb

@@ -1,20 +1,6 @@
 require 'spec_helper'
 
 describe Icalendar::Recurrence::Schedule do
-  describe "#transform_byday_to_hash" do
-    it "returns an array of days when no monthly interval is set" do
-      byday = ["MO", "WE", "FR"]
-      schedule = Schedule.new(nil)
-      expect(schedule.transform_byday_to_hash(byday)).to eq([:monday, :wednesday, :friday])
-    end
-
-    it "returns hash with day of week and interval" do
-      byday = ["1SA"]
-      schedule = Schedule.new(nil);
-      expect(schedule.transform_byday_to_hash(byday)).to eq({saturday: [1]})
-    end
-  end
-
   describe "#occurrences_between" do
     let(:example_occurrence) do
       daily_event = example_event :daily
@@ -40,13 +26,24 @@ describe Icalendar::Recurrence::Schedule do
       end
     end
   end
+  
+  describe "#all_occurrences" do
+    let(:example_occurrences) do
+      weekly_event = example_event :weekly_with_count
+      schedule = Schedule.new(weekly_event)
+      schedule.all_occurrences
+    end
 
-  describe "#parse_ical_byday" do
-    let(:schedule) { Schedule.new(nil) }
+    let(:example_occurrence) { example_occurrences.first }
 
-    it "returns a hash of data" do
-      expect(schedule.parse_ical_byday("1SA")).to eq({day_code: "SA", position: 1})
-      expect(schedule.parse_ical_byday("MO")).to eq({day_code: "MO", position: 0})
+    it "returns object that responds to start_time and end_time" do
+      expect(example_occurrence).to respond_to :start_time
+      expect(example_occurrence).to respond_to :end_time
+    end
+
+    it "returns all occurrences" do
+      expect(example_occurrences.count).to eq(151)
     end
   end
-end
+
+end

data/spec/lib/time_util_spec.rb

@@ -25,7 +25,7 @@ describe TimeUtil do
       pst_midnight =     Time.parse("2014-01-27T12:00:00-08:00")
 
       zoned_datetime = Icalendar::Values::DateTime.new(utc_midnight, "tzid" => "America/Los_Angeles")
-      
+
       expect(TimeUtil.to_time(zoned_datetime)).to eq(pst_midnight)
     end
 
@@ -59,7 +59,7 @@ describe TimeUtil do
     end
 
     it "returns nil when given an unknown timezone" do
-      expect(TimeUtil.timezone_offset("Foo/Bar")).to eq(nil)      
+      expect(TimeUtil.timezone_offset("Foo/Bar")).to eq(nil)
     end
 
     it "removes quotes from given TZID" do
@@ -81,8 +81,8 @@ describe TimeUtil do
 
     it "handles daylight savings" do
       # FYI, clocks turn forward an hour on Nov 2 at 9:00:00 UTC
-      minute_before_clocks_change = Time.parse("Nov 2 at 08:59:00 UTC") # on west coast
-      minute_after_clocks_change = Time.parse("Nov 2 at 09:01:00 UTC") # on west coast
+      minute_before_clocks_change = Time.parse("2014-11-02 at 08:59:00 UTC") # on west coast
+      minute_after_clocks_change  = Time.parse("2014-11-02 at 09:01:00 UTC") # on west coast
 
       expect(TimeUtil.timezone_offset("America/Los_Angeles", moment: minute_before_clocks_change)).to eq("-07:00")
       expect(TimeUtil.timezone_offset("America/Los_Angeles", moment: minute_after_clocks_change)).to eq("-08:00")
@@ -134,4 +134,4 @@ describe TimeUtil do
       expect(eight_am_local.utc?).to eq(false)
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,11 @@
 require 'support/helpers'
+
+# Support gems
+require 'awesome_print'
 require 'timecop'
+require 'pry'
 
+# Gem under test
 require 'icalendar/recurrence'
 
 include Icalendar::Recurrence

data/spec/support/fixtures/weekly_with_count_event.ics

@@ -0,0 +1,23 @@
+BEGIN:VCALENDAR
+X-WR-CALNAME:Test Public
+X-WR-CALID:f512e378-050c-4366-809a-ef471ce45b09:101165
+PRODID:Zimbra-Calendar-Provider
+VERSION:2.0
+METHOD:PUBLISH
+BEGIN:VEVENT
+UID:efcb99ae-d540-419c-91fa-42cc2bd9d302
+RRULE:FREQ=WEEKLY;INTERVAL=1;COUNT=151
+SUMMARY:Every week
+X-ALT-DESC;FMTTYPE=text/html:<html><body></body></html>
+ORGANIZER;CN=Jordan Raine:mailto:foo@sfu.ca
+DTSTART;VALUE=DATE:20140210
+STATUS:CONFIRMED
+CLASS:PUBLIC
+X-MICROSOFT-CDO-ALLDAYEVENT:TRUE
+X-MICROSOFT-CDO-INTENDEDSTATUS:FREE
+TRANSP:TRANSPARENT
+LAST-MODIFIED:20140113T200625Z
+DTSTAMP:20140113T200625Z
+SEQUENCE:0
+END:VEVENT
+END:VCALENDAR

metadata

@@ -1,176 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: icalendar-recurrence
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordan Raine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: icalendar
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: ice_cube
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.2.1
+        version: 4.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.2.1
+        version: 4.0.4
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: tzinfo
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 4.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 4.2.8
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 10.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 10.2.1
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.4
+        version: 0.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.4
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
+  name: tzinfo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 description: 
 email:
 - jnraine@gmail.com
@@ -178,9 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -212,31 +206,31 @@ files:
 - spec/support/fixtures/on_third_every_two_months_event.ics
 - spec/support/fixtures/one_day_a_month_for_three_months_event.ics
 - spec/support/fixtures/utc_event.ics
+- spec/support/fixtures/weekly_with_count_event.ics
 - spec/support/helpers.rb
 homepage: https://github.com/icalendar/icalendar-recurrence
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides recurrence to icalendar gem.
 test_files:
 - spec/lib/recurrence_spec.rb
@@ -257,4 +251,5 @@ test_files:
 - spec/support/fixtures/on_third_every_two_months_event.ics
 - spec/support/fixtures/one_day_a_month_for_three_months_event.ics
 - spec/support/fixtures/utc_event.ics
+- spec/support/fixtures/weekly_with_count_event.ics
 - spec/support/helpers.rb