Date/Holidays/GB.pm

filter: Statementstmt 93.5% 101 / 108 Branchbran 89.5% 43 / 48 Conditioncond 62.5% 15 / 24 MC/DCmcdc 38.4% 5 / 13 Subroutinesub 76.4% 13 / 17 Podpod 44.4% 4 / 9 totaltotal 82.6% 181 / 219 CC 39 SCAR 19.7
CC
39
Cov
88%
holidays
11.1
is_holiday
9.4
next_holiday
9.0
CRAP 7.2
↑ Summary Date/Holidays/GB/NIR.pm »
1 package Date::Holidays::GB;
2  
3 4 our $VERSION = '0.025';
4  
5 # ABSTRACT: Determine British holidays - Current UK public and bank holiday dates up to 2028
6  
7 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 4 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 4 ▶use utf8;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 4 ▶use DateTime;
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 4 ▶use base qw( Date::Holidays::Super Exporter );
Subroutine BEGIN: called CC=1 SCAR=0.0
14 4 our @EXPORT_OK = qw(
15 holidays
16 gb_holidays
17 holidays_ymd
18 is_holiday
19 is_gb_holiday
20 next_holiday
21 next_gb_holiday
22 );
23  
24 # See
25 # https://en.wikipedia.org/wiki/ISO_3166-2
26 # https://en.wikipedia.org/wiki/ISO_3166-2:GB
27  
28 4 ▶use constant REGION_NAMES => {
Subroutine BEGIN: called CC=1 SCAR=0.0
29 EAW => 'England & Wales',
30 SCT => 'Scotland',
31 NIR => 'Northern Ireland',
32 4 };
33 4 ▶use constant REGIONS => [ sort keys %{ +REGION_NAMES } ];
Subroutine BEGIN: called CC=1 SCAR=0.0
34  
35 4 our %holidays;
36 4 set_holidays(\*DATA);
37  
38 7 ▶sub set_holidays {
Subroutine set_holidays: called CC=8 SCAR=20.8
Pod undocumented
39 7 my $fh = shift;
40 7 ▶ while (<$fh>) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($_ = readline $fh)) 1968 7 1975
41 1968 chomp;
42 1968 my ( $date, $region, $name ) = split /\t/;
43 1968 ▶ next unless $date && $region && $name;
Branch: 1 branch
BranchTrueFalseTotal
unless $date and $region and $name 3 1965 1968
Condition66%4/6
$date and $region and $name
!ll&&!rl&&r
301965
$date and $region
!ll&&!rl&&r
301965
MC/DC33%1/3
$date and $region and $name
$date $region $name
Truth table50%2/4
A and B and C
A= $dateB= $regionC= $name
ABCresult
0XX0
10X0
1100
1111
44  
45 1965 my ( $y, $m, $d ) = split /-/, $date;
46 1965 $holidays{$y}->{$date}->{$region} = $name;
47 }
48  
49 # Define an 'all' if all three regions have a holiday on this day, taking
50 # EAW name as the canonical name
51 7 ▶ while ( my ( $year, $dates ) = each %holidays ) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %Date::Holidays::GB::holidays) 119 7 126
52 119 foreach my $holiday ( values %{$dates} ) {
53 $holiday->{all} = $holiday->{EAW}
54 1575 ▶ if keys %{$holiday} == @{ +REGIONS };
Branch: 1 branch
BranchTrueFalseTotal
if keys %{$holiday;} == @{["EAW","NIR","SCT"];} 424 1151 1575
55 }
56 }
57 }
58  
59 0 ▶sub gb_holidays { return holidays(@_) }
Subroutine gb_holidays: not called CC=1 SCAR=6.9
Pod undocumented
60  
61 7 ▶sub holidays {
Subroutine holidays: called CC=10 SCAR=24.1
Pod documented
62 7 ▶ my %args
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /\D/ ? : 4 3 7
63 = $_[0] =~ m/\D/
64 ? @_
65 : ( year => $_[0], regions => $_[1] );
66  
67 7 ▶ unless ( exists $args{year} && defined $args{year} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (exists $args{"year"} and defined $args{"year"}) 0 7 7
Condition33%1/3
exists $args{"year"} and defined $args{"year"}
!ll&&!rl&&r
007
MC/DC0%0/2
exists $args{"year"} and defined $args{"year"}
exists $args{"year"} defined $args{"year"}
Truth table33%1/3
A and B
A= exists $args{"year"}B= defined $args{"year"}
ABresult
0X0
100
111
68 0 $args{year} = ( localtime(time) )[5];
69 0 $args{year} += 1900;
70 }
71  
72 7 ▶ unless ( $args{year} =~ /^\d{4}$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($args{"year"} =~ /^\d{4}$/) 0 7 7
73 0 die "Year must be numeric and four digits, eg '2004'";
74 }
75  
76 # return if empty regions list (undef gets full list)
77 7 ▶ my @region_codes = @{ $args{regions} || REGIONS }
Branch: 1 branch
BranchTrueFalseTotal
my(@region_codes) = @{$args{"regions"} or ["EAW","NIR","SCT"];} or return {} 7 0 7
Condition100%2/2
$args{'regions'} || ['EAW', 'NIR', 'SCT']
l!l
34
MC/DC100%1/1
$args{'regions'} || ['EAW', 'NIR', 'SCT']
$args{'regions'}
Truth table100%2/2
A
A= $args{'regions'}
Aresult
11
00
78 or return {};
79  
80 7 my %return;
81  
82 7 ▶ while ( my ( $date, $holiday ) = each %{ $holidays{ $args{year} } } ) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %{$Date::Holidays::GB::holidays{$args{"year"}};}) 65 7 72
83 65 ▶ my $string = _holiday( $holiday, \@region_codes )
Branch: 1 branch
BranchTrueFalseTotal
my $string = _holiday($holiday, \@region_codes) or next 51 14 65
84 or next;
85  
86 51 ▶ if ( $args{ymd} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($args{'ymd'}) { } 13 38 51
87 13 $return{$date} = $string;
88 }
89 else {
90 38 my ( undef, $m, undef, $d ) = unpack( 'A5A2A1A2', $date );
91 38 $return{ $m . $d } = $string;
92 }
93 }
94  
95 7 return \%return;
96 }
97  
98 1 ▶sub holidays_ymd {
Subroutine holidays_ymd: called CC=2 SCAR=7.2
Pod undocumented
99 1 ▶ my %args
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /\D/ ? : 0 1 1
100 = $_[0] =~ m/\D/
101 ? @_
102 : ( year => $_[0], regions => $_[1] );
103  
104 1 return holidays( %args, ymd => 1 );
105 }
106  
107 0 ▶sub is_gb_holiday { return is_holiday(@_) }
Subroutine is_gb_holiday: not called CC=1 SCAR=6.9
Pod undocumented
108  
109 24 ▶sub is_holiday {
Subroutine is_holiday: called CC=9 SCAR=22.4
Pod documented
110 24 ▶ my %args
Branch: 1 branch
BranchTrueFalseTotal
$_[0] =~ /[^0-9-]/ ? : 18 6 24
111 = $_[0] =~ m/[^0-9-]/
112 ? @_
113 : ( year => $_[0], month => $_[1], day => $_[2], regions => $_[3] );
114  
115 24 my ( $y, $m, $d );
116  
117 24 ▶ if ( $args{date} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($args{'date'}) { } 6 18 24
118 6 ( $y, $m, $d ) = $args{date} =~ m{^([0-9]{4})-([0-9]{2})-([0-9]{2})$};
119 }
120 else {
121 18 ( $y, $m, $d ) = @args{qw( year month day )};
122 }
123  
124 24 ▶ die "Must specify either 'date' or 'year', 'month' and 'day'"
Branch: 1 branch
BranchTrueFalseTotal
unless $y and $m and $d 0 24 24
Condition33%2/6
$y and $m and $d
!ll&&!rl&&r
0024
$y and $m
!ll&&!rl&&r
0024
MC/DC0%0/3
$y and $m and $d
$y $m $d
Truth table25%1/4
A and B and C
A= $yB= $mC= $d
ABCresult
0XX0
10X0
1100
1111
125 unless $y && $m && $d;
126  
127 24 my $date = sprintf( "%04d-%02d-%02d", $y, $m, $d );
128  
129 # return if empty regions list (undef gets full list)
130 24 ▶ my @region_codes = @{ $args{regions} || REGIONS }
Branch: 1 branch
BranchTrueFalseTotal
my(@region_codes) = @{$args{"regions"} or ["EAW","NIR","SCT"];} or return 21 3 24
Condition100%2/2
$args{'regions'} || ['EAW', 'NIR', 'SCT']
l!l
186
MC/DC100%1/1
$args{'regions'} || ['EAW', 'NIR', 'SCT']
$args{'regions'}
Truth table100%2/2
A
A= $args{'regions'}
Aresult
11
00
131 or return;
132  
133 # return if no region has holiday
134 21 ▶ my $holiday = $holidays{$y}->{$date}
Branch: 1 branch
BranchTrueFalseTotal
my $holiday = $Date::Holidays::GB::holidays{$y}{$date} or return 13 8 21
135 or return;
136  
137 13 return _holiday( $holiday, \@region_codes );
138 }
139  
140 0 ▶sub next_gb_holiday { return next_holiday(@_) }
Subroutine next_gb_holiday: not called CC=1 SCAR=6.9
Pod undocumented
141  
142 4 ▶sub next_holiday {
Subroutine next_holiday: called CC=9 SCAR=22.0
Pod documented
143 4 my @regions = @_;
144  
145 4 ▶ unless (@regions) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@regions) 2 2 4
146 2 @regions = ( 'all', @{ +REGIONS } );
147 }
148  
149 4 my $now = DateTime->now->set_time_zone("Europe/London");
150 4 my $year = $now->year;
151 4 my $today = $now->ymd;
152  
153 4 my %next_holidays;
154  
155 4 foreach my $date ( sort keys %{ $holidays{$year} } ) {
156 36 ▶ next unless $date gt $today;
Branch: 1 branch
BranchTrueFalseTotal
unless $date gt $today 14 22 36
157  
158 22 my $holiday = $holidays{$year}->{$date};
159  
160 22 foreach my $region (@regions) {
161 43 ▶ my $name = $holiday->{$region} or next;
Branch: 1 branch
BranchTrueFalseTotal
my $name = $holiday->{$region} or next 30 13 43
162  
163 30 ▶ $next_holidays{$region} ||= { name => $name, date => $date };
Condition100%2/2
$next_holidays{$region} ||= {"name", $name, "date", $date}
l!l
1911
MC/DC100%1/1
$next_holidays{$region} ||= {"name", $name, "date", $date}
$next_holidays{$region}
Truth table100%2/2
A
A= $next_holidays{$region}
Aresult
11
00
164 }
165  
166 22 ▶ last if $next_holidays{all} or keys %next_holidays == @{ +REGIONS };
Branch: 1 branch
BranchTrueFalseTotal
if $next_holidays{"all"} or keys %next_holidays == @{["EAW","NIR","SCT"];} 2 20 22
Condition66%2/3
$next_holidays{"all"} or keys %next_holidays == @{["EAW","NIR","SCT"];}
l!l&&r!l&&!r
2020
MC/DC50%1/2
$next_holidays{"all"} or keys %next_holidays == @{["EAW","NIR","SCT"];}
$next_holidays{"all"} keys %next_holidays == @{["EAW","NIR","SCT"];}
Truth table66%2/3
A or B
A= $next_holidays{"all"}B= keys %next_holidays == @{["EAW","NIR","SCT"];}
ABresult
1X1
011
000
167 }
168  
169 4 return \%next_holidays;
170 }
171  
172 78 ▶sub _holiday {
Subroutine _holiday: called CC=6 SCAR=17.9
173 78 my ( $holiday, $region_codes ) = @_;
174  
175 # return canonical name (EAW) if all regions have holiday
176 78 ▶ return $holiday->{all} if $holiday->{all};
Branch: 1 branch
BranchTrueFalseTotal
if $holiday->{"all"} 35 43 78
177  
178 43 my %region_codes = map { $_ => 1 } @{$region_codes};
179  
180 # return comma separated string of holidays with region(s) in
181 # parentheses
182 43 my %names;
183 43 foreach my $region ( sort keys %region_codes ) {
184 71 ▶ next unless $holiday->{$region};
Branch: 1 branch
BranchTrueFalseTotal
unless $holiday->{$region} 42 29 71
185  
186 29 push @{ $names{ $holiday->{$region} } }, REGION_NAMES->{$region};
187 }
188  
189 43 ▶ return unless %names;
Branch: 1 branch
BranchTrueFalseTotal
unless %names 18 25 43
190  
191 25 my @strings;
192 25 foreach my $name ( sort keys %names ) {
193 25 push @strings, "$name (" . join( ', ', @{ $names{$name} } ) . ")";
194 }
195  
196 25 return join( ', ', @strings );
197 }
198  
199 0 ▶sub date_generated { '2026-01-04' }
Subroutine date_generated: not called CC=1 SCAR=6.9
Pod documented
200  
201 4 1;
202  
203 __DATA__
↑ Summary Date/Holidays/GB/NIR.pm »