mileszs-enterprise_time_extensions 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Miles Z. Sterrett
+
+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.textile

@@ -0,0 +1,65 @@
+h1. Enterprise Time Extensions
+
+Enterprisey extensions to Ruby's Time class.  How else will you know when it's
+OK to stop avoiding work, and you can actually leave work?
+
+Example:
+
+h2. Un-Fun, All-Business Instance Method Examples
+
+<pre>
+  <code>
+    t = Time.now #=> Fri Jan 09 22:12:31 0100 2009
+    # Enterprisey methods in action!:
+    t.after_hours? #=> false
+    t.holiday? #=> false
+
+    t = Time.local(2009, 12, 25) #=>  Fri Dec 25 00:00:00 0100 2009
+    t.after_hours? #=> true -- because it's a holiday
+    t.holiday? #=> true -- I told you!
+
+    t = Time.local(2009, 1, 9, 18, 30) #=> Fri Jan 09 18:30:00 0100 2009
+    t.after_hours? #=> true -- Business hours are 8AM to 6PM ... SHARP!
+    t.holiday? #=> false
+  </code>
+</pre>
+
+There are question mark methods for the holidays that are paid-time-off for
+slaves of The Enterprise.
+
+* new_years_day?
+* mlk_jr_day?
+* memorial_day?
+* independence_day?
+* labor_day?
+* thanksgiving?
+* christmas_day?
+
+<em>If you need/want more, let me know!  You're welcome
+to do it yourself, if you wish.</em>
+
+h2. Frank, Straight-Shooting Class Methods
+
+<pre>
+  <code>
+  # Countdown to the next football game?
+  Time.next_sunday #=> Sun Jan 11 00:00:00 0100 2009
+  # The big one:
+  Time.nth_wday(3, 6, 7, 2009) #=> Sat Jul 18 00:00:00 0200 2009
+  </code>
+</pre>
+
+Time::nth_wday could probably use some explanation.  Time::nth_wday will find the 'nth' week day of a month.  Above, we found the 3th (hehe) Saturday of July 2009.  This is actually used often in the various holiday methods from above.  For instance, Thanksgiving is on the 4th Thursday of November.  The method looks like this:
+<pre>
+  <code>
+  def self.nth_wday(n, wday, month, year)
+  # ...
+  end
+  </code>
+</pre>
+
+*Enjoy!*
+
+<em>(I feel obligated to tell you, honestly, that the environment at nFrame is
+far removed from the usual negative implications of the word 'Enterprise'.
+It's quite nice, actually.  Oh, and we only have like 40 total employees.)</em>

data/lib/enterprise_time_extensions.rb

@@ -0,0 +1,105 @@
+module EnterpriseTimeExtensions
+  module ClassMethods
+    def next_sunday
+      timeobj = Time.local(Time.now.year, Time.now.month, Time.now.day, 0) # Today at midnight
+      timeobj += 60*60*24 until timeobj.wday == 0
+      timeobj # Should now be next Sunday at midnight
+    end
+
+    def nth_wday(n, wday, month, year)
+      if (!n.between? 1,5) ||
+         (!wday.between? 0,6) ||
+         (!month.between? 1,12)
+        raise ArgumentError
+      end
+      t = Time.local year, month, 1
+      first = t.wday
+      if first == wday
+        fwd = 1
+      elsif first < wday
+        fwd = wday - first + 1
+      elsif first > wday
+        fwd = (wday+7) - first + 1
+      end
+      target = fwd + (n-1)*7
+      begin
+        t2 = Time.local year, month, target
+      rescue ArgumentError
+        return nil
+      end
+      t2
+    end
+  end
+
+  def after_hours?
+    result = true
+    # M-F, 8am to 6pm are business hours
+    if (1..5).include?(self.wday) && (8..17).include?(self.hour)
+      result = false
+    end
+    # unless it's a holiday!
+    if self.holiday?
+      result = true
+    end
+    result
+  end
+
+  def holiday?
+    unless new_years_day? ||
+       mlk_jr_day? ||
+       memorial_day? ||
+       independence_day? ||
+       labor_day? ||
+       thanksgiving? ||
+       christmas_day?
+      return false
+    end
+    true
+  end
+
+  def new_years_day?
+    return false unless self.yday == 1
+    true
+  end
+
+  def mlk_jr_day?
+    return false unless self.yday == Time.nth_wday(3,1,1,self.year).yday
+    true
+  end
+
+  def memorial_day?
+    last_day_of_month = Time.local(self.year, 5, 31)
+    if last_day_of_month.wday == 0
+      d = 25
+    else
+      d = last_day_of_month.mday - last_day_of_month.wday + 1
+    end
+    return false unless self.yday == Time.local(self.year, 5, d).yday
+    true
+  end
+
+  def independence_day?
+    return false unless self.month == 7 && self.mday == 4
+    true
+  end
+
+  def labor_day?
+    return false unless self.yday == Time.nth_wday(1,1,9,self.year).yday
+    true
+  end
+
+  def thanksgiving?
+    return false unless self.yday == self.class.nth_wday(4,4,11,self.year).yday
+    true
+  end
+
+  def christmas_day?
+    return false unless self.month == 12 && self.mday == 25
+    true
+  end
+end
+
+Time.class_eval do
+  include EnterpriseTimeExtensions
+  extend EnterpriseTimeExtensions::ClassMethods
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: mileszs-enterprise_time_extensions
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Miles Z. Sterrett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-09 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Enterprisey extensions to Ruby's Time class allowing you to quickly discover whether a time is a holiday, or after hours.
+email: miles.sterrett@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- lib/enterprise_time_extensions.rb
+- MIT-LICENSE
+has_rdoc: false
+homepage: http://github.com/mileszs/enterprise_time_extensions
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Enterprisey extensions to Ruby's Time class.
+test_files: []
+