business_time 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 bokmann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,92 @@
+= business_time
+
+ActiveSupport gives us some great helpers so we can do things like:
+
+  5.days.ago
+
+and
+
+  8.hours.from_now
+
+as well as helpers to do that from any provided date or time.
+
+I needed this, but taking into account business hours/days and holidays.
+
+== Usage
+* install the gem
+
+    gem install business_time
+    
+  or
+  
+    sudo gem install business_time
+    
+  if you require sudo to install gems
+  
+* open up your console
+
+    # if in irb, add these lines:
+  
+    require 'rubygems'
+    require 'active_support'
+    require 'business_time'
+
+    # try these examples, using the current time:
+  
+    1.business_hour.from_now
+    4.business_hours.from_now
+    8.business_hours.from_now
+
+    1.business_hour.ago
+    4.business_hours.ago
+    8.business_hours.ago
+
+    1.business_day.from_now
+    4.business_days.from_now
+    8.business_days.from_now
+
+    1.business_day.ago
+    4.business_days.ago
+    8.business_days.ago
+
+    # and we can do it from any Date or Time object.
+    my_birthday = Date.parse("August 4th, 1969")
+    8.business_days.after(my_birthday)
+    8.business_days.before(my_birthday)
+
+    my_birthday = Time.parse("August 4th, 1969, 8:32 am")
+    8.business_days.after(my_birthday)
+    8.business_days.before(my_birthday)
+
+
+    # We can adjust the start and end time of our business hours
+    BusinessTime::Config.beginning_of_workday = "8:30 am"
+    BusinessTime::Config.end_of_workday = "5:30 pm"
+
+    # and we can add holidays that don't count as business days
+    # July 5 in 2010 is a monday that the U.S. takes off because our independence day falls on that Sunday.
+    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_morning = 1.business_hour.after(friday_afternoon)
+
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== TODO
+* I'd like to return ActiveSupport::TimeWithZone just like the equivalent ActiveSupport helpers do.
+* if it doesn't pollute the logic too much, I'd like to vary the days counted as 'business days'.  Bakers often don't work on Mondays, for instance.
+* We don't care much about timezones.  Dunno if thats an issue.
+
+== Copyright
+
+Copyright (c) 2010 bokmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "business_time"
+    gem.summary = %Q{Support for doing time math in business hours and days}
+    gem.description = %Q{Have you ever wanted to do things like "6.business_days.from_now" and have weekends and holidays taken into account?  Now you can.}
+    gem.email = "dbock@codesherpas.com"
+    gem.homepage = "http://github.com/bokmann/business_time"
+    gem.authors = ["bokmann"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency('activesupport','>= 2.0.0')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "business_time #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/business_time.rb

@@ -0,0 +1,6 @@
+require "business_time/config"
+require "business_time/business_hours"
+require "business_time/business_days"
+require "extensions/date"
+require "extensions/time"
+require "extensions/fixnum"

data/lib/business_time/business_days.rb

@@ -0,0 +1,35 @@
+module BusinessTime
+
+  class BusinessDays
+    def initialize(days)
+      @days = days
+    end
+
+    def ago
+      before(Time.now)
+    end
+
+    def from_now
+      after(Time.now)
+    end
+
+    def after(time)
+      @days.times do
+        begin
+          time = time + 1.day
+        end until time.workday?
+      end
+      time
+    end
+
+    def before(time)
+      @days.times do
+        begin
+          time = time - 1.day
+        end until time.workday?
+      end
+      time
+    end
+  end  
+  
+end

data/lib/business_time/business_hours.rb

@@ -0,0 +1,54 @@
+module BusinessTime
+
+  class BusinessHours
+    def initialize(hours)
+      @hours = hours
+    end
+    
+    def ago
+      before(Time.now)
+    end
+    
+    def from_now
+      after(Time.now)
+    end
+     
+    def after(time)
+      @hours.times do 
+        time = time + 1.hour  #add an hour
+        
+        if (time > time.end_of_workday)
+          time = time + off_hours  # if that pushes us past business hours,
+        end                        # roll into the next day
+        
+        while !time.workday?
+          time = time + 1.day      # if that pushes us into a non-business day,
+        end                        # find the next business day
+      end
+      time
+    end
+            
+    def before(time)
+      @hours.times do 
+        time = time - 1.hour  #add an hour
+        
+        if (time < time.beginning_of_workday)
+          time = time - off_hours  # if that pushes us before business hours,
+        end                        # roll into the previous day
+        
+        while !time.workday?
+          time = time - 1.day      # if that pushes us into a non-business day,
+        end                        # find the previous business day
+      end
+      time
+    end
+    
+    private
+    
+    def off_hours
+      @gap ||= Time.parse(BusinessTime::Config.beginning_of_workday) - 
+              (Time.parse(BusinessTime::Config.end_of_workday) - 1.day)
+    end
+  end
+  
+end

data/lib/business_time/config.rb

@@ -0,0 +1,17 @@
+module BusinessTime
+  
+  # controls the behavior of the code.  You can change
+  # the beginning_of_workday, end_of_workday, and the list of holidays
+  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"
+  end
+  
+end

data/lib/extensions/date.rb

@@ -0,0 +1,10 @@
+# Add workday and weekday concepts to the Date class
+class Date
+  def workday?
+    self.weekday? && !BusinessTime::Config.holidays.include?(self)
+  end
+  
+  def weekday?
+    [1,2,3,4,5].include? self.wday
+  end
+end

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,18 @@
+# Add workday and weekday concepts to the Time class
+class Time
+  def end_of_workday
+    Time.parse self.strftime("%B %d %Y #{BusinessTime::Config.end_of_workday}")  
+  end
+  
+  def beginning_of_workday
+    Time.parse self.strftime("%B %d %Y #{BusinessTime::Config.beginning_of_workday}")
+  end
+  
+  def workday?
+    self.weekday? && !BusinessTime::Config.holidays.include?(self.to_date)
+  end
+  
+  def weekday?
+    [1,2,3,4,5].include? self.wday
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'active_support'
+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,26 @@
+require 'helper'
+
+class TestBusinessDays < Test::Unit::TestCase
+  
+  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 expected == later
+  end
+  
+  should "move to yesterday is we subtract a business day"
+  
+  should "take into account the weekend when adding a day"
+  
+  should "move forward one week when adding 5 business days"
+  
+  should "take into account a holiday when adding a day"
+  
+  should "take into account a holiday on a weekend"
+  
+  should "take into account a holiday on a Monday"
+  
+  should "take into account a holiday on a Friday"
+  
+end

data/test/test_business_hours.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestBusinessHours < Test::Unit::TestCase
+  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")
+  end
+  
+  should "move to yesterday is we subtract 8 business hours"
+  
+  should "take into account a weekend"
+  
+  should "take into account a holiday"
+  
+  should "add hours in the middle of the workday"
+  
+  should "wrap to tomorrow if past the end of the workday"
+  
+  should "wrap to yesterday if past the beginning of the workday"
+  
+end

data/test/test_config.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestConfig < Test::Unit::TestCase
+  
+  should "keep track of the start of the day" do
+    assert BusinessTime::Config.beginning_of_workday == "9:00 am"
+    BusinessTime::Config.beginning_of_workday = "8:30 am"
+    assert BusinessTime::Config.beginning_of_workday == "8:30 am"
+  end
+  
+  should "keep track of the end of the day" do
+    assert BusinessTime::Config.end_of_workday == "5:00 pm"
+    BusinessTime::Config.end_of_workday = "5:30 pm"
+    assert BusinessTime::Config.end_of_workday == "5:30 pm"
+  end
+  
+  should "keep track of holidays" do
+    assert BusinessTime::Config.holidays.empty?
+    daves_birthday = Date.parse("August 4th, 1969")
+    BusinessTime::Config.holidays << daves_birthday
+    assert BusinessTime::Config.holidays.include?(daves_birthday)
+  end
+  
+end

data/test/test_date_extensions.rb

@@ -0,0 +1,16 @@
+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?)
+  end
+  
+  should "know a weekend day is not a workday"
+  
+  should "know a holiday is not a workday"
+  
+end

data/test/test_fixnum_extensions.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestFixnumExtensions < Test::Unit::TestCase
+  
+  should "respond to business_hours by returning an instance of BusinessHours" do
+    assert(1.respond_to?(:business_hour))
+    assert(1.respond_to?(:business_hours))
+    assert 1.business_hour.instance_of?(BusinessTime::BusinessHours)
+  end
+  
+  should "respond to business_days by returning an instance of BusinessDays" do
+    assert(1.respond_to?(:business_day))
+    assert(1.respond_to?(:business_days))
+    assert 1.business_day.instance_of?(BusinessTime::BusinessDays)
+  end
+  
+end

data/test/test_time_extensions.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestTimeExtensions < Test::Unit::TestCase
+  
+  should "know what a weekend day is" do
+    assert(Time.parse("April 9, 2010 10:30am").weekday?)
+    assert(!Time.parse("April 10, 2010 10:30am").weekday?)
+    assert(!Time.parse("April 11, 2010 10:30am").weekday?)
+    assert(Time.parse("April 12, 2010 10:30am").weekday?)
+  end
+  
+  should "know a weekend day is not a workday"
+  
+  should "know a holiday is not a workday"
+  
+  should "know the beginning of the day for an instance"
+  
+  should "know the end of the day for an instance"
+  
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: business_time
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- bokmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Have you ever wanted to do things like "6.business_days.from_now" and have weekends and holidays taken into account?  Now you can.
+email: dbock@codesherpas.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/business_time.rb
+- lib/business_time/business_days.rb
+- lib/business_time/business_hours.rb
+- lib/business_time/config.rb
+- lib/extensions/date.rb
+- lib/extensions/fixnum.rb
+- lib/extensions/time.rb
+- test/helper.rb
+- test/test_business_days.rb
+- test/test_business_hours.rb
+- test/test_config.rb
+- test/test_date_extensions.rb
+- test/test_fixnum_extensions.rb
+- test/test_time_extensions.rb
+has_rdoc: true
+homepage: http://github.com/bokmann/business_time
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Support for doing time math in business hours and days
+test_files: 
+- test/helper.rb
+- test/test_business_days.rb
+- test/test_business_hours.rb
+- test/test_config.rb
+- test/test_date_extensions.rb
+- test/test_fixnum_extensions.rb
+- test/test_time_extensions.rb