lib/Log/Abstraction.pm

Structural Coverage (Approximate)

TER1 (Statement): 98.45%
TER2 (Branch): 90.45%
TER3 (LCSAJ): 97.6% (40/41)
Approximate LCSAJ segments: 179

LCSAJ Legend

● Covered — this LCSAJ path was executed during testing.

● Not covered — this LCSAJ path was never executed. These are the paths to focus on.

Multiple dots on a line indicate that multiple control-flow paths begin at that line. Hovering over any dot shows:

        start → end → jump

start – first line of the linear sequence
end – last line before control flow changes
jump – line execution jumps to next

Uncovered paths show [NOT COVERED] in the tooltip.

Mutant Testing Legend

Survived (tests missed this) Killed (tests detected this) No mutation

1: package Log::Abstraction; 2: 3: use strict; 4: use warnings; 5: use Carp; # Import Carp for warnings 6: use Config::Abstraction 0.36; 7: use Data::Dumper; 8: use Params::Get 0.13; # Import Params::Get for parameter handling 9: use POSIX qw(strftime); 10: use Readonly::Values::Syslog 0.03; 11: use Return::Set; 12: use Scalar::Util 'blessed'; # Import Scalar::Util for object reference checking 13: use Sys::Syslog 0.28; # Import Sys::Syslog for syslog support 14: 15: =head1 NAME 16: 17: Log::Abstraction - Logging Abstraction Layer 18: 19: =head1 VERSION 20: 21: 0.29 22: 23: =cut 24: 25: our $VERSION = 0.29; 26: 27: =head1 SYNOPSIS 28: 29: use Log::Abstraction; 30: 31: my $logger = Log::Abstraction->new(logger => 'logfile.log'); 32: 33: $logger->debug('This is a debug message'); 34: $logger->info('This is an info message'); 35: $logger->notice('This is a notice message'); 36: $logger->trace('This is a trace message'); 37: $logger->warn({ warning => 'This is a warning message' }); 38: 39: =head1 DESCRIPTION 40: 41: The C<Log::Abstraction> class provides a flexible logging layer on top of different types of loggers, 42: including code references, arrays, file paths, and objects. 43: It also supports logging to syslog if configured. 44: 45: =head1 METHODS 46: 47: =head2 new 48: 49: my $logger = Log::Abstraction->new(%args); 50: 51: Creates a new C<Log::Abstraction> object. 52: 53: The argument can be a hash, 54: a reference to a hash or the C<logger> value. 55: The following arguments can be provided: 56: 57: =over 58: 59: =item * C<carp_on_warn> 60: 61: If set to 1, 62: and C<logger> is not given, 63: call C<Carp:carp> on C<warn()>. 64: 65: Causes C<error()> to C<carp> if C<croak_on_error> is not given. 66: 67: =item * C<croak_on_error> 68: 69: If set to 1, 70: and C<logger> is not given, 71: call C<Carp:croak> on C<error()>. 72: 73: =item * C<config_file> 74: 75: Points to a configuration file which contains the parameters to C<new()>. 76: The file can be in any common format, 77: including C<YAML>, C<XML>, and C<INI>. 78: This allows the parameters to be set at run time. 79: 80: On a non-Windows system, 81: the class can be configured using environment variables starting with C<"Log::Abstraction::">. 82: For example: 83: 84: export Log::Abstraction::script_name=foo 85: 86: It doesn't work on Windows because of the case-insensitive nature of that system. 87: 88: =item * C<level> 89: 90: The minimum level at which to log something, 91: the default is "warning". 92: 93: =item * C<logger> 94: 95: A logger can be one or more of: 96: 97: =over 98: 99: =item * a code reference 100: 101: The code will be called with a hashref containing: 102: 103: =over 104: 105: =item * class 106: 107: =item * file 108: 109: =item * line 110: 111: =item * level 112: 113: =item * message - an arrayref of messages 114: 115: =item * ctx - passed to C<new()>, an argument that can help to give context to the caller 116: 117: =back 118: 119: =item * an object 120: 121: =item * a hash of options 122: 123: =item * sendmail - send higher priority messages to an email address 124: 125: To send an e-mail, 126: you need L<require Email::Simple>, L<require Email::Sender::Simple> and L<Email::Sender::Transport::SMTP>. 127: 128: The C<sendmail> hash also accepts a C<min_interval> key (seconds). 129: When set, at most one email is sent per C<min_interval> seconds; any 130: messages that arrive during the cooldown are still logged to other 131: backends but do not trigger a new email. 132: The send time is stored in C<_last_email_sent> on the object, so each 133: instance has its own cooldown window; cloned objects inherit the 134: parent's last-send timestamp at the moment of cloning. 135: 136: =item * array - a reference to an array 137: 138: =item * fd - containing a file descriptor to log to 139: 140: =item * file - containing the filename 141: 142: =back 143: 144: Defaults to L<Log::Log4perl>. 145: In that case, 146: the argument 'verbose' to new() will raise the logging level. 147: 148: =item * C<format> 149: 150: The format of the message. 151: Expands: 152: 153: =over 154: 155: =item * %callstack% 156: 157: =item * %level% 158: 159: =item * %class% 160: 161: =item * %message% 162: 163: =item * %timestamp% 164: 165: =%item * %env_foo% 166: 167: Replaces with C<$ENV{foo}> 168: 169: =back 170: 171: =item * C<syslog> 172: 173: A hash reference for syslog configuration. 174: Only warnings and above will be sent to syslog. 175: This restriction should be lifted in the future, 176: since it's reasonable to send notices and above to the syslog. 177: 178: =item * C<script_name> 179: 180: The name of the script. 181: It's needed when C<syslog> is given, 182: if none is passed, the value is guessed. 183: 184: =back 185: 186: Clone existing objects with or without modifications: 187: 188: my $clone = $logger->new(); 189: 190: =cut 191: 192: sub new { ●193 → 198 → 205●193 → 198 → 0 193: my $class = shift; 194: 195: # Handle hash or hashref arguments 196: my %args; 197:

Mutants (Total: 2, Killed: 2, Survived: 0)

199: $args{'logger'} = shift; 200: } elsif(my $params = Params::Get::get_params(undef, \@_)) { 201: %args = %{$params}; 202: } 203: 204: # Load the configuration from a config file, if provided ●205 → 205 → 225●205 → 205 → 0 205: if(exists($args{'config_file'})) {