ta_by_star 4.0.0

data/spec/integration/shared/index_scope_parameter.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+shared_examples_for 'index_scope parameter' do
+
+  describe ':scope' do
+
+    it 'should memoize the scope variable' do
+      expect(Event.instance_variable_get(:@by_star_index_scope)).to be_nil
+      expect(Post.instance_variable_get(:@by_star_index_scope)).to be_nil
+      expect(Appointment.instance_variable_get(:@by_star_index_scope)).to be_a Proc
+    end
+
+    context 'between_times with index_scope' do
+
+      context 'nil' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: nil) }
+        it { expect(subject.count).to eql(16) }
+      end
+
+      context 'false' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: false) }
+        it { expect(subject.count).to eql(16) }
+      end
+
+      context 'Time' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: Time.zone.parse('2013-11-30 17:00:00')) }
+        it { expect(subject.count).to eql(14) }
+      end
+
+      context 'DateTime' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: Time.zone.parse('2013-11-30 17:00:00').to_datetime) }
+        it { expect(subject.count).to eql(14) }
+      end
+
+      context 'Date' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: Date.parse('2013-11-30')) }
+        it { expect(subject.count).to eql(14) }
+      end
+
+      context 'ActiveSupport::Duration' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: 3.hours) }
+        it { expect(subject.count).to eql(13) }
+      end
+
+      context 'Numeric' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: 3600) }
+        it { expect(subject.count).to eql(13) }
+      end
+
+      context ':beginning_of_day' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: :beginning_of_day) }
+        it { expect(subject.count).to eql(13) }
+      end
+
+      context 'unsupported type' do
+        subject { Event.between_times(Date.parse('2013-12-01'), Date.parse('2014-01-31'), index_scope: Integer) }
+        it { expect{subject.count}.to raise_error(RuntimeError) }
+      end
+    end
+
+    context 'at_time with index_scope' do
+
+      context 'nil' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: nil) }
+        it { expect(subject.count).to eql(3) }
+      end
+
+      context 'false' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: false) }
+        it { expect(subject.count).to eql(3) }
+      end
+
+      context 'Time' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: Time.zone.parse('2013-10-30 17:00:00')) }
+        it { expect(subject.count).to eql(3) }
+      end
+
+      context 'DateTime' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: Time.zone.parse('2013-11-30 17:00:00').to_datetime) }
+        it { expect(subject.count).to eql(1) }
+      end
+
+      context 'Date' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: Date.parse('2013-11-30')) }
+        it { expect(subject.count).to eql(1) }
+      end
+
+      context 'ActiveSupport::Duration' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: 100.hours) }
+        it { expect(subject.count).to eql(1) }
+      end
+
+      context 'Numeric' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: 60 * 60 * 1000) }
+        it { expect(subject.count).to eql(3) }
+      end
+
+      context ':beginning_of_day' do
+        let!(:custom_event){ t = Time.zone.parse('2013-12-30 17:00'); Event.create!(start_time: t - 1.hour, end_time: t + 1.hour) }
+        subject { Event.at_time(Time.zone.parse('2013-12-30 16:00'), index_scope: :beginning_of_day) }
+        it { expect(subject.count).to eql(1) }
+        after { custom_event.delete }
+      end
+
+      context 'unsupported type' do
+        subject { Event.at_time(Time.zone.parse('2013-12-01 14:00'), index_scope: Integer) }
+        it { expect{subject.count}.to raise_error(RuntimeError) }
+      end
+    end
+  end
+end

data/spec/integration/shared/offset_parameter.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+shared_examples_for 'offset parameter' do
+
+  describe ':offset' do
+
+    it 'should memoize the offset variable' do
+      expect(Event.instance_variable_get(:@by_star_offset)).to eq 3.hours
+      expect(Post.instance_variable_get(:@by_star_offset)).to be_nil
+    end
+
+    context 'between_times with default offset' do
+      subject { Event.between_times(Time.zone.parse('2014-01-01'), Time.zone.parse('2014-01-10')) }
+      it { expect(subject.count).to eql(7) }
+    end
+
+    context 'between_times with offset override' do
+      subject { Event.between_times(Time.zone.parse('2014-01-01')..Time.zone.parse('2014-01-10'), offset: 16.hours) }
+      it { expect(subject.count).to eql(7) }
+    end
+
+    context 'by_day with default offset' do
+      subject { Event.by_day(Time.zone.parse('2014-01-01')) }
+      it { expect(subject.count).to eql(5) }
+    end
+
+    context 'by_day with offset override' do
+      subject { Event.by_day(Time.zone.parse('2014-12-26'), field: :start_time, offset: 5.hours) }
+      it { expect(subject.count).to eql(0) }
+    end
+  end
+end

data/spec/integration/shared/order_parameter.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+shared_examples_for 'order parameter' do
+
+  describe ':order' do
+
+    if testing_active_record?
+
+      it 'should be able to order the result set asc' do
+        scope = Post.by_year(Time.zone.now.year, order: 'created_at ASC')
+        expect(scope.order_values).to eq ['created_at ASC']
+        expect(scope.first.created_at).to eq Time.zone.parse('2014-01-01 17:00:00')
+      end
+
+      it 'should be able to order the result set desc' do
+        scope = Post.by_year(Time.zone.now.year, order: 'created_at DESC')
+        expect(scope.order_values).to eq ['created_at DESC']
+        expect(scope.first.created_at).to eq Time.zone.parse('2014-04-15 17:00:00')
+      end
+
+    elsif testing_mongoid?
+
+      it 'should be able to order the result set asc' do
+        scope = Post.by_year(Time.zone.now.year, order: {created_at: :asc})
+        expect(scope.options[:sort]).to eq({'created_at' => 1})
+        expect(scope.first.created_at).to eq Time.zone.parse('2014-01-01 17:00:00')
+      end
+
+      it 'should be able to order the result set desc' do
+        scope = Post.by_year(Time.zone.now.year, order: {created_at: :desc})
+        expect(scope.options[:sort]).to eq({'created_at' => -1})
+        expect(scope.first.created_at).to eq Time.zone.parse('2014-04-15 17:00:00')
+      end
+    end
+  end
+end

data/spec/integration/shared/relative.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+shared_examples_for 'relative' do
+
+  describe '#past_day' do
+    context 'point-in-time' do
+      subject { Post.past_day }
+      it { expect(subject.count).to eql(1) }
+    end
+
+    context 'timespan' do
+      subject { Event.past_day }
+      it { expect(subject.count).to eql(5) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.past_day(strict: true) }
+      it { expect(subject.count).to eql(0) }
+    end
+  end
+
+  describe '#past_week' do
+    context 'point-in-time' do
+      subject { Post.past_week }
+      it { expect(subject.count).to eql(3) }
+    end
+
+    context 'timespan' do
+      subject { Event.past_week }
+      it { expect(subject.count).to eql(7) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.past_week(strict: true) }
+      it { expect(subject.count).to eql(0) }
+    end
+  end
+
+  describe '#past_fortnight' do
+    context 'point-in-time' do
+      subject { Post.past_fortnight }
+      it { expect(subject.count).to eql(4) }
+    end
+
+    context 'timespan' do
+      subject { Event.past_fortnight }
+      it { expect(subject.count).to eql(8) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.past_fortnight(strict: true) }
+      it { expect(subject.count).to eql(1) }
+    end
+  end
+
+  describe '#past_month' do
+    context 'point-in-time' do
+      subject { Post.past_month }
+      it { expect(subject.count).to eql(8) }
+    end
+
+    context 'timespan' do
+      subject { Event.past_month }
+      it { expect(subject.count).to eql(12) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.past_month(strict: true) }
+      it { expect(subject.count).to eql(4) }
+    end
+  end
+
+  describe '#past_year' do
+    context 'point-in-time' do
+      subject { Post.past_year }
+      it { expect(subject.count).to eql(10) }
+    end
+
+    context 'timespan' do
+      subject { Event.past_year }
+      it { expect(subject.count).to eql(13) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.past_year(strict: true) }
+      it { expect(subject.count).to eql(8) }
+    end
+  end
+
+  describe '#next_day' do
+    context 'point-in-time' do
+      subject { Post.next_day }
+      it { expect(subject.count).to eql(2) }
+    end
+
+    context 'timespan' do
+      subject { Event.next_day }
+      it { expect(subject.count).to eql(5) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.next_day(strict: true) }
+      it { expect(subject.count).to eql(0) }
+    end
+  end
+
+  describe '#next_week' do
+    context 'point-in-time' do
+      subject { Post.next_week }
+      it { expect(subject.count).to eql(3) }
+    end
+
+    context 'timespan' do
+      subject { Event.next_week }
+      it { expect(subject.count).to eql(7) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.next_week(strict: true) }
+      it { expect(subject.count).to eql(0) }
+    end
+  end
+
+  describe '#next_fortnight' do
+    context 'point-in-time' do
+      subject { Post.next_fortnight }
+      it { expect(subject.count).to eql(5) }
+    end
+
+    context 'timespan' do
+      subject { Event.next_fortnight }
+      it { expect(subject.count).to eql(7) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.next_fortnight(strict: true) }
+      it { expect(subject.count).to eql(0) }
+    end
+  end
+
+  describe '#next_month' do
+    context 'point-in-time' do
+      subject { Post.next_month }
+      it { expect(subject.count).to eql(6) }
+    end
+
+    context 'timespan' do
+      subject { Event.next_month }
+      it { expect(subject.count).to eql(9) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.next_month(strict: true) }
+      it { expect(subject.count).to eql(3) }
+    end
+  end
+
+  describe '#next_year' do
+    context 'point-in-time' do
+      subject { Post.next_year }
+      it { expect(subject.count).to eql(12) }
+    end
+
+    context 'timespan' do
+      subject { Event.next_year }
+      it { expect(subject.count).to eql(14) }
+    end
+
+    context 'timespan strict' do
+      subject { Event.next_year(strict: true) }
+      it { expect(subject.count).to eql(9) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'fileutils'
+require 'logger'
+
+FileUtils.mkdir_p(File.dirname(__FILE__) + "/tmp")
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+require 'active_record'
+require 'mongoid'
+require 'chronic'
+require 'timecop'
+require 'by_star'
+
+# Specs should pass regardless of timezone
+Time.zone = %w(Asia/Tokyo America/New_York Australia/Sydney UTC).sample
+puts "Running specs in #{Time.zone} timezone..."
+
+# Set Rails time to 2014-01-01 00:00:00
+Timecop.travel(Time.zone.local(2014))
+
+RSpec.configure do |c|
+  c.filter_run_excluding sydney: true unless Time.zone.name == 'Australia/Sydney'
+end
+
+def testing_mongoid?
+  ENV['DB'] == 'mongodb'
+end
+
+def testing_active_record?
+  !testing_mongoid?
+end

data/spec/unit/kernel_date_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Date do
+
+  describe '#in_time_zone' do
+
+    subject { Date.new }
+
+    before do
+      stub_const('Date', Class.new)
+      allow_any_instance_of(Date).to receive(:to_time_in_current_zone)
+    end
+
+    context 'when #in_time_zone is already defined' do
+      before do
+        expect_any_instance_of(Date).to receive(:in_time_zone)
+      end
+
+      context 'when ByStar::Kernel::InTimeZone included' do
+        before do
+          ::Date.__send__(:include, ByStar::Kernel::InTimeZone)
+        end
+
+        it 'should not be aliased to #to_time_in_current_zone' do
+          expect(subject).not_to receive(:to_time_in_current_zone)
+          subject.in_time_zone
+        end
+      end
+
+      context 'when ByStar::Kernel::InTimeZone not included' do
+
+        it 'should not be aliased to #to_time_in_current_zone' do
+          expect(subject).not_to receive(:to_time_in_current_zone)
+          subject.in_time_zone
+        end
+      end
+    end
+
+    context 'when #in_time_zone is not defined' do
+
+      context 'when ByStar::Kernel::InTimeZone included' do
+        before do
+          ::Date.__send__(:include, ByStar::Kernel::InTimeZone)
+        end
+
+        it 'should be aliased to #to_time_in_current_zone' do
+          expect(subject).to receive(:to_time_in_current_zone)
+          subject.in_time_zone
+        end
+      end
+
+      context 'when ByStar::Kernel::InTimeZone not included' do
+
+        it 'should raise NoMethodError' do
+          expect{ subject.in_time_zone }.to raise_error(NoMethodError)
+        end
+      end
+    end
+  end
+
+  describe 'weekend' do
+
+    (0..6).each do |n|
+      context "Monday plus #{n} days" do
+        subject { Date.parse('2014-01-06') + n.days }
+        it { expect(subject.beginning_of_weekend).to eq Date.parse('2014-01-11') }
+        it { expect(subject.end_of_weekend).to eq Date.parse('2014-01-12') }
+      end
+    end
+  end
+
+  describe 'fortnight' do
+
+    context 'first day of year' do
+      subject { Date.parse '2014-01-01' }
+      it { expect(subject.beginning_of_fortnight).to eq Date.parse('2014-01-01') }
+      it { expect(subject.end_of_fortnight).to eq Date.parse('2014-01-14') }
+    end
+
+    context 'second fortnight of year' do
+      subject { Date.parse '2014-01-16' }
+      it { expect(subject.beginning_of_fortnight).to eq Date.parse('2014-01-15') }
+      it { expect(subject.end_of_fortnight).to eq Date.parse('2014-01-28') }
+    end
+
+    context 'middle of year' do
+      subject { Date.parse '2014-06-13' }
+      it { expect(subject.beginning_of_fortnight).to eq Date.parse('2014-06-04') }
+      it { expect(subject.end_of_fortnight).to eq Date.parse('2014-06-17') }
+    end
+
+    context 'last day of year' do
+      subject { Date.parse '2014-12-31' }
+      it { expect(subject.beginning_of_fortnight).to eq Date.parse('2014-12-31') }
+      it { expect(subject.end_of_fortnight).to eq Date.parse('2015-01-13') }
+    end
+  end
+
+  describe 'calendar_month' do
+
+    subject { Date.parse '2014-01-01' }
+
+    context 'week begins Monday' do
+      it { expect(subject.beginning_of_calendar_month).to eq Date.parse('2013-12-30') }
+      it { expect(subject.end_of_calendar_month).to eq Date.parse('2014-02-02') }
+    end
+
+    context 'week begins Sunday' do
+      it { expect(subject.beginning_of_calendar_month(:sunday)).to eq Date.parse('2013-12-29') }
+      it { expect(subject.end_of_calendar_month(:sunday)).to eq Date.parse('2014-02-01') }
+    end
+  end
+end

data/spec/unit/kernel_time_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Time do
+
+  describe 'weekend' do
+
+    (0..6).each do |n|
+      context "Monday plus #{n} days" do
+        subject { Time.zone.parse('2014-01-06') + n.days }
+        it { expect(subject.beginning_of_weekend).to eq Time.zone.parse('2014-01-11') }
+        it { expect(subject.end_of_weekend).to eq Time.zone.parse('2014-01-12').end_of_day }
+      end
+    end
+  end
+
+  describe 'fortnight' do
+
+    context 'first day of year' do
+      subject { Time.zone.parse '2014-01-01' }
+      it { expect(subject.beginning_of_fortnight).to eq Time.zone.parse('2014-01-01') }
+      it { expect(subject.end_of_fortnight).to eq Time.zone.parse('2014-01-14').end_of_day }
+    end
+
+    context 'second fortnight of year' do
+      subject { Time.zone.parse '2014-01-16' }
+      it { expect(subject.beginning_of_fortnight).to eq Time.zone.parse('2014-01-15') }
+      it { expect(subject.end_of_fortnight).to eq Time.zone.parse('2014-01-28').end_of_day }
+    end
+
+    context 'middle of year' do
+      subject { Time.zone.parse '2014-06-13' }
+      it { expect(subject.beginning_of_fortnight).to eq Time.zone.parse('2014-06-04') }
+      it { expect(subject.end_of_fortnight).to eq Time.zone.parse('2014-06-17').end_of_day }
+    end
+
+    context 'last day of year' do
+      subject { Time.zone.parse '2014-12-31' }
+      it { expect(subject.beginning_of_fortnight).to eq Time.zone.parse('2014-12-31') }
+      it { expect(subject.end_of_fortnight).to eq Time.zone.parse('2015-01-13').end_of_day }
+    end
+  end
+
+  describe 'calendar_month' do
+
+    subject { Time.zone.parse '2014-01-01' }
+
+    context 'week begins Monday' do
+      it { expect(subject.beginning_of_calendar_month).to eq Time.zone.parse('2013-12-30') }
+      it { expect(subject.end_of_calendar_month).to eq Time.zone.parse('2014-02-02').end_of_day }
+    end
+
+    context 'week begins Sunday' do
+      it { expect(subject.beginning_of_calendar_month(:sunday)).to eq Time.zone.parse('2013-12-29') }
+      it { expect(subject.end_of_calendar_month(:sunday)).to eq Time.zone.parse('2014-02-01').end_of_day }
+    end
+  end
+end