business_time 0.1.0 → 0.2.0

data/README.rdoc

@@ -70,8 +70,31 @@ I needed this, but taking into account business hours/days and holidays.
     friday_afternoon = Time.parse("July 2nd, 2010, 4:50 pm")
     tuesday_morning = 1.business_hour.after(friday_afternoon)
 
+== Usage in Rails
+The code above should work on a rails console without any issue.  You will want to add a line something like:
 
+    config.gem "business_time"
 
+to your environment.rb file. Or if you're using bundler, add this line to your Gemfile:
+
+    gem "business_time"
+
+This gem also includes a generator so you can bootstrap some stuff in your environment:
+
+    ./script/generate business_time_config
+    
+Or in Rails 3:
+
+    script/rails generate business_time:config
+    
+The generator will add a /config/business_time.yml and a /config/initializers/business_time.rb file that will cause the start of business day, the end of business day, and your holidays to be loaded from the yaml file.  You might want to programatically load your holidays from a database table, but you will want to pay attention to how the initializer works - you will want to make sure that the initializer sets stuff up appropriately so rails instances on mongrels or passenger will have the appropriate data as they come up and down.
+
+== Outside of Rails
+This code does depend on ActiveSupport, but nothing else within rails.  Even then, it would be pretty easy to break that dependency as well (but would add some code bloat and remove some clarity).  Feel free to use it on any ruby project you'd like!
+
+== Contributors
+ * David Bock  http://github.com/bokmann
+ * Enrico Bianco  http://github.com/enricob
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gem.authors = ["bokmann"]
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     gem.add_dependency('activesupport','>= 2.0.0')
+    gem.files += FileList['lib/generators/**/*.rb']
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/business_time/config.rb

@@ -2,16 +2,41 @@ module BusinessTime
   
   # controls the behavior of the code.  You can change
   # the beginning_of_workday, end_of_workday, and the list of holidays
+  #manually, or with a yaml file and the load method.
   class Config
     class << self
       attr_accessor :beginning_of_workday
       attr_accessor :end_of_workday
       attr_accessor :holidays
-  
     end
-    self.holidays = []
-    self.beginning_of_workday = "9:00 am"
-    self.end_of_workday = "5:00 pm"
+    
+    def self.reset
+      self.holidays = []
+      self.beginning_of_workday = "9:00 am"
+      self.end_of_workday = "5:00 pm"
+    end
+    
+    # loads the config data from a yaml file written as:
+    # business_time:
+    #   beginning_od_workday: 8:30 am
+    #   end_of_workday: 5:30 pm
+    #   holidays:
+    #     - Jan 1st, 2010
+    #     - July 4th, 2010
+    #     - Dec 25th, 2010
+    def self.load(filename)
+      self.reset
+      data = YAML::load(File.open(filename))
+      self.beginning_of_workday = data["business_time"]["beginning_of_workday"]
+      self.end_of_workday = data["business_time"]["end_of_workday"]
+      data["business_time"]["holidays"].each do |holiday|
+        self.holidays << Date.parse(holiday)
+      end
+      
+    end
+    
+    #reset the first time we are loaded.
+    self.reset
   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

@@ -1,5 +1,13 @@
 require 'rubygems'
-require 'active_support'
+
+if RUBY_VERSION >= '1.9'
+  require 'time'
+  require 'date'
+  require 'active_support/time'
+else
+  require 'active_support'
+end
+
 require 'test/unit'
 require 'shoulda'
 

data/test/test_business_days.rb

@@ -9,18 +9,59 @@ class TestBusinessDays < Test::Unit::TestCase
     assert expected == later
   end
   
-  should "move to yesterday is we subtract a business day"
+  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 expected == before
+  end
   
-  should "take into account the weekend when adding a day"
+  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 expected == after
+  end
   
-  should "move forward one week when adding 5 business days"
+  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 expected == before
+  end
   
-  should "take into account a holiday when adding a day"
+  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 expected == after
+  end
   
-  should "take into account a holiday on a weekend"
+  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 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 expected == tuesday_afternoon
+  end
   
-  should "take into account a holiday on a Monday"
   
-  should "take into account a holiday on a Friday"
+  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 expected == monday_afternoon
+  end
   
 end

data/test/test_business_hours.rb

@@ -5,18 +5,43 @@ class TestBusinessHours < Test::Unit::TestCase
     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 expected == later
   end
   
-  should "move to yesterday is we subtract 8 business hours"
-  
-  should "take into account a weekend"
+  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 expected == later
+  end
   
-  should "take into account a holiday"
+  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 expected == monday_morning
+  end
   
-  should "add hours in the middle of the workday"
+  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 expected == friday_afternoon
+  end
   
-  should "wrap to tomorrow if past the end of the workday"
+  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 expected == tuesday_morning
+  end
   
-  should "wrap to yesterday if past the beginning of the workday"
+  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 expected == later
+  end
   
 end

data/test/test_config.rb

@@ -15,6 +15,7 @@ class TestConfig < Test::Unit::TestCase
   end
   
   should "keep track of holidays" do
+    BusinessTime::Config.reset
     assert BusinessTime::Config.holidays.empty?
     daves_birthday = Date.parse("August 4th, 1969")
     BusinessTime::Config.holidays << daves_birthday

data/test/test_date_extensions.rb

@@ -3,14 +3,31 @@ require 'helper'
 class TestDateExtensions < Test::Unit::TestCase
   
   should "know what a weekend day is"  do
-    assert(Time.parse("April 9, 2010").weekday?)
-    assert(!Time.parse("April 10, 2010").weekday?)
-    assert(!Time.parse("April 11, 2010").weekday?)
-    assert(Time.parse("April 12, 2010").weekday?)
+    assert(Date.parse("April 9, 2010").weekday?)
+    assert(!Date.parse("April 10, 2010").weekday?)
+    assert(!Date.parse("April 11, 2010").weekday?)
+    assert(Date.parse("April 12, 2010").weekday?)
   end
   
-  should "know a weekend day is not a workday"
+  should "know a weekend day is not a workday"  do
+    assert(Date.parse("April 9, 2010").workday?)
+    assert(!Date.parse("April 10, 2010").workday?)
+    assert(!Date.parse("April 11, 2010").workday?)
+    assert(Date.parse("April 12, 2010").workday?)
+  end
   
-  should "know a holiday is not a workday"
+  should "know a holiday is not a workday" do
+    july_4 = Date.parse("July 4, 2010")
+    july_5 = Date.parse("July 5, 2010")
+    
+    assert(!july_4.workday?)
+    assert(july_5.workday?)
+    
+    BusinessTime::Config.holidays << july_4
+    BusinessTime::Config.holidays << july_5
+    
+    assert(!july_4.workday?)
+    assert(!july_5.workday?)
+  end
   
 end

data/test/test_time_extensions.rb

@@ -9,12 +9,34 @@ class TestTimeExtensions < Test::Unit::TestCase
     assert(Time.parse("April 12, 2010 10:30am").weekday?)
   end
   
-  should "know a weekend day is not a workday"
+  should "know a weekend day is not a workday" do
+    assert(Time.parse("April 9, 2010 10:45 am").workday?)
+    assert(!Time.parse("April 10, 2010 10:45 am").workday?)
+    assert(!Time.parse("April 11, 2010 10:45 am").workday?)
+    assert(Time.parse("April 12, 2010 10:45 am").workday?)
+  end
   
-  should "know a holiday is not a workday"
+  should "know a holiday is not a workday" do
+    BusinessTime::Config.reset
+    
+    BusinessTime::Config.holidays << Date.parse("July 4, 2010")
+    BusinessTime::Config.holidays << Date.parse("July 5, 2010")
+    
+    assert(!Time.parse("July 4th, 2010 1:15 pm").workday?)
+    assert(!Time.parse("July 5th, 2010 2:37 pm").workday?)
+  end
   
-  should "know the beginning of the day for an instance"
   
-  should "know the end of the day for an instance"
+  should "know the beginning of the day for an instance" do
+    first = Time.parse("August 17th, 2010, 11:50 am")
+    expecting = Time.parse("August 17th, 2010, 9:00 am")
+    assert expecting == first.beginning_of_workday
+  end
+  
+  should "know the end of the day for an instance" do
+    first = Time.parse("August 17th, 2010, 11:50 am")
+    expecting = Time.parse("August 17th, 2010, 5:00 pm")
+    assert expecting == first.end_of_workday
+  end
   
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - bokmann
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -04:00
+date: 2010-04-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,10 @@ files:
 - lib/extensions/date.rb
 - lib/extensions/fixnum.rb
 - lib/extensions/time.rb
+- lib/generators/business_time/config_generator.rb
+- rails_generators/business_time_config/business_time_config_generator.rb
+- rails_generators/business_time_config/templates/business_time.rb
+- rails_generators/business_time_config/templates/business_time.yml
 - test/helper.rb
 - test/test_business_days.rb
 - test/test_business_hours.rb