Pod-Tests-1.19/0000755000175100017510000000000011036337431013117 5ustar adamadam00000000000000Pod-Tests-1.19/README0000644000175100017510000001273211036337145014006 0ustar adamadam00000000000000NAME Pod::Tests - Extracts embedded tests and code examples from POD SYNOPSIS use Pod::Tests; $p = Pod::Tests->new; $p->parse_file($file); $p->parse_fh($fh); $p->parse(@code); my @examples = $p->examples; my @tests = $p->tests; foreach my $example (@examples) { print "The example: '$example->{code}' was on line ". "$example->{line}\n"; } my @test_code = $p->build_tests(@tests); my @example_test_code = $p->build_examples(@examples); DESCRIPTION This is a specialized POD viewer to extract embedded tests and code examples from POD. It doesn't do much more than that. pod2test does the useful work. Parsing After creating a Pod::Tests object, you parse the POD by calling one of the available parsing methods documented below. You can call parse as many times as you'd like, all examples and tests found will stack up inside the object. Testing Once extracted, the tests can be built into stand-alone testing code using the build_tests() and build_examples() methods. However, it is recommended that you first look at the pod2test program before embarking on this. Methods new $parser = Pod::Tests->new; Returns a new Pod::Tests object which lets you read tests and examples out of a POD document. parse $parser->parse(@code); Finds the examples and tests in a bunch of lines of Perl @code. Once run they're available via examples() and testing(). parse_file $file $parser->parse_file($filename); Just like parse() except it works on a file. parse_fh $fh $parser->parse_fh($fh); Just like parse() except it works on a filehandle. tests @testing = $parser->tests; Returns the tests found in the parsed POD documents. Each element of @testing is a hash representing an individual testing block and contains information about that block. $test->{code} actual testing code $test->{line} line from where the test was taken examples @examples = $parser->examples; Returns the examples found in the parsed POD documents. Each element of @examples is a hash representing an individual testing block and contains information about that block. $test->{code} actual testing code $test->{line} line from where the test was taken build_tests my @code = $p->build_tests(@tests); Returns a code fragment based on the given embedded @tests. This fragment is expected to print the usual "ok/not ok" (or something Test::Harness can read) or nothing at all. Typical usage might be: my @code = $p->build_tests($p->tests); This fragment is suitable for placing into a larger test script. NOTE Look at pod2test before embarking on your own test building. build_examples my @code = $p->build_examples(@examples); Similar to build_tests(), it creates a code fragment which tests the basic validity of your example code. Essentially, it just makes sure it compiles. If your example has an "example testing" block associated with it it will run the the example code and the example testing block. EXAMPLES Here's the simplest example, just finding the tests and examples in a single module. my $p = Pod::Tests->new; $p->parse_file("path/to/Some.pm"); And one to find all the tests and examples in a directory of files. This illustrates building a set of examples and tests through multiple calls to parse_file(). my $p = Pod::Tests->new; opendir(PODS, "path/to/some/lib/") || die $!; while( my $file = readdir PODS ) { $p->parse_file($file); } printf "Found %d examples and %d tests in path/to/some/lib\n", scalar $p->examples, scalar $p->tests; Finally, an example of parsing your own POD using the DATA filehandle. use Fcntl qw(:seek); my $p = Pod::Tests->new; # Seek to the beginning of the current code. seek(DATA, 0, SEEK_SET) || die $!; $p->parse_fh(\*DATA); SUPPORT This module has been replaced by the newer Test::Inline 2. Most testing code that currently works with "pod2test" should continue to work with the new version. The most notable exceptions are "=for begin" and "=for end", which are deprecated. After upgrading, Pod::Tests and "pod2test" were split out to provide a compatibility package for legacy code. "pod2test" will stay in CPAN, but should remain unchanged indefinately, with the exception of any minor bugs that will require squishing. Bugs in this dist should be reported via the following URL. Feature requests should not be submitted, as further development is now occuring in Test::Inline. AUTHOR Michael G Schwern Adam Kennedy SEE ALSO Test::Inline pod2test, Perl 6 RFC 183 http://dev.perl.org/rfc183.pod Short set of slides on Pod::Tests http://www.pobox.com/~schwern/talks/Embedded_Testing/ Similar schemes can be found in SelfTest and Test::Unit. COPYRIGHT Copyright 2005 - 2008 Adam Kennedy. Copyright 2001 - 2003 Michael G Schwern. 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. Pod-Tests-1.19/Makefile.PL0000644000175100017510000000063411036337145015076 0ustar adamadam00000000000000use inc::Module::Install 0.75; all_from 'lib/Pod/Tests.pm'; requires 'Test::More' => '0.33'; requires 'Test::Harness' => '1.22'; install_script 'pod2test'; # Generate tests via pod2test to be run later print "Running pod2test...\n"; system(qq{$^X "-Ilib" script/pod2test t/02_tests.t t/03_pod2test.t}); system(qq{$^X "-Ilib" script/pod2test t/foo t/i_should_not_be_written.t}); WriteAll; Pod-Tests-1.19/LICENSE0000644000175100017510000004737111036337145014142 0ustar adamadam00000000000000 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. 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 Pod-Tests-1.19/META.yml0000644000175100017510000000077111036337424014377 0ustar adamadam00000000000000--- abstract: 'Extracts embedded tests and code examples from POD' author: - 'Michael G Schwern ' distribution_type: module generated_by: 'Module::Install version 0.76' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 module_name: Pod::Tests name: Pod-Tests no_index: directory: - inc - t requires: Test::Harness: 1.22 Test::More: 0.33 perl: 5.005 resources: license: http://dev.perl.org/licenses/ version: 1.19 Pod-Tests-1.19/MANIFEST0000644000175100017510000000065411036337425014260 0ustar adamadam00000000000000Changes inc/Module/Install.pm inc/Module/Install/Base.pm inc/Module/Install/Can.pm inc/Module/Install/Fetch.pm inc/Module/Install/Makefile.pm inc/Module/Install/Metadata.pm inc/Module/Install/Win32.pm inc/Module/Install/WriteAll.pm lib/Pod/Tests.pm LICENSE Makefile.PL MANIFEST This list of files META.yml README script/pod2test t/01_compile.t t/02_tests.t t/03_pod2test.t t/04_empty.t t/97_meta.t t/98_pod.t t/99_pmv.t t/foo Pod-Tests-1.19/lib/0000755000175100017510000000000011036337431013665 5ustar adamadam00000000000000Pod-Tests-1.19/lib/Pod/0000755000175100017510000000000011036337431014407 5ustar adamadam00000000000000Pod-Tests-1.19/lib/Pod/Tests.pm0000644000175100017510000002667111036337145016065 0ustar adamadam00000000000000package Pod::Tests; =pod =head1 NAME Pod::Tests - Extracts embedded tests and code examples from POD =head1 SYNOPSIS use Pod::Tests; $p = Pod::Tests->new; $p->parse_file($file); $p->parse_fh($fh); $p->parse(@code); my @examples = $p->examples; my @tests = $p->tests; foreach my $example (@examples) { print "The example: '$example->{code}' was on line ". "$example->{line}\n"; } my @test_code = $p->build_tests(@tests); my @example_test_code = $p->build_examples(@examples); =head1 DESCRIPTION This is a specialized POD viewer to extract embedded tests and code examples from POD. It doesn't do much more than that. pod2test does the useful work. =head2 Parsing After creating a Pod::Tests object, you parse the POD by calling one of the available parsing methods documented below. You can call parse as many times as you'd like, all examples and tests found will stack up inside the object. =head2 Testing Once extracted, the tests can be built into stand-alone testing code using the build_tests() and build_examples() methods. However, it is recommended that you first look at the pod2test program before embarking on this. =head2 Methods =cut use 5.005; use strict; use vars qw($VERSION); BEGIN { $VERSION = '1.19'; } ##################################################################### # Constructor =pod =head2 new $parser = Pod::Tests->new; Returns a new Pod::Tests object which lets you read tests and examples out of a POD document. =cut sub new { my ($proto) = shift; my ($class) = ref $proto || $proto; my $self = bless {}, $class; $self->_init; $self->{example} = []; $self->{testing} = []; return $self; } ##################################################################### # Pod::Tests Methods =pod =head2 parse $parser->parse(@code); Finds the examples and tests in a bunch of lines of Perl @code. Once run they're available via examples() and testing(). =cut sub parse { my ($self) = shift; $self->_init; foreach (@_) { if ( /^=(\w.*)/ and $self->{_sawblank} and !$self->{_inblock}) { $self->{_inpod} = 1; my ($tag, $for, $pod) = split /\s+/, $1, 3; if ( $tag eq 'also' ) { $tag = $for; ($for, $pod) = split /\s+/, $pod, 2; } if ( $tag eq 'for' ) { $self->_beginfor($for, $pod); } elsif ( $tag eq 'begin' ) { $self->_beginblock($for); } elsif ( $tag eq 'cut' ) { $self->{_inpod} = 0; } $self->{_sawblank} = 0; } elsif ( $self->{_inpod} ) { if ( (/^=(?:also )?end (\S+)/ or /^=for (\S+) end\b/) and $self->{_inblock} eq $1 ) { $self->_endblock; $self->{_sawblank} = 0; } else { if ( /^\s*$/ ) { $self->_endfor() if $self->{_infor}; $self->{_sawblank} = 1; } elsif ( !$self->{_inblock} and !$self->{_infor} ) { $self->_sawsomethingelse; $self->{_sawblank} = 0; } $self->{_currpod} .= $_; } } else { if ( /^\s*$/ ) { $self->{_sawblank} = 1; } else { $self->_sawsomethingelse; } } $self->{_linenum}++; } $self->_endfor; push @{$self->{example}}, @{$self->{_for}{example}}; push @{$self->{testing}}, @{$self->{_for}{testing}}; push @{$self->{example_testing}}, @{$self->{_for}{example_testing}}; } #=head2 _init # # $parser->_init; # #Initializes the state of the parser, but not the rest of the object. #Should be called before each parse of new POD. sub _init { my ($self) = shift; $self->{_sawblank} = 1; $self->{_inblock} = 0; $self->{_infor} = 0; $self->{_inpod} = 0; $self->{_linenum} = 1; $self->{_for} = { example => [], testing => [], example_testing => [], }; } sub _sawsomethingelse { my ($self) = shift; $self->{_lasttype} = 0; } #=head2 _beginfor # # $parser->_beginfor($format, $pod); # #Indicates that a =for tag has been seen. $format (what immediately #follows '=for'), and $pod is the rest of the POD on that line. sub _beginfor { my ($self, $for, $pod) = @_; if ( $for eq 'example' and defined $pod ) { if ( $pod eq 'begin' ) { return $self->_beginblock($for); } elsif ( $pod eq 'end' ) { return $self->_endlblock; } } $self->{_infor} = $for; $self->{_currpod} = $pod; $self->{_forstart} = $self->{_linenum}; } #=head2 _endfor # # $parser->endfor; # #Indicates that the current =for block has ended. sub _endfor { my ($self) = shift; my $pod = { code => $self->{_currpod}, # Skip over the "=for" line line => $self->{_forstart} + 1, }; if ( $self->{_infor} ) { if ( $self->{_infor} eq 'example_testing' ) { $self->_example_testing($pod); } if ( $self->{_infor} eq $self->{_lasttype}) { my $last_for = ${$self->{_for}{$self->{_infor}}}[-1]; $last_for->{code} .= "\n" x ($pod->{line} - ($last_for->{line} + $last_for->{code} =~ tr/\n//) ); $last_for->{code} .= $self->{_currpod}; } else { push @{$self->{_for}{$self->{_infor}}}, $pod; } } $self->{_lasttype} = $self->{_infor}; $self->{_infor} = 0; } #=head2 _beginblock # # $parser->_beginblock($format); # #Indicates that the parser saw a =begin tag. $format is the word #immediately following =begin. sub _beginblock { my ($self, $for) = @_; $self->{_inblock} = $for; $self->{_currpod} = ''; $self->{_blockstart} = $self->{_linenum}; } #=head2 _endblock # # $parser->_endblock # #Indicates that the parser saw an =end tag for the current block. sub _endblock { my ($self) = shift; my $pod = { code => $self->{_currpod}, # Skip over the "=begin" line => $self->{_blockstart} + 1, }; if ( $self->{_inblock} ) { if ( $self->{_inblock} eq 'example_testing' ) { $self->_example_testing($self->{_currpod}); } if ( $self->{_inblock} eq $self->{_lasttype}) { my $last_for = ${$self->{_for}{$self->{_inblock}}}[-1]; $last_for->{code} .= "\n" x ($pod->{line} - ($last_for->{line} + $last_for->{code} =~ tr/\n//) ); $last_for->{code} .= $self->{_currpod}; } else { push @{$self->{_for}{$self->{_inblock}}}, $pod; } } $self->{_lasttype} = $self->{_inblock}; $self->{_inblock} = 0; } sub _example_testing { my ($self, $test) = @_; my $last_example = ${$self->{_for}{example}}[-1]; $last_example->{code} .= "\n" x ($test->{line} - ($last_example->{line} + $last_example->{code} =~ tr/\n//) ); $last_example->{testing} = $test->{code}; } =pod =head2 parse_file $file $parser->parse_file($filename); Just like parse() except it works on a file. =cut sub parse_file { my ($self, $file) = @_; unless( open(POD, $file) ) { warn "Couldn't open POD file $file: $!\n"; return; } return $self->parse_fh(\*POD); } =pod =head2 parse_fh $fh $parser->parse_fh($fh); Just like parse() except it works on a filehandle. =cut sub parse_fh { my ($self, $fh) = @_; # Yeah, this is inefficient. Sue me. return $self->parse(<$fh>); } =pod =head2 tests @testing = $parser->tests; Returns the tests found in the parsed POD documents. Each element of @testing is a hash representing an individual testing block and contains information about that block. $test->{code} actual testing code $test->{line} line from where the test was taken =cut sub tests { my ($self) = shift; return @{$self->{testing}}; } =pod =head2 examples @examples = $parser->examples; Returns the examples found in the parsed POD documents. Each element of @examples is a hash representing an individual testing block and contains information about that block. $test->{code} actual testing code $test->{line} line from where the test was taken =cut sub examples { my ($self) = shift; return @{$self->{example}}; } =pod =head2 build_tests my @code = $p->build_tests(@tests); Returns a code fragment based on the given embedded @tests. This fragment is expected to print the usual "ok/not ok" (or something Test::Harness can read) or nothing at all. Typical usage might be: my @code = $p->build_tests($p->tests); This fragment is suitable for placing into a larger test script. B Look at pod2test before embarking on your own test building. =cut sub build_tests { my ($self, @tests) = @_; my @code = (); foreach my $test (@tests) { my $file = $self->{file} || ''; push @code, <{line} $file $test->{code} undef \$main::_STDOUT_; undef \$main::_STDERR_; } CODE } return @code; } =pod =head2 build_examples my @code = $p->build_examples(@examples); Similar to build_tests(), it creates a code fragment which tests the basic validity of your example code. Essentially, it just makes sure it compiles. If your example has an "example testing" block associated with it it will run the the example code and the example testing block. =cut sub build_examples { my ($self, @examples) = @_; my @code = (); foreach my $example (@examples) { my $file = $self->{file} || ''; push @code, <{line} $file $example->{code}; } }; is(\$@, '', "example from line $example->{line}"); CODE if ( $example->{testing} ) { $example->{code} .= $example->{testing}; push @code, $self->build_tests($example); } push @code, <new; $p->parse_file("path/to/Some.pm"); And one to find all the tests and examples in a directory of files. This illustrates building a set of examples and tests through multiple calls to parse_file(). my $p = Pod::Tests->new; opendir(PODS, "path/to/some/lib/") || die $!; while( my $file = readdir PODS ) { $p->parse_file($file); } printf "Found %d examples and %d tests in path/to/some/lib\n", scalar $p->examples, scalar $p->tests; Finally, an example of parsing your own POD using the DATA filehandle. use Fcntl qw(:seek); my $p = Pod::Tests->new; # Seek to the beginning of the current code. seek(DATA, 0, SEEK_SET) || die $!; $p->parse_fh(\*DATA); =head2 SUPPORT This module has been replaced by the newer L 2. Most testing code that currently works with C should continue to work with the new version. The most notable exceptions are C<=for begin> and C<=for end>, which are deprecated. After upgrading, Pod::Tests and C were split out to provide a compatibility package for legacy code. C will stay in CPAN, but should remain unchanged indefinately, with the exception of any minor bugs that will require squishing. Bugs in this dist should be reported via the following URL. Feature requests should not be submitted, as further development is now occuring in L. L =head1 AUTHOR Michael G Schwern Eschwern@pobox.comE Adam Kennedy Eadamk@cpan.orgE =head1 SEE ALSO L L, Perl 6 RFC 183 http://dev.perl.org/rfc183.pod Short set of slides on Pod::Tests http://www.pobox.com/~schwern/talks/Embedded_Testing/ Similar schemes can be found in L and L. =head1 COPYRIGHT Copyright 2005 - 2008 Adam Kennedy. Copyright 2001 - 2003 Michael G Schwern. 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 Pod-Tests-1.19/Changes0000644000175100017510000000664311036337145014425 0ustar adamadam00000000000000Changes for Perl extension Pod-Tests 1.19 Sat 12 Jul 2008 - Moving to a production version - Changing to Module::Install to simplify maintenance - Updating perl dependency to 5.005 - Updated author tests - Some slight changes to resolve Kwalitee issues - Stopped using MANIFEST for the tests - Various minor whitespace and layout tweaks 0.18 Thu 22 Sep 2005 - Some last minor whitespace changes - Moving to stable build now I have feedback from testers - Reversion to Pod::Tests namespace complete 0.17_01 Sat 17 Sep 2005 - Superceded by Test::Inline 2.0 - For compatibility reasons, split out a Pod-Tests dist from the main Test-Inline dist. This is now Pod::Tests again. - Cleaned up some Pod to reflect the changes. - Various other minor changes from the splitting out process 0.16 Thu 18 Dec 2003 - Fixed binmode on STDOUT/STDERR (thanks Max Maischein) 0.15 Thu 11 Apr 2002 - Hacked in a solution for when code tries to redirect STDOUT or STDERR. The behavior when redirecting STDOUT & STDERR is currently *UNDEFINED* but at least it doesn't blow up. - Off-by-some line number bugs now fixed. Embedded tests should report correct line numbers. __LINE__ should now be correct. 0.14 Thu 28 Feb 2002 - pod2test now provides an $Original_File - Fixed handling of "print STDERR ..." in tests - Fixed $_STDERR_ and $_STDOUT_ so they clear themselves between test blocks (bug reported by Wolfgang Weisselberg) - Some point between Test::More 0.30 and 0.33 it became unsafe to redirect STDOUT/STDERR in tests. This broke pod2test. The minimum version of Test::More has been uped (again, thanks Wolfgang) 0.13 Mon 18 Feb 2002 - pod2test now exits with 1 if it doesn't find any embedded tests 0.12 Mon 12 Nov 2001 - An excuse to upload a new version to CPAN to get this back on the indexes. 0.11 Thu 30 Aug 2001 - Fixed a bug in the testifypods example in Test::Inline::Tutorial - pod2test will not generate a test file for POD which has no embedded tests. - Testing code examples no longer considered experimental 0.10 Wed 29 Aug 2001 - Pod::Tests is now officially named Test::Inline - Pod::Tests::Tutorial renamed Test::Inline::Tutorial - Tests are now lexically isolated - Works back to 5.004 now (Thanks to Tatsuhiko Miyagawa) - "=also begin example" is now "=for example begin" 0.08 Mon 13 Aug 2001 - Now reporting the line numbers of the orignal POD entries in tests. - Put in warning about tests being lexically isolated next version. - Documented that "=also for example" will never work. - Fixed bug with tests at the very end of the file. 0.07 Wed 18 Jul 2001 - oops, forgot to put the tutorial file into the MANIFEST 0.06 Tue 17 Jul 2001 - Added Pod::Tests::Tutorial docs. 0.05 Fri 29 Jun 2001 - Greatly extended the abilities of testing example code. 0.04 Fri 29 Jun 2001 *UNRELEASED* - Fixed a bug with pod2test puking if there's no tests - Added RFC 183 into the dist. - Fixed up testing of example code 0.03 Tue 12 Jun 2001 - Now using Test::More and the no_plan feature in pod2tests - Multiple tests in one block supported! - Actually usable. 0.02 Sun 4 Mar 2001 - Moved build_examples() and build_tests() to Pod::Tests - Fixed and documented multiple parsing. - Added examples - pod2test now installs itself - Documented all private methods (privately) - Removed bogus Pod::Parser dependency - Fixed and tested pod2test 0.01 Thu 1 Feb 2001 - First version escaped Pod-Tests-1.19/t/0000755000175100017510000000000011036337431013362 5ustar adamadam00000000000000Pod-Tests-1.19/t/97_meta.t0000644000175100017510000000107311036337145015017 0ustar adamadam00000000000000#!/usr/bin/perl # Test that our META.yml file matches the current specification. use strict; BEGIN { $| = 1; $^W = 1; } my $MODULE = 'Test::CPAN::Meta 0.12'; # Don't run tests for installs use Test::More; unless ( $ENV{AUTOMATED_TESTING} or $ENV{RELEASE_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Load the testing module eval "use $MODULE"; if ( $@ ) { $ENV{RELEASE_TESTING} ? die( "Failed to load required release-testing module $MODULE" ) : plan( skip_all => "$MODULE not available for testing" ); } meta_yaml_ok(); Pod-Tests-1.19/t/01_compile.t0000644000175100017510000000024211036337145015477 0ustar adamadam00000000000000#!/usr/bin/perl use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 2; ok( $] >= 5.005, 'Perl version is new enough' ); use_ok( 'Pod::Tests' ); Pod-Tests-1.19/t/98_pod.t0000644000175100017510000000116711036337145014660 0ustar adamadam00000000000000#!/usr/bin/perl # Test that the syntax of our POD documentation is valid use strict; BEGIN { $| = 1; $^W = 1; } my @MODULES = ( 'Pod::Simple 3.07', 'Test::Pod 1.26', ); # Don't run tests for installs use Test::More; unless ( $ENV{AUTOMATED_TESTING} or $ENV{RELEASE_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Load the testing modules foreach my $MODULE ( @MODULES ) { eval "use $MODULE"; if ( $@ ) { $ENV{RELEASE_TESTING} ? die( "Failed to load required release-testing module $MODULE" ) : plan( skip_all => "$MODULE not available for testing" ); } } all_pod_files_ok(); Pod-Tests-1.19/t/04_empty.t0000644000175100017510000000105711036337145015215 0ustar adamadam00000000000000#!/usr/bin/perl use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 6; # Changes is just a convenient file with no tests in it. my $out = `$^X "-Ilib" script/pod2test Changes`; is( $?/256, 1, 'pod2test exited with 1' ); is( $out, '', ' and outputed nothing' ); ok( !-e 't/foofer', 'dummy pod2test output file doesnt exist' ); $out = `$^X "-Ilib" script/pod2test Changes t/foofer`; is( $?/256, 1, 'pod2test exited with 1' ); is( $out, '', ' and outputed nothing' ); ok( !-e 't/foofer', ' and didnt generate a file' ); Pod-Tests-1.19/t/03_pod2test.t0000644000175100017510000000772211036337425015630 0ustar adamadam00000000000000#!/usr/bin/perl -w use Test::More 'no_plan'; package Catch; sub TIEHANDLE { my($class, $var) = @_; return bless { var => $var }, $class; } sub PRINT { my($self) = shift; ${'main::'.$self->{var}} .= join '', @_; } sub OPEN {} # XXX Hackery in case the user redirects sub CLOSE {} # XXX STDERR/STDOUT. This is not the behavior we want. sub READ {} sub READLINE {} sub GETC {} sub BINMODE {} my $Original_File = 't/02_tests.t'; package main; # pre-5.8.0's warns aren't caught by a tied STDERR. $SIG{__WARN__} = sub { $main::_STDERR_ .= join '', @_; }; tie *STDOUT, 'Catch', '_STDOUT_' or die $!; tie *STDERR, 'Catch', '_STDERR_' or die $!; { undef $main::_STDOUT_; undef $main::_STDERR_; #line 95 t/02_tests.t ok(2+2 == 4); is( __LINE__, 96 ); undef $main::_STDOUT_; undef $main::_STDERR_; } { undef $main::_STDOUT_; undef $main::_STDERR_; #line 107 t/02_tests.t my $foo = 0; is( __LINE__, 108 ); ok( !$foo, 'foo is false' ); ok( $foo == 0, 'foo is zero' ); undef $main::_STDOUT_; undef $main::_STDERR_; } { undef $main::_STDOUT_; undef $main::_STDERR_; #line 184 t/02_tests.t use File::Spec; is( $Original_File, File::Spec->catfile(qw(t 02_tests.t)) ); is( __LINE__, 188, 'line in =for testing' ); is( __LINE__, 192, 'line in =begin/end testing' ); undef $main::_STDOUT_; undef $main::_STDERR_; } undef $main::_STDOUT_; undef $main::_STDERR_; eval q{ my $example = sub { local $^W = 0; #line 117 t/02_tests.t # This is an example. 2+2 == 4; 5+5 == 10; ; } }; is($@, '', "example from line 117"); undef $main::_STDOUT_; undef $main::_STDERR_; undef $main::_STDOUT_; undef $main::_STDERR_; eval q{ my $example = sub { local $^W = 0; #line 127 t/02_tests.t sub mygrep (&@) { } mygrep { $_ eq 'bar' } @stuff ; } }; is($@, '', "example from line 127"); undef $main::_STDOUT_; undef $main::_STDERR_; undef $main::_STDOUT_; undef $main::_STDERR_; eval q{ my $example = sub { local $^W = 0; #line 135 t/02_tests.t my $result = 2 + 2; ; } }; is($@, '', "example from line 135"); { undef $main::_STDOUT_; undef $main::_STDERR_; #line 135 t/02_tests.t my $result = 2 + 2; ok( $result == 4, 'addition works' ); is( __LINE__, 142 ); undef $main::_STDOUT_; undef $main::_STDERR_; } undef $main::_STDOUT_; undef $main::_STDERR_; undef $main::_STDOUT_; undef $main::_STDERR_; eval q{ my $example = sub { local $^W = 0; #line 147 t/02_tests.t local $^W = 1; print "Hello, world!\n"; print STDERR "Beware the Ides of March!\n"; warn "Really, we mean it\n"; ; } }; is($@, '', "example from line 147"); { undef $main::_STDOUT_; undef $main::_STDERR_; #line 147 t/02_tests.t local $^W = 1; print "Hello, world!\n"; print STDERR "Beware the Ides of March!\n"; warn "Really, we mean it\n"; is( $_STDERR_, <new; $p->parse_fh(*DATA); my @tests = $p->tests; my @examples = $p->examples; is( @tests, 3, 'saw tests' ); is( @examples, 7, 'saw examples' ); is( $tests[0]{code}, <<'POD', 'saw =for testing' ); ok(2+2 == 4); is( __LINE__, 96 ); POD is( $tests[1]{code}, <<'POD', 'saw testing block' ); my $foo = 0; is( __LINE__, 108 ); ok( !$foo, 'foo is false' ); ok( $foo == 0, 'foo is zero' ); POD is( $examples[0]{code}, <<'POD', 'saw example block' ); # This is an example. 2+2 == 4; 5+5 == 10; POD is( $examples[1]{code}, <<'POD', 'multi-part example glued together' ); sub mygrep (&@) { } mygrep { $_ eq 'bar' } @stuff POD is( $examples[2]{code}, <<'POD', 'example with tests' ); my $result = 2 + 2; POD is( $examples[2]{testing}, <<'POD', q{ and there's the tests}); ok( $result == 4, 'addition works' ); is( __LINE__, 142 ); POD is( $examples[4]{code}, <<'POD', '=for example begin' ); 1 + 1 == 2; POD # Test that double parsing works. # Seek back to __END__. use POSIX qw( :fcntl_h ); seek(DATA, 0, SEEK_SET) || die $!; do { $_ = } until /^__END__$/; $p->parse_fh(*DATA); is( $p->tests, 6, 'double parse tests' ); is( $p->examples, 14, 'double parse examples' ); __END__ code and things =for something_else Make sure Pod::Tests ignores other =for tags. =head1 NAME Dummy testing file for Pod::Tests =for testing ok(2+2 == 4); is( __LINE__, 96 ); This is not a test =cut code and stuff =pod =begin testing my $foo = 0; is( __LINE__, 108 ); ok( !$foo, 'foo is false' ); ok( $foo == 0, 'foo is zero' ); =end testing Neither is this. =also begin example # This is an example. 2+2 == 4; 5+5 == 10; =also end example Let's try an example with helper code. =for example sub mygrep (&@) { } =also for example mygrep { $_ eq 'bar' } @stuff And an example_testing block =for example begin my $result = 2 + 2; =for example end =for example_testing ok( $result == 4, 'addition works' ); is( __LINE__, 142 ); And the special $_STDOUT_ and $_STDERR_ variables.. =for example begin local $^W = 1; print "Hello, world!\n"; print STDERR "Beware the Ides of March!\n"; warn "Really, we mean it\n"; =for example end =for example_testing is( $_STDERR_, <catfile(qw(t 02_tests.t)) ); =for testing is( __LINE__, 188, 'line in =for testing' ); =begin testing is( __LINE__, 192, 'line in =begin/end testing' ); =end testing =for example begin BEGIN{binmode STDOUT}; =for example end =cut Pod-Tests-1.19/t/foo0000644000175100017510000000005311036337145014070 0ustar adamadam00000000000000This file doesn't contain anything of note Pod-Tests-1.19/t/99_pmv.t0000644000175100017510000000112711036337145014675 0ustar adamadam00000000000000#!/usr/bin/perl # Test that our declared minimum Perl version matches our syntax use strict; BEGIN { $| = 1; $^W = 1; } my $MODULE = 'Test::MinimumVersion 0.008'; # Don't run tests for installs use Test::More; unless ( $ENV{AUTOMATED_TESTING} or $ENV{RELEASE_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Load the testing module eval "use $MODULE"; if ( $@ ) { $ENV{RELEASE_TESTING} ? die( "Failed to load required release-testing module $MODULE" ) : plan( skip_all => "$MODULE not available for testing" ); } all_minimum_version_from_metayml_ok(); Pod-Tests-1.19/inc/0000755000175100017510000000000011036337431013670 5ustar adamadam00000000000000Pod-Tests-1.19/inc/Module/0000755000175100017510000000000011036337431015115 5ustar adamadam00000000000000Pod-Tests-1.19/inc/Module/Install/0000755000175100017510000000000011036337431016523 5ustar adamadam00000000000000Pod-Tests-1.19/inc/Module/Install/Win32.pm0000644000175100017510000000350111036337424017764 0ustar adamadam00000000000000#line 1 package Module::Install::Win32; use strict; use Module::Install::Base; use vars qw{$VERSION @ISA $ISCORE}; BEGIN { $VERSION = '0.76'; @ISA = qw{Module::Install::Base}; $ISCORE = 1; } # determine if the user needs nmake, and download it if needed sub check_nmake { my $self = shift; $self->load('can_run'); $self->load('get_file'); require Config; return unless ( $^O eq 'MSWin32' and $Config::Config{make} and $Config::Config{make} =~ /^nmake\b/i and ! $self->can_run('nmake') ); print "The required 'nmake' executable not found, fetching it...\n"; require File::Basename; my $rv = $self->get_file( url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe', ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe', local_dir => File::Basename::dirname($^X), size => 51928, run => 'Nmake15.exe /o > nul', check_for => 'Nmake.exe', remove => 1, ); die <<'END_MESSAGE' unless $rv; ------------------------------------------------------------------------------- Since you are using Microsoft Windows, you will need the 'nmake' utility before installation. It's available at: http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe or ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe Please download the file manually, save it to a directory in %PATH% (e.g. C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to that directory, and run "Nmake15.exe" from there; that will create the 'nmake.exe' file needed by this module. You may then resume the installation process described in README. ------------------------------------------------------------------------------- END_MESSAGE } 1; Pod-Tests-1.19/inc/Module/Install/WriteAll.pm0000644000175100017510000000137011036337423020606 0ustar adamadam00000000000000#line 1 package Module::Install::WriteAll; use strict; use Module::Install::Base; use vars qw{$VERSION @ISA $ISCORE}; BEGIN { $VERSION = '0.76'; @ISA = qw{Module::Install::Base}; $ISCORE = 1; } sub WriteAll { my $self = shift; my %args = ( meta => 1, sign => 0, inline => 0, check_nmake => 1, @_, ); $self->sign(1) if $args{sign}; $self->Meta->write if $args{meta}; $self->admin->WriteAll(%args) if $self->is_admin; $self->check_nmake if $args{check_nmake}; unless ( $self->makemaker_args->{PL_FILES} ) { $self->makemaker_args( PL_FILES => {} ); } if ( $args{inline} ) { $self->Inline->write; } else { $self->Makefile->write; } } 1; Pod-Tests-1.19/inc/Module/Install/Can.pm0000644000175100017510000000351411036337424017567 0ustar adamadam00000000000000#line 1 package Module::Install::Can; use strict; use Module::Install::Base; use Config (); ### This adds a 5.005 Perl version dependency. ### This is a bug and will be fixed. use File::Spec (); use ExtUtils::MakeMaker (); use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.76'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } # check if we can load some module ### Upgrade this to not have to load the module if possible sub can_use { my ($self, $mod, $ver) = @_; $mod =~ s{::|\\}{/}g; $mod .= '.pm' unless $mod =~ /\.pm$/i; my $pkg = $mod; $pkg =~ s{/}{::}g; $pkg =~ s{\.pm$}{}i; local $@; eval { require $mod; $pkg->VERSION($ver || 0); 1 }; } # check if we can run some command sub can_run { my ($self, $cmd) = @_; my $_cmd = $cmd; return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd)); for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') { my $abs = File::Spec->catfile($dir, $_[1]); return $abs if (-x $abs or $abs = MM->maybe_command($abs)); } return; } # can we locate a (the) C compiler sub can_cc { my $self = shift; my @chunks = split(/ /, $Config::Config{cc}) or return; # $Config{cc} may contain args; try to find out the program part while (@chunks) { return $self->can_run("@chunks") || (pop(@chunks), next); } return; } # Fix Cygwin bug on maybe_command(); if ( $^O eq 'cygwin' ) { require ExtUtils::MM_Cygwin; require ExtUtils::MM_Win32; if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) { *ExtUtils::MM_Cygwin::maybe_command = sub { my ($self, $file) = @_; if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) { ExtUtils::MM_Win32->maybe_command($file); } else { ExtUtils::MM_Unix->maybe_command($file); } } } } 1; __END__ #line 157 Pod-Tests-1.19/inc/Module/Install/Metadata.pm0000644000175100017510000002670011036337423020607 0ustar adamadam00000000000000#line 1 package Module::Install::Metadata; use strict 'vars'; use Module::Install::Base; use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.76'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } my @scalar_keys = qw{ name module_name abstract author version distribution_type tests installdirs }; my @tuple_keys = qw{ configure_requires build_requires requires recommends bundles resources }; my @resource_keys = qw{ homepage bugtracker repository }; sub Meta { shift } sub Meta_ScalarKeys { @scalar_keys } sub Meta_TupleKeys { @tuple_keys } sub Meta_ResourceKeys { @resource_keys } foreach my $key ( @scalar_keys ) { *$key = sub { my $self = shift; return $self->{values}{$key} if defined wantarray and !@_; $self->{values}{$key} = shift; return $self; }; } foreach my $key ( @resource_keys ) { *$key = sub { my $self = shift; unless ( @_ ) { return () unless $self->{values}{resources}; return map { $_->[1] } grep { $_->[0] eq $key } @{ $self->{values}{resources} }; } return $self->{values}{resources}{$key} unless @_; my $uri = shift or die( "Did not provide a value to $key()" ); $self->resources( $key => $uri ); return 1; }; } sub requires { my $self = shift; while ( @_ ) { my $module = shift or last; my $version = shift || 0; push @{ $self->{values}{requires} }, [ $module, $version ]; } $self->{values}{requires}; } sub build_requires { my $self = shift; while ( @_ ) { my $module = shift or last; my $version = shift || 0; push @{ $self->{values}{build_requires} }, [ $module, $version ]; } $self->{values}{build_requires}; } sub configure_requires { my $self = shift; while ( @_ ) { my $module = shift or last; my $version = shift || 0; push @{ $self->{values}{configure_requires} }, [ $module, $version ]; } $self->{values}{configure_requires}; } sub recommends { my $self = shift; while ( @_ ) { my $module = shift or last; my $version = shift || 0; push @{ $self->{values}{recommends} }, [ $module, $version ]; } $self->{values}{recommends}; } sub bundles { my $self = shift; while ( @_ ) { my $module = shift or last; my $version = shift || 0; push @{ $self->{values}{bundles} }, [ $module, $version ]; } $self->{values}{bundles}; } # Resource handling my %lc_resource = map { $_ => 1 } qw{ homepage license bugtracker repository }; sub resources { my $self = shift; while ( @_ ) { my $name = shift or last; my $value = shift or next; if ( $name eq lc $name and ! $lc_resource{$name} ) { die("Unsupported reserved lowercase resource '$name'"); } $self->{values}{resources} ||= []; push @{ $self->{values}{resources} }, [ $name, $value ]; } $self->{values}{resources}; } # Aliases for build_requires that will have alternative # meanings in some future version of META.yml. sub test_requires { shift->build_requires(@_) } sub install_requires { shift->build_requires(@_) } # Aliases for installdirs options sub install_as_core { $_[0]->installdirs('perl') } sub install_as_cpan { $_[0]->installdirs('site') } sub install_as_site { $_[0]->installdirs('site') } sub install_as_vendor { $_[0]->installdirs('vendor') } sub sign { my $self = shift; return $self->{values}{sign} if defined wantarray and ! @_; $self->{values}{sign} = ( @_ ? $_[0] : 1 ); return $self; } sub dynamic_config { my $self = shift; unless ( @_ ) { warn "You MUST provide an explicit true/false value to dynamic_config\n"; return $self; } $self->{values}{dynamic_config} = $_[0] ? 1 : 0; return 1; } sub perl_version { my $self = shift; return $self->{values}{perl_version} unless @_; my $version = shift or die( "Did not provide a value to perl_version()" ); $version =~ s/_.+$//; $version = $version + 0; # Numify unless ( $version >= 5.005 ) { die "Module::Install only supports 5.005 or newer (use ExtUtils::MakeMaker)\n"; } $self->{values}{perl_version} = $version; return 1; } sub license { my $self = shift; return $self->{values}{license} unless @_; my $license = shift or die( 'Did not provide a value to license()' ); $self->{values}{license} = $license; # Automatically fill in license URLs if ( $license eq 'perl' ) { $self->resources( license => 'http://dev.perl.org/licenses/' ); } return 1; } sub all_from { my ( $self, $file ) = @_; unless ( defined($file) ) { my $name = $self->name or die( "all_from called with no args without setting name() first" ); $file = join('/', 'lib', split(/-/, $name)) . '.pm'; $file =~ s{.*/}{} unless -e $file; unless ( -e $file ) { die("all_from cannot find $file from $name"); } } # Some methods pull from POD instead of code. # If there is a matching .pod, use that instead my $pod = $file; $pod =~ s/\.pm$/.pod/i; $pod = $file unless -e $pod; # Pull the different values $self->name_from($file) unless $self->name; $self->version_from($file) unless $self->version; $self->perl_version_from($file) unless $self->perl_version; $self->author_from($pod) unless $self->author; $self->license_from($pod) unless $self->license; $self->abstract_from($pod) unless $self->abstract; return 1; } sub provides { my $self = shift; my $provides = ( $self->{values}{provides} ||= {} ); %$provides = (%$provides, @_) if @_; return $provides; } sub auto_provides { my $self = shift; return $self unless $self->is_admin; unless (-e 'MANIFEST') { warn "Cannot deduce auto_provides without a MANIFEST, skipping\n"; return $self; } # Avoid spurious warnings as we are not checking manifest here. local $SIG{__WARN__} = sub {1}; require ExtUtils::Manifest; local *ExtUtils::Manifest::manicheck = sub { return }; require Module::Build; my $build = Module::Build->new( dist_name => $self->name, dist_version => $self->version, license => $self->license, ); $self->provides( %{ $build->find_dist_packages || {} } ); } sub feature { my $self = shift; my $name = shift; my $features = ( $self->{values}{features} ||= [] ); my $mods; if ( @_ == 1 and ref( $_[0] ) ) { # The user used ->feature like ->features by passing in the second # argument as a reference. Accomodate for that. $mods = $_[0]; } else { $mods = \@_; } my $count = 0; push @$features, ( $name => [ map { ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ : @$_ : $_ } @$mods ] ); return @$features; } sub features { my $self = shift; while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) { $self->feature( $name, @$mods ); } return $self->{values}{features} ? @{ $self->{values}{features} } : (); } sub no_index { my $self = shift; my $type = shift; push @{ $self->{values}{no_index}{$type} }, @_ if $type; return $self->{values}{no_index}; } sub read { my $self = shift; $self->include_deps( 'YAML::Tiny', 0 ); require YAML::Tiny; my $data = YAML::Tiny::LoadFile('META.yml'); # Call methods explicitly in case user has already set some values. while ( my ( $key, $value ) = each %$data ) { next unless $self->can($key); if ( ref $value eq 'HASH' ) { while ( my ( $module, $version ) = each %$value ) { $self->can($key)->($self, $module => $version ); } } else { $self->can($key)->($self, $value); } } return $self; } sub write { my $self = shift; return $self unless $self->is_admin; $self->admin->write_meta; return $self; } sub version_from { require ExtUtils::MM_Unix; my ( $self, $file ) = @_; $self->version( ExtUtils::MM_Unix->parse_version($file) ); } sub abstract_from { require ExtUtils::MM_Unix; my ( $self, $file ) = @_; $self->abstract( bless( { DISTNAME => $self->name }, 'ExtUtils::MM_Unix' )->parse_abstract($file) ); } # Add both distribution and module name sub name_from { my ($self, $file) = @_; if ( Module::Install::_read($file) =~ m/ ^ \s* package \s* ([\w:]+) \s* ; /ixms ) { my ($name, $module_name) = ($1, $1); $name =~ s{::}{-}g; $self->name($name); unless ( $self->module_name ) { $self->module_name($module_name); } } else { die("Cannot determine name from $file\n"); } } sub perl_version_from { my $self = shift; if ( Module::Install::_read($_[0]) =~ m/ ^ (?:use|require) \s* v? ([\d_\.]+) \s* ; /ixms ) { my $perl_version = $1; $perl_version =~ s{_}{}g; $self->perl_version($perl_version); } else { warn "Cannot determine perl version info from $_[0]\n"; return; } } sub author_from { my $self = shift; my $content = Module::Install::_read($_[0]); if ($content =~ m/ =head \d \s+ (?:authors?)\b \s* ([^\n]*) | =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s* .*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s* ([^\n]*) /ixms) { my $author = $1 || $2; $author =~ s{E}{<}g; $author =~ s{E}{>}g; $self->author($author); } else { warn "Cannot determine author info from $_[0]\n"; } } sub license_from { my $self = shift; if ( Module::Install::_read($_[0]) =~ m/ ( =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b .*? ) (=head\\d.*|=cut.*|) \z /ixms ) { my $license_text = $1; my @phrases = ( 'under the same (?:terms|license) as perl itself' => 'perl', 1, 'GNU public license' => 'gpl', 1, 'GNU lesser public license' => 'lgpl', 1, 'BSD license' => 'bsd', 1, 'Artistic license' => 'artistic', 1, 'GPL' => 'gpl', 1, 'LGPL' => 'lgpl', 1, 'BSD' => 'bsd', 1, 'Artistic' => 'artistic', 1, 'MIT' => 'mit', 1, 'proprietary' => 'proprietary', 0, ); while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) { $pattern =~ s{\s+}{\\s+}g; if ( $license_text =~ /\b$pattern\b/i ) { if ( $osi and $license_text =~ /All rights reserved/i ) { print "WARNING: 'All rights reserved' in copyright may invalidate Open Source license.\n"; } $self->license($license); return 1; } } } warn "Cannot determine license info from $_[0]\n"; return 'unknown'; } sub bugtracker_from { my $self = shift; my $content = Module::Install::_read($_[0]); my @links = $content =~ m/L\<(http\:\/\/rt\.cpan\.org\/[^>]+)\>/g; unless ( @links ) { warn "Cannot determine bugtracker info from $_[0]\n"; return 0; } if ( @links > 1 ) { warn "Found more than on rt.cpan.org link in $_[0]\n"; return 0; } # Set the bugtracker bugtracker( $links[0] ); return 1; } sub install_script { my $self = shift; my $args = $self->makemaker_args; my $exe = $args->{EXE_FILES} ||= []; foreach ( @_ ) { if ( -f $_ ) { push @$exe, $_; } elsif ( -d 'script' and -f "script/$_" ) { push @$exe, "script/$_"; } else { die("Cannot find script '$_'"); } } } 1; Pod-Tests-1.19/inc/Module/Install/Base.pm0000644000175100017510000000215111036337423017733 0ustar adamadam00000000000000#line 1 package Module::Install::Base; $VERSION = '0.76'; # Suspend handler for "redefined" warnings BEGIN { my $w = $SIG{__WARN__}; $SIG{__WARN__} = sub { $w }; } ### This is the ONLY module that shouldn't have strict on # use strict; #line 41 sub new { my ($class, %args) = @_; foreach my $method ( qw(call load) ) { *{"$class\::$method"} = sub { shift()->_top->$method(@_); } unless defined &{"$class\::$method"}; } bless( \%args, $class ); } #line 61 sub AUTOLOAD { my $self = shift; local $@; my $autoload = eval { $self->_top->autoload } or return; goto &$autoload; } #line 76 sub _top { $_[0]->{_top} } #line 89 sub admin { $_[0]->_top->{admin} or Module::Install::Base::FakeAdmin->new; } #line 101 sub is_admin { $_[0]->admin->VERSION; } sub DESTROY {} package Module::Install::Base::FakeAdmin; my $Fake; sub new { $Fake ||= bless(\@_, $_[0]) } sub AUTOLOAD {} sub DESTROY {} # Restore warning handler BEGIN { $SIG{__WARN__} = $SIG{__WARN__}->(); } 1; #line 146 Pod-Tests-1.19/inc/Module/Install/Makefile.pm0000644000175100017510000001504511036337423020604 0ustar adamadam00000000000000#line 1 package Module::Install::Makefile; use strict 'vars'; use Module::Install::Base; use ExtUtils::MakeMaker (); use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.76'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } sub Makefile { $_[0] } my %seen = (); sub prompt { shift; # Infinite loop protection my @c = caller(); if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) { die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])"; } # In automated testing, always use defaults if ( $ENV{AUTOMATED_TESTING} and ! $ENV{PERL_MM_USE_DEFAULT} ) { local $ENV{PERL_MM_USE_DEFAULT} = 1; goto &ExtUtils::MakeMaker::prompt; } else { goto &ExtUtils::MakeMaker::prompt; } } sub makemaker_args { my $self = shift; my $args = ( $self->{makemaker_args} ||= {} ); %$args = ( %$args, @_ ); return $args; } # For mm args that take multiple space-seperated args, # append an argument to the current list. sub makemaker_append { my $self = sShift; my $name = shift; my $args = $self->makemaker_args; $args->{name} = defined $args->{$name} ? join( ' ', $args->{name}, @_ ) : join( ' ', @_ ); } sub build_subdirs { my $self = shift; my $subdirs = $self->makemaker_args->{DIR} ||= []; for my $subdir (@_) { push @$subdirs, $subdir; } } sub clean_files { my $self = shift; my $clean = $self->makemaker_args->{clean} ||= {}; %$clean = ( %$clean, FILES => join ' ', grep { length $_ } ($clean->{FILES} || (), @_), ); } sub realclean_files { my $self = shift; my $realclean = $self->makemaker_args->{realclean} ||= {}; %$realclean = ( %$realclean, FILES => join ' ', grep { length $_ } ($realclean->{FILES} || (), @_), ); } sub libs { my $self = shift; my $libs = ref $_[0] ? shift : [ shift ]; $self->makemaker_args( LIBS => $libs ); } sub inc { my $self = shift; $self->makemaker_args( INC => shift ); } my %test_dir = (); sub _wanted_t { /\.t$/ and -f $_ and $test_dir{$File::Find::dir} = 1; } sub tests_recursive { my $self = shift; if ( $self->tests ) { die "tests_recursive will not work if tests are already defined"; } my $dir = shift || 't'; unless ( -d $dir ) { die "tests_recursive dir '$dir' does not exist"; } %test_dir = (); require File::Find; File::Find::find( \&_wanted_t, $dir ); $self->tests( join ' ', map { "$_/*.t" } sort keys %test_dir ); } sub write { my $self = shift; die "&Makefile->write() takes no arguments\n" if @_; # Make sure we have a new enough require ExtUtils::MakeMaker; # MakeMaker can complain about module versions that include # an underscore, even though its own version may contain one! # Hence the funny regexp to get rid of it. See RT #35800 # for details. $self->configure_requires( 'ExtUtils::MakeMaker' => $ExtUtils::MakeMaker::VERSION =~ /^(\d+\.\d+)/ ); # Generate the my $args = $self->makemaker_args; $args->{DISTNAME} = $self->name; $args->{NAME} = $self->module_name || $self->name; $args->{VERSION} = $self->version; $args->{NAME} =~ s/-/::/g; if ( $self->tests ) { $args->{test} = { TESTS => $self->tests }; } if ($] >= 5.005) { $args->{ABSTRACT} = $self->abstract; $args->{AUTHOR} = $self->author; } if ( eval($ExtUtils::MakeMaker::VERSION) >= 6.10 ) { $args->{NO_META} = 1; } if ( eval($ExtUtils::MakeMaker::VERSION) > 6.17 and $self->sign ) { $args->{SIGN} = 1; } unless ( $self->is_admin ) { delete $args->{SIGN}; } # merge both kinds of requires into prereq_pm my $prereq = ($args->{PREREQ_PM} ||= {}); %$prereq = ( %$prereq, map { @$_ } map { @$_ } grep $_, ($self->configure_requires, $self->build_requires, $self->requires) ); # Remove any reference to perl, PREREQ_PM doesn't support it delete $args->{PREREQ_PM}->{perl}; # merge both kinds of requires into prereq_pm my $subdirs = ($args->{DIR} ||= []); if ($self->bundles) { foreach my $bundle (@{ $self->bundles }) { my ($file, $dir) = @$bundle; push @$subdirs, $dir if -d $dir; delete $prereq->{$file}; } } if ( my $perl_version = $self->perl_version ) { eval "use $perl_version; 1" or die "ERROR: perl: Version $] is installed, " . "but we need version >= $perl_version"; } $args->{INSTALLDIRS} = $self->installdirs; my %args = map { ( $_ => $args->{$_} ) } grep {defined($args->{$_})} keys %$args; my $user_preop = delete $args{dist}->{PREOP}; if (my $preop = $self->admin->preop($user_preop)) { $args{dist} = $preop; } my $mm = ExtUtils::MakeMaker::WriteMakefile(%args); $self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile'); } sub fix_up_makefile { my $self = shift; my $makefile_name = shift; my $top_class = ref($self->_top) || ''; my $top_version = $self->_top->VERSION || ''; my $preamble = $self->preamble ? "# Preamble by $top_class $top_version\n" . $self->preamble : ''; my $postamble = "# Postamble by $top_class $top_version\n" . ($self->postamble || ''); local *MAKEFILE; open MAKEFILE, "< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; my $makefile = do { local $/; }; close MAKEFILE or die $!; $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /; $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g; $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g; $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m; $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m; # Module::Install will never be used to build the Core Perl # Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks # PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist $makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m; #$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m; # Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well. $makefile =~ s/(\"?)-I\$\(PERL_LIB\)\1//g; # XXX - This is currently unused; not sure if it breaks other MM-users # $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg; open MAKEFILE, "> $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; print MAKEFILE "$preamble$makefile$postamble" or die $!; close MAKEFILE or die $!; 1; } sub preamble { my ($self, $text) = @_; $self->{preamble} = $text . $self->{preamble} if defined $text; $self->{preamble}; } sub postamble { my ($self, $text) = @_; $self->{postamble} ||= $self->admin->postamble; $self->{postamble} .= $text if defined $text; $self->{postamble} } 1; __END__ #line 377 Pod-Tests-1.19/inc/Module/Install/Fetch.pm0000644000175100017510000000476411036337424020127 0ustar adamadam00000000000000#line 1 package Module::Install::Fetch; use strict; use Module::Install::Base; use vars qw{$VERSION $ISCORE @ISA}; BEGIN { $VERSION = '0.76'; $ISCORE = 1; @ISA = qw{Module::Install::Base}; } sub get_file { my ($self, %args) = @_; my ($scheme, $host, $path, $file) = $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) { $args{url} = $args{ftp_url} or (warn("LWP support unavailable!\n"), return); ($scheme, $host, $path, $file) = $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; } $|++; print "Fetching '$file' from $host... "; unless (eval { require Socket; Socket::inet_aton($host) }) { warn "'$host' resolve failed!\n"; return; } return unless $scheme eq 'ftp' or $scheme eq 'http'; require Cwd; my $dir = Cwd::getcwd(); chdir $args{local_dir} or return if exists $args{local_dir}; if (eval { require LWP::Simple; 1 }) { LWP::Simple::mirror($args{url}, $file); } elsif (eval { require Net::FTP; 1 }) { eval { # use Net::FTP to get past firewall my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600); $ftp->login("anonymous", 'anonymous@example.com'); $ftp->cwd($path); $ftp->binary; $ftp->get($file) or (warn("$!\n"), return); $ftp->quit; } } elsif (my $ftp = $self->can_run('ftp')) { eval { # no Net::FTP, fallback to ftp.exe require FileHandle; my $fh = FileHandle->new; local $SIG{CHLD} = 'IGNORE'; unless ($fh->open("|$ftp -n")) { warn "Couldn't open ftp: $!\n"; chdir $dir; return; } my @dialog = split(/\n/, <<"END_FTP"); open $host user anonymous anonymous\@example.com cd $path binary get $file $file quit END_FTP foreach (@dialog) { $fh->print("$_\n") } $fh->close; } } else { warn "No working 'ftp' program available!\n"; chdir $dir; return; } unless (-f $file) { warn "Fetching failed: $@\n"; chdir $dir; return; } return if exists $args{size} and -s $file != $args{size}; system($args{run}) if exists $args{run}; unlink($file) if $args{remove}; print(((!exists $args{check_for} or -e $args{check_for}) ? "done!" : "failed! ($!)"), "\n"); chdir $dir; return !$?; } 1; Pod-Tests-1.19/inc/Module/Install.pm0000644000175100017510000002156211036337423017070 0ustar adamadam00000000000000#line 1 package Module::Install; # For any maintainers: # The load order for Module::Install is a bit magic. # It goes something like this... # # IF ( host has Module::Install installed, creating author mode ) { # 1. Makefile.PL calls "use inc::Module::Install" # 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install # 3. The installed version of inc::Module::Install loads # 4. inc::Module::Install calls "require Module::Install" # 5. The ./inc/ version of Module::Install loads # } ELSE { # 1. Makefile.PL calls "use inc::Module::Install" # 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install # 3. The ./inc/ version of Module::Install loads # } BEGIN { require 5.004; } use strict 'vars'; use vars qw{$VERSION}; BEGIN { # All Module::Install core packages now require synchronised versions. # This will be used to ensure we don't accidentally load old or # different versions of modules. # This is not enforced yet, but will be some time in the next few # releases once we can make sure it won't clash with custom # Module::Install extensions. $VERSION = '0.76'; *inc::Module::Install::VERSION = *VERSION; @inc::Module::Install::ISA = __PACKAGE__; } # Whether or not inc::Module::Install is actually loaded, the # $INC{inc/Module/Install.pm} is what will still get set as long as # the caller loaded module this in the documented manner. # If not set, the caller may NOT have loaded the bundled version, and thus # they may not have a MI version that works with the Makefile.PL. This would # result in false errors or unexpected behaviour. And we don't want that. my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm'; unless ( $INC{$file} ) { die <<"END_DIE" } Please invoke ${\__PACKAGE__} with: use inc::${\__PACKAGE__}; not: use ${\__PACKAGE__}; END_DIE # If the script that is loading Module::Install is from the future, # then make will detect this and cause it to re-run over and over # again. This is bad. Rather than taking action to touch it (which # is unreliable on some platforms and requires write permissions) # for now we should catch this and refuse to run. if ( -f $0 and (stat($0))[9] > time ) { die <<"END_DIE" } Your installer $0 has a modification time in the future. This is known to create infinite loops in make. Please correct this, then run $0 again. END_DIE # Build.PL was formerly supported, but no longer is due to excessive # difficulty in implementing every single feature twice. if ( $0 =~ /Build.PL$/i ) { die <<"END_DIE" } Module::Install no longer supports Build.PL. It was impossible to maintain duel backends, and has been deprecated. Please remove all Build.PL files and only use the Makefile.PL installer. END_DIE # To save some more typing in Module::Install installers, every... # use inc::Module::Install # ...also acts as an implicit use strict. $^H |= strict::bits(qw(refs subs vars)); use Cwd (); use File::Find (); use File::Path (); use FindBin; sub autoload { my $self = shift; my $who = $self->_caller; my $cwd = Cwd::cwd(); my $sym = "${who}::AUTOLOAD"; $sym->{$cwd} = sub { my $pwd = Cwd::cwd(); if ( my $code = $sym->{$pwd} ) { # delegate back to parent dirs goto &$code unless $cwd eq $pwd; } $$sym =~ /([^:]+)$/ or die "Cannot autoload $who - $sym"; unshift @_, ( $self, $1 ); goto &{$self->can('call')} unless uc($1) eq $1; }; } sub import { my $class = shift; my $self = $class->new(@_); my $who = $self->_caller; unless ( -f $self->{file} ) { require "$self->{path}/$self->{dispatch}.pm"; File::Path::mkpath("$self->{prefix}/$self->{author}"); $self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self ); $self->{admin}->init; @_ = ($class, _self => $self); goto &{"$self->{name}::import"}; } *{"${who}::AUTOLOAD"} = $self->autoload; $self->preload; # Unregister loader and worker packages so subdirs can use them again delete $INC{"$self->{file}"}; delete $INC{"$self->{path}.pm"}; return 1; } sub preload { my $self = shift; unless ( $self->{extensions} ) { $self->load_extensions( "$self->{prefix}/$self->{path}", $self ); } my @exts = @{$self->{extensions}}; unless ( @exts ) { my $admin = $self->{admin}; @exts = $admin->load_all_extensions; } my %seen; foreach my $obj ( @exts ) { while (my ($method, $glob) = each %{ref($obj) . '::'}) { next unless $obj->can($method); next if $method =~ /^_/; next if $method eq uc($method); $seen{$method}++; } } my $who = $self->_caller; foreach my $name ( sort keys %seen ) { *{"${who}::$name"} = sub { ${"${who}::AUTOLOAD"} = "${who}::$name"; goto &{"${who}::AUTOLOAD"}; }; } } sub new { my ($class, %args) = @_; # ignore the prefix on extension modules built from top level. my $base_path = Cwd::abs_path($FindBin::Bin); unless ( Cwd::abs_path(Cwd::cwd()) eq $base_path ) { delete $args{prefix}; } return $args{_self} if $args{_self}; $args{dispatch} ||= 'Admin'; $args{prefix} ||= 'inc'; $args{author} ||= ($^O eq 'VMS' ? '_author' : '.author'); $args{bundle} ||= 'inc/BUNDLES'; $args{base} ||= $base_path; $class =~ s/^\Q$args{prefix}\E:://; $args{name} ||= $class; $args{version} ||= $class->VERSION; unless ( $args{path} ) { $args{path} = $args{name}; $args{path} =~ s!::!/!g; } $args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm"; $args{wrote} = 0; bless( \%args, $class ); } sub call { my ($self, $method) = @_; my $obj = $self->load($method) or return; splice(@_, 0, 2, $obj); goto &{$obj->can($method)}; } sub load { my ($self, $method) = @_; $self->load_extensions( "$self->{prefix}/$self->{path}", $self ) unless $self->{extensions}; foreach my $obj (@{$self->{extensions}}) { return $obj if $obj->can($method); } my $admin = $self->{admin} or die <<"END_DIE"; The '$method' method does not exist in the '$self->{prefix}' path! Please remove the '$self->{prefix}' directory and run $0 again to load it. END_DIE my $obj = $admin->load($method, 1); push @{$self->{extensions}}, $obj; $obj; } sub load_extensions { my ($self, $path, $top) = @_; unless ( grep { lc $_ eq lc $self->{prefix} } @INC ) { unshift @INC, $self->{prefix}; } foreach my $rv ( $self->find_extensions($path) ) { my ($file, $pkg) = @{$rv}; next if $self->{pathnames}{$pkg}; local $@; my $new = eval { require $file; $pkg->can('new') }; unless ( $new ) { warn $@ if $@; next; } $self->{pathnames}{$pkg} = delete $INC{$file}; push @{$self->{extensions}}, &{$new}($pkg, _top => $top ); } $self->{extensions} ||= []; } sub find_extensions { my ($self, $path) = @_; my @found; File::Find::find( sub { my $file = $File::Find::name; return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is; my $subpath = $1; return if lc($subpath) eq lc($self->{dispatch}); $file = "$self->{path}/$subpath.pm"; my $pkg = "$self->{name}::$subpath"; $pkg =~ s!/!::!g; # If we have a mixed-case package name, assume case has been preserved # correctly. Otherwise, root through the file to locate the case-preserved # version of the package name. if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) { my $content = Module::Install::_read($subpath . '.pm'); my $in_pod = 0; foreach ( split //, $content ) { $in_pod = 1 if /^=\w/; $in_pod = 0 if /^=cut/; next if ($in_pod || /^=cut/); # skip pod text next if /^\s*#/; # and comments if ( m/^\s*package\s+($pkg)\s*;/i ) { $pkg = $1; last; } } } push @found, [ $file, $pkg ]; }, $path ) if -d $path; @found; } ##################################################################### # Utility Functions sub _caller { my $depth = 0; my $call = caller($depth); while ( $call eq __PACKAGE__ ) { $depth++; $call = caller($depth); } return $call; } sub _read { local *FH; open FH, "< $_[0]" or die "open($_[0]): $!"; my $str = do { local $/; }; close FH or die "close($_[0]): $!"; return $str; } sub _write { local *FH; open FH, "> $_[0]" or die "open($_[0]): $!"; foreach ( 1 .. $#_ ) { print FH $_[$_] or die "print($_[0]): $!" } close FH or die "close($_[0]): $!"; } sub _version ($) { my $s = shift || 0; $s =~ s/^(\d+)\.?//; my $l = $1 || 0; my @v = map { $_ . '0' x (3 - length $_) } $s =~ /(\d{1,3})\D?/g; $l = $l . '.' . join '', @v if @v; return $l + 0; } # Cloned from Params::Util::_CLASS sub _CLASS ($) { ( defined $_[0] and ! ref $_[0] and $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*$/s ) ? $_[0] : undef; } 1; # Copyright 2008 Adam Kennedy. Pod-Tests-1.19/script/0000755000175100017510000000000011036337431014423 5ustar adamadam00000000000000Pod-Tests-1.19/script/pod2test0000644000175100017510000000741311036337145016121 0ustar adamadam00000000000000#!perl =pod =head1 NAME pod2test - Convert embedded tests and code examples to .t files =head1 SYNOPSIS pod2test [-Mmodule] [input [output]] =head1 DESCRIPTION B is a front-end for L (formerly Test::Inline 1). It generates TAP-compatible .t testing scripts from embedded tests and code examples. If output is not specified, the resulting .t file will go to STDOUT. Otherwise, it will go to the given output file. If input is not given, it will draw from STDIN. If the given file contains no tests or code examples, no output will be given, no output file will be created and pod2test will exit with 1. The Test::More module is made available to the testing blocks using the 'no_plan' feature. Any further modules which should be used are specified with -M. B =cut use 5.005; use strict; use vars qw($VERSION); BEGIN { $VERSION = '1.19'; } use File::Spec (); use Pod::Tests (); use Symbol (); my($infile, $outfile) = @ARGV; my($infh,$outfh); if( defined $infile ) { $infh = Symbol::gensym(); open($infh, $infile) or die "Can't open the POD file $infile: $!"; } else { $infh = \*STDIN; } my $p = Pod::Tests->new; $p->parse_fh($infh); # XXX Hack to put the filename into the #line directive $p->{file} = $infile || ''; my @tests = $p->build_tests($p->tests); my @examples = $p->build_examples($p->examples); exit 1 unless @tests or @examples; if( defined $outfile) { $outfh = Symbol::gensym(); open($outfh, ">$outfile") or die "Can't open the test file $outfile: $!"; } else { $outfh = \*STDOUT; } my $perl = $^X; # XXX eventually this will be smarter. print $outfh <<"TEST"; #!$perl -w TEST my $original_file = File::Spec->abs2rel($infile); print $outfh sprintf <<'TEST', $original_file; use Test::More 'no_plan'; package Catch; sub TIEHANDLE { my($class, $var) = @_; return bless { var => $var }, $class; } sub PRINT { my($self) = shift; ${'main::'.$self->{var}} .= join '', @_; } sub OPEN {} # XXX Hackery in case the user redirects sub CLOSE {} # XXX STDERR/STDOUT. This is not the behavior we want. sub READ {} sub READLINE {} sub GETC {} sub BINMODE {} my $Original_File = '%s'; package main; # pre-5.8.0's warns aren't caught by a tied STDERR. $SIG{__WARN__} = sub { $main::_STDERR_ .= join '', @_; }; tie *STDOUT, 'Catch', '_STDOUT_' or die $!; tie *STDERR, 'Catch', '_STDERR_' or die $!; TEST foreach my $test (@tests, @examples) { print $outfh "$test\n"; } =pod =head1 BUGS and CAVEATS This is a very simple rough cut. It only does very rudimentary tests on the examples. =head1 SUPPORT This script has been superceded by C from the newer L 2. Most testing code that currently works with C should continue to work with the new version. The most notable exceptions are C<=for begin> and C<=for end>, which are deprecated in the newer version. After upgrading L, L and C were split out to provide a compatibility package for legacy code. C will stay in CPAN, but should remain unchanged indefinately, with the exception of any minor bugs that will require squishing. Bugs in this dist should be reported via the following URL. Feature requests should not be submitted, as further development is now occuring in L. L =head1 AUTHOR Michael G Schwern Eschwern@pobox.comE Adam Kennedy Eadamk@cpan.orgE =head1 SEE ALSO L, L =head1 COPYRIGHT Copyright 2005 - 2008 Adam Kennedy. Copyright 2001 - 2003 Michael G Schwern. 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