t/DateUtils.t

   1 use Modern::Perl;
   2 use DateTime;
   3 use DateTime::TimeZone;
   4
   5 use C4::Context;
   6
   7 use Test::More tests => 60;
   8
   9 use Test::MockModule;
  10 use Test::Warn;
  11 use Time::HiRes qw/ gettimeofday /;
  12 use t::lib::Mocks;
  13
  14 BEGIN { use_ok('Koha::DateUtils'); }
  15
  16 t::lib::Mocks::mock_preference('dateformat', 'us');
  17 t::lib::Mocks::mock_preference('TimeFormat', 'This_is_not_used_but_called');
  18
  19 my $tz = C4::Context->tz;
  20
  21 isa_ok( $tz, 'DateTime::TimeZone', 'Context returns timezone object' );
  22
  23 my $testdate_iso = '2011-06-16';                   # Bloomsday 2011
  24 my $dt = dt_from_string( $testdate_iso, 'iso' );
  25
  26 isa_ok( $dt, 'DateTime', 'dt_from_string returns a DateTime object' );
  27
  28 cmp_ok( $dt->ymd(), 'eq', $testdate_iso, 'Returned object matches input' );
  29
  30 $dt->set_hour(12);
  31 $dt->set_minute(0);
  32
  33 my $date_string;
  34
  35 my $dateformat = C4::Context->preference('dateformat');
  36 cmp_ok  output_pref({ dt => $dt, dateformat => $dateformat }),
  37         'eq',
  38         output_pref($dt),
  39         'output_pref gives an hashref or a dt';
  40
  41 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '24hr' });
  42 cmp_ok $date_string, 'eq', '2011-06-16 12:00', 'iso output';
  43
  44 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '12hr' });
  45 cmp_ok $date_string, 'eq', '2011-06-16 12:00 PM', 'iso output 12hr';
  46
  47 # "notime" doesn't actually mean anything in this context, but we
  48 # can't pass undef or output_pref will try to access the database
  49 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => 'notime', dateonly => 1 });
  50 cmp_ok $date_string, 'eq', '2011-06-16', 'iso output (date only)';
  51
  52 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '24hr' });
  53 cmp_ok $date_string, 'eq', '06/16/2011 12:00', 'us output';
  54
  55 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr' });
  56 cmp_ok $date_string, 'eq', '06/16/2011 12:00 PM', 'us output 12hr';
  57
  58 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => 'notime', dateonly => 1 });
  59 cmp_ok $date_string, 'eq', '06/16/2011', 'us output (date only)';
  60
  61 # metric should return the French Revolutionary Calendar Really
  62 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr' });
  63 cmp_ok $date_string, 'eq', '16/06/2011 12:00', 'metric output';
  64
  65 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => 'notime', dateonly => 1 });
  66 cmp_ok $date_string, 'eq', '16/06/2011', 'metric output (date only)';
  67
  68 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr' });
  69 cmp_ok $date_string, 'eq', '16/06/2011 12:00',
  70   'output_pref preserves non midnight HH:SS';
  71
  72 my $dear_dirty_dublin = DateTime::TimeZone->new( name => 'Europe/Dublin' );
  73 my $new_dt = dt_from_string( '16/06/2011', 'metric', $dear_dirty_dublin );
  74 isa_ok( $new_dt, 'DateTime', 'Create DateTime with different timezone' );
  75 cmp_ok( $new_dt->ymd(), 'eq', $testdate_iso,
  76     'Returned Dublin object matches input' );
  77
  78 for ( qw/ 2014-01-01 2100-01-01 9999-01-01 / ) {
  79     my $duration = gettimeofday();
  80     $new_dt = dt_from_string($_, 'iso', $dear_dirty_dublin);
  81     $duration = gettimeofday() - $duration;
  82     cmp_ok $duration, '<', 2, "Create DateTime with dt_from_string() for $_ with TZ in less than 2s";
  83     $duration = gettimeofday();
  84     output_pref( { dt => $new_dt } );
  85     $duration = gettimeofday() - $duration;
  86     cmp_ok $duration, '<', 2, "Create DateTime with output_pref() for $_ with TZ in less than 2s";
  87 }
  88
  89 $new_dt = dt_from_string( '2011-06-16 12:00', 'sql' );
  90 isa_ok( $new_dt, 'DateTime', 'Create DateTime from (mysql) sql' );
  91 cmp_ok( $new_dt->ymd(), 'eq', $testdate_iso, 'sql returns correct date' );
  92
  93 $new_dt = dt_from_string( $dt, 'iso' );
  94 isa_ok( $new_dt, 'DateTime', 'Passed a DateTime dt_from_string returns it' );
  95
  96 my $ymd = '2012-01-01';
  97 my $dt0 = dt_from_string( '00/01/2012', 'metric' );
  98 isa_ok( $dt0, 'DateTime',
  99     'dt_from_string returns a DateTime object passed a zero metric day' );
 100 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects metric day 0' );
 101
 102 $dt0 = dt_from_string( '01/00/2012', 'us' );
 103 isa_ok( $dt0, 'DateTime',
 104     'dt_from_string returns a DateTime object passed a zero us day' );
 105 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects us day 0' );
 106
 107 $dt0 = dt_from_string( '2012-01-00', 'iso' );
 108 isa_ok( $dt0, 'DateTime',
 109     'dt_from_string returns a DateTime object passed a zero iso day' );
 110 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects iso day 0' );
 111
 112 # Return undef if passed mysql 0 dates
 113 $dt0 = dt_from_string( '0000-00-00', 'iso' );
 114 is( $dt0, undef, "undefined returned for 0 iso date" );
 115
 116 # Return undef if passed mysql 9999-* date
 117 my $dt9999 = dt_from_string( '9999-12-31', 'sql' );
 118 is( $dt9999->ymd(), '9999-12-31', "dt_from_string should return a DateTime object for 9999-12-31" );
 119
 120 my $formatted = format_sqldatetime( '2011-06-16 12:00:07', 'metric', '24hr' );
 121 cmp_ok( $formatted, 'eq', '16/06/2011 12:00', 'format_sqldatetime conversion' );
 122
 123 $formatted = format_sqldatetime( undef, 'metric' );
 124 cmp_ok( $formatted, 'eq', q{},
 125     'format_sqldatetime formats undef as empty string' );
 126
 127 # Test the as_due_date parameter
 128 $dt = DateTime->new(
 129     year       => 2013,
 130     month      => 12,
 131     day        => 11,
 132     hour       => 23,
 133     minute     => 59,
 134 );
 135 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
 136 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 24hr';
 137
 138 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', dateonly => 1, as_due_date => 1});
 139 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 24hr';
 140
 141 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', as_due_date => 1 });
 142 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 12hr';
 143
 144 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', dateonly => 1, as_due_date => 1});
 145 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 12hr';
 146
 147 # Test as_due_date for hourly loans
 148 $dt = DateTime->new(
 149     year       => 2013,
 150     month      => 12,
 151     day        => 11,
 152     hour       => 18,
 153     minute     => 35,
 154 );
 155 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
 156 cmp_ok $date_string, 'eq', '11/12/2013 18:35', 'as_due_date with hours and timeformat 24hr (non-midnight time)';
 157 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr', as_due_date => 1 });
 158 cmp_ok $date_string, 'eq', '12/11/2013 06:35 PM', 'as_due_date with hours and timeformat 12hr (non-midnight time)';
 159
 160 my $now = DateTime->now;
 161 is( dt_from_string, $now, "Without parameter, dt_from_string should return today" );
 162
 163 my $module_context = new Test::MockModule('C4::Context');
 164 $module_context->mock(
 165     'tz',
 166     sub {
 167         return DateTime::TimeZone->new( name => 'Europe/Lisbon' );
 168     }
 169 );
 170
 171 $dt = dt_from_string('1979-04-01');
 172 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
 173
 174 $module_context->mock(
 175     'tz',
 176     sub {
 177         return DateTime::TimeZone->new( name => 'Europe/Paris' );
 178     }
 179 );
 180
 181 $dt = dt_from_string('2014-03-30 02:00:00');
 182 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
 183
 184 # Test dt_from_string
 185 t::lib::Mocks::mock_preference('dateformat', 'metric');
 186 t::lib::Mocks::mock_preference('TimeFormat', '24hr');
 187
 188 # dt_from_string should take into account the dateformat pref, or the given parameter
 189 $dt = dt_from_string('31/01/2015');
 190 is( ref($dt), 'DateTime', '31/01/2015 is a correct date in metric format' );
 191 is( output_pref( { dt => $dt, dateonly => 1 } ), '31/01/2015' );
 192 $dt = eval { dt_from_string( '31/01/2015', 'iso' ); };
 193 is( ref($dt), '', '31/01/2015 is not a correct date in iso format' );
 194 $dt = eval { dt_from_string( '01/01/2015', 'iso' ); };
 195 is( ref($dt), '', '01/01/2015 is not a correct date in iso format' );
 196 $dt = eval { dt_from_string( '31/01/2015', 'us' ); };
 197 is( ref($dt), '', '31/01/2015 is not a correct date in us format' );
 198 $dt = dt_from_string( '01/01/2015', 'us' );
 199 is( ref($dt), 'DateTime', '01/01/2015 is a correct date in us format' );
 200 $dt = dt_from_string( '01.01.2015', 'dmydot' );
 201 is( ref($dt), 'DateTime', '01.01.2015 is a correct date in dmydot format' );
 202
 203
 204 # default value for hh and mm is 00:00
 205 $dt = dt_from_string('31/01/2015');
 206 is( output_pref( { dt => $dt } ), '31/01/2015 00:00', 'dt_from_string should generate a DT object with 00:00 as default hh:mm' );
 207
 208 $dt = dt_from_string('31/01/2015 12:34');
 209 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm' );
 210
 211 $dt = dt_from_string('31/01/2015 12:34:56');
 212 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm:ss' );
 213
 214 # date before 1900
 215 $dt = dt_from_string('01/01/1900');
 216 is( output_pref( { dt => $dt, dateonly => 1 } ), '01/01/1900', 'dt_from_string should manage date < 1900' );
 217
 218 # fallback
 219 $dt = dt_from_string('2015-01-31 01:02:03');
 220 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string should fallback to sql format' );
 221
 222 # output_pref with str parameter
 223 is( output_pref( { 'str' => $testdate_iso, dateformat => 'iso', dateonly => 1 } ), $testdate_iso, 'output_pref should handle correctly the iso parameter' );
 224 my $output_for_invalid_date;
 225 warning_like { $output_for_invalid_date = output_pref( { str => 'invalid_date' } ) }
 226              { carped => qr[^Invalid date 'invalid_date' passed to output_pref] },
 227              'output_pref should carp if an invalid date is passed for the str parameter';
 228 is( $output_for_invalid_date, undef, 'output_pref should return undef if an invalid date is passed' );
 229 warning_is { output_pref( { 'str' => $testdate_iso, dt => $dt, dateformat => 'iso', dateonly => 1 } ) }
 230            { carped => 'output_pref should not be called with both dt and str parameters' },
 231            'output_pref should carp if str and dt parameters are passed together';