Image

head

code

item

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

README

B<Holidays::US::Federal> - Provides names, dates, and dates observed for US Federal holidays


=begin code :lang<raku>

use Holidays::US::Federal;

=end code


B<Holidays::US::Federal> is a module that provides information on
the eleven official U.S. federal holidays as of 2023-03-08 according to data
available online at 
L<https://www.opm.gov/policy-data-oversight/pay-leave/federal-holidays/>.
A description of the rules for traditional dates and when holidays are 
actually observed as paid holidays off for federal employees
is also found on the site. All the data reflect current laws
in Title 5 US Code Section 6103.


This module provides a routine which provides a hash of the holidays
for a given year keyed by each holiday's C<date>.
Each key is a Raku C<Date> and the key's value is 
a C<class FedHoliday> object.
The data are perpetual for any given 
year as long as Title 5 US Code Section 6103 stays unchanged.


For this collection there should be no overlapping holidays.
Each instance is one with two different date attributes:
(1) the traditional C<date> and (2) the C<date-observed>
which is the paid day-off for most federal government employees (as well as
for many other employees in the US labor force).
If the dates are identical, then that date is the one to use on a calendar.
If they are different, then both should be used.


Note the holidays also have a C<short-name> attribute which is not official
but has the value used by the author for his calendars.


This library is free software; you may redistribute it or modify it under the Artistic License 2.0.


unit module Holidays::Miscellaneous;

use Holidays::Data;
use Date::Event;
use Date::Utils;

# Valentines Day
# Flag Day
# St Patricks Day
# Mothers Day
# Fathers Day
# Perl Harbor Day
# Armed Forces Day

# National Grandparents' Day - first Sunday after Labor Day (US)
# Election Day - Tuesday after the first Monday of November in even years (US)
#   source: Wikipedia
#
# ===== LATER:
# Hanukkah - [use Raku module Date::Calendar::Hebrew by @jforget ]
#    Jewish festival that begins at the 25th day of Kislev, lasts
#       eight days, and concludes on the second or third day of
#       Tevet (Kislev can have 29 or 30 days). Note the Jewish day
#       begins at sunset.
#   source: Wikipedia

class MiscHoliday is Date::Event is export {}

# holidays are divided into two categories:
#   traditional or fixed (same every year)
#   calculated by some formula

# Valentines Day
# Flag Day
# St Patricks Day
# Mothers Day
# Fathers Day
# Perl Harbor Day
# Armed Forces Day

sub get-misc-holidays(:$year!, :$set-id!, :$debug --> Hash) is export {
    my %h;
    for %misc-holidays.keys -> $id {
        if $id ~~ /:i elect / {
            # special: Election Day only occurs in even years
            # Election Day
            next if $year % 2; # skip odd years
        }

        my $uid = $set-id ~ '|' ~ $id;
        my MiscHoliday $h = calc-misc-holiday-dates :$year, :$id, :$debug;
        %h{$h.date}{$uid} = $h;
    }
    %h
}

# Routines for calculating dates observed
# There are two types:
#   1. Those holidays designated as a certain day of the month.
#   2. Those holidays with assigned dates that may fall on
#      weekends. When the date for a year falls on a Saturday,
#      it is observed on the previous Friday. When the date falls
#      on a Sunday, it is observed on the following Monday.

sub calc-misc-holiday-dates(:$year!, :$id!, :$debug --> MiscHoliday) { # is export {
    # Holidays defined in the %holidays hash with attribute
    # date => "0000-nn-nn" have traditional, designated dates.
    #
    # Holidays with attribute date => "" (empty) are subject to the
    # calculated rule and their actual and observed dates
    # are the same.

    my $name           = %misc-holidays{$id}<name>;
    my $date           = %misc-holidays{$id}<date> // 0;
    my $short-name     = %misc-holidays{$id}<short-name>;
    my $check-id       = %misc-holidays{$id}<id>;
    # for calculated dates
    my $nth-value      = %misc-holidays{$id}<nth-value>;
    my $nth-dow        = %misc-holidays{$id}<nth-dow>;
    my $nth-month      = %misc-holidays{$id}<nth-month>;

    # fixed or directed date
    if $date ~~ /^ '0000-' (\d\d) '-' (\d\d) / {
        my $month = ~$0;
        my $day   = ~$1;
        # the actual date
        $date = Date.new("$year-$month-$day");
    }
    else {
        # calculated date:
        $date = calc-date :$name, :$year, :$debug;
    }
    MiscHoliday.new: :$date, :$id, :$name, :Etype(100), :$short-name;
}

sub calc-date(:$name!, :$year!, :$debug --> Date) {
    # This should be similar to the same routine in Holidays::US::Federal
    my Date $date;
    with $name {
        my ($month, $nth, $dow);

        when $_.contains("Grandp") {
            # we first have to determine Labor day
            # which is first Monday in September
            $month =  9; # same month
            my $Ldow = 1;
            my $Lnth = 1;
            my $Ldate  = nth-day-of-week-in-month :$year, :$month,
                         :day-of-week($Ldow), :nth($Lnth), :$debug;

            # Now Grandparents
            $dow   =  7; # first Sunday after labor day
            $nth   =  1;
            $date = nth-dow-after-date :date($Ldate), :$nth, :$dow;
        }

        # Election Day - Tuesday after the first Monday of November in even years (US)
        #   source: Wikipedia
        when $_.contains("Election") {
            die "FATAL: Election Day is in even years, $year is odd" if $year % 2;
            $month = 11;
            # we first have to determine first Monday in November
            my $Edow = 1;
            my $Enth = 1;
            my $Edate  = nth-day-of-week-in-month :$year, :$month,
                         :day-of-week($Edow), :nth($Enth), :$debug;

            # now the actual day
            $dow   =  2;
            $nth   =  1;
            $date = nth-dow-after-date :date($Edate), :$nth, :$dow;
        }
        when $_.contains("Mother") {
            $month = 5;
            $dow   = 7;
            $nth   = 2;
            $date  = nth-day-of-week-in-month :$year, :$month,
                     :day-of-week($dow), :$nth, :$debug;
        }
        when $_.contains("Armed") {
            $month = 5;
            $dow   = 6;
            $nth   = 3;
            $date  = nth-day-of-week-in-month :$year, :$month,
                     :day-of-week($dow), :$nth, :$debug;
        }
        when $_.contains("Father") {
            $month = 6;
            $dow   = 7;
            $nth   = 3;
            $date  = nth-day-of-week-in-month :$year, :$month,
                     :day-of-week($dow), :$nth, :$debug;
        }
        default {
            die "FATAL: Unknown holiday '$name'";
        }
    }
    $date
}



comment

=begin comment
sub get-hanukkah-start(:$year!, :$debug --> Date) is export {
    # scheme is to do the following:
    #   start with the first day of November
    #   get the Hebrew y/m/d equivalent of that Date
    #   while hebrew date not first day of hanukkah {
    #       get next Date
    #   }
    my Date $us .= new: $year, 11, 1;
    my Date::Calendar::Hebrew $he .= new-from-date: $us;
}
=end comment


Miscellaneous

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


README

NAME

SYNOPSIS

DESCRIPTION

Current holiday list

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE

Holidays::Miscellaneous v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation