nextday 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+doc/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nextday.gemspec
+gemspec
+
+gem 'rake'
+
+require 'rbconfig'
+
+if RbConfig::CONFIG['target_os'] =~ /darwin/i
+  gem 'rb-fsevent', '>= 0.4.0', :require => false
+  gem 'growl_notify', :require => false
+  gem 'guard', '~> 0.6.0', :require => false
+  gem 'guard-rspec', '~> 0.4.0', :require => false
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/support/.+\.rb$}) { "spec/" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/README.md

@@ -0,0 +1,29 @@
+# Nextday
+
+Finds the Next Working Day even if holidays are in the way.
+
+Extends ```Date``` to allow you to find the next working day
+
+Nextday only checks for English public holidays at the moment, I aim to extend it to support locales in the near future.
+
+## Usage
+
+```ruby
+Date.today.next_working_day
+```
+
+To use this with ```DateTime``` and ```Time``` convert to ```Date``` first, for instance.
+
+```ruby
+Time.now.to_date.next_working_day
+DateTime.new(2030,11,30).to_date.next_working_day
+```
+
+
+## Installation
+
+To use with bundler just add nextday to your gem file.
+
+```ruby
+gem 'nextday'
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nextday/core_ext/date.rb

@@ -0,0 +1,3 @@
+class Date
+  include Nextday::DateExtension
+end

data/lib/nextday/date_extension.rb

@@ -0,0 +1,59 @@
+module Nextday
+  
+  module DateExtension
+    ##
+    # The next working day after the current date
+    # 
+    # @return [Date] Next Working Day
+    def next_working_day
+      next_day = self + 1
+    
+      # keep going until the next day is a working day
+      while !next_day.working_day?
+        next_day = next_day + 1  
+      end
+      
+      next_day
+    end
+
+    ##
+    # Is the current date a working day?
+    # 
+    # @return [Boolean] 
+    def working_day?
+      !weekend? and !public_holiday?
+    end
+    
+    ##
+    # Is the current date a public holiday?
+    #
+    # @return [Boolean] 
+    def public_holiday?
+      Holidays.dates.include?(self)
+    end
+    
+    ##
+    # Is the current date on the weekend?
+    #
+    # @return [Boolean] 
+    def weekend?
+      saturday? or sunday?
+    end
+    
+    ##
+    # Is the current date a saturday?
+    #
+    # @return [Boolean]
+    def saturday?
+      self.wday == 6
+    end if RUBY_VERSION < '1.9'
+    
+    ##
+    # Is the current date a saturday?
+    #
+    # @return [Boolean]
+    def sunday?
+      self.wday == 0
+    end if RUBY_VERSION < '1.9'
+  end
+end

data/lib/nextday/holiday.rb

@@ -0,0 +1,11 @@
+module Nextday
+  class Holiday
+    
+    attr_reader :name, :date
+    
+    def initialize(name, date)
+      @name = name
+      @date = date
+    end
+  end
+end

data/lib/nextday/holidays.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+
+module Nextday
+  
+  class Holidays
+    include Enumerable
+    include Singleton
+    
+    def initialize
+      @holidays = PUBLIC_HOLIDAYS
+    end
+    
+    def each(&block)
+      @holidays.each{|holiday| block.call(holiday)}
+    end
+    
+    ##
+    # Returning all the dates holidays occur
+    #
+    # @return [Array] of holidays as [Date] objects
+    def self.dates
+      instance.map(&:date)
+    end
+    
+    ##
+    # Find the first holiday for the supplied date
+    # @param [Date] format the format type, `:text` or `:html`
+    # @return [Holiday] the first matching holiday for the supplied date
+    def self.find(date)
+      instance.find{ |holiday| holiday.date == date }
+    end
+  end
+end

data/lib/nextday/public_holidays.rb

@@ -0,0 +1,62 @@
+module Nextday
+  ##
+  # Bank and public holidays in England and Wales
+  # Includes substitute days if holiday lands on a weekend
+  # http://www.direct.gov.uk/en/Employment/Employees/Timeoffandholidays/DG_073741
+  # 
+  # Be careful when adding new holidays, please specify the date as '1' not '01'
+  # 
+  BANK_AND_PUBLIC_HOLIDAYS_ENGLAND_AND_WALES = [
+    Holiday.new("Spring Bank Holiday", Date.new(2011, 5, 30)),
+    Holiday.new("Spring Bank Holiday", Date.new(2012, 6, 4)),
+    Holiday.new("Spring Bank Holiday", Date.new(2013, 5, 27)),
+    Holiday.new("Spring Bank Holiday", Date.new(2014, 5, 26)),
+    Holiday.new("Spring Bank Holiday", Date.new(2015, 5, 25)),
+    
+    Holiday.new("Early May Bank Holiday", Date.new(2011, 5, 2)),
+    Holiday.new("Early May Bank Holiday", Date.new(2012, 5, 7)),
+    Holiday.new("Early May Bank Holiday", Date.new(2013, 5, 6)),
+    Holiday.new("Early May Bank Holiday", Date.new(2014, 5, 5)),
+    Holiday.new("Early May Bank Holiday", Date.new(2015, 5, 4)),
+    
+    Holiday.new("Queen's Diamond Jubilee", Date.new(2012, 6, 5)),
+    
+    Holiday.new("Good Friday", Date.new(2011, 4, 22)),
+    Holiday.new("Good Friday", Date.new(2012, 4, 06)),
+    Holiday.new("Good Friday", Date.new(2013, 3, 29)),
+    Holiday.new("Good Friday", Date.new(2014, 4, 18)),
+    Holiday.new("Good Friday", Date.new(2015, 4, 3)),
+    
+    Holiday.new("Summer Bank Holiday", Date.new(2011, 8, 29)),
+    Holiday.new("Summer Bank Holiday", Date.new(2012, 8, 27)),
+    Holiday.new("Summer Bank Holiday", Date.new(2013, 8, 26)),
+    Holiday.new("Summer Bank Holiday", Date.new(2014, 8, 25)),
+    Holiday.new("Summer Bank Holiday", Date.new(2015, 8, 31)),
+    
+    Holiday.new("New Year's Day", Date.new(2011, 1, 3)),
+    Holiday.new("New Year's Day", Date.new(2012, 1, 2)),
+    Holiday.new("New Year's Day", Date.new(2013, 1, 1)),
+    Holiday.new("New Year's Day", Date.new(2014, 1, 1)),
+    Holiday.new("New Year's Day", Date.new(2015, 1, 1)),
+    
+    Holiday.new("Christmas Day", Date.new(2011, 12, 26)),
+    Holiday.new("Christmas Day", Date.new(2012, 12, 25)),
+    Holiday.new("Christmas Day", Date.new(2013, 12, 25)),
+    Holiday.new("Christmas Day", Date.new(2014, 12, 25)),
+    Holiday.new("Christmas Day", Date.new(2015, 12, 25)),
+    
+    Holiday.new("Easter Monday", Date.new(2011, 4, 25)),
+    Holiday.new("Easter Monday", Date.new(2012, 4, 9)),
+    Holiday.new("Easter Monday", Date.new(2013, 4, 1)),
+    Holiday.new("Easter Monday", Date.new(2014, 4, 21)),
+    Holiday.new("Easter Monday", Date.new(2015, 4, 6)),
+    
+    Holiday.new("Boxing Day", Date.new(2011, 12, 27)),
+    Holiday.new("Boxing Day", Date.new(2012, 12, 26)),
+    Holiday.new("Boxing Day", Date.new(2013, 12, 26)),
+    Holiday.new("Boxing Day", Date.new(2014, 12, 26)),
+    Holiday.new("Boxing Day", Date.new(2015, 12, 28))
+  ]
+  
+  PUBLIC_HOLIDAYS = BANK_AND_PUBLIC_HOLIDAYS_ENGLAND_AND_WALES
+end

data/lib/nextday/version.rb

@@ -0,0 +1,3 @@
+module Nextday
+  VERSION = "0.0.1"
+end

data/lib/nextday.rb

@@ -0,0 +1,7 @@
+require "nextday/version"
+require "nextday/holiday"
+require "nextday/public_holidays"
+require "nextday/holidays"
+
+require "nextday/date_extension"
+require "nextday/core_ext/date"

data/nextday.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nextday/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nextday"
+  s.version     = Nextday::VERSION
+  s.authors     = ["Robert Williams"]
+  s.email       = ["rob@r-williams.com"]
+  s.homepage    = "https://github.com/robwilliams/nextday"
+  s.summary     = %q{Finds the Next Working Day even if holidays are in the way.}
+  s.description = %q{
+    Finds the Next Working Day even if holidays are in the way.
+    Extends Date with a .next_working_day instance method.
+  }
+
+  s.rubyforge_project = "nextday"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency('rspec', '~> 2.6.0')
+  s.add_development_dependency('yard')
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/lib/nextday/core_ext/date_spec.rb

@@ -0,0 +1,52 @@
+require_relative '../../../spec_helper.rb'
+
+describe Date do
+  
+  describe "#working_day?" do
+    
+    describe "on a saturday" do
+      it { 
+        saturdays.each { |date| date.should_not be_a_working_day }
+      }
+    end
+    
+    describe "on a sunday" do
+      it { 
+        sundays.each { |date| date.should_not be_a_working_day }
+      }
+    end
+    
+    describe "on a public holiday" do
+      it {
+        Nextday::Holidays.dates.each { |date| date.should_not be_a_working_day }
+      }
+    end
+  end
+  
+  describe "#next_working_day" do
+    
+    subject {Date.today.next_working_day}
+    
+    it {should be_kind_of(Date)}
+    it {should_not eql(Date.today)}
+    it {should be_a_working_day }
+    
+    describe "on a saturday" do
+      it { 
+        saturdays.each { |date| date.next_working_day.should be_a_working_day }
+      }
+    end
+    
+    describe "on a sunday" do
+      it { 
+        sundays.each { |date| date.next_working_day.should be_a_working_day }
+      }
+    end
+    
+    describe "on a public holiday" do
+      it { 
+        Nextday::Holidays.dates.each { |date| date.next_working_day.should be_a_working_day }
+      }
+    end
+  end
+end

data/spec/lib/nextday/holiday_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../../spec_helper.rb'
+
+describe Nextday::Holiday do
+
+  subject { Nextday::Holiday.new("Christmas Day", Date.new(2012, 12, 25)) }
+  
+  it { subject.name.should eql("Christmas Day")}
+  it { subject.date.should eql(Date.new(2012, 12, 25))}
+end

data/spec/lib/nextday/holidays_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../../spec_helper.rb'
+
+describe Nextday::Holidays do
+
+  describe "#find" do
+    
+    Nextday::Holidays.dates.each do |date|
+      describe "when the date is a holiday (#{date})" do
+        subject {Nextday::Holidays.find(date)}
+        
+        it { should be_kind_of(Nextday::Holiday) }
+        it { subject.date.should eql(date) }
+      end
+    end
+  end
+
+  describe "#dates" do
+    
+    subject { Nextday::Holidays.dates }
+    
+    it { should be_kind_of(Array) }
+    it { subject.should have_at_least(1).holiday }
+    it { subject.each {|date| date.should be_a_kind_of(Date)} }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'nextday'
+
+def weekends
+  saturdays + sundays
+end
+
+def saturdays
+  today = Date.today
+  
+  today += 1 while (today.wday != 6) # step forward until it's saturday
+  saturday = today
+  
+  saturday.step(saturday + 365, 7).to_a
+end
+
+def sundays
+  today = Date.today
+  
+  today += 1 while (today.wday != 0) # step forward until it's sunday
+  sunday = today
+  
+  sunday.step(sunday + 365, 7).to_a
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: nextday
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2151822900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2151822900
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152545660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152545660
+description: ! "\n    Finds the Next Working Day even if holidays are in the way.\n
+  \   Extends Date with a .next_working_day instance method.\n  "
+email:
+- rob@r-williams.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/nextday.rb
+- lib/nextday/core_ext/date.rb
+- lib/nextday/date_extension.rb
+- lib/nextday/holiday.rb
+- lib/nextday/holidays.rb
+- lib/nextday/public_holidays.rb
+- lib/nextday/version.rb
+- nextday.gemspec
+- spec/lib/nextday/core_ext/date_spec.rb
+- spec/lib/nextday/holiday_spec.rb
+- spec/lib/nextday/holidays_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robwilliams/nextday
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nextday
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Finds the Next Working Day even if holidays are in the way.
+test_files:
+- spec/lib/nextday/core_ext/date_spec.rb
+- spec/lib/nextday/holiday_spec.rb
+- spec/lib/nextday/holidays_spec.rb
+- spec/spec_helper.rb