alphasights-business_time 0.3.0

data/lib/extensions/fixnum.rb

@@ -0,0 +1,18 @@
+# hook into fixnum so we can say things like:
+#  5.business_hours.from_now
+#  7.business_days.ago
+#  3.business_days.after(some_date)
+#  4.business_hours.before(some_date_time)
+class Fixnum
+  include BusinessTime
+  
+  def business_hours
+    BusinessHours.new(self)
+  end
+  alias_method :business_hour, :business_hours
+  
+  def business_days
+    BusinessDays.new(self)
+  end
+  alias_method :business_day, :business_days  
+end

data/lib/extensions/time.rb

@@ -0,0 +1,109 @@
+# Add workday and weekday concepts to the Time class
+class Time
+  class << self
+
+    # Gives the time at the end of the workday, assuming that this time falls on a
+    # workday.
+    # Note: It pretends that this day is a workday whether or not it really is a
+    # workday.
+    def end_of_workday(day)
+      format = "%B %d %Y #{BusinessTime::Config.end_of_workday}"
+      Time.zone ? Time.zone.parse(day.strftime(format)) :
+          Time.parse(day.strftime(format))
+    end
+
+    # Gives the time at the beginning of the workday, assuming that this time
+    # falls on a workday.
+    # Note: It pretends that this day is a workday whether or not it really is a
+    # workday.
+    def beginning_of_workday(day)
+      format = "%B %d %Y #{BusinessTime::Config.beginning_of_workday}"
+      Time.zone ? Time.zone.parse(day.strftime(format)) :
+          Time.parse(day.strftime(format))
+    end
+
+    # True if this time is on a workday (between 00:00:00 and 23:59:59), even if
+    # this time falls outside of normal business hours.
+    def workday?(day)
+      Time.weekday?(day) &&
+          !BusinessTime::Config.holidays.include?(day.to_date)
+    end
+
+    # True if this time falls on a weekday.
+    def weekday?(day)
+      # TODO AS: Internationalize this!
+      [1,2,3,4,5].include? day.wday
+    end
+
+    def before_business_hours?(time)
+      time < beginning_of_workday(time)
+    end
+
+    def after_business_hours?(time)
+      time > end_of_workday(time)
+    end
+
+    def during_business_hours?(time)
+      workday?(time) && !before_business_hours?(time) && !after_business_hours?(time)
+    end
+
+    # Rolls forward to the next beginning_of_workday
+    # when the time is outside of business hours
+    def roll_forward(time)
+
+      if (Time.before_business_hours?(time) || !Time.workday?(time))
+        next_business_time = Time.beginning_of_workday(time)
+      elsif Time.after_business_hours?(time)
+        next_business_time = Time.beginning_of_workday(time) + 1.day
+      else
+        next_business_time = time.clone
+      end
+
+      while !Time.workday?(next_business_time)
+        next_business_time += 1.day
+      end
+
+      next_business_time
+    end
+
+  end
+
+  def business_time_left_to(time)
+    if time.to_date == self.to_date
+    end
+    time_left = 0
+    start_day = self
+    while start_day.to_date < time.to_date
+      parsed_start_day = Time.parse(start_day.to_s)
+      time_left += start_day.business_time_left_to_end
+      start_day = Time.beginning_of_workday(parsed_start_day) + 1.day
+    end
+    time_left += time.business_time_passed_from_beginning
+    time_left
+  end
+
+  def business_time_left_to_end
+    time = Time.parse(self.to_s)
+    workday = Time.workday?(time)
+    if workday && Time.during_business_hours?(time)
+      Time.end_of_workday(time) - self
+    elsif Time.before_business_hours?(time) && workday
+      Time.end_of_workday(time) - Time.beginning_of_workday(time)
+    else
+      0
+    end
+  end
+
+  def business_time_passed_from_beginning
+    time = Time.parse(self.to_s)
+    workday = Time.workday?(time)
+    if workday && Time.during_business_hours?(time)
+      self - Time.beginning_of_workday(time)
+    elsif Time.after_business_hours?(time) && workday
+      Time.end_of_workday(time) - Time.beginning_of_workday(time)
+    else
+      0
+    end
+  end
+
+end

data/lib/generators/business_time/config_generator.rb

@@ -0,0 +1,21 @@
+module BusinessTime
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base # :nodoc:
+      
+      def self.gem_root
+        File.expand_path("../../../..", __FILE__)
+      end
+
+      def self.source_root
+        # Use the templates from the 2.3.x generator
+        File.join(gem_root, 'rails_generators', 'business_time_config', 'templates')
+      end
+      
+      def generate
+        template 'business_time.rb', File.join('config', 'initializers', 'business_time.rb')
+        template 'business_time.yml', File.join('config', 'business_time.yml')
+      end
+      
+    end
+  end
+end

data/rails_generators/business_time_config/business_time_config_generator.rb

@@ -0,0 +1,11 @@
+# This generator simply drops the business_time.rb and business_time.yml file
+# into the appropate places in a rails app to configure and initialize the
+# data.  Once generated, these files are yours to modify.
+class BusinessTimeConfigGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.template('business_time.rb', "config/initializers/business_time.rb")
+      m.template('business_time.yml', "config/business_time.yml")
+    end
+  end
+end

data/rails_generators/business_time_config/templates/business_time.rb

@@ -0,0 +1,6 @@
+BusinessTime::Config.load("#{RAILS_ROOT}/config/business_time.yml")
+
+# or you can configure it manually:  look at me!  I'm Tim Ferris!
+#  BusinessTime.Config.beginning_of_workday = "10:00 am"
+#  BusinessTime.Comfig.end_of_workday = "11:30 am"
+#  BusinessTime.config.holidays << Date.parse("August 4th, 2010")

data/rails_generators/business_time_config/templates/business_time.yml

@@ -0,0 +1,7 @@
+business_time:
+  beginning_of_workday: 9:00 am
+  end_of_workday: 5:00 pm
+  holidays:
+    - Jan 01, 2010
+    - July 4th, 2010
+    - December 25th, 2010

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+if RUBY_VERSION >= '1.9'
+  require 'time'
+  require 'date'
+  require 'active_support/time'
+else
+  require 'active_support'
+  require 'active_support/core_ext'
+end
+
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'business_time'
+
+class Test::Unit::TestCase
+end

data/test/test_business_days.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class TestBusinessDays < Test::Unit::TestCase
+  
+  context "with a standard Time object" do
+
+    should "move to tomorrow if we add a business day" do
+      first = Time.parse("April 13th, 2010, 11:00 am")
+      later = 1.business_day.after(first)
+      expected = Time.parse("April 14th, 2010, 11:00 am")
+      assert_equal expected, later
+    end
+  
+    should "move to yesterday is we subtract a business day" do
+      first = Time.parse("April 13th, 2010, 11:00 am")
+      before = 1.business_day.before(first)
+      expected = Time.parse("April 12th, 2010, 11:00 am")
+      assert_equal expected, before
+    end
+  
+    should "take into account the weekend when adding a day" do
+      first = Time.parse("April 9th, 2010, 12:33 pm")
+      after = 1.business_day.after(first)
+      expected = Time.parse("April 12th, 2010, 12:33 pm")
+      assert_equal expected, after
+    end
+  
+    should "take into account the weekend when subtracting a day" do
+      first = Time.parse("April 12th, 2010, 12:33 pm")
+      before = 1.business_day.before(first)
+      expected = Time.parse("April 9th, 2010, 12:33 pm")
+      assert_equal expected, before
+    end
+  
+    should "move forward one week when adding 5 business days" do
+      first = Time.parse("April 9th, 2010, 12:33 pm")
+      after = 5.business_days.after(first)
+      expected = Time.parse("April 16th, 2010, 12:33 pm")
+      assert_equal expected, after
+    end
+  
+    should "move backward one week when subtracting 5 business days" do
+      first = Time.parse("April 16th, 2010, 12:33 pm")
+      before = 5.business_days.before(first)
+      expected = Time.parse("April 9th, 2010, 12:33 pm")
+      assert_equal expected, before
+    end
+  
+    should "take into account a holiday when adding a day" do
+      three_day_weekend = Date.parse("July 5th, 2010")
+      BusinessTime::Config.holidays << three_day_weekend
+      friday_afternoon = Time.parse("July 2nd, 2010, 4:50 pm")
+      tuesday_afternoon = 1.business_day.after(friday_afternoon)
+      expected = Time.parse("July 6th, 2010, 4:50 pm")
+      assert_equal expected, tuesday_afternoon
+    end
+  
+    should "take into account a holiday on a weekend" do
+      BusinessTime::Config.reset
+      july_4 = Date.parse("July 4th, 2010")
+      BusinessTime::Config.holidays << july_4
+      friday_afternoon = Time.parse("July 2nd, 2010, 4:50 pm")
+      monday_afternoon = 1.business_day.after(friday_afternoon)
+      expected = Time.parse("July 5th, 2010, 4:50 pm")
+      assert_equal expected, monday_afternoon
+    end
+  end
+  
+end

data/test/test_business_days_eastern.rb

@@ -0,0 +1,75 @@
+require 'helper'
+
+class TestBusinessDays < Test::Unit::TestCase
+  
+  context "with a TimeWithZone object set to the Eastern timezone" do
+    setup do
+      Time.zone = 'Eastern Time (US & Canada)'
+    end
+    teardown do
+      Time.zone = nil
+    end
+    
+    should "move to tomorrow if we add a business day" do
+      first = Time.zone.parse("April 13th, 2010, 11:00 am")
+      later = 1.business_day.after(first)
+      expected = Time.zone.parse("April 14th, 2010, 11:00 am")
+      assert_equal expected, later
+    end
+
+    should "move to yesterday is we subtract a business day" do
+      first = Time.zone.parse("April 13th, 2010, 11:00 am")
+      before = 1.business_day.before(first)
+      expected = Time.zone.parse("April 12th, 2010, 11:00 am")
+      assert_equal expected, before
+    end
+
+    should "take into account the weekend when adding a day" do
+      first = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      after = 1.business_day.after(first)
+      expected = Time.zone.parse("April 12th, 2010, 12:33 pm")
+      assert_equal expected, after
+    end
+
+    should "take into account the weekend when subtracting a day" do
+      first = Time.zone.parse("April 12th, 2010, 12:33 pm")
+      before = 1.business_day.before(first)
+      expected = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      assert_equal expected, before
+    end
+
+    should "move forward one week when adding 5 business days" do
+      first = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      after = 5.business_days.after(first)
+      expected = Time.zone.parse("April 16th, 2010, 12:33 pm")
+      assert_equal expected, after
+    end
+
+    should "move backward one week when subtracting 5 business days" do
+      first = Time.zone.parse("April 16th, 2010, 12:33 pm")
+      before = 5.business_days.before(first)
+      expected = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      assert_equal expected, before
+    end
+
+    should "take into account a holiday when adding a day" do
+      three_day_weekend = Date.parse("July 5th, 2010")
+      BusinessTime::Config.holidays << three_day_weekend
+      friday_afternoon = Time.zone.parse("July 2nd, 2010, 4:50 pm")
+      tuesday_afternoon = 1.business_day.after(friday_afternoon)
+      expected = Time.zone.parse("July 6th, 2010, 4:50 pm")
+      assert_equal expected, tuesday_afternoon
+    end
+
+    should "take into account a holiday on a weekend" do
+      BusinessTime::Config.reset
+      july_4 = Date.parse("July 4th, 2010")
+      BusinessTime::Config.holidays << july_4
+      friday_afternoon = Time.zone.parse("July 2nd, 2010, 4:50 pm")
+      monday_afternoon = 1.business_day.after(friday_afternoon)
+      expected = Time.zone.parse("July 5th, 2010, 4:50 pm")
+      assert_equal expected, monday_afternoon
+    end
+  end
+  
+end

data/test/test_business_days_utc.rb

@@ -0,0 +1,75 @@
+require 'helper'
+
+class TestBusinessDays < Test::Unit::TestCase
+  
+  context "with a TimeWithZone object set to UTC" do
+    setup do
+      Time.zone = 'UTC'
+    end
+    teardown do
+      Time.zone = nil
+    end
+    
+    should "move to tomorrow if we add a business day" do
+      first = Time.zone.parse("April 13th, 2010, 11:00 am")
+      later = 1.business_day.after(first)
+      expected = Time.zone.parse("April 14th, 2010, 11:00 am")
+      assert_equal expected, later
+    end
+
+    should "move to yesterday is we subtract a business day" do
+      first = Time.zone.parse("April 13th, 2010, 11:00 am")
+      before = 1.business_day.before(first)
+      expected = Time.zone.parse("April 12th, 2010, 11:00 am")
+      assert_equal expected, before
+    end
+
+    should "take into account the weekend when adding a day" do
+      first = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      after = 1.business_day.after(first)
+      expected = Time.zone.parse("April 12th, 2010, 12:33 pm")
+      assert_equal expected, after
+    end
+
+    should "take into account the weekend when subtracting a day" do
+      first = Time.zone.parse("April 12th, 2010, 12:33 pm")
+      before = 1.business_day.before(first)
+      expected = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      assert_equal expected, before
+    end
+
+    should "move forward one week when adding 5 business days" do
+      first = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      after = 5.business_days.after(first)
+      expected = Time.zone.parse("April 16th, 2010, 12:33 pm")
+      assert_equal expected, after
+    end
+
+    should "move backward one week when subtracting 5 business days" do
+      first = Time.zone.parse("April 16th, 2010, 12:33 pm")
+      before = 5.business_days.before(first)
+      expected = Time.zone.parse("April 9th, 2010, 12:33 pm")
+      assert_equal expected, before
+    end
+
+    should "take into account a holiday when adding a day" do
+      three_day_weekend = Date.parse("July 5th, 2010")
+      BusinessTime::Config.holidays << three_day_weekend
+      friday_afternoon = Time.zone.parse("July 2nd, 2010, 4:50 pm")
+      tuesday_afternoon = 1.business_day.after(friday_afternoon)
+      expected = Time.zone.parse("July 6th, 2010, 4:50 pm")
+      assert_equal expected, tuesday_afternoon
+    end
+
+    should "take into account a holiday on a weekend" do
+      BusinessTime::Config.reset
+      july_4 = Date.parse("July 4th, 2010")
+      BusinessTime::Config.holidays << july_4
+      friday_afternoon = Time.zone.parse("July 2nd, 2010, 4:50 pm")
+      monday_afternoon = 1.business_day.after(friday_afternoon)
+      expected = Time.zone.parse("July 5th, 2010, 4:50 pm")
+      assert_equal expected, monday_afternoon
+    end
+  end
+
+end

data/test/test_business_hours.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class TestBusinessHours < Test::Unit::TestCase
+
+  context "with a standard Time object" do
+
+    should "move to tomorrow if we add 8 business hours" do
+      first = Time.parse("Aug 4 2010, 9:35 am")
+      later = 8.business_hours.after(first)
+      expected = Time.parse("Aug 5 2010, 9:35 am")
+      assert_equal expected, later
+    end
+
+    should "move to yesterday if we subtract 8 business hours" do
+      first = Time.parse("Aug 4 2010, 9:35 am")
+      later = 8.business_hours.before(first)
+      expected = Time.parse("Aug 3 2010, 9:35 am")
+      assert_equal expected, later
+    end
+
+    should "take into account a weekend when adding an hour" do
+      friday_afternoon = Time.parse("April 9th, 4:50 pm")
+      monday_morning = 1.business_hour.after(friday_afternoon)
+      expected = Time.parse("April 12th 2010, 9:50 am")
+      assert_equal expected, monday_morning
+    end
+
+    should "take into account a weekend when subtracting an hour" do
+      monday_morning = Time.parse("April 12th 2010, 9:50 am")
+      friday_afternoon = 1.business_hour.before(monday_morning)
+      expected = Time.parse("April 9th 2010, 4:50 pm")
+      assert_equal expected, friday_afternoon
+    end
+
+    should "take into account a holiday" do
+      BusinessTime::Config.holidays << Date.parse("July 5th, 2010")
+      friday_afternoon = Time.parse("July 2nd 2010, 4:50pm")
+      tuesday_morning = 1.business_hour.after(friday_afternoon)
+      expected = Time.parse("July 6th 2010, 9:50 am")
+      assert_equal expected, tuesday_morning
+    end
+
+    should "add hours in the middle of the workday"  do
+      monday_morning = Time.parse("April 12th 2010, 9:50 am")
+      later = 3.business_hours.after(monday_morning)
+      expected = Time.parse("April 12th 2010, 12:50 pm")
+      assert_equal expected, later
+    end
+
+    should "roll forward to 9 am if asked in the early morning" do
+      crack_of_dawn_monday = Time.parse("Mon Apr 26, 04:30:00, 2010")
+      monday_morning = Time.parse("Mon Apr 26, 09:00:00, 2010")
+      assert_equal monday_morning, Time.roll_forward(crack_of_dawn_monday)
+    end
+
+    should "roll forward to the next morning if aftern business hours" do
+      monday_evening = Time.parse("Mon Apr 26, 18:00:00, 2010")
+      tuesday_morning = Time.parse("Tue Apr 27, 09:00:00, 2010")
+      assert_equal tuesday_morning, Time.roll_forward(monday_evening)
+    end
+
+    should "consider any time on a weekend as equivalent to monday morning" do
+      sunday = Time.parse("Sun Apr 25 12:06:56, 2010")
+      monday = Time.parse("Mon Apr 26, 09:00:00, 2010")
+      assert_equal 1.business_hour.before(monday), 1.business_hour.before(sunday)
+    end
+  end
+
+end