business_time 0.4.0 → 0.6.1

data/README.rdoc

@@ -1,5 +1,7 @@
 = business_time
 
+{<img src="https://secure.travis-ci.org/bokmann/business_time.png" />}[http://travis-ci.org/bokmann/business_time]
+
 ActiveSupport gives us some great helpers so we can do things like:
 
   5.days.ago
@@ -80,6 +82,21 @@ I needed this, but taking into account business hours/days and holidays.
     friday = Date.parse("December 24, 2010")
     monday = Date.parse("December 27, 2010")
     friday.business_days_until(monday) #=> 1
+    
+    # or you can calculate business duration between two Time objects
+    ticket_reported = Time.parse("February 3, 2012, 10:40 am")
+    ticket_resolved = Time.parse("February 4, 2012, 10:50 am")
+    ticket_reported.business_time_until(ticket_resolved) #=> 8.hours + 10.minutes
+
+    # note that counterintuitively, durations might not be quite what you expect when involving weekends.
+    # Consider the following example:
+    ticket_reported = Time.parse("February 3, 2012, 10:40 am")
+    ticket_resolved = Time.parse("February 4, 2012, 10:40 am")
+    ticket_reported.business_time_until(ticket_resolved) # will equal 6 hours and 20 minutes!
+
+    # why does this happen?  Feb 4 2012 is a Saturday.  That time will roll over to
+    # Monday, Feb 6th 2012, 9:00am.  The business time between 10:40am friday and 9am monday is
+    # 6 hours and 20 minutes. From a quick inspection of the code, it looks like it should be 8 hours.
 
 == Usage in Rails
 The code above should work on a rails console without any issue.  You will want to add a line something like:
@@ -114,6 +131,13 @@ This gem strives to be timezone-agnostic.  Due to some complications in the hand
  
 This can lead to some wierd looking effects if, say, you are in the Eastern time zone but doing everything in UTC times...  Your business day will appear to start and end at 9:00 and 5:00 UTC.  If this seems perplexing to you, I can almost guarantee you are in over your head with timezones in other ways too, this is just the first place you encountered it.  Timezone relative date handling gets more and more complicated every time you look at it and takes a long time before it starts to seem simple again.  I'm hoping Arild and I write some good blog entries on the subject at http://blog.codesherpas.com.
 
+== Integration with the Holidays gem
+
+	Chris Wise wrote up a great article[http://murmurinfo.wordpress.com/2012/01/11/handling-holidays-and-business-hours/] on using the business_time gem with the holidays[https://github.com/HealthyWeb/holidays] gem. It boils down to this:
+
+  Holidays.between(Date.civil(2011, 1, 1), 2.years.from_now, :ca_on, :o bserved).map{|holiday| BusinessTime::Config.holidays << holiday[:date]}
+
+
 == Contributors
  * David Bock  http://github.com/bokmann
  * Enrico Bianco  http://github.com/enricob
@@ -149,11 +173,7 @@ This can lead to some wierd looking effects if, say, you are in the Eastern time
 * While there have been requests to add 'business minutes' and even 'business seconds' to this gem, I won't
   entertain a pullup request with such things.  If you find it useful, great.  Most users won't, and they don't
   need the baggage.
-* I'm torn on the inclusion of some kind of business_duration_between two Times, for the following reasons:
-  * As a duration, it will be in seconds.  This would naturally be business-seconds, which I trimmed out above.
-  * The logic is complex and error prone.
-  * There is no logical place to put it, as most of this gem mirrors the Timehelpers in ActiveSupport.
-  As a result I'm unlikely to add it unless I have an epiphany or someone wows me with an awesome pullup request.
+
   
 == Copyright
 

data/lib/business_time.rb

@@ -1,8 +1,10 @@
+require 'thread'
 require "active_support"
+require 'active_support/time'
 require "time"
 require "business_time/config"
 require "business_time/business_hours"
 require "business_time/business_days"
 require "extensions/date"
 require "extensions/time"
-require "extensions/fixnum"
+require "extensions/fixnum"

data/lib/business_time/business_days.rb

@@ -1,5 +1,7 @@
-module BusinessTime
+require 'active_support/time'
 
+module BusinessTime
+  
   class BusinessDays
     def initialize(days)
       @days = days

data/lib/business_time/business_hours.rb

@@ -31,6 +31,7 @@ module BusinessTime
       end
       after_time
     end
+    alias_method :since, :after
 
     def before(time)
       before_time = Time.roll_forward(time)

data/lib/business_time/config.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext'
+
 module BusinessTime
   
   # controls the behavior of this gem.  You can change
@@ -71,8 +73,7 @@ module BusinessTime
       self.end_of_workday = data["business_time"]["end_of_workday"]
       self.work_week = data["business_time"]["work_week"]
       data["business_time"]["holidays"].each do |holiday|
-        self.holidays <<
-          Time.zone ? Time.zone.parse(holiday) : Time.parse(holiday)
+        self.holidays << (Time.zone ? Time.zone.parse(holiday) : Time.parse(holiday))
       end
       
     end

data/lib/business_time/version.rb

@@ -1,3 +1,3 @@
 module BusinessTime
-  VERSION = "0.4.0"
+  VERSION = "0.6.1"
 end

data/lib/extensions/time.rb

@@ -63,3 +63,42 @@ class Time
 
   end
 end
+
+class Time
+
+  def business_time_until(to_time)
+
+    # Make sure that we will calculate time from A to B "clockwise"
+    direction = 1
+    if self < to_time
+      time_a = self
+      time_b = to_time
+    else
+      time_a = to_time
+      time_b = self
+      direction = -1
+    end
+    
+    # Align both times to the closest business hours
+    time_a = Time::roll_forward(time_a)
+    time_b = Time::roll_forward(time_b)
+    
+    # If same date, then calculate difference straight forward
+    if time_a.to_date == time_b.to_date
+      result = time_b - time_a
+      return result *= direction
+    end
+    
+    # Both times are in different dates
+    result = Time.parse(time_a.strftime('%Y-%m-%d ') + BusinessTime::Config.end_of_workday) - time_a   # First day
+    result += time_b - Time.parse(time_b.strftime('%Y-%m-%d ') + BusinessTime::Config.beginning_of_workday) # Last day
+    
+    # All days in between
+    duration_of_working_day = Time.parse(BusinessTime::Config.end_of_workday) - Time.parse(BusinessTime::Config.beginning_of_workday)
+    result += (time_a.to_date.business_days_until(time_b.to_date) - 1) * duration_of_working_day
+    
+    # Make sure that sign is correct
+    result *= direction
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: business_time
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 5
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 0
-  version: 0.4.0
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - bokmann
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-25 00:00:00 Z
+date: 2012-04-12 00:00:00 -04:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -25,18 +26,50 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 3
         segments: 
-        - 2
-        - 0
+        - 3
+        - 1
         - 0
-        version: 2.0.0
+        version: 3.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: tzinfo
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 0
+        - 3
+        - 31
+        version: 0.3.31
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,11 +79,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rdoc
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,7 +93,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id005
 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: []
@@ -84,6 +117,7 @@ files:
 - 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
+has_rdoc: true
 homepage: http://github.com/bokmann/business_time
 licenses: []
 
@@ -113,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Support for doing time math in business hours and days