Ouch-0.0409000755000765000024 012461740655 11417 5ustar00jtstaff000000000000README100644000765000024 56012461740655 12341 0ustar00jtstaff000000000000Ouch-0.0409 This archive contains the distribution Ouch, version 0.0409: Exceptions that don't hurt. This software is copyright (c) 2011 by Plain Black Corporation. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. This README file was generated by Dist::Zilla::Plugin::Readme v5.019. Changes100644000765000024 314612461740655 12777 0ustar00jtstaff000000000000Ouch-0.0409Revision history for Perl module Ouch 0.0409 2015-01-27 - Added support for Travis. Thanks to Zshawn Syed. 0.0408 2013-09-24 - Reformatted the Changes file according to the spec in CPAN::Changes::Spec. Thanks to sergeyromanov who is working on a quest to improve CPAN: http://questhub.io/realm/perl/quest/51f0337718ba7d3959000086 0.0407 2013-09-23 - Catch subclasses of Ouch as well Thanks to Graham Knop. 0.0406 2013-09-13 - Ouch doesn't need 5.12 afterall. Just needed to include the correct prereqs for the pragmas. Thanks to MidLifeXis and Ether. 0.0405 2013-08-19 - worr submitted a patch fixing some a POD error 0.0404 2013-08-19 - Made Ouch explicitly require Perl 5.12 due to use of "use overload" and "use parent". 0.0403 2013-07-11 - Fixed documentation misspellings. @richdouglasevans 0.0402 2013-06-18 - Fixed missing documentation for "barf". - Depricated :traditional in favor of Try::Tiny. - Documented rethrowing Ouches. - Added more docs for the :trytiny aliases 0.0401 2011-04-30 - beppu pointed out there was no $VERSION. Told Dist::Zilla to add that. 0.0400 2011-04-30 - Merged barf() from William Orr. - Added an export called ":trytiny" which exports throw(), caught(), and caught_all(). 0.0300 2011-04-14 - Added hug() as a catch all. By popular demand: http://blogs.perl.org/users/jt_smith/2011/04/ouch---exceptions-that-dont-hurt.html#comments - Codes can now be strings. - Added an export called 'traditional' which gives you more traditional names like try(), catch(), throw(), and catch_all(). 0.0200 2011-04-14 - Added 'bleep'. 0.0100 2011-04-13 - Initial public release. LICENSE100644000765000024 4371412461740655 12536 0ustar00jtstaff000000000000Ouch-0.0409This software is copyright (c) 2011 by Plain Black Corporation. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2011 by Plain Black Corporation. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Suite 500, Boston, MA 02110-1335 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2011 by Plain Black Corporation. This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Build.PL100644000765000024 43112461740655 12752 0ustar00jtstaff000000000000Ouch-0.0409use strict; use warnings; use Module::Build; my $builder = Module::Build->new( 'module_name' => 'Ouch', 'license' => 'perl', 'dist_author' => 'JT Smith', 'build_requires' => { 'Test::More' => 0 }, 'create_makefile_pl' => 'traditional' ); $builder->create_build_script();dist.ini100644000765000024 75012461740655 13126 0ustar00jtstaff000000000000Ouch-0.0409name = Ouch author = JT Smith license = Perl_5 copyright_holder = Plain Black Corporation copyright_year = 2011 version = 0.0409 [@Classic] [MetaResources] bugtracker.web = http://github.com/rizen/Ouch/issues repository.url = git://github.com/rizen/Ouch.git repository.web = http://github.com/rizen/Ouch repository.type = git [Prereqs] Test::More = 0 Test::Trap = 0 parent = 0 overload = 0 Carp = 0 t000755000765000024 012461740655 11603 5ustar00jtstaff000000000000Ouch-0.0409Ouch.t100644000765000024 314312461740655 13027 0ustar00jtstaff000000000000Ouch-0.0409/tuse Test::More tests => 27; use Test::Trap; use lib '../lib'; use_ok 'Ouch'; eval { ouch(100, 'Test', 'field_name') }; isa_ok $@, 'Ouch'; is $@->code, 100, 'fetch code'; is kiss(100), 1, 'trap an ouch'; is kiss(101), 0, 'do not trap wrong ouch'; is hug(), 1, 'hug catches ouch'; is $@->message, 'Test', 'fetch message'; is $@->data, 'field_name', 'fetch data'; like $@, qr/^Test at/, 'string overload works'; isa_ok $@->hashref, 'HASH'; ok $@->trace, 'got a stack trace'; is bleep(), 'Test', 'can get a clean message for an ouch'; # what if it's not an ouch; eval { die 'crap' }; is kiss(100), 0, 'do not trap non-ouch'; is bleep(), 'crap', 'can get the message for a non-ouch'; is hug(), 1, 'hug catches non-ouch'; # work out the traditional stuff use Ouch qw(:traditional); my $e = try { throw 100, 'Yikes'; }; isa_ok $e, 'Ouch'; is catch(100, $e), 1, 'catch works'; is catch(101, $e), 0, 'catch works when not trapped'; is catch_all($e), 1, 'catch_all does the same as hug'; # what if there is no exception eval { my $x = 1 }; is hug(), 0, 'hug does not catch lack of exception'; is catch_all($e), 0, 'catch_all does the same as hug'; # what if the exception code is a string eval { ouch('missing_param', 'Email'); }; is kiss('missing_param'), 1, 'kiss works on strings'; is kiss('foo'), 0, 'kiss gives no false positives'; # barf trap {eval { ouch(100, 'oops') } or barf() }; is $trap->exit, 100, 'exit code'; is $trap->stderr, "oops\n", 'stderr err message'; # more barf trap { eval { die 'error' } or barf() }; is $trap->exit, 1, 'default barf exit code'; is $trap->stderr, "error\n", 'stderr err message w/o ouch'; META.yml100644000765000024 111112461740655 12743 0ustar00jtstaff000000000000Ouch-0.0409--- abstract: "Exceptions that don't hurt." author: - 'JT Smith ' build_requires: {} configure_requires: ExtUtils::MakeMaker: '6.30' dynamic_config: 0 generated_by: 'Dist::Zilla version 5.019, CPAN::Meta::Converter version 2.142690' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Ouch requires: Carp: '0' Test::More: '0' Test::Trap: '0' overload: '0' parent: '0' resources: bugtracker: http://github.com/rizen/Ouch/issues repository: git://github.com/rizen/Ouch.git version: '0.0409' MANIFEST100644000765000024 35212461740655 12611 0ustar00jtstaff000000000000Ouch-0.0409# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.019. Build.PL Changes LICENSE MANIFEST META.yml Makefile.PL README dist.ini lib/Ouch.pm t/Ouch.t t/release-pod-coverage.t t/release-pod-syntax.t t/subclass.t lib000755000765000024 012461740655 12106 5ustar00jtstaff000000000000Ouch-0.0409Ouch.pm100644000765000024 2230412461740655 13523 0ustar00jtstaff000000000000Ouch-0.0409/libuse strict; use warnings; package Ouch; $Ouch::VERSION = '0.0409'; use Carp qw(longmess shortmess); use parent 'Exporter'; use overload bool => sub {1}, q{""} => 'scalar', fallback => 1; use Scalar::Util qw(blessed); our @EXPORT = qw(bleep ouch kiss hug barf); our @EXPORT_OK = qw(try throw catch catch_all caught caught_all); our %EXPORT_TAGS = ( traditional => [qw(try throw catch catch_all)], trytiny => [qw( throw caught caught_all )] ); sub new { my ($class, $code, $message, $data) = @_; bless {code => $code, message => $message, data => $data, shortmess => shortmess($message), trace => longmess($message) }, $class; } sub try (&) { my $try = shift; eval { $try->() }; return $@; } sub ouch { my ($code, $message, $data) = @_; my $self = __PACKAGE__->new($code, $message, $data); die $self; } sub throw { # alias ouch @_; } sub kiss { my ($code, $e) = @_; $e ||= $@; if (blessed $e && $e->isa('Ouch') && $e->code eq $code) { return 1; } return 0; } sub catch { kiss @_; } sub caught { kiss @_; } sub hug { my ($e) = @_; $e ||= $@; return $@ ? 1 : 0; } sub catch_all { hug @_; } sub caught_all { hug @_; } sub bleep { my ($e) = @_; $e ||= $@; if (blessed $e && $e->isa('Ouch')) { return $e->message; } else { my $message = $@; if ($message =~ m{^(.*)\s+at\s.*line\s\d+.}xms) { return $1; } else { return $message; } } } sub barf { my ($e) = @_; my $code; $e ||= $@; if (blessed $e && $e->isa('Ouch')) { $code = $e->code; } else { $code = 1; } print STDERR bleep($e)."\n"; exit $code; } sub scalar { my $self = shift; return $self->{shortmess}; } sub trace { my $self = shift; return $self->{trace}; } sub hashref { my $self = shift; return { code => $self->{code}, message => $self->{message}, data => $self->{data}, }; } sub code { my $self = shift; return $self->{code}; } sub message { my $self = shift; return $self->{message}; } sub data { my $self = shift; return $self->{data}; } =head1 NAME Ouch - Exceptions that don't hurt. =head1 VERSION version 0.0409 =head1 SYNOPSIS use Ouch; eval { ouch(404, 'File not found.'); }; if (kiss 404) { check_elsewhere(); } say $@; # These two lines do the say $@->scalar; # same thing. =head1 DESCRIPTION Ouch provides a class for exception handling that doesn't require a lot of boilerplate, nor any up front definition. If L is working for you, great! But if you want something that is faster, easier to use, requires less typing, and has no prereqs, but still gives you much of that same functionality, then Ouch is for you. =head2 Why another exception handling module? It really comes down to L isn't enough for me, and L does what I want but makes me type way too much. Also, I tend to work on a lot of protocol-based systems that use error codes (HTTP, FTP, SMTP, JSON-RPC) rather than error classes, so that feels more natural to me. Consider the difference between these: B use Ouch; ouch 404, 'File not found.', 'file'; B use Exception::Class ( 'FileNotFound' => { fields => [ 'code', 'field' ], }, ); FileNotFound->throw( error => 'File not found.', code => 404, field => 'file' ); And if you want to catch the exception you're looking at: B if (kiss 404) { # do something } B my $e; if ($e = Exception::Class->caught('FileNotFound')) { # do something } Those differences may not seem like a lot, but over any substantial program with lots of exceptions it can become a big deal. =head2 Usage Most of the time, all you need to do is: ouch $code, $message, $data; ouch -32700, 'Parse error.', $request; # JSON-RPC 2.0 error ouch 441, 'You need to specify an email address.', 'email'; # form processing error ouch 'missing_param', 'You need to specify an email address.', 'email'; You can also go long form if you prefer: die Ouch->new($code, $message, $data); If you want to rethrow an Ouch, you can simply C it. eval { ouch(404, 'File not found.'); } ; die $@; =head2 Functional Interface =head3 ouch Some nice sugar instead of using the object oriented interface. ouch 2121, 'Did not do the big thing.'; =over =item code An error code. An integer or string representing error type. Try to stick to codes used in whatever domain you happen to be working in. HTTP Status codes. JSON-RPC error codes, etc. =item message A human readable error message. =item data Optional. Anything you want to attach to the exception to help a developer catching it decide what to do. For example, if you're doing form processing, you might want this to be the name of the field that caused the exception. B Do not include objects or code refs in your data. This should only be stuff that is easily serializable like scalars, array refs, and hash refs. =back =head3 kiss Some nice sugar to trap an Ouch. if (kiss $code) { # make it go } =over =item code The code you're looking for. =item exception Optional. If you like you can pass the exception into C. If not, it will just use whatever is in C<$@>. You might want to do this if you've saved the exception before running another C, for example. =back =head3 hug Some nice sugar to trap any exception. if (hug) { # make it stop } =over =item exception Optional. If you like you can pass the exception into C. If not, it will just use whatever is in C<$@>. =back =head3 bleep A little sugar to make exceptions human friendly. Returns a clean error message from any exception, including an Ouch. File not found. Rather than: File not found. at /Some/File.pm line 63. =over =item exception Optional. If you like you can pass the exception into C. If not, it will just use whatever is in C<$@>. =back =head3 barf Calls C, and then exits with error code =over =item exception Optional. You can pass an exception into C which then gets passed to C otherwise it will use whatever's in C<$@> =back =head2 Object-Oriented Interface =head3 new Constructor for the object-oriented interface. Takes the same parameters as C. Ouch->new($code, $message, $data); =head3 scalar Returns the scalar form of the error message: Crap! at /Some/File.pm line 43. Just as if you had done: die 'Crap!'; Rather than: ouch $code, 'Crap!'; =head3 trace Call this if you want the full stack trace that lead up to the ouch. =head3 hashref Returns a formatted hash reference of the exception, which can be useful for handing off to a serializer like L. { code => $code, message => $message, data => $data, } =head3 code Returns the C passed into the constructor. =head3 message Returns the C passed into the constructor. =head3 data Returns the C passed into the constructor. =head2 Try::Tiny Many Ouch users like to use Ouch with L. use Try::Tiny; use Ouch; try { ouch 404, 'File not found!'; } catch { if (kiss(401, $_)) { # do something } else { die $_; # rethrow } }; Some users are sticks in the mud who can't bring themselves to C and C. For them, there is the C<:trytiny> interface. Here's how it works: use Try::Tiny; use Ouch qw(:trytiny); try { throw(404, 'File not found!'; } catch { if (caught(401, $_)) { # do something } else { die $_; # rethrow } }; =head3 throw See C for details. =head3 caught See C for details. =head3 caught_all See C for details. =head1 DEPRECATED This functionality is deprecated and will be removed in a future release. Use Try::Tiny instead. =head2 Traditional Interface Some people just can't bring themselves to use the sugary cuteness of Ouch. For them there is the C<:traditional> interface. Here's how it works: use Ouch qw(:traditional); my $e = try { throw 404, 'File not found.'; }; if ( catch 404, $e ) { # do the big thing } elsif ( catch_all $e ) { # make it stop } else { # make it go } B C also populates C<$@>, and C and C will also use C<$@> if you don't specify an exception. =head3 try Returns an exception. Is basically just a nice wrapper around C. =over =item block Try accepts a code ref, anonymous subroutine, or a block. B You need a semi-colon at the end of a C block. =back =head3 throw Works exactly like C. See C for details. =head3 catch Works exactly like C. See C for details. =head3 catch_all Works exactly like C. See C for details. =head1 REQUIREMENTS Requires Perl 5.12 or higher. =head1 SUPPORT =over =item Repository L =item Bug Reports L =back =head1 SEE ALSO If you're looking for something lighter, check out L that ships with Perl. Or if you're looking for something heavier check out L. =head1 AUTHOR JT Smith =head1 LEGAL Ouch is Copyright 2011 Plain Black Corporation (L) and is licensed under the same terms as Perl itself. =cut 1; Makefile.PL100644000765000024 207412461740655 13455 0ustar00jtstaff000000000000Ouch-0.0409 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.019. use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "Exceptions that don't hurt.", "AUTHOR" => "JT Smith ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30" }, "DISTNAME" => "Ouch", "EXE_FILES" => [], "LICENSE" => "perl", "NAME" => "Ouch", "PREREQ_PM" => { "Carp" => 0, "Test::More" => 0, "Test::Trap" => 0, "overload" => 0, "parent" => 0 }, "VERSION" => "0.0409", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "Test::More" => 0, "Test::Trap" => 0, "overload" => 0, "parent" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); subclass.t100644000765000024 33512461740655 13730 0ustar00jtstaff000000000000Ouch-0.0409/tuse Test::More tests => 2; use Test::Trap; use lib '../lib'; use_ok 'Ouch'; { package Subclass::Ouch; use parent 'Ouch'; } eval { die Subclass::Ouch->new(42, 'welp') }; is kiss(42), 1, 'still catches subclasses'; release-pod-syntax.t100644000765000024 45612461740655 15641 0ustar00jtstaff000000000000Ouch-0.0409/t#!perl BEGIN { unless ($ENV{RELEASE_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for release candidate testing'); } } # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use Test::More; use Test::Pod 1.41; all_pod_files_ok(); release-pod-coverage.t100644000765000024 57212461740655 16105 0ustar00jtstaff000000000000Ouch-0.0409/t#!perl BEGIN { unless ($ENV{RELEASE_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for release candidate testing'); } } # This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. use Test::Pod::Coverage 1.08; use Pod::Coverage::TrustPod; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' });