us_bank_holidays 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c3a4c8155f725d440890a1d187c38596f34b326
-  data.tar.gz: 239f7ae539a79fce66e8eb97fd8d78e110bea7d2
+  metadata.gz: 421d85478436ebcc1574e2ccc9639b887029e46e
+  data.tar.gz: 3a0cd71dd007bfddc392a016739eabcae93af9c4
 SHA512:
-  metadata.gz: e5631bf04812d8a388c88a0a5e834f7dfb8d9eadbd44baa9308ceb5aac6c74030545f2ce276f45c63a27e3c2daeb5afabdf510562f27d7796dd0ea4c81a7b0f1
-  data.tar.gz: 7f2af15f67b235524fb4a818c33aa5fdadc85b964495a56602e973190ed91ae35012560ffeb5c45572ba9f8c027ab1ef0d7e74349ab3449340e3091e9fa1f6bf
+  metadata.gz: c1a919b687012cc56dea4f7afa1259715b83e037ac275e236dda25f1ebfd9fd9de6e642d3f8ad89f03e5cfc46846b46a84f95c16e84f96d78489daf0cd4a48cd
+  data.tar.gz: 18552331c1658fdc6a1eda5db1bdfe61485c6736a5ae318064fadeb48a45fc6304ca625c6c5c810ec2e612cb46b21a6043160d5b0012fa72e72ffce041748e82

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+script: 'bundle exec rake spec'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: rbx

data/README.md

@@ -1,7 +1,19 @@
 # UsBankHolidays
 
+https://github.com/albertosaurus/us_bank_holidays
+
+[![Build Status](https://travis-ci.org/albertosaurus/us_bank_holidays.png?branch=master)](https://travis-ci.org/albertosaurus/us_bank_holidays)
+
 Patches `Date` to make working with US bank holidays easier
 
+## Requirements
+
+Tested against the following Ruby runtimes:
+
+* MRI 1.9.3, 2.0.0, 2.1.0
+* JRuby 1.7+
+* Rubinius (latest)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -10,7 +22,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -31,8 +43,10 @@ date = Date.new(2014, 1, 3)               # Friday, January 3, 2014
 date.bank_holiday?                        # Returns false
 date.weekend?                             # Returns false
 date.next_banking_day                     # Returns Monday, January 6, 2014
+date.banking_day?                         # Returns true
 
 Date.new(2014, 1, 16).add_banking_days(2) # Returns Tuesday, January 21, 2014
+Date.new(2014, 1, 5).previous_banking_day # Returns Friday, January 3, 2014
 ```
 
 ## Contributing

data/lib/us_bank_holidays/holiday_year.rb

@@ -1,5 +1,7 @@
 module UsBankHolidays
 
+  # Utility class to calculate where the federal holidays will actually fall
+  # for any given year.
   class HolidayYear
 
     attr_reader :year,
@@ -49,6 +51,9 @@ module UsBankHolidays
 
     end
 
+    # Returns the federal holidays for the given year on the dates they will actually
+    # be observed. In the event that New Year's Day for the following year falls on a
+    # Saturday December 31 will also be included.
     def bank_holidays
       @bank_holidays ||= begin
         holidays = [ new_years_day,
@@ -69,17 +74,19 @@ module UsBankHolidays
       end
     end
 
-    private
-
-      def roll_nominal(nominal)
-        if nominal.saturday?
-          nominal - 1
-        elsif nominal.sunday?
-          nominal + 1
-        else
-          nominal
-        end
+    # Figures out where to roll the given nominal date. If it's a Saturday, assumes
+    # it's the day before (Friday), if Sunday it's the date after (Monday), otherwise
+    # just returns self.
+    def roll_nominal(nominal)
+      if nominal.saturday?
+        nominal - 1
+      elsif nominal.sunday?
+        nominal + 1
+      else
+        nominal
       end
+    end
+    private :roll_nominal
 
   end
 

data/lib/us_bank_holidays/version.rb

@@ -1,3 +1,3 @@
 module UsBankHolidays
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/us_bank_holidays.rb

@@ -6,15 +6,23 @@ require 'us_bank_holidays/month'
 
 module UsBankHolidays
 
+  # Returns true if the given date is a weekend, false otherwise.
   def self.weekend?(date)
     date.sunday? || date.saturday?
   end
 
+  # Returns true if the given date is a bank holiday, false otherwise.
   def self.bank_holiday?(date)
     weekend?(date) ||
       ::UsBankHolidays::HolidayYear.new(date.year).bank_holidays.include?(date)
   end
 
+  # Returns true if the given date is a banking day, i.e. is not a bank holiday,
+  # false otherwise.
+  def self.banking_day?(date)
+    !bank_holiday?(date)
+  end
+
   def self.next_banking_day(date)
     if (next_date = date + 1).bank_holiday?
       next_banking_day(next_date)
@@ -31,24 +39,32 @@ module UsBankHolidays
     end
   end
 
+  # Instance methods to be injected into the Date class
   module DateMethods
 
+    # Returns true if the date if a weekend, false otherwise.
     def weekend?
       ::UsBankHolidays.weekend? self
     end
 
+    # Returns true if the date is a bank holiday, false otherwise.
     def bank_holiday?
       ::UsBankHolidays.bank_holiday? self
     end
 
+    # Returns the next banking day after this one.
     def next_banking_day
       ::UsBankHolidays.next_banking_day self
     end
 
+    # Returns the previous banking day
     def previous_banking_day
       ::UsBankHolidays.previous_banking_day self
     end
 
+    # Adds the given number of banking days, i.e. bank holidays don't count.
+    # If days is negative, subtracts the given number of banking days.
+    # If days is zero, returns self.
     def add_banking_days(days)
       day = self
       if days > 0
@@ -58,6 +74,12 @@ module UsBankHolidays
       end
       day
     end
+
+    # Returns true if this is a banking day, i.e. is not a bank holiday,
+    # false otherwise.
+    def banking_day?
+      !bank_holiday?
+    end
   end
 
 end

data/spec/functional/us_bank_holidays_spec.rb

@@ -88,21 +88,33 @@ describe UsBankHolidays do
 
   describe '.bank_holiday?' do
     it 'should determine bank holidays on the list' do
-      sample_holidays.each{ |holiday| UsBankHolidays.bank_holiday?(holiday).should be_true }
+      sample_holidays.each{ |holiday|
+        UsBankHolidays.bank_holiday?(holiday).should be_true
+        UsBankHolidays.banking_day?(holiday).should be_false
+      }
     end
 
     it 'weekends should be bank holidays' do
-      sample_weekends.each{ |weekend| UsBankHolidays.bank_holiday?(weekend).should be_true }
+      sample_weekends.each{ |weekend|
+        UsBankHolidays.bank_holiday?(weekend).should be_true
+        UsBankHolidays.banking_day?(weekend).should be_false
+      }
     end
 
     it 'regular days should not be bank holidays' do
-      sample_weekdays.each { |day| UsBankHolidays.bank_holiday?(day).should be_false }
+      sample_weekdays.each { |day|
+        UsBankHolidays.bank_holiday?(day).should be_false
+        UsBankHolidays.banking_day?(day).should be_true
+      }
     end
   end
 
   describe '.weekend?' do
     it 'should recognize weekends' do
-      sample_weekends.each{ |weekend| UsBankHolidays.weekend?(weekend).should be_true }
+      sample_weekends.each{ |weekend|
+        UsBankHolidays.weekend?(weekend).should be_true
+        UsBankHolidays.banking_day?(weekend).should be_false
+      }
     end
 
     it 'weekdays should not be considered weekends' do
@@ -115,7 +127,10 @@ describe UsBankHolidays do
     describe '.bank_holiday?' do
 
       it 'should recognize bank holidays' do
-        sample_holidays.each{ |holiday| holiday.bank_holiday?.should be_true }
+        sample_holidays.each{ |holiday|
+          holiday.bank_holiday?.should be_true
+          holiday.banking_day?.should be_false
+        }
       end
 
       it 'should treat weekends as bank holidays' do
@@ -123,7 +138,10 @@ describe UsBankHolidays do
       end
 
       it 'should not treat regular weekdays as bank holidays' do
-        sample_weekdays.each { |day| day.bank_holiday?.should be_false }
+        sample_weekdays.each { |day|
+          day.bank_holiday?.should be_false
+          day.banking_day?.should be_true
+        }
       end
 
       it 'if Jan. 1 falls on a Saturday, Dec. 31 of the previous year should be a bank holiday' do
@@ -134,11 +152,17 @@ describe UsBankHolidays do
     describe '.weekend?' do
 
       it 'should recognize weekends' do
-        sample_weekends.each{ |weekend| weekend.weekend?.should be_true }
+        sample_weekends.each{ |weekend|
+          weekend.weekend?.should be_true
+          weekend.banking_day?.should be_false
+        }
       end
 
       it 'weekdays should not be considered weekends' do
-        sample_weekdays.each { |day| day.weekend?.should be_false }
+        sample_weekdays.each { |day|
+          day.weekend?.should be_false
+          day.banking_day?.should be_true
+        }
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: us_bank_holidays
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Arthur Shagall
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md