File Coverage

blib/lib/Mojo/Log/Clearable.pm

Criterion	Covered	Total	%
statement	7	7	100.0
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod	1	1	100.0
total	11	11	100.0

package Mojo::Log::Clearable;

use Mojo::Base 'Mojo::Log';
use Class::Method::Modifiers ();

our $VERSION = '0.003';

sub clear_handle { delete shift->{handle} };
Class::Method::Modifiers::before 'path' => sub { $_[0]->clear_handle if @_ > 1 };

=head1 NAME

Mojo::Log::Clearable - Mojo::Log with clearable log handle

=head1 SYNOPSIS

 use Mojo::Log::Clearable;
 my $log = Mojo::Log::Clearable->new(path => $path1);
 $log->info($message); # Logged to $path1
 $log->path($path2);
 $log->debug($message); # Logged to $path2
 $log->path(undef);
 $log->warn($message); # Logged to STDERR

 # Reopen filehandle after logrotate (if logrotate sends SIGUSR1)
 $SIG{USR1} = sub { $log->clear_handle };

=head1 DESCRIPTION

L is a simple logger class. It holds a filehandle once it writes to
a log, and changing L does not open a new filehandle for logging.
L subclasses L to provide a L
method and to automatically call it when setting L so the logging
handle is reopened at the new path. The L method can also be
used to reopen the logging handle after logrotate.

=head1 EVENTS

L inherits all events from L.

=head1 ATTRIBUTES

L inherits all attributes from L and
implements the following new ones.

=head2 path

 my $path = $log->path;
 $log     = $log->path('/var/log/mojo.log');

Log file path used by L. Reopens the handle when set.

=head1 METHODS

L inherits all methods from L and implements
the following new ones.

=head2 clear_handle

 $log->clear_handle;

Clears L attribute, it will be reopened from the L
attribute when next accessed.

=head1 AUTHOR

Dan Book, C

=head1 COPYRIGHT AND LICENSE

Copyright 2015, Dan Book.

This library is free software; you may redistribute it and/or modify it undef
the terms of the Artistic License version 2.0.

=head1 SEE ALSO

L

=cut

1;