File Coverage

blib/lib/Time/Concise.pm

Criterion	Covered	Total	%
statement	22	22	100.0
branch	6	8	75.0
condition			n/a
subroutine	4	4	100.0
pod	2	2	100.0
total	34	36	94.4

package Time::Concise;
# $Id: Concise.pm,v 1.1 2004/01/05 20:35:42 cwest Exp $
use strict;

require Exporter;

use vars qw[$VERSION @ISA @EXPORT %CONVERT @CONVERT $CONVERT];
$VERSION  = (qw$Revision: 1.1 $)[1];
@ISA      = qw[Exporter];
@EXPORT   = qw[to_concise from_concise];

=head1 NAME

Time::Concise - Convert to and from concise duration formats.

=head1 SYNOPSIS

  use Time::Concise;
  my $seconds = from_concise "5y4d3h2m1s"; # 158141171
  my $concise =   to_concise 158141171;    # 5y4d3h2m1s

=head1 DESCRIPTION

B exports two functions by default, C and
C.

The term I was borrowed from L.

=head2 Concise Format

The format is an integer followed immediatley by its duration
identifier.  White-space will be ignored.

The following table explains the format.

  identifier   duration
  ----------   --------
           y   year
           d   day
           h   hour
           m   minute
           s   second

=cut

@CONVERT  = qw[y d h m s];
$CONVERT  = join '', @CONVERT;
%CONVERT  = (
             y => 31_556_930,
             d => 86_400,
             h => 3_600,
             m => 60,
             s => 1,
            );

=head2 Functions

=over 8

=item to_concise I<$seconds>

This function requires one argument, an integer number of seconds, and
returns a concise string representation of the duration.

If the input is not an integer this function returns C.

=cut

sub to_concise($;) {
    my ($seconds) = @_;
    return undef if $seconds =~ /\D/;
    my $string = '';
    foreach my $type ( @CONVERT ) {
        my $leftover = $seconds % $CONVERT{$type};
        my $amount   = ( $seconds - $leftover ) / $CONVERT{$type};
        $string .= "$amount$type" if $amount;
        $seconds = $leftover;
    }
    return $string;
}

=item from_concise I<$concise>

This function requires one argument, a concise string representation
of the duration, and returns the number of seconds in the duration.

If the concise string contains characters outside those represented
in a concise duration string this function will return C.

=cut

sub from_concise($;) {
    my ($string) = @_;
    return undef if $string =~ /[^${CONVERT}0-9 ]/o;
    my $seconds = 0;
    foreach my $type ( @CONVERT ) {
        if ( my ($amount) = ( $string =~ /(\d+)$type/ ) ) {
            $seconds += $amount * $CONVERT{$type};
        }
    }
    return $seconds;
}

=pod

=back

=cut

1;

__END__