avoid playing with meta in Catalyst::Log

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Log.pm

diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm
old mode 100755 (executable)
new mode 100644 (file)
index 2418302..ef085ff
--- a/lib/Catalyst/Log.pm
+++ b/lib/Catalyst/Log.pm
@@ -4,7 +4,6 @@ use Moose;
 with 'MooseX::Emulate::Class::Accessor::Fast';
 
 use Data::Dump;
-use Moose::Util 'find_meta';
 use Carp qw/ cluck /;
 
 our %LEVELS = (); # Levels stored as bit field, ergo debug = 1, warn = 2 etc
@@ -13,7 +12,7 @@ our %LEVEL_MATCH = (); # Stored as additive, thus debug = 31, warn = 30 etc
 has level => (is => 'rw');
 has _body => (is => 'rw');
 has abort => (is => 'rw');
-has autoflush => (is => 'rw');
+has autoflush => (is => 'rw', default => sub {1});
 has _psgi_logger => (is => 'rw', predicate => '_has_psgi_logger', clearer => '_clear_psgi_logger');
 has _psgi_errors => (is => 'rw', predicate => '_has_psgi_errors', clearer => '_clear_psgi_errors');
 
@@ -34,9 +33,8 @@ sub psgienv {
 {
     my @levels = qw[ debug info warn error fatal ];
 
-    my $meta = find_meta(__PACKAGE__);
     my $summed_level = 0;
-    for ( my $i = $#levels ; $i >= 0 ; $i-- ) {
+    for my $i ( reverse 0 .. $#levels ) {
 
         my $name  = $levels[$i];
 
@@ -46,29 +44,43 @@ sub psgienv {
         $LEVELS{$name} = $level;
         $LEVEL_MATCH{$name} = $summed_level;
 
-       $meta->add_method($name, sub {
+        no strict 'refs';
+
+        *$name = sub {
             my $self = shift;
 
             if ( $self->level & $level ) {
                 $self->_log( $name, @_ );
             }
-        });
+        };
 
-        $meta->add_method("is_$name", sub {
+        *{"is_$name"} = sub {
             my $self = shift;
             return $self->level & $level;
-        });;
+        };
     }
 }
 
-around new => sub {
-    my $orig = shift;
+sub BUILDARGS {
     my $class = shift;
-    my $self = $class->$orig;
+    my $args;
 
-    $self->levels( scalar(@_) ? @_ : keys %LEVELS );
+    if (@_ == 1 && ref $_[0] eq 'HASH') {
+        $args = $_[0];
+    }
+    else {
+        $args = {
+            levels => [@_ ? @_ : keys %LEVELS],
+        };
+    }
 
-    return $self;
+    if (delete $args->{levels}) {
+        my $level = 0;
+        $level |= $_
+            for map $LEVEL_MATCH{$_}, @_ ? @_ : keys %LEVELS;
+        $args->{level} = $level;
+    }
+    return $args;
 };
 
 sub levels {
@@ -108,9 +120,8 @@ sub _log {
     my $self    = shift;
     my $level   = shift;
     my $message = join( "\n", @_ );
-    my $ret;
     if ($self->can('_has_psgi_logger') and $self->_has_psgi_logger) {
-        $ret = $self->_psgi_logger->({
+        $self->_psgi_logger->({
                 level => $level,
                 message => $message,
             });
@@ -118,12 +129,12 @@ sub _log {
         $message .= "\n" unless $message =~ /\n$/;
         my $body = $self->_body;
         $body .= sprintf( "[%s] %s", $level, $message );
-        $ret = $self->_body($body);
+        $self->_body($body);
     }
     if( $self->autoflush && !$self->abort ) {
       $self->_flush;
     }
-    return $ret;
+    return 1;
 }
 
 sub _flush {
@@ -142,27 +153,27 @@ sub _send_to_log {
     if ($self->can('_has_psgi_errors') and $self->_has_psgi_errors) {
         $self->_psgi_errors->print(@_);
     } else {
+        binmode STDERR, ":utf8";
         print STDERR @_;
     }
 }
 
 # 5.7 compat code.
 # Alias _body to body, add a before modifier to warn..
-my $meta = __PACKAGE__->meta; # Calling meta method here fine as we happen at compile time.
-$meta->add_method('body', $meta->get_method('_body'));
+*body = \&_body;
 my %package_hash; # Only warn once per method, per package.
                   # I haven't provided a way to disable them, patches welcome.
-$meta->add_before_method_modifier('body', sub {
+before body => sub {
     my $class = blessed(shift);
     $package_hash{$class}++ || do {
         warn("Class $class is calling the deprecated method Catalyst::Log->body method,\n"
             . "this will be removed in Catalyst 5.81");
     };
-});
+};
 # End 5.70 backwards compatibility hacks.
 
 no Moose;
-__PACKAGE__->meta->make_immutable(inline_constructor => 0);
+__PACKAGE__->meta->make_immutable;
 
 1;
 
@@ -292,11 +303,25 @@ to use Log4Perl or another logger, you should call it like this:
 
 =head2 autoflush
 
-When enabled, messages are written to the log immediately instead of queued
-until the end of the request. By default, autoflush is enabled during setup,
-but turned back off thereafter. This is done purely for legacy support,
-specifically for L<Catalyst::Plugin::Static::Simple>, and may be changed in
-the future.
+When enabled (default), messages are written to the log immediately instead
+of queued until the end of the request.
+
+This option, as well as C<abort>, is provided for modules such as
+L<Catalyst::Plugin::Static::Simple> to be able to programmatically
+suppress the output of log messages. By turning off C<autoflush> (application-wide
+setting) and then setting the C<abort> flag within a given request, all log
+messages for the given request will be suppressed. C<abort> can still be set
+independently of turning off C<autoflush>, however. It just means any messages
+sent to the log up until that point in the request will obviously still be emitted,
+since C<autoflush> means they are written in real-time.
+
+If you need to turn off autoflush you should do it like this (in your main app
+class):
+
+    after setup_finalize => sub {
+      my $c = shift;
+      $c->log->autoflush(0) if $c->log->can('autoflush');
+    };
 
 =head2 _send_to_log
 
@@ -321,8 +346,6 @@ will send to STDERR as before.
 
 Clears the PSGI environment attributes set by L</psgienv>.
 
-=head2 meta
-
 =head1 SEE ALSO
 
 L<Catalyst>.
@@ -337,7 +360,3 @@ This library is free software. You can redistribute it and/or modify
 it under the same terms as Perl itself.
 
 =cut
-
-__PACKAGE__->meta->make_immutable;
-
-1;