PATCH: Sync Time::Local in blead to 1.13 on CPAN

Message-ID: <Pine.LNX.4.64.0608090422450.8735@urth.org>

p4raw-id: //depot/perl@28683

2 files changed, 190 insertions, 168 deletions

diff --git a/lib/Time/Local.pm b/lib/Time/Local.pm
index 7f5ceb1753..4c1957c856 100644
--- a/lib/Time/Local.pm
+++ b/lib/Time/Local.pm
@@ -7,8 +7,8 @@ use strict;
 use integer;
 
 use vars qw( $VERSION @ISA @EXPORT @EXPORT_OK );
-$VERSION   = '1.12_01';
-$VERSION   = eval $VERSION;
+$VERSION   = '1.13';
+
 @ISA       = qw( Exporter );
 @EXPORT    = qw( timegm timelocal );
 @EXPORT_OK = qw( timegm_nocheck timelocal_nocheck );
@@ -145,31 +145,33 @@ sub timegm_nocheck {
 
 sub timelocal {
     my $ref_t = &timegm;
-    my $loc_t = _timegm( localtime($ref_t) );
-
-    # Is there a timezone offset from GMT or are we done?
-    my $zone_off = $ref_t - $loc_t
-        or return $loc_t;
+    my $loc_for_ref_t = _timegm( localtime($ref_t) );
 
-    # This hack is needed to always pick the first matching time
-    # during a DST change when time would otherwise be ambiguous
-    $zone_off -= SECS_PER_HOUR if $ref_t >= SECS_PER_HOUR;
+    my $zone_off = $loc_for_ref_t - $ref_t
+        or return $loc_for_ref_t;
 
     # Adjust for timezone
-    $loc_t = $ref_t + $zone_off;
+    my $loc_t = $ref_t - $zone_off;
 
     # Are we close to a DST change or are we done
-    my $dst_off = $ref_t - _timegm( localtime($loc_t) )
-        or return $loc_t;
+    my $dst_off = $ref_t - _timegm( localtime($loc_t) );
+
+    # If this evaluates to true, it means that the value in $loc_t is
+    # the _second_ hour after a DST change where the local time moves
+    # backward.
+    if ( ! $dst_off &&
+         ( ( $ref_t - SECS_PER_HOUR ) - _timegm( localtime( $loc_t - SECS_PER_HOUR ) ) < 0 )
+       ) {
+        return $loc_t - SECS_PER_HOUR;
+    }
 
     # Adjust for DST change
     $loc_t += $dst_off;
 
-    return $loc_t if $dst_off >= 0;
+    return $loc_t if $dst_off > 0;
 
-    # for a negative offset from GMT, and if the original date
-    # was a non-extent gap in a forward DST jump, we should
-    # now have the wrong answer - undo the DST adjust;
+    # If the original date was a non-extent gap in a forward DST jump,
+    # we should now have the wrong answer - undo the DST adjustment
     my ( $s, $m, $h ) = localtime($loc_t);
     $loc_t -= $dst_off if $s != $_[0] || $m != $_[1] || $h != $_[2];
 
@@ -196,59 +198,70 @@ Time::Local - efficiently compute time from local and GMT time
 
 =head1 DESCRIPTION
 
-These routines are the inverse of built-in perl functions localtime()
-and gmtime().  They accept a date as a six-element array, and return
-the corresponding time(2) value in seconds since the system epoch
-(Midnight, January 1, 1970 GMT on Unix, for example).  This value can
-be positive or negative, though POSIX only requires support for
-positive values, so dates before the system's epoch may not work on
-all operating systems.
+This module provides functions that are the inverse of built-in perl
+functions C<localtime()> and C<gmtime()>. They accept a date as a
+six-element array, and return the corresponding C<time(2)> value in
+seconds since the system epoch (Midnight, January 1, 1970 GMT on Unix,
+for example). This value can be positive or negative, though POSIX
+only requires support for positive values, so dates before the
+system's epoch may not work on all operating systems.
 
 It is worth drawing particular attention to the expected ranges for
-the values provided.  The value for the day of the month is the actual
+the values provided. The value for the day of the month is the actual
 day (ie 1..31), while the month is the number of months since January
-(0..11).  This is consistent with the values returned from localtime()
-and gmtime().
+(0..11). This is consistent with the values returned from
+C<localtime()> and C<gmtime()>.
+
+=head1 FUNCTIONS
+
+This module exports two functions by default, C<timelocal()> and
+C<timegm()>.
 
-The timelocal() and timegm() functions perform range checking on the
-input $sec, $min, $hour, $mday, and $mon values by default.  If you
-are confident that your data is good, you can explicitly import the
-timelocal_nocheck() and timegm_nocheck() functions, which may provide
-a small performance improvement.
+The C<timelocal()> and C<timegm()> functions perform range checking on
+the input $sec, $min, $hour, $mday, and $mon values by default.
+
+If you are working with data you know to be valid, you can speed your
+code up by using the "nocheck" variants, C<timelocal_nocheck()> and
+C<timegm_nocheck()>. These variants must be explicitly imported.
 
     use Time::Local 'timelocal_nocheck';
 
     # The 365th day of 1999
     print scalar localtime timelocal_nocheck 0,0,0,365,0,99;
 
-Strictly speaking, the year should also be specified in a form
-consistent with localtime(), i.e. the offset from 1900.  In order to
-make the interpretation of the year easier for humans, however, who
-are more accustomed to seeing years as two-digit or four-digit values,
-the following conventions are followed:
+If you supply data which is not valid (month 27, second 1,000) the
+results will be unpredictable (so don't do that).
+
+=head2 Year Value Interpretation
+
+Strictly speaking, the year should be specified in a form consistent
+with C<localtime()>, i.e. the offset from 1900. In order to make the
+interpretation of the year easier for humans, however, who are more
+accustomed to seeing years as two-digit or four-digit values, the
+following conventions are followed:
 
 =over 4
 
 =item *
 
 Years greater than 999 are interpreted as being the actual year,
-rather than the offset from 1900.  Thus, 1964 would indicate the year
+rather than the offset from 1900. Thus, 1964 would indicate the year
 Martin Luther King won the Nobel prize, not the year 3864.
 
 =item *
 
-Years in the range 100..999 are interpreted as offset from 1900, 
-so that 112 indicates 2012.  This rule also applies to years less than zero
-(but see note below regarding date range).
+Years in the range 100..999 are interpreted as offset from 1900, so
+that 112 indicates 2012. This rule also applies to years less than
+zero (but see note below regarding date range).
 
 =item *
 
 Years in the range 0..99 are interpreted as shorthand for years in the
 rolling "current century," defined as 50 years on either side of the
-current year.  Thus, today, in 1999, 0 would refer to 2000, and 45 to
-2045, but 55 would refer to 1955.  Twenty years from now, 55 would
-instead refer to 2055.  This is messy, but matches the way people
-currently think about two digit dates.  Whenever possible, use an
+current year. Thus, today, in 1999, 0 would refer to 2000, and 45 to
+2045, but 55 would refer to 1955. Twenty years from now, 55 would
+instead refer to 2055. This is messy, but matches the way people
+currently think about two digit dates. Whenever possible, use an
 absolute four digit year instead.
 
 =back
@@ -256,18 +269,20 @@ absolute four digit year instead.
 The scheme above allows interpretation of a wide range of dates,
 particularly if 4-digit years are used.
 
-Please note, however, that the range of dates that can be actually be
-handled depends on the size of an integer (time_t) on a given
+=head2 Limits of time_t
+
+The range of dates that can be actually be handled depends on the size
+of C<time_t> (usually a signed integer) on the given
 platform. Currently, this is 32 bits for most systems, yielding an
 approximate range from Dec 1901 to Jan 2038.
 
-Both timelocal() and timegm() croak if given dates outside the
+Both C<timelocal()> and C<timegm()> croak if given dates outside the
 supported range.
 
 =head2 Ambiguous Local Times (DST)
 
 Because of DST changes, there are many time zones where the same local
-time occurs for two different GMT times on the same day.  For example,
+time occurs for two different GMT times on the same day. For example,
 in the "Europe/Paris" time zone, the local time of 2001-10-28 02:30:00
 can represent either 2001-10-28 00:30:00 GMT, B<or> 2001-10-28
 01:30:00 GMT.
@@ -279,19 +294,19 @@ times.
 =head2 Non-Existent Local Times (DST)
 
 When a DST change causes a locale clock to skip one hour forward,
-there will be an hour's worth of local times that don't exist.  Again,
+there will be an hour's worth of local times that don't exist. Again,
 for the "Europe/Paris" time zone, the local clock jumped from
 2001-03-25 01:59:59 to 2001-03-25 03:00:00.
 
-If the timelocal() function is given a non-existent local time, it
+If the C<timelocal()> function is given a non-existent local time, it
 will simply return an epoch value for the time one hour later.
 
 =head2 Negative Epoch Values
 
-Negative epoch (time_t) values are not officially supported by the
-POSIX standards, so this module's tests do not test them.  On some
-systems, they are known not to work.  These include MacOS (pre-OSX)
-and Win32.
+Negative epoch (C<time_t>) values are not officially supported by the
+POSIX standards, so this module's tests do not test them. On some
+systems, they are known not to work. These include MacOS (pre-OSX) and
+Win32.
 
 On systems which do support negative epoch values, this module should
 be able to cope with dates before the start of the epoch, down the
@@ -300,18 +315,18 @@ minimum value of time_t for the system.
 =head1 IMPLEMENTATION
 
 These routines are quite efficient and yet are always guaranteed to
-agree with localtime() and gmtime().  We manage this by caching the
-start times of any months we've seen before.  If we know the start
+agree with C<localtime()> and C<gmtime()>. We manage this by caching
+the start times of any months we've seen before. If we know the start
 time of the month, we can always calculate any time within the month.
 The start times are calculated using a mathematical formula. Unlike
-other algorithms that do multiple calls to gmtime().
+other algorithms that do multiple calls to C<gmtime()>.
 
-timelocal() is implemented using the same cache.  We just assume that
-we're translating a GMT time, and then fudge it when we're done for
-the timezone and daylight savings arguments.  Note that the timezone
-is evaluated for each date because countries occasionally change their
-official timezones.  Assuming that localtime() corrects for these
-changes, this routine will also be correct.
+The C<timelocal()> function is implemented using the same cache. We
+just assume that we're translating a GMT time, and then fudge it when
+we're done for the timezone and daylight savings arguments. Note that
+the timezone is evaluated for each date because countries occasionally
+change their official timezones. Assuming that C<localtime()> corrects
+for these changes, this routine will also be correct.
 
 =head1 BUGS
 
@@ -321,10 +336,11 @@ bug.
 =head1 SUPPORT
 
 Support for this module is provided via the datetime@perl.org email
-list.  See http://lists.perl.org/ for more details.
+list. See http://lists.perl.org/ for more details.
 
-Please submit bugs using the RT system at rt.cpan.org, or as a last
-resort, to the datetime@perl.org list.
+Please submit bugs to the CPAN RT system at
+http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Time-Local or via email
+at bug-time-local@rt.cpan.org.
 
 =head1 AUTHOR
 
@@ -338,4 +354,3 @@ It is now being maintained separately from the Perl core by Dave
 Rolsky, <autarch@urth.org>.
 
 =cut
-
diff --git a/lib/Time/Local.t b/lib/Time/Local.t
index 39c99a090b..a6120e8da2 100755
--- a/lib/Time/Local.t
+++ b/lib/Time/Local.t
@@ -9,8 +9,7 @@ BEGIN {
 
 use strict;
 
-use Config;
-use Test;
+use Test::More;
 use Time::Local;
 
 # Set up time values to test
@@ -69,7 +68,7 @@ $tests += @neg_time * 12;
 $tests += @bad_time;
 $tests += 6;
 $tests += 2 if $ENV{PERL_CORE};
-$tests += 6 if $ENV{MAINTAINER};
+$tests += 8 if $ENV{MAINTAINER};
 
 plan tests => $tests;
 
@@ -78,40 +77,39 @@ for (@time, @neg_time) {
     $year -= 1900;
     $mon--;
 
-    if ($^O eq 'vos' && $year == 70) {
-        skip(1, "skipping 1970 test on VOS.\n") for 1..6;
-    } elsif ($year < 70 && ! $neg_epoch_ok) {
-        skip(1, "skipping negative epoch.\n") for 1..6;
-    } else {
-        my $year_in = $year < 70 ? $year + 1900 : $year;
-        my $time = timelocal($sec,$min,$hour,$mday,$mon,$year_in);
-
-        my($s,$m,$h,$D,$M,$Y) = localtime($time);
-
-        ok($s, $sec, "timelocal second for @$_");
-        ok($m, $min, "timelocal minute for @$_");
-        ok($h, $hour, "timelocal hour for @$_");
-        ok($D, $mday, "timelocal day for @$_");
-        ok($M, $mon, "timelocal month for @$_");
-        ok($Y, $year, "timelocal year for @$_");
-    }
-
-    if ($^O eq 'vos' && $year == 70) {
-        skip(1, "skipping 1970 test on VOS.\n") for 1..6;
-    } elsif ($year < 70 && ! $neg_epoch_ok) {
-        skip(1, "skipping negative epoch.\n") for 1..6;
-    } else {
-        my $year_in = $year < 70 ? $year + 1900 : $year;
-        my $time = timegm($sec,$min,$hour,$mday,$mon,$year_in);
-
-        my($s,$m,$h,$D,$M,$Y) = gmtime($time);
-
-        ok($s, $sec, "timegm second for @$_");
-        ok($m, $min, "timegm minute for @$_");
-        ok($h, $hour, "timegm hour for @$_");
-        ok($D, $mday, "timegm day for @$_");
-        ok($M, $mon, "timegm month for @$_");
-        ok($Y, $year, "timegm year for @$_");
+ SKIP: {
+        skip '1970 test on VOS fails.', 12
+            if $^O eq 'vos' && $year == 70;
+        skip 'this platform does not support negative epochs.', 12
+            if $year < 70 && ! $neg_epoch_ok;
+
+        {
+            my $year_in = $year < 70 ? $year + 1900 : $year;
+            my $time = timelocal($sec,$min,$hour,$mday,$mon,$year_in);
+
+            my($s,$m,$h,$D,$M,$Y) = localtime($time);
+
+            is($s, $sec, "timelocal second for @$_");
+            is($m, $min, "timelocal minute for @$_");
+            is($h, $hour, "timelocal hour for @$_");
+            is($D, $mday, "timelocal day for @$_");
+            is($M, $mon, "timelocal month for @$_");
+            is($Y, $year, "timelocal year for @$_");
+        }
+
+        {
+            my $year_in = $year < 70 ? $year + 1900 : $year;
+            my $time = timegm($sec,$min,$hour,$mday,$mon,$year_in);
+
+            my($s,$m,$h,$D,$M,$Y) = gmtime($time);
+
+            is($s, $sec, "timegm second for @$_");
+            is($m, $min, "timegm minute for @$_");
+            is($h, $hour, "timegm hour for @$_");
+            is($D, $mday, "timegm day for @$_");
+            is($M, $mon, "timegm month for @$_");
+            is($Y, $year, "timegm year for @$_");
+        }
     }
 }
 
@@ -122,18 +120,20 @@ for (@bad_time) {
 
     eval { timegm($sec,$min,$hour,$mday,$mon,$year) };
 
-    ok($@, qr/.*out of range.*/, 'invalid time caused an error');
+    like($@, qr/.*out of range.*/, 'invalid time caused an error');
 }
 
-ok(timelocal(0,0,1,1,0,90) - timelocal(0,0,0,1,0,90), 3600,
-   'one hour difference between two calls to timelocal');
+{
+    is(timelocal(0,0,1,1,0,90) - timelocal(0,0,0,1,0,90), 3600,
+       'one hour difference between two calls to timelocal');
 
-ok(timelocal(1,2,3,1,0,100) - timelocal(1,2,3,31,11,99), 24 * 3600,
-   'one day difference between two calls to timelocal');
+    is(timelocal(1,2,3,1,0,100) - timelocal(1,2,3,31,11,99), 24 * 3600,
+       'one day difference between two calls to timelocal');
 
-# Diff beween Jan 1, 1980 and Mar 1, 1980 = (31 + 29 = 60 days)
-ok(timegm(0,0,0, 1, 2, 80) - timegm(0,0,0, 1, 0, 80), 60 * 24 * 3600,
-   '60 day difference between two calls to timegm');
+    # Diff beween Jan 1, 1980 and Mar 1, 1980 = (31 + 29 = 60 days)
+    is(timegm(0,0,0, 1, 2, 80) - timegm(0,0,0, 1, 0, 80), 60 * 24 * 3600,
+       '60 day difference between two calls to timegm');
+}
 
 # bugid #19393
 # At a DST transition, the clock skips forward, eg from 01:59:59 to
@@ -144,67 +144,74 @@ ok(timegm(0,0,0, 1, 2, 80) - timegm(0,0,0, 1, 0, 80), 60 * 24 * 3600,
     my $hour = (localtime(timelocal(0, 0, 2, 7, 3, 102)))[2];
     # testers in US/Pacific should get 3,
     # other testers should get 2
-    ok($hour == 2 || $hour == 3, 1, 'hour should be 2 or 3');
+    ok($hour == 2 || $hour == 3, 'hour should be 2 or 3');
 }
 
-if ($neg_epoch_ok) {
+SKIP:
+{
+    skip 'this platform does not support negative epochs.', 2
+        unless $neg_epoch_ok;
+
     eval { timegm(0,0,0,29,1,1900) };
-    ok($@, qr/Day '29' out of range 1\.\.28/);
+    like($@, qr/Day '29' out of range 1\.\.28/,
+         'does not accept leap day in 1900');
 
     eval { timegm(0,0,0,29,1,1904) };
-    ok($@, '');
-} else {
-    skip(1, "skipping negative epoch.\n") for 1..2;
+    is($@, '', 'no error with leap day of 1904');
 }
 
 if ($ENV{MAINTAINER}) {
-    eval { require POSIX; POSIX::tzset() };
-    if ($@) {
-        skip( 1, "Cannot call POSIX::tzset() on this platform\n" ) for 1..3;
-    }
-    else {
-        local $ENV{TZ} = 'Europe/Vienna';
-        POSIX::tzset();
-
-        # 2001-10-28 02:30:00 - could be either summer or standard time,
-        # prefer earlier of the two, in this case summer
-        my $time = timelocal(0, 30, 2, 28, 9, 101);
-        ok($time, 1004229000,
-           'timelocal prefers earlier epoch in the presence of a DST change');
-
-        local $ENV{TZ} = 'America/Chicago';
-        POSIX::tzset();
-
-        # Same local time in America/Chicago.  There is a transition
-        # here as well.
-        $time = timelocal(0, 30, 1, 28, 9, 101);
-        ok($time, 1004250600,
-           'timelocal prefers earlier epoch in the presence of a DST change');
-
-        $time = timelocal(0, 30, 2, 1, 3, 101);
-        ok($time, 986113800,
-           'timelocal for non-existent time gives you the time one hour later');
-
-        local $ENV{TZ} = 'Australia/Sydney';
-        POSIX::tzset();
-
-        # 2001-03-25 02:30:00 in Australia/Sydney.  This is the transition
-        # _to_ summer time.  The southern hemisphere transitions are
-        # opposite those of the northern.
-        $time = timelocal(0, 30, 2, 25, 2, 101);
-        ok($time, 985447800,
-           'timelocal prefers earlier epoch in the presence of a DST change');
-
-        $time = timelocal(0, 30, 2, 28, 9, 101);
-        ok($time, 1004200200,
-           'timelocal for non-existent time gives you the time one hour later');
-
-        local $ENV{TZ} = 'Europe/London';
-        POSIX::tzset();
-        $time = timelocal( localtime(1111917720) );
-        ok($time, 1111917720,
-           'timelocal for round trip bug on date of DST change for Europe/London');
-    }
+    require POSIX;
+
+    local $ENV{TZ} = 'Europe/Vienna';
+    POSIX::tzset();
+
+    # 2001-10-28 02:30:00 - could be either summer or standard time,
+    # prefer earlier of the two, in this case summer
+    my $time = timelocal(0, 30, 2, 28, 9, 101);
+    is($time, 1004229000,
+       'timelocal prefers earlier epoch in the presence of a DST change');
+
+    local $ENV{TZ} = 'America/Chicago';
+    POSIX::tzset();
+
+    # Same local time in America/Chicago.  There is a transition here
+    # as well.
+    $time = timelocal(0, 30, 1, 28, 9, 101);
+    is($time, 1004250600,
+       'timelocal prefers earlier epoch in the presence of a DST change');
+
+    $time = timelocal(0, 30, 2, 1, 3, 101);
+    is($time, 986113800,
+       'timelocal for non-existent time gives you the time one hour later');
+
+    local $ENV{TZ} = 'Australia/Sydney';
+    POSIX::tzset();
+    # 2001-03-25 02:30:00 in Australia/Sydney.  This is the transition
+    # _to_ summer time.  The southern hemisphere transitions are
+    # opposite those of the northern.
+    $time = timelocal(0, 30, 2, 25, 2, 101);
+    is($time, 985447800,
+       'timelocal prefers earlier epoch in the presence of a DST change');
+
+    $time = timelocal(0, 30, 2, 28, 9, 101);
+    is($time, 1004200200,
+       'timelocal for non-existent time gives you the time one hour later');
+
+    local $ENV{TZ} = 'Europe/London';
+    POSIX::tzset();
+    $time = timelocal( localtime(1111917720) );
+    is($time, 1111917720,
+       'timelocal for round trip bug on date of DST change for Europe/London');
+
+    # There is no 1:00 AM on this date, as it leaps forward to
+    # 2:00 on the DST change - this should return 2:00 per the
+    # docs.
+    is( ( localtime( timelocal( 0, 0, 1, 27, 2, 2005 ) ) )[2], 2,
+        'hour is 2 when given 1:00 AM on Europe/London date change' );
+
+    is( ( localtime( timelocal( 0, 0, 2, 27, 2, 2005 ) ) )[2], 2,
+        'hour is 2 when given 2:00 AM on Europe/London date change' );
 }
 
 if ($ENV{PERL_CORE}) {
@@ -212,9 +219,9 @@ if ($ENV{PERL_CORE}) {
   require 'timelocal.pl';
 
   # need to get ok() from main package
-  ::ok(timegm(0,0,0,1,0,80), main::timegm(0,0,0,1,0,80),
+  ::is(timegm(0,0,0,1,0,80), main::timegm(0,0,0,1,0,80),
      'timegm in timelocal.pl');
 
-  ::ok(timelocal(1,2,3,4,5,88), main::timelocal(1,2,3,4,5,88),
+  ::is(timelocal(1,2,3,4,5,88), main::timelocal(1,2,3,4,5,88),
      'timelocal in timelocal.pl');
 }