diff --git a/Changes b/Changes new file mode 100644 index 0000000..4610f99 --- /dev/null +++ b/Changes @@ -0,0 +1,54 @@ +Revision history for Test-Fatal + +0.014 2014-12-09 18:35:59-05:00 America/New_York + - avoid assuming that t/todo.t is always called t/todo.t + +0.013 2013-09-23 10:31:15 America/New_York + - rebuild to get a newer compile test that may work on 5.6.x + +0.012 2013-09-17 22:01:45 Asia/Tokyo + - go back to auto-detecting the required Test::More, reverting the + changes made for [rt.cpan.org #62699] + +0.011 2013-09-17 08:48:20 Asia/Tokyo + - more clearly (and correctly) document the way NOT to use Test::Fatal + (thanks, Karen Etheridge!) + + - try to fix $TODO not working when the user test uses $T::B::Level + (thanks, Jesse Luehrs) + +0.010 2012-02-16 10:27:54 America/New_York + - avoid tickling an overloading bug in perl 5.6 during testing (thanks, + Zefram) + +0.009 2012-02-09 15:26:11 America/New_York + - advise against using isnt(exception{...},undef) + +0.008 2011-11-06 21:10:14 America/New_York + - no changes since 0.007 + +0.007 2011-10-31 23:22:47 America/New_York + - revert the mistake by which 0.004 allowed blocks after "exception" as + well as "success" + +0.006 2011-06-01 22:55:10 America/New_York + - crank back the Test::More and Exporter requirements + + - add lives_ok and dies_ok emulation (thanks, Paul "LeoNerd" Evans) + +0.005 2011-04-26 07:50:48 America/New_York + - fix the logic that picks tests for 5.13.1+ (thanks, Zefram) + +0.004 2011-04-25 11:57:59 America/New_York + - success blocks now allow trailing blocks like finally, catch, etc. + (thanks, Joel Bernstein) + +0.003 2010-10-28 22:10:59 America/New_York + - more tests for false exceptions, especially on 5.13 + +0.002 2010-10-28 00:11:09 America/New_York + - add tests for handling of false exceptions + - fix precedence error in documentation (thanks, ether) + +0.001 2010-10-24 00:23:24 America/New_York + - first release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..edb8bc8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2010 by Ricardo Signes. + +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) 2010 by Ricardo Signes. + +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, Fifth Floor, Boston, MA 02110-1301 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) 2010 by Ricardo Signes. + +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 + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..2dfffa2 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,19 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.026. +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +README +dist.ini +examples/convert-to-test-fatal +examples/exception_like.t +lib/Test/Fatal.pm +t/00-report-prereqs.dd +t/00-report-prereqs.t +t/basic.t +t/like-exception.t +t/todo.t +xt/release/changes_has_content.t +xt/release/pod-syntax.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..778eec3 --- /dev/null +++ b/META.json @@ -0,0 +1,503 @@ +{ + "abstract" : "incredibly simple helpers for testing code with exceptions", + "author" : [ + "Ricardo Signes " + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 5.026, CPAN::Meta::Converter version 2.143240", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Test-Fatal", + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "develop" : { + "requires" : { + "Test::Pod" : "1.41" + } + }, + "runtime" : { + "requires" : { + "Carp" : "0", + "Exporter" : "5.57", + "Test::Builder" : "0", + "Try::Tiny" : "0.07", + "strict" : "0", + "warnings" : "0" + } + }, + "test" : { + "recommends" : { + "CPAN::Meta" : "2.120900" + }, + "requires" : { + "ExtUtils::MakeMaker" : "0", + "File::Spec" : "0", + "Test::Builder::Tester" : "0", + "Test::More" : "0.96", + "overload" : "0" + } + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/rjbs/Test-Fatal/issues" + }, + "homepage" : "https://github.com/rjbs/Test-Fatal", + "repository" : { + "type" : "git", + "url" : "https://github.com/rjbs/Test-Fatal.git", + "web" : "https://github.com/rjbs/Test-Fatal" + } + }, + "version" : "0.014", + "x_Dist_Zilla" : { + "perl" : { + "version" : "5.021005" + }, + "plugins" : [ + { + "class" : "Dist::Zilla::Plugin::Git::GatherDir", + "config" : { + "Dist::Zilla::Plugin::GatherDir" : { + "exclude_filename" : [], + "exclude_match" : [], + "follow_symlinks" : "0", + "include_dotfiles" : "0", + "prefix" : "", + "prune_directory" : [], + "root" : "." + }, + "Dist::Zilla::Plugin::Git::GatherDir" : { + "include_untracked" : "0" + }, + "Dist::Zilla::Role::Git::Repo" : { + "repo_root" : "." + } + }, + "name" : "@RJBS/Git::GatherDir", + "version" : "2.028" + }, + { + "class" : "Dist::Zilla::Plugin::CheckPrereqsIndexed", + "name" : "@RJBS/CheckPrereqsIndexed", + "version" : "0.013" + }, + { + "class" : "Dist::Zilla::Plugin::CheckExtraTests", + "name" : "@RJBS/CheckExtraTests", + "version" : "0.025" + }, + { + "class" : "Dist::Zilla::Plugin::PromptIfStale", + "config" : { + "Dist::Zilla::Plugin::PromptIfStale" : { + "check_all_plugins" : 0, + "check_all_prereqs" : 0, + "modules" : [ + "Dist::Zilla::PluginBundle::RJBS" + ], + "phase" : "build", + "skip" : [] + } + }, + "name" : "@RJBS/RJBS-Outdated", + "version" : "0.032" + }, + { + "class" : "Dist::Zilla::Plugin::PromptIfStale", + "config" : { + "Dist::Zilla::Plugin::PromptIfStale" : { + "check_all_plugins" : "1", + "check_all_prereqs" : 0, + "modules" : [], + "phase" : "release", + "skip" : [] + } + }, + "name" : "@RJBS/CPAN-Outdated", + "version" : "0.032" + }, + { + "class" : "Dist::Zilla::Plugin::PruneCruft", + "name" : "@RJBS/@Filter/PruneCruft", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::ManifestSkip", + "name" : "@RJBS/@Filter/ManifestSkip", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::MetaYAML", + "name" : "@RJBS/@Filter/MetaYAML", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::License", + "name" : "@RJBS/@Filter/License", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::Readme", + "name" : "@RJBS/@Filter/Readme", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::ExecDir", + "name" : "@RJBS/@Filter/ExecDir", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::ShareDir", + "name" : "@RJBS/@Filter/ShareDir", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::Manifest", + "name" : "@RJBS/@Filter/Manifest", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::TestRelease", + "name" : "@RJBS/@Filter/TestRelease", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::ConfirmRelease", + "name" : "@RJBS/@Filter/ConfirmRelease", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::UploadToCPAN", + "name" : "@RJBS/@Filter/UploadToCPAN", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::MakeMaker", + "config" : { + "Dist::Zilla::Role::TestRunner" : { + "default_jobs" : 9 + } + }, + "name" : "@RJBS/MakeMaker", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::AutoPrereqs", + "name" : "@RJBS/AutoPrereqs", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::Git::NextVersion", + "config" : { + "Dist::Zilla::Plugin::Git::NextVersion" : { + "first_version" : "0.001", + "version_by_branch" : "0", + "version_regexp" : "(?^:^([0-9]+\\.[0-9]+)$)" + }, + "Dist::Zilla::Role::Git::Repo" : { + "repo_root" : "." + } + }, + "name" : "@RJBS/Git::NextVersion", + "version" : "2.028" + }, + { + "class" : "Dist::Zilla::Plugin::PkgVersion", + "name" : "@RJBS/PkgVersion", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::MetaConfig", + "name" : "@RJBS/MetaConfig", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::MetaJSON", + "name" : "@RJBS/MetaJSON", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::NextRelease", + "name" : "@RJBS/NextRelease", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::Test::ChangesHasContent", + "name" : "@RJBS/Test::ChangesHasContent", + "version" : "0.007" + }, + { + "class" : "Dist::Zilla::Plugin::PodSyntaxTests", + "name" : "@RJBS/PodSyntaxTests", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::Test::ReportPrereqs", + "name" : "@RJBS/Test::ReportPrereqs", + "version" : "0.019" + }, + { + "class" : "Dist::Zilla::Plugin::Prereqs", + "config" : { + "Dist::Zilla::Plugin::Prereqs" : { + "phase" : "test", + "type" : "requires" + } + }, + "name" : "@RJBS/TestMoreWithSubtests", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::PodWeaver", + "config" : { + "Dist::Zilla::Plugin::PodWeaver" : { + "config_plugins" : [ + "@RJBS" + ], + "finder" : [ + ":InstallModules", + ":ExecFiles" + ], + "plugins" : [ + { + "class" : "Pod::Weaver::Plugin::EnsurePod5", + "name" : "@CorePrep/EnsurePod5", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Plugin::H1Nester", + "name" : "@CorePrep/H1Nester", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Plugin::SingleEncoding", + "name" : "@RJBS/SingleEncoding", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Name", + "name" : "@RJBS/Name", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Version", + "name" : "@RJBS/Version", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Region", + "name" : "@RJBS/Prelude", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Synopsis", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Description", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Overview", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Generic", + "name" : "@RJBS/Stability", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Collect", + "name" : "Attributes", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Collect", + "name" : "Methods", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Collect", + "name" : "Functions", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Leftovers", + "name" : "@RJBS/Leftovers", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Region", + "name" : "@RJBS/postlude", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Authors", + "name" : "@RJBS/Authors", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Section::Legal", + "name" : "@RJBS/Legal", + "version" : "4.009" + }, + { + "class" : "Pod::Weaver::Plugin::Transformer", + "name" : "@RJBS/List", + "version" : "4.009" + } + ] + } + }, + "name" : "@RJBS/PodWeaver", + "version" : "4.006" + }, + { + "class" : "Dist::Zilla::Plugin::GithubMeta", + "name" : "@RJBS/GithubMeta", + "version" : "0.46" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Check", + "config" : { + "Dist::Zilla::Plugin::Git::Check" : { + "untracked_files" : "die" + }, + "Dist::Zilla::Role::Git::DirtyFiles" : { + "allow_dirty" : [ + "dist.ini", + "Changes" + ], + "allow_dirty_match" : [], + "changelog" : "Changes" + }, + "Dist::Zilla::Role::Git::Repo" : { + "repo_root" : "." + } + }, + "name" : "@RJBS/@Git/Check", + "version" : "2.028" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Commit", + "config" : { + "Dist::Zilla::Plugin::Git::Commit" : { + "add_files_in" : [], + "commit_msg" : "v%v%n%n%c", + "time_zone" : "local" + }, + "Dist::Zilla::Role::Git::DirtyFiles" : { + "allow_dirty" : [ + "dist.ini", + "Changes" + ], + "allow_dirty_match" : [], + "changelog" : "Changes" + }, + "Dist::Zilla::Role::Git::Repo" : { + "repo_root" : "." + } + }, + "name" : "@RJBS/@Git/Commit", + "version" : "2.028" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Tag", + "config" : { + "Dist::Zilla::Plugin::Git::Tag" : { + "branch" : null, + "signed" : 0, + "tag" : "0.014", + "tag_format" : "%v", + "tag_message" : "v%v", + "time_zone" : "local" + }, + "Dist::Zilla::Role::Git::Repo" : { + "repo_root" : "." + } + }, + "name" : "@RJBS/@Git/Tag", + "version" : "2.028" + }, + { + "class" : "Dist::Zilla::Plugin::Git::Push", + "config" : { + "Dist::Zilla::Plugin::Git::Push" : { + "push_to" : [ + "origin :", + "github :" + ], + "remotes_must_exist" : 0 + }, + "Dist::Zilla::Role::Git::Repo" : { + "repo_root" : "." + } + }, + "name" : "@RJBS/@Git/Push", + "version" : "2.028" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":InstallModules", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":IncModules", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":TestFiles", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":ExecFiles", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":ShareFiles", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":MainModule", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":AllFiles", + "version" : "5.026" + }, + { + "class" : "Dist::Zilla::Plugin::FinderCode", + "name" : ":NoFiles", + "version" : "5.026" + } + ], + "zilla" : { + "class" : "Dist::Zilla::Dist::Builder", + "config" : { + "is_trial" : "0" + }, + "version" : "5.026" + } + } +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..a00c104 --- /dev/null +++ b/META.yml @@ -0,0 +1,368 @@ +--- +abstract: 'incredibly simple helpers for testing code with exceptions' +author: + - 'Ricardo Signes ' +build_requires: + ExtUtils::MakeMaker: '0' + File::Spec: '0' + Test::Builder::Tester: '0' + Test::More: '0.96' + overload: '0' +configure_requires: + ExtUtils::MakeMaker: '0' +dynamic_config: 0 +generated_by: 'Dist::Zilla version 5.026, CPAN::Meta::Converter version 2.143240' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: Test-Fatal +requires: + Carp: '0' + Exporter: '5.57' + Test::Builder: '0' + Try::Tiny: '0.07' + strict: '0' + warnings: '0' +resources: + bugtracker: https://github.com/rjbs/Test-Fatal/issues + homepage: https://github.com/rjbs/Test-Fatal + repository: https://github.com/rjbs/Test-Fatal.git +version: '0.014' +x_Dist_Zilla: + perl: + version: '5.021005' + plugins: + - + class: Dist::Zilla::Plugin::Git::GatherDir + config: + Dist::Zilla::Plugin::GatherDir: + exclude_filename: [] + exclude_match: [] + follow_symlinks: '0' + include_dotfiles: '0' + prefix: '' + prune_directory: [] + root: . + Dist::Zilla::Plugin::Git::GatherDir: + include_untracked: '0' + Dist::Zilla::Role::Git::Repo: + repo_root: . + name: '@RJBS/Git::GatherDir' + version: '2.028' + - + class: Dist::Zilla::Plugin::CheckPrereqsIndexed + name: '@RJBS/CheckPrereqsIndexed' + version: '0.013' + - + class: Dist::Zilla::Plugin::CheckExtraTests + name: '@RJBS/CheckExtraTests' + version: '0.025' + - + class: Dist::Zilla::Plugin::PromptIfStale + config: + Dist::Zilla::Plugin::PromptIfStale: + check_all_plugins: 0 + check_all_prereqs: 0 + modules: + - Dist::Zilla::PluginBundle::RJBS + phase: build + skip: [] + name: '@RJBS/RJBS-Outdated' + version: '0.032' + - + class: Dist::Zilla::Plugin::PromptIfStale + config: + Dist::Zilla::Plugin::PromptIfStale: + check_all_plugins: '1' + check_all_prereqs: 0 + modules: [] + phase: release + skip: [] + name: '@RJBS/CPAN-Outdated' + version: '0.032' + - + class: Dist::Zilla::Plugin::PruneCruft + name: '@RJBS/@Filter/PruneCruft' + version: '5.026' + - + class: Dist::Zilla::Plugin::ManifestSkip + name: '@RJBS/@Filter/ManifestSkip' + version: '5.026' + - + class: Dist::Zilla::Plugin::MetaYAML + name: '@RJBS/@Filter/MetaYAML' + version: '5.026' + - + class: Dist::Zilla::Plugin::License + name: '@RJBS/@Filter/License' + version: '5.026' + - + class: Dist::Zilla::Plugin::Readme + name: '@RJBS/@Filter/Readme' + version: '5.026' + - + class: Dist::Zilla::Plugin::ExecDir + name: '@RJBS/@Filter/ExecDir' + version: '5.026' + - + class: Dist::Zilla::Plugin::ShareDir + name: '@RJBS/@Filter/ShareDir' + version: '5.026' + - + class: Dist::Zilla::Plugin::Manifest + name: '@RJBS/@Filter/Manifest' + version: '5.026' + - + class: Dist::Zilla::Plugin::TestRelease + name: '@RJBS/@Filter/TestRelease' + version: '5.026' + - + class: Dist::Zilla::Plugin::ConfirmRelease + name: '@RJBS/@Filter/ConfirmRelease' + version: '5.026' + - + class: Dist::Zilla::Plugin::UploadToCPAN + name: '@RJBS/@Filter/UploadToCPAN' + version: '5.026' + - + class: Dist::Zilla::Plugin::MakeMaker + config: + Dist::Zilla::Role::TestRunner: + default_jobs: 9 + name: '@RJBS/MakeMaker' + version: '5.026' + - + class: Dist::Zilla::Plugin::AutoPrereqs + name: '@RJBS/AutoPrereqs' + version: '5.026' + - + class: Dist::Zilla::Plugin::Git::NextVersion + config: + Dist::Zilla::Plugin::Git::NextVersion: + first_version: '0.001' + version_by_branch: '0' + version_regexp: (?^:^([0-9]+\.[0-9]+)$) + Dist::Zilla::Role::Git::Repo: + repo_root: . + name: '@RJBS/Git::NextVersion' + version: '2.028' + - + class: Dist::Zilla::Plugin::PkgVersion + name: '@RJBS/PkgVersion' + version: '5.026' + - + class: Dist::Zilla::Plugin::MetaConfig + name: '@RJBS/MetaConfig' + version: '5.026' + - + class: Dist::Zilla::Plugin::MetaJSON + name: '@RJBS/MetaJSON' + version: '5.026' + - + class: Dist::Zilla::Plugin::NextRelease + name: '@RJBS/NextRelease' + version: '5.026' + - + class: Dist::Zilla::Plugin::Test::ChangesHasContent + name: '@RJBS/Test::ChangesHasContent' + version: '0.007' + - + class: Dist::Zilla::Plugin::PodSyntaxTests + name: '@RJBS/PodSyntaxTests' + version: '5.026' + - + class: Dist::Zilla::Plugin::Test::ReportPrereqs + name: '@RJBS/Test::ReportPrereqs' + version: '0.019' + - + class: Dist::Zilla::Plugin::Prereqs + config: + Dist::Zilla::Plugin::Prereqs: + phase: test + type: requires + name: '@RJBS/TestMoreWithSubtests' + version: '5.026' + - + class: Dist::Zilla::Plugin::PodWeaver + config: + Dist::Zilla::Plugin::PodWeaver: + config_plugins: + - '@RJBS' + finder: + - ':InstallModules' + - ':ExecFiles' + plugins: + - + class: Pod::Weaver::Plugin::EnsurePod5 + name: '@CorePrep/EnsurePod5' + version: '4.009' + - + class: Pod::Weaver::Plugin::H1Nester + name: '@CorePrep/H1Nester' + version: '4.009' + - + class: Pod::Weaver::Plugin::SingleEncoding + name: '@RJBS/SingleEncoding' + version: '4.009' + - + class: Pod::Weaver::Section::Name + name: '@RJBS/Name' + version: '4.009' + - + class: Pod::Weaver::Section::Version + name: '@RJBS/Version' + version: '4.009' + - + class: Pod::Weaver::Section::Region + name: '@RJBS/Prelude' + version: '4.009' + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Synopsis' + version: '4.009' + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Description' + version: '4.009' + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Overview' + version: '4.009' + - + class: Pod::Weaver::Section::Generic + name: '@RJBS/Stability' + version: '4.009' + - + class: Pod::Weaver::Section::Collect + name: Attributes + version: '4.009' + - + class: Pod::Weaver::Section::Collect + name: Methods + version: '4.009' + - + class: Pod::Weaver::Section::Collect + name: Functions + version: '4.009' + - + class: Pod::Weaver::Section::Leftovers + name: '@RJBS/Leftovers' + version: '4.009' + - + class: Pod::Weaver::Section::Region + name: '@RJBS/postlude' + version: '4.009' + - + class: Pod::Weaver::Section::Authors + name: '@RJBS/Authors' + version: '4.009' + - + class: Pod::Weaver::Section::Legal + name: '@RJBS/Legal' + version: '4.009' + - + class: Pod::Weaver::Plugin::Transformer + name: '@RJBS/List' + version: '4.009' + name: '@RJBS/PodWeaver' + version: '4.006' + - + class: Dist::Zilla::Plugin::GithubMeta + name: '@RJBS/GithubMeta' + version: '0.46' + - + class: Dist::Zilla::Plugin::Git::Check + config: + Dist::Zilla::Plugin::Git::Check: + untracked_files: die + Dist::Zilla::Role::Git::DirtyFiles: + allow_dirty: + - dist.ini + - Changes + allow_dirty_match: [] + changelog: Changes + Dist::Zilla::Role::Git::Repo: + repo_root: . + name: '@RJBS/@Git/Check' + version: '2.028' + - + class: Dist::Zilla::Plugin::Git::Commit + config: + Dist::Zilla::Plugin::Git::Commit: + add_files_in: [] + commit_msg: v%v%n%n%c + time_zone: local + Dist::Zilla::Role::Git::DirtyFiles: + allow_dirty: + - dist.ini + - Changes + allow_dirty_match: [] + changelog: Changes + Dist::Zilla::Role::Git::Repo: + repo_root: . + name: '@RJBS/@Git/Commit' + version: '2.028' + - + class: Dist::Zilla::Plugin::Git::Tag + config: + Dist::Zilla::Plugin::Git::Tag: + branch: ~ + signed: 0 + tag: '0.014' + tag_format: '%v' + tag_message: v%v + time_zone: local + Dist::Zilla::Role::Git::Repo: + repo_root: . + name: '@RJBS/@Git/Tag' + version: '2.028' + - + class: Dist::Zilla::Plugin::Git::Push + config: + Dist::Zilla::Plugin::Git::Push: + push_to: + - 'origin :' + - 'github :' + remotes_must_exist: 0 + Dist::Zilla::Role::Git::Repo: + repo_root: . + name: '@RJBS/@Git/Push' + version: '2.028' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':InstallModules' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':IncModules' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':TestFiles' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':ExecFiles' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':ShareFiles' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':MainModule' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':AllFiles' + version: '5.026' + - + class: Dist::Zilla::Plugin::FinderCode + name: ':NoFiles' + version: '5.026' + zilla: + class: Dist::Zilla::Dist::Builder + config: + is_trial: '0' + version: '5.026' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..43e9eb4 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,71 @@ + +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.026. +use strict; +use warnings; + + + +use ExtUtils::MakeMaker; + + + +my %WriteMakefileArgs = ( + "ABSTRACT" => "incredibly simple helpers for testing code with exceptions", + "AUTHOR" => "Ricardo Signes ", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "Test-Fatal", + "EXE_FILES" => [], + "LICENSE" => "perl", + "NAME" => "Test::Fatal", + "PREREQ_PM" => { + "Carp" => 0, + "Exporter" => "5.57", + "Test::Builder" => 0, + "Try::Tiny" => "0.07", + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "ExtUtils::MakeMaker" => 0, + "File::Spec" => 0, + "Test::Builder::Tester" => 0, + "Test::More" => "0.96", + "overload" => 0 + }, + "VERSION" => "0.014", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "Carp" => 0, + "Exporter" => "5.57", + "ExtUtils::MakeMaker" => 0, + "File::Spec" => 0, + "Test::Builder" => 0, + "Test::Builder::Tester" => 0, + "Test::More" => "0.96", + "Try::Tiny" => "0.07", + "overload" => 0, + "strict" => 0, + "warnings" => 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); + + + diff --git a/README b/README new file mode 100644 index 0000000..56fddd5 --- /dev/null +++ b/README @@ -0,0 +1,15 @@ + + +This archive contains the distribution Test-Fatal, +version 0.014: + + incredibly simple helpers for testing code with exceptions + +This software is copyright (c) 2010 by Ricardo Signes. + +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.026. + diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..1989265 --- /dev/null +++ b/dist.ini @@ -0,0 +1,7 @@ +name = Test-Fatal +author = Ricardo Signes +license = Perl_5 +copyright_holder = Ricardo Signes +copyright_year = 2010 + +[@RJBS] diff --git a/examples/convert-to-test-fatal b/examples/convert-to-test-fatal new file mode 100755 index 0000000..f937d6e --- /dev/null +++ b/examples/convert-to-test-fatal @@ -0,0 +1,128 @@ +#!/usr/bin/perl + +use strict; +use warnings; + +use Path::Tiny; +use PPI; + +rewrite_doc($_) for grep { -w } @ARGV; + +sub rewrite_doc { + my $file = shift; + + my $doc = PPI::Document->new($file); + + return unless $doc =~ /Test::Exception/; + + print $file, "\n"; + + my $pattern = sub { + my $elt = $_[1]; + + return 1 + if $elt->isa('PPI::Statement') + && $elt->content() + =~ /^\s*(?:::)?(?:lives_|throws_|dies_)(?:ok|and)/; + + return 0; + }; + + for my $elt ( @{ $doc->find($pattern) || [] } ) { + transform_statement($elt); + } + + my $content = $doc->content(); + $content =~ s/Test::Exception/Test::Fatal/g; + + path( $file )->spew( $content ); +} + +sub transform_statement { + my $stmt = shift; + + my @children = $stmt->schildren; + + my $func = shift @children; + + my $colons = $func =~ /^::/ ? '::' : q{}; + + my $code; + if ( $func =~ /lives_/ ) { + $code = function( + $colons . 'is', + $children[0], + 'undef', + $children[1] + ); + } + elsif ( $func =~ /dies_/ ) { + $code = function( + $colons . 'isnt', + $children[0], + 'undef', + $children[1] + ); + } + elsif ( $func =~ /throws_/ ) { + + # $children[2] is always a comma if it exists + if ( $children[1]->isa('PPI::Token::QuoteLike::Regexp') ) { + $code = function( + $colons . 'like', + $children[0], + $children[1], + $children[3] + ); + } + else { + $code = function( + $colons . 'is', + $children[0], + $children[1], + $children[3] + ); + } + } + + $stmt->insert_before($code); + $stmt->remove; +} + +sub function { + my $func = shift; + my $exception = shift; + my $expect = shift; + my $desc = shift; + + my $exc_func = $func =~ /^::/ ? '::exception' : 'exception'; + + my @code; + + push @code, + PPI::Token::Word->new($func), + PPI::Token::Structure->new('('), + PPI::Token::Whitespace->new(q{ }), + PPI::Token::Word->new($exc_func), + PPI::Token::Whitespace->new(q{ }), + $exception->clone, + PPI::Token::Operator->new(','), + PPI::Token::Whitespace->new(q{ }), + ( ref $expect ? $expect->clone : PPI::Token::Word->new($expect) ); + + if ( $desc && $desc->isa('PPI::Token::Quote') ) { + push @code, PPI::Token::Operator->new(','), + PPI::Token::Whitespace->new(q{ }), + $desc->clone; + } + + push @code, + PPI::Token::Whitespace->new(q{ }), + PPI::Token::Structure->new(')'), + PPI::Token::Structure->new(';'); + + my $stmt = PPI::Statement->new; + $stmt->add_element($_) for @code; + + return $stmt; +} diff --git a/examples/exception_like.t b/examples/exception_like.t new file mode 100644 index 0000000..b5355fe --- /dev/null +++ b/examples/exception_like.t @@ -0,0 +1,23 @@ +use strict; +use warnings FATAL => 'all'; + +use Test::More; +use Test::Fatal; +use Carp 'confess'; + +sub exception_like(&$;$) +{ + my ($code, $pattern, $name) = @_; + like( &exception($code), $pattern, $name ); +} + +exception_like(sub { confess 'blah blah' }, qr/foo/, 'foo seems to appear in the exception'); + +# the test only passes when we invert it +unlike( + ( exception { confess 'blah blah' } || '' ), + qr/foo/, + 'foo does NOT ACTUALLY appear in the exception', +); + +done_testing; diff --git a/lib/Test/Fatal.pm b/lib/Test/Fatal.pm new file mode 100644 index 0000000..29aa662 --- /dev/null +++ b/lib/Test/Fatal.pm @@ -0,0 +1,364 @@ +use strict; +use warnings; +package Test::Fatal; +# ABSTRACT: incredibly simple helpers for testing code with exceptions +$Test::Fatal::VERSION = '0.014'; +#pod =head1 SYNOPSIS +#pod +#pod use Test::More; +#pod use Test::Fatal; +#pod +#pod use System::Under::Test qw(might_die); +#pod +#pod is( +#pod exception { might_die; }, +#pod undef, +#pod "the code lived", +#pod ); +#pod +#pod like( +#pod exception { might_die; }, +#pod qr/turns out it died/, +#pod "the code died as expected", +#pod ); +#pod +#pod isa_ok( +#pod exception { might_die; }, +#pod 'Exception::Whatever', +#pod 'the thrown exception', +#pod ); +#pod +#pod =head1 DESCRIPTION +#pod +#pod Test::Fatal is an alternative to the popular L. It does much +#pod less, but should allow greater flexibility in testing exception-throwing code +#pod with about the same amount of typing. +#pod +#pod It exports one routine by default: C. +#pod +#pod =cut + +use Carp (); +use Try::Tiny 0.07; + +use Exporter 5.57 'import'; + +our @EXPORT = qw(exception); +our @EXPORT_OK = qw(exception success dies_ok lives_ok); + +#pod =func exception +#pod +#pod my $exception = exception { ... }; +#pod +#pod C takes a bare block of code and returns the exception thrown by +#pod that block. If no exception was thrown, it returns undef. +#pod +#pod B If the block results in a I exception, such as 0 or the +#pod empty string, Test::Fatal itself will die. Since either of these cases +#pod indicates a serious problem with the system under testing, this behavior is +#pod considered a I. If you must test for these conditions, you should use +#pod L's try/catch mechanism. (Try::Tiny is the underlying exception +#pod handling system of Test::Fatal.) +#pod +#pod Note that there is no TAP assert being performed. In other words, no "ok" or +#pod "not ok" line is emitted. It's up to you to use the rest of C in an +#pod existing test like C, C, C, et cetera. Or you may wish to use +#pod the C and C wrappers, which do provide TAP output. +#pod +#pod C does I alter the stack presented to the called block, meaning +#pod that if the exception returned has a stack trace, it will include some frames +#pod between the code calling C and the thing throwing the exception. +#pod This is considered a I because it avoids the occasionally twitchy +#pod C mechanism. +#pod +#pod B This is not a great idea: +#pod +#pod sub exception_like(&$;$) { +#pod my ($code, $pattern, $name) = @_; +#pod like( &exception($code), $pattern, $name ); +#pod } +#pod +#pod exception_like(sub { }, qr/foo/, 'foo appears in the exception'); +#pod +#pod If the code in the C<...> is going to throw a stack trace with the arguments to +#pod each subroutine in its call stack (for example via C, +#pod the test name, "foo appears in the exception" will itself be matched by the +#pod regex. Instead, write this: +#pod +#pod like( exception { ... }, qr/foo/, 'foo appears in the exception' ); +#pod +#pod B: One final bad idea: +#pod +#pod isnt( exception { ... }, undef, "my code died!"); +#pod +#pod It's true that this tests that your code died, but you should really test that +#pod it died I. For example, if you make an unrelated mistake +#pod in the block, like using the wrong dereference, your test will pass even though +#pod the code to be tested isn't really run at all. If you're expecting an +#pod inspectable exception with an identifier or class, test that. If you're +#pod expecting a string exception, consider using C. +#pod +#pod =cut + +our ($REAL_TBL, $REAL_CALCULATED_TBL) = (1, 1); + +sub exception (&) { + my $code = shift; + + return try { + my $incremented = $Test::Builder::Level - $REAL_CALCULATED_TBL; + local $Test::Builder::Level = $REAL_CALCULATED_TBL; + if ($incremented) { + # each call to exception adds 5 stack frames + $Test::Builder::Level += 5; + for my $i (1..$incremented) { + # -2 because we want to see it from the perspective of the call to + # is() within the call to $code->() + my $caller = caller($Test::Builder::Level - 2); + if ($caller eq __PACKAGE__) { + # each call to exception adds 5 stack frames + $Test::Builder::Level = $Test::Builder::Level + 5; + } + else { + $Test::Builder::Level = $Test::Builder::Level + 1; + } + } + } + + local $REAL_CALCULATED_TBL = $Test::Builder::Level; + $code->(); + return undef; + } catch { + return $_ if $_; + + my $problem = defined $_ ? 'false' : 'undef'; + Carp::confess("$problem exception caught by Test::Fatal::exception"); + }; +} + +#pod =func success +#pod +#pod try { +#pod should_live; +#pod } catch { +#pod fail("boo, we died"); +#pod } success { +#pod pass("hooray, we lived"); +#pod }; +#pod +#pod C, exported only by request, is a L helper with semantics +#pod identical to L|Try::Tiny/finally>, but the body of the block will +#pod only be run if the C block ran without error. +#pod +#pod Although almost any needed exception tests can be performed with C, +#pod success blocks may sometimes help organize complex testing. +#pod +#pod =cut + +sub success (&;@) { + my $code = shift; + return finally( sub { + return if @_; # <-- only run on success + $code->(); + }, @_ ); +} + +#pod =func dies_ok +#pod +#pod =func lives_ok +#pod +#pod Exported only by request, these two functions run a given block of code, and +#pod provide TAP output indicating if it did, or did not throw an exception. +#pod These provide an easy upgrade path for replacing existing unit tests based on +#pod C. +#pod +#pod RJBS does not suggest using this except as a convenience while porting tests to +#pod use Test::Fatal's C routine. +#pod +#pod use Test::More tests => 2; +#pod use Test::Fatal qw(dies_ok lives_ok); +#pod +#pod dies_ok { die "I failed" } 'code that fails'; +#pod +#pod lives_ok { return "I'm still alive" } 'code that does not fail'; +#pod +#pod =cut + +my $Tester; + +# Signature should match that of Test::Exception +sub dies_ok (&;$) { + my $code = shift; + my $name = shift; + + require Test::Builder; + $Tester ||= Test::Builder->new; + + my $ok = $Tester->ok( exception( \&$code ), $name ); + $ok or $Tester->diag( "expected an exception but none was raised" ); + return $ok; +} + +sub lives_ok (&;$) { + my $code = shift; + my $name = shift; + + require Test::Builder; + $Tester ||= Test::Builder->new; + + my $ok = $Tester->ok( !exception( \&$code ), $name ); + $ok or $Tester->diag( "expected return but an exception was raised" ); + return $ok; +} + +1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +Test::Fatal - incredibly simple helpers for testing code with exceptions + +=head1 VERSION + +version 0.014 + +=head1 SYNOPSIS + + use Test::More; + use Test::Fatal; + + use System::Under::Test qw(might_die); + + is( + exception { might_die; }, + undef, + "the code lived", + ); + + like( + exception { might_die; }, + qr/turns out it died/, + "the code died as expected", + ); + + isa_ok( + exception { might_die; }, + 'Exception::Whatever', + 'the thrown exception', + ); + +=head1 DESCRIPTION + +Test::Fatal is an alternative to the popular L. It does much +less, but should allow greater flexibility in testing exception-throwing code +with about the same amount of typing. + +It exports one routine by default: C. + +=head1 FUNCTIONS + +=head2 exception + + my $exception = exception { ... }; + +C takes a bare block of code and returns the exception thrown by +that block. If no exception was thrown, it returns undef. + +B If the block results in a I exception, such as 0 or the +empty string, Test::Fatal itself will die. Since either of these cases +indicates a serious problem with the system under testing, this behavior is +considered a I. If you must test for these conditions, you should use +L's try/catch mechanism. (Try::Tiny is the underlying exception +handling system of Test::Fatal.) + +Note that there is no TAP assert being performed. In other words, no "ok" or +"not ok" line is emitted. It's up to you to use the rest of C in an +existing test like C, C, C, et cetera. Or you may wish to use +the C and C wrappers, which do provide TAP output. + +C does I alter the stack presented to the called block, meaning +that if the exception returned has a stack trace, it will include some frames +between the code calling C and the thing throwing the exception. +This is considered a I because it avoids the occasionally twitchy +C mechanism. + +B This is not a great idea: + + sub exception_like(&$;$) { + my ($code, $pattern, $name) = @_; + like( &exception($code), $pattern, $name ); + } + + exception_like(sub { }, qr/foo/, 'foo appears in the exception'); + +If the code in the C<...> is going to throw a stack trace with the arguments to +each subroutine in its call stack (for example via C, +the test name, "foo appears in the exception" will itself be matched by the +regex. Instead, write this: + + like( exception { ... }, qr/foo/, 'foo appears in the exception' ); + +B: One final bad idea: + + isnt( exception { ... }, undef, "my code died!"); + +It's true that this tests that your code died, but you should really test that +it died I. For example, if you make an unrelated mistake +in the block, like using the wrong dereference, your test will pass even though +the code to be tested isn't really run at all. If you're expecting an +inspectable exception with an identifier or class, test that. If you're +expecting a string exception, consider using C. + +=head2 success + + try { + should_live; + } catch { + fail("boo, we died"); + } success { + pass("hooray, we lived"); + }; + +C, exported only by request, is a L helper with semantics +identical to L|Try::Tiny/finally>, but the body of the block will +only be run if the C block ran without error. + +Although almost any needed exception tests can be performed with C, +success blocks may sometimes help organize complex testing. + +=head2 dies_ok + +=head2 lives_ok + +Exported only by request, these two functions run a given block of code, and +provide TAP output indicating if it did, or did not throw an exception. +These provide an easy upgrade path for replacing existing unit tests based on +C. + +RJBS does not suggest using this except as a convenience while porting tests to +use Test::Fatal's C routine. + + use Test::More tests => 2; + use Test::Fatal qw(dies_ok lives_ok); + + dies_ok { die "I failed" } 'code that fails'; + + lives_ok { return "I'm still alive" } 'code that does not fail'; + +=head1 AUTHOR + +Ricardo Signes + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2010 by Ricardo Signes. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=cut diff --git a/t/00-report-prereqs.dd b/t/00-report-prereqs.dd new file mode 100644 index 0000000..b0e1e4d --- /dev/null +++ b/t/00-report-prereqs.dd @@ -0,0 +1,36 @@ +do { my $x = { + 'configure' => { + 'requires' => { + 'ExtUtils::MakeMaker' => '0' + } + }, + 'develop' => { + 'requires' => { + 'Test::Pod' => '1.41' + } + }, + 'runtime' => { + 'requires' => { + 'Carp' => '0', + 'Exporter' => '5.57', + 'Test::Builder' => '0', + 'Try::Tiny' => '0.07', + 'strict' => '0', + 'warnings' => '0' + } + }, + 'test' => { + 'recommends' => { + 'CPAN::Meta' => '2.120900' + }, + 'requires' => { + 'ExtUtils::MakeMaker' => '0', + 'File::Spec' => '0', + 'Test::Builder::Tester' => '0', + 'Test::More' => '0.96', + 'overload' => '0' + } + } + }; + $x; + } \ No newline at end of file diff --git a/t/00-report-prereqs.t b/t/00-report-prereqs.t new file mode 100644 index 0000000..402b3d9 --- /dev/null +++ b/t/00-report-prereqs.t @@ -0,0 +1,176 @@ +#!perl + +use strict; +use warnings; + +# This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.019 + +use Test::More tests => 1; + +use ExtUtils::MakeMaker; +use File::Spec; + +# from $version::LAX +my $lax_version_re = + qr/(?: undef | (?: (?:[0-9]+) (?: \. | (?:\.[0-9]+) (?:_[0-9]+)? )? + | + (?:\.[0-9]+) (?:_[0-9]+)? + ) | (?: + v (?:[0-9]+) (?: (?:\.[0-9]+)+ (?:_[0-9]+)? )? + | + (?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)? + ) + )/x; + +# hide optional CPAN::Meta modules from prereq scanner +# and check if they are available +my $cpan_meta = "CPAN::Meta"; +my $cpan_meta_pre = "CPAN::Meta::Prereqs"; +my $HAS_CPAN_META = eval "require $cpan_meta; $cpan_meta->VERSION('2.120900')" && eval "require $cpan_meta_pre"; ## no critic + +# Verify requirements? +my $DO_VERIFY_PREREQS = 1; + +sub _max { + my $max = shift; + $max = ( $_ > $max ) ? $_ : $max for @_; + return $max; +} + +sub _merge_prereqs { + my ($collector, $prereqs) = @_; + + # CPAN::Meta::Prereqs object + if (ref $collector eq $cpan_meta_pre) { + return $collector->with_merged_prereqs( + CPAN::Meta::Prereqs->new( $prereqs ) + ); + } + + # Raw hashrefs + for my $phase ( keys %$prereqs ) { + for my $type ( keys %{ $prereqs->{$phase} } ) { + for my $module ( keys %{ $prereqs->{$phase}{$type} } ) { + $collector->{$phase}{$type}{$module} = $prereqs->{$phase}{$type}{$module}; + } + } + } + + return $collector; +} + +my @include = qw( + +); + +my @exclude = qw( + +); + +# Add static prereqs to the included modules list +my $static_prereqs = do 't/00-report-prereqs.dd'; + +# Merge all prereqs (either with ::Prereqs or a hashref) +my $full_prereqs = _merge_prereqs( + ( $HAS_CPAN_META ? $cpan_meta_pre->new : {} ), + $static_prereqs +); + +# Add dynamic prereqs to the included modules list (if we can) +my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; +if ( $source && $HAS_CPAN_META ) { + if ( my $meta = eval { CPAN::Meta->load_file($source) } ) { + $full_prereqs = _merge_prereqs($full_prereqs, $meta->prereqs); + } +} +else { + $source = 'static metadata'; +} + +my @full_reports; +my @dep_errors; +my $req_hash = $HAS_CPAN_META ? $full_prereqs->as_string_hash : $full_prereqs; + +# Add static includes into a fake section +for my $mod (@include) { + $req_hash->{other}{modules}{$mod} = 0; +} + +for my $phase ( qw(configure build test runtime develop other) ) { + next unless $req_hash->{$phase}; + next if ($phase eq 'develop' and not $ENV{AUTHOR_TESTING}); + + for my $type ( qw(requires recommends suggests conflicts modules) ) { + next unless $req_hash->{$phase}{$type}; + + my $title = ucfirst($phase).' '.ucfirst($type); + my @reports = [qw/Module Want Have/]; + + for my $mod ( sort keys %{ $req_hash->{$phase}{$type} } ) { + next if $mod eq 'perl'; + next if grep { $_ eq $mod } @exclude; + + my $file = $mod; + $file =~ s{::}{/}g; + $file .= ".pm"; + my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; + + my $want = $req_hash->{$phase}{$type}{$mod}; + $want = "undef" unless defined $want; + $want = "any" if !$want && $want == 0; + + my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; + + if ($prefix) { + my $have = MM->parse_version( File::Spec->catfile($prefix, $file) ); + $have = "undef" unless defined $have; + push @reports, [$mod, $want, $have]; + + if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META && $type eq 'requires' ) { + if ( $have !~ /\A$lax_version_re\z/ ) { + push @dep_errors, "$mod version '$have' cannot be parsed ($req_string)"; + } + elsif ( ! $full_prereqs->requirements_for( $phase, $type )->accepts_module( $mod => $have ) ) { + push @dep_errors, "$mod version '$have' is not in required range '$want'"; + } + } + } + else { + push @reports, [$mod, $want, "missing"]; + + if ( $DO_VERIFY_PREREQS && $type eq 'requires' ) { + push @dep_errors, "$mod is not installed ($req_string)"; + } + } + } + + if ( @reports ) { + push @full_reports, "=== $title ===\n\n"; + + my $ml = _max( map { length $_->[0] } @reports ); + my $wl = _max( map { length $_->[1] } @reports ); + my $hl = _max( map { length $_->[2] } @reports ); + splice @reports, 1, 0, ["-" x $ml, "-" x $wl, "-" x $hl]; + + push @full_reports, map { sprintf(" %*s %*s %*s\n", -$ml, $_->[0], $wl, $_->[1], $hl, $_->[2]) } @reports; + push @full_reports, "\n"; + } + } +} + +if ( @full_reports ) { + diag "\nVersions for all modules listed in $source (including optional ones):\n\n", @full_reports; +} + +if ( @dep_errors ) { + diag join("\n", + "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n", + "The following REQUIRED prerequisites were not satisfied:\n", + @dep_errors, + "\n" + ); +} + +pass; + +# vim: ts=4 sts=4 sw=4 et: diff --git a/t/basic.t b/t/basic.t new file mode 100644 index 0000000..85a9876 --- /dev/null +++ b/t/basic.t @@ -0,0 +1,77 @@ +use strict; +use warnings; +use Test::More tests => 7 + ($] < 5.013001 ? 1 : 0); +use Test::Fatal qw(exception success); +use Try::Tiny 0.07; + +like( + exception { die "foo bar" }, + qr{foo bar}, + "foo bar is like foo bar", +); + +ok( + ! exception { 1 }, + "no fatality means no exception", +); + +try { + die "die"; +} catch { + pass("we die on demand"); +} success { + fail("this should never be emitted"); +}; + +try { + # die "die"; +} catch { + fail("we did not demand to die"); +} success { + pass("a success block runs, passing"); +}; + +{ + my $i = 0; + try { + die { foo => 42 }; + } catch { + 1; + } success { + fail("never get here"); + } finally { + $i++; + pass("finally block after success block"); + }; + + is($i, 1, "finally block after success block still runs"); +}; + +# TODO: test for fatality of undef exception? + +{ + package BreakException; + sub DESTROY { eval { my $x = 'o no'; } } +} + +if ($] < 5.013001) { + like( + exception { exception { + my $blackguard = bless {}, 'BreakException'; + die "real exception"; + } }, + qr{false exception}, + "we throw a new exception if the exception is false", + ); +} + +{ + package FalseObject; + use overload 'bool' => sub { 0 }; +} + +like( + exception { exception { die(bless {} => 'FalseObject'); } }, + qr{false exception}, + "we throw a new exception if the exception is false", +); diff --git a/t/like-exception.t b/t/like-exception.t new file mode 100644 index 0000000..f7fed35 --- /dev/null +++ b/t/like-exception.t @@ -0,0 +1,27 @@ +#!/usr/bin/perl + +use strict; + +use Test::Builder::Tester tests => 4; + +use Test::Fatal qw( dies_ok lives_ok ); + +test_out( "ok 1 - died" ); +dies_ok { die "FAIL" } 'died'; +test_test( "die dies" ); + +test_out( "not ok 1 - returned" ); +test_fail( +2 ); +test_err( "# expected an exception but none was raised" ); +dies_ok { return 1 } 'returned'; +test_test( "return doesn't die" ); + +test_out( "ok 1 - returned" ); +lives_ok { return 1 } 'returned'; +test_test( "return lived" ); + +test_out( "not ok 1 - died" ); +test_fail( +2 ); +test_err( "# expected return but an exception was raised" ); +lives_ok { die "FAIL" } 'died'; +test_test( "die doesn't live" ); diff --git a/t/todo.t b/t/todo.t new file mode 100644 index 0000000..cc4aae3 --- /dev/null +++ b/t/todo.t @@ -0,0 +1,133 @@ +#!/usr/bin/perl + +use strict; + +use Test::Builder::Tester tests => 4; + +use Test::More; +use Test::Fatal; + +my $file = __FILE__; + +{ + my $line = __LINE__ + 13; + my $out = < 2; + +note 'Checking Changes'; +my $changes_file = 'Changes'; +my $newver = '0.014'; +my $trial_token = '-TRIAL'; + +SKIP: { + ok(-e $changes_file, "$changes_file file exists") + or skip 'Changes is missing', 1; + + ok(_get_changes($newver), "$changes_file has content for $newver"); +} + +done_testing; + +# _get_changes copied and adapted from Dist::Zilla::Plugin::Git::Commit +# by Jerome Quelin +sub _get_changes +{ + my $newver = shift; + + # parse changelog to find commit message + open(my $fh, '<', $changes_file) or die "cannot open $changes_file: $!"; + my $changelog = join('', <$fh>); + close $fh; + + my @content = + grep { /^$newver(?:$trial_token)?(?:\s+|$)/ ... /^\S/ } # from newver to un-indented + split /\n/, $changelog; + shift @content; # drop the version line + + # drop unindented last line and trailing blank lines + pop @content while ( @content && $content[-1] =~ /^(?:\S|\s*$)/ ); + + # return number of non-blank lines + return scalar @content; +} + diff --git a/xt/release/pod-syntax.t b/xt/release/pod-syntax.t new file mode 100644 index 0000000..f0468f1 --- /dev/null +++ b/xt/release/pod-syntax.t @@ -0,0 +1,6 @@ +#!perl +# This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. +use Test::More; +use Test::Pod 1.41; + +all_pod_files_ok();