The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Throwable-Factory-Try-0.03
River stage zero No dependents
++
/ Throwable::Factory::Try

NAME

Throwable::Factory::Try - exception handling for Throwable::Factory

VERSION

Version 0.03

SYNOPSIS

This module provides a try/catch/finally mechanism to be used with Throwable::Factory, based off Try::Tiny::ByClass and Dispatch::Class. The goal is to provide a simple but powerful exception framework.

    use Throwable::Factory
        FooBarException => ['-notimplemented'],
        FooException => ['-notimplemented'],
    ;
    use Throwable::Factory::Try;

    try {
        FooBarException->throw('it happened again')
    }
    catch [
        'LWP::UserAgent' => sub { print 'Why are you throwing that at me' },
        ['LWP::UserAgent', 'HTTP::Tiny'] => sub { print 'Why are you throwing those at me' },
        'FooBarException' => sub { print shift },
        qr/^Foo/ => sub { FooException->throw },
        ['FooBarException','FooException'] => sub { print "One of these two" },
        '-notimplemented' => sub { print 'One of these' },
        [':str', qr/^Foo/] => sub { print 'String starting with Foo: ' . shift },
        ':str' => sub { print 'Just a string: ' . shift },
        '*' => sub { print 'default case' },
    ],
    finally {
        do_it_anyway()
    };

FUNCTIONS

catch

Replacement for catch. It has to be right after the try code block, and can handle the finally statement as an argument. It takes an array reference of CONDITION => CODE BLOCK, which will be treated in the same order it was passed to catch. CONDITION can be one of the following:

  • '<class>' - matches objects which DOES or isa <class>

        try {
        My::Exception::Class->throw('my own exception')
    }
    catch [
        'My::Exception::Class' => sub { print 'Here it is' }
    ];

  • ['<class>'] - matches objects whose classname is in the array

        try {
        My::Exception::Class->throw('my own exception')
    }
    catch [
        ['My::Exception::Class', 'My::Exception::SecondClass'] => sub { print 'Here it is' }
    ];

  • '<TYPE>' - matches Throwable::Factory objects based on their TYPE

        use Throwable::Factory
        FooBarException => undef,
    ;
    
    try {
        FooBarException->throw('I failed')
    }
    catch [
        'FooBarException' => sub { print 'Here it is' }
    ];

  • ['<TYPE>'] - same as above, but with multiple choice.

        use Throwable::Factory
        FooBarException => undef,
    ;
    
    try {
        FooBarException->throw('I failed')
    }
    catch [
        ['FooBarException', 'FooException'] => sub { print 'Here it is' }
    ];

  • Regexp - matches Throwable::Factory objects whose TYPE matches the pattern

        use Throwable::Factory
        ConnectionClosedException => undef,
        ConnectionFailedException => undef,
    ;
    
    try {
        ConnectionClosedException->throw('Damn')
    }
    catch [
        qr/^Connection/ => sub { print 'Here it is' }
    ];

  • '<TAXONOMY>' - matches Throwable::Factory objects based of their taxonomy

        use Throwable::Factory
        BadArgumentException => ['-caller'],
    ;
    
    try {
        BadArgumentException->throw('try again')
    }
    catch [
        '-caller' => sub { print 'Here it is' }
    ];

  • ':str' - matches all strings

        try {
        die 'oops'
    }
    catch [
        ':str' => sub { print 'Here it is: ' . shift }
    ];

    [':str', <Regexp>] - matches strings with a Regexp

        try {
        die 'oops'
    }
    catch [
        [':str', qr/^oops/ ] => sub { print 'Here it is: ' . shift }
    ];

  • '*' - matches everything. Use this as a 'catch all' case.

INTERNAL METHODS

_class_case

Method based on class_name, but with cases specific to Throwable::Factory, i.e. taxonomy cases and exception type.

_dispatch

Method based on dispatch.

AUTHOR

Lucien Coffe, <lcoffe at cpan.org>

BUGS

Please report any bugs or feature requests to bug-throwable-factory-try at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Throwable-Factory-Try. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Throwable::Factory::Try

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Lucien Coffe.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.