—

              
package Workflow::Exception;
use warnings;
use strict;
use v5.14.0;
# Declare some of our exceptions...
use Exception::Class (
    'Workflow::Exception::Configuration' => {
        isa         => 'Workflow::Exception',
        description => 'Configuration errors',
    },
    'Workflow::Exception::Persist' => {
        isa         => 'Workflow::Exception',
        description => 'Persistence errors',
    },
    'Workflow::Exception::Validation' => {
        isa         => 'Workflow::Exception',
        description => 'Validation errors',
        fields      => 'invalid_fields',
    },
);
use Log::Any;
my %TYPE_CLASSES = (
    configuration_error => 'Workflow::Exception::Configuration',
    persist_error       => 'Workflow::Exception::Persist',
    validation_error    => 'Workflow::Exception::Validation',
    workflow_error      => 'Workflow::Exception',
);
my %TYPE_LOGGING = (
    configuration_error => 'error',
    persist_error       => 'error',
    validation_error    => 'info',
    workflow_error      => 'error',
);
$Workflow::Exception::VERSION   = '2.05';
@Workflow::Exception::ISA       = qw( Exporter Exception::Class::Base );
@Workflow::Exception::EXPORT_OK = keys %TYPE_CLASSES;
# Exported shortcuts
sub _mythrow {
    my ( $type, @items ) = @_;
    my ( $msg, %params ) = _massage(@items);
    my $caller = caller;
    my $log = Log::Any->get_logger( category => $caller ); # log as if part of the package of the caller
    my ( $pkg, $line ) = (caller)[ 0, 2 ];
    my ( $prev_pkg, $prev_line ) = ( caller 1 )[ 0, 2 ];
    # Do not log condition errors
    my $method = $TYPE_LOGGING{$type};
    $log->$method(
        "$type exception thrown from [$pkg: $line; before: ",
        "$prev_pkg: $prev_line]: $msg"
    );
    goto &Exception::Class::Base::throw(
        $TYPE_CLASSES{$type},
        message => $msg,
        %params
    );
}
# Use 'goto' here to maintain the stack trace
sub configuration_error {
    unshift @_, 'configuration_error';
    goto &_mythrow;
}
sub persist_error {
    unshift @_, 'persist_error';
    goto &_mythrow;
}
sub validation_error {
    unshift @_, 'validation_error';
    goto &_mythrow;
}
sub workflow_error {
    unshift @_, 'workflow_error';
    goto &_mythrow;
}
# Override 'throw' so we can massage the message and parameters into
# the right format for E::C
sub throw {
    my ( $class, @items ) = @_;
    my ( $msg, %params ) = _massage(@items);
    goto &Exception::Class::Base::throw( $class, message => $msg, %params );
}
sub _massage {
    my @items = @_;
    my %params = ( ref $items[-1] eq 'HASH' ) ? %{ pop @items } : ();
    my $msg = join '', @items;
    $msg =~ s/\\n/ /g; # don't log newlines as per Log4perl recommendations
    return ( $msg, %params );
}
1;
__END__
HideShow 130 lines of Pod
=pod
=head1 NAME
Workflow::Exception - Base class for workflow exceptions
=head1 VERSION
This documentation describes version 2.05 of this package
=head1 SYNOPSIS
 # Standard usage
 use Workflow::Exception qw( workflow_error );
 my $user = $wf->context->param( 'current_user' );
 unless ( $user->check_password( $entered_password ) ) {
   workflow_error "User exists but password check failed";
 }
 # Pass a list of strings to form the message
 unless ( $user->check_password( $entered_password ) ) {
   workflow_error 'Bad login: ', $object->login_attempted;
 }
 # Using other exported shortcuts
 use Workflow::Exception qw( configuration_error );
 configuration_error "Field 'foo' must be a set to 'bar'";
 use Workflow::Exception qw( validation_error );
 validation_error "Validation for field 'foo' failed: $error";
=head1 DESCRIPTION
First, you should probably look at
L<Exception::Class|Exception::Class> for more usage examples, why we
use exceptions, what they are intended for, etc.
This is the base class for all workflow exceptions. It declares a
handful of exceptions and provides shortcuts to make raising an
exception easier and more readable.
=head1 METHODS
=head3 throw( @msg, [ \%params ])
This overrides B<throw()> from L<Exception::Class|Exception::Class> to
add a little syntactic sugar. Instead of:
 $exception_class->throw( message => 'This is my very long error message that I would like to pass',
                          param1  => 'Param1 value',
                          param2  => 'Param2 value' );
You can use:
 $exception_class->throw( 'This is my very long error message ',
                          'that I would like to pass',
                          { param1 => 'Param1 value',
                            param2 => 'Param2 value' } );
And everything will work the same. Combined with the L<SHORTCUTS> this
makes for very readable code:
 workflow_error "Something went horribly, terribly, dreadfully, "
                "frightfully wrong: $@",
                { foo => 'bar' };
=head3 configuration_error
This method transforms the error to a configuration error.
This exception is thrown via </mythrow> when configuration of a workflow is unsuccessful.
=head3 persist_error
This method transforms the error to a persistance error.
This exception is thrown via </mythrow> when the save of a workflow is unsuccessful.
=head3 validation_error
This method transforms the error to a validation error.
This exception is thrown via </mythrow> when input data or similar of a workflow is unsuccessful.
=head3 workflow_error
This method transforms the error to a workflow error.
This exception is thrown via </mythrow> when input data or similar of a workflow is unsuccessful.
=head1 SHORTCUTS
=over
=item * B<Workflow::Exception> - import using C<workflow_error>
=item * B<Workflow::Exception::Configuration> - import using C<configuration_error>
=item * B<Workflow::Exception::Persist> - import using C<persist_error>
=item * B<Workflow::Exception::Validation> - import using C<validation_error>
=back
=head1 SEE ALSO
=over
=item * L<Exception::Class|Exception::Class>
=back
=head1 COPYRIGHT
Copyright (c) 2003-2021 Chris Winters. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
Please see the F<LICENSE>
=head1 AUTHORS
Please see L<Workflow>
=cut