view release on metacpan or  search on metacpan

lib/App/Kit/Role/Log.pm  view on Meta::CPAN

package App::Kit::Role::Log;

## no critic (RequireUseStrict) - Moo::Role does strict/warnings
use Moo::Role;

our $VERSION = '0.1';

# ro-NOOP:
#   my $isa_digit = sub { die "Must be all digits!" unless $_[0] =~ m/\A[0-9]+\z/; };
#   has _log_reload_check_time => ( is => 'rw', lazy => 1, isa => $isa_digit, default => sub { time } );    # not rwp so its easier to test
#   has _log_reload_check_every => ( is => 'rw', lazy => 1, isa => $isa_digit, default => sub { 30 } );     # not rwp so its easier to test

has log => (
    is => ( $INC{'App/Kit/Util/RW.pm'} || $ENV{'App-Kit-Util-RW'} ? 'rw' : 'rwp' ),
    lazy    => 1,
    default => sub {
        require Log::Dispatch;
        require Log::Dispatch::Config;

        # ro-NOOP: my ($app, %new) = @_;
        my ($app) = @_;

        my $path = $app->fs->file_lookup( 'config', 'log.conf' );

        if ($path) {

            # Log::Dispatch::Config->configure( $path ); # $app->log->reload; at will

            # since we only call instance() once this would be a noop *except* the wrapper needs it via needs_reload()
            #   (we could bypass via $app->log->{config}->needs_reload but what if the module changes? poof!)
            Log::Dispatch::Config->configure_and_watch($path);

            my $log = Log::Dispatch::Config->instance;

            # ? TODO: optional 'before' log per config file or $app->conf('reload_log')
            # check mtime instead?
            # before 'log' => sub {
            #      if (!$app->_log_reload_check_time() || time() - $app->_log_reload_check_time() < $app->_log_reload_check_every() ) {
            #          $app->_log_reload_check_time(time());
            #          $app->log->reload if $app->log->needs_reload;
            #      }
            # };

            return $log;
        }

        # ro-NOOP: elsif(keys %new) {
        # ro-NOOP:     return Log::Dispatch->new(%new);
        # ro-NOOP: }

        else {
            return Log::Dispatch->new(
                outputs => [ [ "Screen", min_level => "notice", "newline" => 1 ] ],
                callbacks => sub {    # ? TODO break this out into a thing consumable by Log::Dispatch::Config above ?
                    my %info = @_;

                    my $short = $info{'level'};
                    $short = substr( $info{'level'}, 0, 5 ) eq 'emerg' ? 'M' : uc( substr( $short, 0, 1 ) );
                    $short = " ㏒\xc2\xa0$short";    # Unicode: \x{33D2} utf-8: \xe3\x8f\x92

                    # 0 debug
                    # 1 info
                    # 2 notice
                    # 3 warning (warn)
                    # 4 error (err)
                    # 5 critical (crit)
                    # 6 alert
                    # 7 emergency (emerg)

                    my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) = localtime(time);
                    my $time_stamp = sprintf( "%04d-%02d-%02d\xc2\xa0%02d:%02d:%02d", $year + 1900, $mon + 1, $mday, $hour, $min, $sec );

                    my $tap = $app->detect->is_testing ? '#' : '';    # make it TAP safe

                    # TODO: format via $app->output e.g.:
                    # return $app->output->current_indent() . $app->output->short_indent() . $app->output->class($short, $info{'level'}) . ' ' . $app->output->class($time_stamp, 'dim') . $app->output->short_indent() . $app->output->class($info{messag...
                    return "$tap  $short $time_stamp  $info{message}";
                },
            );
        }
    },
);

1;

__END__

=encoding utf-8

=head1 NAME

App::Kit::Role::Log - A Lazy Façade method role for logging

=head1 VERSION

This document describes App::Kit::Role::Log version 0.1

=head1 SYNOPSIS

In your class:

   with 'App::Kit::Role::Log';

Then later in your program:

    $app->log->info(…)

=head1 DESCRIPTION

Add lazy façade logging support to your class.

=head1 INTERFACE

This role adds one lazy façade method: