us_bank_holidays 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4921197ea42b26e8e08bf2f4059f034c805e214
-  data.tar.gz: d40a2bbb91cce5c533a7f0056e833ba9bf09ebfd
+  metadata.gz: b60841173b3f8f7871352347c1182b85a23dc144
+  data.tar.gz: 0aaa072931196f5f0f6a342efb0f4ae831280097
 SHA512:
-  metadata.gz: b90aab66fb070972ce928c186233c2ca82066b371691b728cec75b8e4c94a7f9c6c5b09dd4e7bdad9dd37ff4c907f223b789c58acfb299801786801ba92945b7
-  data.tar.gz: 4a944a80069321f13677993dc3a3ff4b386b8dc93c740d657f0b6aa012ae98c8679a5dbed74094b8e6e1f6a2689692cb7e832f60019ee86e1547b40db5759569
+  metadata.gz: 4a523666e1a6f5b81383b8592c13de633e55a8101bbfc8e2fae9daa2acd651e172d2b45f6fa9897169394b6faed24de7ad3be0cea54118bbada2be319176a08f
+  data.tar.gz: c075e3c186c6420301a838125a6ba02cd993ac412ba269155ea42341450d6f00ca9f7d2d2fe68b5b8b6f457290f8c5ce5f097c9bbdb1c60fb0bf80961bf77e36

data/README.md

@@ -4,6 +4,7 @@ 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)
 [![Code Climate](https://codeclimate.com/github/albertosaurus/us_bank_holidays.png)](https://codeclimate.com/github/albertosaurus/us_bank_holidays)
+[![Gem Version](https://badge.fury.io/rb/us_bank_holidays.png)](http://badge.fury.io/rb/us_bank_holidays)
 
 Patches `Date` to make working with US bank holidays easier
 
@@ -50,6 +51,14 @@ 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
 ```
 
+By default, weekends always count as bank holidays, but this can be disabled.
+
+```ruby
+date = Date.new(2014, 2, 2)               # Sunday, February 2, 2014
+date.bank_holiday?                        # Returns true
+date.bank_holiday?(false)                 # Returns false
+```
+
 ## Contributing
 
 1. Fork it

data/lib/us_bank_holidays.rb

@@ -12,9 +12,14 @@ module UsBankHolidays
   end
 
   # Returns true if the given date is a bank holiday, false otherwise.
-  def self.bank_holiday?(date)
-    weekend?(date) ||
+  # Pass the optional 'include_weekends' to control whether weekends should count as
+  # bank holidays (default is true).
+  def self.bank_holiday?(date, include_weekends = true)
+    if include_weekends && weekend?(date)
+      true
+    else
       ::UsBankHolidays::HolidayYear.new(date.year).bank_holidays.include?(date)
+    end
   end
 
   # Returns true if the given date is a banking day, i.e. is not a bank holiday,
@@ -48,8 +53,10 @@ module UsBankHolidays
     end
 
     # Returns true if the date is a bank holiday, false otherwise.
-    def bank_holiday?
-      ::UsBankHolidays.bank_holiday? self
+    # Pass the optional 'include_weekends' to control whether weekends should count as
+    # bank holidays (default is true).
+    def bank_holiday?(include_weekends = true)
+      ::UsBankHolidays.bank_holiday? self, include_weekends
     end
 
     # Returns the next banking day after this one.

data/lib/us_bank_holidays/holiday_year.rb

@@ -16,8 +16,9 @@ module UsBankHolidays
                 :thanksgiving,
                 :christmas
 
+    # Initializes instance from a given year
     def initialize(year)
-      @year                 = year
+      @year = year
 
       init_fixed_holidays
       init_rolled_holidays

data/lib/us_bank_holidays/version.rb

@@ -1,3 +1,3 @@
 module UsBankHolidays
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/functional/us_bank_holidays_spec.rb

@@ -88,19 +88,25 @@ describe UsBankHolidays do
 
   describe '.bank_holiday?' do
     it 'should determine bank holidays on the list' do
-      sample_holidays.each{ |holiday|
+      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|
+      sample_weekends.each { |weekend|
         UsBankHolidays.bank_holiday?(weekend).should be_true
         UsBankHolidays.banking_day?(weekend).should be_false
       }
     end
 
+    it 'should exclude weekends if the appropriate flag is passed' do
+      sample_weekends.each { |weekend|
+        UsBankHolidays.bank_holiday?(weekend, false).should be_false
+      }
+    end
+
     it 'regular days should not be bank holidays' do
       sample_weekdays.each { |day|
         UsBankHolidays.bank_holiday?(day).should be_false
@@ -111,7 +117,7 @@ describe UsBankHolidays do
 
   describe '.weekend?' do
     it 'should recognize weekends' do
-      sample_weekends.each{ |weekend|
+      sample_weekends.each { |weekend|
         UsBankHolidays.weekend?(weekend).should be_true
         UsBankHolidays.banking_day?(weekend).should be_false
       }
@@ -124,47 +130,54 @@ describe UsBankHolidays do
 
   describe ::UsBankHolidays::DateMethods do
 
-    describe '.bank_holiday?' do
+    describe '.weekend?' do
 
-      it 'should recognize bank holidays' do
-        sample_holidays.each{ |holiday|
-          holiday.bank_holiday?.should be_true
-          holiday.banking_day?.should be_false
+      it 'should recognize weekends' do
+        sample_weekends.each { |weekend|
+          weekend.weekend?.should     be_true
+          weekend.banking_day?.should be_false
         }
       end
 
-      it 'should treat weekends as bank holidays' do
-        sample_weekends.each{ |weekend| weekend.bank_holiday?.should be_true }
-      end
-
-      it 'should not treat regular weekdays as bank holidays' do
+      it 'weekdays should not be considered weekends' do
         sample_weekdays.each { |day|
-          day.bank_holiday?.should be_false
+          day.weekend?.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
-        Date.new(2021, 12, 31).bank_holiday?.should be_true
-      end
     end
 
-    describe '.weekend?' do
+    describe '.bank_holiday?' do
 
-      it 'should recognize weekends' do
-        sample_weekends.each{ |weekend|
+      it 'should recognize bank holidays' do
+        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
+        sample_weekends.each { |weekend| weekend.bank_holiday?.should be_true }
+      end
+
+      it 'should exclude weekends if the appropriate flag is passed' do
+        sample_weekends.each { |weekend|
           weekend.weekend?.should be_true
-          weekend.banking_day?.should be_false
+          weekend.bank_holiday?(false).should be_false
         }
       end
 
-      it 'weekdays should not be considered weekends' do
+      it 'should not treat regular weekdays as bank holidays' do
         sample_weekdays.each { |day|
-          day.weekend?.should be_false
+          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
+        Date.new(2021, 12, 31).bank_holiday?.should be_true
+      end
     end
 
     describe '.next_banking_day' do

data/spec/spec_helper.rb

@@ -3,7 +3,9 @@ unless ENV['TRAVIS']
   SimpleCov.start
 end
 
-require  File.join(File.dirname(__FILE__), '..', 'lib', 'us_bank_holidays')
+require 'bundler/setup'
+
+require 'us_bank_holidays'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: us_bank_holidays
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Arthur Shagall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Patches Date to add methods to make dealing with US bank holidays simpler.