Koha/t/db_dependent/Serials/GetNextDate.t
Jonathan Druart 9d6d641d1f Bug 17600: Standardize our EXPORT_OK
On bug 17591 we discovered that there was something weird going on with
the way we export and use subroutines/modules.
This patch tries to standardize our EXPORT to use EXPORT_OK only.

That way we will need to explicitely define the subroutine we want to
use from a module.

This patch is a squashed version of:
Bug 17600: After export.pl
Bug 17600: After perlimport
Bug 17600: Manual changes
Bug 17600: Other manual changes after second perlimports run
Bug 17600: Fix tests

And a lot of other manual changes.

export.pl is a dirty script that can be found on bug 17600.

"perlimport" is:
git clone https://github.com/oalders/App-perlimports.git
cd App-perlimports/
cpanm --installdeps .
export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib"
find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \;

The ideas of this patch are to:
* use EXPORT_OK instead of EXPORT
* perltidy the EXPORT_OK list
* remove '&' before the subroutine names
* remove some uneeded use statements
* explicitely import the subroutines we need within the controllers or
modules

Note that the private subroutines (starting with _) should not be
exported (and not used from outside of the module except from tests).

EXPORT vs EXPORT_OK (from
https://www.thegeekstuff.com/2010/06/perl-exporter-examples/)
"""
Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members.

@EXPORT and @EXPORT_OK are the two main variables used during export operation.

@EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace.

@EXPORT_OK does export of symbols on demand basis.
"""

If this patch caused a conflict with a patch you wrote prior to its
push:
* Make sure you are not reintroducing a "use" statement that has been
removed
* "$subroutine" is not exported by the C4::$MODULE module
means that you need to add the subroutine to the @EXPORT_OK list
* Bareword "$subroutine" not allowed while "strict subs"
means that you didn't imported the subroutine from the module:
  - use $MODULE qw( $subroutine list );
You can also use the fully qualified namespace: C4::$MODULE::$subroutine

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-07-16 08:58:47 +02:00

543 lines
19 KiB
Perl
Executable file

#!/usr/bin/perl
use Modern::Perl;
use Test::More tests => 102;
use Koha::Database;
use C4::Serials qw( GetNextDate );
use C4::Serials::Frequency;
my $schema = Koha::Database->new->schema;
$schema->storage->txn_begin;
my $dbh = C4::Context->dbh;
# TEST CASE - 1 issue per day, no irregularities
my $frequency = {
description => "One issue per day",
unit => 'day',
issuesperunit => 1,
unitsperissue => 1,
};
my $subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
my $publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-03');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-04');
# TEST CASE - 1 issue per day, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '2;4', # Skip the second and fourth issues
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-03');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-05');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-06');
# TEST CASE - 2 issues per day, no irregularity
$frequency = {
description => "Two issues per day",
unit => 'day',
issuesperunit => 2,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-03');
# TEST CASE - 2 issues per day, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3;5;6',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-04');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-04');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-05');
# TEST CASE - 1 issue every 2 days, no irregularity
$frequency = {
description => "one issue every two days",
unit => 'day',
issuesperunit => 1,
unitsperissue => 2,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-03');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-05');
# TEST CASE - 1 issue every 2 days, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-03');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-07');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-09');
# TEST CASE - 1 issue per week, no irregularity
$frequency = {
description => "one issue per week",
unit => 'week',
issuesperunit => 1,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-08');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-15');
# TEST CASE - 1 issue per week, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-08');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-22');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-29');
# TEST CASE - 1 issue every 2 weeks, no irregularity
$frequency = {
description => "one issue every 2 weeks",
unit => 'week',
issuesperunit => 1,
unitsperissue => 2,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-15');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-29');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-12');
# TEST CASE - 1 issue every 2 weeks, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-15');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-12');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-26');
# TEST CASE - 2 issues per week, no irregularity
$frequency = {
description => "two issues per week",
unit => 'week',
issuesperunit => 2,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-04');
# when more than 1 issue per week, date is automatically set to the same day of
# week as firstacquidate
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-08');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-11');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-15');
# TEST CASE - 2 issues per week, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3;5;6',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-04');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-11');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-22');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-25');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-29');
# TEST CASE - 6 issues per week, no irregularity
$frequency = {
description => "six issues per week",
unit => 'week',
issuesperunit => 6,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-06',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-07');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-08');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-09');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-10');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-11');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-13');
# TEST CASE - 6 issues per week, irregularities
$subscription = {
firstacquidate => '1970-01-06',
irregularity => '3;5;6',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-07');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-09');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-13');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-14');
# TEST CASE - 1 issue per month, no irregularity
$frequency = {
description => "1 issue per month",
unit => 'month',
issuesperunit => 1,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-03-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-04-01');
# TEST CASE - 1 issue per month, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '2;4',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-03-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-05-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-06-01');
# TEST CASE - 1 issue every 2 months, no irregularity
$frequency = {
description => "1 issue every 2 months",
unit => 'month',
issuesperunit => 1,
unitsperissue => 2,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-03-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-05-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-07-01');
# TEST CASE - 1 issue every 2 months, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '2;3',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-07-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-09-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-11-01');
# TEST CASE - 2 issues per month, no irregularity
$frequency = {
description => "2 issues per month",
unit => 'month',
issuesperunit => 2,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-16', 'January has 31 days');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-16', 'February has only 28 days');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-03-01');
# TEST CASE - 2 issues per month, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3;5;6',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-01-16', 'January has 31 days');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-02-16', 'February has only 28 days');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-04-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-04-16', 'April has 30 days');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-05-01');
# TEST CASE - 1 issue per year, no irregularity
$frequency = {
description => "1 issue per year",
unit => 'year',
issuesperunit => 1,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1971-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1972-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1973-01-01');
# TEST CASE - 1 issue per year, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '2;4',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1972-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1974-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1975-01-01');
# TEST CASE - 1 issue every 2 years, no irregularity
$frequency = {
description => "1 issue every 2 years",
unit => 'year',
issuesperunit => 1,
unitsperissue => 2,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1972-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1974-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1976-01-01');
# TEST CASE - 1 issue every 2 years, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '2;4',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1974-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1978-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1980-01-01');
# Move publisheddate to Feb 29 (leap year 1980)
$publisheddate = '1980-02-29';
$publisheddate = GetNextDate( $subscription, $publisheddate, $frequency );
is( $publisheddate, '1982-02-28', 'Test +2 year from Feb 29' );
# TEST CASE - 2 issues per year, no irregularity
$frequency = {
description => "1 issue every 2 years",
unit => 'year',
issuesperunit => 2,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-07-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1971-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1971-07-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1972-01-01');
# TEST CASE - 2 issues per year, irregularities
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '3;5;6',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1970-07-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1971-07-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1973-01-01');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1973-07-02');
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, '1974-01-01');
# TEST CASE - 9 issues per year, dates spread throughout month
$frequency = {
description => "9 issues per year",
unit => 'year',
issuesperunit => 9,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-08-10',
irregularity => '',
countissuesperunit => 1,
};
my @dates = ( $subscription->{firstacquidate} );
foreach(1..27) {
push @dates, GetNextDate( $subscription, $dates[-1], $frequency );
}
is( $dates[9], '1971-08-10', 'Freq 9/yr, 1 year passed' );
is( $dates[18], '1972-08-10', 'Freq 9/yr, 2 years passed (leap year)' );
is( $dates[27], '1973-08-10', 'Freq 9/yr, 3 years passed' );
# Keep (first) position in cycle, but shift back 9 days
is( GetNextDate( $subscription, '1973-08-01', $frequency ), '1973-09-10', 'Back 9 days, without annual correction' );
# Set position to last in cycle, and shift back 9 days; annual correction
$subscription->{countissuesperunit} = 9;
is( GetNextDate( $subscription, '1973-08-01', $frequency ), '1973-09-15', 'Last in cycle, back 9 days, expect annual correction' );
# TEST CASE - Irregular
$frequency = {
description => "Irregular",
unit => undef,
issuesperunit => 1,
unitsperissue => 1,
};
$subscription = {
firstacquidate => '1970-01-01',
irregularity => '',
countissuesperunit => 1,
};
$publisheddate = $subscription->{firstacquidate};
# GetNextDate always return undef if subscription is irregular
$publisheddate = GetNextDate($subscription, $publisheddate, $frequency);
is($publisheddate, undef);
# GetNextDate returns undef if one of two first parameters is undef
$publisheddate = GetNextDate($subscription, undef, $frequency);
is($publisheddate, undef);
$publisheddate = GetNextDate(undef, $subscription->{firstacquidate}, $frequency);
is($publisheddate, undef);
$publisheddate = GetNextDate(undef, undef, $frequency);
is($publisheddate, undef);
$schema->storage->txn_rollback;