chronological 0.0.9 → 1.0.0beta1

data/lib/chronological.rb

@@ -1,7 +1,97 @@
 require 'chronological/version'
-require 'chronological/base'
-require 'chronological/absolute_timeframe'
-require 'chronological/relative_timeframe'
+require 'chronological/errors'
+require 'chronological/strategy_resolver'
+require 'chronological/strategies'
 
 module Chronological
+  def timeframe(*args)
+    options  = args.first.is_a?(Hash) ? args.pop : {}
+    strategy = Chronological::StrategyResolver.resolve(options)
+
+    class_eval do
+      columns_hash[strategy.field_names[:starting_time]] ||= ActiveRecord::ConnectionAdapters::Column.new(strategy.field_names[:starting_time], nil, 'datetime')
+      columns_hash[strategy.field_names[:ending_time]]   ||= ActiveRecord::ConnectionAdapters::Column.new(strategy.field_names[:ending_time],   nil, 'datetime')
+      columns_hash[strategy.field_names[:starting_date]] ||= ActiveRecord::ConnectionAdapters::Column.new(strategy.field_names[:starting_date], nil, 'date')
+      columns_hash[strategy.field_names[:ending_date]]   ||= ActiveRecord::ConnectionAdapters::Column.new(strategy.field_names[:ending_date],   nil, 'date')
+    end
+
+    unless strategy.has_absolute_start?
+      define_method(strategy.field_names[:starting_time]) do
+        strategy.starting_time(self)
+      end
+    end
+
+    unless strategy.has_absolute_end?
+      define_method(strategy.field_names[:ending_time]) do
+        strategy.ending_time(self)
+      end
+    end
+
+    define_method(:scheduled?) do
+      strategy.scheduled?(self)
+    end
+
+    define_method(:partially_scheduled?) do
+      strategy.partially_scheduled?(self)
+    end
+
+    define_method(:inactive?) do
+      strategy.inactive?(self)
+    end
+
+    define_method(:in_progress?) do
+      strategy.in_progress?(self)
+    end
+
+    define_method(:duration) do
+      strategy.duration(self)
+    end
+
+    define_method(strategy.field_names[:starting_date]) do
+      strategy.starting_date(self)
+    end
+
+    define_method(strategy.field_names[:ending_date]) do
+      strategy.ending_date(self)
+    end
+
+    ###
+    # Scopes
+    #
+    define_singleton_method(:by_date) do |direction = :asc|
+      strategy.class.by_date(self, strategy.field_names, direction)
+    end
+
+    define_singleton_method(:ended) do
+      strategy.class.ended(self, strategy.field_names)
+    end
+
+    define_singleton_method(:not_yet_ended) do
+      strategy.class.not_yet_ended(self, strategy.field_names)
+    end
+
+    define_singleton_method(:in_progress) do
+      strategy.class.in_progress(self, strategy.field_names)
+    end
+
+    define_singleton_method(:started) do
+      strategy.class.started(self, strategy.field_names)
+    end
+
+    define_singleton_method(:in_progress?) do
+      strategy.class.in_progress?(self, strategy.field_names)
+    end
+
+    ###
+    # Aliases
+    #
+    instance_eval do
+      alias active? in_progress?
+      alias active  in_progress
+    end
+
+    class_eval do
+      alias active? in_progress?
+    end
+  end
 end

data/spec/chronological_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+class ChronologicableStrategyClass
+  extend Chronological
+end
+
+describe Chronological do
+  describe '.timeframe' do
+    context 'when it is called with a symbol representing a strategy' do
+      before do
+        ChronologicableStrategyClass.class_eval do
+          timeframe type:       :absolute,
+                    start_utc:  :started_at_utc,
+                    end_utc:    :ended_at_utc
+        end
+      end
+
+      pit 'is translated properly' do
+        ChronologicableStrategyClass.class_variable_get(:@@chronological_strategy).should eql Chronological::AbsoluteStrategy
+      end
+    end
+
+    context 'when it is called with a symbol that does not represent a strategy' do
+      it 'it throws an error' do
+        lambda do
+          ChronologicableStrategyClass.class_eval do
+            timeframe :grey_goose
+          end
+        end.should raise_error Chronological::UndefinedStrategy
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'sqlite3'
+require 'pg'
 require 'active_record'
 require 'timecop'
 require 'chronological'
@@ -6,50 +6,4 @@ require 'chronological'
 Dir[File.expand_path('../support/**/*.rb',   __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
-  config.before(:suite) do
-    SQLite3::Database.new 'tmp/test.db'
-
-    ActiveRecord::Base.establish_connection(
-      :adapter  => 'sqlite3',
-      :database => 'tmp/test.db'
-    )
-
-    class SetupTests < ActiveRecord::Migration
-      def up
-        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
-
-        create_table :chronologicable_with_time_zones do |t|
-          t.datetime :started_at_utc
-          t.datetime :ended_at_utc
-          t.string   :time_zone
-        end
-      end
-    end
-
-    SetupTests.new.migrate(:up)
-  end
-
-  config.before(:each) do
-    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
-    `rm -f ./tmp/test.db`
-  end
 end

data/spec/{absolute_timeframe_spec.rb → strategies/absolute_spec.rb}

@@ -1,21 +1,23 @@
 require 'spec_helper'
 
 class AbsoluteChronologicable < ActiveRecord::Base
-  include Chronological::AbsoluteTimeframe
+  extend Chronological
 
-  absolute_timeframe start_utc:  :started_at_utc,
-                     end_utc:    :ended_at_utc
+  timeframe type:           :absolute,
+            starting_time:  :started_at_utc,
+            ending_time:    :ended_at_utc
 end
 
 class ChronologicableWithTimeZone < ActiveRecord::Base
-  include Chronological::AbsoluteTimeframe
+  extend Chronological
 
-  absolute_timeframe start_utc:  :started_at_utc,
-                     end_utc:    :ended_at_utc,
-                     time_zone:  :time_zone
+  timeframe type:           :absolute,
+            starting_time:  :started_at_utc,
+            ending_time:    :ended_at_utc,
+            time_zone:      :time_zone
 end
 
-describe Chronological::AbsoluteTimeframe, :timecop => true do
+describe Chronological::AbsoluteStrategy, :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) }
@@ -26,90 +28,125 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
 
   before           { Timecop.freeze(now) }
 
-  it { AbsoluteChronologicable.new.respond_to?(:starts_at_utc).should   be_true }
-  it { AbsoluteChronologicable.new.respond_to?(:starting_at_utc).should be_true }
-  it { AbsoluteChronologicable.new.respond_to?(:ends_at_utc).should     be_true }
-  it { AbsoluteChronologicable.new.respond_to?(:ending_at_utc).should   be_true }
-  it { AbsoluteChronologicable.new.respond_to?(:active?).should         be_true }
+  describe '.by_date' do
+    context 'when there are two chronologicables that start at the same time' do
+      context 'but end at different times' do
+        let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => past }
+        let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
 
-  it { AbsoluteChronologicable.respond_to?(:active?).should             be_true }
-  it { AbsoluteChronologicable.respond_to?(:active).should              be_true }
-
-  context 'when there are two chronologicables that start at the same time' do
-    context 'but end at different times' do
-      let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => past }
-      let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
+        context 'when no option is passed' do
+          it 'properly sorts them in ascending order' do
+            AbsoluteChronologicable.by_date.first.should  eql chronologicable_1
+            AbsoluteChronologicable.by_date.last.should   eql chronologicable_2
+          end
+        end
 
-      describe '.by_date' do
-        it 'properly sorts them' do
-          AbsoluteChronologicable.by_date.first.should  eql chronologicable_1
-          AbsoluteChronologicable.by_date.last.should   eql chronologicable_2
+        context 'when the :desc option is passed' do
+          it 'sorts them backwards by the start date' do
+            AbsoluteChronologicable.by_date(:desc).first.should  eql chronologicable_2
+            AbsoluteChronologicable.by_date(:desc).last.should   eql chronologicable_1
+          end
         end
       end
 
-      describe '.by_date_reversed' do
-        it 'sorts them backwards by the start date' do
-          AbsoluteChronologicable.by_date_reversed.first.should  eql chronologicable_2
-          AbsoluteChronologicable.by_date_reversed.last.should   eql chronologicable_1
+      context 'and end at the same time' do
+        let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
+        let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
+
+        describe '.by_date' do
+          context 'when in ascending order' do
+            it 'does not matter what order they are in as long as they are all there' do
+              AbsoluteChronologicable.by_date.should  include chronologicable_1
+              AbsoluteChronologicable.by_date.should  include chronologicable_2
+            end
+          end
+
+          context 'when in descending order' do
+            it 'does not matter what order they are in as long as they are all there' do
+              AbsoluteChronologicable.by_date(:desc).should  include chronologicable_1
+              AbsoluteChronologicable.by_date(:desc).should  include chronologicable_2
+            end
+          end
         end
       end
     end
 
-    context 'and end at the same time' do
-      let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
-      let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
+    context 'when there are two chronologicables that start at different times' do
+      context 'and end at different times' do
+        let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
+        let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => now,  :ended_at_utc => later }
 
-      describe '.by_date' do
-        it 'does not matter what order they are in as long as they are all there' do
-          AbsoluteChronologicable.by_date.should  include chronologicable_1
-          AbsoluteChronologicable.by_date.should  include chronologicable_2
+        context 'when in ascending order' do
+          it 'sorts them by the start date' do
+            AbsoluteChronologicable.by_date.first.should  eql chronologicable_1
+            AbsoluteChronologicable.by_date.last.should   eql chronologicable_2
+          end
+        end
+
+        context 'when in descending order' do
+          it 'sorts them backwards by the start date' do
+            AbsoluteChronologicable.by_date(:desc).first.should  eql chronologicable_2
+            AbsoluteChronologicable.by_date(:desc).last.should   eql chronologicable_1
+          end
         end
       end
 
-      describe '.by_date_reversed' do
-        it 'does not matter what order they are in as long as they are all there' do
-          AbsoluteChronologicable.by_date.should  include chronologicable_1
-          AbsoluteChronologicable.by_date.should  include chronologicable_2
+      context 'but end at the same time' do
+        let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => later }
+        let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => now,  :ended_at_utc => later }
+
+        context 'when in ascending order' do
+          it 'sorts them by the start date' do
+            AbsoluteChronologicable.by_date.first.should  eql chronologicable_1
+            AbsoluteChronologicable.by_date.last.should   eql chronologicable_2
+          end
+        end
+
+        context 'when in descending order' do
+          it 'sorts them backwards by the start date' do
+            AbsoluteChronologicable.by_date(:desc).first.should  eql chronologicable_2
+            AbsoluteChronologicable.by_date(:desc).last.should   eql chronologicable_1
+          end
         end
       end
     end
   end
 
-  context 'when there are two chronologicables that start at different times' do
-    context 'and end at different times' do
-      let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => now }
-      let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => now,  :ended_at_utc => later }
+  describe '.by_duration' do
+    context 'when there are two chronologicables that are different durations' do
+      let!(:chronologicable_1) { AbsoluteChronologicable.create(:started_at_utc => 3.seconds.ago, :ended_at_utc => 2.seconds.ago) }
+      let!(:chronologicable_2) { AbsoluteChronologicable.create(:started_at_utc => 3.seconds.ago, :ended_at_utc => 1.second.ago) }
 
-      describe '.by_date' do
-        it 'sorts them by the start date' do
+      context 'when no option is passed' do
+        it 'properly sorts them in ascending order' do
           AbsoluteChronologicable.by_date.first.should  eql chronologicable_1
           AbsoluteChronologicable.by_date.last.should   eql chronologicable_2
         end
       end
 
-      describe '.by_date_reversed' do
+      context 'when the :desc option is passed' do
         it 'sorts them backwards by the start date' do
-          AbsoluteChronologicable.by_date_reversed.first.should  eql chronologicable_2
-          AbsoluteChronologicable.by_date_reversed.last.should   eql chronologicable_1
+          AbsoluteChronologicable.by_date(:desc).first.should  eql chronologicable_2
+          AbsoluteChronologicable.by_date(:desc).last.should   eql chronologicable_1
         end
       end
     end
 
-    context 'but end at the same time' do
-      let!(:chronologicable_1) { AbsoluteChronologicable.create :started_at_utc => past, :ended_at_utc => later }
-      let!(:chronologicable_2) { AbsoluteChronologicable.create :started_at_utc => now,  :ended_at_utc => later }
+    context 'when there are two chronologicables that are the same duration' do
+      let!(:chronologicable_1) { AbsoluteChronologicable.create(:started_at_utc => 3.seconds.ago, :ended_at_utc => 1.second.ago) }
+      let!(:chronologicable_2) { AbsoluteChronologicable.create(:started_at_utc => 3.seconds.ago, :ended_at_utc => 1.second.ago) }
 
-      describe '.by_date' do
-        it 'sorts them by the start date' do
-          AbsoluteChronologicable.by_date.first.should  eql chronologicable_1
-          AbsoluteChronologicable.by_date.last.should   eql chronologicable_2
+      context 'when no option is passed' do
+        it 'does not matter what order they are in' do
+          AbsoluteChronologicable.by_date.should  include chronologicable_1
+          AbsoluteChronologicable.by_date.should  include chronologicable_2
         end
       end
 
-      describe '.by_date_reversed' do
-        it 'sorts them backwards by the start date' do
-          AbsoluteChronologicable.by_date_reversed.first.should  eql chronologicable_2
-          AbsoluteChronologicable.by_date_reversed.last.should   eql chronologicable_1
+      context 'when the :desc option is passed' do
+        it 'does not matter what order they are in' do
+          AbsoluteChronologicable.by_date(:desc).should  include chronologicable_1
+          AbsoluteChronologicable.by_date(:desc).should  include chronologicable_2
         end
       end
     end
@@ -304,9 +341,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.expired' do
+        describe '.ended' do
           it 'includes that chronologicable' do
-            AbsoluteChronologicable.expired.should include chronologicable
+            AbsoluteChronologicable.ended.should include chronologicable
           end
         end
 
@@ -316,9 +353,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.current' do
+        describe '.not_yet_ended' do
           it 'does not include that chronologicable' do
-            AbsoluteChronologicable.current.should_not include chronologicable
+            AbsoluteChronologicable.not_yet_ended.should_not include chronologicable
           end
         end
 
@@ -338,9 +375,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.expired' do
+        describe '.ended' do
           it 'does include that chronologicable' do
-            AbsoluteChronologicable.expired.should include chronologicable
+            AbsoluteChronologicable.ended.should include chronologicable
           end
         end
 
@@ -350,9 +387,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.current' do
+        describe '.not_yet_ended' do
           it 'does not include that chronologicable' do
-            AbsoluteChronologicable.current.should_not include chronologicable
+            AbsoluteChronologicable.not_yet_ended.should_not include chronologicable
           end
         end
 
@@ -372,9 +409,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.expired' do
+        describe '.ended' do
           it 'does not include that chronologicable' do
-            AbsoluteChronologicable.expired.should_not include chronologicable
+            AbsoluteChronologicable.ended.should_not include chronologicable
           end
         end
 
@@ -384,9 +421,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.current' do
+        describe '.not_yet_ended' do
           it 'includes that chronologicable' do
-            AbsoluteChronologicable.current.should include chronologicable
+            AbsoluteChronologicable.not_yet_ended.should include chronologicable
           end
         end
 
@@ -410,9 +447,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.expired' do
+        describe '.ended' do
           it 'does include that chronologicable' do
-            AbsoluteChronologicable.expired.should include chronologicable
+            AbsoluteChronologicable.ended.should include chronologicable
           end
         end
 
@@ -422,9 +459,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.current' do
+        describe '.not_yet_ended' do
           it 'does not include that chronologicable' do
-            AbsoluteChronologicable.current.should_not include chronologicable
+            AbsoluteChronologicable.not_yet_ended.should_not include chronologicable
           end
         end
 
@@ -444,9 +481,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.expired' do
+        describe '.ended' do
           it 'does not include that chronologicable' do
-            AbsoluteChronologicable.expired.should_not include chronologicable
+            AbsoluteChronologicable.ended.should_not include chronologicable
           end
         end
 
@@ -456,9 +493,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
           end
         end
 
-        describe '.current' do
+        describe '.not_yet_ended' do
           it 'includes that chronologicable' do
-            AbsoluteChronologicable.current.should include chronologicable
+            AbsoluteChronologicable.not_yet_ended.should include chronologicable
           end
         end
 
@@ -480,9 +517,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
         end
       end
 
-      describe '.expired' do
+      describe '.ended' do
         it 'does not include that chronologicable' do
-          AbsoluteChronologicable.expired.should_not include chronologicable
+          AbsoluteChronologicable.ended.should_not include chronologicable
         end
       end
 
@@ -492,9 +529,9 @@ describe Chronological::AbsoluteTimeframe, :timecop => true do
         end
       end
 
-      describe '.current' do
+      describe '.not_yet_ended' do
         it 'includes that chronologicable' do
-          AbsoluteChronologicable.current.should include chronologicable
+          AbsoluteChronologicable.not_yet_ended.should include chronologicable
         end
       end