icalendar-rrule 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bc3ceb9790452476e8f32de6f5c5f6f9780fb13f7fb667d002a76d8a0438774
+  data.tar.gz: a910d639df4e221adb306571005e3eb23a4f68753de363946cb8a6befb906080
+SHA512:
+  metadata.gz: 32f11de521b34a9caeda104a49cf428e9c9f3f23938e804c057a5f0a8371bffbb96eb8cbc9cbe5ed890c5813a0a3d5240994d72db175b86f2f18e2b5f8108896
+  data.tar.gz: 440e88786c1ed54ee3c090a709e0fd145d930147bfb00c62cd8d8b98fafda00a0680880727e68d0f2c13ba9845010d04718261eb924ac81e06c2efe6c96f5e75

data/.gitignore

@@ -0,0 +1,100 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+cmake-build-release/
+
+# Mongo Explorer plugin:
+.idea
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+/.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,45 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5.0
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Metrics/LineLength:
+  Max: 122
+
+Metrics/MethodLength:
+  Max: 16
+
+Naming/FileName:
+  Exclude:
+     - 'lib/icalendar-rrule.rb'
+     - 'lib/icalendar/schedulable-component.rb'
+     - 'lib/icalendar/scannable-calendar.rb'
+     - 'spec/icalendar/scannable-calendar_spec.rb'
+     - 'spec/icalendar/schedulable-component_spec.rb'
+
+
+
+Metrics/ModuleLength:
+   Enabled: false
+
+Style/DocumentationMethod:
+  Description: 'Public methods.'
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+
+
+
+# inherit_from: .rubocop_todo.yml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in icalendar-rrule.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    icalendar-rrule (0.1.5)
+      activesupport (~> 5.1)
+      icalendar (~> 2.4)
+      ice_cube (~> 0.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    icalendar (2.4.1)
+    ice_cube (0.16.2)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.25.1)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  icalendar-rrule!
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  rubocop (~> 0.55.0)
+  rubocop-rspec (~> 1.24)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Harald
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# icalendar-rrule
+This is an add-on to the [iCalendar Gem](https://github.com/icalendar/icalendar).
+It helps to handle calendars in iCalendar format with __repeating events__.
+
+According to the [RFC 5545](https://tools.ietf.org/html/rfc5545) specification, 
+repeating events are represented by one single entry, the repetitions being shown by
+an attached _repeat rule_. Thus when we iterate through a calendar with, for example,
+a daily repeating event, 
+we'll only see one single event where for a month there would be many more events in reality.
+
+The _icalendar-rrule gem_ patches an additional function called `scan` into the _iCalendar Gem_. 
+The _scan_ shows all events by unrolling the _repeat rule_ for a 
+given time period.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'icalendar-rrule'
+```
+
+and run `bundle install` from your shell.
+
+## Usage
+
+For explanations on how to parse and process RFC 5545 compatible calendars, please
+have a look at the [iCalendar gem](http://github.com/icalendar/icalendar).
+
+To use this gem we'll first have to require it: 
+
+`require 'icalendar-rrule'`
+
+Further we have to declare the use of the "Scannable" namespace. 
+This is called a "[Refinement](https://ruby-doc.org/core-2.5.0/doc/syntax/refinements_rdoc.html)"
+which is a _new Ruby core feature_ since Ruby 2.0.
+
+`using Icalendar::Scannable`
+
+Now we can inquire a calendar for all events (or tasks) within in a time span. 
+
+`scan = calendar.scan(begin_time, closing_time)`
+
+Here is a simple example:
+```ruby
+require 'icalendar-rrule' # this will require all needed GEMS including the icalendar gem
+
+using Icalendar::Scannable # this will make the function Icalendar::Calendar.scan available
+
+# we create a calendar with one single event
+calendar = Icalendar::Calendar.new
+calendar.event do |e|
+  # the event starts on January first and lasts from half past eight to five o' clock
+  e.dtstart     =  DateTime.civil(2018, 1, 1, 8, 30)
+  e.dtend       =  DateTime.civil(2018, 1, 1, 17, 00)
+  e.summary     = 'Working'
+  # the event repeats all working days
+  e.rrule       = 'FREQ=DAILY;BYDAY=MO,TU,WE,TH,FR'
+end
+
+begin_time =   Date.new(2018, 4, 22)
+closing_time = Date.new(2018, 4, 29)
+
+# we are interested in the calendar entries in the last week of April
+scan = calendar.scan(begin_time, closing_time) # that's where the magic happens
+
+
+scan.each do |occurrence|
+  puts "#{occurrence.start_time.strftime('%a. %b. %d. %k:%M')}-#{occurrence.end_time.strftime('%k:%M')}"
+end
+```
+This will produce:
+
+```
+Mon. Apr. 23.  8:30-17:00 
+Tue. Apr. 24.  8:30-17:00 
+Wed. Apr. 25.  8:30-17:00 
+Thu. Apr. 26.  8:30-17:00 
+Fri. Apr. 27.  8:30-17:00 
+```
+
+For a more elaborate example, please have a look at 
+<https://github.com/free-creations/sk_calendar>
+
+## Used Libraries
+
+- [iCalendar Gem](https://github.com/icalendar/icalendar).
+- [Ice cube](https://github.com/seejohnrun/ice_cube)
+- **Active Support:** see also 
+  [How to Load Core Extensions](http://edgeguides.rubyonrails.org/active_support_core_extensions.html#how-to-load-core-extensions)
+
+## Links
+- [Wikipedia](https://en.wikipedia.org/wiki/ICalendar) article explaining the _iCalendar_ format.
+- [RFC 5545](https://tools.ietf.org/html/rfc5545) Internet 
+  Calendaring and Scheduling Core Object Specification.
+- The Ruby [iCalendar gem](http://github.com/icalendar/icalendar) is used here as a base for 
+  handling ical data.
+- [RI_CAL](https://github.com/rubyredrick/ri_cal) is a project similar 
+  to this one that aims to 
+  "support important things like enumerating occurrences of repeating events".
+  A newer fork is available here: [kdgm/ri_cal](https://github.com/kdgm/ri_cal)
+- [The deceptively complex world of calendar events and RRULEs](https://www.nylas.com/blog/calendar-events-rrules/).
+  A Blog of Jennie Lees.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/free-creations/icalendar-rrule.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/icalendar-rrule.gemspec

@@ -0,0 +1,38 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# note: requiring the version file here, will make this file invisible to 'SimpleCov' the code coverage analysis tool.
+require 'icalendar/rrule/version'
+
+Gem::Specification.new do |gem_spec|
+  gem_spec.name          = 'icalendar-rrule'
+  gem_spec.version       = Icalendar::Rrule::VERSION
+  gem_spec.authors       = ['Harald Postner']
+  gem_spec.email         = ['harald@free-creations.de']
+
+  gem_spec.summary       = 'Use this module if you want to iterate over an ICalendars with recurring events. '
+  gem_spec.description   = 'This Gem adds a view to ICalendar class which expands ' \
+                       'all recurring events.'
+  gem_spec.homepage      = 'https://github.com/free-creations/icalendar-rrule'
+  gem_spec.license       = 'MIT'
+
+  gem_spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  gem_spec.bindir        = 'exe'
+  gem_spec.executables   = gem_spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  gem_spec.require_paths = ['lib']
+
+  gem_spec.add_dependency 'activesupport', '~> 5.1'
+  gem_spec.add_dependency 'icalendar', '~> 2.4'
+  gem_spec.add_dependency 'ice_cube', '~> 0.16'
+
+  gem_spec.add_development_dependency 'bundler', '~> 1.16'
+  gem_spec.add_development_dependency 'rake', '~> 10.0'
+  gem_spec.add_development_dependency 'rspec', '~> 3.7'
+  gem_spec.add_development_dependency 'rubocop', '~> 0.55.0'
+  gem_spec.add_development_dependency 'rubocop-rspec', '~> 1.24'
+  gem_spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/lib/icalendar-rrule.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'icalendar/rrule'

data/lib/icalendar/rrule.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'icalendar'
+require 'icalendar/schedulable-component.rb'
+require 'icalendar/scannable-calendar'
+
+require 'icalendar/rrule/version'
+require 'icalendar/rrule/occurrence'

data/lib/icalendar/rrule/occurrence.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Icalendar
+  module Rrule
+    ##
+    # An Occurrence represents the point of time where an event or any other component of an iCalendar happens.
+    #
+    # A component with a _repeat rule_ happens several times.
+    # Such a component is represented by a set of many __Occurrence instances__.
+    # All these occurrence instances refer to the same component called herein the __base_component__.
+    #
+    # The base_component can be one of the following:
+    #
+    # - Icalendar::Event
+    # - Icalendar::Todo
+    #
+    # furthermore it can also be one of the following:
+    #
+    # - Icalendar::Freebusy
+    # - Icalendar::Journal
+    #
+    # but these are not tested in the current version of this GEM.
+    #
+    # The Occurrence delegates reading of attributes to its underlying
+    # base_component.
+    # @example
+    #   occurrence_of_event.description                      #=> "Meeting with Mr. X"
+    #   occurrence_of_event.not_an_attribute                 #=> Error
+    #   occurrence_of_event.description = 'new description'  #=> Error
+    #
+    #
+    #
+    class Occurrence
+      include Comparable
+      using Icalendar::Schedulable
+
+      ##
+      # @return [Icalendar::Calendar] the calendar this occurrence is taken from.
+      attr_reader :base_calendar
+      ##
+      # @return [Icalendar::Component] the calendar-component (an event or a task) this occurrence refers to.
+      attr_reader :base_component
+      ##
+      # @return [ActiveSupport::TimeWithZone] the start of this occurrence.
+      attr_reader :start_time
+      ##
+      # @return [ActiveSupport::TimeWithZone] the end of this occurrence.
+      attr_reader :end_time
+      ##
+
+      ##
+      # Create a new Occurrence instance.
+      #
+      # @param [Icalendar::Calendar] base_calendar the calendar that holds the component.
+      # @param [Icalendar::Component] base_component the underlying calendar-component.
+      # @param [ActiveSupport::TimeWithZone] start_time the time when this occurrence starts.
+      #                   (might be different to the start time of the base_component)
+      # @param [ActiveSupport::TimeWithZone]  end_time the time when this occurrence starts.
+      #                    (might be different to the end time of the base_component)
+      #
+      def initialize(base_calendar, base_component, start_time, end_time)
+        raise ArgumentError, "'base_calendar' not of class 'Icalendar::Calendar'" unless
+            base_calendar.nil? || base_calendar.is_a?(Icalendar::Calendar)
+        raise ArgumentError, "'base_component' not of class 'Icalendar::Component'" unless
+            base_component.is_a?(Icalendar::Component)
+        raise ArgumentError, "'start_time' not of class 'ActiveSupport::TimeWithZone'" unless
+            start_time.is_a?(ActiveSupport::TimeWithZone)
+        raise ArgumentError, "'end_time' not of class 'ActiveSupport::TimeWithZone'" unless
+            end_time.is_a?(ActiveSupport::TimeWithZone)
+
+        @base_calendar  = base_calendar
+        @base_component = base_component
+        @start_time     = start_time
+        @end_time       = end_time
+
+        super()
+      end
+
+      ##
+      # Invoked by Ruby when the Occurrence-object is sent a message it cannot handle.
+      #
+      # Reading of attributes will be  delegated all to the _base component_.
+      #
+      # An attempt to set an attribute will result in an error.
+      #
+      # @param [String] method_name  the symbol for the method called
+      # @param [*object] arguments the arguments that were passed to the method.
+      # @param [] block the block that was passed to the method.
+      def method_missing(method_name, *arguments, &block)
+        if method_name.to_s[-1, 1] == '='
+          # do not allow for setter methods
+          super
+        else
+          # delegate all other requests to the base component
+          base_component.send(method_name, *arguments, &block)
+        end
+      end
+
+      ##
+      # @return [ActiveSupport::TimeZone] the timezone used in this component
+      def time_zone
+        base_component.component_timezone
+      end
+
+      ##
+      # Returns true if the Occurrence can respond to the given method, that is, the
+      # base component responds to the given method.
+      #
+      # @param [String] method_name  the symbol for the method called
+      # @param include_private
+      def respond_to_missing?(method_name, include_private = false)
+        if method_name.to_s[-1, 1] == '='
+          # do not allow to set attributes
+          super ## throws no method error
+        else
+          # delegate all read requests to the base component
+          base_component.respond_to?(method_name, include_private)
+        end
+      end
+
+      ##
+      # Compares this occurrence to the other.
+      # Comparison is on:
+      #
+      # 1. @start_time
+      # 2. @end_time
+      #
+      def <=>(other)
+        return nil unless other.respond_to? :start_time
+        return nil unless other.start_time.is_a?(ActiveSupport::TimeWithZone)
+        start_compare = @start_time <=> other.start_time
+        return start_compare unless start_compare.zero?
+
+        return 0 unless other.respond_to? :end_time
+        return 0 unless other.end_time.is_a?(ActiveSupport::TimeWithZone)
+        @end_time <=> other.end_time
+      end
+    end
+  end
+end

data/lib/icalendar/rrule/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Icalendar
+  module Rrule
+    VERSION = '0.1.5'
+  end
+end

data/lib/icalendar/scannable-calendar.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Icalendar
+  ##
+  # Refines the  Icalendar::Calendar class by adding
+  # the `scan` function to this class.
+  #
+  # @note [Refinement](https://ruby-doc.org/core-2.5.0/doc/syntax/refinements_rdoc.html)
+  # is a _Ruby core feature_ since Ruby 2.0
+  #
+  module Scannable
+    ##
+    # Provides _mixin_ methods for the
+    # Icalendar::Calendar class
+    refine Icalendar::Calendar do # rubocop:disable Metrics/BlockLength
+      using Icalendar::Schedulable
+      ##
+      # @param[date_time] begin_time
+      # @param[date_time] closing_time
+      # @param [Set] component_types a list of components that shall be retrieved these can be
+      # - :events
+      # - :todos
+      # Note: `:journals` and `:freebusys` are currently not tested.
+      #
+      # @return [Array] all occurrences between begin_time and closing_time
+      def scan(begin_time, closing_time, component_types = Set[:events])
+        component_types = component_types.to_set
+        result = []
+        component_types.each do |component_type|
+          result += _occurrences_between(_components(component_type), begin_time, closing_time)
+        end
+        result ||= [] # stop RubyMine to complain about uninitialized result.
+        result.sort!
+      end
+
+      private def _components(component_type)
+        # note: events(), todos(), journals(), freebusys() are attributes added
+        # to Icalendar::Calendar by meta-programming.
+        case component_type
+        when :events then events
+        when :todos then todos
+          # :nocov:
+        when :journals then journals
+        when :freebusys then freebusys
+          # :nocov:
+        else
+          raise ArgumentError, "Unknown Component type: `#{component_type}`."
+        end
+      end
+
+      private def _occurrences_between(components, begin_time, closing_time)
+        result = []
+        components.each do |comp|
+          occurrences = comp.schedule.occurrences_between(begin_time, closing_time)
+          occurrences.each do |oc|
+            new_oc = Icalendar::Rrule::Occurrence.new(self, comp, oc.start_time, oc.end_time)
+            result << new_oc
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/icalendar/schedulable-component.rb

@@ -0,0 +1,437 @@
+# frozen_string_literal: true
+
+require 'ice_cube'
+require 'active_support/time_with_zone'
+
+module Icalendar
+  ##
+  # Refines the  Icalendar::Component class by adding
+  # an interface between the IceCube Gem  and the the Icalendar::Component-class.
+  #
+  # __Note:__ _Refinement_  is a Ruby core feature since Ruby 2.0.
+  # @see: https://ruby-doc.org/core-2.5.0/doc/syntax/refinements_rdoc.html
+  #
+  # There are some shortcomings, the
+  # [documentation](http://ruby-doc.org/core-2.2.2/doc/syntax/refinements_rdoc.html#label-Indirect+Method+Calls)
+  # says:
+  #
+  # >When using indirect method access such as Kernel#send, Kernel#method or Kernel#respond_to?
+  # >refinements are not honored for the caller context during method lookup.
+  # >
+  # >This behavior may be changed in the future.
+  #
+  # The purpose of this module is:
+  #
+  # - normalise the handling of date and time by using ActiveSupport::TimeWithZone everywhere.
+  # - provide the methods *start_time* and *end_time* that always return something sensible, no matter
+  #   how these times were defined in the original component.
+  # - provide a schedule for repeating events created by the so called **rrule**.
+  #
+  #
+  module Schedulable
+    ##
+    # @!method start_time()
+    #   The time when the event or task shall start.
+    #   @return [ActiveSupport::TimeWithZone] a valid DateTime object
+    #
+    #
+    # @!method end_time()
+    #   The time when the event or task shall end.
+    #   @return [ActiveSupport::TimeWithZone] a valid DateTime object
+    #
+
+    # The start of the Unix Epoch (January 1, 1970 00:00 UTC).
+    NULL_TIME = 0
+
+    # the number of seconds in a minute
+    SEC_MIN  = 60
+    # the number of seconds in an hour
+    SEC_HOUR = 60 * SEC_MIN
+    # the number of seconds in a day
+    SEC_DAY  = 24 * SEC_HOUR
+    # the number of seconds in a week
+    SEC_WEEK = 7 * SEC_DAY
+    ##
+    # Provides _mixin_ methods for the
+    # Icalendar::Component class
+    refine Icalendar::Component do # rubocop:disable Metrics/BlockLength
+      ##
+      # Make sure, that we can always query for a _dtstart_ time.
+      # @return [Icalendar::Value, nil] a valid DateTime object or nil.
+      # @api private
+      private def _dtstart
+        dtstart
+      rescue StandardError
+        nil
+      end
+      ##
+      # Make sure, that we can always query for a _dtend_ time.
+      # @return [Icalendar::Value, nil] a valid DateTime object or nil.
+      # @api private
+      private def _dtend
+        dtend
+      rescue StandardError
+        nil
+      end
+      ##
+      # Make sure, that we can always query for a _due_ date.
+      # @return [Icalendar::Value, nil] a valid DateTime object or nil.
+      # @api private
+      private def _due
+        due
+      rescue StandardError
+        nil
+      end
+      ##
+      # Make sure, that we can always query for a _the duration value.
+      # @return [Icalendar::Values::Duration, nil] a valid Duration object or nil.
+      # @api private
+      def _duration
+        duration
+      rescue StandardError
+        nil
+      end
+
+      ##
+      # @return [Integer] the number of seconds this task will last.
+      #                   If no duration for this task is specified, this function returns zero.
+      # @api private
+      def _duration_seconds # rubocop:disable Metrics/AbcSize
+        return _guessed_duration unless _duration
+        d = _duration
+        return _guessed_duration unless d.is_a?(Icalendar::Values::Duration)
+        d.seconds + (d.minutes * SEC_MIN) + (d.hours * SEC_HOUR) + (d.days * SEC_DAY) + (d.weeks * SEC_WEEK)
+      end
+
+      ##
+      # Make an educated guess how long this event might last according to the following definition from RFC 5545:
+      #
+      #   > For cases where a "VEVENT" calendar component
+      #   > specifies a "DTSTART" property with a DATE value type but no
+      #   > "DTEND" nor "DURATION" property, the event's duration is taken to
+      #   >  be one day.
+      #
+      # @return [Integer] the number of seconds this task might last.
+      # @api private
+      def _guessed_duration
+        if _dtstart.is_a?(Icalendar::Values::Date) && _dtend.nil? && _duration.nil? && _due.nil?
+          SEC_DAY
+        else
+          0
+        end
+      end
+
+      ##
+      # The time when the event or task shall start.
+      # @return [ActiveSupport::TimeWithZone] a valid DateTime object
+      def start_time
+        if _dtstart
+          _to_time_with_zone(_dtstart)
+        elsif _due
+          _to_time_with_zone(_due.to_i - _duration_seconds)
+        else
+          _to_time_with_zone(NULL_TIME)
+        end
+      end
+
+      ##
+      # The time when the event or task shall end.
+      # @return [ActiveSupport::TimeWithZone] a valid DateTime object
+      def end_time # rubocop:disable Metrics/AbcSize
+        if _due
+          _to_time_with_zone(_due)
+        elsif _dtend
+          _to_time_with_zone(_dtend)
+        elsif _dtstart
+          _to_time_with_zone(_dtstart.to_i + _duration_seconds)
+        else
+          _to_time_with_zone(NULL_TIME + _duration_seconds)
+        end
+      end
+
+      ##
+      # Heuristic to determine whether the event is scheduled
+      # for a date without precising the exact time of day.
+      # @return [Boolean] true if the component is scheduled for a date, false otherwise.
+      def all_day?
+        _dtstart.is_a?(Icalendar::Values::Date) ||
+          (start_time == start_time.beginning_of_day && end_time == end_time.beginning_of_day)
+      end
+
+      ##
+      # @return [Boolean] true if the duration of the event spans more than one day.
+      def multi_day?
+        start_time.next_day.beginning_of_day < end_time
+      end
+
+      ##
+      # Make sure, that we can always query for a _rrule_ array.
+      # @return [array] an array of _ical repeat-rules_ (or an empty array
+      #                if no repeat-rules are defined for this component).
+      # @api private
+      def _rrules
+        Array(rrule).flatten.map(&:value_ical)
+      rescue StandardError
+        []
+      end
+
+      ##
+      # Make sure, that we can always query for an _exdate_ array.
+      # @return [array<ActiveSupport::TimeWithZone>] an array of _ical exdates_ (or an empty array
+      #                if no repeat-rules are defined for this component).
+      # @api private
+      def _exdates
+        Array(exdate).flatten
+      rescue StandardError
+        []
+      end
+
+      ##
+      # Make sure, that we can always query for the Recurrence ID.
+      #
+      # From RFC 5545:
+      #
+      # ```
+      #   3.8.4.4.  Recurrence ID
+      #
+      #   This property is used in conjunction with the "UID" and
+      #       "SEQUENCE" properties to identify a specific instance of a
+      #       recurring "VEVENT", "VTODO", or "VJOURNAL" calendar component.
+      #
+      # ```
+      #
+      # @return [ActiveSupport::TimeWithZone] the original value of the "DTSTART" property
+      #       of the recurrence instance.
+      # @api private
+      def _recurrence_id
+        recurrence_id
+      rescue StandardError
+        nil
+      end
+
+      ##
+      # Is this component a replacement for a certain repeat- occurrence.
+      # @return [Boolean] true if this component replaces a repeat- occurrence.
+      # @api private
+      def _is_substitute?
+        !_recurrence_id.nil?
+      end
+
+      ##
+      # @return [Array<Icalendar::Component>] the container that holds this component.
+      # @api private
+      def _parent_set
+        return [] unless respond_to?(:parent)
+        return [] unless parent.is_a?(Icalendar::Calendar)
+
+        case self
+        when Icalendar::Event then parent.events
+        when Icalendar::Todo then parent.todos
+        when Icalendar::Journal then parent.journals
+        else
+          []
+        end
+      end
+
+      ##
+      # Like the for _exdates, also for these dates do not schedule recurrence items.
+      #
+      # @return [array<ActiveSupport::TimeWithZone>] an array of dates.
+      # @api private
+      def _overwritten_dates
+        result = []
+        _parent_set.each do |event|
+          next unless uid == event.uid
+          next unless event._is_substitute?
+          next if _recurrence_id == event._recurrence_id # do not add myself
+          result << event._recurrence_id
+        end
+        result
+      end
+
+      ##
+      # Make sure, that we can always query for an rdate(Recurrence Date) array.
+      # @return [array] an array of _ical rdates_ (or an empty array
+      #                if no repeat-rules are defined for this component).
+      # @api private
+      def _rdates
+        Array(rdate).flatten
+      rescue StandardError
+        []
+      end
+
+      ##
+      # Creates a schedule for this event
+      # @return [IceCube::Schedule]
+      def schedule # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        schedule = IceCube::Schedule.new
+        schedule.start_time = start_time
+        schedule.end_time = end_time
+        _rrules.each do |rrule|
+          ice_cube_recurrence_rule = IceCube::Rule.from_ical(rrule)
+          schedule.add_recurrence_rule(ice_cube_recurrence_rule)
+        end
+
+        _exdates.each do |time|
+          schedule.add_exception_time(_to_time_with_zone(time))
+        end
+
+        _overwritten_dates.each do |time|
+          schedule.add_exception_time(_to_time_with_zone(time))
+        end
+
+        rdates = _rdates
+        rdates.each do |time|
+          schedule.add_recurrence_time(_to_time_with_zone(time))
+        end
+        schedule
+      end
+
+      ##
+      # Transform the given object into an object of type `ActiveSupport::TimeWithZone`.
+      #
+      # Further, try to make sure, that all time-objects of this component are defined in the same timezone.
+      #
+      # @param [Object] date_time an object that represents a time.
+      # @param [ActiveSupport::TimeZone] timezone the timezone to be used. If nil, the timezone will be guessed.
+      # @return [ActiveSupport::TimeWithZone] if the given object satisfies all conditions it is returned unchanged.
+      #                                     Otherwise the method attempts to "correct" the given Object.
+      #
+      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      def _to_time_with_zone(date_time, timezone = nil)
+        timezone ||= component_timezone
+
+        # For Icalendar::Values::DateTime, we can extract the ical value. Which probably is already what we want.
+        date_time_value = if date_time.is_a?(Icalendar::Values::DateTime)
+                            date_time.value
+                          else
+                            date_time
+                          end
+
+        if date_time_value.is_a?(ActiveSupport::TimeWithZone)
+          # the class is correct
+          #  if the timezone is also correct, we'll give back the input object.
+          return date_time_value if date_time_value.time_zone == timezone
+
+          # convert to the requested timezone and return it.
+          return date_time_value.in_time_zone(timezone)
+
+        elsif date_time_value.is_a?(DateTime)
+          return date_time_value.in_time_zone(timezone)
+
+        elsif date_time_value.is_a?(Icalendar::Values::Date)
+          return _date_to_time_with_zone(date_time_value, timezone)
+
+        elsif date_time_value.is_a?(Date)
+          return _date_to_time_with_zone(date_time_value, timezone)
+
+        elsif date_time_value.respond_to?(:to_time)
+          return timezone.at(date_time_value.to_time)
+
+        elsif date_time_value.respond_to?(:to_i)
+          # lets interpret the given value as the number of seconds since the Epoch (January 1, 1970 00:00 UTC).
+          return timezone.at(date_time_value.to_i)
+
+        end
+        # Oops, the given object is unusable, we'll give back the NULL_DATE
+        timezone.at(NULL_TIME)
+      end
+      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+
+      ##
+      # Convert a date into the corresponding TimeWithZone value.
+      # @param [#to_date] date a calendar date.
+      # @param [ActiveSupport::TimeZone] timezone the timezone to be used.
+      # @return [ActiveSupport::TimeWithZone] mid-night in the given timezone at the given date.
+      def _date_to_time_with_zone(date, timezone)
+        d = date.to_date
+        timezone.local(d.year, d.month, d.day)
+      end
+
+      ##
+      # Heuristic to determine the best timezone that shall be used in this component.
+      # @return [ActiveSupport::TimeZone] the unique timezone used in this component
+      def component_timezone
+        # let's try sequentially, the first non-nil wins.
+        timezone ||= _extract_timezone(_dtend)
+        timezone ||= _extract_timezone(_dtstart)
+        timezone ||= _extract_timezone(_due)
+        timezone ||= _extract_calendar_timezone
+
+        # as a last resort we'll use the Coordinated Universal Time (UTC).
+        timezone || ActiveSupport::TimeZone['UTC']
+      end
+
+      ##
+      # Try to determine this components time zone by inspecting the parents calendar.
+      # @return[ActiveSupport::TimeZone, nil] the first valid timezone found in the
+      #    parent calender or nil if none could be found.
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def _extract_calendar_timezone
+        return nil unless parent
+        return nil unless parent.is_a?(Icalendar::Calendar)
+        calendar_timezones = parent.timezones
+        calendar_timezones.each do |tz|
+          break unless tz.valid?(true)
+          ugly_tzid = tz.tzid
+          break unless ugly_tzid
+          tzid = Array(ugly_tzid).first.to_s.gsub(/^(["'])|(["'])$/, '')
+          tz_found = ActiveSupport::TimeZone[tzid]
+          return tz_found if tz_found
+        end
+        nil
+      rescue StandardError
+        nil
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      ##
+      # Get the timezone from the given object trying different methods to find an indication in the object.
+      # @param [Object] date_time an object from which we shall determine the time zone.
+      # @return [ActiveSupport::TimeZone, nil] the timezone used by the parameter or nil if no timezone has been set.
+      # @api private
+      def _extract_timezone(date_time)
+        timezone ||= _extract_ical_time_zone(date_time) # try with ical parameter
+        timezone ||= _extract_act_sup_timezone(date_time) # is the given value already ActiveSupport::TimeWithZone?
+        timezone || _extract_value_time_zone(date_time) # is the ical.value of type ActiveSupport::TimeWithZone?
+      end
+
+      ##
+      # Get the timezone from the given object, assuming it is an ActiveSupport::TimeWithZone.
+      # @param [Object] date_time an object from which we shall determine the time zone.
+      # @return [ActiveSupport::TimeZone, nil] the timezone or nil if the operation could not be performed.
+      # @api private
+      def _extract_act_sup_timezone(date_time)
+        return nil unless date_time.is_a?(ActiveSupport::TimeWithZone)
+        date_time.time_zone
+      end
+
+      ##
+      # Get the timezone from the given object, assuming it can be extracted from `ical_value.value.time_zone`
+      # @param [Object] ical_value an object from which we shall determine the time zone.
+      # @return [ActiveSupport::TimeZone, nil] the timezone used by the parameter
+      #                                  or nil if the operation could not be performed.
+      # @api private
+      def _extract_value_time_zone(ical_value)
+        return nil unless ical_value.is_a?(Icalendar::Value)
+        return nil unless ical_value.value.is_a?(ActiveSupport::TimeWithZone)
+        ical_value.value.time_zone
+      end
+
+      ##
+      # Get the timezone from the given object, assuming it can be extracted from ical params.
+      # @param [Icalendar::Value] ical_value an ical value that (probably) supports a time zone identifier.
+      # @return [ActiveSupport::TimeZone, nil] the timezone referred to by the ical_value or nil.
+      # @api private
+      def _extract_ical_time_zone(ical_value)
+        return nil unless ical_value.is_a?(Icalendar::Value)
+        return nil unless ical_value.respond_to?(:ical_params)
+        ugly_tzid = ical_value.ical_params.fetch('tzid', nil)
+        return nil if ugly_tzid.nil?
+        tzid = Array(ugly_tzid).first.to_s.gsub(/^(["'])|(["'])$/, '')
+        ActiveSupport::TimeZone[tzid]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: icalendar-rrule
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Harald Postner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: This Gem adds a view to ICalendar class which expands all recurring events.
+email:
+- harald@free-creations.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- icalendar-rrule.gemspec
+- lib/icalendar-rrule.rb
+- lib/icalendar/rrule.rb
+- lib/icalendar/rrule/occurrence.rb
+- lib/icalendar/rrule/version.rb
+- lib/icalendar/scannable-calendar.rb
+- lib/icalendar/schedulable-component.rb
+homepage: https://github.com/free-creations/icalendar-rrule
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Use this module if you want to iterate over an ICalendars with recurring
+  events.
+test_files: []