Detecting holidays

Hi all,

Well, it took seven years, but I've finally been annoyed enough by
reports failing on national holidays to say something. Report writers
know the routine:

Them: Why did the report fail for Jan. 1st?
Me: National holiday. There was no data to grab. Ignore the failure.
Them: Oh, right.

Repeat again for Memorial Day, July 4th, Thanksgiving, and Christmas.

Is there a package out there that deals with national holidays (for any
nation)? The only thing I came across what date2, but that only seems
to handle Japanese national holidays. I guess I'm looking for
something like Perl's Date::Calc [1] module or, more specifically, it's
days).

Ideally, I'd like to be able to do something like:

if Date.today.is_national_holiday?
   exit # Don't run report on this day
end

And no, it's not a simple matter of using something more flexible than
cron because some reports pull data from X days back or ahead, not on
the date they're run.

Thoughts?

- Dan

[1] http://search.cpan.org/~stbey/Date-Calc-5.4/Calendar.pod
[2]
http://search.cpan.org/~stbey/Date-Calc-5.4/lib/Date/Calendar/Profiles.pod
[3]
http://search.cpan.org/~jonasbn/Date-Holidays-0.08/lib/Date/Holidays.pm

···

Date::calendar::Profiles [2] module. Or something like Perl's
Date::Holidays::XXX [3] approach (I'm not sure which is preferred these

Try this:

class Date
  def is_national_holiday?
     this_year = self.year.to_s
     # Not perfect; Thanksgiving and Easter change...
     dates = [this_year + '-12-25', this_year + '-12-24', this_year +
'-1-1', this_year + '-7-4', this_year + '-11-28']

     if (dates.include?(self.to_s)):
        return true
     else
        return false
     end
   end
end

irb(main):263:0> christmas = Date.parse('2007-12-25')
=> #<Date: 4908919/2,0,2299161>
irb(main):264:0> christmas.is_national_holiday?
=> true
irb(main):265:0> today = Date.today
=> #<Date: 4908205/2,0,2299161>
irb(main):266:0> today.is_national_holiday?
=> false

Again, it doesn't get Thanksgiving right or others that change like
Easter. If you want, I could hack it in; otherwise, this should get
you on the right path. :wink:

--Jeremy

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

Hi all,

Well, it took seven years, but I've finally been annoyed enough by
reports failing on national holidays to say something. Report writers
know the routine:

Them: Why did the report fail for Jan. 1st?
Me: National holiday. There was no data to grab. Ignore the failure.
Them: Oh, right.

Repeat again for Memorial Day, July 4th, Thanksgiving, and Christmas.

Is there a package out there that deals with national holidays (for any
nation)? The only thing I came across what date2, but that only seems
to handle Japanese national holidays. I guess I'm looking for
something like Perl's Date::Calc [1] module or, more specifically, it's
Date::calendar::Profiles [2] module. Or something like Perl's
Date::Holidays::XXX [3] approach (I'm not sure which is preferred these
days).

Ideally, I'd like to be able to do something like:

if Date.today.is_national_holiday?
   exit # Don't run report on this day
end

And no, it's not a simple matter of using something more flexible than
cron because some reports pull data from X days back or ahead, not on
the date they're run.

Thoughts?

- Dan

[1] Date::Calendar - Calendar objects for different holiday schemes - metacpan.org
[2]
Date::Calendar::Profiles - Some sample profiles for Date::Calendar and Date::Calendar::Year - metacpan.org
[3]
http://search.cpan.org/~jonasbn/Date-Holidays-0.08/lib/Date/Holidays.pm

--
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/

My blogs:

http://www.rubyinpractice.com/

Them: Why did the report fail for Jan. 1st?
Me: National holiday. There was no data to grab. Ignore the failure.
Them: Oh, right.

[snip]

Ideally, I'd like to be able to do something like:

if Date.today.is_national_holiday?
  exit # Don't run report on this day
end

Nice, but won't this just change the problem to:

Them: Why is there no report for Jan. 1st?

What currently happens when the report 'fails'? Could you generate an
empty report that says

'No data available for today. Was it a holiday?'

That might solve your actual problem, without introducing a 'holidays'
module. Though if your reports often fail for other reasons, perhaps
you do need to detect holidays to distinguish them rom real error
conditions.

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:
--
Kieran Tully, Software Developer and Tenor, http://ktully.net

<...>

The best way I know of checking for holidays is somehow keeping a
record of which dates are holidays in a given year. It can be a
database table, or some sort of configuration files when that isn't
possible.

This record would have to be mantained manually, but it would be just
a simple case of editing the table/file every time you buy a new
calendar :).

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

Hi all,

Well, it took seven years, but I've finally been annoyed enough by
reports failing on national holidays to say something. Report writers
know the routine:

--
Bira

http://sinfoniaferida.blogspot.com

You may be able to build something that checks againt an iCalendar
file of holidays.

* webcal://ical.mac.com/ical/US32Holidays.ics
* http://www.infinitenil.com/developers.html
* Radar – O’Reilly

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

Is there a package out there that deals with national holidays (for any
nation)? The only thing I came across what date2, but that only seems
to handle Japanese national holidays. I guess I'm looking for
something like Perl's Date::Calc [1] module or, more specifically, it's
Date::calendar::Profiles [2] module. Or something like Perl's
Date::Holidays::XXX [3] approach (I'm not sure which is preferred these
days).

Ideally, I'd like to be able to do something like:

if Date.today.is_national_holiday?
   exit # Don't run report on this day
end

Okay, I got the code done. I just need to create lists of holidays
now. I can do the U.S. holidays (if I need any help algorithm-wise,
I'll let you guys know...), but I have no clue about UK or anyone
else's holidays. Anyone from another locality care to englighten me?

I called it "special_days" because Im hoping it can be used for
purposes other than just holidays (birthdays? patch_days? The
possibilities are approaching limitless!).

I'm working on getting a gem together right now...

--Jeremy

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

Hi all,

Well, it took seven years, but I've finally been annoyed enough by
reports failing on national holidays to say something. Report writers
know the routine:

Them: Why did the report fail for Jan. 1st?
Me: National holiday. There was no data to grab. Ignore the failure.
Them: Oh, right.

Repeat again for Memorial Day, July 4th, Thanksgiving, and Christmas.

Is there a package out there that deals with national holidays (for any
nation)? The only thing I came across what date2, but that only seems
to handle Japanese national holidays. I guess I'm looking for
something like Perl's Date::Calc [1] module or, more specifically, it's
Date::calendar::Profiles [2] module. Or something like Perl's
Date::Holidays::XXX [3] approach (I'm not sure which is preferred these
days).

Ideally, I'd like to be able to do something like:

if Date.today.is_national_holiday?
   exit # Don't run report on this day
end

And no, it's not a simple matter of using something more flexible than
cron because some reports pull data from X days back or ahead, not on
the date they're run.

Thoughts?

- Dan

[1] Date::Calendar - Calendar objects for different holiday schemes - metacpan.org
[2]
Date::Calendar::Profiles - Some sample profiles for Date::Calendar and Date::Calendar::Year - metacpan.org
[3]
http://search.cpan.org/~jonasbn/Date-Holidays-0.08/lib/Date/Holidays.pm

--
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/

My blogs:

http://www.rubyinpractice.com/

Kieran Tully wrote:

> Them: Why did the report fail for Jan. 1st?
> Me: National holiday. There was no data to grab. Ignore the failure.
> Them: Oh, right.
[snip]
> Ideally, I'd like to be able to do something like:
>
> if Date.today.is_national_holiday?
> exit # Don't run report on this day
> end

Nice, but won't this just change the problem to:

Them: Why is there no report for Jan. 1st?

What currently happens when the report 'fails'? Could you generate an
empty report that says

'No data available for today. Was it a holiday?'

True, I may end up doing that in practice.

That might solve your actual problem, without introducing a 'holidays'
module. Though if your reports often fail for other reasons, perhaps
you do need to detect holidays to distinguish them rom real error
conditions.

Yes, sometimes they fail for other reasons, such as the network or
database flaking out briefly. So, in practice I see myself doing
something like:

begin
    # main report body
rescue ReportException
   if Date.today.is_national_holiday?
      # note in log that it was a holiday, in case anyone asks.
   else
      raise
   end
end

It might be a little trickier than that in practice, but that's the
general idea.

Regards,

Dan

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

For those sort of holidays you could use the Chronic gem to parse a textual date:

irb(main):010:0> Chronic.parse('4th thursday in november')
=> Thu Nov 22 11:00:00 -0500 2007

Still kind of a shame there isn't just a 'holidays' gem.

-Mat

···

On Jan 2, 2007, at 11:56 AM, Jeremy McAnally wrote:

Try this:

class Date
def is_national_holiday?
    this_year = self.year.to_s
    # Not perfect; Thanksgiving and Easter change...
    dates = [this_year + '-12-25', this_year + '-12-24', this_year +
'-1-1', this_year + '-7-4', this_year + '-11-28']

    if (dates.include?(self.to_s)):
       return true
    else
       return false
    end
  end
end

irb(main):263:0> christmas = Date.parse('2007-12-25')
=> #<Date: 4908919/2,0,2299161>
irb(main):264:0> christmas.is_national_holiday?
=> true
irb(main):265:0> today = Date.today
=> #<Date: 4908205/2,0,2299161>
irb(main):266:0> today.is_national_holiday?
=> false

Again, it doesn't get Thanksgiving right or others that change like
Easter. If you want, I could hack it in; otherwise, this should get
you on the right path. :wink:

Bira wrote:

> Hi all,
>
> Well, it took seven years, but I've finally been annoyed enough by
> reports failing on national holidays to say something. Report writers
> know the routine:

<...>

The best way I know of checking for holidays is somehow keeping a
record of which dates are holidays in a given year. It can be a
database table, or some sort of configuration files when that isn't
possible.

This record would have to be mantained manually, but it would be just
a simple case of editing the table/file every time you buy a new
calendar :).

For fixed holidays, sure - I think that's what Date::Calc does (i.e.
read an external file in, base on the selected country). But for
floating holidays I would prefer a general algorithm. Surely someone
can come up with a general algorithm for "3rd Thursday in November",
etc. I'll bet the Rails folks already have something, but I haven't
looked.

Regards,

Dan

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

RubyConf Days?

···

On Wed, 2007-01-03 at 11:38 +0900, Jeremy McAnally wrote:

Okay, I got the code done. I just need to create lists of holidays
now. I can do the U.S. holidays (if I need any help algorithm-wise,
I'll let you guys know...), but I have no clue about UK or anyone
else's holidays. Anyone from another locality care to englighten me?

I called it "special_days" because Im hoping it can be used for
purposes other than just holidays (birthdays? patch_days? The
possibilities are approaching limitless!).

Jeremy McAnally wrote:

Okay, I got the code done. I just need to create lists of holidays
now. I can do the U.S. holidays (if I need any help algorithm-wise,
I'll let you guys know...), but I have no clue about UK or anyone
else's holidays. Anyone from another locality care to englighten me?

http://www.dti.gov.uk/employment/bank-public-holidays/index.html

This may also be of use:

Unfortunately, there doesn't seem to be much explanation of the logic behind them.

···

--
Alex

I thought of Chronic (a fine library that I use often!); I'm toying
around with it right now and I think I have it figured out (without
using Chronic)...

I'll re-post the code later on...and maybe make a little gem for those
(i.e, four people) who need it. :wink:

--Jeremy

···

On 1/2/07, Mat Schaffer <schapht@gmail.com> wrote:

On Jan 2, 2007, at 11:56 AM, Jeremy McAnally wrote:

> Try this:
>
> class Date
> def is_national_holiday?
> this_year = self.year.to_s
> # Not perfect; Thanksgiving and Easter change...
> dates = [this_year + '-12-25', this_year + '-12-24', this_year +
> '-1-1', this_year + '-7-4', this_year + '-11-28']
>
> if (dates.include?(self.to_s)):
> return true
> else
> return false
> end
> end
> end
>
> irb(main):263:0> christmas = Date.parse('2007-12-25')
> => #<Date: 4908919/2,0,2299161>
> irb(main):264:0> christmas.is_national_holiday?
> => true
> irb(main):265:0> today = Date.today
> => #<Date: 4908205/2,0,2299161>
> irb(main):266:0> today.is_national_holiday?
> => false
>
> Again, it doesn't get Thanksgiving right or others that change like
> Easter. If you want, I could hack it in; otherwise, this should get
> you on the right path. :wink:

For those sort of holidays you could use the Chronic gem to parse a
textual date:

irb(main):010:0> Chronic.parse('4th thursday in november')
=> Thu Nov 22 11:00:00 -0500 2007

Still kind of a shame there isn't just a 'holidays' gem.

-Mat

--
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/

My blogs:

http://www.rubyinpractice.com/

Emacs has a really robust holidays library that's not too lengthy, perhaps a
good topic for a Ruby quiz or someone's spare time to just port it to Ruby?

/Nick

···

On 1/2/07, Mat Schaffer <schapht@gmail.com> wrote:

For those sort of holidays you could use the Chronic gem to parse a
textual date:

irb(main):010:0> Chronic.parse('4th thursday in november')
=> Thu Nov 22 11:00:00 -0500 2007

Still kind of a shame there isn't just a 'holidays' gem.

Daniel Berger wrote:

Bira wrote:
> > Hi all,
> >
> > Well, it took seven years, but I've finally been annoyed enough by
> > reports failing on national holidays to say something. Report writers
> > know the routine:
>
> <...>
>
> The best way I know of checking for holidays is somehow keeping a
> record of which dates are holidays in a given year. It can be a
> database table, or some sort of configuration files when that isn't
> possible.
>
> This record would have to be mantained manually, but it would be just
> a simple case of editing the table/file every time you buy a new
> calendar :).

For fixed holidays, sure - I think that's what Date::Calc does (i.e.
read an external file in, base on the selected country). But for
floating holidays I would prefer a general algorithm. Surely someone
can come up with a general algorithm for "3rd Thursday in November",
etc. I'll bet the Rails folks already have something, but I haven't
looked.

Regards,

Dan

And whatever solution, it needs to be dynamically updatable to account
for suddenly announced national "holidays", like today happens to be -
doh!

Ken

···

> On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

Daniel Berger wrote:

Bira wrote:

Hi all,

Well, it took seven years, but I've finally been annoyed enough by
reports failing on national holidays to say something. Report writers
know the routine:

<...>

The best way I know of checking for holidays is somehow keeping a
record of which dates are holidays in a given year. It can be a
database table, or some sort of configuration files when that isn't
possible.

This record would have to be mantained manually, but it would be just
a simple case of editing the table/file every time you buy a new
calendar :).

For fixed holidays, sure - I think that's what Date::Calc does (i.e.
read an external file in, base on the selected country). But for
floating holidays I would prefer a general algorithm. Surely someone
can come up with a general algorithm for "3rd Thursday in November",
etc. I'll bet the Rails folks already have something, but I haven't
looked.

Regards,

Dan

I have an old copy of Computer Language that includes the C source for Julian dates. One of the functions is the determination of Easter for any given year. If you are interested in just that algorithm or the entire code let me know. I assume that the determination of Thanksgiving (for the US) would be trivial from there.
The only other real problem is that some states, Nevada for example, change at least one of the holidays, where the state doesn't take Columbus day off but takes off October 31st -- state admission day.

···

On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:

I haven't forgotten! I'm trying to get the architecture right (I was
modifying the Date class directly, but now I made a module), but I'm
having some testing problems (for some reason it's not including the
default Date class first before my extensions...even though I'm
requiring it.

I'm working on it!

--Jeremy

···

On 1/3/07, Alex Young <alex@blackkettle.org> wrote:

Jeremy McAnally wrote:
> Okay, I got the code done. I just need to create lists of holidays
> now. I can do the U.S. holidays (if I need any help algorithm-wise,
> I'll let you guys know...), but I have no clue about UK or anyone
> else's holidays. Anyone from another locality care to englighten me?
http://www.dti.gov.uk/employment/bank-public-holidays/index.html

This may also be of use:

Category:Public holidays by country - Wikipedia

Unfortunately, there doesn't seem to be much explanation of the logic
behind them.

--
Alex

--
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/

My blogs:

http://www.rubyinpractice.com/

Well, the way I'm working it out is like AR's dynamic finders. It
will have a few groups of dates hardcoded (like national holidays and
such), but then you can give it new groups in the form hashes of
arrays of dates with named "work_holidays" or "surprise_offdays" and
then call the method like is_a_work_holiday? or is_a_surprise_offday?.
  I'm still working on it...I'll post when I've got it done.

--Jeremy

···

On 1/2/07, Kenosis <kenosis@gmail.com> wrote:

Daniel Berger wrote:
> Bira wrote:
> > On 1/2/07, Daniel Berger <djberg96@gmail.com> wrote:
> > > Hi all,
> > >
> > > Well, it took seven years, but I've finally been annoyed enough by
> > > reports failing on national holidays to say something. Report writers
> > > know the routine:
> >
> > <...>
> >
> > The best way I know of checking for holidays is somehow keeping a
> > record of which dates are holidays in a given year. It can be a
> > database table, or some sort of configuration files when that isn't
> > possible.
> >
> > This record would have to be mantained manually, but it would be just
> > a simple case of editing the table/file every time you buy a new
> > calendar :).
>
> For fixed holidays, sure - I think that's what Date::Calc does (i.e.
> read an external file in, base on the selected country). But for
> floating holidays I would prefer a general algorithm. Surely someone
> can come up with a general algorithm for "3rd Thursday in November",
> etc. I'll bet the Rails folks already have something, but I haven't
> looked.
>
> Regards,
>
> Dan
And whatever solution, it needs to be dynamically updatable to account
for suddenly announced national "holidays", like today happens to be -
doh!

Ken

--
My free Ruby e-book:
http://www.humblelittlerubybook.com/book/

My blogs:

http://www.rubyinpractice.com/

Jeremy McAnally wrote:

I haven't forgotten! I'm trying to get the architecture right (I was
modifying the Date class directly, but now I made a module), but I'm
having some testing problems (for some reason it's not including the
default Date class first before my extensions...even though I'm
requiring it.

I'm working on it!

I tinkered a bit with the notion of using a module instead of monkey
patching the Date class (or subclassing) but I wasn't satisfied with
the interface. I'll be curious to see what you come up with.

Regards,

Dan

Sounds neat. Just please bottom post when replying :slight_smile:
-Mat

···

On Jan 2, 2007, at 2:37 PM, Jeremy McAnally wrote:

Well, the way I'm working it out is like AR's dynamic finders. It
will have a few groups of dates hardcoded (like national holidays and
such), but then you can give it new groups in the form hashes of
arrays of dates with named "work_holidays" or "surprise_offdays" and
then call the method like is_a_work_holiday? or is_a_surprise_offday?.
I'm still working on it...I'll post when I've got it done.

--Jeremy

Jeremy McAnally wrote:

Well, the way I'm working it out is like AR's dynamic finders. It
will have a few groups of dates hardcoded (like national holidays and
such), but then you can give it new groups in the form hashes of
arrays of dates with named "work_holidays" or "surprise_offdays" and
then call the method like is_a_work_holiday? or is_a_surprise_offday?.
  I'm still working on it...I'll post when I've got it done.

Actually, once I took a stab at it, I think it's fairly easy for the
national holidays IF I'm using Date#cweek correctly and reliably here:

require 'date'

class Date
   def thanksgiving?
      month == 11 && wday == 4 && cweek == 3
   end

   def christmas?
      month == 12 && day == 25
   end

   def new_years?
      month == 1 && day == 1
   end

   alias new_year new_years
   alias new_years_day new_years

   def memorial_day?
      if month == 5 && wday == 1 && cweek == 5
   end

   def independence_day?
      month == 7 && day == 4
   end

   alias fourth_of_july? independence_day?

   def national_holiday?
      new_years? && memorial_day? && independence_day? && thanksgiving?
&&
      christmas?
   end
end

How's that?

Regards,

Dan