holidays/README

76 lines
1.8 KiB
Plaintext
Raw Normal View History

= Ruby Holidays Gem
2007-11-20 01:58:20 +01:00
2007-11-30 05:36:08 +01:00
A set of functions to deal with holidays in Ruby.
2007-11-20 01:58:20 +01:00
Extends Ruby's built-in Date class and supports custom holiday definition lists.
2007-11-30 05:36:08 +01:00
=== Installation
To install the gem from RubyForge:
gem install holidays
Or, download the source <tt>.tgz</tt> file from http://rubyforge.org/holidays and
extract it somewhere in your include path.
=== Examples
2007-11-30 05:36:08 +01:00
For more information, see the notes at the top of the Holidays module.
==== Using the Holidays class
2007-11-30 05:36:08 +01:00
Get all holidays on April 25, 2008 in Australia.
date = Date.civil(2008,4,25)
2007-11-30 05:36:08 +01:00
Holidays.by_day(date, :au)
=> [{:name => 'ANZAC Day',...}]
2007-11-20 01:58:20 +01:00
2007-11-30 05:36:08 +01:00
Get holidays that are observed on July 2, 2007 in British Columbia, Canada.
date = Date.civil(2007,7,2)
2007-11-20 01:58:20 +01:00
2007-11-30 05:36:08 +01:00
Holidays.by_day(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)
2007-11-30 05:36:08 +01:00
Holidays.between(from, to, :ca, :us)
=> [{:name => 'Canada Day',...}
2007-11-30 01:49:33 +01:00
{:name => 'Independence Day',...}]
2007-11-30 05:36:08 +01:00
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
2007-11-30 05:36:08 +01:00
Check which holidays occur in Iceland on January 1, 2008.
d = Date.civil(2008,7,1)
2007-11-30 05:36:08 +01:00
d.holidays(:is)
=> [{:name => 'Nýársdagur'}...]
2007-11-20 01:58:20 +01:00
2007-11-30 05:36:08 +01:00
Lookup Canada Day in different regions.
d = Date.civil(2008,7,1)
2007-11-20 01:58:20 +01:00
2007-11-30 05:36:08 +01:00
d.holiday?(:ca) # Canada
=> true
2007-11-20 01:58:20 +01:00
2007-11-30 05:36:08 +01:00
d.holiday?(:ca_bc) # British Columbia, Canada
=> true
d.holiday?(:fr) # France
=> false
2007-11-20 01:58:20 +01:00
=== Credits and code
2007-11-20 01:58:20 +01:00
* Project page: http://code.dunae.ca/holidays
* Source: http://code.dunae.ca/svn/holidays
* Docs: http://code.dunae.ca/holidays/doc
2007-11-20 01:58:20 +01:00
By Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007.
2007-11-20 01:58:20 +01:00
Made on Vancouver Island.