uk_working_days 0.1.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) 2010 Notonthehighstreet Enterprises Ltd
+
+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,40 @@
+= UK Working Days
+
+Provides mixins to the Date, Time and DateTime clasess to provide functionality around UK working days / public holidays.
+
+== Basic Usage
+
+If Easter monday is on the 5th April 2010:
+
+    Date.new(2010, 4, 5).public_holiday? # => true
+    Date.new(2010, 4, 5).working_day? # => false
+    Date.new(2010, 4, 5).weekday? # => true
+    Date.new(2010, 4, 5) == Date.easter_monday(2010) # => true
+    Date.public_holidays(2010).include?( Date.new(2010, 4, 5) ) # => true
+
+Will return DateTimes or Times instead as appropriate. See rdoc for more information.
+
+== Dependencies
+
+* ActiveSupport
+
+== Authors
+
+* Gregory Becker
+* Joe Simms
+* Roland Swingler
+* Jonathan Viney
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Notonthehighstreet Enterprises Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "uk_working_days"
+    gem.summary = %Q{Provide date helpers for UK working days}
+    gem.description = %Q{Provide date helpers for UK working days}
+    gem.email = "roland.swingler@gmail.com"
+    gem.homepage = "http://github.com/knaveofdiamonds/uk_working_days"
+    gem.authors = ["Roland Swingler"]
+    gem.add_dependency "activesupport", ">= 2"
+    gem.add_development_dependency "shoulda", ">= 0"
+    # 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 = "uk_working_days #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/uk_working_days/date_extensions.rb

@@ -0,0 +1,100 @@
+module UkWorkingDays
+  # Extensions to the Date and DateTime classes
+  module DateExtensions
+    # Returns true if this day is in the week
+    def weekday?
+      ! weekend?
+    end
+
+    # Returns true if this day is on the weekend
+    def weekend?
+      wday == 0 || wday == 6
+    end
+
+    # Returns true if this day is a bank holiday
+    def public_holiday?
+      Date.public_holidays(year).include?(to_date)
+    end
+
+    # Returns true if this day is a normal weekday
+    def working_day?
+      weekday? && ! public_holiday?
+    end
+
+    # Returns the next (or count'th) working day
+    def next_working_day(count = 1)
+      negative = count < 0
+      count = count.abs
+      date = negative ? yesterday : tomorrow
+      
+      loop do
+        count -= 1 if date.working_day?
+        return date if count.zero? 
+        
+        date += negative ? -1 : 1
+      end
+    end
+
+    # The previous (or count'th) working day
+    def previous_working_day(count = 1)
+      next_working_day(-count)
+    end
+
+    module ClassMethods
+      # New year's day, or the next weekday following if on a weekend
+      def new_years_day_holiday(year)
+        nyd = new(year, 1, 1)
+        nyd.weekday?() ? nyd : nyd.next_week
+      end
+
+      # Christmas day, or the next weekday following if on a weekend
+      def christmas_day_holiday(year)
+        xmas_day = new(year, 12, 25)
+        xmas_day.weekday? ? xmas_day : xmas_day.next_week
+      end
+
+      # Boxing day, or the next working day following
+      def boxing_day_holiday(year)
+        ([0,5,6].include? christmas_day_holiday(year).wday) ? christmas_day_holiday(year).next_week : christmas_day_holiday(year).tomorrow
+      end
+
+      # The monday after Easter Sunday
+      def easter_monday(year)
+        easter(year) + 1
+      end
+
+      # The friday before Easter Sunday
+      def good_friday(year)
+        easter(year) - 2
+      end
+
+      # The first monday in May
+      def may_bank_holiday(year)
+        first_day_may = new(year, 5, 1)
+        first_day_may.wday == 1 ? first_day_may : first_day_may.next_week
+      end 
+
+      # The last monday in May 
+      def spring_bank_holiday(year)
+        new(year, 5, 31).beginning_of_week
+      end
+
+      # The last monday in August
+      def summer_bank_holiday(year)
+        new(year, 8, 31).beginning_of_week
+      end
+
+      # An Array of all public holidays for the given year
+      def public_holidays(year)
+        [new_years_day_holiday(year),
+         good_friday(year),
+         easter_monday(year),
+         may_bank_holiday(year),
+         spring_bank_holiday(year),
+         summer_bank_holiday(year),
+         christmas_day_holiday(year),
+         boxing_day_holiday(year)]
+      end
+    end
+  end
+end

data/lib/uk_working_days/easter.rb

@@ -0,0 +1,43 @@
+# The easter calculation is largely derived from
+# reusablecode.blogspot.com under the following license
+#
+# Copyright (c) 2008, reusablecode.blogspot.com; some rights reserved.
+#
+# This work is licensed under the Creative Commons Attribution License. To view
+# a copy of this license, visit http://creativecommons.org/licenses/by/3.0/ or
+# send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California
+# 94305, USA.
+#
+
+module UkWorkingDays
+  module Easter
+    # Calculate easter sunday for the given year
+    def easter(year)
+      golden_number = (year % 19) + 1
+      
+      if year <= 1752 then
+        # Julian calendar
+        dominical_number = (year + (year / 4) + 5) % 7
+        paschal_full_moon = (3 - (11 * golden_number) - 7) % 30
+      else
+        # Gregorian calendar
+        dominical_number = (year + (year / 4) - (year / 100) + (year / 400)) % 7
+        solar_correction = (year - 1600) / 100 - (year - 1600) / 400
+        lunar_correction = (((year - 1400) / 100) * 8) / 25
+        paschal_full_moon = (3 - 11 * golden_number + solar_correction - lunar_correction) % 30
+      end
+
+      dominical_number += 7 until dominical_number > 0 
+      
+      paschal_full_moon += 30 until paschal_full_moon > 0 
+      paschal_full_moon -= 1 if paschal_full_moon == 29 or (paschal_full_moon == 28 and golden_number > 11)
+      
+      difference = (4 - paschal_full_moon - dominical_number) % 7
+      difference += 7 if difference < 0 
+      
+      day_easter = paschal_full_moon + difference + 1
+      
+      day_easter < 11 ? new(year, 3, day_easter + 21) : new(year, 4, day_easter - 10)
+    end
+  end
+end

data/lib/uk_working_days.rb

@@ -0,0 +1,14 @@
+require 'date'
+require 'activesupport'
+require File.dirname(__FILE__) + '/uk_working_days/easter'
+require File.dirname(__FILE__) + '/uk_working_days/date_extensions'
+
+class Date #:nodoc:
+  extend UkWorkingDays::Easter
+  extend UkWorkingDays::DateExtensions::ClassMethods
+  include UkWorkingDays::DateExtensions
+end
+
+class Time #:nodoc:
+  include UkWorkingDays::DateExtensions
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'uk_working_days'
+
+class Test::Unit::TestCase
+end

data/test/test_easter.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestEaster < Test::Unit::TestCase
+  should "be on the 4th of April in 2010" do
+    assert_equal Date.new(2010,4,4), Date.easter(2010)
+  end
+end

data/test/test_uk_working_days.rb

@@ -0,0 +1,158 @@
+require 'helper'
+
+class TestUkWorkingDays < Test::Unit::TestCase
+  should "return true for #weekend? if day is a Saturday or Sunday" do
+    assert Date.new(2010, 2, 27).weekend?
+    assert Date.new(2010, 2, 28).weekend?
+    assert Time.local(2010, 2, 28).weekend?
+  end
+
+  should "return true for #weekday? if day is not on the Weekend" do
+    assert Date.new(2010, 2, 26).weekday?
+    assert Time.local(2010, 2, 26).weekday?
+  end
+
+  should "return true for #public_holiday? if day is a public holiday" do
+    assert Date.new(2010, 4, 5).public_holiday?
+    assert DateTime.new(2010, 4, 5).public_holiday?
+    assert Time.local(2010, 4, 5).public_holiday?
+  end
+
+  should "return false for #public_holiday? if day not a public holiday" do
+    assert ! Date.new(2010, 4, 6).public_holiday?
+    assert ! DateTime.new(2010, 4, 6).public_holiday?
+  end
+
+  should "return true for #working_day? on a normal weekday" do
+    assert Date.new(2010, 4, 1).working_day?
+    assert Time.local(2010, 4, 1).working_day?
+  end
+
+  should "return false for #working_day? if day is a public holiday or on the weekend" do
+    assert ! Date.new(2010, 4, 5).working_day?
+    assert ! Date.new(2010, 4, 4).working_day?
+    assert ! Time.local(2010, 4, 4).working_day?
+  end
+
+  should "return the next working day for #next_working_day" do
+    assert_equal Date.new(2010, 4, 6), Date.new(2010, 4, 2).next_working_day
+    assert_equal Date.new(2010, 4, 7), Date.new(2010, 4, 6).next_working_day
+    assert_equal Time.local(2010, 4, 7), Time.local(2010, 4, 6).next_working_day
+  end
+
+  should "return the previous working day for #previous_working_day" do
+    assert_equal Date.new(2010, 4, 1), Date.new(2010, 4, 6).previous_working_day
+    assert_equal Date.new(2010, 3, 31), Date.new(2010, 4, 1).previous_working_day
+    assert_equal Time.local(2010, 3, 31), Time.local(2010, 4, 1).previous_working_day
+  end
+
+  context "Date#new_years_day_holiday" do
+    should "return new year's day if it is a weekday" do
+      assert_equal Date.new(2010, 1, 1), Date.new_years_day_holiday(2010)
+    end
+
+    should "return the next monday after new year's day if on a weekend" do
+      assert_equal Date.new(2011, 1, 3), Date.new_years_day_holiday(2011)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime, DateTime.new_years_day_holiday(2011)
+    end
+  end
+
+  context "Date#christmas_day_holiday" do
+    should "return christmas day if it is a weekday" do
+      assert_equal Date.new(2009, 12, 25), Date.christmas_day_holiday(2009)
+    end
+
+    should "return the next monday after new year's day if on a weekend" do
+      assert_equal Date.new(2010, 12, 27), Date.christmas_day_holiday(2010)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime, DateTime.christmas_day_holiday(2010)
+    end
+  end
+
+  context "Date#boxing_day_holiday" do
+    should "return following monday if boxing day is on saturday" do
+      assert_equal Date.new(2009, 12, 28), Date.boxing_day_holiday(2009)
+    end
+
+    should "return the following tuesday if boxing day is on sunday" do
+      assert_equal Date.new(2010, 12, 28), Date.boxing_day_holiday(2010)
+    end
+
+    should "return the following tuesday if boxing day is on monday" do
+      assert_equal Date.new(2011, 12, 27), Date.boxing_day_holiday(2011)
+    end
+
+    should "return boxing day itself in other cases" do
+      assert_equal Date.new(2008, 12, 26), Date.boxing_day_holiday(2008)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime, DateTime.boxing_day_holiday(2010)
+    end
+  end
+
+  context "Date#easter_monday" do
+    should "return the monday after easter" do
+      assert_equal Date.new(2010, 4, 5), Date.easter_monday(2010)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime, DateTime.easter_monday(2010)
+    end
+  end
+
+  context "Date#good_friday" do
+    should "return the friday before easter sunday" do
+      assert_equal Date.new(2010, 4, 2), Date.good_friday(2010)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime,  DateTime.good_friday(2010)
+    end
+  end
+
+  context "Date#may_bank_holiday" do
+    should "return the first monday in may" do
+      assert_equal Date.new(2010, 5, 3), Date.may_bank_holiday(2010)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime,  DateTime.may_bank_holiday(2010)
+    end
+  end
+
+  context "Date#spring_bank_holiday" do
+    should "return the last monday in may" do
+      assert_equal Date.new(2010, 5, 31), Date.spring_bank_holiday(2010)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime,  DateTime.spring_bank_holiday(2010)
+    end
+  end
+
+  context "Date#summer_bank_holiday" do
+    should "return the last monday in august" do
+      assert_equal Date.new(2010, 8, 30), Date.summer_bank_holiday(2010)
+    end
+
+    should "return a DateTime if called from DateTime" do
+      assert_kind_of DateTime,  DateTime.summer_bank_holiday(2010)
+    end
+  end
+
+  context "Date#public_holidays" do
+    should "return the eight public holidays in the year" do
+      assert_equal 8, Date.public_holidays(2010).uniq.size 
+    end
+
+    should "return datetimes if called from DateTime" do
+      assert DateTime.public_holidays(2010).all? {|d| d.kind_of? DateTime }
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: uk_working_days
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Roland Swingler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-05 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Provide date helpers for UK working days
+email: roland.swingler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/uk_working_days.rb
+- lib/uk_working_days/date_extensions.rb
+- lib/uk_working_days/easter.rb
+- test/helper.rb
+- test/test_easter.rb
+- test/test_uk_working_days.rb
+has_rdoc: true
+homepage: http://github.com/knaveofdiamonds/uk_working_days
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provide date helpers for UK working days
+test_files: 
+- test/helper.rb
+- test/test_easter.rb
+- test/test_uk_working_days.rb