chronological 0.0.1 → 0.0.2

data/lib/chronological/version.rb

@@ -1,3 +1,3 @@
 module Chronological
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/chronological.rb

@@ -38,38 +38,36 @@ module Chronological
 
   def self.included(base)
     base.extend ClassMethods
-  end
-
-  ###
-  # Aliases
-  #
-  # Aliasing date methods to make code more readable
 
-  alias_attribute  :starts_at,        :started_at
-  alias_attribute  :starting_at,      :started_at
-  alias_attribute  :ends_at,          :ended_at
-  alias_attribute  :ending_at,        :ended_at
-  alias_attribute  :starts_at_utc,    :started_at_utc
-  alias_attribute  :starting_at_utc,  :started_at_utc
-  alias_attribute  :ends_at_utc,      :ended_at_utc
-  alias_attribute  :ending_at_utc,    :ended_at_utc
+    ###
+    # Aliases
+    #
+    # Aliasing date methods to make code more readable
+
+    base.instance_eval <<-EVALING
+      alias_attribute  :starts_at_utc,    :started_at_utc
+      alias_attribute  :starting_at_utc,  :started_at_utc
+      alias_attribute  :ends_at_utc,      :ended_at_utc
+      alias_attribute  :ending_at_utc,    :ended_at_utc
+    EVALING
+  end
 
-  def started_at_date
-    return nil unless started_at.respond_to? :to_date
+  def started_at_utc_date
+    return nil unless started_at_utc.respond_to? :to_date
 
-    started_at.to_date
+    started_at_utc.to_date
   end
 
-  def ended_at_date
-    return nil unless ended_at.respond_to? :to_date
+  def ended_at_utc_date
+    return nil unless ended_at_utc.respond_to? :to_date
 
-    ended_at.to_date
+    ended_at_utc.to_date
   end
 
   def in_progress?
     return false unless scheduled?
 
-    self.started_at.past? && self.ending_at.future?
+    (started_at_utc <= Time.now.utc) && ended_at_utc.future?
   end
 
   alias active? in_progress?
@@ -79,7 +77,11 @@ module Chronological
   end
 
   def scheduled?
-    started_at.present? || ended_at.present? || time_zone.present?
+    started_at_utc.present? && ended_at_utc.present?
+  end
+
+  def partially_scheduled?
+    started_at_utc.present? || ended_at_utc.present?
   end
 
   def duration
@@ -91,6 +93,6 @@ module Chronological
 
 private
   def duration_in_minutes
-    @duration_in_minutes ||= (ended_at - started_at) / 60
+    @duration_in_minutes ||= (ended_at_utc - started_at_utc) / 60
   end
 end

data/spec/chronological_spec.rb

@@ -0,0 +1,206 @@
+require 'spec_helper'
+
+class Chronologicable < ActiveRecord::Base
+  include Chronological
+end
+
+describe Chronological do
+  let(:later) { Time.utc(2012, 7, 26, 6, 0, 26) }
+  let(:now)   { Time.utc(2012, 7, 26, 6, 0, 25) }
+  let(:past)  { Time.utc(2012, 7, 26, 6, 0, 24) }
+
+  before      { Timecop.freeze(now)             }
+
+  let(:chronologicable) do
+    Chronologicable.create(
+      :started_at_utc => start_time,
+      :ended_at_utc   => end_time)
+  end
+
+  it { Chronologicable.new.respond_to?(:starts_at_utc).should   be_true }
+  it { Chronologicable.new.respond_to?(:starting_at_utc).should be_true }
+  it { Chronologicable.new.respond_to?(:ends_at_utc).should     be_true }
+  it { Chronologicable.new.respond_to?(:ending_at_utc).should   be_true }
+
+  describe '#started_at_utc_date' 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
+      end
+    end
+
+    context 'when the date field is set to a date' do
+      let(:start_time) { Time.utc(2012, 7, 26, 3, 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
+      end
+    end
+  end
+
+  describe '#ended_at_utc_date' 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
+      end
+    end
+
+    context 'when the date field is set to a date' do
+      let(:start_time)  { nil }
+      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
+      end
+    end
+  end
+
+  context 'when a start time is set' do
+    let(:start_time) { Time.now }
+
+    context 'but no end time is set' do
+      let(:end_time) { nil }
+
+      describe '#scheduled?' do
+        it 'is false' do
+          chronologicable.should_not be_scheduled
+        end
+      end
+
+      describe '#partially_scheduled?' do
+        it 'is true' do
+          chronologicable.should     be_partially_scheduled
+        end
+      end
+    end
+
+    context 'and an end time is set' do
+      let(:end_time) { Time.now }
+
+      describe '#scheduled?' do
+        it 'is true' do
+          chronologicable.should     be_scheduled
+        end
+      end
+
+      describe '#partially_scheduled?' do
+        it 'is true' do
+          chronologicable.should     be_partially_scheduled
+        end
+      end
+    end
+  end
+
+  context 'when an end time is set' do
+    let(:end_time) { Time.now }
+
+    context 'but no start time is set' do
+      let(:start_time) { nil }
+
+      describe '#scheduled?' do
+        it 'is false' do
+          chronologicable.should_not be_scheduled
+        end
+      end
+
+      describe '#partially_scheduled?' do
+        it 'is true' do
+          chronologicable.should     be_partially_scheduled
+        end
+      end
+    end
+  end
+
+  context 'when neither a start time nor an end time is set' do
+    let(:start_time) { nil }
+    let(:end_time)   { nil }
+
+    describe '#scheduled?' do
+      it 'is false' do
+        chronologicable.should_not be_scheduled
+      end
+    end
+
+    describe '#partially_scheduled?' do
+      it 'is false' do
+        chronologicable.should_not be_partially_scheduled
+      end
+    end
+  end
+
+  context 'when there is a chronologicable that has already started' do
+    let(:start_time) { past }
+
+    context 'and has already ended' do
+      let(:end_time) { past }
+
+      describe '#in_progress?' do
+        it 'is false' do
+          chronologicable.should_not be_in_progress
+        end
+      end
+    end
+
+    context 'and ends now' do
+      let(:end_time) { now }
+
+      describe '#in_progress?' do
+        it 'is false' do
+          chronologicable.should_not be_in_progress
+        end
+      end
+    end
+
+    context 'and ends later' do
+      let(:end_time) { later }
+
+      describe '#in_progress?' do
+        it 'is true' do
+          chronologicable.should     be_in_progress
+        end
+      end
+    end
+  end
+
+  context 'when there is a chronologicable that starts now' do
+    let(:start_time) { now }
+
+    context 'and ends now' do
+      let(:end_time) { now }
+
+      describe '#in_progress?' do
+        it 'is false' do
+          chronologicable.should_not be_in_progress
+        end
+      end
+    end
+
+    context 'and ends later' do
+      let(:end_time) { later }
+
+      describe '#in_progress?' do
+        it 'is true' do
+          chronologicable.should     be_in_progress
+        end
+      end
+    end
+  end
+
+  context 'when there is a chronologicable that has not yet started' do
+    let(:start_time) { later }
+    let(:end_time)   { later }
+
+    describe '#in_progress?' do
+      it 'is false' do
+        chronologicable.should_not be_in_progress
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'sqlite3'
+require 'active_record'
+require 'timecop'
+require 'chronological'
+
+Dir[File.expand_path('../support/**/*.rb',   __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.before(:all) 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 :chronologicables do |t|
+          t.datetime :started_at_utc
+          t.datetime :ended_at_utc
+        end
+      end
+    end
+
+    SetupTests.new.migrate(:up)
+  end
+
+  config.after(:all) do
+    `rm -f ./tmp/test.db`
+  end
+end

data/spec/support/focused.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  # Configure RSpec to run focused specs, and also respect the alias 'fit' for focused specs
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run       :focused => true
+  config.alias_example_to :fit, :focused => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/pending.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  # Configure RSpec to respect the alias 'pit' for pending specs
+  config.alias_example_to :pit, :pending => true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronological
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,152 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
-dependencies: []
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.8
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
 description: ''
 email: support@chirrpy.com
 executables: []
@@ -25,6 +169,10 @@ files:
 - Rakefile
 - README.md
 - LICENSE
+- spec/chronological_spec.rb
+- spec/spec_helper.rb
+- spec/support/focused.rb
+- spec/support/pending.rb
 homepage: https://github.com/chirrpy/chronological
 licenses: []
 post_install_message: 
@@ -50,4 +198,8 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Easy Accessors for ActiveModel Objects
-test_files: []
+test_files:
+- spec/chronological_spec.rb
+- spec/spec_helper.rb
+- spec/support/focused.rb
+- spec/support/pending.rb