rrule 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dbf6e375db3049f9f5bac8ec82125959575cb69
-  data.tar.gz: 31f17de3e7eddd34657fe3b496c407fbbaa65b98
+  metadata.gz: a6c2ba5195c291cf1e8ef2fb970f4e1405466e88
+  data.tar.gz: 4f6e5cdf83c920ef0c1bb481726f30214948c876
 SHA512:
-  metadata.gz: 402fcac3f63d617d0f87a387bea46ee69d8f77682422992bfb456bc2bc9ddac95a011d4851091ff1c83a56df957aa45fc4e2ff3259d1ff59a3ea5d63341357d0
-  data.tar.gz: c73b5402e012f237351643e0e9f862dfcd68ef31d5807550a1749961660a257a82580b7d72569c22c2a6105fa9f1369c96e9440c0755bf77ee13d095425825e9
+  metadata.gz: ed30baabc688529bc1f4c5881dac96658e610d108d15ef0332aaf21aeae803d3368e7fc144e50af215f72e1b90ebb9f2727e8b7411e4b1c9deb5087a4229cf06
+  data.tar.gz: 88402450d02bcc6e87acd4a628f277f66766671b45dab25ada7892c991a9e58b7d1de78c514421dc66f71c136123a203e78f89d4903ffa1b191fc0f83527ec47

data/.gitignore

@@ -0,0 +1,4 @@
+.rspec
+*.gem
+*.sublime-project
+*.sublime-workspace

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Change Log
+==========
+
+Version 0.1.0 *(2017-06-06)*
+----------------------------
+
+Initial release.

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+Contributing
+============
+
+If you would like to contribute code to this project you can do so through GitHub by
+forking the repository and sending a pull request.
+
+When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible. Please also make
+sure your code compiles by running `mvn clean verify`. Checkstyle failures
+during compilation indicate errors in your style and can be viewed in the
+`checkstyle-result.xml` file.
+
+Before your code can be accepted into the project you must also sign the
+[Individual Contributor License Agreement (CLA)][1].
+
+
+ [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,71 @@
+# rrule
+
+## Description
+
+rrule is a minimalist library for expanding RRULEs, with a goal of being fully compliant with [iCalendar spec](https://tools.ietf.org/html/rfc2445).
+
+## Examples
+
+To install this gem, add it to your Gemfile:
+
+```ruby
+gem 'rrule'
+```
+
+Create an rrule with an RRULE string:
+
+```ruby
+rrule = RRule::Rule.new('FREQ=DAILY;COUNT=3')
+rrule = RRule.parse('FREQ=DAILY;COUNT=3') # alternate syntax
+```
+
+### Generating recurrence instances
+
+Either generate all instances of a recurrence, or generate instances in a range:
+
+```ruby
+rrule.all
+=> [2016-06-23 16:45:32 -0700, 2016-06-24 16:45:32 -0700, 2016-06-25 16:45:32 -0700]
+rrule.between(Time.new(2016, 6, 23), Time.new(2016, 6, 24))
+=> [2016-06-23 16:45:32 -0700]
+```
+
+By default the DTSTART of the recurrence is the current time, but this can be overriden with the `dtstart` option:
+
+```ruby
+rrule = RRule::Rule.new('FREQ=DAILY;COUNT=3', dtstart: Time.new(2016, 7, 1))
+rrule.all
+=> [2016-07-01 00:00:00 -0700, 2016-07-02 00:00:00 -0700, 2016-07-03 00:00:00 -0700]
+```
+
+Unless your rrule should be evaluated in UTC time, you should also pass an explicit timezone in the `tzid` option to ensure that daylight saving time boundaries are respected, etc.:
+
+```ruby
+rrule = RRule::Rule.new('FREQ=DAILY;COUNT=3', dtstart: Time.new(2016, 7, 1), tzid: 'America/Los_Angeles')
+```
+
+### Exceptions (EXDATEs)
+
+To define exception dates, pass the `exdate` option:
+
+```ruby
+rrule = RRule::Rule.new('FREQ=DAILY;COUNT=3', dtstart: Time.new(2016, 7, 1), exdate: [DateTime.parse('2016-07-02 00:00:00 -0700'])
+rrule.all
+=> [2016-07-01 00:00:00 -0700, 2016-07-03 00:00:00 -0700]
+```
+
+## License
+
+Copyright 2015 Square Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+require File.expand_path('../lib/rrule', __FILE__)
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  task :all => ['spec']
+end
+
+task :default => 'spec:all'
+# 
+# desc 'Builds the gem'
+# task :build do
+#   sh "gem build rrule.gemspec"
+# end
+#
+# desc 'Builds and installs the gem'
+# task :install => :build do
+#   sh "gem install rrule-#{RRule::VERSION}"
+# end
+#
+# desc 'Tags version, pushes to remote, and pushes gem'
+# task :release => :build do
+#   sh "git tag v#{RRule::VERSION}"
+#   sh "git push origin master"
+#   sh "git push origin v#{RRule::VERSION}"
+#   sh "gem push rrule-#{RRule::VERSION}.gem"
+# end

data/lib/rrule.rb

@@ -1,6 +1,28 @@
-class RRule
-  def initialize(rrule, dtstart)
-    @rrule = rrule
-    @dtstart = dtstart
+require 'active_support/all'
+
+module RRule
+  autoload :Rule, 'rrule/rule'
+  autoload :Context, 'rrule/context'
+  autoload :Weekday, 'rrule/weekday'
+
+  autoload :Frequency, 'rrule/frequencies/frequency'
+  autoload :Daily, 'rrule/frequencies/daily'
+  autoload :Weekly, 'rrule/frequencies/weekly'
+  autoload :Monthly, 'rrule/frequencies/monthly'
+  autoload :Yearly, 'rrule/frequencies/yearly'
+
+  autoload :ByMonth, 'rrule/filters/by_month'
+  autoload :ByWeekNumber, 'rrule/filters/by_week_number'
+  autoload :ByWeekDay, 'rrule/filters/by_week_day'
+  autoload :ByYearDay, 'rrule/filters/by_year_day'
+  autoload :ByMonthDay, 'rrule/filters/by_month_day'
+
+  autoload :AllOccurrences, 'rrule/generators/all_occurrences'
+  autoload :BySetPosition, 'rrule/generators/by_set_position'
+
+  def self.parse(rrule, options)
+    Rule.new(rrule, options)
   end
+
+  MAX_YEAR = 9999
 end

data/lib/rrule/context.rb

@@ -0,0 +1,137 @@
+module RRule
+  class Context
+    attr_reader :options, :dtstart, :tz, :day_of_year_mask, :year
+
+    def initialize(options, dtstart, tz)
+      @options = options
+      @dtstart = dtstart
+      @tz = tz
+    end
+
+    def rebuild(year, month)
+      @year = year
+
+      reset_year if year != last_year
+
+      if options[:bynweekday] && !options[:bynweekday].empty? && (month != last_month || year != last_year)
+        possible_date_ranges = []
+        if options[:freq] == 'YEARLY'
+          if options[:bymonth]
+            options[:bymonth].each do |month|
+              possible_date_ranges.push(elapsed_days_in_year_by_month[(month - 1)..(month)])
+            end
+          else
+            possible_date_ranges = [[0, year_length_in_days]]
+          end
+        elsif options[:freq] == 'MONTHLY'
+          possible_date_ranges = [elapsed_days_in_year_by_month[(month - 1)..(month)]]
+        end
+
+        unless possible_date_ranges.empty?
+          @day_of_year_mask = Array.new(year_length_in_days, false)
+
+          possible_date_ranges.each do |possible_date_range|
+            year_day_start = possible_date_range[0]
+            year_day_end = possible_date_range[1] - 1
+            options[:bynweekday].each do |weekday|
+              day_of_year = day_of_year_within_range(weekday, year_day_start, year_day_end)
+              day_of_year_mask[day_of_year] = true if day_of_year
+            end
+          end
+        end
+
+        @last_year = year
+        @last_month = month
+      end
+    end
+
+    def year_length_in_days
+      @year_length_in_days ||= leap_year? ? 366 : 365
+    end
+
+    def next_year_length_in_days
+      @next_year_length_in_days ||= Date.leap?(year + 1) ? 366 : 365
+    end
+
+    def first_day_of_year
+      @first_day_of_year ||= Date.new(year).beginning_of_year
+    end
+
+    def first_weekday_of_year
+      @first_weekday_of_year ||= first_day_of_year.wday
+    end
+
+    def month_by_day_of_year
+      @month_by_day_of_year ||= days_in_year.map(&:month)
+    end
+
+    def month_day_by_day_of_year
+      @month_day_by_day_of_year ||= days_in_year.map(&:day)
+    end
+
+    def negative_month_day_by_day_of_year
+      @negative_month_day_by_day_of_year ||= days_in_year.map { |day| day.day - day.end_of_month.day - 1 }
+    end
+
+    def weekday_by_day_of_year
+      @weekday_by_day_of_year ||= weekdays_in_year.drop(first_weekday_of_year)
+    end
+
+    def week_number_by_day_of_year
+      @week_number_by_day_of_year ||= days_in_year.map(&:cweek)
+    end
+
+    def negative_week_number_by_day_of_year
+      @negative_month_day_by_day_of_year ||= days_in_year.map { |day| day.cweek - Date.new(day.cwyear, 12, 28).cweek - 1 }
+    end
+
+    def elapsed_days_in_year_by_month
+      @elapsed_days_in_year_by_month ||= [0] + (1..12).map { |month| Date.new(year, month).end_of_month.yday }
+    end
+
+    private
+
+    attr_reader :last_month, :last_year
+
+    def weekdays_in_year
+      @weekdays_in_year ||= ((0..6).to_a * 54)
+    end
+
+    def leap_year?
+      Date.leap?(year)
+    end
+
+    def reset_year
+      @days_in_year = nil
+      @year_length_in_days = nil
+      @next_year_length_in_days = nil
+      @first_day_of_year = nil
+      @first_weekday_of_year = nil
+      @month_by_day_of_year = nil
+      @month_day_by_day_of_year = nil
+      @negative_month_day_by_day_of_year = nil
+      @weekday_by_day_of_year = nil
+      @week_number_by_day_of_year = nil
+      @negative_week_number_by_day_of_year = nil
+      @elapsed_days_in_year_by_month = nil
+    end
+
+    def days_in_year
+      @days_in_year ||= (first_day_of_year..first_day_of_year.end_of_year + 7.days)
+    end
+
+    def day_of_year_within_range(weekday, year_day_start, year_day_end)
+      wday = weekday.index
+      ordinal_weekday = weekday.ordinal
+      if ordinal_weekday < 0
+        day_of_year = year_day_end + (ordinal_weekday + 1) * 7
+        day_of_year -= (weekday_by_day_of_year[day_of_year] - wday) % 7
+      else
+        day_of_year = year_day_start + (ordinal_weekday - 1) * 7
+        day_of_year += (7 - weekday_by_day_of_year[day_of_year] + wday) % 7
+      end
+
+      day_of_year if year_day_start <= day_of_year && day_of_year <= year_day_end
+    end
+  end
+end