business_time 0.3.0 → 0.3.1

data/README.rdoc

@@ -70,6 +70,11 @@ 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)
 
+		# you can also calculate business duration between two dates
+		friday = Date.parse("December 24, 2010")
+    monday = Date.parse("December 27, 2010")
+		friday.business_days_until(monday) #=> 1
+
 == Usage in Rails
 The code above should work on a rails console without any issue.  You will want to add a line something like:
 
@@ -94,8 +99,12 @@ This code does depend on ActiveSupport, but nothing else within rails.  Even the
 
 == Timezone support
 This gem strives to be timezone-agnostic.  Due to some complications in the handling of timezones in the built in Time class, and some complexities (bugs?) in the timeWithZone class, this was harder than expected... but here's the idea:
- * When you configure the gem with something like 9:00am as the start time, this is agnostic of time zone.
- * When you are dealing with a Time or TimeWithZone class, the timezone is preserved and the beginning and end of times for the business day are referenced in that time zone.
+
+* When you configure the gem with something like 9:00am as the start time,
+  this is agnostic of time zone.
+* When you are dealing with a Time or TimeWithZone class, the timezone is
+  preserved and the beginning and end of times for the business day are
+  referenced in that time zone.
  
 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.
 
@@ -103,6 +112,7 @@ This can lead to some wierd looking effects if, say, you are in the Eastern time
  * David Bock  http://github.com/bokmann
  * Enrico Bianco  http://github.com/enricob
  * Arild Shirazi  http://github.com/ashirazi
+ * Piotr Jakubowski https://github.com/piotrj
  
  (Special thanks for Arild on the complexities of dealing with TimeWithZone)
  
@@ -117,9 +127,32 @@ This can lead to some wierd looking effects if, say, you are in the Eastern time
 * 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.
 
+* 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.  I'd do it in something like this:
+  
+    BusinessTime::Config.work_week = [:tue, :wed, :thur, :fri, :sat]
+
+* Arild has pointed out that there may be some logical inconsistencies
+  regaring the beginning_of_workday and end_of workday times not actually
+  being considered inside of the workday.  I'd like to make sure that they
+  work as if the beginning_of_workday is included and the end_of_workday is
+  not included, just like the '...' range operator in Ruby.
+
+== NOT TODO
+
+* I spent way too much time in my previous java-programmer life building frameworks that worshipped complexity,
+  always trying to give the developer-user ultimate flexibility at the expense of the 'surface area' of the api.
+  Never again - I will sooner limit functionality to 80% so that something stays usable and let people fork.
+* 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
 
 Copyright (c) 2010 bokmann. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/extensions/date.rb

@@ -7,4 +7,8 @@ class Date
   def weekday?
     [1,2,3,4,5].include? self.wday
   end
-end
+  
+  def business_days_until(to_date)
+    (self...to_date).select{ |day| day.workday? }.size
+  end
+end

data/test/test_calculating_business_duration.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestCalculatingBusinessDuration < Test::Unit::TestCase 
+  should "properly calculate business duration over weekends" do
+    friday = Date.parse("December 24, 2010")
+    monday = Date.parse("December 27, 2010")
+    assert_equal friday.business_days_until(monday), 1
+  end
+  
+  should "properly calculate business duration without weekends" do
+    monday = Date.parse("December 20, 2010")
+    wednesday = Date.parse("December 22, 2010")
+    assert_equal monday.business_days_until(wednesday), 2
+  end
+  
+  should "properly calculate business duration with respect to holidays" do
+    free_friday = Date.parse("December 17, 2010")
+    wednesday = Date.parse("December 15,2010")
+    monday = Date.parse("December 20, 2010")
+    BusinessTime::Config.holidays << free_friday
+    assert_equal wednesday.business_days_until(monday), 2
+  end
+  
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - bokmann
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-30 00:00:00 -04:00
+date: 2010-12-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - test/test_business_hours.rb
 - test/test_business_hours_eastern.rb
 - test/test_business_hours_utc.rb
+- test/test_calculating_business_duration.rb
 - test/test_config.rb
 - test/test_date_extensions.rb
 - test/test_fixnum_extensions.rb
@@ -120,6 +121,7 @@ test_files:
 - test/test_business_hours.rb
 - test/test_business_hours_eastern.rb
 - test/test_business_hours_utc.rb
+- test/test_calculating_business_duration.rb
 - test/test_config.rb
 - test/test_date_extensions.rb
 - test/test_fixnum_extensions.rb