File Coverage

blib/lib/Tie/Handle/Filter/Output/Timestamp.pm

Criterion	Covered	Total	%
statement	18	18	100.0
branch			n/a
condition	1	2	50.0
subroutine	7	7	100.0
pod			n/a
total	26	27	96.3

package Tie::Handle::Filter::Output::Timestamp;

# ABSTRACT: prepend filehandle output with a timestamp

use 5.008;
use strict;
use warnings;
use base 'Tie::Handle::Filter';
use POSIX 'strftime';
our $VERSION = '0.009';    # TRIAL

#pod =head1 SYNOPSIS
#pod
#pod     use Tie::Handle::Filter::Output::Timestamp;
#pod     tie *STDOUT, 'Tie::Handle::Filter::Output::Timestamp', *STDOUT;
#pod
#pod     print "Everything I print will be prepended with a timestamp.\n";
#pod     print <<'END_OUTPUT';
#pod     The first line of a multi-line string will be prepended.
#pod     Subsequent lines will not.
#pod     END_OUTPUT
#pod
#pod =head1 DESCRIPTION
#pod
#pod This class may be used with Perl's L function to
#pod prepend all output with a timestamp, optionally formatted according to
#pod the L|POSIX/strftime> function. Only the beginning of
#pod strings given to L|perlfunc/print>,
#pod L|perlfunc/printf>, L|perlfunc/syswrite>, and
#pod L|perlfunc/say> (in Perl > v5.10) get timestamps. If you want
#pod I line prefixed, use
#pod L|Tie::Handle::Filter::Output::Timestamp::EveryLine>,
#pod
#pod =head1 BUGS AND LIMITATIONS
#pod
#pod Because the date and time format is specified using
#pod L|POSIX/strftime>, portable code should restrict itself to
#pod formats using ANSI C89 specifiers.
#pod
#pod =method TIEHANDLE
#pod
#pod Invoked by the command
#pod C.
#pod You may also specify a L|POSIX/strftime> string as an
#pod additional parameter to format the timestamp; by default the format is
#pod C<%x %X >, which is the local representation of the date and time
#pod followed by a space.
#pod
#pod =cut

sub TIEHANDLE {
    my ( $class, $handle_glob, $format ) = @_;
    $format ||= '%x %X ';
    return $class->SUPER::TIEHANDLE( $handle_glob,
        sub { ( strftime( $format, localtime ), @_ ) } );
}

1;

__END__