diff --git a/Build.PL b/Build.PL new file mode 100644 index 0000000..9f2888f --- /dev/null +++ b/Build.PL @@ -0,0 +1,26 @@ +#! perl + +BEGIN { require 5.006002 } + +use Module::Build; + +my $build = Module::Build->new( + module_name => 'SUPER', + license => 'perl', + requires => + { + 'perl' => '5.6.2', + 'Scalar::Util' => '1.20', + 'Sub::Identify' => '0.03', + }, + build_requires => + { + 'Test::Simple' => '0.61', + }, + no_index => + { + package => [ qw( UNIVERSAL DB ) ] + }, +); + +$build->create_build_script(); diff --git a/Changes b/Changes new file mode 100644 index 0000000..48d5262 --- /dev/null +++ b/Changes @@ -0,0 +1,56 @@ +Revision history for Perl extension SUPER. + +1.20141117 2014-11-17 09:12:01-08:00 America/Los_Angeles + - improved export mechanism + - removed useless Exporter tests + - improved docs (RT #79681) + +1.20141116 2014-11-16 14:07:18-08:00 America/Los_Angeles + - resolved Test::More changes (RT #97939) + +1.20120705 2012-07-05 14:46:44 America/Los_Angeles + - resolved PAUSE packaging nit (Oliver Mengué, RT #77110) + - converted to dzil + +1.16 + Wed Apr 4 05:54:23 UTC 2007 ($Rev: 154 $, $Author: chromatic $) + - avoid deep recursion problem on deep hierarchies (RT #24795, Paul Talacko) + +1.15 + Sat Sep 30 20:34:51 UTC 2006 (Rev: 2941, Author: chromatic) + - allow weird class names (RT #21491, Joshua ben Jore, with some caveats) + - added documentation for weird class names and caveats + - fixed deep recursion on can() error (RT #21644, Joshua ben Jore again) + - prevent indexing UNIVERSAL and DB + +1.14 Mon May 15 23:47:24 UTC 2006 + - removed nearly-dead code that made another nasty loop (bugfix) + +1.13 Sun May 14 01:05:31 UTC 2006 (Rev: 16687, Author: chromatic) + - fixed SUPER() calls when inheriting the method being called (yow!) + - fixed a few documentation formatting nits + +1.12 Fri Apr 21 00:51:12 UTC 2006 (Rev: 15993, Author: chromatic) + - look for parents better in case of a proxy or mock object + - added developer test goodness to make life easier for installers + +1.11 Sun Nov 13 00:59:29 UTC 2005 (Rev: 9748, Author: chromatic) + - cleaned up documentation + - added POD testing tests + - fixed failing 1.t test -- due to Test::More changes + +1.10 Sat Apr 16 05:52:13 UTC 2005 + - added SUPER() method and tests + - ported to Module::Build + - added Build.PL + - first release with new maintainership + +1.01 Tuesday 2nd March, 2004 + Fix the case expressed by t/keep_going.t + +1.00 Saturday 18th January, 2004 + Initial CPAN Release. + +0.01 Sat Jan 18 14:57:52 2003 + - original version; created by h2xs 1.22 with options + -b 5.6.0 -AX -n SUPER diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d1bedbd --- /dev/null +++ b/LICENSE @@ -0,0 +1,379 @@ +This software is copyright (c) 2014 by chromatic@wgz.org. + +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) 2014 by chromatic@wgz.org. + +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) 2014 by chromatic@wgz.org. + +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..08d57e5 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,17 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.020. +Build.PL +Changes +LICENSE +MANIFEST +META.yml +Makefile.PL +README +dist.ini +lib/SUPER.pm +t/1.t +t/bugs.t +t/deep_inheritance.t +t/follow_inheritance.t +t/get_all_parents.t +t/keep_going.t +t/keep_going_manual.t diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..27a1802 --- /dev/null +++ b/META.yml @@ -0,0 +1,27 @@ +--- +abstract: 'control superclass method dispatch' +author: + - chromatic +build_requires: + Test::More: '0' + base: '0' + lib: '0' +configure_requires: + ExtUtils::MakeMaker: '0' +dynamic_config: 0 +generated_by: 'Dist::Zilla version 5.020, CPAN::Meta::Converter version 2.142060' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: SUPER +requires: + Carp: '0' + Scalar::Util: '0' + Sub::Identify: '0' + strict: '0' + warnings: '0' +resources: + bugtracker: http://rt.cpan.org/NoAuth/Bugs.html?Dist=SUPER + repository: https://github.com/chromatic/SUPER.git +version: '1.20141117' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..fb4f718 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,65 @@ + +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.020. +use strict; +use warnings; + + + +use ExtUtils::MakeMaker ; + + + +my %WriteMakefileArgs = ( + "ABSTRACT" => "control superclass method dispatch", + "AUTHOR" => "chromatic", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "SUPER", + "EXE_FILES" => [], + "LICENSE" => "perl", + "NAME" => "SUPER", + "PREREQ_PM" => { + "Carp" => 0, + "Scalar::Util" => 0, + "Sub::Identify" => 0, + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "Test::More" => 0, + "base" => 0, + "lib" => 0 + }, + "VERSION" => "1.20141117", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "Carp" => 0, + "Scalar::Util" => 0, + "Sub::Identify" => 0, + "Test::More" => 0, + "base" => 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..990a545 --- /dev/null +++ b/README @@ -0,0 +1,15 @@ + + +This archive contains the distribution SUPER, +version 1.20141117: + + control superclass method dispatch + +This software is copyright (c) 2014 by chromatic@wgz.org. + +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.020. + diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..2bd0a1a --- /dev/null +++ b/dist.ini @@ -0,0 +1,31 @@ +name = SUPER +author = chromatic +license = Perl_5 +copyright_holder = chromatic@wgz.org +copyright_year = 2014 + +[MetaResources] +bugtracker.web = http://rt.cpan.org/NoAuth/Bugs.html?Dist=SUPER +bugtracker.mailto = bug-super@rt.cpan.org +repository.url = https://github.com/chromatic/SUPER.git +repository.web = https://github.com/chromatic/SUPER +repository.type = git + +[AutoVersion] +format = {{ cldr('1.yyyyMMdd') }} + +[AutoPrereqs] +skip = ^Father|Grandfather|Level\d$ + +[@Basic] +[PkgVersion] +[NextRelease] + +[@Git] +changelog = Changes ; this is the default +allow_dirty = dist.ini ; see Git::Check... +allow_dirty = Changes ; ... and Git::Commit +commit_msg = v%v%n%n%c ; see Git::Commit +tag_format = %v ; see Git::Tag +tag_message = %v ; see Git::Tag +push_to = origin ; see Git::Push diff --git a/lib/SUPER.pm b/lib/SUPER.pm new file mode 100644 index 0000000..29b4333 --- /dev/null +++ b/lib/SUPER.pm @@ -0,0 +1,264 @@ +# Dear PAUSE: please do not index this +package + DB; + +sub uplevel_args { my @foo = caller(2); return @DB::args } + +# Dear PAUSE: nor this +package + UNIVERSAL; + +use strict; +use warnings; + +use Scalar::Util 'blessed'; + +sub super +{ + return ( SUPER::find_parent( @_, '', $_[0] ) )[0]; +} + +sub SUPER +{ + my $self = $_[0]; + my $blessed = blessed( $self ); + my $self_class = defined $blessed ? $blessed : $self; + my ($class, $method) = ( caller( 1 ) )[3] =~ /(.+)::(\w+)$/; + my ($sub, $parent) = + SUPER::find_parent( $self_class, $method, $class, $self ); + + return unless $sub; + goto &$sub; +} + +package SUPER; +# ABSTRACT: control superclass method dispatch +$SUPER::VERSION = '1.20141117'; +use strict; +use warnings; + +use Carp; + +use Scalar::Util 'blessed'; +use Sub::Identify (); + +# no need to use Exporter +sub import +{ + my ($class) = @_; + my $caller = caller(); + do { no strict 'refs'; *{ $caller . '::super' } = \&super }; +} + +sub find_parent +{ + my ($class, $method, $prune, $invocant) = @_; + my $blessed = blessed( $class ); + $invocant ||= $class; + $class = $blessed if $blessed; + $prune ||= ''; + + my @parents = get_all_parents( $invocant, $class ); + + # only check parents above the $prune point + my $i = $#parents; + for my $parent (reverse @parents) { + last if $parent eq $prune; + $i--; + } + + for my $parent ( @parents[$i .. $#parents] ) + { + if ( my $subref = $parent->can( $method ) ) + { + my $source = Sub::Identify::sub_fullname( $subref ); + next if $source eq "${prune}::$method"; + return ( $subref, $parent ); + } + } +} + +sub get_all_parents +{ + my ($invocant, $class) = @_; + + my @parents = eval { $invocant->__get_parents() }; + + unless ( @parents ) + { + no strict 'refs'; + @parents = @{ $class . '::ISA' }; + } + + return 'UNIVERSAL' unless @parents; + return @parents, map { get_all_parents( $_, $_ ) } @parents; +} + +sub super() +{ + # Someone's trying to find SUPER's super. Blah. + goto &UNIVERSAL::super if @_; + + @_ = DB::uplevel_args(); + + carp 'You must call super() from a method call' unless $_[0]; + + my $caller = ( caller(1) )[3]; + my $self = caller(); + $caller =~ s/.*:://; + + goto &{ $self->UNIVERSAL::super($caller) }; +} + +1; + +=head1 NAME + +SUPER - control superclass method dispatch + +=head1 SYNOPSIS + +Find the parent method that would run if this weren't here: + + sub my_method + { + my $self = shift; + my $super = $self->super('my_method'); # Who's your daddy? + + if ($want_to_deal_with_this) + { + # ... + } + else + { + $super->($self, @_) + } + } + +Or Ruby-style: + + sub my_method + { + my $self = shift; + + if ($want_to_deal_with_this) + { + # ... + } + else + { + super; + } + } + +Or call the super method manually, with respect to inheritance, and passing +different arguments: + + sub my_method + { + my $self = shift; + + # parent handles args backwardly + $self->SUPER( reverse @_ ); + } + +=head1 DESCRIPTION + +When subclassing a class, you occasionally want to dispatch control to the +superclass -- at least conditionally and temporarily. The Perl syntax for +calling your superclass is ugly and unwieldy: + + $self->SUPER::method(@_); + +especially when compared to its Ruby equivalent: + + super; + +It's even worse in that the normal Perl redispatch mechanism only dispatches to +the parent of the class containing the method I. That doesn't work very well for mixins and roles. + +This module provides nicer equivalents, along with the universal method +C to determine a class' own superclass. This allows you to do things +such as: + + goto &{$_[0]->super('my_method')}; + +if you don't like wasting precious stack frames. + +If you are using roles or mixins or otherwise pulling in methods from other +packages that need to dispatch to their super methods, or if you want to pass +different arguments to the super method, use the C method: + + $self->SUPER( qw( other arguments here ) ); + +=head1 FUNCTIONS and METHODS + +This module provides the following functions and methods: + +=over + +=item C + +This function calls the super method of the currently-executing method, no +matter where the super method is in the hierarchy. + +This takes no arguments; it passes the same arguments passed to the +currently-executing method. + +The module exports this function by default. + +I: you I have the appropriate C declaration in place for +this to work. That is, you must have I the method in which you use +this function in the package from which you want to use it. Them's the breaks +with Perl 5. + +=item C + +Attempts to find a parent implementation of C<$method> starting with C<$class>. +If you pass C<$prune>, it will not ignore the method found in that package, if +it exists there. Pass C<$invocant> if the object itself might have a different +idea of its parents. + +The module does not export this function by default. Call it directly. + +=item C + +Returns all of the parents for the C<$invocant>, if it supports the +C<__get_parents()> method or the contents of C<@ISA> for C<$class>. You +probably oughtn't call this on your own. + +=item C + +Calls the super method of the currently-executing method. You I pass +arguments. This is a method. + +=back + +=head1 NOTES + +I if you do weird things with code generation, be sure to I your +anonymous subroutines. See I #57. + +Using C doesn't let you pass alternate arguments to your superclass's +method. If you want to pass different arguments, use C instead. D'oh. + +This module does a small amount of Deep Magic to find the arguments of method +I C itself. This may confuse tools such as C. + +In your own code, if you do complicated things with proxy objects and the like, +define C<__get_parents()> to return a list of all parents of the object to +which you really want to dispatch. + +=head1 AUTHOR + +Created by Simon Cozens, C. Copyright (c) 2003 Simon Cozens. + +Maintained by chromatic, Echromatic at wgz dot orgE after version 1.01. +Copyright (c) 2004-2014 chromatic. + +Thanks to Joshua ben Jore for bug reports and suggestions. + +=head1 LICENSE + +You may use and distribute this silly little module under the same terms as +Perl itself. diff --git a/t/1.t b/t/1.t new file mode 100644 index 0000000..e9429fb --- /dev/null +++ b/t/1.t @@ -0,0 +1,48 @@ +#!perl +use strict; +use warnings; + +use Test::More; + +package Daddy; + +Test::More->import(); + +sub new { bless {}, shift } + +sub foo +{ + my $self = shift; + isa_ok( $self, "Kid" ); + is( $_[0], 123, "Arguments passed OK" ); +} + +package Kid; + +Test::More->import(); +@Kid::ISA = 'Daddy'; + +use SUPER; + +sub foo +{ + my $self = shift; + if ( $_[0] > 100 ) + { + super; + } + else + { + is( $_[0], 50, "Arguments retained OK" ) + } +} + +my $a = Kid->new(); +$a->foo(123); +$a->foo(50); + +is( $a->super( 'new' ), \&Daddy::new, 'Kid inherits new() from Daddy' ); +is( $a->super( 'foo' ), \&Daddy::foo, + '... as it does foo, even though it overrides it' ); + +done_testing(); diff --git a/t/bugs.t b/t/bugs.t new file mode 100644 index 0000000..c3a3fce --- /dev/null +++ b/t/bugs.t @@ -0,0 +1,83 @@ +#!perl + +use strict; +use warnings; + +use SUPER; +use Test::More tests => 6; + +# RT #21491 - weird class names +{ + + package Pirate; + sub chumbucket { return 'Ahoy!'; } + sub four_bells { return 'Belay that order!'; } + sub keelhaul { return 'Rub some salt into it, ye scurvy dog.'; } +} + +{ + # The '...' class has a method named 'chumbucket' and inherits from + # Pirate. + no strict 'refs'; + *{'...::chumbucket'} = sub { local *__ANON__ = 'chumbucket'; $_[0]->SUPER }; + @{'...::ISA'} = 'Pirate'; + + my $obj = bless [], '...'; + eval { is( $obj->chumbucket, Pirate->chumbucket, "Class '...'" ) }; + fail( "Class '...' ($@)" ) if $@; +} + +{ + no strict 'refs'; + *{"\n::four_bells"} = sub { local *__ANON__ = 'four_bells'; $_[0]->SUPER }; + @{"\n::ISA"} = 'Pirate'; + + my $obj = bless [], "\n"; + eval { is( $obj->four_bells, Pirate->four_bells, "Class '\\n'" ); }; + fail( "Class '' ($@)" ) if $@; +} + +{ + no strict 'refs'; + + *{'0::keelhaul'} = sub { local *__ANON__ = 'keelhaul'; $_[0]->SUPER }; + @{'0::ISA'} = 'Pirate'; + + my $obj = bless [], '0'; + eval { is( $obj->keelhaul, Pirate->keelhaul, "Class '0'" ); }; + fail( "Class '0' ($@)" ) if $@; +} + +# RT #21644 - poor recursion handling +package Mars; + +sub rock_out { return 'Rrraaawwwr!'; } + +package Venus; + +use SUPER; +use warnings FATAL => 'recursion'; + +@Venus::ISA = 'Mars'; + +# A generic constructor. +sub new { return bless [], shift } + +sub can +{ + my $obj = shift; + + # Delegate and make sure that accidental infinite + # recursion is deadly for purposes of these tests. + + return $obj->SUPER( @_ ); +} + +package main; + +my $obj = Venus->new(); +my $out = eval { $obj->can('rock_out') }; +ok( ! $@, 'No deep recursion' ) or diag( "Exception: '$@'" ); +eval { is( Venus->can('rock_out'), \&Mars::rock_out, '$Class->can worked' ); }; +fail('$Class->can failed') if $@; +is( $obj->rock_out, $out->(), '... and should get to right method' ); diff --git a/t/deep_inheritance.t b/t/deep_inheritance.t new file mode 100644 index 0000000..b1ce19c --- /dev/null +++ b/t/deep_inheritance.t @@ -0,0 +1,87 @@ +#!/usr/bin/perl -w + +BEGIN +{ + chdir 't' if -d 't'; +} + +use lib '../lib'; + +use strict; +use Test::More tests => 15; +use Scalar::Util 'blessed'; + +my $module = 'SUPER'; +use_ok($module) or die; + +my $obj = Level4->new; +isa_ok( $obj, 'Level4' ); + +is( $obj->good_stuff, 'this has done good stuff', + '...the object is initialized as level4' +); + +my @parents = SUPER::get_all_parents( $obj, blessed($obj) ); +is_deeply( \@parents, [qw( Level3 Level2 Level1 UNIVERSAL )], + '...the object has four parents from its own class.' +); + +@parents = SUPER::get_all_parents( $obj, 'Level3' ); +is_deeply( \@parents, [qw( Level2 Level1 UNIVERSAL )], + '... 3 parents from one class above.' +); + +@parents = SUPER::get_all_parents( $obj, 'Level2' ); +is_deeply( \@parents, [qw( Level1 UNIVERSAL )], + '...2 parents from two classes above.' ); + +@parents = SUPER::get_all_parents( $obj, 'Level1' ); +is_deeply( \@parents, [ 'UNIVERSAL' ], + '...and only UNIVERSAL from the top level class.' ); + +my ( $sub, $parent ) = + SUPER::find_parent( blessed($obj), 'good_stuff', 'Level4', $obj ); +is( $sub, \&Level3::good_stuff, '...get the expected superclass method.' ); +is( $parent, 'Level3', '...in the expected superclass.' ); + +( $sub, $parent ) = + SUPER::find_parent( blessed($obj), 'good_stuff', 'Level3', $obj ); +is( $sub, \&Level2::good_stuff, + '...get the expected superclass method one up.' ); +is( $parent, 'Level2', '...in the superclass one up.' ); + +( $sub, $parent ) = + SUPER::find_parent( blessed($obj), 'good_stuff', 'Level2', $obj ); +is( $sub, \&Level1::good_stuff, + '...get the expected superclass method two up.' ); +is( $parent, 'Level1', '...in the superclass two up.' ); + +( $sub, $parent ) = + SUPER::find_parent( blessed($obj), 'good_stuff', 'Level1', $obj ); +is( $sub, '', '...get an empty string when there are no more super class.' ); +is( $parent, undef, + '...and undef when no further superclasses match the desired method.' ); + +exit; + +package Level1; + +sub new { bless {}, $_[0] } + +sub good_stuff { return "this has done good stuff" } + +package Level2; + +use base 'Level1'; + +sub good_stuff { $_[0]->SUPER; } + +package Level3; + +use base 'Level2'; + +sub good_stuff { $_[0]->SUPER; } + +package Level4; + +use base 'Level3'; diff --git a/t/follow_inheritance.t b/t/follow_inheritance.t new file mode 100644 index 0000000..6380e35 --- /dev/null +++ b/t/follow_inheritance.t @@ -0,0 +1,70 @@ +#!/usr/bin/perl -w + +BEGIN +{ + chdir 't' if -d 't'; +} + +use lib '../lib'; + +use strict; +use Test::More tests => 6; + +my $module = 'SUPER'; +use_ok( $module ) or exit; + +package Foo; + +sub go_nowhere +{ + my $self = shift; + return $self->SUPER(); +} + +sub foo +{ + return __PACKAGE__; +} + +package Bar; + +@Bar::ISA = 'Foo'; + +sub foo +{ + return [ $_[0]->SUPER(), __PACKAGE__ ]; +} + +package Baz; + +@Baz::ISA = 'Bar'; + +sub foo +{ + my $self = shift; + $self->SUPER(); +} + +package Quux; + +@Quux::ISA = 'Foo'; +*Quux::foo = \&Baz::foo; +*Quux::foo = 1; + +package Qaax; + +@Qaax::ISA = 'Quux'; + +package main; + +my $baz = bless [], 'Quux'; +is( $baz->foo(), 'Foo', + 'SUPER() should respect current, not compile-time @ISA' ); + +*Quux::foo = \&Bar::foo; +is_deeply( $baz->foo(), [ 'Foo', 'Bar' ], '... even when reset' ); +is_deeply( Quux->foo(), [ 'Foo', 'Bar' ], '... for class calls too' ); +is( Foo->go_nowhere(), (), 'SUPER() and should go nowhere with nowhere to go' ); + +my $q = bless {}, 'Qaax'; +is_deeply( $q->foo(), [ 'Foo', 'Bar' ], 'mu' ); diff --git a/t/get_all_parents.t b/t/get_all_parents.t new file mode 100644 index 0000000..e378c82 --- /dev/null +++ b/t/get_all_parents.t @@ -0,0 +1,56 @@ +#!perl + +use strict; +use warnings; + +use Test::More tests => 2; + +my $proxy_called; +my $parent_called; + +package Parent; + +sub call_me +{ + $parent_called++; +} + +package Proxied; + +@Proxied::ISA = 'Parent'; + +sub new { bless {}, shift } + +package Proxy; + +use SUPER; +use Scalar::Util 'blessed'; + +sub __get_parents +{ + my $self = shift; + my $proxied = $$self; + + return do { no strict 'refs'; @{ blessed( $proxied ) . '::ISA' } }; +} + +sub new +{ + my ($class, $proxied) = @_; + bless \$proxied, $class; +} + +sub call_me +{ + my $self = shift; + $proxy_called++; + return $self->SUPER(); +} + +package main; + +my $proxied = Proxied->new(); +my $proxy = Proxy->new( $proxied ); +$proxy->call_me(); +ok( $proxy_called, 'Proxy should get called' ); +ok( $parent_called, '... and SUPER should find parent' ); diff --git a/t/keep_going.t b/t/keep_going.t new file mode 100644 index 0000000..5b2f6cd --- /dev/null +++ b/t/keep_going.t @@ -0,0 +1,60 @@ +#!perl + +BEGIN +{ + chdir 't' if -d 't'; +} + +use lib '../lib'; + +use strict; +use warnings; + +use Test::More tests => 4; + +# so being able to say super() once is neat, but I want to super all +# the way back up to the root of the tree + +package Grandfather; + +Test::More->import(); + +sub foo +{ + pass( "Called on the Grandfather" ); + return 42; +} + +package Father; + +Test::More->import(); + +use SUPER; +use base qw( Grandfather ); +my $called; + +sub foo +{ + die "Recursed on Father (should have called Grandfather)" + if ++$called > 1; + + pass( "Called on the Father" ); + super; +} + +package Son; + +Test::More->import(); + +use SUPER; +use base qw( Father ); + +sub foo +{ + pass( "Called on the Son" ); + super; +} + +package main; + +is( Son->foo(), 42, "called the Son->Father->Grandfather" ); diff --git a/t/keep_going_manual.t b/t/keep_going_manual.t new file mode 100644 index 0000000..5e1e4af --- /dev/null +++ b/t/keep_going_manual.t @@ -0,0 +1,68 @@ +#!perl + +BEGIN +{ + chdir 't' if -d 't'; +} + +use lib '../lib'; + +use strict; +use warnings; + +use Test::More tests => 7; + +# Being able to say SUPER() once is neat, but I want to super all +# the way back up to the root of the tree, passing different arguments + +package Grandfather; + +Test::More->import(); + +sub foo +{ + my ($self, $from) = @_; + pass( 'Called on the Grandfather' ); + is( $from, 'Father', '... from the father' ); + return __PACKAGE__; +} + +package Father; + +Test::More->import(); + +use SUPER; +use base qw( Grandfather ); +my $called; + +sub foo +{ + my ($self, $from) = @_; + die "Recursed on Father (should have called Grandfather)" + if ++$called > 1; + + pass( 'Called on the Father' ); + is( $from, 'Son', '... from the son' ); + my $super_class = $self->SUPER( __PACKAGE__ ); + is( $super_class, 'Grandfather', '... (whose parent is the grandfather)' ); + return __PACKAGE__; +} + +package Son; + +Test::More->import(); + +use SUPER; +use base qw( Father ); + +sub foo +{ + my $self = shift; + pass( 'Called on the Son' ); + my $super_class = $self->SUPER( __PACKAGE__ ); + is( $super_class, 'Father', '... (whose parent is the father)' ); +} + +package main; + +Son->foo();