Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A collection of Ruby methods to deal with statutory and other holidays. You deserve a holiday!
Ruby
branch: master

This branch is 13 commits ahead, 212 commits behind holidays:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
data
lib
test
.gitignore
.travis.yml
CHANGELOG
Gemfile
LICENSE
README.rdoc
REFERENCES
holidays.gemspec
rakefile.rb

README.rdoc

Ruby Holidays Gem

A set of functions to deal with holidays in Ruby.

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

Installation

To install the gem from RubyGems:

gem install holidays

Time zones

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

Examples

For more information, see the notes at the top of the Holidays module.

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)
=> [{:name => 'Valentine\'s Day',...}]

Extending Ruby's Date class

Check which holidays occur in Iceland on January 1, 2008.

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

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

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

How to contribute

To make changes to any of the definitions, edit the YAML files only.

Tests are also added at the end of the YAML files. Please add tests, it makes the pull requests go around.

After you're satisfied with the YAML file, run rake defs:build_all and rake defs:manifest, which will generate the ruby files that make up the actual code as well as the tests.

It is also very appreciated if documentation is attached to the pull request, a simple wikipedia post referencing the change would suffice.

Tests can be run using rake test, use rake -T to see all available tasks.

Credits and code

Started by Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007-12. Maintained by Hana Wang (github.com/hahahana), 2013

On Twitter: @MrMrBug.

Made on Vancouver Island. Maintained in the way more beautiful Houston, TX.

Something went wrong with that request. Please try again.