diff options
author | gregor herrmann <gregoa@debian.org> | 2021-01-16 19:48:47 +0100 |
---|---|---|
committer | gregor herrmann <gregoa@debian.org> | 2021-01-16 19:48:47 +0100 |
commit | 09a137621dea9f17c5b81005bff764f0711d4ff3 (patch) | |
tree | e0859e4dae74166ffc735f5db8d9d96bf58e1393 | |
parent | fca052fe524b32126d783581314f03266ea3dc30 (diff) | |
parent | ebb1246a24aafc4a07cc5b5099abf177f2923771 (diff) |
Update upstream source from tag 'upstream/1.100'
Update to upstream version '1.100'
with Debian dir d4b0b5f30f9f334b4ce7c94a1dfa7eb2ca4e126a
-rw-r--r-- | Build.PL | 68 | ||||
-rw-r--r-- | Changes | 5 | ||||
-rw-r--r-- | INSTALL | 77 | ||||
-rw-r--r-- | LICENSE | 379 | ||||
-rw-r--r-- | MANIFEST | 18 | ||||
-rw-r--r-- | META.json | 73 | ||||
-rw-r--r-- | META.yml | 15 | ||||
-rw-r--r-- | README | 19 | ||||
-rw-r--r-- | README.md | 48 | ||||
-rw-r--r-- | TODO | 8 | ||||
-rw-r--r-- | cpanfile | 21 | ||||
-rw-r--r-- | dist.ini | 7 | ||||
-rw-r--r-- | lib/Pod/Strip.pm | 34 | ||||
-rw-r--r-- | t/00-compile.t | 63 | ||||
-rw-r--r-- | t/00_load.t | 6 | ||||
-rw-r--r-- | t/99_pod.t | 6 | ||||
-rw-r--r-- | t/99_pod_coverage.t | 6 |
17 files changed, 750 insertions, 103 deletions
@@ -1,18 +1,58 @@ + +# This file was automatically generated by Dist::Zilla::Plugin::ModuleBuild v6.017. use strict; use warnings; -use Module::Build; - -my $builder = Module::Build->new( - module_name => 'Pod::Strip', - license => 'perl', - dist_author => 'Thomas Klausner <domm@zsi.at>', - dist_version_from => 'lib/Pod/Strip.pm', - requires => { - 'Test::More' => 0, - 'Pod::Simple' => '3.00', - }, - add_to_cleanup => [ 'Pod-Strip-*' ], - create_makefile_pl => 'traditional', + +use Module::Build 0.28; + + +my %module_build_args = ( + "build_requires" => { + "Module::Build" => "0.28" + }, + "configure_requires" => { + "Module::Build" => "0.28" + }, + "dist_abstract" => "Remove POD from Perl code", + "dist_author" => [ + "Thomas Klausner <domm\@plix.at>" + ], + "dist_name" => "Pod-Strip", + "dist_version" => "1.100", + "license" => "perl", + "module_name" => "Pod::Strip", + "recursive_test_files" => 1, + "requires" => { + "base" => 0 + }, + "test_requires" => { + "File::Spec" => 0, + "File::Temp" => 0, + "IO::Handle" => 0, + "IPC::Open3" => 0, + "Test::More" => 0, + "perl" => "5.006" + } ); -$builder->create_build_script(); + +my %fallback_build_requires = ( + "File::Spec" => 0, + "File::Temp" => 0, + "IO::Handle" => 0, + "IPC::Open3" => 0, + "Module::Build" => "0.28", + "Test::More" => 0, + "perl" => "5.006" +); + + +unless ( eval { Module::Build->VERSION(0.4004) } ) { + delete $module_build_args{test_requires}; + $module_build_args{build_requires} = \%fallback_build_requires; +} + +my $build = Module::Build->new(%module_build_args); + + +$build->create_build_script; @@ -1,9 +1,10 @@ #----------------------------------------------------------------- # Changes for Pod::Strip -# $Rev: 17 $ -# $Date: 2006-03-20 21:18:35 +0100 (Mon, 20 Mar 2006) $ #----------------------------------------------------------------- +1.100 2021-01-10 18:41:21+01:00 + - dist housekeeping, Dist::Zilla::PluginBundle::Author::DOMM + 1.02 2006-03-20 - changed to 'traditional' Makefile.PL creation (easier install) @@ -0,0 +1,77 @@ +This is the Perl distribution Pod-Strip. + +Installing Pod-Strip is straightforward. + +## Installation with cpanm + +If you have cpanm, you only need one line: + + % cpanm Pod::Strip + +If it does not have permission to install modules to the current perl, cpanm +will automatically set up and install to a local::lib in your home directory. +See the local::lib documentation (https://metacpan.org/pod/local::lib) for +details on enabling it in your environment. + +## Installing with the CPAN shell + +Alternatively, if your CPAN shell is set up, you should just be able to do: + + % cpan Pod::Strip + +## Manual installation + +As a last resort, you can manually install it. Download the tarball, untar it, +install configure prerequisites (see below), then build it: + + % perl Build.PL + % ./Build && ./Build test + +Then install it: + + % ./Build install + +Or the more portable variation: + + % perl Build.PL + % perl Build + % perl Build test + % perl Build install + +If your perl is system-managed, you can create a local::lib in your home +directory to install modules to. For details, see the local::lib documentation: +https://metacpan.org/pod/local::lib + +The prerequisites of this distribution will also have to be installed manually. The +prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated +by running the manual build process described above. + +## Configure Prerequisites + +This distribution requires other modules to be installed before this +distribution's installer can be run. They can be found under the + or the +"{prereqs}{configure}{requires}" key of META.json. + +## Other Prerequisites + +This distribution may require additional modules to be installed after running +Build.PL. +Look for prerequisites in the following phases: + +* to run ./Build, PHASE = build +* to use the module code itself, PHASE = runtime +* to run tests, PHASE = test + +They can all be found in the or the +"{prereqs}{PHASE}{requires}" key of MYMETA.json. + +## Documentation + +Pod-Strip documentation is available as POD. +You can run `perldoc` from a shell to read the documentation: + + % perldoc Pod::Strip + +For more information on installing Perl modules via CPAN, please see: +https://www.cpan.org/modules/INSTALL.html @@ -0,0 +1,379 @@ +This software is copyright (c) 2004 - 2021 by Thomas Klausner. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2004 - 2021 by Thomas Klausner. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2004 - 2021 by Thomas Klausner. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + @@ -1,13 +1,15 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.017. Build.PL Changes -lib/Pod/Strip.pm -Makefile.PL +INSTALL +LICENSE MANIFEST -META.yml # Will be created by "make dist" -README -t/00_load.t +META.json +Makefile.PL +README.md +cpanfile +dist.ini +lib/Pod/Strip.pm +t/00-compile.t t/10_strip.t t/11_replace_with_comments.t -t/99_pod.t -t/99_pod_coverage.t -TODO diff --git a/META.json b/META.json new file mode 100644 index 0000000..aba6f38 --- /dev/null +++ b/META.json @@ -0,0 +1,73 @@ +{ + "abstract" : "Remove POD from Perl code", + "author" : [ + "Thomas Klausner <domm@plix.at>" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 6.017, CPAN::Meta::Converter version 2.150010", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : 2 + }, + "name" : "Pod-Strip", + "no_index" : { + "directory" : [ + "examples", + "t", + "xt" + ] + }, + "prereqs" : { + "build" : { + "requires" : { + "Module::Build" : "0.28" + } + }, + "configure" : { + "requires" : { + "Module::Build" : "0.28" + } + }, + "runtime" : { + "requires" : { + "base" : "0" + } + }, + "test" : { + "requires" : { + "File::Spec" : "0", + "File::Temp" : "0", + "IO::Handle" : "0", + "IPC::Open3" : "0", + "Test::More" : "0", + "perl" : "5.006" + } + } + }, + "provides" : { + "Pod::Strip" : { + "file" : "lib/Pod/Strip.pm", + "version" : "1.100" + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/domm/Pod-Strip/issues" + }, + "homepage" : "https://github.com/domm/Pod-Strip", + "repository" : { + "type" : "git", + "url" : "https://github.com/domm/Pod-Strip.git", + "web" : "https://github.com/domm/Pod-Strip" + } + }, + "version" : "1.100", + "x_generated_by_perl" : "v5.32.0", + "x_serialization_backend" : "Cpanel::JSON::XS version 4.25", + "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" +} + diff --git a/META.yml b/META.yml deleted file mode 100644 index 61ee882..0000000 --- a/META.yml +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Pod-Strip -version: 1.02 -author: - - 'Thomas Klausner <domm@zsi.at>' -abstract: Remove POD from Perl code -license: perl -requires: - Pod::Simple: 3.00 - Test::More: 0 -provides: - Pod::Strip: - file: lib/Pod/Strip.pm - version: 1.02 -generated_by: Module::Build version 0.2611 @@ -1,19 +0,0 @@ -Pod::Strip - Remove POD from Perl code - -Pod::Strip is a subclass of Pod::Simple that strips all POD from Perl Code. - -INSTALLATION - -To install this module, run the following commands: - - perl Build.PL - ./Build - ./Build test - ./Build install - -COPYRIGHT AND LICENCE - -Copyright (C) 2004,2005,2006 Thomas Klausner, ZSI - -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e405d2e --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# NAME + +Pod::Strip - Remove POD from Perl code + +# VERSION + +version 1.100 + +# SYNOPSIS + + use Pod::Strip; + + my $p=Pod::Strip->new; # create parser + my $podless; # set output string + $p->output_string(\$podless); # see Pod::Simple + $p->parse_string_document($code); # or some other parsing method + # from Pod::Simple + # $podless will now contain code without any POD + +# DESCRIPTION + +Pod::Strip is a subclass of Pod::Simple that strips all POD from Perl Code. + +# METHODS + +All methods besides those listed here are inherited from Pod::Simple + +## new + +Generate a new parser object. + +## replace\_with\_comments + +Call this method with a true argument to replace POD with comments (looking like "# stripped POD") instead of stripping it. + +This has the effect that line numbers get reported correctly in error +messages etc. + +# AUTHOR + +Thomas Klausner <domm@plix.at> + +# COPYRIGHT AND LICENSE + +This software is copyright (c) 2004 - 2021 by Thomas Klausner. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. @@ -1,8 +0,0 @@ -#----------------------------------------------------------------- -# TODO -# $Rev: 15 $ -# $Date: 2005-11-07 10:32:24 +0100 (Mon, 07 Nov 2005) $ -#----------------------------------------------------------------- - - - diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..326a882 --- /dev/null +++ b/cpanfile @@ -0,0 +1,21 @@ +# This file is generated by Dist::Zilla::Plugin::CPANFile v6.017 +# Do not edit this file directly. To change prereqs, edit the `dist.ini` file. + +requires "base" => "0"; + +on 'build' => sub { + requires "Module::Build" => "0.28"; +}; + +on 'test' => sub { + requires "File::Spec" => "0"; + requires "File::Temp" => "0"; + requires "IO::Handle" => "0"; + requires "IPC::Open3" => "0"; + requires "Test::More" => "0"; + requires "perl" => "5.006"; +}; + +on 'configure' => sub { + requires "Module::Build" => "0.28"; +}; diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..7433055 --- /dev/null +++ b/dist.ini @@ -0,0 +1,7 @@ +name = Pod-Strip +author = Thomas Klausner <domm@plix.at> +license = Perl_5 +copyright_holder = Thomas Klausner +copyright_year = 2004 - 2021 + +[@Author::DOMM] diff --git a/lib/Pod/Strip.pm b/lib/Pod/Strip.pm index 8a7e841..a301ab1 100644 --- a/lib/Pod/Strip.pm +++ b/lib/Pod/Strip.pm @@ -1,12 +1,13 @@ package Pod::Strip; +# ABSTRACT: Remove POD from Perl code +our $VERSION = '1.100'; # VERSION + use warnings; use strict; use base ('Pod::Simple'); -our $VERSION = "1.02"; - sub new { my $new = shift->SUPER::new(@_); $new->{_code_line}=0; @@ -25,22 +26,27 @@ sub new { return $new; } - sub replace_with_comments { my $self = shift; $self->{_replace_with_comments} = defined $_[0] ? $_[0] : 1; } - 1; + __END__ =pod +=encoding UTF-8 + =head1 NAME Pod::Strip - Remove POD from Perl code +=head1 VERSION + +version 1.100 + =head1 SYNOPSIS use Pod::Strip; @@ -52,7 +58,6 @@ Pod::Strip - Remove POD from Perl code # from Pod::Simple # $podless will now contain code without any POD - =head1 DESCRIPTION Pod::Strip is a subclass of Pod::Simple that strips all POD from Perl Code. @@ -74,22 +79,13 @@ messages etc. =head1 AUTHOR -Thomas Klausner, C<< <domm@cpan.org> >> - -=head1 BUGS +Thomas Klausner <domm@plix.at> -Please report any bugs or feature requests to -C<bug-pod-strip@rt.cpan.org>, or through the web interface at -L<http://rt.cpan.org>. I will be notified, and then you'll automatically -be notified of progress on your bug as I make changes. +=head1 COPYRIGHT AND LICENSE -=head1 COPYRIGHT & LICENSE +This software is copyright (c) 2004 - 2021 by Thomas Klausner. -Copyright 2004, 2005, 2006 Thomas Klausner, All Rights Reserved. - -This program is free software; you can redistribute it and/or modify it -under the same terms as Perl itself. +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. =cut - - diff --git a/t/00-compile.t b/t/00-compile.t new file mode 100644 index 0000000..288a8a5 --- /dev/null +++ b/t/00-compile.t @@ -0,0 +1,63 @@ +use 5.006; +use strict; +use warnings; + +# this test was generated with Dist::Zilla::Plugin::Test::Compile 2.058 + +use Test::More; + +plan tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0); + +my @module_files = ( + 'Pod/Strip.pm' +); + + + +# fake home for cpan-testers +use File::Temp; +local $ENV{HOME} = File::Temp::tempdir( CLEANUP => 1 ); + + +my @switches = ( + -d 'blib' ? '-Mblib' : '-Ilib', +); + +use File::Spec; +use IPC::Open3; +use IO::Handle; + +open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; + +my @warnings; +for my $lib (@module_files) +{ + # see L<perlfaq8/How can I capture STDERR from an external command?> + my $stderr = IO::Handle->new; + + diag('Running: ', join(', ', map { my $str = $_; $str =~ s/'/\\'/g; q{'} . $str . q{'} } + $^X, @switches, '-e', "require q[$lib]")) + if $ENV{PERL_COMPILE_TEST_DEBUG}; + + my $pid = open3($stdin, '>&STDERR', $stderr, $^X, @switches, '-e', "require q[$lib]"); + binmode $stderr, ':crlf' if $^O eq 'MSWin32'; + my @_warnings = <$stderr>; + waitpid($pid, 0); + is($?, 0, "$lib loaded ok"); + + shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ + and not eval { +require blib; blib->VERSION('1.01') }; + + if (@_warnings) + { + warn @_warnings; + push @warnings, @_warnings; + } +} + + + +is(scalar(@warnings), 0, 'no warnings found') + or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ) if $ENV{AUTHOR_TESTING}; + + diff --git a/t/00_load.t b/t/00_load.t deleted file mode 100644 index 464aa20..0000000 --- a/t/00_load.t +++ /dev/null @@ -1,6 +0,0 @@ -use Test::More tests => 1; - -BEGIN { -use_ok( 'Pod::Strip' ); -} - diff --git a/t/99_pod.t b/t/99_pod.t deleted file mode 100644 index 976d7cd..0000000 --- a/t/99_pod.t +++ /dev/null @@ -1,6 +0,0 @@ -#!perl -T - -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(); diff --git a/t/99_pod_coverage.t b/t/99_pod_coverage.t deleted file mode 100644 index 703f91d..0000000 --- a/t/99_pod_coverage.t +++ /dev/null @@ -1,6 +0,0 @@ -#!perl -T - -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(); |