rrule 0.0.0 → 0.1.0

data/lib/rrule/weekday.rb

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

data/rrule.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = 'rrule'
+  s.version = '0.1.0'
+  s.date = '2016-06-06'
+  s.summary = 'RRule expansion'
+  s.description = 'A gem for expanding dates according to the RRule specification'
+  s.authors = ['Ryan Mitchell']
+  s.email = 'rmitchell@squareup.com'
+  s.files = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.homepage = 'http://rubygems.org/gems/rrule'
+
+  # Since Ruby 1.9.2, Time implementation uses a signed 63 bit integer, Bignum
+  # or Rational. This enables Time to finally work with years after 2038 which
+  # is critical for this library.
+  s.required_ruby_version = '>= 1.9.2'
+  s.add_runtime_dependency 'activesupport', '>= 4.1'
+  s.add_development_dependency 'rspec', '~> 3.4'
+end

data/spec/context_spec.rb

@@ -0,0 +1,261 @@
+require 'spec_helper'
+
+describe RRule::Context do
+  let(:context) do
+    RRule::Context.new(
+      { freq: 'DAILY', count: 3 },
+      Time.parse('Tue Sep  2 06:00:00 PDT 1997'),
+      'America/Los_Angeles'
+    )
+  end
+
+  before(:each) { context.rebuild(1997, 1) }
+
+  describe '#year_length_in_days' do
+    subject { context.year_length_in_days }
+
+    context 'in a non leap year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it { is_expected.to eql 365 }
+    end
+
+    context 'in a leap year' do
+      before(:each) { context.rebuild(2000, 1) }
+
+      it { is_expected.to eql 366 }
+    end
+  end
+
+  describe '#next_year_length_in_days' do
+    subject { context.next_year_length_in_days }
+
+    context 'in a year not prior to a leap year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it { is_expected.to eql 365 }
+    end
+
+    context 'in a year prior to a leap year' do
+      before(:each) { context.rebuild(1999, 1) }
+
+      it { is_expected.to eql 366 }
+    end
+  end
+
+  describe '#first_day_of_year' do
+    subject { context.first_day_of_year }
+
+    it { is_expected.to eq Date.new(1997, 1, 1) }
+  end
+
+  describe '#month_by_day_of_year' do
+    subject(:month_by_day_of_year) { context.month_by_day_of_year }
+
+    context 'in a leap year' do
+      before(:each) { context.rebuild(2000, 1) }
+
+      it 'maps the day of the year to the month number' do
+        expect(month_by_day_of_year.length).to eql 366 + 7 # 7 padding days
+        expect(month_by_day_of_year[0]).to eql 1
+        expect(month_by_day_of_year[59]).to eql 2
+        expect(month_by_day_of_year[365]).to eql 12
+      end
+    end
+
+    context 'in a non leap year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'maps the day of the year to the month number' do
+        expect(month_by_day_of_year.length).to eql 365 + 7 # 7 padding days
+        expect(month_by_day_of_year[0]).to eql 1
+        expect(month_by_day_of_year[59]).to eql 3
+        expect(month_by_day_of_year[364]).to eql 12
+      end
+    end
+  end
+
+  describe '#month_day_by_day_of_year' do
+    subject(:month_day_by_day_of_year) { context.month_day_by_day_of_year }
+
+    context 'in a leap year' do
+      before(:each) { context.rebuild(2000, 1) }
+
+      it 'maps the month day of the year to the month number' do
+        expect(month_day_by_day_of_year.length).to eql 366 + 7 # 7 padding days
+        expect(month_day_by_day_of_year[0]).to eql 1
+        expect(month_day_by_day_of_year[1]).to eql 2
+        expect(month_day_by_day_of_year[59]).to eql 29
+        expect(month_day_by_day_of_year[365]).to eql 31
+      end
+    end
+
+    context 'in a non leap year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'maps the month day of the year to the month number' do
+        expect(month_day_by_day_of_year.length).to eql 365 + 7 # 7 padding days
+        expect(month_day_by_day_of_year[0]).to eql 1
+        expect(month_day_by_day_of_year[1]).to eql 2
+        expect(month_day_by_day_of_year[59]).to eql 1
+        expect(month_day_by_day_of_year[364]).to eql 31
+      end
+    end
+  end
+
+  describe '#negative_month_day_by_day_of_year' do
+    subject(:negative_month_day_by_day_of_year) { context.negative_month_day_by_day_of_year }
+
+    context 'in a leap year' do
+      before(:each) { context.rebuild(2000, 1) }
+
+      it 'maps the month day of the year to the month number' do
+        expect(negative_month_day_by_day_of_year.length).to eql 366 + 7 # 7 padding days
+        expect(negative_month_day_by_day_of_year[0]).to eql -31
+        expect(negative_month_day_by_day_of_year[1]).to eql -30
+        expect(negative_month_day_by_day_of_year[59]).to eql -1
+        expect(negative_month_day_by_day_of_year[365]).to eql -1
+      end
+    end
+
+    context 'in a non leap year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'maps the month day of the year to the month number' do
+        expect(negative_month_day_by_day_of_year.length).to eql 365 + 7 # 7 padding days
+        expect(negative_month_day_by_day_of_year[0]).to eql -31
+        expect(negative_month_day_by_day_of_year[1]).to eql -30
+        expect(negative_month_day_by_day_of_year[59]).to eql -31
+        expect(negative_month_day_by_day_of_year[364]).to eql -1
+      end
+    end
+  end
+
+  describe '#week_number_by_day_of_year' do
+    subject(:week_number_by_day_of_year) { context.week_number_by_day_of_year }
+
+    context 'when the first day of the year is in the first week of that calendar-week-based year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'is part of the current calendar-week-based year' do
+        expect(week_number_by_day_of_year[0]).to eql 1
+      end
+    end
+
+    context 'when the first day of the year is in the last week of the previous calendar-week-based year' do
+      before(:each) { context.rebuild(1999, 1) }
+
+      it 'is part of the previous calendar-week-based year' do
+        expect(week_number_by_day_of_year[0]).to eql 53
+      end
+    end
+
+    context 'when the last day of the year is in the last week of that calendar-week-based year' do
+      before(:each) { context.rebuild(1999, 1) }
+
+      it 'is part of the current calendar-week-based year' do
+        expect(week_number_by_day_of_year[364]).to eql 52
+      end
+    end
+
+    context 'when the last day of the year is in the first week of the next calendar-week-based year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'is part of the next calendar-week-based year' do
+        expect(week_number_by_day_of_year[364]).to eql 1
+      end
+    end
+  end
+
+  describe '#negative_week_number_by_day_of_year' do
+    subject(:negative_week_number_by_day_of_year) { context.negative_week_number_by_day_of_year }
+
+    context 'when the first day of the year is in the first week of that calendar-week-based year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'is part of the current calendar-week-based year' do
+        expect(negative_week_number_by_day_of_year[0]).to eql -52
+      end
+    end
+
+    context 'when the first day of the year is in the last week of the previous calendar-week-based year' do
+      before(:each) { context.rebuild(1999, 1) }
+
+      it 'is part of the previous calendar-week-based year' do
+        expect(negative_week_number_by_day_of_year[0]).to eql -1
+      end
+    end
+
+    context 'when the last day of the year is in the last week of that calendar-week-based year' do
+      before(:each) { context.rebuild(1999, 1) }
+
+      it 'is part of the current calendar-week-based year' do
+        expect(negative_week_number_by_day_of_year[364]).to eql -1
+      end
+    end
+
+    context 'when the last day of the year is in the first week of the next calendar-week-based year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it 'is part of the next calendar-week-based year' do
+        expect(negative_week_number_by_day_of_year[364]).to eql -53
+      end
+    end
+  end
+
+  describe '#first_weekday_of_year' do
+    subject { context.first_weekday_of_year }
+
+    it { is_expected.to eq 3 }
+  end
+
+  describe '#weekday_by_day_of_year' do
+    subject { context.weekday_by_day_of_year }
+
+    it { is_expected.to start_with(3, 4, 5, 6, 0, 1, 2) }
+  end
+
+  describe '#elapsed_days_in_year_by_month' do
+    subject { context.elapsed_days_in_year_by_month }
+
+    context 'in a leap year' do
+      before(:each) { context.rebuild(2000, 1) }
+
+      it { is_expected.to start_with(0, 31, 60, 91) }
+    end
+
+    context 'in a non leap year' do
+      before(:each) { context.rebuild(1997, 1) }
+
+      it { is_expected.to start_with(0, 31, 59, 90) }
+    end
+  end
+
+  describe '#day_of_year_mask' do
+    let(:context) do
+      RRule::Context.new(
+          { freq: 'MONTHLY', count: 3, bynweekday: [RRule::Weekday.parse('3TU'), RRule::Weekday.parse('-2MO')] },
+          Time.parse('Wed Jan  1 00:00:00 PST 1997'),
+          'America/Los_Angeles'
+      )
+    end
+
+    subject(:day_of_year_mask) { context.day_of_year_mask }
+
+    it 'correctly masks all days except the third Tuesday and the next-to-last Monday in January 1997' do
+      day_of_year_mask.each_with_index do |available, day_of_year|
+        expect(available).to be [19, 20].include?(day_of_year)
+      end
+    end
+
+    context 'when the month is advanced' do
+      before(:each) { context.rebuild(1997, 2) }
+
+      it 'correctly masks all days except the third Tuesday and the next-to-last Monday in February 1997' do
+        day_of_year_mask.each_with_index do |available, day_of_year|
+          expect(available).to be [48, 47].include?(day_of_year)
+        end
+      end
+    end
+  end
+end

data/spec/filters/by_month_day_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe RRule::ByMonthDay do
+  let(:context) do
+    RRule::Context.new(
+        { freq: 'MONTHLY', count: 4 },
+        Time.parse('Wed Jan  1 00:00:00 PST 1997'),
+        'America/Los_Angeles'
+    )
+  end
+
+  subject { described_class.new([3, -3], context).reject?(date.yday - 1) }
+
+  before(:each) { context.rebuild(1997, 1) }
+
+  describe '#reject?' do
+    context 'for the third day of the month' do
+      let(:date) { Date.new(1997, 1, 3) }
+
+      it { is_expected.to be false }
+    end
+
+    context 'for the fourth day of the month' do
+      let(:date) { Date.new(1997, 1, 4) }
+
+      it { is_expected.to be true }
+    end
+
+    context 'for the third-to-last day of the month' do
+      let(:date) { Date.new(1997, 1, 29) }
+
+      it { is_expected.to be false }
+    end
+  end
+end

data/spec/filters/by_month_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe RRule::ByMonth do
+  let(:context) do
+    RRule::Context.new(
+        { freq: 'MONTHLY', count: 4 },
+        Time.parse('Wed Jan  1 00:00:00 PST 1997'),
+        'America/Los_Angeles'
+    )
+  end
+
+  subject { described_class.new([1, 3], context).reject?(date.yday) }
+
+  before(:each) { context.rebuild(1997, 1) }
+
+  describe '#reject?' do
+    context 'for a day in January' do
+      let(:date) { Date.new(1997, 1, 15) }
+
+      it { is_expected.to be false }
+    end
+
+    context 'for a day in February' do
+      let(:date) { Date.new(1997, 2, 15) }
+
+      it { is_expected.to be true }
+    end
+
+    context 'for a day in March' do
+      let(:date) { Date.new(1997, 3, 15) }
+
+      it { is_expected.to be false }
+    end
+  end
+end

data/spec/filters/by_week_day_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe RRule::ByWeekDay do
+  let(:context) do
+    RRule::Context.new(
+        { freq: 'WEEKLY', count: 4 },
+        Time.parse('Wed Jan  1 00:00:00 PST 1997'),
+        'America/Los_Angeles'
+    )
+  end
+
+  subject { described_class.new([RRule::Weekday.parse('TU'), RRule::Weekday.parse('FR')], context).reject?(date.yday - 1) }
+
+  before(:each) { context.rebuild(1997, 1) }
+
+  describe '#reject?' do
+    context 'for the Friday of the week' do
+      let(:date) { Date.new(1997, 1, 3) }
+
+      it { is_expected.to be false }
+    end
+
+    context 'for the Saturday of the week' do
+      let(:date) { Date.new(1997, 1, 4) }
+
+      it { is_expected.to be true }
+    end
+
+    context 'for the Tuesday of the next week' do
+      let(:date) { Date.new(1997, 1, 7) }
+
+      it { is_expected.to be false }
+    end
+  end
+end

data/spec/filters/by_week_number_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe RRule::ByWeekNumber do
+  let(:context) do
+    RRule::Context.new(
+        { freq: 'YEARLY', wkst: 1 },
+        Time.parse('Wed Jan  1 00:00:00 PST 1997'),
+        'America/Los_Angeles'
+    )
+  end
+
+  subject { described_class.new([2, -3], context).reject?(date.yday - 1) }
+
+  before(:each) { context.rebuild(1997, 1) }
+
+  describe '#reject?' do
+    context 'for the first week of the year' do
+      let(:date) { Date.new(1997, 1, 2) }
+
+      it { is_expected.to be true }
+    end
+
+    context 'for the second week of the year' do
+      let(:date) { Date.new(1997, 1, 8) }
+
+      it { is_expected.to be false }
+    end
+
+    context 'for the fourth week of the year' do
+      let(:date) { Date.new(1997, 1, 22) }
+
+      it { is_expected.to be true }
+    end
+
+    context 'for the third-to-last week of the year' do
+      let(:date) { Date.new(1997, 12, 9) }
+
+      it { is_expected.to be false }
+    end
+  end
+end