blib/lib/Date/Holidays/UA.pm

filter: Statementstmt 100% 127 / 127 Branchbran 83.3% 40 / 48 Conditioncond 70.0% 21 / 30 MC/DCmcdc 47.0% 8 / 17 Subroutinesub 100% 19 / 19 Podpod 100% 7 / 7 totaltotal 89.5% 222 / 248 CC 41 SCAR 18.7
CC
41
Cov
92%
_spread_on_weekend
13.4
_generate_calendar
8.0
is_ua_holiday
7.0
CRAP 6.5
↑ Summary
1 package Date::Holidays::UA;
2  
3 2 ▶use 5.006;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 2 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 2 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 2 ▶use DateTime;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 2 ▶use DateTime::Event::Easter;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 2 ▶use Exporter qw(import);
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 2 our %EXPORT_TAGS = ( 'all' => [ qw(
13 is_holiday
14 is_ua_holiday
15 is_holiday_dt
16 holidays
17 ua_holidays
18 holidays_dt
19 ) ] );
20  
21 2 our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
22  
23 2 ▶use constant {
Subroutine BEGIN: called CC=1 SCAR=0.0
24 2 DEFAULT_LANG => 'UA',
25 WEEKEND_MAP => {
26 6 => 1,
27 7 => 1
28 },
29 HOLIDAY_RULES => [
30 {name => 'New Year', local_name => 'Новий рік', month => 1, day => 1},
31 {name => 'Labour Day', local_name => 'День праці', month => 5, day => 1},
32 {name => 'Labour Day', local_name => 'День праці', month => 5, day => 2, end_year => 2018},
33 {name => 'Defender Of Ukraine day', local_name => 'День захисника України', month => 10, day => 14, start_year => 2015},
34 {name => 'Catholic Christmas day', local_name => 'Різдво Христове(католицьке)', month => 12, day => 25, start_year => 2017},
35 {name => 'Orthodox Christmas day', local_name => 'Різдво Христове', month => 1, day => 7},
36 {name => 'Women Day', local_name => 'Міжнародний жіночий день', month => 3, day => 8},
37 {name => 'Victory Day', local_name => 'День перемоги над нацизмом у Другій світовій війні', month => 5, day => 9},
38 {name => 'Constitution Day', local_name => 'День Конституції України', month => 6, day => 28},
39 {name => 'Independence Day', local_name => 'День незалежності України', month => 8, day => 24},
40 {name => 'Orthodox Easter Day', local_name => 'Великдень', is_easter_depend => 1, easter_offset_day => 0},
41 {name => 'Orthodox Pentecost Day', local_name => 'Трійця', is_easter_depend => 1, easter_offset_day => 49},
42 ]
43 2 };
44  
45 =head1 NAME
46  
47 Date::Holidays::UA - Holidays module for Ukraine
48  
49 =head1 VERSION
50  
51 Version 0.02
52  
53 =cut
54  
55 2 our $VERSION = '0.02';
56  
57  
58 =head1 SYNOPSIS
59  
60 # procedural approach
61  
62 use Date::Holidays::UA qw(:all);
63  
64 my ($year, $month, $day) = (localtime)[5, 4, 3];
65 $year += 1900;
66 $month += 1;
67  
68 print 'Holiday!' if is_holiday($year, $month, $day);
69  
70 my $calendar = holidays($year, {language => 'en'});
71 print $calendar->{'0824'};
72  
73  
74 # object-oriented approach
75  
76 use DateTime;
77 use Date::Holidays::UA;
78  
79 my $ua = Date::Holidays::UA->new({ language => 'en' });
80 print 'Holiday!' if $ua->is_holiday_dt(DateTime->today);
81  
82 my $calendar = $ua->holidays(DateTime->today->year);
83 print join("\n", value(%$calendar)); # list of holiday names for Ukraine
84  
85 =head1 SUBROUTINES/METHODS
86  
87 =head2 new()
88  
89 Create a new Date::Holidays::UA object. Parameters should be given as
90 a hashref of key-value pairs.
91  
92 my $ua = Date::Holidays::UA->new();
93  
94 my $ua = Date::Holidays::UA->new({
95 language => 'en'
96 });
97  
98 One parameters can be specified: B<language>.
99  
100 =cut
101  
102 150 ▶sub new {
Subroutine new: called CC=4 SCAR=13.9
Pod documented
103 150 my $class = shift;
104 150 ▶ my $args_ref = shift || {};
Condition100%2/2
shift() || {}
l!l
42108
MC/DC100%1/1
shift() || {}
shift()
Truth table100%2/2
A
A= shift()
Aresult
11
00
105  
106 150 ▶ croak('Wrong language parameter') if (!ref($args_ref));
Branch: 1 branch
BranchTrueFalseTotal
unless ref $args_ref 0 150 150
107  
108 return bless {
109 150 ▶ language => $args_ref->{language} || DEFAULT_LANG
Condition100%2/2
$args_ref->{'language'} || 'UA'
l!l
42108
MC/DC100%1/1
$args_ref->{'language'} || 'UA'
$args_ref->{'language'}
Truth table100%2/2
A
A= $args_ref->{'language'}
Aresult
11
00
110 }, $class;
111 }
112  
113 =head2 is_holiday()
114  
115 For a given year, month (1-12) and day (1-31), return 1 if the given
116 day is a holiday; 0 if not. When using procedural calling style, an
117 additional hashref of options can be specified.
118  
119 $holiday_p = is_holiday($year, $month, $day);
120  
121 $holiday_p = is_holiday($year, $month, $day, {
122 language => 'en'
123 });
124  
125 $holiday_p = $ua->is_holiday($year, $month, $day);
126  
127 =cut
128  
129 198 ▶sub is_holiday {
Subroutine is_holiday: called CC=2 SCAR=6.9
Pod documented
130 198 ▶ return (is_ua_holiday(@_) ? 1 : 0);
Branch: 1 branch
BranchTrueFalseTotal
is_ua_holiday(@_) ? : 174 24 198
131 }
132  
133 =head2 is_holiday_dt()
134  
135 As is_holiday, but accepts a DateTime object in place of a numeric year,
136 month, and day.
137  
138 $holiday_p = is_holiday_dt($dt, {language => 'en'});
139  
140 $holiday_p = $ua->is_holiday_dt($dt);
141  
142 =cut
143  
144 99 ▶sub is_holiday_dt {
Subroutine is_holiday_dt: called CC=2 SCAR=6.9
Pod documented
145 my @args = map {
146 99 ▶ ref $_ eq 'DateTime' ? ($_->year, $_->month, $_->day) : $_
Branch: 1 branch
BranchTrueFalseTotal
ref $_ eq 'DateTime' ? : 99 66 165
147 } @_;
148  
149 99 return is_holiday(@args);
150 }
151  
152 =head2 is_ua_holiday()
153  
154 Similar to C<is_holiday>. Return the name of the holiday occurring on
155 the specified date if there is one; C<undef> if there isn't.
156  
157 print $ua->is_ua_holiday(2020, 1, 1); # "New Year"
158  
159 =cut
160  
161 330 ▶sub is_ua_holiday {
Subroutine is_ua_holiday: called CC=7 SCAR=19.5
Pod documented
162 330 my $self;
163 330 ▶ $self = shift if (ref $_[0]);
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] 198 132 330
164  
165 330 my $year = shift;
166 330 my $month = shift;
167 330 my $day = shift;
168 330 my $opt = shift;
169  
170 330 _assert_valid_date($year, $month, $day);
171  
172 330 ▶ if (!defined($self)) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self) 132 198 330
173 132 $self = __PACKAGE__->new($opt);
174 }
175  
176 330 my $holiday_name = undef;
177 330 my $calendar = $self->_generate_calendar($year);
178  
179 330 ▶ for my $holiday(@{$calendar || []}) {
Condition50%1/2
$calendar || []
l!l
3300
MC/DC0%0/1
$calendar || []
$calendar
Truth table50%1/2
A
A= $calendar
Aresult
11
00
180 2730 my $holiday_dt = $holiday->{dt};
181  
182 2730 ▶ if (($holiday_dt->month == $month) && ($holiday_dt->day == $day)) {
Branch: 1 branch
BranchTrueFalseTotal
if ($holiday_dt->month == $month and $holiday_dt->day == $day) 290 2440 2730
Condition100%3/3
$holiday_dt->month == $month and $holiday_dt->day == $day
!ll&&!rl&&r
2100340290
MC/DC100%2/2
$holiday_dt->month == $month and $holiday_dt->day == $day
$holiday_dt->month == $month $holiday_dt->day == $day
Truth table100%3/3
A and B
A= $holiday_dt->month == $monthB= $holiday_dt->day == $day
ABresult
0X0
100
111
183 290 $holiday_name = $self->_get_holiday_name($holiday);
184 290 last;
185 }
186 }
187  
188 330 return $holiday_name;
189 }
190  
191 =head2 holidays()
192  
193 For the given year, return a hashref containing all the holidays for
194 that year. The keys are the date of the holiday in C<mmdd> format
195 (eg '1225' for December 25); the values are the holiday names.
196  
197 my $calendar = holidays($year, {language => 'en'});
198 print $calendar->{'0824'}; # "Independence Day"
199  
200 my $calendar = $ua->holidays($year);
201 print $calendar->{'0628'}; # "Constitution Day"
202  
203 =cut
204  
205 28 ▶sub holidays {
Subroutine holidays: called CC=4 SCAR=13.9
Pod documented
206 28 my $self;
207 28 ▶ $self = shift if (ref $_[0]);
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] 16 12 28
208  
209 28 my $year = shift;
210 28 my $args_ref = shift;
211  
212 28 ▶ unless (defined $self) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self) 12 16 28
213 12 $self = __PACKAGE__->new($args_ref);
214 }
215  
216 28 my $calendar = $self->_generate_calendar($year);
217 my %holidays = map {
218 406 $_->{dt}->strftime('%m%d') => $self->_get_holiday_name($_)
219 28 ▶ }@{$calendar || []};
Condition50%1/2
$calendar || []
l!l
280
MC/DC0%0/1
$calendar || []
$calendar
Truth table50%1/2
A
A= $calendar
Aresult
11
00
220  
221 28 return \%holidays;
222 }
223  
224 =head2 ua_holidays()
225  
226 Same as C<holidays()>.
227  
228 =cut
229  
230 16 ▶sub ua_holidays {
Subroutine ua_holidays: called CC=1 SCAR=0.0
Pod documented
231 16 return holidays(@_);
232 }
233  
234 =head2 holidays_dt()
235  
236 Similar to C<holidays()>, The keys are the date of the holiday in C<mmdd> format
237 (eg '1225' for December 25); and DateTime objects as the values.
238  
239 my $calendar = $ua->holidays_dt($year);
240  
241 =cut
242  
243 4 ▶sub holidays_dt {
Subroutine holidays_dt: called CC=4 SCAR=14.1
Pod documented
244 4 my $self;
245 4 ▶ $self = shift if (ref $_[0]);
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] 0 4 4
246  
247 4 my $year = shift;
248 4 my $args_ref = shift;
249  
250 4 ▶ unless (defined $self) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self) 4 0 4
251 4 $self = __PACKAGE__->new($args_ref);
252 }
253  
254 4 my $calendar = $self->_generate_calendar($year);
255 my %holidays = map {
256 $_->{dt}->strftime('%m%d') => $_->{dt}
257 4 ▶ }@{$calendar || []};
Condition50%1/2
$calendar || []
l!l
40
MC/DC0%0/1
$calendar || []
$calendar
Truth table50%1/2
A
A= $calendar
Aresult
11
00
258  
259 4 return \%holidays;
260 }
261  
262 # _get_holiday_name
263 #
264 # accepts: holiday item
265 # returns: holiday name
266 #
267 # generate a holiday calendar for the specified year
268 696 ▶sub _get_holiday_name {
Subroutine _get_holiday_name: called CC=5 SCAR=17.0
269 696 my $self = shift;
270 696 my $holiday = shift;
271  
272 696 ▶ croak('Missing or wrong holiday item') if (!$holiday || !keys(%{$holiday || {}}));
Branch: 1 branch
BranchTrueFalseTotal
unless $holiday and keys %{$holiday or {};} 0 696 696
Condition40%2/5
$holiday and keys %{$holiday or {};}
!ll&&!rl&&r
00696
$holiday || {}
l!l
6960
MC/DC0%0/2
$holiday and keys %{$holiday or {};}
$holiday keys %{$holiday or {};}
MC/DC0%0/1
$holiday || {}
$holiday
Truth table33%1/3
A and B
A= $holidayB= keys %{$holiday or {};}
ABresult
0X0
100
111
Truth table50%1/2
A
A= $holiday
Aresult
11
00
273  
274 696 ▶ my $holiday_name = (lc($self->{language}) eq lc(DEFAULT_LANG)) ? $holiday->{local_name} : $holiday->{name};
Branch: 1 branch
BranchTrueFalseTotal
lc $self->{'language'} eq 'ua' ? : 377 319 696
275 696 return $holiday_name;
276 }
277  
278 # _generate_calendar
279 #
280 # accepts: numeric year
281 # returns: arrayref of hashref
282 #
283 # generate a holiday calendar for the specified year
284 362 ▶sub _generate_calendar {
Subroutine _generate_calendar: called CC=8 SCAR=20.8
285 362 my $self = shift;
286 362 my $year = shift;
287 362 my $calendar = [];
288  
289 362 ▶ croak('Missing year parameter') if (!$year);
Branch: 1 branch
BranchTrueFalseTotal
unless $year 0 362 362
290  
291 362 for my $holiday_rule(@{${\HOLIDAY_RULES}}) {
292 4344 ▶ next if ($holiday_rule->{start_year} && ($year <= $holiday_rule->{start_year}));
Branch: 1 branch
BranchTrueFalseTotal
if $holiday_rule->{"start_year"} and $year <= $holiday_rule->{"start_year"} 302 4042 4344
Condition100%3/3
$holiday_rule->{"start_year"} and $year <= $holiday_rule->{"start_year"}
!ll&&!rl&&r
3620422302
MC/DC100%2/2
$holiday_rule->{"start_year"} and $year <= $holiday_rule->{"start_year"}
$holiday_rule->{"start_year"} $year <= $holiday_rule->{"start_year"}
Truth table100%3/3
A and B
A= $holiday_rule->{"start_year"}B= $year <= $holiday_rule->{"start_year"}
ABresult
0X0
100
111
293 4042 ▶ next if ($holiday_rule->{end_year} && ($year >= $holiday_rule->{end_year}));
Branch: 1 branch
BranchTrueFalseTotal
if $holiday_rule->{"end_year"} and $year >= $holiday_rule->{"end_year"} 206 3836 4042
Condition100%3/3
$holiday_rule->{"end_year"} and $year >= $holiday_rule->{"end_year"}
!ll&&!rl&&r
3680156206
MC/DC100%2/2
$holiday_rule->{"end_year"} and $year >= $holiday_rule->{"end_year"}
$holiday_rule->{"end_year"} $year >= $holiday_rule->{"end_year"}
Truth table100%3/3
A and B
A= $holiday_rule->{"end_year"}B= $year >= $holiday_rule->{"end_year"}
ABresult
0X0
100
111
294  
295 3836 ▶ if ($holiday_rule->{is_easter_depend}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($holiday_rule->{'is_easter_depend'}) { } 724 3112 3836
296 724 my $dt = DateTime->new(year => $year);
297 724 my $easter = DateTime::Event::Easter->new(easter => "eastern");
298 724 my $easter_offset_day = $holiday_rule->{easter_offset_day};
299  
300 724 push @{$calendar}, {
301 name => $holiday_rule->{name},
302 local_name => $holiday_rule->{local_name},
303 724 dt => $easter->following($dt)->add(days => $easter_offset_day)
304 };
305 }
306 else {
307 my $dt = DateTime->new(
308 year => $year,
309 month => $holiday_rule->{month},
310 day => $holiday_rule->{day}
311 3112 );
312 3112 push @{$calendar}, {name => $holiday_rule->{name}, local_name => $holiday_rule->{local_name}, dt => $dt};
313 }
314 }
315  
316 362 return _spread_on_weekend($calendar);
317 }
318  
319 # _spread_on_weekend
320 #
321 # accepts: calendar of holidays
322 # returns: arrayref of hashref
323 #
324 # spread weekend holidays on other non-weekend days
325  
326 362 ▶sub _spread_on_weekend {
Subroutine _spread_on_weekend: called CC=13 SCAR=26.0
327 362 my $calendar = shift;
328  
329 362 ▶ croak('Missing calendar') if (!scalar(@{$calendar || []}));
Branch: 1 branch
BranchTrueFalseTotal
unless scalar @{$calendar or [];} 0 362 362
Condition50%1/2
$calendar || []
l!l
3620
MC/DC0%0/1
$calendar || []
$calendar
Truth table50%1/2
A
A= $calendar
Aresult
11
00
330 362 my $calc = [];
331  
332 362 ▶ for my $holiday(@{$calendar || []}) {
Condition50%1/2
$calendar || []
l!l
3620
MC/DC0%0/1
$calendar || []
$calendar
Truth table50%1/2
A
A= $calendar
Aresult
11
00
333 3836 ▶ next if (!$holiday->{dt});
Branch: 1 branch
BranchTrueFalseTotal
unless $holiday->{"dt"} 0 3836 3836
334  
335 3836 push(@{$calc}, $holiday);
336  
337 3836 my $dt = $holiday->{dt}->clone();
338 3836 ▶ my $is_weekend = WEEKEND_MAP->{$dt->day_of_week()} ? 1 : 0;
Branch: 1 branch
BranchTrueFalseTotal
{6 => 1, 7 => 1}->{$dt->day_of_week} ? : 1418 2418 3836
339  
340 3836 ▶ if ($is_weekend) {
Branch: 1 branch
BranchTrueFalseTotal
if ($is_weekend) 1418 2418 3836
341 1418 ▶ for (my $offset_day = 1; $offset_day <= 2; $offset_day++) {
Branch: 1 branch
BranchTrueFalseTotal
if ($offset_day <= 2) 1876 0 1876
342 1876 my $dt_next = $dt->clone()->add(days => $offset_day);
343 1876 ▶ next if (WEEKEND_MAP->{$dt_next->day_of_week()});
Branch: 1 branch
BranchTrueFalseTotal
if {"6" => 1,"7" => 1}->{$dt_next->day_of_week} 362 1514 1876
344  
345 1514 ▶ my $is_holiday = scalar(grep{ DateTime->compare($dt_next, $_->{dt}) == 0 }@{$calc || []}) ? 1 : 0;
Branch: 1 branch
BranchTrueFalseTotal
scalar grep({'DateTime'->compare($dt_next, $_->{'dt'}) == 0;} @{$calc or [];}) ? : 96 1418 1514
Condition50%1/2
$calc || []
l!l
15140
MC/DC0%0/1
$calc || []
$calc
Truth table50%1/2
A
A= $calc
Aresult
11
00
346  
347 1514 ▶ if (!$is_holiday) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($is_holiday) 1418 96 1514
348 1418 push(@{$calc}, {name => $holiday->{name}, local_name => $holiday->{local_name}, dt => $dt_next});
349 1418 last;
350 }
351 }
352 }
353 }
354  
355 362 return $calc;
356 }
357  
358 # _assert_valid_date
359 #
360 # accepts: numeric year, month, day
361 # returns: nothing
362 #
363 # throw an exception on invalid dates; otherwise, do nothing.
364  
365 330 ▶sub _assert_valid_date {
Subroutine _assert_valid_date: called CC=1 SCAR=0.0
366 330 my ($year, $month, $day) = @_;
367  
368 # DateTime does date validation when a DT object is created.
369 330 my $dt = DateTime->new(
370 year => $year, month => $month, day => $day,
371 );
372 }
373  
374 =head1 AUTHOR
375  
376 Denis Boyun, C<< <denisboyun at gmail.com> >>
377  
378 =head1 BUGS
379  
380 Please report any bugs or feature requests to C<bug-date-holidays-ua at rt.cpan.org>, or through
381 the web interface at L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Date-Holidays-UA>. I will be notified, and then you'll
382 automatically be notified of progress on your bug as I make changes.
383  
384  
385  
386  
387 =head1 SUPPORT
388  
389 You can find documentation for this module with the perldoc command.
390  
391 perldoc Date::Holidays::UA
392  
393  
394 You can also look for information at:
395  
396 =over 4
397  
398 =item * RT: CPAN's request tracker (report bugs here)
399  
400 L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Date-Holidays-UA>
401  
402 =item * AnnoCPAN: Annotated CPAN documentation
403  
404 L<http://annocpan.org/dist/Date-Holidays-UA>
405  
406 =item * CPAN Ratings
407  
408 L<https://cpanratings.perl.org/d/Date-Holidays-UA>
409  
410 =item * Search CPAN
411  
412 L<https://metacpan.org/release/Date-Holidays-UA>
413  
414 =back
415  
416  
417 =head1 ACKNOWLEDGEMENTS
418  
419  
420 =head1 LICENSE AND COPYRIGHT
421  
422 This software is copyright (c) 2020 by Denis Boyun.
423  
424 This is free software; you can redistribute it and/or modify it under
425 the same terms as the Perl 5 programming language system itself.
426  
427  
428 =cut
429  
430 2 1; # End of Date::Holidays::UA
↑ Summary