chronological 0.0.9 → 1.0.0beta1

data/spec/support/active_record.rb

@@ -0,0 +1,47 @@
+postgres_connection_options = {
+  :adapter      => 'postgresql',
+  :host         => 'localhost',
+  :database     => 'chronological',
+  :username     => ENV['USER'],
+  :min_messages => 'warning',
+  :encoding     => 'utf8' }
+
+ActiveRecord::Base.establish_connection       postgres_connection_options.merge(
+                                                :database           => 'postgres',
+                                                :schema_search_path => 'public')
+
+ActiveRecord::Base.connection.drop_database   postgres_connection_options[:database] rescue nil
+ActiveRecord::Base.connection.create_database postgres_connection_options[:database]
+
+ActiveRecord::Base.establish_connection       postgres_connection_options
+
+ActiveRecord::Base.connection.create_table :base_chronologicables do |t|
+  t.datetime :started_at
+  t.datetime :ended_at
+end
+
+ActiveRecord::Base.connection.create_table :relative_chronologicables do |t|
+  t.integer  :starting_offset
+  t.integer  :ending_offset
+  t.datetime :base_datetime_utc
+end
+
+ActiveRecord::Base.connection.create_table :absolute_chronologicables do |t|
+  t.datetime :started_at_utc
+  t.datetime :ended_at_utc
+end
+
+ActiveRecord::Base.connection.create_table :chronologicable_with_time_zones do |t|
+  t.datetime :started_at_utc
+  t.datetime :ended_at_utc
+  t.string   :time_zone
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ActiveRecord::Base.connection.execute 'DELETE FROM base_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
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: chronological
 version: !ruby/object:Gem::Version
-  version: 0.0.9
-  prerelease: 
+  version: 1.0.0beta1
+  prerelease: 5
 platform: ruby
 authors:
 - jfelchner
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2012-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -125,13 +125,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.8
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -164,18 +164,24 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- lib/chronological/absolute_timeframe.rb
-- lib/chronological/base.rb
-- lib/chronological/relative_timeframe.rb
+- lib/chronological/errors.rb
+- lib/chronological/strategies/absolute.rb
+- lib/chronological/strategies/base.rb
+- lib/chronological/strategies/relative.rb
+- lib/chronological/strategies.rb
+- lib/chronological/strategy_resolver.rb
 - lib/chronological/version.rb
 - lib/chronological.rb
 - Rakefile
 - README.md
 - LICENSE
-- spec/absolute_timeframe_spec.rb
-- spec/base_spec.rb
-- spec/relative_timeframe_spec.rb
+- spec/chronological_spec.rb
 - spec/spec_helper.rb
+- spec/strategies/absolute_spec.rb
+- spec/strategies/base_spec.rb
+- spec/strategies/relative_spec.rb
+- spec/strategy_resolver_spec.rb
+- spec/support/active_record.rb
 - spec/support/focused.rb
 - spec/support/pending.rb
 - spec/support/timecop.rb
@@ -195,9 +201,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: chronological
 rubygems_version: 1.8.24
@@ -205,10 +211,13 @@ signing_key:
 specification_version: 3
 summary: Easy Accessors for ActiveModel Objects
 test_files:
-- spec/absolute_timeframe_spec.rb
-- spec/base_spec.rb
-- spec/relative_timeframe_spec.rb
+- spec/chronological_spec.rb
 - spec/spec_helper.rb
+- spec/strategies/absolute_spec.rb
+- spec/strategies/base_spec.rb
+- spec/strategies/relative_spec.rb
+- spec/strategy_resolver_spec.rb
+- spec/support/active_record.rb
 - spec/support/focused.rb
 - spec/support/pending.rb
 - spec/support/timecop.rb

data/lib/chronological/absolute_timeframe.rb

@@ -1,98 +0,0 @@
-module Chronological
-  module AbsoluteTimeframe
-    module ClassMethods
-      # TODO: Needs to be able to add a validation option which can do the
-      # typical timeliness validation such as ended_at should be after started_at
-      # and that both should validate timeliness
-      def absolute_timeframe(options = {})
-        start_time_field            = options[:start_utc] || options[:start]
-        start_date_field            = start_time_field.to_s.gsub(/_at/, '_on')
-        end_time_field              = options[:end_utc]   || options[:end]
-        end_date_field              = end_time_field.to_s.gsub(/_at/, '_on')
-        time_zone                   = options[:time_zone]
-        start_time_field_is_utc     = options.has_key? :start_utc
-        end_time_field_is_utc       = options.has_key? :end_utc
-        start_time_field_utc_suffix = start_time_field_is_utc ? '_utc' : ''
-        end_time_field_utc_suffix   = end_time_field_is_utc ? '_utc' : ''
-
-        define_method(:scheduled?) do
-          optional_time_zone = !options[:time_zone].nil? ? send(time_zone) : true
-
-          send(start_time_field).present? && send(end_time_field).present? && optional_time_zone
-        end
-
-        define_method(:partially_scheduled?) do
-          optional_time_zone = !options[:time_zone].nil? ? send(time_zone) : false
-
-          send(start_time_field).present? || send(end_time_field).present? || optional_time_zone
-        end
-
-        ###
-        # Scopes
-        #
-        self.class.send(:define_method, :by_date) do
-          order "#{table_name}.#{start_time_field} ASC, #{table_name}.#{end_time_field} ASC"
-        end
-
-        self.class.send(:define_method, :by_date_reversed) do
-          order "#{table_name}.#{start_time_field} DESC, #{table_name}.#{end_time_field} DESC"
-        end
-
-        self.class.send(:define_method, :expired) do
-          where("#{end_time_field} <= :now", :now => Time.now.utc)
-        end
-
-        self.class.send(:define_method, :current) do
-          where("#{end_time_field} > :now", :now => Time.now.utc)
-        end
-
-        self.class.send(:define_method, :in_progress) do
-          where("#{start_time_field} <= :now AND #{end_time_field} > :now", :now => Time.now.utc)
-        end
-
-        self.class.send(:define_method, :started) do
-          where("#{start_time_field} <= :now", :now => Time.now.utc)
-        end
-
-        self.class.send(:define_method, :in_progress?) do
-          in_progress.any?
-        end
-
-        ###
-        # Aliases
-        #
-        # Aliasing date methods to make code more readable
-        instance_eval do
-          alias active? in_progress?
-          alias active  in_progress
-        end
-
-        class_eval do
-          alias_attribute   :"starts_at#{start_time_field_utc_suffix}",    start_time_field.to_sym
-          alias_attribute   :"starting_at#{start_time_field_utc_suffix}",  start_time_field.to_sym
-          alias_attribute   :"ends_at#{start_time_field_utc_suffix}",      end_time_field.to_sym
-          alias_attribute   :"ending_at#{start_time_field_utc_suffix}",    end_time_field.to_sym
-        end
-
-        base_timeframe  start_date_field: start_date_field,
-                        start_time_field: start_time_field,
-                        end_date_field:   end_date_field,
-                        end_time_field:   end_time_field
-
-      private
-        define_method(:has_absolute_timeframe?) do
-          send(start_time_field).present? && send(end_time_field).present?
-        end
-
-        define_method(:duration_in_seconds) do
-          (send(end_time_field) - send(start_time_field))
-        end
-      end
-    end
-
-    def self.included(base)
-      base.extend Chronological::Base
-      base.extend ClassMethods
-    end
-  end
-end

data/lib/chronological/base.rb

@@ -1,41 +0,0 @@
-module Chronological
-  module Base
-    def base_timeframe(options = {})
-      define_method(options[:start_date_field]) do
-        return nil unless send(options[:start_time_field]).respond_to? :to_date
-
-        send(options[:start_time_field]).to_date
-      end
-
-      define_method(options[:end_date_field]) do
-        return nil unless send(options[:end_time_field]).respond_to? :to_date
-
-        send(options[:end_time_field]).to_date
-      end
-
-      define_method(:inactive?) do
-        !active?
-      end
-
-      define_method(:duration) do
-        return Hash.new unless duration_in_seconds.present?
-
-        hours   = (duration_in_seconds / 3600).to_i
-        minutes = ((duration_in_seconds % 3600) / 60).to_i
-        seconds = (duration_in_seconds % 60).to_i
-
-        { :hours => hours, :minutes => minutes, :seconds => seconds }
-      end
-
-      define_method(:in_progress?) do
-        return false unless has_absolute_timeframe?
-
-        (send(options[:start_time_field]) <= Time.now.utc) && send(options[:end_time_field]).future?
-      end
-
-      class_eval do
-        alias active? in_progress?
-      end
-    end
-  end
-end

data/lib/chronological/relative_timeframe.rb

@@ -1,96 +0,0 @@
-module Chronological
-  module RelativeTimeframe
-    module ClassMethods
-      def relative_timeframe(options = {})
-        base_time_field        = options[:base_utc] || options[:base]
-        base_time_field_is_utc = options.has_key? :base_utc
-        time_field_utc_suffix  = base_time_field_is_utc ? 'utc' : nil
-
-        start_time_field       = ['started_at', time_field_utc_suffix].compact.join('_')
-        end_time_field         = ['ended_at',   time_field_utc_suffix].compact.join('_')
-        start_date_field       = ['started_on', time_field_utc_suffix].compact.join('_')
-        end_date_field         = ['ended_on',   time_field_utc_suffix].compact.join('_')
-
-        class_eval do
-          columns_hash[start_time_field] = ActiveRecord::ConnectionAdapters::Column.new(start_time_field, nil, "datetime")
-          columns_hash[end_time_field]   = ActiveRecord::ConnectionAdapters::Column.new(end_time_field, nil, "datetime")
-        end
-
-        unless base_time_field_is_utc
-          define_method("#{start_time_field}_utc") do
-            return nil unless send(start_time_field).present?
-
-            send(start_time_field).in_time_zone('UTC')
-          end
-
-          define_method("#{end_time_field}_utc") do
-            return nil unless send(end_time_field).present?
-
-            send(end_time_field).in_time_zone('UTC')
-          end
-        end
-
-        define_method(start_time_field) do
-          return nil unless send(base_time_field).present? && send(options[:start]).present?
-
-          send(base_time_field) - send(options[:start])
-        end
-
-        define_method(end_time_field) do
-          return nil unless send(base_time_field).present? && send(options[:end]).present?
-
-          send(base_time_field) - send(options[:end])
-        end
-
-        define_method(:scheduled?) do
-          send(base_time_field).present? && send(options[:start]).present? && send(options[:end]).present?
-        end
-
-        define_method(:partially_scheduled?) do
-          send(base_time_field).present? || send(options[:start]).present? || send(options[:end]).present?
-        end
-
-        ###
-        # Scopes
-        #
-        self.class.send(:define_method, :in_progress) do
-          all.select(&:in_progress?)
-        end
-
-        self.class.send(:define_method, :in_progress?) do
-          all.any?(&:in_progress?)
-        end
-
-        ###
-        # Aliases
-        #
-        # Aliasing date methods to make code more readable
-        instance_eval do
-          alias active? in_progress?
-          alias active  in_progress
-        end
-
-        base_timeframe  start_date_field: start_date_field,
-                        start_time_field: start_time_field,
-                        end_date_field:   end_date_field,
-                        end_time_field:   end_time_field
-
-      private
-        define_method(:has_absolute_timeframe?) do
-          scheduled?
-        end
-
-        define_method(:duration_in_seconds) do
-          return nil unless send(options[:start]).present? && send(options[:end]).present?
-
-          send(options[:start]) - send(options[:end])
-        end
-      end
-    end
-
-    def self.included(base)
-      base.extend Chronological::Base
-      base.extend ClassMethods
-    end
-  end
-end

data/spec/base_spec.rb

@@ -1,230 +0,0 @@
-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