lib/Moose/Error/Default.pm

   1 package Moose::Error::Default;
   2
   3 use strict;
   4 use warnings;
   5
   6 our $AUTHORITY = 'cpan:STEVAN';
   7
   8 use Carp::Heavy;
   9 use Class::MOP::MiniTrait;
  10
  11 use base 'Class::MOP::Object';
  12
  13 Class::MOP::MiniTrait::apply(__PACKAGE__, 'Moose::Meta::Object::Trait');
  14
  15 sub new {
  16     my ( $self, @args ) = @_;
  17     if (defined $ENV{MOOSE_ERROR_STYLE} && $ENV{MOOSE_ERROR_STYLE} eq 'croak') {
  18         $self->create_error_croak( @args );
  19     }
  20     else {
  21         $self->create_error_confess( @args );
  22     }
  23 }
  24
  25 sub create_error_croak {
  26     my ( $self, @args ) = @_;
  27     $self->_create_error_carpmess( @args );
  28 }
  29
  30 sub create_error_confess {
  31     my ( $self, @args ) = @_;
  32     $self->_create_error_carpmess( @args, longmess => 1 );
  33 }
  34
  35 sub _create_error_carpmess {
  36     my ( $self, %args ) = @_;
  37
  38     my $carp_level = 3 + ( $args{depth} || 1 );
  39     local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
  40
  41     my @args = exists $args{message} ? $args{message} : ();
  42
  43     if ( $args{longmess} || $Carp::Verbose ) {
  44         local $Carp::CarpLevel = ( $Carp::CarpLevel || 0 ) + $carp_level;
  45         return Carp::longmess(@args);
  46     } else {
  47         return Carp::ret_summary($carp_level, @args);
  48     }
  49 }
  50
  51 __PACKAGE__
  52
  53 # ABSTRACT: L<Carp> based error generation for Moose.
  54
  55 __END__
  56
  57 =pod
  58
  59 =head1 DESCRIPTION
  60
  61 This class implements L<Carp> based error generation.
  62
  63 The default behavior is like L<Moose::Error::Confess>. To override this to
  64 default to L<Moose::Error::Croak>'s behaviour on a system wide basis, set the
  65 MOOSE_ERROR_STYLE environment variable to C<croak>. The use of this
  66 environment variable is considered experimental, and may change in a future
  67 release.
  68
  69 =head1 METHODS
  70
  71 =over 4
  72
  73 =item B<< Moose::Error::Default->new(@args) >>
  74
  75 Create a new error. Delegates to C<create_error_confess> or
  76 C<create_error_croak>.
  77
  78 =item B<< $error->create_error_confess(@args) >>
  79
  80 =item B<< $error->create_error_croak(@args) >>
  81
  82 Creates a new errors string of the specified style.
  83
  84 =back
  85
  86 =cut
  87
  88