File Coverage

blib/lib/XAS/Exception.pm

Criterion	Covered	Total	%
statement	6	17	35.2
branch	0	6	0.0
condition	0	3	0.0
subroutine	2	5	40.0
pod	3	3	100.0
total	11	34	32.3

package XAS::Exception;

use base Badger::Exception;
$Badger::Exception::TRACE = 1;

sub type {
    my $self = shift;

    return @_
      ? ($self->{'type'} = shift)
      : ($self->{'type'} || $TYPE);

}

sub type_info {
    my $self = shift;

    return $self->type, $self->info;

}

sub stack_trace {
    my $self = shift;

    my @lines;

    if (my $stack = $self->{ stack }) {

        foreach my $caller (@$stack) {

            # ignore Try::Tiny lines

            no warnings;

            next if (grep( $_ =~ /Try::Tiny/, @$caller ));
            push(@lines, $self->message( caller => @$caller ));

        }

    }

    return join("\n", @lines);

}

1;

__END__

=head1 NAME

XAS::Exception - The base exception class for the XAS environment

=head1 DESCRIPTION

This module defines a base exception class for the XAS Environment and
inherits from L<Badger::Exception|https://metacpan.org/Badger::Exception>.
The only differences is that it turns stack tracing on by default.

=head1 METHODS

=head2 type

This provides the missing type() method from L<Badger::Exception|https://metacpan.org/pod/Badger::Exception>.

=head2 type_info

This provides the missing type_info() method from L<Badger::Exception|https://metacpan.org/pod/Badger::Exception>.

=head2 stack_trace

Removes any reference to L<Try::Tiny|https://metacpan.org/pod/Try::Tiny> in the stack trace.

=head1 SEE ALSO

=over 4

=item L<XAS|XAS>

=back

=head1 AUTHOR

Kevin L. Esteb, E<lt>[e-mail]<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2014 Kevin L. Esteb

This is free software; you can redistribute it and/or modify it under
the terms of the Artistic License 2.0. For details, see the full text
of the license at http://www.perlfoundation.org/artistic_license_2_0.

=cut