chronological 0.0.3 → 0.0.4

data/lib/chronological/version.rb

@@ -1,3 +1,3 @@
 module Chronological
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/chronological.rb

@@ -1,30 +1,35 @@
 module Chronological
   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 chronological(options = {})
-      start_field            = options[:start_utc] || options[:start]
-      end_field              = options[:end_utc]   || options[:end]
-      time_zone              = options[:time_zone]
-      start_field_is_utc     = options.has_key? :start_utc
-      end_field_is_utc       = options.has_key? :end_utc
-      start_field_utc_suffix = start_field_is_utc ? '_utc' : ''
-      end_field_utc_suffix   = end_field_is_utc ? '_utc' : ''
+      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(:started_at_utc_date) do
-        return nil unless send(start_field).respond_to? :to_date
+      define_method(start_date_field) do
+        return nil unless send(start_time_field).respond_to? :to_date
 
-        send(start_field).to_date
+        send(start_time_field).to_date
       end
 
-      define_method(:ended_at_utc_date) do
-        return nil unless send(end_field).respond_to? :to_date
+      define_method(end_date_field) do
+        return nil unless send(end_time_field).respond_to? :to_date
 
-        send(end_field).to_date
+        send(end_time_field).to_date
       end
 
       define_method(:in_progress?) do
         return false unless scheduled?
 
-        (send(start_field) <= Time.now.utc) && send(end_field).future?
+        (send(start_time_field) <= Time.now.utc) && send(end_time_field).future?
       end
 
       define_method(:inactive?) do
@@ -34,13 +39,13 @@ module Chronological
       define_method(:scheduled?) do
         optional_time_zone = !options[:time_zone].nil? ? send(time_zone) : true
 
-        send(start_field).present? && send(end_field).present? && optional_time_zone
+        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_field).present? || send(end_field).present? || optional_time_zone
+        send(start_time_field).present? || send(end_time_field).present? || optional_time_zone
       end
 
       define_method(:duration) do
@@ -55,27 +60,27 @@ module Chronological
       # Scopes
       #
       self.class.send(:define_method, :by_date) do
-        order "#{table_name}.#{start_field} ASC, #{table_name}.#{end_field} ASC"
+        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_field} DESC, #{table_name}.#{end_field} DESC"
+        order "#{table_name}.#{start_time_field} DESC, #{table_name}.#{end_time_field} DESC"
       end
 
       self.class.send(:define_method, :expired) do
-        where("#{end_field} <= :now", :now => Time.now.utc)
+        where("#{end_time_field} <= :now", :now => Time.now.utc)
       end
 
       self.class.send(:define_method, :current) do
-        where("#{end_field} > :now", :now => Time.now.utc)
+        where("#{end_time_field} > :now", :now => Time.now.utc)
       end
 
       self.class.send(:define_method, :in_progress) do
-        where("#{start_field} <= :now AND #{end_field} > :now", :now => Time.now.utc)
+        where("#{start_time_field} <= :now AND #{end_time_field} > :now", :now => Time.now.utc)
       end
 
       self.class.send(:define_method, :started) do
-        where("#{start_field} <= :now", :now => Time.now.utc)
+        where("#{start_time_field} <= :now", :now => Time.now.utc)
       end
 
       self.class.send(:define_method, :in_progress?) do
@@ -92,17 +97,17 @@ module Chronological
       #
       # Aliasing date methods to make code more readable
       class_eval do
-        alias_attribute   :"starts_at#{start_field_utc_suffix}",    start_field.to_sym
-        alias_attribute   :"starting_at#{start_field_utc_suffix}",  start_field.to_sym
-        alias_attribute   :"ends_at#{start_field_utc_suffix}",      end_field.to_sym
-        alias_attribute   :"ending_at#{start_field_utc_suffix}",    end_field.to_sym
+        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
 
         alias             active?                                   in_progress?
       end
 
     private
       define_method(:duration_in_seconds) do
-        (send(end_field) - send(start_field))
+        (send(end_time_field) - send(start_time_field))
       end
     end
   end

data/spec/chronological_spec.rb

@@ -130,13 +130,13 @@ describe Chronological, :timecop => true do
     end
   end
 
-  describe '#started_at_utc_date' do
+  describe '#started_on_utc' do
     context 'when the date field is set to a string' do
       let(:start_time) { '2012-07-26 03:15:12' }
       let(:end_time)   { nil }
 
       it 'properly converts the date' do
-        chronologicable.started_at_utc_date.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        chronologicable.started_on_utc.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
       end
     end
 
@@ -145,18 +145,18 @@ describe Chronological, :timecop => true do
       let(:end_time)   { nil }
 
       it 'properly converts the date' do
-        chronologicable.started_at_utc_date.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        chronologicable.started_on_utc.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
       end
     end
   end
 
-  describe '#ended_at_utc_date' do
+  describe '#ended_on_utc' do
     context 'when the date field is set to a string' do
       let(:start_time)  { nil }
       let(:end_time)    { '2012-07-26 03:15:12' }
 
       it 'properly converts the date' do
-        chronologicable.ended_at_utc_date.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        chronologicable.ended_on_utc.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
       end
     end
 
@@ -165,7 +165,7 @@ describe Chronological, :timecop => true do
       let(:end_time)    { Time.utc(2012, 7, 26, 3, 15, 12) }
 
       it 'properly converts the date' do
-        chronologicable.ended_at_utc_date.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
+        chronologicable.ended_on_utc.should eql Time.utc(2012, 7, 26, 3, 15, 12).to_date
       end
     end
   end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'chronological'
 Dir[File.expand_path('../support/**/*.rb',   __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
-  config.before(:all) do
+  config.before(:suite) do
     SQLite3::Database.new 'tmp/test.db'
 
     ActiveRecord::Base.establish_connection(
@@ -36,7 +36,7 @@ RSpec.configure do |config|
     ActiveRecord::Base.connection.execute 'DELETE FROM chronologicables'
   end
 
-  config.after(:all) do
+  config.after(:suite) do
     `rm -f ./tmp/test.db`
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronological
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec