bizhours 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 1.0.0 / 2008-08-09
+
+* Initial Release
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/bizhours
+lib/bizhours.rb

data/README.txt

@@ -0,0 +1,43 @@
+= bizhours
+
+== DESCRIPTION:
+   Calculate hours between 2 timestamps that match business hours
+
+== FEATURES/PROBLEMS:
+   Edit the BIZHOURS constant to set your normal business hours for each day of the week.
+   Supports custom hours on days as well, look at #diffhours= line in bizhours.rb for example using Rails
+
+== SYNOPSIS:
+   require 'bizhours'
+   Bizhours::get_duration(Time.now, Time.now + 86400)
+
+== REQUIREMENTS:
+   Duration >= 0.1.0
+
+== INSTALL:
+   sudo gem install bizhours
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,18 @@
+
+require 'rubygems'
+require 'hoe'
+require './lib/bizhours.rb'
+
+Hoe.new('bizhours', Bizhours::VERSION) do |p|
+  p.rubyforge_name = 'bizhours'
+  p.summary = 'A utility to determine the ammount of business hours between two timestamps'
+  p.author = 'Curtis Carter'
+  p.email = 'curtis@rubyhq.com'
+  p.url = 'http://rubyhq.com'
+  p.description = p.paragraphs_of('README.txt', 2..6).join("\n\n")
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['duration', '>= 0.1.0']
+  #p.developer('FIX', 'FIX@example.com')
+end
+
+# vim: syntax=Ruby

data/lib/bizhours.rb

@@ -0,0 +1,152 @@
+require 'rubygems'
+require 'duration'
+require 'date'
+
+module Bizhours
+  VERSION = '1.0.0'
+  BIZHOURS = {  
+    :mon => [8,20],
+    :tue => [8,20],
+    :wed => [8,20],
+    :thu => [8,20],
+    :fri => [8,20],
+    :sat => [9,18],
+    :sun => [8,8]
+  }
+  
+  ##
+  #Takes 2 timestamps and returns a duration object of hours that match 
+  
+  def self.get_duration(startt, endt)
+    #if start and end time is on same day do the following
+    if (startt.yday == endt.yday && startt.year == endt.year)
+      openhr, closehr = business_hours_for_day(startt)
+      openhr = Time.local(startt.year, startt.month, startt.day, openhr)
+      closehr = Time.local(startt.year, startt.month, startt.day, closehr)
+      
+      #to solve start hour before open
+      if startt < openhr
+        startt = Time.local(startt.year, startt.month, startt.day, openhr.hour)
+      end
+      
+      #solves close hour after closing
+      if endt > closehr
+        endt = Time.local(endt.year, endt.month, endt.day, closehr.hour)
+      end
+      dur = Duration.new(endt - startt)
+      
+      #to solve same time in and out past business hours
+      if dur < 0
+        return Duration.new
+      else
+        return dur 
+      end
+    end
+
+    startd = Time.local(startt.year, startt.month, startt.day)
+    endd = Time.local(endt.year, endt.month, endt.day)
+   
+    duration = first_day_time(startt) + last_day_time(endt) + inbetween_day_time(startt, endt)
+    return duration
+  end
+
+  private
+  ##
+  # Calculate duration for first day
+  
+  def self.first_day_time(startt)
+    #get the closehr for the day
+    openhr, closehr = business_hours_for_day(startt)
+    
+    #set open close start
+    open = Time.local(startt.year, startt.month, startt.day, openhr)
+    close = Time.local(startt.year, startt.month, startt.day, closehr)
+    start = Time.local(startt.year, startt.month, startt.day, startt.hour, startt.min, startt.sec)
+
+    #if start time happens after close then return 0 Duration
+    if close < start
+      return Duration.new
+    end
+
+    #if time started before opening time
+    if open > start
+      start = Time.local(startt.year, startt.month, startt.day, openhr)
+    end
+    
+    elapsed = Duration.new(close - start)
+
+    return elapsed
+  end
+
+  ##
+  # Calculate duration for last day
+  
+  def self.last_day_time(endt)
+    openhr, closehr = business_hours_for_day(endt)
+    close = Time.local(endt.year, endt.month, endt.day, closehr)
+    stop = Time.local(endt.year, endt.month, endt.day, endt.hour, endt.min, endt.sec)
+    open = Time.local(endt.year, endt.month, endt.day, openhr)
+   
+    #if stop time happens before open hours for that day set that days duration to 0
+    if stop < open
+      return Duration.new
+    end
+
+    #if timestamped out after close set stop to closing time
+    if stop > close
+      stop = Time.local(endt.year, endt.month, endt.day, close.hour)
+    end
+
+    elapsed = Duration.new(stop - open)
+
+    return elapsed
+  end
+
+  ##
+  # Calculate duration for days inbetween first and last
+  
+  def self.inbetween_day_time(startt,endt)
+    durs = []
+    duration = Duration.new
+    startd = DateTime.new(startt.year, startt.month, startt.day)
+    endd = DateTime.new(endt.year, endt.month, endt.day)
+
+    (startd..endd).each do |day|
+      daytime = Time.local(day.year, day.month, day.day)
+      openhr, closehr = business_hours_for_day(daytime)
+      close = Time.local(day.year, day.month, day.day, closehr)
+      open = Time.local(day.year, day.month, day.day, openhr)
+      elapsed = Duration.new(close - open)
+      durs << elapsed
+    end
+
+    durs.shift
+    durs.pop
+    durs.each do |dur|
+      duration += dur
+    end
+
+    return duration
+  end
+ 
+  ##
+  # If date has special hours it can pull them from db, otherwise it uses the BIZHOURS hash
+  # returns array with [openhour, closehour]
+  
+  def self.business_hours_for_day(time)
+
+    ##If your going to have custom hours do something like the following and comment out the diffhours = nil
+    #diffhours = Hour.find(:first, :conditions => ["date = ?", time.to_date] )
+    #previous assumes table Hours, fields open and close
+    diffhours = nil
+    #if date is in database return them instead of defaults  
+    if diffhours
+      return [diffhours.open.hour,diffhours.close.hour]
+    else
+      day = time.to_s.downcase[0,3]
+      return BIZHOURS[day.to_sym]
+    end
+  end
+end
+
+#puts Bizhours::get_duration(Time.now, Time.now + 86400 + 86400 + 899986400)

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: bizhours
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Curtis Carter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: duration
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: "== FEATURES/PROBLEMS: Edit the BIZHOURS constant to set your normal business hours for each day of the week. Supports custom hours on days as well, look at #diffhours= line in bizhours.rb for example using Rails  == SYNOPSIS: require 'bizhours' Bizhours::get_duration(Time.now, Time.now + 86400)  == REQUIREMENTS: Duration >= 0.1.0  == INSTALL: sudo gem install bizhours  == LICENSE:"
+email: curtis@rubyhq.com
+executables: 
+- bizhours
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/bizhours
+- lib/bizhours.rb
+has_rdoc: true
+homepage: http://rubyhq.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bizhours
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A utility to determine the ammount of business hours between two timestamps
+test_files: 
+- test/test_bizhours.rb