# Inspired by Date::Holidays::DK
# For docs see POD at end of this file

package Date::Holidays::CZ;

use strict;
use warnings;

use Date::Simple;
use Date::Easter;

use base qw(Exporter);
our $VERSION = '0.1';
our @EXPORT = qw( is_cz_holiday cz_holidays );

# Fixed-date holidays {'MMDD' => 'NAME'}
my $FIX = {'0101' => 'Den obnovy samostatného českého státu',
           '0501' => 'Svátek práce',
	   '0508' => 'Den vítězství',
           '0705' => 'Den slovanských věrozvěstů Cyrila a Metoděje',
           '0706' => 'Den upálení mistra Jana Husa',
           '0928' => 'Den české státnosti',
           '1028' => 'Den vzniku samostatného československého státu',
           '1117' => 'Den boje za svobodu a demokracii',
           '1224' => 'Štědrý den',
           '1225' => '1. svátek vánoční',
           '1226' => '2. svátek vánoční'
	  };

# The only variable-date holiday is Easter Monday -- we deal with that separately
my $EM = 'Velikonoční pondělí';

sub is_cz_holiday {
   # returns: name of holiday (true) or 0 (false)

   my ($year, $month, $day) = @_;

   my $k = sprintf "%02d%02d", $month, $day;
   if (exists $FIX->{$k}) {
      # this is a fixed-date holiday
      return $FIX->{$k};
   }

   # Date::Simple overloads the '-' (subtraction) operation for
   # Date::Simple objects. If the difference between the given date
   # and Easter Sunday is +1, then the given date is Easter Monday.
   my $diff = Date::Simple->new($year, $month, $day) - Date::Simple->new($year, easter($year));
   if ( $diff == 1 ) {
      return $EM;
   }

   # In all other cases
   return 0;
}


sub cz_holidays {
   # when given:
   #   - a year
   #   - a year and a month
   #   - a year, a month, and a day
   # returns reference to hash of holidays (or undef, if none)

   my ($year, $month, $day) = @_;

   # Easter Monday is the day after Easter
   my $easter = Date::Simple->new($year, easter($year));
   my $em = $easter + 1;

   # Easter Key ($ek) is a string in the form 'MMDD'
   my $ek = sprintf "%02d%02d", $em->month, $em->day;

   # $h is a reference to a hash containing the results
   my $h;

   if ( ! $month ) { 

      #print "DEBUG: only year given\n";
      $h = {%$FIX};
      $h->{$ek} = $EM;

   } elsif ( ! $day ) { 

      #print "DEBUG: only year and month given\n";
      my $m = sprintf "%02d", $month;
      foreach my $k (keys %$FIX) {
         $h->{$k} = $FIX->{$k} if $k =~ m/\A$m/;
      }
      $h->{$ek} = $EM if $ek =~ m/\A$m/;

   } else { 

      #print "DEBUG: year, month, and day given\n";
      my $k = sprintf "%02d%02d", $month, $day;
      $h->{$k} = $FIX->{$k} if exists $FIX->{$k};
      $h->{$ek} = $EM if $ek == $k;

   }

   return $h;
}

1;

__END__
=pod

=encoding utf8

=head1 NAME

Date::Holidays::CZ - determine Czech Republic bank holidays

=head1 SYNOPSIS

   use Date::Holidays::CZ;
   my ($year, $month, $day) = (localtime)[ 5, 4, 3 ];
       
   $year  += 1900;
   $month += 1;
   print "Woohoo" if is_holiday( $year, $month, $day );

   my $hashref;
   $hashref = cz_holidays(2014);        # full listing for 2014
   $hashref = cz_holidays(2014, 4);     # just for April, 2014
   $hashref = cz_holidays(2014, 4, 8);  # just for April 8, 2014

=head1 VERSION

This POD describes version 0.1 of Date::Holidays::CZ

=head1 DESCRIPTION

In its current, primitive form, this module provides a simple way to
get information on Czech Republic bank holidays. The information it
provides was current at the time the module was written (c. 2013).

Someday, it would nice to develop the module into conformity with the
C<Date::Holidays> paradigm -- i.e. into an "OOP Adapter". First, though,
I will have to figure out what an "OOP Adapter" is!

=head1 CZECH REPUBLIC BANK HOLIDAYS

=head2 Fixed and variable

The dates of all Czech Republic bank holidays are fixed, except for
Easter Monday. 

=head2 Listings 

=head3 English translation

The dates and names (in English translation) of all Czech Republic
bank holidays as of the time of this writing are as follows:

=over 8

=item B<Jan 01> -- Restoration Day of the Independent Czech State

=item B<Apr XY> -- Easter Monday

=item B<May 01> -- Labor Day

=item B<May 08> -- Liberation Day

=item B<Jul 05> -- Saints Cyril and Methodius Day

=item B<Jul 06> -- Jan Hus Day

=item B<Sep 28> -- Feast of St. Wenceslas (Czech Statehood Day)

=item B<Oct 28> -- Independent Czechoslovak State Day

=item B<Nov 17> -- Struggle for Freedom and Democracy Day

=item B<Dec 24> -- Christmas Eve

=item B<Dec 25> -- Christmas Day

=item B<Dec 26> -- Feast of St. Stephen

=back

=head3 Czech original

The dates and names (in the original Czech) of all Czech Republic
bank holidays as of the time of this writing are as follows:

=over 8

=item B<Jan 01> -- Den obnovy samostatného českého státu

=item B<Apr XY> -- Velikonoční pondělí

=item B<May 01> -- Svátek práce

=item B<May 08> -- Den vítězství

=item B<Jul 05> -- Den slovanských věrozvěstů Cyrila a Metoděje

=item B<Jul 06> -- Den upálení mistra Jana Husa

=item B<Sep 28> -- Den české státnosti

=item B<Oct 28> -- Den vzniku samostatného československého státu

=item B<Nov 17> -- Den boje za svobodu a demokracii

=item B<Dec 24> -- Štědrý den

=item B<Dec 25> -- 1. svátek vánoční

=item B<Dec 26> -- 2. svátek vánoční

=back

=head1 SUBROUTINES/METHODS

=head2 C<is_cz_holiday>

Takes three named arguments:

=over 8

=item * C<year>, four-digit number

=item * C<month>, 1-12, two-digit number

=item * C<day>, 1-31, two-digit number

=back

=head2 C<cz_holidays>

Takes a single named argument, C<year> (four-digit number).
Optionally, can also take a second argument, C<month> (1-12, two-digit number)
and a third argument, C<day> (1-31, two-digit number).

In all cases, the subroutine returns a reference to a hash in which
the keys are 'MMDD' (month and day, concatenated) and the values are
the names of all the various bank holidays that fall within the time
span indicated by the arguments (year, month, or day).

=head3 Examples

For examples, see L<SYNOPSIS>, above.

=head1 DEPENDENCIES

=over 8

=item * C<Date::Simple>

=item * C<Date::Easter>

=back

=head1 AUTHOR

C<< Nathan Cutler <presnypreklad@gmail.com> >>

=head1 LICENSE AND COPYRIGHT

Copyright 2013-2014 SUSE LLC

C<Date::Holidays::CZ> is released under the Artistic License, as
specified by the Artistic file in the standard Perl distribution
(L<http://dev.perl.org/licenses/artistic.html>)

=cut
