weekdays 1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Darby
+
+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,36 @@
+h1. weekdays
+
+A Ruby on Rails gem that provides methods to work with 'weekdays' (ie. 5.weekdays_ago)
+
+h2. What it does
+
+weekdays extends Rails' Date, Time, DateTime, and Numeric ActiveSupport Core Extensions and gives you a handful of helpful methods that calculate spans of weekdays.
+
+h2. Requirements
+
+This gem ;)
+
+h2. How to Install
+
+<pre>sudo gem install weekdays --source 'http://gemcutter.com'</pre>
+
+Then add it to your environment.rb:
+<pre>config.gem "weekdays"</pre>
+
+h2. How to Use
+
+You can now do cool things like:
+
+<pre>
+Date.today.weekday? # => true
+5.weekdays_ago # => Tue Mar 24 10:46:42 -0400 2009
+11.weekdays_from_now # => Wed Apr 15 10:46:54 -0400 2009
+20.weekdays_from(Date.yesterday) # => Mon, 27 Apr 2009
+Date.today.weekdays_until(Date.tomorrow) # => 1
+</pre>
+
+h2. About the Author
+
+My name is "Matt Darby.":http://blog.matt-darby.com I’m an IT Manager and pro-web-dev at for "Dynamix Engineering":http://dynamix-ltd.com and hold a Master’s Degree in Computer Science from "Franklin University":http://www.franklin.edu in sunny "Columbus, OH.":http://en.wikipedia.org/wiki/Columbus,_Ohio
+
+Feel free to check out my "blog":http://blog.matt-darby.com or "recommend me":http://www.workingwithrails.com/person/10908-matt-darby

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "weekdays")

data/lib/weekdays.rb

@@ -0,0 +1,92 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Date #:nodoc:
+      # Enables the use of time calculations within Date itself
+      module Calculations
+        # Tells whether the Date object is a weekday
+        def weekday?
+          (1..5).include?(wday)
+        end
+        
+        # Returns the number of weekdays until a future Date
+        def weekdays_until(date)
+          return 0 if date <= self
+          (self...date).select{|day| day.weekday?}.size
+        end
+      end
+    end
+  end
+end
+
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Time #:nodoc:
+      # Enables the use of time calculations within Time itself
+      module Calculations
+        def weekday?
+          (1..5).include?(wday)
+        end
+      
+        def weekdays_until(date)
+          return 0 if date <= self.to_date
+          (self.to_date...date).select{|day| day.weekday?}.size
+        end
+      end
+    end
+  end
+end
+
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module DateTime #:nodoc:
+      # Enables the use of time calculations within DateTime itself
+      module Calculations
+        # Tells whether the Date object is a weekday
+        def weekday?
+          (1..5).include?(wday)
+        end
+      end
+    end
+  end
+end
+
+module ActiveSupport #:nodoc:
+  module CoreExtensions
+    module Numeric
+      module Time
+        # Returns a Time object that is n number of weekdays in the future of a given Date
+        def weekdays_from(time = ::Time.now)
+          # -5.weekdays_from(time) == 5.weekdays_ago(time)
+          return self.abs.weekdays_ago(time) if self < 0
+          
+          x = 0
+          curr_date = time
+
+          until x == self
+            curr_date += 1.days
+            x += 1 if curr_date.weekday?
+          end
+
+          curr_date
+        end
+        alias :weekdays_from_now :weekdays_from
+
+        # Returns a Time object that is n number of weekdays in the past from a given Date
+        def weekdays_ago(time = ::Time.now)
+          # -5.weekdays_ago(time) == 5.weekdays_from(time)
+          return self.abs.weekdays_from(time) if self < 0
+          
+          x = 0
+          curr_date = time
+
+          until x == self
+            curr_date -= 1.days
+            x += 1 if curr_date.weekday?
+          end
+
+          curr_date
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'activesupport'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'weekdays.rb')
+
+Spec::Runner.configure do |config|
+end

data/spec/weekdays_spec.rb

@@ -0,0 +1,127 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe "Date Extension" do
+  
+  describe "Checking a Date for weekday status" do
+    
+    it "should know that Mon-Fri are weekdays" do
+      (1...5).each do |i|
+        Date.new(2000, 1, (3 + i)).weekday?.should be_true
+      end
+    end
+    
+    it "should know that Sunday is not a weekday" do
+      Date.new(2000, 1, 2).weekday?.should be_false
+    end
+    
+    it "should know that Saturday is not a weekday" do
+      Date.new(2000, 1, 1).weekday?.should be_false
+    end
+    
+  end
+  
+  describe "Calculating weekdays between Dates" do
+    it "should return 2086" do
+      Date.new(2000, 1, 1).weekdays_until(Date.new(2008, 1, 1)).should == 2086
+    end
+  end
+  
+end
+
+describe "Time Extension" do
+  
+  describe "Checking a Time for weekday status" do
+    
+    it "should know that Mon-Fri are weekdays" do
+      (1...5).each do |i|
+        Date.new(2000, 1, (3 + i)).beginning_of_day.weekday?.should be_true
+      end
+    end
+    
+    it "should know that Sunday is not a weekday" do
+      Date.new(2000, 1, 2).beginning_of_day.weekday?.should be_false
+    end
+    
+    it "should know that Saturday is not a weekday" do
+      Date.new(2000, 1, 1).beginning_of_day.weekday?.should be_false
+    end
+    
+  end
+  
+  describe "Calculating weekdays between Times" do
+    it "should return 521" do
+      Date.new(2000, 1, 1).beginning_of_day.weekdays_until(Date.new(2002, 1, 1)).should == 521
+    end
+  end
+  
+end
+
+describe "DateTime Extension" do
+  
+  describe "Checking a DateTime for weekday status" do
+    
+    it "should know that Mon-Fri are weekdays" do
+      (1...5).each do |i|
+        DateTime.new(2000, 1, (3 + i), 1, 1, 1).weekday?.should be_true
+      end
+    end
+    
+    it "should know that Sunday is not a weekday" do
+      DateTime.new(2000, 1, 2, 1, 1, 1).weekday?.should be_false
+    end
+    
+    it "should know that Saturday is not a weekday" do
+      DateTime.new(2000, 1, 1, 1, 1, 1).weekday?.should be_false
+    end
+    
+  end
+  
+end
+
+describe "Numeric::Time Extension" do
+  
+  describe "#weekdays_from" do
+    it "should return 5" do
+      5.weekdays_from(Date.new(2000, 1, 1).beginning_of_day).should == Date.new(2000, 1, 7).beginning_of_day
+    end
+  end
+
+  describe "#weekdays_from_now" do
+    it "should return 5" do
+      Time.stub!(:now => Date.new(2000, 1, 1).beginning_of_day)
+      5.weekdays_from_now.should == Date.new(2000, 1, 7).beginning_of_day
+    end
+    
+    it "should be able to handle zero cases" do
+      Time.stub!(:now => Date.new(2000, 1, 1).beginning_of_day)
+      0.weekdays_from_now.should == Date.new(2000, 1, 1).beginning_of_day
+    end
+
+    it "should be able to handle negative spans" do
+      Time.stub!(:now => Date.new(2000, 1, 1).beginning_of_day)
+      -5.weekdays_from_now.should == Date.new(1999, 12, 27).beginning_of_day
+    end
+    
+  end
+
+
+  describe "#weekdays_ago" do
+    it "should return 5" do
+      Time.stub!(:now => Date.new(2000, 1, 1).beginning_of_day)
+      5.weekdays_ago.should == Date.new(1999, 12, 27).beginning_of_day
+      5.weekdays_ago(Date.new(1999, 12, 27).beginning_of_day).should == Date.new(1999, 12, 20).beginning_of_day
+    end
+    
+    it "should handle zero spans" do
+      Time.stub!(:now => Date.new(2000, 1, 1).beginning_of_day)
+      0.weekdays_ago.should == Date.new(2000, 1, 1).beginning_of_day
+    end
+
+    it "should handle negative spans" do
+      Time.stub!(:now => Date.new(2000, 1, 1).beginning_of_day)
+      -5.weekdays_ago.should == Date.new(2000, 1, 7).beginning_of_day
+    end
+    
+  end
+
+end

data/weekdays.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name     = "weekdays"
+  s.version  = "1.0"
+  s.date     = "2009-03-31"
+  s.summary  = "Provides methods to work with 'weekdays'"
+  s.email    = "matt@matt-darby.com"
+  s.homepage = "http://github.com/mdarby/weekdays/tree/master"
+  s.description = "Provides methods to work with 'weekdays' (ie. 5.weekdays_ago)"
+  s.has_rdoc = false
+  s.authors  = ["Matt Darby"]
+  s.files    = [
+    'MIT-LICENSE',
+    'README.textile',
+    'init.rb',
+    'lib/weekdays.rb',
+    'spec/weekdays_spec.rb',
+    'spec/spec_helper.rb',
+    'weekdays.gemspec',
+  ]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: weekdays
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Matt Darby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-31 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Provides methods to work with 'weekdays' (ie. 5.weekdays_ago)
+email: matt@matt-darby.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.textile
+- init.rb
+- lib/weekdays.rb
+- spec/weekdays_spec.rb
+- spec/spec_helper.rb
+- weekdays.gemspec
+has_rdoc: true
+homepage: http://github.com/mdarby/weekdays/tree/master
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Provides methods to work with 'weekdays'
+test_files: []
+