chronological 0.0.5 → 0.0.6

data/spec/base_spec.rb

@@ -0,0 +1,230 @@
+require 'spec_helper'
+
+class BaseChronologicable < ActiveRecord::Base
+  extend Chronological::Base
+
+  base_timeframe :start_date_field => :started_on,
+                 :start_time_field => :started_at,
+                 :end_date_field   => :ended_on,
+                 :end_time_field   => :ended_at
+
+private
+  def has_absolute_timeframe?
+    started_at.present? && ended_at.present?
+  end
+end
+
+describe Chronological::Base do
+  let(:started_at) { nil }
+  let(:ended_at)   { nil }
+
+  let(:chronologicable) do
+    BaseChronologicable.new(
+      :started_at => started_at,
+      :ended_at   => ended_at
+    )
+  end
+
+  describe '#started_on' do
+    context 'when #started_at is set' do
+      context 'to a string' do
+        let(:started_at) { '2012-07-26 03:15:12' }
+
+        it 'properly converts the date' do
+          chronologicable.started_on.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        end
+      end
+
+      context 'to a date' do
+        let(:started_at) { Time.utc(2012, 7, 26, 3, 15, 12) }
+
+        it 'properly converts the date' do
+          chronologicable.started_on.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        end
+      end
+    end
+
+    context 'when #started_at is not set' do
+      let(:started_at) { nil }
+
+      it 'is nil' do
+        chronologicable.started_on.should be_nil
+      end
+    end
+  end
+
+  describe '#ended_on' do
+    context 'when #ended_at is set' do
+      context 'to a string' do
+        let(:ended_at) { '2012-07-26 03:15:12' }
+
+        it 'properly converts the date' do
+          chronologicable.ended_on.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        end
+      end
+
+      context 'to a date' do
+        let(:ended_at) { Time.utc(2012, 7, 26, 3, 15, 12) }
+
+        it 'properly converts the date' do
+          chronologicable.ended_on.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        end
+      end
+    end
+
+    context 'when #ended_at is not set' do
+      let(:ended_at) { nil }
+
+      it 'is nil' do
+        chronologicable.ended_on.should be_nil
+      end
+    end
+  end
+
+  describe '#duration' do
+    context 'when the chronologicable represents something with a duration' do
+      before { chronologicable.should_receive(:duration_in_seconds).any_number_of_times.and_return(6263) }
+
+      it 'is a hash with the correct hours' do
+        chronologicable.duration[:hours].should eql 1
+      end
+
+      it 'is a hash with the correct minutes' do
+        chronologicable.duration[:minutes].should eql 44
+      end
+
+      it 'is a hash with the correct seconds' do
+        chronologicable.duration[:seconds].should eql 23
+      end
+    end
+
+    context 'when the chronologicable represents something with an even second time duration' do
+      before { chronologicable.should_receive(:duration_in_seconds).any_number_of_times.and_return(6240) }
+
+      it 'is a hash with the correct hours' do
+        chronologicable.duration[:hours].should eql 1
+      end
+
+      it 'is a hash with the correct minutes' do
+        chronologicable.duration[:minutes].should eql 44
+      end
+
+      it 'is a hash with the correct seconds' do
+        chronologicable.duration[:seconds].should eql 0
+      end
+    end
+
+    context 'when the chronologicable represents something with an even minute time duration' do
+      before { chronologicable.should_receive(:duration_in_seconds).any_number_of_times.and_return(3600) }
+
+      it 'is a hash with the correct hours' do
+        chronologicable.duration[:hours].should eql 1
+      end
+
+      it 'is a hash with the correct minutes' do
+        chronologicable.duration[:minutes].should eql 0
+      end
+
+      it 'is a hash with the correct seconds' do
+        chronologicable.duration[:seconds].should eql 0
+      end
+    end
+
+    context 'when the chronologicable represents something with a zero duration' do
+      before { chronologicable.should_receive(:duration_in_seconds).any_number_of_times.and_return(0) }
+
+      it 'is a hash with the correct hours' do
+        chronologicable.duration[:hours].should eql 0
+      end
+
+      it 'is a hash with the correct minutes' do
+        chronologicable.duration[:minutes].should eql 0
+      end
+
+      it 'is a hash with the correct seconds' do
+        chronologicable.duration[:seconds].should eql 0
+      end
+    end
+
+    context 'when duration in seconds returns an empty value' do
+      before { chronologicable.should_receive(:duration_in_seconds).and_return(nil) }
+
+      it 'is an empty hash' do
+        chronologicable.duration.should eql Hash.new
+      end
+    end
+  end
+
+  describe '#in_progress?', :timecop => true do
+    let(:later) { Time.local(2012, 7, 26, 6, 0, 26) }
+    let(:now)   { Time.local(2012, 7, 26, 6, 0, 25) }
+    let(:past)  { Time.local(2012, 7, 26, 6, 0, 24) }
+
+    before      { Timecop.freeze(now)             }
+
+    context 'when it does not have an absolute timeframe' do
+      before { chronologicable.should_receive(:has_absolute_timeframe?).and_return(false) }
+
+      it 'is false' do
+        chronologicable.should_not be_in_progress
+      end
+    end
+
+    context 'when it has already started' do
+      let(:started_at) { past }
+
+      context 'and already ended' do
+        let(:ended_at) { past }
+
+        it 'is false' do
+          chronologicable.should_not be_in_progress
+        end
+      end
+
+      context 'and ends now' do
+        let(:ended_at) { now }
+
+        it 'is false' do
+          chronologicable.should_not be_in_progress
+        end
+      end
+
+      context 'and ends later' do
+        let(:ended_at) { later }
+
+        it 'is true' do
+          chronologicable.should be_in_progress
+        end
+      end
+    end
+
+    context 'when there is a chronologicable that starts now' do
+      let(:started_at) { now }
+
+      context 'and ends now' do
+        let(:ended_at) { now }
+
+        it 'is false' do
+          chronologicable.should_not be_in_progress
+        end
+      end
+
+      context 'and ends later' do
+        let(:ended_at) { later }
+
+        it 'is true' do
+          chronologicable.should be_in_progress
+        end
+      end
+    end
+
+    context 'when there is a chronologicable that has not yet started' do
+      let(:started_at) { later }
+      let(:ended_at)   { later }
+
+      it 'is false' do
+        chronologicable.should_not be_in_progress
+      end
+    end
+  end
+end

data/spec/relative_timeframe_spec.rb

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+class RelativeChronologicable < ActiveRecord::Base
+  include Chronological::RelativeTimeframe
+
+  relative_timeframe :start     => :starting_offset,
+                     :end       => :ending_offset,
+                     :base_utc  => :base_datetime_utc
+end
+
+describe Chronological::RelativeTimeframe do
+  let(:now)         { Time.local(2012, 7, 26, 6, 0, 0)  }
+  let(:base_time)   { Time.local(2012, 7, 26, 6, 0, 30) }
+
+  before            { Timecop.freeze(now)               }
+
+  let(:chronologicable) do
+    RelativeChronologicable.create(
+      :starting_offset      => starting_offset,
+      :ending_offset        => ending_offset,
+      :base_datetime_utc    => base_time)
+  end
+
+  describe '#started_at_utc' do
+    let(:ending_offset) { 'anything' }
+
+    context 'when the starting offset is set' do
+      let(:starting_offset) { 30 }
+
+      context 'but the base time is not set' do
+        let(:base_time) { nil }
+
+        it 'is nil' do
+          chronologicable.started_at_utc.should be_nil
+        end
+      end
+
+      context 'and the base time is set' do
+        let(:base_time)   { Time.local(2012, 7, 26, 6, 0, 30) }
+
+        it 'is the proper offset calculation' do
+          chronologicable.started_at_utc.should eql Time.local(2012, 7, 26, 6, 0, 0)
+        end
+      end
+    end
+
+    context 'when the starting offset is not set' do
+      let(:starting_offset) { nil }
+
+      it 'is nil' do
+        chronologicable.started_at_utc.should be_nil
+      end
+    end
+  end
+
+  describe '#ended_at_utc' do
+    let(:starting_offset) { 'anything' }
+
+    context 'when the ending offset is set' do
+      let(:ending_offset) { 30 }
+
+      context 'but the base time is not set' do
+        let(:base_time) { nil }
+
+        it 'is nil' do
+          chronologicable.ended_at_utc.should be_nil
+        end
+      end
+
+      context 'and the base time is set' do
+        let(:base_time)   { Time.local(2012, 7, 26, 6, 0, 30) }
+
+        it 'is the proper offset calculation' do
+          chronologicable.ended_at_utc.should eql Time.local(2012, 7, 26, 6, 0, 0)
+        end
+      end
+    end
+
+    context 'when the ending offset is not set' do
+      let(:ending_offset) { nil }
+
+      it 'is nil' do
+        chronologicable.ended_at_utc.should be_nil
+      end
+    end
+  end
+
+  context 'when the base time is not set' do
+    let(:now)             { Time.local(2012, 7, 26, 6, 0, 0) }
+    let(:base_time)       { nil }
+
+    context 'but the starting offset is set' do
+      let(:starting_offset) { 30 }
+
+      context 'and the ending offset is set' do
+        let(:ending_offset) { 0 }
+
+        it 'is not scheduled' do
+          chronologicable.should_not be_scheduled
+        end
+
+        it 'is partially scheduled' do
+          chronologicable.should be_partially_scheduled
+        end
+      end
+
+      context 'and the ending offset is not set' do
+        let(:ending_offset) { nil }
+
+        it 'is not scheduled' do
+          chronologicable.should_not be_scheduled
+        end
+
+        it 'is partially scheduled' do
+          chronologicable.should be_partially_scheduled
+        end
+      end
+    end
+
+    context 'and the starting offset is not set' do
+      let(:starting_offset) { nil }
+
+      context 'but the ending offset is set' do
+        let(:ending_offset) { 0 }
+
+        it 'is not scheduled' do
+          chronologicable.should_not be_scheduled
+        end
+
+        it 'is partially scheduled' do
+          chronologicable.should be_partially_scheduled
+        end
+      end
+    end
+
+    context 'and neither of the offsets is set' do
+      let(:starting_offset) { nil }
+      let(:ending_offset)   { nil }
+
+      it 'is not scheduled' do
+        chronologicable.should_not be_scheduled
+      end
+
+      it 'is not partially scheduled' do
+        chronologicable.should_not be_partially_scheduled
+      end
+    end
+  end
+
+  context 'when the starting offset is not set' do
+    let(:now)             { Time.local(2012, 7, 26, 6, 0, 0) }
+    let(:starting_offset) { nil }
+
+    context 'and the ending offset is not set' do
+      let(:ending_offset) { nil }
+
+      it 'is not scheduled' do
+        chronologicable.should_not be_scheduled
+      end
+
+      it 'is partially scheduled' do
+        chronologicable.should be_partially_scheduled
+      end
+    end
+
+    context 'and the ending offset is set' do
+      let(:ending_offset)   { 0 }
+
+      it 'is not scheduled' do
+        chronologicable.should_not be_scheduled
+      end
+
+      it 'is partially scheduled' do
+        chronologicable.should be_partially_scheduled
+      end
+    end
+  end
+
+  context 'when the starting offset is set' do
+    let(:now)             { Time.local(2012, 7, 26, 6, 0, 0) }
+    let(:starting_offset) { 30 }
+
+    context 'and the ending offset is not set' do
+      let(:ending_offset) { nil }
+
+      it 'is not scheduled' do
+        chronologicable.should_not be_scheduled
+      end
+
+      it 'is partially scheduled' do
+        chronologicable.should be_partially_scheduled
+      end
+    end
+
+    context 'and the ending offset is set' do
+      let(:ending_offset)   { 0 }
+
+      it 'is scheduled' do
+        chronologicable.should be_scheduled
+      end
+
+      it 'is partially scheduled' do
+        chronologicable.should be_partially_scheduled
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -16,7 +16,18 @@ RSpec.configure do |config|
 
     class SetupTests < ActiveRecord::Migration
       def up
-        create_table :chronologicables do |t|
+        create_table :base_chronologicables do |t|
+          t.datetime :started_at
+          t.datetime :ended_at
+        end
+
+        create_table :relative_chronologicables do |t|
+          t.integer  :starting_offset
+          t.integer  :ending_offset
+          t.datetime :base_datetime_utc
+        end
+
+        create_table :absolute_chronologicables do |t|
           t.datetime :started_at_utc
           t.datetime :ended_at_utc
         end
@@ -33,7 +44,9 @@ RSpec.configure do |config|
   end
 
   config.before(:each) do
-    ActiveRecord::Base.connection.execute 'DELETE FROM chronologicables'
+    ActiveRecord::Base.connection.execute 'DELETE FROM relative_chronologicables'
+    ActiveRecord::Base.connection.execute 'DELETE FROM absolute_chronologicables'
+    ActiveRecord::Base.connection.execute 'DELETE FROM chronologicable_with_time_zones'
   end
 
   config.after(:suite) do