A collection of Ruby methods to deal with statutory and other holidays. You deserve a holiday!
Ruby Other
Latest commit f216eda Sep 24, 2016 @ptrimble ptrimble committed on GitHub Merge pull request #229 from ptrimble/fix_makefile
Fix broken makefile targets for gem build and push (used by maintaine…
Permalink
Failed to load latest commit information.
bin Rewrite: update README and add bin directory for easier irb use Dec 13, 2015
definitions @ 3c3b7aa Issue-221: add definitions submodule and point to latest version Sep 24, 2016
lib Issue-221: add definitions submodule and point to latest version Sep 24, 2016
test Issue-221: add definitions submodule and point to latest version Sep 24, 2016
.coveralls.yml Reformat README and add in coverage status badge Mar 19, 2015
.gitignore Reformat README and add in coverage status badge Mar 19, 2015
.gitmodules Issue-221: add definitions submodule and point to latest version Sep 24, 2016
.travis.yml Issue-221: re-add lazy loading of definitions and prepare for def sub… Sep 24, 2016
CHANGELOG.md Issue-221: re-add lazy loading of definitions and prepare for def sub… Sep 24, 2016
CODE_OF_CONDUCT.md Issue-170: add code of conduct Apr 23, 2016
CONTRIBUTING.md Issue-221: add definitions submodule and point to latest version Sep 24, 2016
Gemfile Issue-144: Update all definitions with new custom method repo usage Apr 17, 2016
LICENSE Copyright years Jan 4, 2014
Makefile Fix broken makefile targets for gem build and push (used by maintaine… Sep 24, 2016
README.md Issue-203: add README updates for new Date and Time core extensions Aug 11, 2016
REFERENCES Update REFERENCES with new language and additional easter calculation… Apr 17, 2016
Rakefile Move factories to their own namespace Jul 29, 2016
holidays.gemspec Issue-221: re-add lazy loading of definitions and prepare for def sub… Sep 24, 2016

README.md

Ruby Holidays Gem Build Status Coverage Status

A set of functions to deal with holidays in Ruby.

Extends Ruby's built-in Date class and supports custom holiday definition lists.

Full documentation can be found here.

Installation

To install the gem from RubyGems:

gem install holidays

The Holidays gem is tested on Ruby 2.0.0, 2.1.0, 2.2.0, 2.3.0 and JRuby.

This gem follows semantic versioning. The only methods covered by this guarantee are under the Holidays namespace specifically. Anything that is not a method off of Holidays or the core extension is not covered by semver. Please take this into account when relying on this gem as a dependency.

Time zones

Time zones are ignored. This library assumes that all dates are within the same time zone.

Using the Holidays class

Get all holidays on April 25, 2008 in Australia.

date = Date.civil(2008,4,25)

Holidays.on(date, :au)
=> [{:name => 'ANZAC Day',...}]

Get holidays that are observed on July 2, 2007 in British Columbia, Canada.

date = Date.civil(2007,7,2)

Holidays.on(date, :ca_bc, :observed)
=> [{:name => 'Canada Day',...}]

Get all holidays in July, 2008 in Canada and the US.

from = Date.civil(2008,7,1)
to = Date.civil(2008,7,31)

Holidays.between(from, to, :ca, :us)
=> [{:name => 'Canada Day',...}
    {:name => 'Independence Day',...}]

Get informal holidays in February.

from = Date.civil(2008,2,1)
to = Date.civil(2008,2,15)

Holidays.between(from, to, :informal)
=> [{:name => 'Valentine\'s Day',...}]

Return all available regions:

Holidays.available_regions
=> [:ar, :at, ..., :sg] # this will be a big array

To check if there are any holidays taking place during a specified work week:

Holidays.any_holidays_during_work_week?(Date.civil(2016, 1, 1))
=> true

To find and return the next holidays occurring from date, inclusively:

Holidays.next_holidays(3, [:us, :informal], Date.civil(2016, 2, 23))
=> [{:name => "St. Patrick's Day",...}, {:name => "Good Friday",...}, {:name => "Easter Sunday",...}]

Will default to Date.today if no date is provided.

To find all holidays occuring from date to end of year, inclusively:

Holidays.year_holidays([:ca_on], Date.civil(2016, 2, 23))
=> [{:name=>"Good Friday",...},
    {name=>"Easter Sunday",...},
    {:name=>"Victoria Day",...},
    {:name=>"Canada Day",...},
    {:name=>"Civic Holiday",...},
    {:name=>"Labour Day",...},
    {:name=>"Thanksgiving",...},
    {:name=>"Remembrance Day",...},
    {:name=>"Christmas Day",...},
    {:name=>"Boxing Day",...}]

Will default to Date.today if no date is provided.

Loading Custom Definitions on the fly

Load custom definitions file on the fly and use them immediately.

Load custom 'Company Founding' holiday on June 1st:

Holidays.load_custom('/home/user/holiday_definitions/custom_holidays.yaml')

date = Date.civil(2013,6,1)

Holidays.on(date, :my_custom_region)
  => [{:name => 'Company Founding',...}]

Custom definition files must match the format of the existing definition YAML files location in the 'definitions' directory.

Multiple files can also be passed:

Holidays.load_custom('/home/user/holidays/custom_holidays1.yaml', '/home/user/holidays/custom_holidays2.yaml')

Extending Ruby's Date and Time classes

To extend the 'Date' class:

require 'holidays/core_extensions/date'
class Date
  include Holidays::CoreExtensions::Date
end

Now you can check which holidays occur in Iceland on January 1, 2008:

d = Date.civil(2008,7,1)

d.holidays(:is)
=> [{:name => 'Nýársdagur'}...]

Or lookup Canada Day in different regions:

d = Date.civil(2008,7,1)

d.holiday?(:ca) # Canada
=> true

d.holiday?(:ca_bc) # British Columbia, Canada
=> true

d.holiday?(:fr) # France
=> false

Or return the new date based on the options:

d = Date.civil(2008,7,1)
d.change(:year => 2016, :month => 1, :day => 1)
=> #<Date: 2016-01-01 ((2457389j,0s,0n),+0s,2299161j)>

Or you can calculate the day of the month:

Date.calculate_mday(2015, 4, :first, 2)
=> 7

Or find end of month for given date (requires 'Time' extensions as well):

d = Date.civil(2016,8,1)
d.end_of_month
=> #<Date: 2016-08-31 ((2457632j,0s,0n),+0s,2299161j)>

Caching Holiday Lookups

If you are checking holidays regularly you can cache your results for improved performance. Run this before looking up a holiday (eg. in an initializer):

Holidays.cache_between(Time.now, 2.years.from_now, :ca, :us, :observed)

Holidays for the regions specified within the dates specified will be pre-calculated and stored in-memory. Future lookups will be much faster.

How to contribute

See our contribution guidelines for information on how to help out!

Credits and code

Plus all of these wonderful contributors!