rrule 0.4.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1aad8dd06524a47f1d310b7f077db21f41696bc7
-  data.tar.gz: f2e1673c1fd07da16c47fc96e944eeabef43578b
+SHA256:
+  metadata.gz: '007499934626da51ca670d58c30fab5efe4f88c782979eaff317f440e8f237fc'
+  data.tar.gz: a99135de58a44d1c71a2af4fee8721475f09c44cfd40ab21410c7cb755835784
 SHA512:
-  metadata.gz: fa77f6132a2d47a45d8aab0a58af68a1ccd0417e22a9c2fc6ef4a2b14aef90e65040324177893773cba2b06e74373776105a19e078c5d81360f5e894b2cdec3c
-  data.tar.gz: 4fddc6b136db1d57c8d8e89fe099820e572f13fc447647cdd7c43942a74112255c8720ad2b8c82a0cb1586a8a1bdb0e862ec12014f6f05c5982a86ce58207518
+  metadata.gz: b2f9bc5d989d05bebf09aafac0ded5fd2148901481b15fce0b4ea60680cb26fefe4f6bfebe286473a02f25543e8be499b842020988da87226d6da3eaf847070f
+  data.tar.gz: 5b450cdde1f0b8c7a6c05a0520ecfdcb43e93647e2155a0fc2dc1578f7fdf4457c42a638fe31fadfd8bd31a1fc006169dab6847a03fa2552c530283c91f78870

data/.gitignore

@@ -1,4 +1,7 @@
+Gemfile.lock
 .rspec
 *.gem
 *.sublime-project
 *.sublime-workspace
+.ruby-version
+gemfiles/*.lock

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'gemfiles/**/*'
+    - Appraisals
+
+Layout:
+  Enabled: false
+
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,3 +1,29 @@
 language: ruby
+sudo: false
 rvm:
-  - 2.3.1
+  - 2.6.5
+  - 2.7.0
+  - 3.0.0
+
+gemfile:
+  - gemfiles/activesupport_2.3_LTS.gemfile
+  - gemfiles/activesupport_3.gemfile
+  - gemfiles/activesupport_4.gemfile
+  - gemfiles/activesupport_5.gemfile
+  - gemfiles/activesupport_6.gemfile
+  - gemfiles/activesupport_7.gemfile
+
+jobs:
+  exclude:
+  - rvm: 2.7.0
+    gemfile: gemfiles/activesupport_3.gemfile
+  - rvm: 2.7.0
+    gemfile: gemfiles/activesupport_4.gemfile
+  - rvm: 3.0.0
+    gemfile: gemfiles/activesupport_3.gemfile
+  - rvm: 3.0.0
+    gemfile: gemfiles/activesupport_4.gemfile
+
+before_install:
+  - yes | gem update --system --force
+  - gem install bundler

data/Appraisals

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+appraise 'activesupport-2.3-LTS' do
+  gem 'rexml'
+  gem 'activesupport', '>= 2', git: 'https://github.com/makandra/rails.git', branch: '2-3-lts'
+end
+
+appraise 'activesupport-3' do
+  gem 'activesupport', '~> 3'
+  gem 'tzinfo', '~> 1.2'
+end
+
+appraise 'activesupport-4' do
+  gem 'activesupport', '~> 4'
+end
+
+appraise 'activesupport-5' do
+  gem 'activesupport', '~> 5'
+end
+
+appraise 'activesupport-6' do
+  gem 'activesupport', '~> 6'
+end
+
+appraise 'activesupport-7' do
+  gem 'activesupport', '~> 7'
+end

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 Change Log
 ==========
 
+Version 0.4.4 *(2022-03-01)*
+----------------------------
+Remove constraint on ActiveSupport version
+
+Version 0.4.3 *(2021-08-10)*
+----------------------------
+Adding support for multiple versions of ActiveSupport, up until at least ActiveSupport 6
+Handle case where DTSTART is a date
+Several bugfixes (fix weekday ordinal matching, BYDAY calculations with and without ordinals)
+
+Version 0.4.2 *(2019-02-05)*
+----------------------------
+Truncate the floor_date option if it's less than the dtstart option
+
 Version 0.4.1 *(2018-11-28)*
 ----------------------------
 Fix bug in SimpleWeekly when ENV['TZ'] was not equal to time zone of rrule

data/Gemfile

@@ -1,5 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+gem 'pry', '~> 0.12.2'
 gem 'rake'
+gem 'rspec', '~> 3.8'
+gem 'rubocop', '0.63.1'
+
+platform :mri do
+  gem 'pry-byebug'
+end
 
 gemspec

data/Rakefile

@@ -1,12 +1,18 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rake'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require File.expand_path('../lib/rrule', __FILE__)
+require File.expand_path('lib/rrule', __dir__)
 
 RSpec::Core::RakeTask.new(:spec)
 
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
 namespace :spec do
-  task :all => ['spec']
+  task all: ['spec']
 end
 
-task :default => 'spec:all'
+task default: %w[spec:all rubocop]

data/gemfiles/activesupport_2.3_LTS.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry", "~> 0.12.2"
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "0.63.1"
+gem "rexml"
+gem "activesupport", ">= 2", git: "https://github.com/makandra/rails.git", branch: "2-3-lts"
+
+platforms :mri do
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activesupport_3.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry", "~> 0.12.2"
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "0.63.1"
+gem "activesupport", "~> 3"
+gem "tzinfo", "~> 1.2"
+
+platforms :mri do
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activesupport_4.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry", "~> 0.12.2"
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "0.63.1"
+gem "activesupport", "~> 4"
+
+platforms :mri do
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activesupport_5.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry", "~> 0.12.2"
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "0.63.1"
+gem "activesupport", "~> 5"
+
+platforms :mri do
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activesupport_6.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry", "~> 0.12.2"
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "0.63.1"
+gem "activesupport", "~> 6"
+
+platforms :mri do
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activesupport_7.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pry", "~> 0.12.2"
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "0.63.1"
+gem "activesupport", "~> 7"
+
+platforms :mri do
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/lib/rrule/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Context
     attr_reader :options, :dtstart, :tz, :day_of_year_mask, :year
@@ -17,14 +19,14 @@ module RRule
         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)])
+            options[:bymonth].each do |mon|
+              possible_date_ranges.push(elapsed_days_in_year_by_month[(mon - 1)..mon])
             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)]]
+          possible_date_ranges = [elapsed_days_in_year_by_month[(month - 1)..month]]
         end
 
         unless possible_date_ranges.empty?

data/lib/rrule/filters/by_month.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class ByMonth
     def initialize(by_months, context)

data/lib/rrule/filters/by_month_day.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class ByMonthDay
     def initialize(by_month_days, context)

data/lib/rrule/filters/by_week_day.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class ByWeekDay
     def initialize(weekdays, context)
@@ -6,17 +8,17 @@ module RRule
     end
 
     def reject?(i)
-      masked?(i) || !matches_by_week_days?(i)
+      masked?(i) && !matches_by_week_days?(i)
     end
 
     private
 
     def masked?(i)
-      context.day_of_year_mask && !context.day_of_year_mask[i]
+      context.day_of_year_mask.blank? || !context.day_of_year_mask[i]
     end
 
     def matches_by_week_days?(i)
-      by_week_days.empty? || by_week_days.include?(context.weekday_by_day_of_year[i])
+      by_week_days.present? && by_week_days.include?(context.weekday_by_day_of_year[i])
     end
 
     attr_reader :by_week_days, :context

data/lib/rrule/filters/by_week_number.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class ByWeekNumber
     def initialize(by_week_numbers, context)

data/lib/rrule/filters/by_year_day.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class ByYearDay
     def initialize(by_year_days, context)
@@ -6,7 +8,7 @@ module RRule
     end
 
     def reject?(i)
-      !by_year_days.empty? && 
+      !by_year_days.empty? &&
         ((i < context.year_length_in_days && !by_year_days.include?(i + 1) && !by_year_days.include?(i - context.year_length_in_days)) ||
           (i >= context.year_length_in_days && !by_year_days.include?(i + 1 - context.year_length_in_days) && !by_year_days.include?(i - context.year_length_in_days - context.next_year_length_in_days)))
     end

data/lib/rrule/frequencies/daily.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Daily < Frequency
     def possible_days

data/lib/rrule/frequencies/frequency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Frequency
     attr_reader :current_date, :filters, :generator, :timeset
@@ -12,9 +14,7 @@ module RRule
 
     def advance
       @current_date = current_date.advance(advance_by).tap do |new_date|
-        unless same_month(current_date, new_date)
-          context.rebuild(new_date.year, new_date.month)
-        end
+        context.rebuild(new_date.year, new_date.month) unless same_month(current_date, new_date)
       end
     end
 
@@ -32,10 +32,6 @@ module RRule
       end
     end
 
-    def possible_days
-      fail NotImplementedError
-    end
-
     def self.for_options(options)
       case options[:freq]
       when 'DAILY'
@@ -51,7 +47,7 @@ module RRule
       when 'YEARLY'
         Yearly
       else
-        raise InvalidRRule, "Valid FREQ value is required"
+        raise InvalidRRule, 'Valid FREQ value is required'
       end
     end
 
@@ -62,9 +58,5 @@ module RRule
     def same_month(first_date, second_date)
       first_date.month == second_date.month && first_date.year == second_date.year
     end
-
-    def advance_by
-      fail NotImplementedError
-    end
   end
 end

data/lib/rrule/frequencies/monthly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Monthly < Frequency
     def possible_days

data/lib/rrule/frequencies/simple_weekly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class SimpleWeekly < Frequency
     def next_occurrences
@@ -8,15 +10,13 @@ module RRule
     end
 
     def correct_current_date_if_needed
-      if context.options[:byweekday].present?
-        target_wday = context.options[:byweekday].first.index
+      target_wday = if context.options[:byweekday].present?
+        context.options[:byweekday].first.index
       else
-        target_wday = context.dtstart.wday
+        context.dtstart.wday
       end
 
-      while @current_date.wday != target_wday
-        @current_date = @current_date + 1.day
-      end
+      @current_date += 1.day while @current_date.wday != target_wday
     end
   end
 end

data/lib/rrule/frequencies/weekly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Weekly < Frequency
     def possible_days

data/lib/rrule/frequencies/yearly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Yearly < Frequency
     def possible_days

data/lib/rrule/generators/all_occurrences.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class AllOccurrences < Generator
     def combine_dates_and_times(dayset, timeset)

data/lib/rrule/generators/by_set_position.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class BySetPosition < Generator
     attr_reader :by_set_positions

data/lib/rrule/generators/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Generator
     attr_reader :context
@@ -7,6 +9,8 @@ module RRule
     end
 
     def process_timeset(date, timeset)
+      return [date] if timeset.blank?
+
       timeset.map do |time|
         hour_sets = (
           Array.wrap(time[:hour]).sort.map do |hour|
@@ -31,4 +35,4 @@ module RRule
       end.flatten
     end
   end
-end
+end

data/lib/rrule/rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Rule
     include Enumerable
@@ -6,7 +8,7 @@ module RRule
 
     def initialize(rrule, dtstart: Time.now, tzid: 'UTC', exdate: [], max_year: nil)
       @tz = tzid
-      @dtstart = floor_to_seconds_in_timezone(dtstart)
+      @dtstart = dtstart.is_a?(Date) ? dtstart : floor_to_seconds_in_timezone(dtstart)
       @exdate = exdate
       @options = parse_options(rrule)
       @frequency_type = Frequency.for_options(options)
@@ -25,11 +27,8 @@ module RRule
     end
 
     def each(floor_date: nil)
-      floor_date ||= dtstart
       # If we have a COUNT or INTERVAL option, we have to start at dtstart, because those are relative to dtstart
-      if count_or_interval_present?
-        floor_date = dtstart
-      end
+      floor_date = dtstart if count_or_interval_present? || floor_date.nil? || dtstart > floor_date
 
       return enum_for(:each, floor_date: floor_date) unless block_given?
       context = Context.new(options, dtstart, tz)
@@ -39,30 +38,20 @@ module RRule
       count = options[:count]
 
       filters = []
-      if options[:bymonth]
-        filters.push(ByMonth.new(options[:bymonth], context))
-      end
+      filters.push(ByMonth.new(options[:bymonth], context)) if options[:bymonth]
 
-      if options[:byweekno]
-        filters.push(ByWeekNumber.new(options[:byweekno], context))
-      end
+      filters.push(ByWeekNumber.new(options[:byweekno], context)) if options[:byweekno]
 
-      if options[:byweekday]
-        filters.push(ByWeekDay.new(options[:byweekday], context))
-      end
+      filters.push(ByWeekDay.new(options[:byweekday], context)) if options[:byweekday]
 
-      if options[:byyearday]
-        filters.push(ByYearDay.new(options[:byyearday], context))
-      end
+      filters.push(ByYearDay.new(options[:byyearday], context)) if options[:byyearday]
 
-      if options[:bymonthday]
-        filters.push(ByMonthDay.new(options[:bymonthday], context))
-      end
+      filters.push(ByMonthDay.new(options[:bymonthday], context)) if options[:bymonthday]
 
-      if options[:bysetpos]
-        generator = BySetPosition.new(options[:bysetpos], context)
+      generator = if options[:bysetpos]
+        BySetPosition.new(options[:bysetpos], context)
       else
-        generator = AllOccurrences.new(context)
+        AllOccurrences.new(context)
       end
 
       frequency = Frequency.for_options(options).new(context, filters, generator, timeset, start_date: floor_date)
@@ -106,7 +95,8 @@ module RRule
     def parse_options(rule)
       options = { interval: 1, wkst: 1 }
 
-      params = rule.split(';')
+      # Remove RRULE: prefix to prevent parsing options incorrectly.
+      params = rule.delete_prefix('RRULE:').split(';')
       params.each do |param|
         option, value = param.split('=')
 
@@ -117,15 +107,17 @@ module RRule
           i = begin
             Integer(value)
           rescue ArgumentError
-            raise InvalidRRule, "COUNT must be a non-negative integer"
+            raise InvalidRRule, 'COUNT must be a non-negative integer'
           end
-          raise InvalidRRule, "COUNT must be a non-negative integer" if i < 0
+          raise InvalidRRule, 'COUNT must be a non-negative integer' if i < 0
           options[:count] = i
         when 'UNTIL'
-          options[:until] = Time.parse(value)
+          # The value of the UNTIL rule part MUST have the same
+          # value type as the "DTSTART" property.
+          options[:until] = @dtstart.is_a?(Date) ? Date.parse(value) : Time.parse(value)
         when 'INTERVAL'
           i = Integer(value) rescue 0
-          raise InvalidRRule, "INTERVAL must be a positive integer" unless i > 0
+          raise InvalidRRule, 'INTERVAL must be a positive integer' unless i > 0
           options[:interval] = i
         when 'BYHOUR'
           options[:byhour] = value.split(',').compact.map(&:to_i)
@@ -138,7 +130,7 @@ module RRule
         when 'BYSETPOS'
           options[:bysetpos] = value.split(',').map(&:to_i)
         when 'WKST'
-          options[:wkst] = ['SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA'].index(value)
+          options[:wkst] = RRule::WEEKDAYS.index(value)
         when 'BYMONTH'
           options[:bymonth] = value.split(',').compact.map(&:to_i)
         when 'BYMONTHDAY'
@@ -150,12 +142,10 @@ module RRule
         end
       end
 
-      if !(options[:byweekno] || options[:byyearday] || options[:bymonthday] || options[:byweekday])
+      unless options[:byweekno] || options[:byyearday] || options[:bymonthday] || options[:byweekday]
         case options[:freq]
         when 'YEARLY'
-          unless options[:bymonth]
-            options[:bymonth] = [dtstart.month]
-          end
+          options[:bymonth] = [dtstart.month] unless options[:bymonth]
           options[:bymonthday] = [dtstart.day]
         when 'MONTHLY'
           options[:bymonthday] = [dtstart.day]
@@ -165,11 +155,13 @@ module RRule
         end
       end
 
-      unless options[:byweekday].nil?
-        options[:byweekday], options[:bynweekday] = options[:byweekday].partition { |wday| wday.ordinal.nil? }
-      end
+      options[:byweekday], options[:bynweekday] = options[:byweekday].partition { |wday| wday.ordinal.nil? } unless options[:byweekday].nil?
 
-      options[:timeset] = [{ hour: (options[:byhour].presence || dtstart.hour), minute: (options[:byminute].presence || dtstart.min), second: (options[:bysecond].presence || dtstart.sec) }]
+      # The BYSECOND, BYMINUTE and BYHOUR rule parts MUST NOT be specified
+      # when the associated "DTSTART" property has a DATE value type.
+      # These rule parts MUST be ignored in RECUR value that violate the
+      # above requirement
+      options[:timeset] = [{ hour: (options[:byhour].presence || dtstart.hour), minute: (options[:byminute].presence || dtstart.min), second: (options[:bysecond].presence || dtstart.sec) }] unless dtstart.is_a?(Date)
 
       options
     end

data/lib/rrule/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RRule
+  VERSION = '0.4.4'
+end

data/lib/rrule/weekday.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RRule
   class Weekday
     attr_reader :index, :ordinal
@@ -8,8 +10,8 @@ module RRule
     end
 
     def self.parse(weekday)
-      match = /([+-]?\d)?([A-Z]{2})/.match(weekday)
-      index = ['SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA'].index(match[2])
+      match = /([+-]?\d+)?([A-Z]{2})/.match(weekday)
+      index = RRule::WEEKDAYS.index(match[2])
       ordinal = match[1] ? match[1].to_i : nil
       new(index, ordinal)
     end