In Files

Parent

Object

Included Modules

Class/Module Index [+]

Quicksearch

Date

Extending Ruby's Date class with the Holidays gem

The Holidays gem automatically extends Ruby's Date class and gives you access to three new methods: holiday?, holidays and calculate_mday.

Examples

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'...}]

Public Class Methods

calculate_mday(year, month, week, wday) click to toggle source

Calculate day of the month based on the week number and the day of the week.

Parameters

year

Integer.

month

Integer from 1-12.

week

One of :first, :second, :third, :fourth, :fifth or :last.

wday

Day of the week as an integer from 0 (Sunday) to 6 (Saturday) or as a symbol (e.g. :monday).

Returns an integer.

Examples

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
# File lib/holidays.rb, line 464
def self.calculate_mday(year, month, week, wday)
  raise ArgumentError, "Week parameter must be one of Holidays::WEEKS (provided #{week})." unless WEEKS.include?(week) or WEEKS.has_value?(week)

  unless wday.kind_of?(Numeric) and wday.between?(0,6) or DAY_SYMBOLS.index(wday)
    raise ArgumentError, "Wday parameter must be an integer between 0 and 6 or one of Date::DAY_SYMBOLS."
  end

  week = WEEKS[week] if week.kind_of?(Symbol)
  wday = DAY_SYMBOLS.index(wday) if wday.kind_of?(Symbol)

  # :first, :second, :third, :fourth or :fifth
  if week > 0
    return ((week - 1) * 7) + 1 + ((wday - Date.civil(year, month,(week-1)*7 + 1).wday) % 7)
  end
  
  days = MONTH_LENGTHS[month-1]

  days = 29 if month == 2 and Date.leap?(year)
    
  return days - ((Date.civil(year, month, days).wday - wday + 7) % 7) - (7 * (week.abs - 1))
end

Public Instance Methods

holiday?(*options) click to toggle source

Check if the current date is a holiday.

Returns true or false.

Date.civil('2008-01-01').holiday?(:ca)
=> true
# File lib/holidays.rb, line 432
def holiday?(*options)
  holidays = self.holidays(options)
  holidays && !holidays.empty?
end
holidays(*options) click to toggle source

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.

# File lib/holidays.rb, line 422
def holidays(*options)
  Holidays.on(self, options)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.