diff --git a/Build.PL b/Build.PL new file mode 100644 index 0000000..6d07a99 --- /dev/null +++ b/Build.PL @@ -0,0 +1,10 @@ +use strict; +use Module::Build; + +Module::Build->new + ( module_name => 'Class::Factory::Util', + license => 'perl', + sign => 1, + create_readme => 1, + create_makefile_pl => 'passthrough', + )->create_build_script(); diff --git a/Changes b/Changes new file mode 100644 index 0000000..c404b5b --- /dev/null +++ b/Changes @@ -0,0 +1,34 @@ +1.7 2007-03-30 + +- Switch to Module::Build. + +- Add pod-related tests. + +- Make distro more modern. + + +1.6 2003-08-23 + +- Scanning for subclasses now looks at @INC, instead of just the + calling module's directory. Patch from Iain Truskett. + + +1.5 2003-07-30 + +- Fix a mistake in the documentation's SYNOPSIS. Reported by Jay + Bonci. + +- Added COPYRIGHT and SUPPORT sections to the docs, as well as a + LICENSE file to the distro. Thanks to Jay Bonci for reminding me + that actually including a license is a good idea ;) + +1.4 2003-02-21 + +- Add subclasses() function for backwards compatibility. But it's + deprecated ;) + +1.3 2003-02-14 + +- New maintainer - Dave Rolsky + +- Internals and docs agree, and it all works. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9d0305b --- /dev/null +++ b/LICENSE @@ -0,0 +1,383 @@ +Terms of Perl 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 General Public License (GPL) +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, +Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute +verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU 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. This General Public License applies to most of +the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for this service if you wish), 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 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 show +them these terms so they know 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. + +Finally, any free program is threatened constantly by software patents. We wish +to avoid the danger that redistributors of a free program will individually obtain +patent licenses, in effect making the program proprietary. To prevent this, we +have made it clear that any patent must be licensed for everyone's free use or +not licensed at all. + +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 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 +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or translated +into another language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is not +restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +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 License and to the absence of any +warranty; and give any other recipients of the Program a copy of this License +along with the Program. + +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. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such +modifications or work under the terms of Section 1 above, provided that you also +meet all of these conditions: + +a) You must cause the modified files to carry prominent notices stating that you +changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or in +part contains or is derived from the Program or any part thereof, to be licensed +as a whole at no charge to all third parties under the terms of this License. + +c) If the modified program normally reads commands interactively when run, you +must cause it, when started running for such interactive use in the most ordinary +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 License. (Exception: if the +Program itself is interactive but does not normally print such an announcement, +your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, +and its terms, do not apply to those sections when you distribute them as +separate works. But when you distribute the same sections as part of a whole +which is a work based on the Program, the distribution of the whole must be on +the terms of this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to +work written entirely by you; rather, the intent is to exercise the right to control +the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 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 Sections 1 and 2 above on a +medium customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give any +third party, for a charge no more than your cost of physically performing source +distribution, a complete machine-readable copy of the corresponding source +code, to be distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute +corresponding source code. (This alternative is allowed only for noncommercial +distribution and only if you received the program in object code or executable +form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all the +source code for all modules it contains, plus any associated interface definition +files, plus the scripts used to control compilation and installation of the +executable. However, as a special exception, the source code distributed need +not include anything that is normally distributed (in either source or binary form) +with the major components (compiler, kernel, and so on) of the operating system +on which the executable runs, unless that component itself accompanies the +executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so long +as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not accept +this License. Therefore, by modifying or distributing 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 for copying, distributing or modifying the +Program or works based on it. + +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. You are not responsible for enforcing compliance by third parties +to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement +or for any other reason (not limited to patent issues), conditions are imposed on +you (whether by court order, agreement or otherwise) that contradict the +conditions of this License, they do not excuse you from the conditions of this +License. If you cannot distribute so as to satisfy simultaneously your obligations +under this License and any other pertinent obligations, then as a consequence +you may not distribute the Program at all. For example, if a patent license would +not permit royalty-free redistribution of the Program by all those who receive +copies directly or indirectly through you, then the only way you could satisfy +both it and this License would be to refrain entirely from distribution of the +Program. + +If any portion of this section is held invalid or unenforceable under any particular +circumstance, the balance of the section is intended to apply and the section as +a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other +property right claims or to contest validity of any such claims; this section has +the sole purpose of protecting the integrity of the free software distribution +system, which is implemented by public license practices. Many people have +made generous contributions to the wide range of software distributed through +that system in reliance on consistent application of that system; it is up to the +author/donor to decide if he or she is willing to distribute software through any +other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries +either by patents or by copyrighted interfaces, the original copyright holder who +places the Program under this License may add an explicit geographical +distribution limitation excluding those countries, so that distribution is permitted +only in or among countries not thus excluded. In such case, this License +incorporates the limitation as if written in the body of this License. + +9. 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 this 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 this License, you may choose any version ever +published by the Free Software Foundation. + +10. 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 + +11. 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. + +12. 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 + + +--------------------------------------------------------------------------- + +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. Aggregation of this Package with a commercial distribution is always permitted +provided that the use of this Package is embedded; that is, when no overt attempt +is made to make this Package's interfaces visible to the end user of the +commercial distribution. Such use shall not be construed as a distribution of +this Package. + +9. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +10. 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..b2cc33e --- /dev/null +++ b/MANIFEST @@ -0,0 +1,16 @@ +Build.PL +Changes +lib/Class/Factory/Util.pm +LICENSE +Makefile.PL +MANIFEST This list of files +META.yml +README +t/01test.t +t/lib/Factory.pm +t/lib/Factory/Bar.pm +t/lib/Factory/Foo.pm +t/lib2/Factory/Baz.pm +t/pod-coverage.t +t/pod.t +SIGNATURE Added here by Module::Build diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..edead0f --- /dev/null +++ b/META.yml @@ -0,0 +1,20 @@ +--- +name: Class-Factory-Util +version: 1.7 +author: + - 'Dave Rolsky, .' + - |- + Removed from Alzabo and packaged by Terrence Brannon, + . +abstract: Provide utility methods for factory classes +license: perl +resources: + license: http://dev.perl.org/licenses/ +provides: + Class::Factory::Util: + file: lib/Class/Factory/Util.pm + version: 1.7 +generated_by: Module::Build version 0.2806 +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.2.html + version: 1.2 diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..192903a --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,31 @@ +# Note: this file was auto-generated by Module::Build::Compat version 0.03 + + unless (eval "use Module::Build::Compat 0.02; 1" ) { + print "This module requires Module::Build to install itself.\n"; + + require ExtUtils::MakeMaker; + my $yn = ExtUtils::MakeMaker::prompt + (' Install Module::Build now from CPAN?', 'y'); + + unless ($yn =~ /^y/i) { + die " *** Cannot install without Module::Build. Exiting ...\n"; + } + + require Cwd; + require File::Spec; + require CPAN; + + # Save this 'cause CPAN will chdir all over the place. + my $cwd = Cwd::cwd(); + + CPAN::Shell->install('Module::Build::Compat'); + CPAN::Shell->expand("Module", "Module::Build::Compat")->uptodate + or die "Couldn't install Module::Build, giving up.\n"; + + chdir $cwd or die "Cannot chdir() back to $cwd: $!"; + } + eval "use Module::Build::Compat 0.02; 1" or die $@; + + Module::Build::Compat->run_build_pl(args => \@ARGV); + require Module::Build; + Module::Build::Compat->write_makefile(build_class => 'Module::Build'); diff --git a/README b/README new file mode 100644 index 0000000..add449d --- /dev/null +++ b/README @@ -0,0 +1,42 @@ +NAME + Class::Factory::Util - Provide utility methods for factory classes + +SYNOPSIS + package My::Class; + + use Class::Factory::Util; + + My::Class->subclasses; + +DESCRIPTION + This module exports a method that is useful for factory classes. + +USAGE + When this module is loaded, it creates a method in its caller named + "subclasses()". This method returns a list of the available subclasses + for the package. It does this by looking in @INC as well as the + directory containing the caller, and finding any modules in the + immediate subdirectories of the calling module. + + So if you have the modules "Foo::Base", "Foo::Base::Bar", and + "Foo::Base::Baz", then the return value of "Foo::Base->subclasses()" + would be "Bar" and "Baz". + +SUPPORT + Please submit bugs to the CPAN RT system at + http://rt.cpan.org/NoAuth/ReportBug.html?Queue=class-factory-util or via + email at bug-class-factory-util@rt.cpan.org. + +AUTHOR + Dave Rolsky, . + + Removed from Alzabo and packaged by Terrence Brannon, . + +COPYRIGHT + Copyright (c) 2003-2007 David Rolsky. All rights reserved. This program + is free software; you can redistribute it and/or modify it under the + same terms as Perl itself. + + The full text of the license can be found in the LICENSE file included + with this module. + diff --git a/SIGNATURE b/SIGNATURE new file mode 100644 index 0000000..4e5edb9 --- /dev/null +++ b/SIGNATURE @@ -0,0 +1,38 @@ +This file contains message digests of all files listed in MANIFEST, +signed via the Module::Signature module, version 0.55. + +To verify the content in this distribution, first make sure you have +Module::Signature installed, then type: + + % cpansign -v + +It will check each file's integrity, as well as the signature's +validity. If "==> Signature verified OK! <==" is not displayed, +the distribution may already have been compromised, and you should +not run its Makefile.PL or Build.PL. + +-----BEGIN PGP SIGNED MESSAGE----- +Hash: SHA1 + +SHA1 3c7a791e918985d2d4cd281223cb6dc2217f6478 Build.PL +SHA1 5d7234e76eb74b27031e88ad0a746ad5c5ce7d59 Changes +SHA1 f235ba4160673bcb7c9d58c2f09dbc7fc0efadea LICENSE +SHA1 c35ebc7825c2e49bbac4601d134597b6806ca2bb MANIFEST +SHA1 ef14f142b65c858552dcdb6559ba40c2f2a3041e META.yml +SHA1 cd14ada78fb37a0d926edd86eddcdf7f939de582 Makefile.PL +SHA1 bcc115958a19379d46de17c22ec2be5872badf9d README +SHA1 e6ed8106b5a532974e305c19c114f0b82308a748 lib/Class/Factory/Util.pm +SHA1 a8fc7e74ce11e36d53b5e87f806b93633daf760e t/01test.t +SHA1 bc7c8e933147de3220a0477f91cff32fd9fe5e2e t/lib/Factory.pm +SHA1 4235e13ff5495a5e785d3db7bf0fc3c9534e9686 t/lib/Factory/Bar.pm +SHA1 4611fe16e4a09b4736e0b684e73da0aa9492b41c t/lib/Factory/Foo.pm +SHA1 59707665bd917eed6b29106b00f4a6fa5ba213e6 t/lib2/Factory/Baz.pm +SHA1 cbb62f546315d473bf4677b18e416452689a8134 t/pod-coverage.t +SHA1 37307177c8305132ecc2c9b0778f53fa48f1691e t/pod.t +-----BEGIN PGP SIGNATURE----- +Version: GnuPG v1.4.6 (GNU/Linux) + +iD8DBQFGDTBz3Or3ZzQuifMRAvq9AJ9dbtDqEC6KSapQAzGdJ+i1TtTuXQCgtW1Y +ew4ppWSceh8KOYbdfgjlCJ4= +=2kyo +-----END PGP SIGNATURE----- diff --git a/lib/Class/Factory/Util.pm b/lib/Class/Factory/Util.pm new file mode 100644 index 0000000..1bae8d0 --- /dev/null +++ b/lib/Class/Factory/Util.pm @@ -0,0 +1,118 @@ +package Class::Factory::Util; + +use strict; +use vars qw($VERSION); + +use Carp qw(confess); + +$VERSION = '1.7'; + +1; + +sub import +{ + my $caller = caller(0); + + { + no strict 'refs'; + *{"${caller}::subclasses"} = \&_subclasses; + } +} + +# deprecated +sub subclasses { _subclasses(@_) } + +sub _subclasses +{ + my $base = shift; + + $base =~ s,::,/,g; + + my %dirs = map { $_ => 1 } @INC; + + my $dir = substr( $INC{"$base.pm"}, 0, (length $INC{"$base.pm"}) - 3 ); + + $dirs{$dir} = 1; + + my @packages = map { _scandir( "$_/$base" ) } keys %dirs; + + # Make list of unique elements + my %packages = map { $_ => 1 } @packages; + + return sort keys %packages; +} + +sub _scandir +{ + my $dir = shift; + + return unless -d $dir; + + opendir DIR, $dir + or confess ("Cannot open directory $dir: $!"); + + my @packages = + ( map { substr($_, 0, length($_) - 3) } + grep { substr($_, -3) eq '.pm' && -f "$dir/$_" } + readdir DIR + ); + + closedir DIR + or confess("Cannot close directory $dir: $!" ); + + return @packages; +} + +__END__ + +=head1 NAME + +Class::Factory::Util - Provide utility methods for factory classes + +=head1 SYNOPSIS + + package My::Class; + + use Class::Factory::Util; + + My::Class->subclasses; + +=head1 DESCRIPTION + +This module exports a method that is useful for factory classes. + +=head1 USAGE + +When this module is loaded, it creates a method in its caller named +C. This method returns a list of the available +subclasses for the package. It does this by looking in C<@INC> as +well as the directory containing the caller, and finding any modules +in the immediate subdirectories of the calling module. + +So if you have the modules "Foo::Base", "Foo::Base::Bar", and +"Foo::Base::Baz", then the return value of C<< Foo::Base->subclasses() +>> would be "Bar" and "Baz". + +=head1 SUPPORT + +Please submit bugs to the CPAN RT system at +http://rt.cpan.org/NoAuth/ReportBug.html?Queue=class-factory-util or +via email at bug-class-factory-util@rt.cpan.org. + +=head1 AUTHOR + +Dave Rolsky, . + +Removed from Alzabo and packaged by Terrence Brannon, +. + +=head1 COPYRIGHT + +Copyright (c) 2003-2007 David Rolsky. All rights reserved. This +program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +The full text of the license can be found in the LICENSE file included +with this module. + +=cut diff --git a/t/01test.t b/t/01test.t new file mode 100644 index 0000000..cf4edc8 --- /dev/null +++ b/t/01test.t @@ -0,0 +1,21 @@ +use strict; + +use Test; + +plan tests => 5; + +require Class::Factory::Util; + +ok(1); + +use lib 'lib', 't/lib', 't/lib2'; + +use Factory; + +my @s = sort Factory->subclasses; + +ok( scalar @s, 3 ); + +ok( $s[0], 'Bar' ); +ok( $s[1], 'Baz' ); +ok( $s[2], 'Foo' ); diff --git a/t/lib/Factory.pm b/t/lib/Factory.pm new file mode 100644 index 0000000..708f12a --- /dev/null +++ b/t/lib/Factory.pm @@ -0,0 +1,7 @@ +package Factory; + +use strict; + +use Class::Factory::Util; + +1; diff --git a/t/lib/Factory/Bar.pm b/t/lib/Factory/Bar.pm new file mode 100644 index 0000000..471683e --- /dev/null +++ b/t/lib/Factory/Bar.pm @@ -0,0 +1,3 @@ +package Factory::Bar; + +1; diff --git a/t/lib/Factory/Foo.pm b/t/lib/Factory/Foo.pm new file mode 100644 index 0000000..2d5053b --- /dev/null +++ b/t/lib/Factory/Foo.pm @@ -0,0 +1,3 @@ +package Factory::Foo; + +1; diff --git a/t/lib2/Factory/Baz.pm b/t/lib2/Factory/Baz.pm new file mode 100644 index 0000000..10250d5 --- /dev/null +++ b/t/lib2/Factory/Baz.pm @@ -0,0 +1,3 @@ +package Factory::Baz; + +1; diff --git a/t/pod-coverage.t b/t/pod-coverage.t new file mode 100644 index 0000000..983bdca --- /dev/null +++ b/t/pod-coverage.t @@ -0,0 +1,5 @@ +use Test::More; +eval "use Test::Pod::Coverage 1.04"; +plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD coverage" + if $@; +all_pod_coverage_ok( { trustme => [ qr/^subclasses$/ ] } ); diff --git a/t/pod.t b/t/pod.t new file mode 100644 index 0000000..fa2425d --- /dev/null +++ b/t/pod.t @@ -0,0 +1,4 @@ +use Test::More; +eval "use Test::Pod 1.14"; +plan skip_all => "Test::Pod 1.14 required for testing POD" if $@; +all_pod_files_ok();