From cde0b40bcd5fa346c276c23fc665d55fa3b55222 Mon Sep 17 00:00:00 2001 From: Packit Date: Sep 16 2020 16:04:04 +0000 Subject: perl-Sub-Uplevel-0.2800 base --- diff --git a/CONTRIBUTING.mkdn b/CONTRIBUTING.mkdn new file mode 100644 index 0000000..761c9db --- /dev/null +++ b/CONTRIBUTING.mkdn @@ -0,0 +1,87 @@ +## HOW TO CONTRIBUTE + +Thank you for considering contributing to this distribution. This file +contains instructions that will help you work with the source code. + +The distribution is managed with Dist::Zilla. This means than many of the +usual files you might expect are not in the repository, but are generated at +release time, as is much of the documentation. Some generated files are +kept in the repository as a convenience (e.g. Makefile.PL or cpanfile). + +Generally, **you do not need Dist::Zilla to contribute patches**. You do need +Dist::Zilla to create a tarball. See below for guidance. + +### Getting dependencies + +If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to +satisfy dependencies like this: + + $ cpanm --installdeps . + +Otherwise, look for either a `Makefile.PL` or `cpanfile` file for +a list of dependencies to satisfy. + +### Running tests + +You can run tests directly using the `prove` tool: + + $ prove -l + $ prove -lv t/some_test_file.t + +For most of my distributions, `prove` is entirely sufficient for you to test any +patches you have. I use `prove` for 99% of my testing during development. + +### Code style and tidying + +Please try to match any existing coding style. If there is a `.perltidyrc` +file, please install Perl::Tidy and use perltidy before submitting patches. + +If there is a `tidyall.ini` file, you can also install Code::TidyAll and run +`tidyall` on a file or `tidyall -a` to tidy all files. + +### Patching documentation + +Much of the documentation Pod is generated at release time. Some is +generated boilerplate; other documentation is built from pseudo-POD +directives in the source like C<=method> or C<=func>. + +If you would like to submit a documentation edit, please limit yourself to +the documentation you see. + +If you see typos or documentation issues in the generated docs, please +email or open a bug ticket instead of patching. + +### Installing and using Dist::Zilla + +Dist::Zilla is a very powerful authoring tool, optimized for maintaining a +large number of distributions with a high degree of automation, but it has a +large dependency chain, a bit of a learning curve and requires a number of +author-specific plugins. + +To install it from CPAN, I recommend one of the following approaches for +the quickest installation: + + # using CPAN.pm, but bypassing non-functional pod tests + $ cpan TAP::Harness::Restricted + $ PERL_MM_USE_DEFAULT=1 HARNESS_CLASS=TAP::Harness::Restricted cpan Dist::Zilla + + # using cpanm, bypassing *all* tests + $ cpanm -n Dist::Zilla + +In either case, it's probably going to take about 10 minutes. Go for a walk, +go get a cup of your favorite beverage, take a bathroom break, or whatever. +When you get back, Dist::Zilla should be ready for you. + +Then you need to install any plugins specific to this distribution: + + $ cpan `dzil authordeps` + $ dzil authordeps | cpanm + +Once installed, here are some dzil commands you might try: + + $ dzil build + $ dzil test + $ dzil xtest + +You can learn more about Dist::Zilla at http://dzil.org/ + diff --git a/Changes b/Changes new file mode 100644 index 0000000..4ec3c55 --- /dev/null +++ b/Changes @@ -0,0 +1,185 @@ +Changes for Sub::Uplevel + +0.2800 2017-04-01 13:31:22-04:00 America/New_York + + - No changes from 0.2700-TRIAL + +0.2700 2017-03-30 10:09:46-04:00 America/New_York (TRIAL RELEASE) + + [Fixed] + + - Tests now work if '.' is not in @INC + +0.2600 2016-08-05 10:46:37-04:00 America/New_York + + - No changes from 0.2501-TRIAL + +0.2501 2016-07-29 16:18:45-04:00 America/New_York (TRIAL RELEASE) + + [~Internal~] + + - Optimized calls to caller() + +0.25 2015-01-26 20:32:52-05:00 America/New_York + + [Fixed] + + - fixed: 00-compile.t failures under Windows (bug #98230). + The 00-compile.t file has been moved to a release test and is + no longer shipped. [Michael Gray] + + [Meta] + + - moved bug tracker to Github + + - updated repo files explaining how to contribute + + - enabled Travis CI + +0.24 2012-02-20 22:18:46 EST5EDT + + - no changes from 0.23_03 + +0.23_03 2012-02-07 17:16:49 EST5EDT + + - fixed: additional test regex fixed + +0.23_02 2012-02-07 14:32:53 EST5EDT + + - fixed: Perl 5.15 series Carp changes output format of messages (adds + a period). This fixes the test regular expressions. [Andreas Koenig] + +0.23_01 2012-02-02 10:41:31 EST5EDT + + - added: the $Sub::Uplevel::CHECK_FRAMES global constant to enable the + frame depth checking and compile it out if not needed. [Adam + Kennedy] + +0.22 Tue Nov 17 05:38:42 EST 2009 + + - meta: added repository to metadata [Alexandr Ciornii] + +0.21_01 Sat Nov 29 15:24:49 EST 2008 + + - added: the ":aggressive" tag may be used to force reloading of + Exporter, which often binds caller() prior to Sub::Uplevel's global + override + +0.2002 Thu Sep 11 14:33:09 EDT 2008 + + - changed: removed Exporter dependency + + - test fix: fixed strange t/07_uplevel_too_high.t fail on Win32 + +0.2001 Tue Sep 9 22:22:40 EDT 2008 + + - test fix: changed prior override test to be more robust (SCHWERN) + +0.20 Tue Sep 9 19:23:35 EDT 2008 + + - changed: bumped perl requirement to 5.006 and stopped using vars + (fixes a test bug under Test::More > 0.80) + +0.19_03 Fri Jul 4 13:31:21 EDT 2008 + + - fixed: load Carp only as needed (fixes problem on 5.005) + +0.19_02 Thu Feb 21 14:58:46 EST 2008 + + - added: uplevel will warn if uplevel request is more than the call + stack depth + +0.1901 Thu Feb 14 14:07:37 EST 2008 + + - fixed: hides the "DB" package from indexers (DB used to support + @DB::args) + +0.19 Thu Feb 14 11:50:16 EST 2008 + + - bug fix: replacement caller() correctly sets @DB::args if calling + package is DB + + - repackaging: custom Build.PL, moved all author tests to xt/, added + LICENSE and INSTALL files + +0.18 Wed Oct 31 06:56:13 EDT 2007 + - release version of 0.17_01 changes + +0.17_01 + - removed 5.006-specific language and tested on prerelease 5.00505 + +0.16 Mon Jul 30 09:54:41 EDT 2007 + - release version of 0.15_01 changes + +0.15_01 Thu Jul 5 22:54:08 EDT 2007 + - Won't override any existing CORE::GLOBAL::caller when loaded + - Localize global caller() override to the scope of the uplevel() call + so it can play nicer with things like Contextual::Return and + Hook::LexWrap that also override caller() + +0.14 Sun Nov 5 23:38:46 EST 2006 + - fixed t/99_pod_coverage.t bug + - added examples directory + +0.13 Thu Jun 22 19:47:26 EDT 2006 + - fixed bug in Uplevel.t that caused test failure on FreeBSD for 5.8.0 + - fixed bug in Uplevel.t that caused test failure on bleadperl-5.9.4 + - removed ancient Test::More provided in t/lib + - switched ok(eq_array()) tests to is_deeper() for better diagnostics + - added pod/pod coverage checks + - numbered tests + +0.12 Fri May 12 18:33:40 EDT 2006 + - official release of the uplevel stack patch (fixes RT#13893) + - added Build.PL and switched to boilerplate generated Makefile.PL + - removed SIGNATURE due to recently discovered Module::Signature + issues with newline handling and sub-key compatible keyservers + - updated/added various meta files + +0.11_01 Fri Apr 21 00:49:51 EDT 2006 + - uplevel now keeps a proper stack of uplevel calls allowing + nesting of uplevel and non-uplevel calls + +0.10 Thu Apr 20 19:15:20 EDT 2006 + - Stopped warnings about "undefined" on Perl 5.8.8 + - DAGOLDEN added as co-maintainer + +0.09 Wed Jul 7 14:52:08 EDT 2004 + - Ok, ok. I'll put a license on this. + +0.08 Wed Oct 22 09:02:38 PDT 2003 + - New die_check.t test was written in a non-portable manner. + [Thanks Martin Thurn and cpantesters] + +0.07 Tue Mar 18 03:03:22 GMT 2003 + - Fixed a test bug due to 5.6.0's differing Carp::croak stack output + +0.06 Thu Sep 20 08:50:30 EDT 2001 + * Fixed a bug with deeply nested callers. + * Fixed nested uplevel() calls. + - Forgot to include Test::More dependency + - Added 5.006 dependency to Makefile.PL + - Removed unnecessary die and warn overrides + - Added DIRE WARNING to the docs. + +0.05 Wed Sep 19 06:00:12 EDT 2001 + * Things were still pretty broken. I *think* I have the tests + sorted out now. + * Blows over any CORE::GLOBAL::caller, die or warn you might have + set. I'll fix this soon. + +0.04 Wed Sep 19 04:28:19 EDT 2001 + * Ooops, we'd broken caller(). Turns out the tests were wrong. + +0.03 Wed Sep 19 03:41:59 EDT 2001 + * Greatly simplified the uplevel logic + +0.02 Wed Sep 19 03:03:10 EDT 2001 + * Fools croak() + +0.01 Wed Sep 19 00:19:38 EDT 2001 + * First working version + * Fools caller(), die() and warn(). + - Needs more work against, say, Carp. + - Needs more work to check that it doesn't break the + subtleties of caller, die and warn. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bcaa4d0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2017 by Michael Schwern and David Golden. + +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) 2017 by Michael Schwern and David Golden. + +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) 2017 by Michael Schwern and David Golden. + +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..8796f79 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,37 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.009. +CONTRIBUTING.mkdn +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +README +cpanfile +dist.ini +examples/uplevel-demo.pl +lib/Sub/Uplevel.pm +perlcritic.rc +t/00-report-prereqs.dd +t/00-report-prereqs.t +t/01_die_check.t +t/02_uplevel.t +t/03_nested_uplevels.t +t/04_honor_later_override.t +t/05_honor_prior_override.t +t/06_db_args.t +t/07_uplevel_too_high.t +t/08_exporter.t +t/09_emptylist.t +t/lib/Bar.pm +t/lib/Foo.pm +t/lib/MyImporter.pm +xt/author/00-compile.t +xt/author/critic.t +xt/author/pod-coverage.t +xt/author/pod-spell.t +xt/author/pod-syntax.t +xt/author/portability.t +xt/author/test-version.t +xt/release/distmeta.t +xt/release/minimum-version.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..925f28e --- /dev/null +++ b/META.json @@ -0,0 +1,112 @@ +{ + "abstract" : "apparently run a function in a higher stack frame", + "author" : [ + "Michael Schwern ", + "David Golden " + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 6.009, CPAN::Meta::Converter version 2.150010", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : 2 + }, + "name" : "Sub-Uplevel", + "no_index" : { + "directory" : [ + "corpus", + "examples", + "t", + "xt" + ], + "package" : [ + "DB" + ] + }, + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "6.17", + "perl" : "5.006" + } + }, + "develop" : { + "requires" : { + "Dist::Zilla" : "5", + "Dist::Zilla::Plugin::ReleaseStatus::FromVersion" : "0", + "Dist::Zilla::PluginBundle::DAGOLDEN" : "0.073", + "English" : "0", + "File::Spec" : "0", + "File::Temp" : "0", + "IO::Handle" : "0", + "IPC::Open3" : "0", + "Pod::Coverage::TrustPod" : "0", + "Pod::Wordlist" : "0", + "Software::License::Perl_5" : "0", + "Test::CPAN::Meta" : "0", + "Test::MinimumVersion" : "0", + "Test::More" : "0", + "Test::Pod" : "1.41", + "Test::Pod::Coverage" : "1.08", + "Test::Portability::Files" : "0", + "Test::Spelling" : "0.12", + "Test::Version" : "1", + "blib" : "1.01" + } + }, + "runtime" : { + "requires" : { + "Carp" : "0", + "constant" : "0", + "perl" : "5.006", + "strict" : "0", + "warnings" : "0" + } + }, + "test" : { + "recommends" : { + "CPAN::Meta" : "2.120900" + }, + "requires" : { + "Exporter" : "0", + "ExtUtils::MakeMaker" : "0", + "File::Spec" : "0", + "Test::More" : "0", + "lib" : "0", + "perl" : "5.006" + } + } + }, + "provides" : { + "Sub::Uplevel" : { + "file" : "lib/Sub/Uplevel.pm", + "version" : "0.2800" + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/Perl-Toolchain-Gang/Sub-Uplevel/issues" + }, + "homepage" : "https://github.com/Perl-Toolchain-Gang/Sub-Uplevel", + "repository" : { + "type" : "git", + "url" : "https://github.com/Perl-Toolchain-Gang/Sub-Uplevel.git", + "web" : "https://github.com/Perl-Toolchain-Gang/Sub-Uplevel" + } + }, + "version" : "0.2800", + "x_authority" : "cpan:DAGOLDEN", + "x_contributors" : [ + "Adam Kennedy ", + "Alexandr Ciornii ", + "David Golden ", + "Graham Ollis ", + "J. Nick Koston ", + "Michael Gray " + ], + "x_serialization_backend" : "Cpanel::JSON::XS version 3.0225" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..2e6f62c --- /dev/null +++ b/META.yml @@ -0,0 +1,54 @@ +--- +abstract: 'apparently run a function in a higher stack frame' +author: + - 'Michael Schwern ' + - 'David Golden ' +build_requires: + Exporter: '0' + ExtUtils::MakeMaker: '0' + File::Spec: '0' + Test::More: '0' + lib: '0' + perl: '5.006' +configure_requires: + ExtUtils::MakeMaker: '6.17' + perl: '5.006' +dynamic_config: 0 +generated_by: 'Dist::Zilla version 6.009, CPAN::Meta::Converter version 2.150010' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: Sub-Uplevel +no_index: + directory: + - corpus + - examples + - t + - xt + package: + - DB +provides: + Sub::Uplevel: + file: lib/Sub/Uplevel.pm + version: '0.2800' +requires: + Carp: '0' + constant: '0' + perl: '5.006' + strict: '0' + warnings: '0' +resources: + bugtracker: https://github.com/Perl-Toolchain-Gang/Sub-Uplevel/issues + homepage: https://github.com/Perl-Toolchain-Gang/Sub-Uplevel + repository: https://github.com/Perl-Toolchain-Gang/Sub-Uplevel.git +version: '0.2800' +x_authority: cpan:DAGOLDEN +x_contributors: + - 'Adam Kennedy ' + - 'Alexandr Ciornii ' + - 'David Golden ' + - 'Graham Ollis ' + - 'J. Nick Koston ' + - 'Michael Gray ' +x_serialization_backend: 'YAML::Tiny version 1.69' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..9627062 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,61 @@ +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.009. +use strict; +use warnings; + +use 5.006; + +use ExtUtils::MakeMaker 6.17; + +my %WriteMakefileArgs = ( + "ABSTRACT" => "apparently run a function in a higher stack frame", + "AUTHOR" => "Michael Schwern , David Golden ", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => "6.17" + }, + "DISTNAME" => "Sub-Uplevel", + "LICENSE" => "perl", + "MIN_PERL_VERSION" => "5.006", + "NAME" => "Sub::Uplevel", + "PREREQ_PM" => { + "Carp" => 0, + "constant" => 0, + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "Exporter" => 0, + "ExtUtils::MakeMaker" => 0, + "File::Spec" => 0, + "Test::More" => 0, + "lib" => 0 + }, + "VERSION" => "0.2800", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "Carp" => 0, + "Exporter" => 0, + "ExtUtils::MakeMaker" => 0, + "File::Spec" => 0, + "Test::More" => 0, + "constant" => 0, + "lib" => 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..0adb4f9 --- /dev/null +++ b/README @@ -0,0 +1,170 @@ +NAME + Sub::Uplevel - apparently run a function in a higher stack frame + +VERSION + version 0.2800 + +SYNOPSIS + use Sub::Uplevel; + + sub foo { + print join " - ", caller; + } + + sub bar { + uplevel 1, \&foo; + } + + #line 11 + bar(); # main - foo.plx - 11 + +DESCRIPTION + Like Tcl's uplevel() function, but not quite so dangerous. The idea is + just to fool caller(). All the really naughty bits of Tcl's uplevel() + are avoided. + + THIS IS NOT THE SORT OF THING YOU WANT TO DO EVERYDAY + + uplevel + uplevel $num_frames, \&func, @args; + + Makes the given function think it's being executed $num_frames + higher than the current stack level. So when they use + caller($frames) it will actually give caller($frames + $num_frames) + for them. + + "uplevel(1, \&some_func, @_)" is effectively "goto &some_func" but + you don't immediately exit the current subroutine. So while you + can't do this: + + sub wrapper { + print "Before\n"; + goto &some_func; + print "After\n"; + } + + you can do this: + + sub wrapper { + print "Before\n"; + my @out = uplevel 1, &some_func; + print "After\n"; + return @out; + } + + "uplevel" has the ability to issue a warning if $num_frames is more + than the current call stack depth, although this warning is disabled + and compiled out by default as the check is relatively expensive. + + To enable the check for debugging or testing, you should set the + global $Sub::Uplevel::CHECK_FRAMES to true before loading + Sub::Uplevel for the first time as follows: + + #!/usr/bin/perl + + BEGIN { + $Sub::Uplevel::CHECK_FRAMES = 1; + } + use Sub::Uplevel; + + Setting or changing the global after the module has been loaded will + have no effect. + +EXAMPLE + The main reason I wrote this module is so I could write wrappers around + functions and they wouldn't be aware they've been wrapped. + + use Sub::Uplevel; + + my $original_foo = \&foo; + + *foo = sub { + my @output = uplevel 1, $original_foo; + print "foo() returned: @output"; + return @output; + }; + + If this code frightens you you should not use this module. + +BUGS and CAVEATS + Well, the bad news is uplevel() is about 5 times slower than a normal + function call. XS implementation anyone? It also slows down every + invocation of caller(), regardless of whether uplevel() is in effect. + + Sub::Uplevel overrides CORE::GLOBAL::caller temporarily for the scope of + each uplevel call. It does its best to work with any previously existing + CORE::GLOBAL::caller (both when Sub::Uplevel is first loaded and within + each uplevel call) such as from Contextual::Return or Hook::LexWrap. + + However, if you are routinely using multiple modules that override + CORE::GLOBAL::caller, you are probably asking for trouble. + + You should load Sub::Uplevel as early as possible within your program. + As with all CORE::GLOBAL overloading, the overload will not affect + modules that have already been compiled prior to the overload. One + module that often is unavoidably loaded prior to Sub::Uplevel is + Exporter. To forcibly recompile Exporter (and Exporter::Heavy) after + loading Sub::Uplevel, use it with the ":aggressive" tag: + + use Sub::Uplevel qw/:aggressive/; + + The private function "Sub::Uplevel::_force_reload()" may be passed a + list of additional modules to reload if ":aggressive" is not aggressive + enough. Reloading modules may break things, so only use this as a last + resort. + + As of version 0.20, Sub::Uplevel requires Perl 5.6 or greater. + +HISTORY + Those who do not learn from HISTORY are doomed to repeat it. + + The lesson here is simple: Don't sit next to a Tcl programmer at the + dinner table. + +THANKS + Thanks to Brent Welch, Damian Conway and Robin Houston. + + See http://www.perl.com/perl/misc/Artistic.html + +SEE ALSO + PadWalker (for the similar idea with lexicals), Hook::LexWrap, Tcl's + uplevel() at http://www.scriptics.com/man/tcl8.4/TclCmd/uplevel.htm + +SUPPORT + Bugs / Feature Requests + Please report any bugs or feature requests through the issue tracker at + . You will be + notified automatically of any progress on your issue. + + Source Code + This is open source software. The code repository is available for + public review and contribution under the terms of the license. + + + + git clone https://github.com/Perl-Toolchain-Gang/Sub-Uplevel.git + +AUTHORS + * Michael Schwern + + * David Golden + +CONTRIBUTORS + * Adam Kennedy + + * Alexandr Ciornii + + * David Golden + + * Graham Ollis + + * J. Nick Koston + + * Michael Gray + +COPYRIGHT AND LICENSE + This software is copyright (c) 2017 by Michael Schwern and David Golden. + + This is free software; you can redistribute it and/or modify it under + the same terms as the Perl 5 programming language system itself. + diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..78e128f --- /dev/null +++ b/cpanfile @@ -0,0 +1,46 @@ +requires "Carp" => "0"; +requires "constant" => "0"; +requires "perl" => "5.006"; +requires "strict" => "0"; +requires "warnings" => "0"; + +on 'test' => sub { + requires "Exporter" => "0"; + requires "ExtUtils::MakeMaker" => "0"; + requires "File::Spec" => "0"; + requires "Test::More" => "0"; + requires "lib" => "0"; + requires "perl" => "5.006"; +}; + +on 'test' => sub { + recommends "CPAN::Meta" => "2.120900"; +}; + +on 'configure' => sub { + requires "ExtUtils::MakeMaker" => "6.17"; + requires "perl" => "5.006"; +}; + +on 'develop' => sub { + requires "Dist::Zilla" => "5"; + requires "Dist::Zilla::Plugin::ReleaseStatus::FromVersion" => "0"; + requires "Dist::Zilla::PluginBundle::DAGOLDEN" => "0.073"; + requires "English" => "0"; + requires "File::Spec" => "0"; + requires "File::Temp" => "0"; + requires "IO::Handle" => "0"; + requires "IPC::Open3" => "0"; + requires "Pod::Coverage::TrustPod" => "0"; + requires "Pod::Wordlist" => "0"; + requires "Software::License::Perl_5" => "0"; + requires "Test::CPAN::Meta" => "0"; + requires "Test::MinimumVersion" => "0"; + requires "Test::More" => "0"; + requires "Test::Pod" => "1.41"; + requires "Test::Pod::Coverage" => "1.08"; + requires "Test::Portability::Files" => "0"; + requires "Test::Spelling" => "0.12"; + requires "Test::Version" => "1"; + requires "blib" => "1.01"; +}; diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..25d130a --- /dev/null +++ b/dist.ini @@ -0,0 +1,15 @@ +name = Sub-Uplevel +author = Michael Schwern +author = David Golden +license = Perl_5 +copyright_holder = Michael Schwern and David Golden + +[@DAGOLDEN] +:version = 0.073 +stopwords = PadWalker +stopwords = Tcl's +stopwords = Welch +stopwords = uplevel + +[ReleaseStatus::FromVersion] +testing = second_decimal_odd diff --git a/examples/uplevel-demo.pl b/examples/uplevel-demo.pl new file mode 100644 index 0000000..ce3239c --- /dev/null +++ b/examples/uplevel-demo.pl @@ -0,0 +1,23 @@ +use strict; +use warnings; + +use Sub::Uplevel; + +# subroutine A calls subroutine B with uplevel(), so when +# subroutine B queries caller(), it gets main as the caller (just +# like subroutine A) instead of getting subroutine A + +sub sub_a { + print "Entering Subroutine A\n"; + print "caller() says: ", join( ", ", (caller())[0 .. 2] ), "\n"; + print "Calling B with uplevel\n"; + uplevel 1, \&sub_b; +} + +sub sub_b { + print "Entering Subroutine B\n"; + print "caller() says: ", join( ", ", (caller())[0 .. 2] ), "\n"; +} + +sub_a(); + diff --git a/lib/Sub/Uplevel.pm b/lib/Sub/Uplevel.pm new file mode 100644 index 0000000..51ad32f --- /dev/null +++ b/lib/Sub/Uplevel.pm @@ -0,0 +1,610 @@ +package Sub::Uplevel; +use 5.006; +use strict; +# ABSTRACT: apparently run a function in a higher stack frame + +our $VERSION = '0.2800'; + +# Frame check global constant +our $CHECK_FRAMES; +BEGIN { + $CHECK_FRAMES = !! $CHECK_FRAMES; +} +use constant CHECK_FRAMES => $CHECK_FRAMES; + +# We must override *CORE::GLOBAL::caller if it hasn't already been +# overridden or else Perl won't see our local override later. + +if ( not defined *CORE::GLOBAL::caller{CODE} ) { + *CORE::GLOBAL::caller = \&_normal_caller; +} + +# modules to force reload if ":aggressive" is specified +my @reload_list = qw/Exporter Exporter::Heavy/; + +sub import { + no strict 'refs'; ## no critic + my ($class, @args) = @_; + for my $tag ( @args, 'uplevel' ) { + if ( $tag eq 'uplevel' ) { + my $caller = caller(0); + *{"$caller\::uplevel"} = \&uplevel; + } + elsif( $tag eq ':aggressive' ) { + _force_reload( @reload_list ); + } + else { + die qq{"$tag" is not exported by the $class module\n} + } + } + return; +} + +sub _force_reload { + no warnings 'redefine'; + local $^W = 0; + for my $m ( @_ ) { + $m =~ s{::}{/}g; + $m .= ".pm"; + require $m if delete $INC{$m}; + } +} + +#pod =head1 SYNOPSIS +#pod +#pod use Sub::Uplevel; +#pod +#pod sub foo { +#pod print join " - ", caller; +#pod } +#pod +#pod sub bar { +#pod uplevel 1, \&foo; +#pod } +#pod +#pod #line 11 +#pod bar(); # main - foo.plx - 11 +#pod +#pod =head1 DESCRIPTION +#pod +#pod Like Tcl's uplevel() function, but not quite so dangerous. The idea +#pod is just to fool caller(). All the really naughty bits of Tcl's +#pod uplevel() are avoided. +#pod +#pod B +#pod +#pod =over 4 +#pod +#pod =item B +#pod +#pod uplevel $num_frames, \&func, @args; +#pod +#pod Makes the given function think it's being executed $num_frames higher +#pod than the current stack level. So when they use caller($frames) it +#pod will actually give caller($frames + $num_frames) for them. +#pod +#pod C is effectively C but +#pod you don't immediately exit the current subroutine. So while you can't +#pod do this: +#pod +#pod sub wrapper { +#pod print "Before\n"; +#pod goto &some_func; +#pod print "After\n"; +#pod } +#pod +#pod you can do this: +#pod +#pod sub wrapper { +#pod print "Before\n"; +#pod my @out = uplevel 1, &some_func; +#pod print "After\n"; +#pod return @out; +#pod } +#pod +#pod C has the ability to issue a warning if C<$num_frames> is more than +#pod the current call stack depth, although this warning is disabled and compiled +#pod out by default as the check is relatively expensive. +#pod +#pod To enable the check for debugging or testing, you should set the global +#pod C<$Sub::Uplevel::CHECK_FRAMES> to true before loading Sub::Uplevel for the +#pod first time as follows: +#pod +#pod #!/usr/bin/perl +#pod +#pod BEGIN { +#pod $Sub::Uplevel::CHECK_FRAMES = 1; +#pod } +#pod use Sub::Uplevel; +#pod +#pod Setting or changing the global after the module has been loaded will have +#pod no effect. +#pod +#pod =cut + +# @Up_Frames -- uplevel stack +# $Caller_Proxy -- whatever caller() override was in effect before uplevel +our (@Up_Frames, $Caller_Proxy); + +sub _apparent_stack_height { + my $height = 1; # start above this function + while ( 1 ) { + last if ! defined scalar $Caller_Proxy->($height); + $height++; + } + return $height - 1; # subtract 1 for this function +} + +sub uplevel { + # Backwards compatible version of "no warnings 'redefine'" + my $old_W = $^W; + $^W = 0; + + # Update the caller proxy if the uplevel override isn't in effect + local $Caller_Proxy = *CORE::GLOBAL::caller{CODE} + if *CORE::GLOBAL::caller{CODE} != \&_uplevel_caller; + local *CORE::GLOBAL::caller = \&_uplevel_caller; + + # Restore old warnings state + $^W = $old_W; + + if ( CHECK_FRAMES and $_[0] >= _apparent_stack_height() ) { + require Carp; + Carp::carp("uplevel $_[0] is more than the caller stack"); + } + + local @Up_Frames = (shift, @Up_Frames ); + + my $function = shift; + return $function->(@_); +} + +sub _normal_caller (;$) { ## no critic Prototypes + my ($height) = @_; + $height++; + my @caller = CORE::caller($height); + if ( CORE::caller() eq 'DB' ) { + # Oops, redo picking up @DB::args + package DB; + @caller = CORE::caller($height); + } + + return if ! @caller; # empty + return $caller[0] if ! wantarray; # scalar context + return @_ ? @caller : @caller[0..2]; # extra info or regular +} + +sub _uplevel_caller (;$) { ## no critic Prototypes + my $height = $_[0] || 0; + + # shortcut if no uplevels have been called + # always add +1 to CORE::caller (proxy caller function) + # to skip this function's caller + return $Caller_Proxy->( $height + 1 ) if ! @Up_Frames; + +#pod =begin _private +#pod +#pod So it has to work like this: +#pod +#pod Call stack Actual uplevel 1 +#pod CORE::GLOBAL::caller +#pod Carp::short_error_loc 0 +#pod Carp::shortmess_heavy 1 0 +#pod Carp::croak 2 1 +#pod try_croak 3 2 +#pod uplevel 4 +#pod function_that_called_uplevel 5 +#pod caller_we_want_to_see 6 3 +#pod its_caller 7 4 +#pod +#pod So when caller(X) winds up below uplevel(), it only has to use +#pod CORE::caller(X+1) (to skip CORE::GLOBAL::caller). But when caller(X) +#pod winds up no or above uplevel(), it's CORE::caller(X+1+uplevel+1). +#pod +#pod Which means I'm probably going to have to do something nasty like walk +#pod up the call stack on each caller() to see if I'm going to wind up +#pod before or after Sub::Uplevel::uplevel(). +#pod +#pod =end _private +#pod +#pod =begin _dagolden +#pod +#pod I found the description above a bit confusing. Instead, this is the logic +#pod that I found clearer when CORE::GLOBAL::caller is invoked and we have to +#pod walk up the call stack: +#pod +#pod * if searching up to the requested height in the real call stack doesn't find +#pod a call to uplevel, then we can return the result at that height in the +#pod call stack +#pod +#pod * if we find a call to uplevel, we need to keep searching upwards beyond the +#pod requested height at least by the amount of upleveling requested for that +#pod call to uplevel (from the Up_Frames stack set during the uplevel call) +#pod +#pod * additionally, we need to hide the uplevel subroutine call, too, so we search +#pod upwards one more level for each call to uplevel +#pod +#pod * when we've reached the top of the search, we want to return that frame +#pod in the call stack, i.e. the requested height plus any uplevel adjustments +#pod found during the search +#pod +#pod =end _dagolden +#pod +#pod =cut + + my $saw_uplevel = 0; + my $adjust = 0; + + # walk up the call stack to fight the right package level to return; + # look one higher than requested for each call to uplevel found + # and adjust by the amount found in the Up_Frames stack for that call. + # We *must* use CORE::caller here since we need the real stack not what + # some other override says the stack looks like, just in case that other + # override breaks things in some horrible way + my $test_caller; + for ( my $up = 0; $up <= $height + $adjust; $up++ ) { + $test_caller = scalar CORE::caller($up + 1); + if( $test_caller && $test_caller eq __PACKAGE__ ) { + # add one for each uplevel call seen + # and look into the uplevel stack for the offset + $adjust += 1 + $Up_Frames[$saw_uplevel]; + $saw_uplevel++; + } + } + + # For returning values, we pass through the call to the proxy caller + # function, just at a higher stack level + my @caller = $Caller_Proxy->($height + $adjust + 1); + if ( CORE::caller() eq 'DB' ) { + # Oops, redo picking up @DB::args + package DB; + @caller = $Sub::Uplevel::Caller_Proxy->($height + $adjust + 1); + } + + return if ! @caller; # empty + return $caller[0] if ! wantarray; # scalar context + return @_ ? @caller : @caller[0..2]; # extra info or regular +} + +#pod =back +#pod +#pod =head1 EXAMPLE +#pod +#pod The main reason I wrote this module is so I could write wrappers +#pod around functions and they wouldn't be aware they've been wrapped. +#pod +#pod use Sub::Uplevel; +#pod +#pod my $original_foo = \&foo; +#pod +#pod *foo = sub { +#pod my @output = uplevel 1, $original_foo; +#pod print "foo() returned: @output"; +#pod return @output; +#pod }; +#pod +#pod If this code frightens you B +#pod +#pod +#pod =head1 BUGS and CAVEATS +#pod +#pod Well, the bad news is uplevel() is about 5 times slower than a normal +#pod function call. XS implementation anyone? It also slows down every invocation +#pod of caller(), regardless of whether uplevel() is in effect. +#pod +#pod Sub::Uplevel overrides CORE::GLOBAL::caller temporarily for the scope of +#pod each uplevel call. It does its best to work with any previously existing +#pod CORE::GLOBAL::caller (both when Sub::Uplevel is first loaded and within +#pod each uplevel call) such as from Contextual::Return or Hook::LexWrap. +#pod +#pod However, if you are routinely using multiple modules that override +#pod CORE::GLOBAL::caller, you are probably asking for trouble. +#pod +#pod You B load Sub::Uplevel as early as possible within your program. As +#pod with all CORE::GLOBAL overloading, the overload will not affect modules that +#pod have already been compiled prior to the overload. One module that often is +#pod unavoidably loaded prior to Sub::Uplevel is Exporter. To forcibly recompile +#pod Exporter (and Exporter::Heavy) after loading Sub::Uplevel, use it with the +#pod ":aggressive" tag: +#pod +#pod use Sub::Uplevel qw/:aggressive/; +#pod +#pod The private function C may be passed a list of +#pod additional modules to reload if ":aggressive" is not aggressive enough. +#pod Reloading modules may break things, so only use this as a last resort. +#pod +#pod As of version 0.20, Sub::Uplevel requires Perl 5.6 or greater. +#pod +#pod =head1 HISTORY +#pod +#pod Those who do not learn from HISTORY are doomed to repeat it. +#pod +#pod The lesson here is simple: Don't sit next to a Tcl programmer at the +#pod dinner table. +#pod +#pod =head1 THANKS +#pod +#pod Thanks to Brent Welch, Damian Conway and Robin Houston. +#pod +#pod See http://www.perl.com/perl/misc/Artistic.html +#pod +#pod =head1 SEE ALSO +#pod +#pod PadWalker (for the similar idea with lexicals), Hook::LexWrap, +#pod Tcl's uplevel() at http://www.scriptics.com/man/tcl8.4/TclCmd/uplevel.htm +#pod +#pod =cut + +1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +Sub::Uplevel - apparently run a function in a higher stack frame + +=head1 VERSION + +version 0.2800 + +=head1 SYNOPSIS + + use Sub::Uplevel; + + sub foo { + print join " - ", caller; + } + + sub bar { + uplevel 1, \&foo; + } + + #line 11 + bar(); # main - foo.plx - 11 + +=head1 DESCRIPTION + +Like Tcl's uplevel() function, but not quite so dangerous. The idea +is just to fool caller(). All the really naughty bits of Tcl's +uplevel() are avoided. + +B + +=over 4 + +=item B + + uplevel $num_frames, \&func, @args; + +Makes the given function think it's being executed $num_frames higher +than the current stack level. So when they use caller($frames) it +will actually give caller($frames + $num_frames) for them. + +C is effectively C but +you don't immediately exit the current subroutine. So while you can't +do this: + + sub wrapper { + print "Before\n"; + goto &some_func; + print "After\n"; + } + +you can do this: + + sub wrapper { + print "Before\n"; + my @out = uplevel 1, &some_func; + print "After\n"; + return @out; + } + +C has the ability to issue a warning if C<$num_frames> is more than +the current call stack depth, although this warning is disabled and compiled +out by default as the check is relatively expensive. + +To enable the check for debugging or testing, you should set the global +C<$Sub::Uplevel::CHECK_FRAMES> to true before loading Sub::Uplevel for the +first time as follows: + + #!/usr/bin/perl + + BEGIN { + $Sub::Uplevel::CHECK_FRAMES = 1; + } + use Sub::Uplevel; + +Setting or changing the global after the module has been loaded will have +no effect. + +=begin _private + +So it has to work like this: + + Call stack Actual uplevel 1 +CORE::GLOBAL::caller +Carp::short_error_loc 0 +Carp::shortmess_heavy 1 0 +Carp::croak 2 1 +try_croak 3 2 +uplevel 4 +function_that_called_uplevel 5 +caller_we_want_to_see 6 3 +its_caller 7 4 + +So when caller(X) winds up below uplevel(), it only has to use +CORE::caller(X+1) (to skip CORE::GLOBAL::caller). But when caller(X) +winds up no or above uplevel(), it's CORE::caller(X+1+uplevel+1). + +Which means I'm probably going to have to do something nasty like walk +up the call stack on each caller() to see if I'm going to wind up +before or after Sub::Uplevel::uplevel(). + +=end _private + +=begin _dagolden + +I found the description above a bit confusing. Instead, this is the logic +that I found clearer when CORE::GLOBAL::caller is invoked and we have to +walk up the call stack: + +* if searching up to the requested height in the real call stack doesn't find +a call to uplevel, then we can return the result at that height in the +call stack + +* if we find a call to uplevel, we need to keep searching upwards beyond the +requested height at least by the amount of upleveling requested for that +call to uplevel (from the Up_Frames stack set during the uplevel call) + +* additionally, we need to hide the uplevel subroutine call, too, so we search +upwards one more level for each call to uplevel + +* when we've reached the top of the search, we want to return that frame +in the call stack, i.e. the requested height plus any uplevel adjustments +found during the search + +=end _dagolden + +=back + +=head1 EXAMPLE + +The main reason I wrote this module is so I could write wrappers +around functions and they wouldn't be aware they've been wrapped. + + use Sub::Uplevel; + + my $original_foo = \&foo; + + *foo = sub { + my @output = uplevel 1, $original_foo; + print "foo() returned: @output"; + return @output; + }; + +If this code frightens you B + +=head1 BUGS and CAVEATS + +Well, the bad news is uplevel() is about 5 times slower than a normal +function call. XS implementation anyone? It also slows down every invocation +of caller(), regardless of whether uplevel() is in effect. + +Sub::Uplevel overrides CORE::GLOBAL::caller temporarily for the scope of +each uplevel call. It does its best to work with any previously existing +CORE::GLOBAL::caller (both when Sub::Uplevel is first loaded and within +each uplevel call) such as from Contextual::Return or Hook::LexWrap. + +However, if you are routinely using multiple modules that override +CORE::GLOBAL::caller, you are probably asking for trouble. + +You B load Sub::Uplevel as early as possible within your program. As +with all CORE::GLOBAL overloading, the overload will not affect modules that +have already been compiled prior to the overload. One module that often is +unavoidably loaded prior to Sub::Uplevel is Exporter. To forcibly recompile +Exporter (and Exporter::Heavy) after loading Sub::Uplevel, use it with the +":aggressive" tag: + + use Sub::Uplevel qw/:aggressive/; + +The private function C may be passed a list of +additional modules to reload if ":aggressive" is not aggressive enough. +Reloading modules may break things, so only use this as a last resort. + +As of version 0.20, Sub::Uplevel requires Perl 5.6 or greater. + +=head1 HISTORY + +Those who do not learn from HISTORY are doomed to repeat it. + +The lesson here is simple: Don't sit next to a Tcl programmer at the +dinner table. + +=head1 THANKS + +Thanks to Brent Welch, Damian Conway and Robin Houston. + +See http://www.perl.com/perl/misc/Artistic.html + +=head1 SEE ALSO + +PadWalker (for the similar idea with lexicals), Hook::LexWrap, +Tcl's uplevel() at http://www.scriptics.com/man/tcl8.4/TclCmd/uplevel.htm + +=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan + +=head1 SUPPORT + +=head2 Bugs / Feature Requests + +Please report any bugs or feature requests through the issue tracker +at L. +You will be notified automatically of any progress on your issue. + +=head2 Source Code + +This is open source software. The code repository is available for +public review and contribution under the terms of the license. + +L + + git clone https://github.com/Perl-Toolchain-Gang/Sub-Uplevel.git + +=head1 AUTHORS + +=over 4 + +=item * + +Michael Schwern + +=item * + +David Golden + +=back + +=head1 CONTRIBUTORS + +=for stopwords Adam Kennedy Alexandr Ciornii David Golden Graham Ollis J. Nick Koston Michael Gray + +=over 4 + +=item * + +Adam Kennedy + +=item * + +Alexandr Ciornii + +=item * + +David Golden + +=item * + +Graham Ollis + +=item * + +J. Nick Koston + +=item * + +Michael Gray + +=back + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2017 by Michael Schwern and David Golden. + +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/perlcritic.rc b/perlcritic.rc new file mode 100644 index 0000000..bcbbb45 --- /dev/null +++ b/perlcritic.rc @@ -0,0 +1,26 @@ +severity = 5 +verbose = 8 + +[Variables::ProhibitPunctuationVars] +allow = $@ $! + +[TestingAndDebugging::ProhibitNoStrict] +allow = refs + +[Variables::ProhibitEvilVariables] +variables = $DB::single + +# Turn these off +[-BuiltinFunctions::ProhibitStringyEval] +[-ControlStructures::ProhibitPostfixControls] +[-ControlStructures::ProhibitUnlessBlocks] +[-Documentation::RequirePodSections] +[-InputOutput::ProhibitInteractiveTest] +[-References::ProhibitDoubleSigils] +[-RegularExpressions::RequireExtendedFormatting] +[-InputOutput::ProhibitTwoArgOpen] +[-Modules::ProhibitEvilModules] + +# Turn this on +[Lax::ProhibitStringyEval::ExceptForRequire] + diff --git a/t/00-report-prereqs.dd b/t/00-report-prereqs.dd new file mode 100644 index 0000000..041801c --- /dev/null +++ b/t/00-report-prereqs.dd @@ -0,0 +1,56 @@ +do { my $x = { + 'configure' => { + 'requires' => { + 'ExtUtils::MakeMaker' => '6.17', + 'perl' => '5.006' + } + }, + 'develop' => { + 'requires' => { + 'Dist::Zilla' => '5', + 'Dist::Zilla::Plugin::ReleaseStatus::FromVersion' => '0', + 'Dist::Zilla::PluginBundle::DAGOLDEN' => '0.073', + 'English' => '0', + 'File::Spec' => '0', + 'File::Temp' => '0', + 'IO::Handle' => '0', + 'IPC::Open3' => '0', + 'Pod::Coverage::TrustPod' => '0', + 'Pod::Wordlist' => '0', + 'Software::License::Perl_5' => '0', + 'Test::CPAN::Meta' => '0', + 'Test::MinimumVersion' => '0', + 'Test::More' => '0', + 'Test::Pod' => '1.41', + 'Test::Pod::Coverage' => '1.08', + 'Test::Portability::Files' => '0', + 'Test::Spelling' => '0.12', + 'Test::Version' => '1', + 'blib' => '1.01' + } + }, + 'runtime' => { + 'requires' => { + 'Carp' => '0', + 'constant' => '0', + 'perl' => '5.006', + 'strict' => '0', + 'warnings' => '0' + } + }, + 'test' => { + 'recommends' => { + 'CPAN::Meta' => '2.120900' + }, + 'requires' => { + 'Exporter' => '0', + 'ExtUtils::MakeMaker' => '0', + 'File::Spec' => '0', + 'Test::More' => '0', + 'lib' => '0', + 'perl' => '5.006' + } + } + }; + $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..e338372 --- /dev/null +++ b/t/00-report-prereqs.t @@ -0,0 +1,183 @@ +#!perl + +use strict; +use warnings; + +# This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.025 + +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 + && (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 ); + + if ($type eq 'modules') { + splice @reports, 1, 0, ["-" x $ml, "", "-" x $hl]; + push @full_reports, map { sprintf(" %*s %*s\n", -$ml, $_->[0], $hl, $_->[2]) } @reports; + } + else { + 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/01_die_check.t b/t/01_die_check.t new file mode 100644 index 0000000..fab017e --- /dev/null +++ b/t/01_die_check.t @@ -0,0 +1,18 @@ +#!/usr/bin/perl + +# Kirk: How we deal with death is at least as important as how we deal +# with life, wouldn't you say? +# Saavik: As I indicated, Admiral, that thought had not occurred to me. +# Kirk: Well, now you have something new to think about. Carry on. + +# XXX DG: Why is this test here? Seems pointless. Oh, well. + +use strict; +BEGIN { $^W = 1 } + +use Test::More tests => 1; + +#line 12 +eval { die }; +is( $@, "Died at $0 line 12.\n" ); + diff --git a/t/02_uplevel.t b/t/02_uplevel.t new file mode 100644 index 0000000..5d7e454 --- /dev/null +++ b/t/02_uplevel.t @@ -0,0 +1,211 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More tests => 23; + +BEGIN { use_ok('Sub::Uplevel'); } +can_ok('Sub::Uplevel', 'uplevel'); +can_ok(__PACKAGE__, 'uplevel'); + +#line 11 +ok( !caller, "top-level caller() not screwed up" ); + +eval { die }; +is( $@, "Died at $0 line 13.\n", 'die() not screwed up' ); + +sub foo { + join " - ", caller; +} + +sub bar { + uplevel(1, \&foo); +} + +#line 25 +is( bar(), "main - $0 - 25", 'uplevel()' ); + + +# Sure, but does it fool die? +sub try_die { + die "You must die! I alone am best!"; +} + +sub wrap_die { + uplevel(1, \&try_die); +} + +# line 38 +eval { wrap_die() }; +is( $@, "You must die! I alone am best! at $0 line 30.\n", 'die() fooled' ); + + +# how about warn? +sub try_warn { + warn "HA! You don't fool me!"; +} + +sub wrap_warn { + uplevel(1, \&try_warn); +} + + +my $warning; +{ + local $SIG{__WARN__} = sub { $warning = join '', @_ }; +#line 56 + wrap_warn(); +} +is( $warning, "HA! You don't fool me! at $0 line 44.\n", 'warn() fooled' ); + + +# Carp? +use Carp; +sub try_croak { +# line 64 + croak("Now we can fool croak!"); +} + +sub wrap_croak { +# line 68 + uplevel(shift, \&try_croak); +} + + +# depending on perl version, we could get 'require 0' or 'eval {...}' +# in the stack. This test used to be 'require 0' for <= 5.006, but +# it broke on 5.005_05 test release, so we'll just take either +# line 72 +eval { wrap_croak(1) }; +my $croak_regex = quotemeta( <<"CARP" ); +Now we can fool croak! at $0 line 64 + main::wrap_croak(1) called at $0 line 72 +CARP +$croak_regex =~ s/64/64\.?/; # Perl 5.15 series Carp adds period +$croak_regex .= '\t(require 0|eval \{\.\.\.\})' + . quotemeta( " called at $0 line 72" ); +like( $@, "/$croak_regex/", 'croak() fooled'); + +# Try to wrap higher -- this may have been a problem that was exposed on +# Test Exception +# line 75 +eval { wrap_croak(2) }; +$croak_regex = quotemeta( <<"CARP" ); +Now we can fool croak! at $0 line 64 +CARP +$croak_regex =~ s/64/64\.?/; # Perl 5.15 series Carp adds period +like( $@, "/$croak_regex/", 'croak() fooled'); + +#line 79 +ok( !caller, "caller() not screwed up" ); + +eval { die "Dying" }; +is( $@, "Dying at $0 line 81.\n", 'die() not screwed up' ); + + + +# how about carp? +sub try_carp { +# line 88 + carp "HA! Even carp is fooled!"; +} + +sub wrap_carp { + uplevel(1, \&try_carp); +} + + +$warning = ''; +{ + local $SIG{__WARN__} = sub { $warning = join '', @_ }; +#line 98 + wrap_carp(); +} +my $carp_regex = quotemeta( <<"CARP" ); +HA! Even carp is fooled! at $0 line 88 + main::wrap_carp() called at $0 line 98 +CARP +$carp_regex =~ s/88/88\.?/; # Perl 5.15 series Carp adds period +like( $warning, "/$carp_regex/", 'carp() fooled' ); + + +use lib 't/lib'; +use Foo; +can_ok( 'main', 'fooble' ); + +#line 114 +sub core_caller_check { + return CORE::caller(0); +} + +sub caller_check { + return caller(shift); +} + +is_deeply( [ ( caller_check(0), 0, 4 )[0 .. 3] ], + ['main', $0, 122, 'main::caller_check' ], + 'caller check' ); + +is( (() = caller_check(0)), (() = core_caller_check(0)) , + "caller() with args returns right number of values" +); + +sub core_caller_no_args { + return CORE::caller(); +} + +sub caller_no_args { + return caller(); +} + +is( (() = caller_no_args()), (() = core_caller_no_args()), + "caller() with no args returns right number of values" +); + +sub deep_caller { + return caller(1); +} + +sub check_deep_caller { + deep_caller(); +} + +#line 134 +is_deeply([(check_deep_caller)[0..2]], ['main', $0, 134], 'shallow caller' ); + +sub deeper { deep_caller() } # caller 0 +sub still_deeper { deeper() } # caller 1 -- should give this line, 137 +sub ever_deeper { still_deeper() } # caller 2 + +is_deeply([(ever_deeper)[0..2]], ['main', $0, 137], 'deep caller()' ); + +# This uplevel() should not effect deep_caller's caller(1). +sub yet_deeper { uplevel( 1, \&ever_deeper) } +is_deeply([(yet_deeper)[0..2]], ['main', $0, 137], 'deep caller() + uplevel' ); + +sub target { caller } +sub yarrow { uplevel( 1, \&target ) } +sub hock { uplevel( 1, \&yarrow ) } + +is_deeply([(hock)], ['main', $0, 150], 'nested uplevel()s' ); + +# Deep caller inside uplevel +package Delegator; +# line 159 +sub delegate { main::caller_check(shift) } + +package Wrapper; +use Sub::Uplevel; +sub wrap { uplevel( 1, \&Delegator::delegate, @_ ) } + +package main; + +is( (Wrapper::wrap(0))[0], 'Delegator', + 'deep caller check of parent sees real calling package' +); + +is( (Wrapper::wrap(1))[0], 'main', + 'deep caller check of grandparent sees package above uplevel' +); + diff --git a/t/03_nested_uplevels.t b/t/03_nested_uplevels.t new file mode 100644 index 0000000..fe0dcac --- /dev/null +++ b/t/03_nested_uplevels.t @@ -0,0 +1,81 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More; + +use Sub::Uplevel; + +package Wrap; +use Sub::Uplevel; + +sub wrap { + my ($n, $f, $depth, $up, @case) = @_; + + if ($n > 1) { + $n--; + return wrap( $n, $f, $depth, $up, @case ); + } + else { + return uplevel( $up , $f, $depth, $up, @case ); + } +} + +package Call; + +sub recurse_call_check { + my ($depth, $up, @case) = @_; + + if ( $depth ) { + $depth--; + my @result; + push @result, recurse_call_check($depth, $up, @case, 'Call' ); + for my $n ( 1 .. $up ) { + push @result, Wrap::wrap( $n, \&recurse_call_check, + $depth, $n, @case, + $n == 1 ? "Wrap(Call)" : "Wrap(Call) x $n" ), + ; + } + return @result; + } + else { + my (@uplevel_callstack, @real_callstack); + my $i = 0; + while ( defined( my $caller = caller($i++) ) ) { + push @uplevel_callstack, $caller; + } + $i = 0; + while ( defined( my $caller = CORE::caller($i++) ) ) { + push @real_callstack, $caller; + } + return [ + join( q{, }, @case ), + join( q{, }, reverse @uplevel_callstack ), + join( q{, }, reverse @real_callstack ), + ]; + } +} + +package main; + +my $depth = 4; +my $up = 3; +my $cases = 104; + +plan tests => $cases; + +my @results = Call::recurse_call_check( $depth, $up, 'Call' ); + +is( scalar @results, $cases, + "Right number of cases" +); + +my $expected = shift @results; + +for my $got ( @results ) { + is( $got->[1], $expected->[1], + "Case: $got->[0]" + ) or diag( "Real callers: $got->[2]" ); +} + diff --git a/t/04_honor_later_override.t b/t/04_honor_later_override.t new file mode 100644 index 0000000..de1608b --- /dev/null +++ b/t/04_honor_later_override.t @@ -0,0 +1,83 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More tests => 7; + +# Goal of these tests: confirm that Sub::Uplevel will honor (use) a +# CORE::GLOBAL::caller that occurs after Sub::Uplevel is loaded + +#--------------------------------------------------------------------------# +# define a custom caller function that reverses the package name +#--------------------------------------------------------------------------# + +sub _reverse_caller(;$) { + my $height = $_[0]; + my @caller = CORE::caller(++$height); + $caller[0] = defined $caller[0] ? reverse $caller[0] : undef; + if( wantarray and !@_ ) { + return @caller[0..2]; + } + elsif (wantarray) { + return @caller; + } + else { + return $caller[0]; + } +} + +#--------------------------------------------------------------------------# +# load Sub::Uplevel then redefine CORE::GLOBAL::caller +#--------------------------------------------------------------------------# + +BEGIN { + ok( ! defined *CORE::GLOBAL::caller{CODE}, + "no global override yet" + ); + + use_ok('Sub::Uplevel'); + + is( *CORE::GLOBAL::caller{CODE}, \&Sub::Uplevel::_normal_caller, + "Sub::Uplevel's normal caller override in place" + ); + + # old style no warnings 'redefine' + my $old_W = $^W; + $^W = 0; + + *CORE::GLOBAL::caller = \&_reverse_caller; + $^W = $old_W + +} + +is( *CORE::GLOBAL::caller{CODE}, \&_reverse_caller, + "added new, custom caller override" +); + +#--------------------------------------------------------------------------# +# define subs *after* caller has been redefined in BEGIN +#--------------------------------------------------------------------------# + +sub test_caller { return scalar caller } + +sub uplevel_caller { return uplevel 1, \&test_caller } + +sub test_caller_w_uplevel { return uplevel_caller } + +#--------------------------------------------------------------------------# +# Test for reversed package name both inside and outside an uplevel call +#--------------------------------------------------------------------------# + +is( scalar caller(), undef, + "caller from main package is undef" +); + +is( test_caller(), reverse("main"), + "caller from subroutine calls custom routine" +); + +is( test_caller_w_uplevel(), reverse("main"), + "caller from uplevel subroutine calls custom routine" +); + diff --git a/t/05_honor_prior_override.t b/t/05_honor_prior_override.t new file mode 100644 index 0000000..e70e7f7 --- /dev/null +++ b/t/05_honor_prior_override.t @@ -0,0 +1,94 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More tests => 10; + +# Goal of these tests: confirm that Sub::Uplevel will honor (use) a +# CORE::GLOBAL::caller override that occurs prior to Sub::Uplevel loading + +#--------------------------------------------------------------------------# +# define a custom caller function that increments a counter +#--------------------------------------------------------------------------# + +my $caller_counter = 0; +sub _count_caller(;$) { + $caller_counter++; + my $height = $_[0]; + my @caller = CORE::caller(++$height); + if( wantarray and !@_ ) { + return @caller[0..2]; + } + elsif (wantarray) { + return @caller; + } + else { + return $caller[0]; + } +} + +#--------------------------------------------------------------------------# +# redefine CORE::GLOBAL::caller then load Sub::Uplevel +#--------------------------------------------------------------------------# + +BEGIN { + ok( ! defined *CORE::GLOBAL::caller{CODE}, + "no global override yet" + ); + + { + # old style no warnings 'redefine' + my $old_W = $^W; + $^W = 0; + *CORE::GLOBAL::caller = \&_count_caller; + $^W = $old_W; + } + + is( *CORE::GLOBAL::caller{CODE}, \&_count_caller, + "added custom caller override" + ); + + use_ok('Sub::Uplevel'); + + is( *CORE::GLOBAL::caller{CODE}, \&_count_caller, + "custom caller override still in place" + ); + + +} + +#--------------------------------------------------------------------------# +# define subs *after* caller has been redefined in BEGIN +#--------------------------------------------------------------------------# + +sub test_caller { return scalar caller } + +sub uplevel_caller { return uplevel 1, \&test_caller } + +sub test_caller_w_uplevel { return uplevel_caller } + +#--------------------------------------------------------------------------# +# Test for reversed package name both inside and outside an uplevel call +#--------------------------------------------------------------------------# + +my $old_caller_counter; + +$old_caller_counter = $caller_counter; +is( scalar caller(), undef, + "caller from main package is undef" +); +ok( $caller_counter > $old_caller_counter, "custom caller() was used" ); + +$old_caller_counter = $caller_counter; +is( test_caller(), "main", + "caller from subroutine is main" +); +ok( $caller_counter > $old_caller_counter, "custom caller() was used" ); + +$old_caller_counter = $caller_counter; +is( test_caller_w_uplevel(), "main", + "caller from uplevel subroutine is main" +); +ok( $caller_counter > $old_caller_counter, "custom caller() was used" ); + diff --git a/t/06_db_args.t b/t/06_db_args.t new file mode 100644 index 0000000..9c3414b --- /dev/null +++ b/t/06_db_args.t @@ -0,0 +1,34 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More tests => 3; + +BEGIN { use_ok('Sub::Uplevel'); } + +sub get_caller_args { + package DB; + my @x = caller(1); + return @DB::args; +} + +sub addition { + my $x; + $x += $_ for @_; + return $x; +} + +sub wrap_addition { + my @args = get_caller_args(); + my $sum = uplevel 1, \&addition, @_; + return ($sum, @args); +} + +my ($sum, @args) = wrap_addition(1, 2, 3); + +is($sum, 6, "wrapper returned value correct"); +is_deeply( \@args, [1, 2, 3], "wrapper returned args correct" ); + + + diff --git a/t/07_uplevel_too_high.t b/t/07_uplevel_too_high.t new file mode 100644 index 0000000..5a4a417 --- /dev/null +++ b/t/07_uplevel_too_high.t @@ -0,0 +1,33 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More tests => 5; + +BEGIN { + $Sub::Uplevel::CHECK_FRAMES = 1; + use_ok('Sub::Uplevel'); +} + +sub show_caller { + return scalar caller; +} + +sub wrap_show_caller { + my $uplevel = shift; + return uplevel $uplevel, \&show_caller; +} + +my $warning = ''; +local $SIG{__WARN__} = sub { $warning = shift }; + +my $caller = wrap_show_caller(1); +is($caller, 'main', "wrapper returned correct caller"); +is( $warning, '', "don't warn if ordinary uplevel" ); + +$warning = ''; +$caller = wrap_show_caller(2); +my $file = __FILE__; +is($caller, undef, "wrapper returned correct caller"); +like( $warning, qr/uplevel 2 is more than the caller stack/, "warn if too much uplevel" ); diff --git a/t/08_exporter.t b/t/08_exporter.t new file mode 100644 index 0000000..5e055e4 --- /dev/null +++ b/t/08_exporter.t @@ -0,0 +1,19 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More; + +plan tests => 1; + +# Goal of these tests: confirm that Sub::Uplevel will work with Exporter's +# import() function + +package main; +use lib 't/lib'; +require MyImporter; +require Bar; +MyImporter::import_for_me('Bar','func3'); +can_ok('main','func3'); + diff --git a/t/09_emptylist.t b/t/09_emptylist.t new file mode 100644 index 0000000..d3cb059 --- /dev/null +++ b/t/09_emptylist.t @@ -0,0 +1,34 @@ +#!/usr/bin/perl + +use strict; +BEGIN { $^W = 1 } + +use Test::More; + +use Sub::Uplevel; + +plan tests => 3; + +sub get_caller { + return caller(shift); +} + +sub wrapper { + my $height = shift; + return uplevel 1, \&get_caller, $height; +} + +{ + my @caller = wrapper(0); + ok(scalar @caller, "caller(N) in stack returns list"); +} + +{ + my @caller = wrapper(1); + is(scalar @caller, 0, "caller(N) out of stack returns empty list"); +} + +{ + my @caller = caller; + is(scalar @caller, 0, "caller from main returns empty list"); +} diff --git a/t/lib/Bar.pm b/t/lib/Bar.pm new file mode 100644 index 0000000..b4efcb4 --- /dev/null +++ b/t/lib/Bar.pm @@ -0,0 +1,8 @@ +package Bar; +use warnings; +use strict; +require Exporter; +our @ISA = qw(Exporter); +our @EXPORT_OK = qw( func3 ); +sub func3 { 3 } +1; diff --git a/t/lib/Foo.pm b/t/lib/Foo.pm new file mode 100644 index 0000000..ea5f2bd --- /dev/null +++ b/t/lib/Foo.pm @@ -0,0 +1,8 @@ +package Foo; + +# Hook::LexWrap does this, Sub::Uplevel appears to interfere. +sub import { *{caller()."::fooble"} = \&fooble } + +sub fooble { 42 } + +1; diff --git a/t/lib/MyImporter.pm b/t/lib/MyImporter.pm new file mode 100644 index 0000000..0ddcc77 --- /dev/null +++ b/t/lib/MyImporter.pm @@ -0,0 +1,15 @@ +package MyImporter; +use warnings; +use strict; +use Sub::Uplevel qw/:aggressive/; +sub import_for_me { + my ($pkg, @p) = @_; + my $level = 1; + my $import = $pkg->can('import'); + if ($import) { + uplevel $level, $import, ($pkg, @p); + } else { + warn "no import in $pkg\n"; + } +} +1; diff --git a/xt/author/00-compile.t b/xt/author/00-compile.t new file mode 100644 index 0000000..7b452f1 --- /dev/null +++ b/xt/author/00-compile.t @@ -0,0 +1,63 @@ +use 5.006; +use strict; +use warnings; + +# this test was generated with Dist::Zilla::Plugin::Test::Compile 2.056 + +use Test::More; + +plan tests => 2; + +my @module_files = ( + 'Sub/Uplevel.pm' +); + + + +# fake home for cpan-testers +use File::Temp; +local $ENV{HOME} = File::Temp::tempdir( CLEANUP => 1 ); + + +my @switches = ( + -d 'blib' ? '-Mblib' : '-Ilib', +); + +use File::Spec; +use IPC::Open3; +use IO::Handle; + +open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; + +my @warnings; +for my $lib (@module_files) +{ + # see L + my $stderr = IO::Handle->new; + + diag('Running: ', join(', ', map { my $str = $_; $str =~ s/'/\\'/g; q{'} . $str . q{'} } + $^X, @switches, '-e', "require q[$lib]")) + if $ENV{PERL_COMPILE_TEST_DEBUG}; + + my $pid = open3($stdin, '>&STDERR', $stderr, $^X, @switches, '-e', "require q[$lib]"); + binmode $stderr, ':crlf' if $^O eq 'MSWin32'; + my @_warnings = <$stderr>; + waitpid($pid, 0); + is($?, 0, "$lib loaded ok"); + + shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ + and not eval { require blib; blib->VERSION('1.01') }; + + if (@_warnings) + { + warn @_warnings; + push @warnings, @_warnings; + } +} + + + +is(scalar(@warnings), 0, 'no warnings found') + or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ); + + diff --git a/xt/author/critic.t b/xt/author/critic.t new file mode 100644 index 0000000..d5b4c96 --- /dev/null +++ b/xt/author/critic.t @@ -0,0 +1,12 @@ +#!perl + +use strict; +use warnings; + +use Test::More; +use English qw(-no_match_vars); + +eval "use Test::Perl::Critic"; +plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; +Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; +all_critic_ok(); diff --git a/xt/author/pod-coverage.t b/xt/author/pod-coverage.t new file mode 100644 index 0000000..66b3b64 --- /dev/null +++ b/xt/author/pod-coverage.t @@ -0,0 +1,7 @@ +#!perl +# 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' }); diff --git a/xt/author/pod-spell.t b/xt/author/pod-spell.t new file mode 100644 index 0000000..22b8656 --- /dev/null +++ b/xt/author/pod-spell.t @@ -0,0 +1,41 @@ +use strict; +use warnings; +use Test::More; + +# generated by Dist::Zilla::Plugin::Test::PodSpelling 2.007004 +use Test::Spelling 0.12; +use Pod::Wordlist; + + +add_stopwords(); +all_pod_files_spelling_ok( qw( bin lib ) ); +__DATA__ +Adam +Alexandr +Ciornii +David +Golden +Graham +Gray +Kennedy +Koston +Michael +Nick +Ollis +PadWalker +Schwern +Sub +Tcl's +Uplevel +Welch +adamk +alexchorny +and +dagolden +lib +mg13 +mschwern +nick +plicease +uplevel +xdg diff --git a/xt/author/pod-syntax.t b/xt/author/pod-syntax.t new file mode 100644 index 0000000..e563e5d --- /dev/null +++ b/xt/author/pod-syntax.t @@ -0,0 +1,7 @@ +#!perl +# This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. +use strict; use warnings; +use Test::More; +use Test::Pod 1.41; + +all_pod_files_ok(); diff --git a/xt/author/portability.t b/xt/author/portability.t new file mode 100644 index 0000000..f6ac836 --- /dev/null +++ b/xt/author/portability.t @@ -0,0 +1,10 @@ +use strict; +use warnings; + +use Test::More; + +eval 'use Test::Portability::Files'; +plan skip_all => 'Test::Portability::Files required for testing portability' + if $@; +options(test_one_dot => 0); +run_tests(); diff --git a/xt/author/test-version.t b/xt/author/test-version.t new file mode 100644 index 0000000..247ba9a --- /dev/null +++ b/xt/author/test-version.t @@ -0,0 +1,23 @@ +use strict; +use warnings; +use Test::More; + +# generated by Dist::Zilla::Plugin::Test::Version 1.09 +use Test::Version; + +my @imports = qw( version_all_ok ); + +my $params = { + is_strict => 0, + has_version => 1, + multiple => 0, + +}; + +push @imports, $params + if version->parse( $Test::Version::VERSION ) >= version->parse('1.002'); + +Test::Version->import(@imports); + +version_all_ok; +done_testing; diff --git a/xt/release/distmeta.t b/xt/release/distmeta.t new file mode 100644 index 0000000..c2280dc --- /dev/null +++ b/xt/release/distmeta.t @@ -0,0 +1,6 @@ +#!perl +# This file was automatically generated by Dist::Zilla::Plugin::MetaTests. + +use Test::CPAN::Meta; + +meta_yaml_ok(); diff --git a/xt/release/minimum-version.t b/xt/release/minimum-version.t new file mode 100644 index 0000000..708ba15 --- /dev/null +++ b/xt/release/minimum-version.t @@ -0,0 +1,8 @@ +#!perl + +use Test::More; + +eval "use Test::MinimumVersion"; +plan skip_all => "Test::MinimumVersion required for testing minimum versions" + if $@; +all_minimum_version_ok( qq{5.010} );