Class | Date |
In: |
lib/holidays.rb
|
Parent: | Object |
The Holidays gem automatically extends Ruby‘s Date class and gives you access to three new methods: holiday?, holidays and calculate_mday.
Lookup Canada Day in the :ca region
Date.civil(2008,7,1).holiday?(:ca) => true
Lookup Canada Day in the :fr region
Date.civil(2008,7,1).holiday?(:fr) => false
Lookup holidays on North America in January 1.
Date.civil(2008,1,1).holidays(:ca, :mx, :us, :informal, :observed) => [{:name => 'New Year\'s Day'...}]
Calculate day of the month based on the week number and the day of the week.
Returns an integer.
First Monday of January, 2008:
Date.calculate_mday(2008, 1, :first, :monday) => 7
Third Thursday of December, 2008:
Date.calculate_mday(2008, 12, :third, :thursday) => 18
Last Monday of January, 2008:
Date.calculate_mday(2008, 1, :last, 1) => 28
Check if the current date is a holiday.
Returns true or false.
Date.civil('2008-01-01').holiday?(:ca) => true
Get holidays on the current date.
Returns an array of hashes or nil. See Holidays#between for options and the output format.
Date.civil('2008-01-01').holidays(:ca_) => [{:name => 'New Year\'s Day',...}]
Also available via Holidays#on.