alphasights-business_time 0.3.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,152 @@
+= 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)
+
+== 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!
+
+== 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.
+ 
+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.
+
+== Contributors
+ * David Bock  http://github.com/bokmann
+ * Enrico Bianco  http://github.com/enricob
+ * Arild Shirazi  http://github.com/ashirazi
+ 
+ (Special thanks for Arild on the complexities of dealing with TimeWithZone)
+ 
+== 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
+
+* 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/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "alphasights-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/slawosz/business_time/tree/hours_left"
+    gem.authors = ["bokmann"]
+    gem.add_development_dependency "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
+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.3.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,36 @@
+module BusinessTime
+
+  class BusinessDays
+    def initialize(days)
+      @days = days
+    end
+
+    def after(time = Time.now)
+      time = Time.zone ? Time.zone.parse(time.to_s) : Time.parse(time.to_s)
+      @days.times do
+        begin
+          time = time + 1.day
+        end until Time.workday?(time)
+      end
+      time
+    end
+    
+    alias_method :from_now, :after
+    alias_method :since, :after
+    
+    def before(time = Time.now)
+      time = Time.zone ? Time.zone.parse(time.to_s) : Time.parse(time.to_s)
+      @days.times do
+        begin
+          time = time - 1.day
+        end until Time.workday?(time)
+      end
+      time
+    end
+    
+    alias_method :ago, :before
+    alias_method :until, :before
+  
+  end  
+  
+end

data/lib/business_time/business_hours.rb

@@ -0,0 +1,69 @@
+module BusinessTime
+
+  class BusinessHours
+    def initialize(hours)
+      @hours = hours
+    end
+
+    def ago
+      Time.zone ? before(Time.zone.now) : before(Time.now)
+    end
+
+    def from_now
+      Time.zone ?  after(Time.zone.now) : after(Time.now)
+    end
+
+    def after(time)
+      after_time = Time.roll_forward(time)
+      # Step through the hours, skipping over non-business hours
+      @hours.times do
+        after_time = after_time + 1.hour
+
+        # Ignore hours before opening and after closing
+        if (after_time > Time.end_of_workday(after_time))
+          after_time = after_time + off_hours
+        end
+
+        # Ignore weekends and holidays
+        while !Time.workday?(after_time)
+          after_time = after_time + 1.day
+        end
+      end
+      after_time
+    end
+
+    def before(time)
+      before_time = Time.roll_forward(time)
+      # Step through the hours, skipping over non-business hours
+      @hours.times do
+        before_time = before_time - 1.hour
+
+        # Ignore hours before opening and after closing
+        if (before_time < Time.beginning_of_workday(before_time))
+          before_time = before_time - off_hours
+        end
+
+        # Ignore weekends and holidays
+        while !Time.workday?(before_time)
+          before_time = before_time - 1.day
+        end
+      end
+      before_time
+    end
+
+    private
+
+    def off_hours
+      return @gap if @gap
+      if Time.zone
+        gap_end = Time.zone.parse(BusinessTime::Config.beginning_of_workday)
+        gap_begin = (Time.zone.parse(BusinessTime::Config.end_of_workday)-1.day)
+      else
+        gap_end = Time.parse(BusinessTime::Config.beginning_of_workday)
+        gap_begin = (Time.parse(BusinessTime::Config.end_of_workday) - 1.day)
+      end
+      @gap = gap_end - gap_begin
+    end
+  end
+
+end

data/lib/business_time/config.rb

@@ -0,0 +1,59 @@
+module BusinessTime
+  
+  # controls the behavior of this gem.  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
+      # You can set this yourself, either by the load method below, or
+      # by saying
+      #   BusinessTime::Config.beginning_of_workday = "8:30 am"
+      # someplace in the initializers of your application.
+      attr_accessor :beginning_of_workday
+      
+      # You can set this yourself, either by the load method below, or
+      # by saying
+      #   BusinessTime::Config.end_of_workday = "5:30 pm"
+      # someplace in the initializers of your application.
+      attr_accessor :end_of_workday
+      
+      # You can set this yourself, either by the load method below, or
+      # by saying
+      #   BusinessTime::Config.holidays << my_holiday_date_object
+      # someplace in the initializers of your application.
+      attr_accessor :holidays
+
+    end
+    
+    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 <<
+          Time.zone ? Time.zone.parse(holiday) : Time.parse(holiday)
+      end
+      
+    end
+    
+    #reset the first time we are loaded.
+    self.reset
+  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