blib/lib/Date/Holidays/NYSE.pm

filter: Statementstmt 98.3% 60 / 61 Branchbran 97.7% 43 / 44 Conditioncond 96.7% 151 / 156 MC/DCmcdc 88.7% 63 / 71 Subroutinesub 100% 9 / 9 Podpod 100% 4 / 4 totaltotal 95.6% 330 / 345 CC 75 SCAR 41.7
CC
75
Cov
97%
is_holiday
73.2
holidays
3.0
BEGIN
1.0
CRAP 64.5
↑ Summary
1 package Date::Holidays::NYSE;
2 21 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 21 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 21 ▶use base qw{Exporter};
Subroutine BEGIN: called CC=1 SCAR=0.0
5 21 ▶use POSIX (); #strftime to calculate wday
Subroutine BEGIN: called CC=1 SCAR=0.0
6 21 ▶use Date::Calc 5.0 (); #to calculate Easter and thus Good Friday
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 21 our @EXPORT_OK = qw(is_holiday holidays is_nyse_holiday nyse_holidays);
9 21 our $VERSION = '0.04';
10  
11 =head1 NAME
12  
13 Date::Holidays::NYSE - Date::Holidays Adapter for New York Stock Exchange (NYSE) holidays
14  
15 =head1 SYNOPSIS
16  
17 use Date::Holidays::NYSE qw{is_holiday};
18 my $holiday_name = is_holiday($year, $month, $day);
19  
20 =head1 DESCRIPTION
21  
22 Date::Holidays Adapter for New York Stock Exchange (NYSE) holidays
23  
24 Per https://www.nyse.com/markets/hours-calendars these are the NYSE holidays.
25  
26 New Years Day (not observed on 12/31)
27 Martin Luther King, Jr. Day
28 Washington's Birthday
29 Good Friday (falls between March 20 and April 23)
30 Memorial Day
31 Juneteenth National Independence Day (first observed in 2022)
32 Independence Day
33 Labor Day
34 Thanksgiving Day
35 Christmas Day
36  
37 =head1 METHODS
38  
39 =head2 is_holiday
40  
41 Returns a holiday name or undef given three arguments (year, month, day).
42  
43 my ($year, $month, $day) = (2023, 4, 7);
44 use Date::Holidays::NYSE qw{is_holiday};
45 my $holiday_name = is_holiday($year, $month, $day);
46 if (defined $holiday_name) {
47 print "Holiday: $holiday_name\n"; #Good Friday
48 } else {
49 print "Not a NYSE Holiday\n";
50 }
51  
52 =cut
53  
54 8232 ▶sub is_holiday {
Subroutine is_holiday: called CC=73 SCAR=42.9
Pod documented
55 8232 my $year = shift;
56 8232 my $month = shift;
57 8232 my $day = shift;
58 8232 my $wday = POSIX::strftime(qq{%w}, 0, 0, 0, $day, $month-1, $year-1900); #12:00 am #0=Sun, 1=Mon, 6=Sat
59 8232 my $is_good_friday = 0;
60 8232 ▶ if ($wday == 5 and (($month == 3 and $day >= 20) or ($month == 4 and $day <= 23))) { #Check Fridays in March and April for Good Friday
Branch: 1 branch
BranchTrueFalseTotal
if ($wday == 5 and $month == 3 && $day >= 20 || $month == 4 && $day <= 23) 128 8104 8232
Condition100%12/12
$wday == 5 and $month == 3 && $day >= 20 || $month == 4 && $day <= 23
!ll&&!rl&&r
70471057128
$month == 3 and $day >= 20 or $month == 4 and $day <= 23
l!l&&r!l&&!r
43851057
$month == 3 and $day >= 20
!ll&&!rl&&r
10826043
$month == 4 and $day <= 23
!ll&&!rl&&r
10352285
MC/DC100%5/5
$wday == 5 and $month == 3 && $day >= 20 || $month == 4 && $day <= 23
$wday == 5 $month == 3 $day >= 20 $month == 4 $day <= 23
Truth table75%6/8
A and B and C or D and E
A= $wday == 5B= $month == 3C= $day >= 20D= $month == 4E= $day <= 23
ABCDEresult
0XXXX0
10X0X0
10X100
1100X0
110100
111XX1
10X111
110111
61 # Good Friday is the Friday before Easter Sunday.
62 # Easter can happen on any day from March 22 to April 25.
63 # thus Good Friday can happen on any day from March 20 to April 23.
64 128 my ($year_easter , $month_easter , $day_easter ) = Date::Calc::Easter_Sunday($year);
65 128 my ($year_good_friday, $month_good_friday, $day_good_friday) = Date::Calc::Add_Delta_Days($year_easter, $month_easter, $day_easter, -2);
66 128 ▶ if ($year == $year_good_friday and $month == $month_good_friday and $day == $day_good_friday) {
Branch: 1 branch
BranchTrueFalseTotal
if ($year == $year_good_friday and $month == $month_good_friday and $day == $day_good_friday) 40 88 128
Condition83%5/6
$year == $year_good_friday and $month == $month_good_friday and $day == $day_good_friday
!ll&&!rl&&r
493940
$year == $year_good_friday and $month == $month_good_friday
!ll&&!rl&&r
04979
MC/DC66%2/3
$year == $year_good_friday and $month == $month_good_friday and $day == $day_good_friday
$year == $year_good_friday $month == $month_good_friday $day == $day_good_friday
Truth table75%3/4
A and B and C
A= $year == $year_good_fridayB= $month == $month_good_fridayC= $day == $day_good_friday
ABCresult
0XX0
10X0
1100
1111
67 40 $is_good_friday = 1;
68 }
69 }
70  
71 #Ref: https://www.nyse.com/markets/hours-calendars
72 #Ref: https://web.archive.org/web/20101203013357/http://www.nyse.com/about/newsevents/1176373643795.html
73 #Friday 12/31 - New Years' Day (January 1) in 2011 falls on a Saturday. The rules of the applicable exchanges state that when a holiday falls on a Saturday, we observe the preceding Friday unless the Friday is the end of a monthly or yearly accounting period. In this case, Friday, December 31, 2010 is the end of both a monthly and yearly accounting period; therefore the exchanges will be open that day and the following Monday.
74 8232 ▶ if ($month == 1 and $day == 1 and $wday >= 1 and $wday <= 5) { #New Year's Day on a Weekday
Branch: 18 branches
BranchTrueFalseTotal
if ($month == 1 and $day == 1 and $wday >= 1 and $wday <= 5) { } 34 8198 8232
elsif ($month == 1 and $day == 2 and $wday == 1) { } 6 8192 8198
elsif ($month == 1 and $day >= 15 and $day <= 21 and $wday == 1) { } 40 8152 8192
elsif ($month == 2 and $day >= 15 and $day <= 21 and $wday == 1) { } 40 8112 8152
elsif ($is_good_friday) { } 40 8072 8112
elsif ($month == 5 and $day >= 25 and $day <= 31 and $wday == 1) { } 40 8032 8072
elsif ($year >= 2022 and $month == 6 and $day == 18 and $wday == 5) { } 0 8032 8032
elsif ($year >= 2022 and $month == 6 and $day == 19 and $wday >= 1 and $wday <= 5) { } 12 8020 8032
elsif ($year >= 2022 and $month == 6 and $day == 20 and $wday == 1) { } 2 8018 8020
elsif ($month == 7 and $day == 3 and $wday == 5) { } 8 8010 8018
elsif ($month == 7 and $day == 4 and $wday >= 1 and $wday <= 5) { } 28 7982 8010
elsif ($month == 7 and $day == 5 and $wday == 1) { } 4 7978 7982
elsif ($month == 9 and $day >= 1 and $day <= 7 and $wday == 1) { } 40 7938 7978
elsif ($month == 11 and $day >= 22 and $day <= 28 and $wday == 4) { } 40 7898 7938
elsif ($month == 12 and $day == 24 and $wday == 5) { } 4 7894 7898
elsif ($month == 12 and $day == 25 and $wday >= 1 and $wday <= 5) { } 30 7864 7894
elsif ($month == 12 and $day == 26 and $wday == 1) { } 6 7858 7864
elsif ($year == 2025 and $month == 1 and $day == 9) { } 2 7856 7858
Condition100%9/9
$month == 1 and $day == 1 and $wday >= 1 and $wday <= 5
!ll&&!rl&&r
8194434
$month == 1 and $day == 1 and $wday >= 1
!ll&&!rl&&r
8191338
$month == 1 and $day == 1
!ll&&!rl&&r
750968241
MC/DC100%4/4
$month == 1 and $day == 1 and $wday >= 1 and $wday <= 5
$month == 1 $day == 1 $wday >= 1 $wday <= 5
Truth table100%5/5
A and B and C and D
A= $month == 1B= $day == 1C= $wday >= 1D= $wday <= 5
ABCDresult
0XXX0
10XX0
110X0
11100
11111
75 34 return q{New Year's Day};
76 ▶ } elsif ($month == 1 and $day == 2 and $wday == 1) { #Monday after New Year's Day
Condition100%6/6
$month == 1 and $day == 2 and $wday == 1
!ll&&!rl&&r
8173196
$month == 1 and $day == 2
!ll&&!rl&&r
750966425
MC/DC100%3/3
$month == 1 and $day == 2 and $wday == 1
$month == 1 $day == 2 $wday == 1
Truth table100%4/4
A and B and C
A= $month == 1B= $day == 2C= $wday == 1
ABCresult
0XX0
10X0
1100
1111
77 6 return q{New Year's Day Observed};
78 ▶ } elsif ($month == 1 and $day >= 15 and $day <= 21 and $wday == 1) { #Third Monday in January
Condition100%9/9
$month == 1 and $day >= 15 and $day <= 21 and $wday == 1
!ll&&!rl&&r
802013240
$month == 1 and $day >= 15 and $day <= 21
!ll&&!rl&&r
7800220172
$month == 1 and $day >= 15
!ll&&!rl&&r
7509291392
MC/DC100%4/4
$month == 1 and $day >= 15 and $day <= 21 and $wday == 1
$month == 1 $day >= 15 $day <= 21 $wday == 1
Truth table100%5/5
A and B and C and D
A= $month == 1B= $day >= 15C= $day <= 21D= $wday == 1
ABCDresult
0XXX0
10XX0
110X0
11100
11111
79 40 return 'Martin Luther King, Jr. Day';
80 ▶ } elsif ($month == 2 and $day >= 15 and $day <= 21 and $wday == 1) { #Third Monday in February
Condition100%9/9
$month == 2 and $day >= 15 and $day <= 21 and $wday == 1
!ll&&!rl&&r
798013240
$month == 2 and $day >= 15 and $day <= 21
!ll&&!rl&&r
7818162172
$month == 2 and $day >= 15
!ll&&!rl&&r
7510308334
MC/DC100%4/4
$month == 2 and $day >= 15 and $day <= 21 and $wday == 1
$month == 2 $day >= 15 $day <= 21 $wday == 1
Truth table100%5/5
A and B and C and D
A= $month == 2B= $day >= 15C= $day <= 21D= $wday == 1
ABCDresult
0XXX0
10XX0
110X0
11100
11111
81 40 return q{Washington's Birthday};
82 } elsif ($is_good_friday) { #Good Friday between March 20 and April 23
83 40 return 'Good Friday';
84 ▶ } elsif ($month == 5 and $day >= 25 and $day <= 31 and $wday == 1) { #Last Monday in May
Condition88%8/9
$month == 5 and $day >= 25 and $day <= 31 and $wday == 1
!ll&&!rl&&r
790013240
$month == 5 and $day >= 25 and $day <= 31
!ll&&!rl&&r
79000172
$month == 5 and $day >= 25
!ll&&!rl&&r
7372528172
MC/DC75%3/4
$month == 5 and $day >= 25 and $day <= 31 and $wday == 1
$month == 5 $day >= 25 $day <= 31 $wday == 1
Truth table80%4/5
A and B and C and D
A= $month == 5B= $day >= 25C= $day <= 31D= $wday == 1
ABCDresult
0XXX0
10XX0
110X0
11100
11111
85 40 return 'Memorial Day';
86 ▶ } elsif ($year >= 2022 and $month == 6 and $day == 18 and $wday == 5) { #Juneteenth on a Friday
Condition88%8/9
$year >= 2022 and $month == 6 and $day == 18 and $wday == 5
!ll&&!rl&&r
802390
$year >= 2022 and $month == 6 and $day == 18
!ll&&!rl&&r
77572669
$year >= 2022 and $month == 6
!ll&&!rl&&r
47553002275
MC/DC0%0/4
$year >= 2022 and $month == 6 and $day == 18 and $wday == 5
$year >= 2022 $month == 6 $day == 18 $wday == 5
Truth table80%4/5
A and B and C and D
A= $year >= 2022B= $month == 6C= $day == 18D= $wday == 5
ABCDresult
0XXX0
10XX0
110X0
11100
11111
87 0 return 'Juneteenth National Independence Day Observed';
88 ▶ } elsif ($year >= 2022 and $month == 6 and $day == 19 and $wday >= 1 and $wday <= 5) { #Juneteenth on a weekday
Condition91%11/12
$year >= 2022 and $month == 6 and $day == 19 and $wday >= 1 and $wday <= 5
!ll&&!rl&&r
8020012
$year >= 2022 and $month == 6 and $day == 19 and $wday >= 1
!ll&&!rl&&r
8019112
$year >= 2022 and $month == 6 and $day == 19
!ll&&!rl&&r
775726213
$year >= 2022 and $month == 6
!ll&&!rl&&r
47553002275
MC/DC80%4/5
$year >= 2022 and $month == 6 and $day == 19 and $wday >= 1 and $wday <= 5
$year >= 2022 $month == 6 $day == 19 $wday >= 1 $wday <= 5
Truth table83%5/6
A and B and C and D and E
A= $year >= 2022B= $month == 6C= $day == 19D= $wday >= 1E= $wday <= 5
ABCDEresult
0XXXX0
10XXX0
110XX0
1110X0
111100
111111
89 12 return 'Juneteenth National Independence Day';
90 ▶ } elsif ($year >= 2022 and $month == 6 and $day == 20 and $wday == 1) { #Juneteenth on a Monday
Condition100%9/9
$year >= 2022 and $month == 6 and $day == 20 and $wday == 1
!ll&&!rl&&r
801082
$year >= 2022 and $month == 6 and $day == 20
!ll&&!rl&&r
775725310
$year >= 2022 and $month == 6
!ll&&!rl&&r
47553002263
MC/DC100%4/4
$year >= 2022 and $month == 6 and $day == 20 and $wday == 1
$year >= 2022 $month == 6 $day == 20 $wday == 1
Truth table100%5/5
A and B and C and D
A= $year >= 2022B= $month == 6C= $day == 20D= $wday == 1
ABCDresult
0XXX0
10XX0
110X0
11100
11111
91 2 return 'Juneteenth National Independence Day Observed';
92 ▶ } elsif ($month == 7 and $day == 3 and $wday == 5) { #Friday before July 4
Condition100%6/6
$month == 7 and $day == 3 and $wday == 5
!ll&&!rl&&r
7992188
$month == 7 and $day == 3
!ll&&!rl&&r
731667626
MC/DC100%3/3
$month == 7 and $day == 3 and $wday == 5
$month == 7 $day == 3 $wday == 5
Truth table100%4/4
A and B and C
A= $month == 7B= $day == 3C= $wday == 5
ABCresult
0XX0
10X0
1100
1111
93 8 return 'Independence Day Observed';
94 ▶ } elsif ($month == 7 and $day == 4 and $wday >= 1 and $wday <= 5) { #July 4 on a weekday
Condition100%9/9
$month == 7 and $day == 4 and $wday >= 1 and $wday <= 5
!ll&&!rl&&r
7977528
$month == 7 and $day == 4 and $wday >= 1
!ll&&!rl&&r
7974333
$month == 7 and $day == 4
!ll&&!rl&&r
731665836
MC/DC100%4/4
$month == 7 and $day == 4 and $wday >= 1 and $wday <= 5
$month == 7 $day == 4 $wday >= 1 $wday <= 5
Truth table100%5/5
A and B and C and D
A= $month == 7B= $day == 4C= $wday >= 1D= $wday <= 5
ABCDresult
0XXX0
10XX0
110X0
11100
11111
95 28 return 'Independence Day';
96 ▶ } elsif ($month == 7 and $day == 5 and $wday == 1) { #Monday after July 4
Condition100%6/6
$month == 7 and $day == 5 and $wday == 1
!ll&&!rl&&r
7958204
$month == 7 and $day == 5
!ll&&!rl&&r
731664224
MC/DC100%3/3
$month == 7 and $day == 5 and $wday == 1
$month == 7 $day == 5 $wday == 1
Truth table100%4/4
A and B and C
A= $month == 7B= $day == 5C= $wday == 1
ABCresult
0XX0
10X0
1100
1111
97 4 return 'Independence Day Observed';
98 ▶ } elsif ($month == 9 and $day >= 1 and $day <= 7 and $wday == 1) { #First Monday in September
Condition88%8/9
$month == 9 and $day >= 1 and $day <= 7 and $wday == 1
!ll&&!rl&&r
780613240
$month == 9 and $day >= 1 and $day <= 7
!ll&&!rl&&r
7300506172
$month == 9 and $day >= 1
!ll&&!rl&&r
73000678
MC/DC75%3/4
$month == 9 and $day >= 1 and $day <= 7 and $wday == 1
$month == 9 $day >= 1 $day <= 7 $wday == 1
Truth table80%4/5
A and B and C and D
A= $month == 9B= $day >= 1C= $day <= 7D= $wday == 1
ABCDresult
0XXX0
10XX0
110X0
11100
11111
99 40 return 'Labor Day';
100 ▶ } elsif ($month == 11 and $day >= 22 and $day <= 28 and $wday == 4) { #Fourth Thursday in November.
Condition100%9/9
$month == 11 and $day >= 22 and $day <= 28 and $wday == 4
!ll&&!rl&&r
776613240
$month == 11 and $day >= 22 and $day <= 28
!ll&&!rl&&r
772244172
$month == 11 and $day >= 22
!ll&&!rl&&r
7260462216
MC/DC100%4/4
$month == 11 and $day >= 22 and $day <= 28 and $wday == 4
$month == 11 $day >= 22 $day <= 28 $wday == 4
Truth table100%5/5
A and B and C and D
A= $month == 11B= $day >= 22C= $day <= 28D= $wday == 4
ABCDresult
0XXX0
10XX0
110X0
11100
11111
101 40 return 'Thanksgiving Day';
102 ▶ } elsif ($month == 12 and $day == 24 and $wday == 5) { #Friday before December 25
Condition100%6/6
$month == 12 and $day == 24 and $wday == 5
!ll&&!rl&&r
7874204
$month == 12 and $day == 24
!ll&&!rl&&r
719567924
MC/DC100%3/3
$month == 12 and $day == 24 and $wday == 5
$month == 12 $day == 24 $wday == 5
Truth table100%4/4
A and B and C
A= $month == 12B= $day == 24C= $wday == 5
ABCresult
0XX0
10X0
1100
1111
103 4 return 'Christmas Day Observed';
104 ▶ } elsif ($month == 12 and $day == 25 and $wday >= 1 and $wday <= 5) { #December 25 on a weekday
Condition100%9/9
$month == 12 and $day == 25 and $wday >= 1 and $wday <= 5
!ll&&!rl&&r
7861330
$month == 12 and $day == 25 and $wday >= 1
!ll&&!rl&&r
7857433
$month == 12 and $day == 25
!ll&&!rl&&r
719566237
MC/DC100%4/4
$month == 12 and $day == 25 and $wday >= 1 and $wday <= 5
$month == 12 $day == 25 $wday >= 1 $wday <= 5
Truth table100%5/5
A and B and C and D
A= $month == 12B= $day == 25C= $wday >= 1D= $wday <= 5
ABCDresult
0XXX0
10XX0
110X0
11100
11111
105 30 return 'Christmas Day';
106 ▶ } elsif ($month == 12 and $day == 26 and $wday == 1) { #Monday after December 25
Condition100%6/6
$month == 12 and $day == 26 and $wday == 1
!ll&&!rl&&r
7839196
$month == 12 and $day == 26
!ll&&!rl&&r
719564425
MC/DC100%3/3
$month == 12 and $day == 26 and $wday == 1
$month == 12 $day == 26 $wday == 1
Truth table100%4/4
A and B and C
A= $month == 12B= $day == 26C= $wday == 1
ABCresult
0XX0
10X0
1100
1111
107 6 return 'Christmas Day Observed';
108 ▶ } elsif ($year == 2025 and $month == 1 and $day == 9) { #Day of Mourning for Jimmy Carter
Condition100%6/6
$year == 2025 and $month == 1 and $day == 9
!ll&&!rl&&r
7828282
$year == 2025 and $month == 1
!ll&&!rl&&r
750232630
MC/DC100%3/3
$year == 2025 and $month == 1 and $day == 9
$year == 2025 $month == 1 $day == 9
Truth table100%4/4
A and B and C
A= $year == 2025B= $month == 1C= $day == 9
ABCresult
0XX0
10X0
1100
1111
109 2 return 'Day of Mourning for President Jimmy Carter';
110 } else {
111 7856 return undef;
112 }
113 }
114  
115 =head2 is_nyse_holiday
116  
117 Wrapper around is_holiday function per the API specification. See L<Date::Holidays/is_holiday1>
118  
119 =cut
120  
121 4 ▶sub is_nyse_holiday {return is_holiday(@_)};
Subroutine is_nyse_holiday: called CC=1 SCAR=0.0
Pod documented
122  
123 =head2 holidays
124  
125 Returns a hash reference containing all of the holidays in the specified year. The keys for the returned hash reference are the dates where 2-digit month and 2-digit day are concatenated.
126  
127 use Date::Holidays::US qw{holidays};
128 my $year = 2023;
129 my $holidays_href = holidays($year);
130 foreach my $key (sort keys %$holidays_href) { #e.g. "0101", "0619","0704"
131 my ($month, $day) = $key =~ m/\A([0-9]{2})([0-9]{2})\Z/;
132 my $name = $holidays_href->{$key};
133 print "Year: $year, Month: $month, Day: $day, Name: $name\n";
134 }
135  
136 =cut
137  
138 22 ▶sub holidays {
Subroutine holidays: called CC=3 SCAR=11.0
Pod documented
139 22 my $year = shift;
140 22 my %holidays = ();
141 22 my $time = POSIX::mktime(0, 0, 0, 1, 0, $year-1900); #Jan 1st
142 22 while (1) {
143 8060 my ($year_calculated, $month, $day) = split /-/, POSIX::strftime("%Y-%m-%d", POSIX::gmtime($time));
144 8060 ▶ last if $year_calculated > $year;
Branch: 1 branch
BranchTrueFalseTotal
if $year_calculated > $year 22 8038 8060
145 8038 my $date = $month . $day;
146 8038 my $name = is_holiday($year, $month, $day);
147 8038 ▶ $holidays{$date} = $name if defined($name);
Branch: 1 branch
BranchTrueFalseTotal
if defined $name 206 7832 8038
148 8038 $time += 86400; #Note: Not all US days have 24 hours but we are using UTC for the date component
149 }
150 22 return \%holidays;
151 }
152  
153 =head2 nyse_holidays
154  
155 Wrapper around holidays function per the API specification. See L<Date::Holidays/holidays1>
156  
157 =cut
158  
159 2 ▶sub nyse_holidays {return holidays(@_)};
Subroutine nyse_holidays: called CC=1 SCAR=0.0
Pod documented
160  
161 =head1 SEE ALSO
162  
163 L<Date::Holidays>, L<Date::Holidays::US>
164  
165 =head1 AUTHOR
166  
167 Michael R. Davis, MRDVT
168  
169 =head1 COPYRIGHT AND LICENSE
170  
171 Copyright (C) 2023 by Michael R. Davis
172  
173 MIT License
174  
175 =cut
176  
177 21 1;
↑ Summary