PPIx-DocumentName-1.01000755001750001750 014037121045 14572 5ustar00ollisgollisg000000000000README100644001750001750 1615214037121045 15560 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01NAME PPIx::DocumentName - Utility to extract a name from a PPI Document VERSION version 1.01 SYNOPSIS New API: use PPIx::DocumentName 1.00 -api => 1; my $result = PPIx::DocumentName->extract( $ppi_document ); # say the "name" of the document say $result->name; # the result object can also be stringified into the name found: say "$result"; # the line number, column, filename etc. where the name was found my $location = $result->node->location; Old API: use PPIx::DocumentName; # assumes -api => 0 my $name = PPIx::DocumentName->extract( $ppi_document ); # say the "name" of the document say $name; DESCRIPTION This module contains a few utilities for extracting a "name" out of an arbitrary Perl file. Typically, this is the module name, in the form: package Foo However, it also supports extraction of an override statement in the form: # PODNAME: OverrideName::Goes::Here Which may be more applicable for documents that lack a package statement, or the package statement may be "wrong", but they still need the document parsed under the guise of having a name ( for purposes such as POD ) METHODS extract my $result = PPIx::Document->extract( $ppi_document); This will first attempt to extract a name via the PODNAME: comment notation, and then fall back to using a package Package::Name statement. $ppi_document is ideally a PPI::Document, but will be auto-up-cast if it is any of the parameters PPI::Document->new() understands. The $result is the found name as a string under -api => 0 and a PPIx::DocumentName::Result object under -api => 1. If the name is not found, then it will be undef (with either API). Note that PPIx::DocumentName::Result is stringified to the found name, so in many circumstances the new API can be used in the same way as the old. extract_via_statement my $result = PPIx::DocumentName->extract_via_statement( $ppi_document ); This only extract package Package::Name statement based document names. $ppi_document is ideally a PPI::Document, but will be auto-up-cast if it is any of the parameters PPI::Document->new() understands. The $result is the found name as a string under -api => 0 and a PPIx::DocumentName::Result object under -api => 1. If the name is not found, then it will be undef (with either API). extract_via_comment my $result = PPIx::DocumentName->extract_via_comment( $ppi_document ); This will only extract PODNAME: comment based document names. $ppi_document is ideally a PPI::Document, but will be auto-up-cast if it is any of the parameters PPI::Document->new() understands. The $result is the found name as a string under -api => 0 and a PPIx::DocumentName::Result object under -api => 1. If the name is not found, then it will be undef (with either API). CAVEATS The newer API (-api => 1) is packaged scoped in Perl 5.6 and 5.8. In newer Perls the API is block scoped as it should be. Because this can cause bugs if you are using an older version of Perl this module will complain loudly if you are using an older Perl with the newer API. If you don't like the warning, then either use the old API or upgrade to Perl 5.10+. Under the older API (-api => 0; the default), extract_via_statement, unlike the other methods in this module, returns empty list instead of undef when it does find a name. When using the newer API (-api => 1), calls are consistent in scalar and list context. New code should therefore use the newer API. ALTERNATIVE NAMES Other things I could have called this * PPIx::PodName - But it isn't, because it doesn't extract from POD, only returns data that may be useful FOR POD * PPIx::ModuleName - But it kinda isn't either, because its more generic than that and is tailored to extracting "a name" out of any PPI Document, and they're NOT all modules. SEE ALSO Modules that are perceptibly similar to this ones tasks ( but are subtly different in important ways ) are as follows: * Module::Metadata - Module::Metadata does a bunch of things this module explicitly doesn't want or need to do, and it lacks a bunch of features this module needs. Module::Metadata is predominantly concerned with extracting ALL name spaces and ALL versions from a module for the purposes of indexing and indexing related tasks. This also means it has a notion of "hideable" name spaces with the purpose of hiding them from CPAN. Due to being core as well, it is not able to use PPI for its features, so the above concerns mean it is also mostly based on careful regex parsing, which can easily be false tripped on miscellaneous in document content. Whereas PPIx::DocumentName only cares about the first name of a given class, and it cares much more about nested strings being ignored intentionally. It also has a motive to show names even for documents that won't be indexed ( And Module::Metadata has no short term plans on exposing hidden document names ). PPIx::DocumentName also has special logic for the PODNAME: declaration, and may eventually support other mechanisms for extracting a name from "a document", which will be not in Module::Metadata's collection of desired use-cases. * Module::Extract::Namespaces - This is probably closer to PPIx::DocumentName's requirements, using PPI to extract content. Most of Module::Extract::Namespaces's code seems to be glue for legacy versions of PPI and the remaining code is for loading modules from @INC ( Which we don't need ), or special casing IO ( Which is also not necessary, as this module assumes you're moderately acquainted with PPI and can do IO yourself ) Module::Extract::Namespaces also obliterates document comments, which of course stands in the way of our auxiliary requirements re PODNAME: declarations. It will also not be flexible enough to support other name extraction features we may eventually add. And like Module::Metadata, it also focuses on extracting many package declarations where this module prefers to extract only the first. * PPIx::DocumentName::Result - comes with this module, and contains the results of this module, when using the newer -api => 1 API. ACKNOWLEDGEMENTS The bulk of this logic was extrapolated from Pod::Weaver::Section::Name and a related role, Pod::Weaver::Role::StringFromComment. Thanks to RJBS for the initial implementation and DROLSKY for some of the improvement patches. AUTHORS * Kent Fredric * Graham Ollis COPYRIGHT AND LICENSE This software is copyright (c) 2015-2021 by Kent Fredric . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Changes100644001750001750 230514037121045 16146 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01Release history for PPIx-ModuleName 1.01 2021-04-18 15:18:27 -0600 - Documentation fixes (gh#2) 1.00_01 2021-04-16 11:32:50 -0600 - New maintainer, new GitHub repository. Note the new repository is not a fork of the old repository https://github.com/kentnl/PPIx-DocumentName because it makes PRs against itself painful, sorry for the inconvenience - New API level 1. The default API level 0 maintains the behavnior from the previous releases. (gh#1) - New class PPIx::DocumentName::Result for use with new API level 1. (gh#1) 0.001003 2017-03-06T03:29:51Z edb00ab [Bugfix] - Fix tooling issues with -Ddefault_inc_excludes_dot - Closes https://github.com/kentnl/PPIx-DocumentName/issues/1 [Dependencies::Stats] - Dependencies changed since 0.001002, see misc/*.deps* for details - develop: +5 ↑4 -1 (suggests: ↑2) - test: ↓1 0.001002 2015-02-08T12:20:42Z 38739e1 [Documentation] - Use experimental cpan:// uri's to link to authors (https://metacpan.org/pod/URI::cpan) 0.001001 2015-02-08T06:46:52Z a9afc04 [Documentation] - Document similar modules and why this module is necessary - Acknowledge source material 0.001000 2015-02-07T10:43:55Z e7639e3 - First version. LICENSE100644001750001750 4400414037121045 15702 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01This software is copyright (c) 2015-2021 by Kent Fredric . 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) 2015-2021 by Kent Fredric . This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2015-2021 by Kent Fredric . 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 INSTALL100644001750001750 437014037121045 15710 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01This is the Perl distribution PPIx-DocumentName. Installing PPIx-DocumentName is straightforward. ## Installation with cpanm If you have cpanm, you only need one line: % cpanm PPIx::DocumentName 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 PPIx::DocumentName ## 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 Makefile.PL % make && make test Then install it: % make install On Windows platforms, you should use `dmake` or `nmake`, instead of `make`. 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 "configure_requires" key of META.yml or the "{prereqs}{configure}{requires}" key of META.json. ## Other Prerequisites This distribution may require additional modules to be installed after running Makefile.PL. Look for prerequisites in the following phases: * to run make, PHASE = build * to use the module code itself, PHASE = runtime * to run tests, PHASE = test They can all be found in the "PHASE_requires" key of MYMETA.yml or the "{prereqs}{PHASE}{requires}" key of MYMETA.json. ## Documentation PPIx-DocumentName documentation is available as POD. You can run `perldoc` from a shell to read the documentation: % perldoc PPIx::DocumentName For more information on installing Perl modules via CPAN, please see: https://www.cpan.org/modules/INSTALL.html dist.ini100644001750001750 264214037121045 16323 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01name = PPIx-DocumentName author = Kent Fredric author = Graham Ollis license = Perl_5 copyright_holder = Kent Fredric copyright_year = 2015-2021 version = 1.01 ; authordep Pod::Coverage::TrustPod ; authordep Test::CPAN::Changes ; authordep Test::CPAN::Meta ; authordep Test::Kwalitee ; authordep Test::MinimumVersion ; authordep Test::Pod ; authordep Test::Pod::Coverage [@Author::Plicease] :version = 2.61 installer = Author::Plicease::MakeMaker github_user = uperl release_tests = 1 workflow = linux workflow = macos workflow = windows workflow = cygwin workflow = msys2-mingw [MetaConfig] [MetaProvides::Package] :version = 1.14000001 [MetaData::BuiltWith] :version = 1.004000 show_config = 1 show_uname = 1 uname_args = -s -o -r -m -i use_external_file = only [Git::Contributors] :version = 0.006 include_authors = 0 include_releaser = 0 order_by = name [MetaTests] [PodCoverageTests] [PodSyntaxTests] [Test::ReportPrereqs] [Test::Kwalitee] [Test::MinimumVersion] [Prereqs::AuthorDeps] [Test::CPAN::Changes] [Author::Plicease::Upload] [Prereqs::Upgrade] Dist::Zila::Plugin::MetaProvides::Package = 2.000000 Dist::Zilla = 5 ExtUtils::MakeMaker = 7.00 File::ShareDir::Install = 0.10 Moo = 1.000008 Moose = 2.000 Path::Tiny = 0.058 Test::File::ShareDir = 1.000000 Test::More = 0.99 [RemovePrereqs::Provided] META.yml100644001750001750 3361314037121045 16152 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01--- abstract: 'Utility to extract a name from a PPI Document' author: - 'Kent Fredric ' - 'Graham Ollis ' build_requires: ExtUtils::MakeMaker: '0' File::Spec: '0' Test::More: '0.98' perl: '5.006' configure_requires: ExtUtils::MakeMaker: '0' perl: '5.006' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.017, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: PPIx-DocumentName provides: PPIx::DocumentName: file: lib/PPIx/DocumentName.pm version: '1.01' PPIx::DocumentName::Result: file: lib/PPIx/DocumentName/Result.pm version: '1.01' requires: Carp: '0' PPI::Util: '0' overload: '0' perl: '5.006' strict: '0' warnings: '0' resources: bugtracker: https://github.com/uperl/PPIx-DocumentName/issues homepage: https://metacpan.org/pod/PPIx::DocumentName repository: git://github.com/uperl/PPIx-DocumentName.git version: '1.01' x_BuiltWith: external_file: misc/built_with.json x_Dist_Zilla: perl: version: '5.033008' plugins: - class: Dist::Zilla::Plugin::GatherDir config: Dist::Zilla::Plugin::GatherDir: exclude_filename: - Build.PL - Makefile.PL - xt/release/changes.t - xt/release/fixme.t exclude_match: - ^_build/ follow_symlinks: 0 include_dotfiles: 0 prefix: '' prune_directory: [] root: . name: '@Author::Plicease/GatherDir' version: '6.017' - class: Dist::Zilla::Plugin::PruneCruft name: '@Author::Plicease/PruneCruft' version: '6.017' - class: Dist::Zilla::Plugin::ManifestSkip name: '@Author::Plicease/ManifestSkip' version: '6.017' - class: Dist::Zilla::Plugin::MetaYAML name: '@Author::Plicease/MetaYAML' version: '6.017' - class: Dist::Zilla::Plugin::License name: '@Author::Plicease/License' version: '6.017' - class: Dist::Zilla::Plugin::ExecDir name: '@Author::Plicease/ExecDir' version: '6.017' - class: Dist::Zilla::Plugin::ShareDir name: '@Author::Plicease/ShareDir' version: '6.017' - class: Dist::Zilla::Plugin::Author::Plicease::MakeMaker name: '@Author::Plicease/Author::Plicease::MakeMaker' version: '2.62' - class: Dist::Zilla::Plugin::Manifest name: '@Author::Plicease/Manifest' version: '6.017' - class: Dist::Zilla::Plugin::TestRelease name: '@Author::Plicease/TestRelease' version: '6.017' - class: Dist::Zilla::Plugin::PodWeaver config: Dist::Zilla::Plugin::PodWeaver: finder: - ':InstallModules' - ':ExecFiles' plugins: - class: Pod::Weaver::Plugin::EnsurePod5 name: '@CorePrep/EnsurePod5' version: '4.015' - class: Pod::Weaver::Plugin::H1Nester name: '@CorePrep/H1Nester' version: '4.015' - class: Pod::Weaver::Plugin::SingleEncoding name: -SingleEncoding version: '4.015' - class: Pod::Weaver::Section::Name name: Name version: '4.015' - class: Pod::Weaver::Section::Version name: Version version: '4.015' - class: Pod::Weaver::Section::Region name: prelude version: '4.015' - class: Pod::Weaver::Section::Generic name: SYNOPSIS version: '4.015' - class: Pod::Weaver::Section::Generic name: DESCRIPTION version: '4.015' - class: Pod::Weaver::Section::Generic name: OVERVIEW version: '4.015' - class: Pod::Weaver::Section::Collect name: METHODS version: '4.015' - class: Pod::Weaver::Section::Collect name: ATTRIBUTES version: '4.015' - class: Pod::Weaver::Section::Collect name: PRIVATE_ATTRIBUTES version: '4.015' - class: Pod::Weaver::Section::Collect name: PRIVATE_METHODS version: '4.015' - class: Pod::Weaver::Section::Leftovers name: Leftovers version: '4.015' - class: Pod::Weaver::Section::Region name: postlude version: '4.015' - class: Pod::Weaver::Section::Authors name: Authors version: '4.015' - class: Pod::Weaver::Section::Legal name: Legal version: '4.015' name: '@Author::Plicease/PodWeaver' version: '4.008' - class: Dist::Zilla::Plugin::NextRelease name: '@Author::Plicease/NextRelease' version: '6.017' - class: Dist::Zilla::Plugin::AutoPrereqs name: '@Author::Plicease/AutoPrereqs' version: '6.017' - class: Dist::Zilla::Plugin::OurPkgVersion name: '@Author::Plicease/OurPkgVersion' version: '0.21' - class: Dist::Zilla::Plugin::MetaJSON name: '@Author::Plicease/MetaJSON' version: '6.017' - class: Dist::Zilla::Plugin::Git::Check config: Dist::Zilla::Plugin::Git::Check: untracked_files: die Dist::Zilla::Role::Git::DirtyFiles: allow_dirty: - Changes - README.md - dist.ini allow_dirty_match: [] changelog: Changes Dist::Zilla::Role::Git::Repo: git_version: 2.20.1 repo_root: . name: '@Author::Plicease/Git::Check' version: '2.047' - class: Dist::Zilla::Plugin::Git::Commit config: Dist::Zilla::Plugin::Git::Commit: add_files_in: [] commit_msg: v%V%n%n%c signoff: '0' Dist::Zilla::Role::Git::DirtyFiles: allow_dirty: - Changes - README.md - dist.ini allow_dirty_match: [] changelog: Changes Dist::Zilla::Role::Git::Repo: git_version: 2.20.1 repo_root: . Dist::Zilla::Role::Git::StringFormatter: time_zone: local name: '@Author::Plicease/Git::Commit' version: '2.047' - class: Dist::Zilla::Plugin::Git::Tag config: Dist::Zilla::Plugin::Git::Tag: branch: ~ changelog: Changes signed: 0 tag: v1.01 tag_format: v%V tag_message: v%V Dist::Zilla::Role::Git::Repo: git_version: 2.20.1 repo_root: . Dist::Zilla::Role::Git::StringFormatter: time_zone: local name: '@Author::Plicease/Git::Tag' version: '2.047' - class: Dist::Zilla::Plugin::Git::Push config: Dist::Zilla::Plugin::Git::Push: push_to: - origin remotes_must_exist: 1 Dist::Zilla::Role::Git::Repo: git_version: 2.20.1 repo_root: . name: '@Author::Plicease/Git::Push' version: '2.047' - class: Dist::Zilla::Plugin::MetaResources name: '@Author::Plicease/MetaResources' version: '6.017' - class: Dist::Zilla::Plugin::Author::Plicease::Tests config: Dist::Zilla::Role::TestRunner: default_jobs: 1 name: '@Author::Plicease/Author::Plicease::Tests' version: '2.62' - class: Dist::Zilla::Plugin::InstallGuide config: Dist::Zilla::Role::ModuleMetadata: Module::Metadata: '1.000037' version: '0.006' name: '@Author::Plicease/InstallGuide' version: '1.200013' - class: Dist::Zilla::Plugin::ConfirmRelease name: '@Author::Plicease/ConfirmRelease' version: '6.017' - class: Dist::Zilla::Plugin::MinimumPerl name: '@Author::Plicease/MinimumPerl' version: '1.006' - class: Dist::Zilla::Plugin::Author::Plicease::ReadmeAnyFromPod config: Dist::Zilla::Role::FileWatcher: version: '0.006' name: '@Author::Plicease/Author::Plicease::ReadmeAnyFromPod' version: '2.62' - class: Dist::Zilla::Plugin::Author::Plicease::ReadmeAnyFromPod config: Dist::Zilla::Role::FileWatcher: version: '0.006' name: '@Author::Plicease/ReadMePodInRoot' version: '2.62' - class: Dist::Zilla::Plugin::Author::Plicease::SpecialPrereqs name: '@Author::Plicease/Author::Plicease::SpecialPrereqs' version: '2.62' - class: Dist::Zilla::Plugin::Author::Plicease::NoUnsafeInc name: '@Author::Plicease/Author::Plicease::NoUnsafeInc' version: '2.62' - class: Dist::Zilla::Plugin::MetaConfig name: MetaConfig version: '6.017' - class: Dist::Zilla::Plugin::MetaProvides::Package config: Dist::Zilla::Plugin::MetaProvides::Package: finder_objects: - class: Dist::Zilla::Plugin::FinderCode name: MetaProvides::Package/AUTOVIV/:InstallModulesPM version: '6.017' include_underscores: 0 Dist::Zilla::Role::MetaProvider::Provider: $Dist::Zilla::Role::MetaProvider::Provider::VERSION: '2.002004' inherit_missing: '1' inherit_version: '1' meta_noindex: '1' Dist::Zilla::Role::ModuleMetadata: Module::Metadata: '1.000037' version: '0.006' name: MetaProvides::Package version: '2.004003' - class: Dist::Zilla::Plugin::MetaData::BuiltWith config: Dist::Zilla::Plugin::MetaData::BuiltWith: $Module::Metadata::VERSION: '1.000037' _stash_key: x_BuiltWith external_file_name: misc/built_with.json show_config: '1' show_uname: '1' uname: uname_args: - -s - -o - -r - -m - -i uname_call: uname use_external_file: only name: MetaData::BuiltWith version: '1.004005' - class: Dist::Zilla::Plugin::Git::Contributors config: Dist::Zilla::Plugin::Git::Contributors: git_version: 2.20.1 include_authors: 0 include_releaser: 0 order_by: name paths: [] name: Git::Contributors version: '0.036' - class: Dist::Zilla::Plugin::MetaTests name: MetaTests version: '6.017' - class: Dist::Zilla::Plugin::PodCoverageTests name: PodCoverageTests version: '6.017' - class: Dist::Zilla::Plugin::PodSyntaxTests name: PodSyntaxTests version: '6.017' - class: Dist::Zilla::Plugin::Test::ReportPrereqs name: Test::ReportPrereqs version: '0.028' - class: Dist::Zilla::Plugin::Test::Kwalitee config: Dist::Zilla::Plugin::Test::Kwalitee: filename: xt/release/kwalitee.t skiptest: [] name: Test::Kwalitee version: '2.12' - class: Dist::Zilla::Plugin::Test::MinimumVersion config: Dist::Zilla::Plugin::Test::MinimumVersion: max_target_perl: ~ name: Test::MinimumVersion version: '2.000010' - class: Dist::Zilla::Plugin::Prereqs::AuthorDeps name: Prereqs::AuthorDeps version: '0.007' - class: Dist::Zilla::Plugin::Test::CPAN::Changes config: Dist::Zilla::Plugin::Test::CPAN::Changes: changelog: Changes name: Test::CPAN::Changes version: '0.012' - class: Dist::Zilla::Plugin::Author::Plicease::Upload name: Author::Plicease::Upload version: '2.62' - class: Dist::Zilla::Plugin::Prereqs::Upgrade config: Dist::Zilla::Plugin::Prereqs::Upgrade: modules: Dist::Zila::Plugin::MetaProvides::Package: '2.000000' Dist::Zilla: '5' ExtUtils::MakeMaker: '7.00' File::ShareDir::Install: '0.10' Moo: '1.000008' Moose: '2.000' Path::Tiny: '0.058' Test::File::ShareDir: '1.000000' Test::More: '0.99' name: Prereqs::Upgrade version: '0.001001' - class: Dist::Zilla::Plugin::RemovePrereqs::Provided name: RemovePrereqs::Provided version: '0.001001' - class: Dist::Zilla::Plugin::FinderCode name: ':InstallModules' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':IncModules' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':TestFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':ExtraTestFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':ExecFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':PerlExecFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':ShareFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':MainModule' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':AllFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: ':NoFiles' version: '6.017' - class: Dist::Zilla::Plugin::FinderCode name: MetaProvides::Package/AUTOVIV/:InstallModulesPM version: '6.017' zilla: class: Dist::Zilla::Dist::Builder config: is_trial: '0' version: '6.017' x_generated_by_perl: v5.33.8 x_serialization_backend: 'YAML::Tiny version 1.73' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' x_use_unsafe_inc: 0 MANIFEST100644001750001750 172314037121045 16007 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.017. Changes INSTALL LICENSE MANIFEST META.json META.yml Makefile.PL README author.yml dist.ini lib/PPIx/DocumentName.pm lib/PPIx/DocumentName/Result.pm maint/cip-before-install maint/perlcritic.rc.gen.pl misc/Changes.deps misc/Changes.deps.all misc/Changes.deps.dev misc/Changes.deps.opt misc/built_with.json misc/perlcritic.deps perlcriticrc t/00-report-prereqs.dd t/00-report-prereqs.t t/00_diag.t t/ppix_documentname.t t/ppix_documentname__api1.t t/ppix_documentname__api2.t t/ppix_documentname_result.t weaver.ini xt/author/critic.t xt/author/distmeta.t xt/author/eol.t xt/author/minimum-version.t xt/author/no_tabs.t xt/author/pod-coverage.t xt/author/pod-syntax.t xt/author/pod.t xt/author/pod_coverage.t xt/author/pod_spelling_common.t xt/author/pod_spelling_system.t xt/author/strict.t xt/author/version.t xt/release/changes.t xt/release/cpan-changes.t xt/release/fixme.t xt/release/kwalitee.t META.json100644001750001750 5675014037121045 16331 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01{ "abstract" : "Utility to extract a name from a PPI Document", "author" : [ "Kent Fredric ", "Graham Ollis " ], "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" : "PPIx-DocumentName", "prereqs" : { "configure" : { "recommends" : { "ExtUtils::MakeMaker" : "7.00" }, "requires" : { "ExtUtils::MakeMaker" : "0", "perl" : "5.006" } }, "develop" : { "recommends" : { "Test::More" : "0.99" }, "requires" : { "Dist::Zilla" : "5", "Dist::Zilla::Plugin::Author::Plicease::Upload" : "0", "Dist::Zilla::Plugin::Git::Contributors" : "0.006", "Dist::Zilla::Plugin::MetaConfig" : "0", "Dist::Zilla::Plugin::MetaData::BuiltWith" : "1.004000", "Dist::Zilla::Plugin::MetaProvides::Package" : "1.14000001", "Dist::Zilla::Plugin::MetaTests" : "0", "Dist::Zilla::Plugin::PodCoverageTests" : "0", "Dist::Zilla::Plugin::PodSyntaxTests" : "0", "Dist::Zilla::Plugin::Prereqs::AuthorDeps" : "0", "Dist::Zilla::Plugin::Prereqs::Upgrade" : "0", "Dist::Zilla::Plugin::RemovePrereqs::Provided" : "0", "Dist::Zilla::Plugin::Test::CPAN::Changes" : "0", "Dist::Zilla::Plugin::Test::Kwalitee" : "0", "Dist::Zilla::Plugin::Test::MinimumVersion" : "0", "Dist::Zilla::Plugin::Test::ReportPrereqs" : "0", "Dist::Zilla::PluginBundle::Author::Plicease" : "2.61", "File::Spec" : "0", "FindBin" : "0", "Perl::Critic" : "0", "Pod::Coverage::TrustPod" : "0", "Software::License::Perl_5" : "0", "Test2::Require::Module" : "0.000060", "Test2::Tools::PerlCritic" : "0", "Test2::V0" : "0.000060", "Test::CPAN::Changes" : "0.19", "Test::CPAN::Meta" : "0", "Test::EOL" : "0", "Test::Fixme" : "0.07", "Test::Kwalitee" : "1.21", "Test::MinimumVersion" : "0", "Test::More" : "0.96", "Test::NoTabs" : "0", "Test::Pod" : "1.41", "Test::Pod::Coverage" : "1.08", "Test::Pod::Spelling::CommonMistakes" : "0", "Test::Spelling" : "0", "Test::Strict" : "0", "YAML" : "0" } }, "runtime" : { "requires" : { "Carp" : "0", "PPI::Util" : "0", "overload" : "0", "perl" : "5.006", "strict" : "0", "warnings" : "0" } }, "test" : { "recommends" : { "CPAN::Meta" : "2.120900", "ExtUtils::MakeMaker" : "7.00", "Test::More" : "0.99" }, "requires" : { "ExtUtils::MakeMaker" : "0", "File::Spec" : "0", "Test::More" : "0.98", "perl" : "5.006" } } }, "provides" : { "PPIx::DocumentName" : { "file" : "lib/PPIx/DocumentName.pm", "version" : "1.01" }, "PPIx::DocumentName::Result" : { "file" : "lib/PPIx/DocumentName/Result.pm", "version" : "1.01" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/uperl/PPIx-DocumentName/issues" }, "homepage" : "https://metacpan.org/pod/PPIx::DocumentName", "repository" : { "type" : "git", "url" : "git://github.com/uperl/PPIx-DocumentName.git", "web" : "https://github.com/uperl/PPIx-DocumentName" } }, "version" : "1.01", "x_BuiltWith" : { "external_file" : "misc/built_with.json" }, "x_Dist_Zilla" : { "perl" : { "version" : "5.033008" }, "plugins" : [ { "class" : "Dist::Zilla::Plugin::GatherDir", "config" : { "Dist::Zilla::Plugin::GatherDir" : { "exclude_filename" : [ "Build.PL", "Makefile.PL", "xt/release/changes.t", "xt/release/fixme.t" ], "exclude_match" : [ "^_build/" ], "follow_symlinks" : 0, "include_dotfiles" : 0, "prefix" : "", "prune_directory" : [], "root" : "." } }, "name" : "@Author::Plicease/GatherDir", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::PruneCruft", "name" : "@Author::Plicease/PruneCruft", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::ManifestSkip", "name" : "@Author::Plicease/ManifestSkip", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::MetaYAML", "name" : "@Author::Plicease/MetaYAML", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::License", "name" : "@Author::Plicease/License", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::ExecDir", "name" : "@Author::Plicease/ExecDir", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::ShareDir", "name" : "@Author::Plicease/ShareDir", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::MakeMaker", "name" : "@Author::Plicease/Author::Plicease::MakeMaker", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::Manifest", "name" : "@Author::Plicease/Manifest", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::TestRelease", "name" : "@Author::Plicease/TestRelease", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::PodWeaver", "config" : { "Dist::Zilla::Plugin::PodWeaver" : { "finder" : [ ":InstallModules", ":ExecFiles" ], "plugins" : [ { "class" : "Pod::Weaver::Plugin::EnsurePod5", "name" : "@CorePrep/EnsurePod5", "version" : "4.015" }, { "class" : "Pod::Weaver::Plugin::H1Nester", "name" : "@CorePrep/H1Nester", "version" : "4.015" }, { "class" : "Pod::Weaver::Plugin::SingleEncoding", "name" : "-SingleEncoding", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Name", "name" : "Name", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Version", "name" : "Version", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Region", "name" : "prelude", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "SYNOPSIS", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "DESCRIPTION", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "OVERVIEW", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "METHODS", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "ATTRIBUTES", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "PRIVATE_ATTRIBUTES", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "PRIVATE_METHODS", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Leftovers", "name" : "Leftovers", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Region", "name" : "postlude", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Authors", "name" : "Authors", "version" : "4.015" }, { "class" : "Pod::Weaver::Section::Legal", "name" : "Legal", "version" : "4.015" } ] } }, "name" : "@Author::Plicease/PodWeaver", "version" : "4.008" }, { "class" : "Dist::Zilla::Plugin::NextRelease", "name" : "@Author::Plicease/NextRelease", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::AutoPrereqs", "name" : "@Author::Plicease/AutoPrereqs", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::OurPkgVersion", "name" : "@Author::Plicease/OurPkgVersion", "version" : "0.21" }, { "class" : "Dist::Zilla::Plugin::MetaJSON", "name" : "@Author::Plicease/MetaJSON", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::Git::Check", "config" : { "Dist::Zilla::Plugin::Git::Check" : { "untracked_files" : "die" }, "Dist::Zilla::Role::Git::DirtyFiles" : { "allow_dirty" : [ "Changes", "README.md", "dist.ini" ], "allow_dirty_match" : [], "changelog" : "Changes" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.20.1", "repo_root" : "." } }, "name" : "@Author::Plicease/Git::Check", "version" : "2.047" }, { "class" : "Dist::Zilla::Plugin::Git::Commit", "config" : { "Dist::Zilla::Plugin::Git::Commit" : { "add_files_in" : [], "commit_msg" : "v%V%n%n%c", "signoff" : 0 }, "Dist::Zilla::Role::Git::DirtyFiles" : { "allow_dirty" : [ "Changes", "README.md", "dist.ini" ], "allow_dirty_match" : [], "changelog" : "Changes" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.20.1", "repo_root" : "." }, "Dist::Zilla::Role::Git::StringFormatter" : { "time_zone" : "local" } }, "name" : "@Author::Plicease/Git::Commit", "version" : "2.047" }, { "class" : "Dist::Zilla::Plugin::Git::Tag", "config" : { "Dist::Zilla::Plugin::Git::Tag" : { "branch" : null, "changelog" : "Changes", "signed" : 0, "tag" : "v1.01", "tag_format" : "v%V", "tag_message" : "v%V" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.20.1", "repo_root" : "." }, "Dist::Zilla::Role::Git::StringFormatter" : { "time_zone" : "local" } }, "name" : "@Author::Plicease/Git::Tag", "version" : "2.047" }, { "class" : "Dist::Zilla::Plugin::Git::Push", "config" : { "Dist::Zilla::Plugin::Git::Push" : { "push_to" : [ "origin" ], "remotes_must_exist" : 1 }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.20.1", "repo_root" : "." } }, "name" : "@Author::Plicease/Git::Push", "version" : "2.047" }, { "class" : "Dist::Zilla::Plugin::MetaResources", "name" : "@Author::Plicease/MetaResources", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::Tests", "config" : { "Dist::Zilla::Role::TestRunner" : { "default_jobs" : 1 } }, "name" : "@Author::Plicease/Author::Plicease::Tests", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::InstallGuide", "config" : { "Dist::Zilla::Role::ModuleMetadata" : { "Module::Metadata" : "1.000037", "version" : "0.006" } }, "name" : "@Author::Plicease/InstallGuide", "version" : "1.200013" }, { "class" : "Dist::Zilla::Plugin::ConfirmRelease", "name" : "@Author::Plicease/ConfirmRelease", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::MinimumPerl", "name" : "@Author::Plicease/MinimumPerl", "version" : "1.006" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::ReadmeAnyFromPod", "config" : { "Dist::Zilla::Role::FileWatcher" : { "version" : "0.006" } }, "name" : "@Author::Plicease/Author::Plicease::ReadmeAnyFromPod", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::ReadmeAnyFromPod", "config" : { "Dist::Zilla::Role::FileWatcher" : { "version" : "0.006" } }, "name" : "@Author::Plicease/ReadMePodInRoot", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::SpecialPrereqs", "name" : "@Author::Plicease/Author::Plicease::SpecialPrereqs", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::NoUnsafeInc", "name" : "@Author::Plicease/Author::Plicease::NoUnsafeInc", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::MetaConfig", "name" : "MetaConfig", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::MetaProvides::Package", "config" : { "Dist::Zilla::Plugin::MetaProvides::Package" : { "finder_objects" : [ { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : "MetaProvides::Package/AUTOVIV/:InstallModulesPM", "version" : "6.017" } ], "include_underscores" : 0 }, "Dist::Zilla::Role::MetaProvider::Provider" : { "$Dist::Zilla::Role::MetaProvider::Provider::VERSION" : "2.002004", "inherit_missing" : 1, "inherit_version" : 1, "meta_noindex" : 1 }, "Dist::Zilla::Role::ModuleMetadata" : { "Module::Metadata" : "1.000037", "version" : "0.006" } }, "name" : "MetaProvides::Package", "version" : "2.004003" }, { "class" : "Dist::Zilla::Plugin::MetaData::BuiltWith", "config" : { "Dist::Zilla::Plugin::MetaData::BuiltWith" : { "$Module::Metadata::VERSION" : "1.000037", "_stash_key" : "x_BuiltWith", "external_file_name" : "misc/built_with.json", "show_config" : "1", "show_uname" : "1", "uname" : { "uname_args" : [ "-s", "-o", "-r", "-m", "-i" ], "uname_call" : "uname" }, "use_external_file" : "only" } }, "name" : "MetaData::BuiltWith", "version" : "1.004005" }, { "class" : "Dist::Zilla::Plugin::Git::Contributors", "config" : { "Dist::Zilla::Plugin::Git::Contributors" : { "git_version" : "2.20.1", "include_authors" : 0, "include_releaser" : 0, "order_by" : "name", "paths" : [] } }, "name" : "Git::Contributors", "version" : "0.036" }, { "class" : "Dist::Zilla::Plugin::MetaTests", "name" : "MetaTests", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::PodCoverageTests", "name" : "PodCoverageTests", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::PodSyntaxTests", "name" : "PodSyntaxTests", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::Test::ReportPrereqs", "name" : "Test::ReportPrereqs", "version" : "0.028" }, { "class" : "Dist::Zilla::Plugin::Test::Kwalitee", "config" : { "Dist::Zilla::Plugin::Test::Kwalitee" : { "filename" : "xt/release/kwalitee.t", "skiptest" : [] } }, "name" : "Test::Kwalitee", "version" : "2.12" }, { "class" : "Dist::Zilla::Plugin::Test::MinimumVersion", "config" : { "Dist::Zilla::Plugin::Test::MinimumVersion" : { "max_target_perl" : null } }, "name" : "Test::MinimumVersion", "version" : "2.000010" }, { "class" : "Dist::Zilla::Plugin::Prereqs::AuthorDeps", "name" : "Prereqs::AuthorDeps", "version" : "0.007" }, { "class" : "Dist::Zilla::Plugin::Test::CPAN::Changes", "config" : { "Dist::Zilla::Plugin::Test::CPAN::Changes" : { "changelog" : "Changes" } }, "name" : "Test::CPAN::Changes", "version" : "0.012" }, { "class" : "Dist::Zilla::Plugin::Author::Plicease::Upload", "name" : "Author::Plicease::Upload", "version" : "2.62" }, { "class" : "Dist::Zilla::Plugin::Prereqs::Upgrade", "config" : { "Dist::Zilla::Plugin::Prereqs::Upgrade" : { "modules" : { "Dist::Zila::Plugin::MetaProvides::Package" : "2.000000", "Dist::Zilla" : "5", "ExtUtils::MakeMaker" : "7.00", "File::ShareDir::Install" : "0.10", "Moo" : "1.000008", "Moose" : "2.000", "Path::Tiny" : "0.058", "Test::File::ShareDir" : "1.000000", "Test::More" : "0.99" } } }, "name" : "Prereqs::Upgrade", "version" : "0.001001" }, { "class" : "Dist::Zilla::Plugin::RemovePrereqs::Provided", "name" : "RemovePrereqs::Provided", "version" : "0.001001" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":InstallModules", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":IncModules", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":TestFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExtraTestFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExecFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":PerlExecFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ShareFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":MainModule", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":AllFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":NoFiles", "version" : "6.017" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : "MetaProvides::Package/AUTOVIV/:InstallModulesPM", "version" : "6.017" } ], "zilla" : { "class" : "Dist::Zilla::Dist::Builder", "config" : { "is_trial" : 0 }, "version" : "6.017" } }, "x_generated_by_perl" : "v5.33.8", "x_serialization_backend" : "Cpanel::JSON::XS version 4.25", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later", "x_use_unsafe_inc" : 0 } author.yml100644001750001750 50014037121045 16653 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01--- pod_spelling_system: skip: 0 # list of words that are spelled correctly # (regardless of what spell check thinks) stopwords: - PPI - hideable pod_coverage: skip: 0 # format is "Class#method" or "Class", regex allowed # for either Class or method. private: - PPIx::DocumentName#log.* weaver.ini100644001750001750 131514037121045 16645 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01[@CorePrep] [-SingleEncoding] [Name] [Version] [Region / prelude] [Generic / SYNOPSIS] [Generic / DESCRIPTION] [Generic / OVERVIEW] ;[Generic / METHODS] ;[Collect / METHODS] [Collect / METHODS] command = method [Collect / ATTRIBUTES] command = attr ;[Collect / FILTER_METHODS] ;header = FILTER METHODS ;command = filter ;[Collect / TERMINATOR_LIST_METHODS] ;header = TERMINATOR LIST METHODS ;command = terminator ;[Collect / MIRROR_LIST_METHODS] ;header = MIRROR LIST METHODS ;command = mirrorlist [Collect / PRIVATE_ATTRIBUTES] header = PRIVATE ATTRIBUTES command = p_attr [Collect / PRIVATE_METHODS] header = PRIVATE METHODS command = p_method [Leftovers] [Region / postlude] [Authors] [Legal] t000755001750001750 014037121045 14756 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.0100_diag.t100644001750001750 242714037121045 16513 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/tuse strict; use warnings; use Config; use Test::More tests => 1; # This .t file is generated. # make changes instead to dist.ini my %modules; my $post_diag; $modules{$_} = $_ for qw( CPAN::Meta Carp ExtUtils::MakeMaker File::Spec PPI::Util Test::More overload ); my @modules = sort keys %modules; sub spacer () { diag ''; diag ''; diag ''; } pass 'okay'; my $max = 1; $max = $_ > $max ? $_ : $max for map { length $_ } @modules; our $format = "%-${max}s %s"; spacer; my @keys = sort grep /(MOJO|PERL|\A(LC|HARNESS)_|\A(SHELL|LANG)\Z)/i, keys %ENV; if(@keys > 0) { diag "$_=$ENV{$_}" for @keys; if($ENV{PERL5LIB}) { spacer; diag "PERL5LIB path"; diag $_ for split $Config{path_sep}, $ENV{PERL5LIB}; } elsif($ENV{PERLLIB}) { spacer; diag "PERLLIB path"; diag $_ for split $Config{path_sep}, $ENV{PERLLIB}; } spacer; } diag sprintf $format, 'perl', "$] $^O $Config{archname}"; foreach my $module (@modules) { my $pm = "$module.pm"; $pm =~ s{::}{/}g; if(eval { require $pm; 1 }) { my $ver = eval { $module->VERSION }; $ver = 'undef' unless defined $ver; diag sprintf $format, $module, $ver; } else { diag sprintf $format, $module, '-'; } } if($post_diag) { spacer; $post_diag->(); } spacer; Makefile.PL100644001750001750 346714037121045 16637 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01BEGIN { use strict; use warnings; unless(eval q{ use 5.006; 1}) { print "Perl 5.006 or better required\n"; exit; } } # This file was automatically generated by Dist::Zilla::Plugin::Author::Plicease::MakeMaker v2.62. use strict; use warnings; use 5.006; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "Utility to extract a name from a PPI Document", "AUTHOR" => "Kent Fredric , Graham Ollis ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "PPIx-DocumentName", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.006", "NAME" => "PPIx::DocumentName", "PM" => { "lib/PPIx/DocumentName.pm" => "\$(INST_LIB)/PPIx/DocumentName.pm", "lib/PPIx/DocumentName/Result.pm" => "\$(INST_LIB)/PPIx/DocumentName/Result.pm" }, "PREREQ_PM" => { "Carp" => 0, "PPI::Util" => 0, "overload" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Test::More" => "0.98" }, "VERSION" => "1.01", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "PPI::Util" => 0, "Test::More" => "0.98", "overload" => 0, "strict" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs);perlcriticrc100644001750001750 2255014037121045 17307 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01color = 1 color-severity-low = green color-severity-medium = yellow only = 1 severity = 1 verbose = 9 [Bangs::ProhibitBitwiseOperators] [Bangs::ProhibitCommentedOutCode] [Bangs::ProhibitDebuggingModules] [-Bangs::ProhibitFlagComments] [Bangs::ProhibitNoPlan] [Bangs::ProhibitNumberedNames] [Bangs::ProhibitRefProtoOrProto] [Bangs::ProhibitUselessRegexModifiers] [Bangs::ProhibitVagueNames] [BuiltinFunctions::ProhibitBooleanGrep] [BuiltinFunctions::ProhibitComplexMappings] [BuiltinFunctions::ProhibitLvalueSubstr] [BuiltinFunctions::ProhibitReverseSortBlock] [BuiltinFunctions::ProhibitSleepViaSelect] [BuiltinFunctions::ProhibitStringyEval] allow_includes = 1 [BuiltinFunctions::ProhibitStringySplit] [BuiltinFunctions::ProhibitUniversalCan] [BuiltinFunctions::ProhibitUniversalIsa] [BuiltinFunctions::ProhibitUselessTopic] [BuiltinFunctions::ProhibitVoidGrep] [BuiltinFunctions::ProhibitVoidMap] [BuiltinFunctions::RequireBlockGrep] [BuiltinFunctions::RequireBlockMap] [BuiltinFunctions::RequireGlobFunction] [BuiltinFunctions::RequireSimpleSortBlock] [ClassHierarchies::ProhibitAutoloading] [ClassHierarchies::ProhibitExplicitISA] [ClassHierarchies::ProhibitOneArgBless] [CodeLayout::ProhibitFatCommaNewline] [CodeLayout::ProhibitHardTabs] [-CodeLayout::ProhibitHashBarewords] [CodeLayout::ProhibitIfIfSameLine] [CodeLayout::ProhibitParensWithBuiltins] [CodeLayout::ProhibitQuotedWordLists] [CodeLayout::ProhibitTrailingWhitespace] [-CodeLayout::RequireASCII] [CodeLayout::RequireConsistentNewlines] [CodeLayout::RequireFinalSemicolon] [-CodeLayout::RequireTidyCode] [CodeLayout::RequireTrailingCommaAtNewline] [CodeLayout::RequireTrailingCommas] [-CodeLayout::RequireUseUTF8] [Compatibility::ConstantLeadingUnderscore] [Compatibility::ConstantPragmaHash] [Compatibility::Gtk2Constants] [Compatibility::PerlMinimumVersionAndWhy] [-Compatibility::PodMinimumVersion] [Compatibility::ProhibitThreeArgumentOpen] [Compatibility::ProhibitUnixDevNull] [ControlStructures::ProhibitCStyleForLoops] [ControlStructures::ProhibitCascadingIfElse] [ControlStructures::ProhibitDeepNests] [ControlStructures::ProhibitLabelsWithSpecialBlockNames] [ControlStructures::ProhibitMutatingListFunctions] [ControlStructures::ProhibitNegativeExpressionsInUnlessAndUntilConditions] [-ControlStructures::ProhibitPostfixControls] [ControlStructures::ProhibitUnlessBlocks] [ControlStructures::ProhibitUnreachableCode] [ControlStructures::ProhibitUntilBlocks] [Documentation::ProhibitAdjacentLinks] [Documentation::ProhibitBadAproposMarkup] [Documentation::ProhibitDuplicateHeadings] [Documentation::ProhibitDuplicateSeeAlso] [Documentation::ProhibitLinkToSelf] [Documentation::ProhibitParagraphEndComma] [Documentation::ProhibitParagraphTwoDots] [Documentation::ProhibitUnbalancedParens] [Documentation::ProhibitVerbatimMarkup] [Documentation::RequireEndBeforeLastPod] [Documentation::RequireFilenameMarkup] [Documentation::RequireFinalCut] [Documentation::RequireLinkedURLs] [-Documentation::RequirePODUseEncodingUTF8] [Documentation::RequirePackageMatchesPodName] [Documentation::RequirePodAtEnd] ;[Documentation::RequirePodLinksIncludeText] [-Documentation::RequirePodSections] [-Editor::RequireEmacsFileVariables] [ErrorHandling::RequireCarping] [ErrorHandling::RequireCheckingReturnValueOfEval] [ErrorHandling::RequireUseOfExceptions] [InputOutput::ProhibitBacktickOperators] [InputOutput::ProhibitBarewordFileHandles] [InputOutput::ProhibitExplicitStdin] [InputOutput::ProhibitInteractiveTest] [InputOutput::ProhibitJoinedReadline] [InputOutput::ProhibitOneArgSelect] [InputOutput::ProhibitReadlineInForLoop] [InputOutput::ProhibitTwoArgOpen] [InputOutput::RequireBracedFileHandleWithPrint] [InputOutput::RequireBriefOpen] [InputOutput::RequireCheckedClose] [InputOutput::RequireCheckedOpen] [InputOutput::RequireCheckedSyscalls] [InputOutput::RequireEncodingWithUTF8Layer] [Lax::ProhibitComplexMappings::LinesNotStatements] [Lax::ProhibitEmptyQuotes::ExceptAsFallback] [Lax::ProhibitLeadingZeros::ExceptChmod] [Lax::RequireEndWithTrueConst] [Lax::RequireExplicitPackage::ExceptForPragmata] allowed_pragmata = diagnostics feature perlversion strict warnings utf8 [Miscellanea::ProhibitFormats] [Miscellanea::ProhibitTies] [Miscellanea::ProhibitUnrestrictedNoCritic] [-Miscellanea::ProhibitUselessNoCritic] [-Miscellanea::RequireRcsKeywords] [Miscellanea::TextDomainPlaceholders] [Miscellanea::TextDomainUnused] [Modules::PerlMinimumVersion] [Modules::ProhibitAutomaticExportation] [Modules::ProhibitConditionalUseStatements] [Modules::ProhibitEvilModules] [Modules::ProhibitExcessMainComplexity] [Modules::ProhibitModuleShebang] [Modules::ProhibitMultiplePackages] [Modules::ProhibitPOSIXimport] [Modules::ProhibitUseQuotedVersion] [Modules::RequireBarewordIncludes] [Modules::RequireEndWithOne] [-Modules::RequireExplicitInclusion] [-Modules::RequireExplicitPackage] [Modules::RequireFilenameMatchesPackage] [Modules::RequireNoMatchVarsWithUseEnglish] [Modules::RequirePerlVersion] [Modules::RequireVersionVar] [-Moose::ProhibitMultipleWiths] [Moose::ProhibitNewMethod] [Moose::RequireCleanNamespace] [Moose::RequireMakeImmutable] [NamingConventions::Capitalization] [NamingConventions::ProhibitAmbiguousNames] [NamingConventions::ProhibitMixedCaseSubs] [NamingConventions::ProhibitMixedCaseVars] [Objects::ProhibitIndirectSyntax] [References::ProhibitDoubleSigils] [RegularExpressions::ProhibitCaptureWithoutTest] [RegularExpressions::ProhibitComplexRegexes] [RegularExpressions::ProhibitEnumeratedClasses] [RegularExpressions::ProhibitEscapedMetacharacters] [RegularExpressions::ProhibitFixedStringMatches] [RegularExpressions::ProhibitSingleCharAlternation] [RegularExpressions::ProhibitUnusedCapture] [RegularExpressions::ProhibitUnusualDelimiters] [RegularExpressions::ProhibitUselessTopic] [RegularExpressions::RequireBracesForMultiline] [RegularExpressions::RequireDotMatchAnything] [RegularExpressions::RequireExtendedFormatting] [RegularExpressions::RequireLineBoundaryMatching] [Subroutines::ProhibitAmpersandSigils] [Subroutines::ProhibitBuiltinHomonyms] [Subroutines::ProhibitCallsToUndeclaredSubs] [Subroutines::ProhibitCallsToUnexportedSubs] [Subroutines::ProhibitExcessComplexity] [Subroutines::ProhibitExplicitReturnUndef] [Subroutines::ProhibitExportingUndeclaredSubs] [Subroutines::ProhibitManyArgs] [Subroutines::ProhibitNestedSubs] [Subroutines::ProhibitQualifiedSubDeclarations] [Subroutines::ProhibitReturnSort] [-Subroutines::ProhibitSubroutinePrototypes] [Subroutines::ProhibitUnusedPrivateSubroutines] private_name_regex = _(?!build_)\w [Subroutines::ProtectPrivateSubs] [-Subroutines::RequireArgUnpacking] [-Subroutines::RequireFinalReturn] [TestingAndDebugging::ProhibitNoStrict] [TestingAndDebugging::ProhibitNoWarnings] [TestingAndDebugging::ProhibitProlongedStrictureOverride] [TestingAndDebugging::RequireTestLabels] [TestingAndDebugging::RequireUseStrict] equivalent_modules = Moose Moo [TestingAndDebugging::RequireUseWarnings] equivalent_modules = Moose Moo [Tics::ProhibitLongLines] base_max = 130 [Tics::ProhibitManyArrows] [Tics::ProhibitUseBase] [ValuesAndExpressions::ConstantBeforeLt] [ValuesAndExpressions::NotWithCompare] [ValuesAndExpressions::ProhibitArrayAssignAref] [ValuesAndExpressions::ProhibitBarewordDoubleColon] [ValuesAndExpressions::ProhibitCommaSeparatedStatements] [ValuesAndExpressions::ProhibitComplexVersion] [ValuesAndExpressions::ProhibitConstantPragma] [ValuesAndExpressions::ProhibitDuplicateHashKeys] [-ValuesAndExpressions::ProhibitEmptyCommas] [ValuesAndExpressions::ProhibitEmptyQuotes] [ValuesAndExpressions::ProhibitEscapedCharacters] [ValuesAndExpressions::ProhibitFiletest_f] [ValuesAndExpressions::ProhibitImplicitNewlines] [ValuesAndExpressions::ProhibitInterpolationOfLiterals] [ValuesAndExpressions::ProhibitLeadingZeros] [ValuesAndExpressions::ProhibitLongChainsOfMethodCalls] [-ValuesAndExpressions::ProhibitMagicNumbers] [ValuesAndExpressions::ProhibitMismatchedOperators] [ValuesAndExpressions::ProhibitMixedBooleanOperators] [ValuesAndExpressions::ProhibitNoisyQuotes] [ValuesAndExpressions::ProhibitNullStatements] [ValuesAndExpressions::ProhibitQuotesAsQuotelikeOperatorDelimiters] [ValuesAndExpressions::ProhibitSpecialLiteralHeredocTerminator] [ValuesAndExpressions::ProhibitUnknownBackslash] [ValuesAndExpressions::ProhibitVersionStrings] [ValuesAndExpressions::RequireConstantOnLeftSideOfEquality] [ValuesAndExpressions::RequireInterpolationOfMetachars] [ValuesAndExpressions::RequireNumberSeparators] [ValuesAndExpressions::RequireNumericVersion] [ValuesAndExpressions::RequireQuotedHeredocTerminator] [ValuesAndExpressions::RequireUpperCaseHeredocTerminator] [ValuesAndExpressions::RestrictLongStrings] max_length = 80 [ValuesAndExpressions::UnexpandedSpecialLiteral] [Variables::ProhibitAugmentedAssignmentInDeclaration] [Variables::ProhibitConditionalDeclarations] [Variables::ProhibitEvilVariables] [Variables::ProhibitLocalVars] [Variables::ProhibitMatchVars] [Variables::ProhibitPackageVars] [Variables::ProhibitPerl4PackageNames] [-Variables::ProhibitPunctuationVars] [Variables::ProhibitReusedNames] [Variables::ProhibitUnusedVariables] [Variables::ProhibitUnusedVarsStricter] [Variables::ProtectPrivateVars] [Variables::RequireInitializationForLocalVars] [Variables::RequireLexicalLoopIterators] [Variables::RequireLocalizedPunctuationVars] [Variables::RequireNegativeIndices] author000755001750001750 014037121045 16450 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xteol.t100644001750001750 51014037121045 17530 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::EOL' unless eval q{ use Test::EOL; 1 }; }; use Test::EOL; use FindBin; use File::Spec; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); all_perl_files_ok(grep { -e $_ } qw( bin lib t Makefile.PL )); pod.t100644001750001750 47214037121045 17542 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::Pod' unless eval q{ use Test::Pod; 1 }; }; use Test::Pod; use FindBin; use File::Spec; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); all_pod_files_ok( grep { -e $_ } qw( bin lib )); misc000755001750001750 014037121045 15446 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.01Changes.deps100644001750001750 41114037121045 20007 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/miscThis file contains changes in REQUIRED dependencies for standard CPAN phases (configure/build/runtime/test) 0.001004 0.001003 2017-03-06T03:29:51Z [Changed / test requires] - Test::More 0.89 → 0 0.001002 2015-02-08T12:20:42Z 0.001001 2015-02-08T06:46:52Z critic.t100644001750001750 51114037121045 20227 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse Test2::Require::Module 'Test2::Tools::PerlCritic'; use Test2::Require::Module 'Perl::Critic'; use Test2::Require::Module 'Perl::Critic::Freenode'; use Test2::V0; use Perl::Critic; use Test2::Tools::PerlCritic; my $critic = Perl::Critic->new( -profile => 'perlcriticrc', ); perl_critic_ok ['lib'], $critic; done_testing; strict.t100644001750001750 103114037121045 20300 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::Strict' unless eval q{ use Test::Strict; 1 }; }; use Test::Strict; use FindBin; use File::Spec; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); unshift @Test::Strict::MODULES_ENABLING_STRICT, 'ozo', 'Test2::Bundle::SIPS', 'Test2::V0', 'Test2::Bundle::Extended'; note "enabling strict = $_" for @Test::Strict::MODULES_ENABLING_STRICT; all_perl_files_ok( grep { -e $_ } qw( bin lib t Makefile.PL )); release000755001750001750 014037121045 16566 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xtfixme.t100644001750001750 61614037121045 20206 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/releaseuse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::Fixme' unless eval q{ use Test::Fixme 0.14; 1 }; }; use Test::Fixme 0.07; use FindBin; use File::Spec; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); run_tests( match => qr/FIXME/, where => [ grep { -e $_ } qw( bin lib t Makefile.PL Build.PL )], warn => 1, ); no_tabs.t100644001750001750 52214037121045 20401 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::NoTabs' unless eval q{ use Test::NoTabs; 1 }; }; use Test::NoTabs; use FindBin; use File::Spec; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); all_perl_files_ok( grep { -e $_ } qw( bin lib t Makefile.PL )); version.t100644001750001750 147314037121045 20467 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; use FindBin (); BEGIN { plan skip_all => "test requires Test::Version 2.00" unless eval q{ use Test::Version 2.00 qw( version_all_ok ), { has_version => 1, filename_match => sub { $_[0] !~ m{/(ConfigData|Install/Files)\.pm$} }, }; 1 }; plan skip_all => 'test requires YAML' unless eval q{ use YAML; 1; }; } use YAML qw( LoadFile ); use FindBin; use File::Spec; my $config_filename = File::Spec->catfile( $FindBin::Bin, File::Spec->updir, File::Spec->updir, 'author.yml' ); my $config; $config = LoadFile($config_filename) if -r $config_filename; if($config->{version}->{dir}) { note "using dir " . $config->{version}->{dir} } version_all_ok($config->{version}->{dir} ? ($config->{version}->{dir}) : ()); done_testing; perlcritic.deps100644001750001750 137114037121045 20625 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/miscPerl::Critic::Policy::Documentation::PodSpelling~0 Perl::Critic::Policy::Lax::RequireExplicitPackage::ExceptForPragmata~0 Perl::Critic::Policy::Variables::ProhibitUnusedVarsStricter~0 Perl::Critic::ProfileCompiler::Bundle::Bangs~0 Perl::Critic::ProfileCompiler::Bundle::Compatibility~0 Perl::Critic::ProfileCompiler::Bundle::Core~0 Perl::Critic::ProfileCompiler::Bundle::Deprecated~0 Perl::Critic::ProfileCompiler::Bundle::Itch~0 Perl::Critic::ProfileCompiler::Bundle::Lax~0 Perl::Critic::ProfileCompiler::Bundle::Moose~0 Perl::Critic::ProfileCompiler::Bundle::More~0 Perl::Critic::ProfileCompiler::Bundle::Pulp~0 Perl::Critic::ProfileCompiler::Bundle::StricterSubs~0 Perl::Critic::ProfileCompiler::Bundle::Swift~0 Perl::Critic::ProfileCompiler::Bundle::Tics~0 changes.t100644001750001750 111314037121045 20517 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/releaseuse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::CPAN::Changes' unless eval q{ use Test::CPAN::Changes; 1 }; }; use Test::CPAN::Changes; use FindBin; use File::Spec; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); do { my $old = \&Test::Builder::carp; my $new = sub { my($self, @messages) = @_; return if $messages[0] =~ /^Date ".*" is not in the recommend format/; $old->($self, @messages); }; no warnings 'redefine'; *Test::Builder::carp = $new; }; changes_file_ok; done_testing; built_with.json100644001750001750 456214037121045 20662 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/misc{ "modules" : { "CPAN::Meta" : "2.150010", "Carp" : "1.52", "Dist::Zilla" : "6.017", "Dist::Zilla::Plugin::Author::Plicease::Upload" : "2.62", "Dist::Zilla::Plugin::Git::Contributors" : "0.036", "Dist::Zilla::Plugin::MetaConfig" : "6.017", "Dist::Zilla::Plugin::MetaData::BuiltWith" : "1.004005", "Dist::Zilla::Plugin::MetaProvides::Package" : "2.004003", "Dist::Zilla::Plugin::MetaTests" : "6.017", "Dist::Zilla::Plugin::PodCoverageTests" : "6.017", "Dist::Zilla::Plugin::PodSyntaxTests" : "6.017", "Dist::Zilla::Plugin::Prereqs::AuthorDeps" : "0.007", "Dist::Zilla::Plugin::Prereqs::Upgrade" : "0.001001", "Dist::Zilla::Plugin::RemovePrereqs::Provided" : "0.001001", "Dist::Zilla::Plugin::Test::CPAN::Changes" : "0.012", "Dist::Zilla::Plugin::Test::Kwalitee" : "2.12", "Dist::Zilla::Plugin::Test::MinimumVersion" : "2.000010", "Dist::Zilla::Plugin::Test::ReportPrereqs" : "0.028", "Dist::Zilla::PluginBundle::Author::Plicease" : "2.62", "ExtUtils::MakeMaker" : "7.60", "File::Spec" : "3.80", "FindBin" : "1.52", "PPI::Util" : "1.270", "Perl::Critic" : "1.140", "Pod::Coverage::TrustPod" : "0.100005", "Software::License::Perl_5" : "0.103014", "Test2::Require::Module" : "0.000139", "Test2::Tools::PerlCritic" : "0.04", "Test2::V0" : "0.000139", "Test::CPAN::Changes" : "0.400002", "Test::CPAN::Meta" : "0.25", "Test::EOL" : "2.02", "Test::Fixme" : "0.16", "Test::Kwalitee" : "1.28", "Test::MinimumVersion" : "0.101082", "Test::More" : "1.302183", "Test::NoTabs" : "2.02", "Test::Pod" : "1.52", "Test::Pod::Coverage" : "1.10", "Test::Pod::Spelling::CommonMistakes" : "1.001", "Test::Spelling" : "0.20", "Test::Strict" : "0.52", "YAML" : "1.30", "overload" : "1.33", "strict" : "1.12", "warnings" : "1.51" }, "perl" : { "original" : "v5.33.8", "qv" : 1, "version" : [ 5, 33, 8 ] }, "perl-config" : { "gccversion" : "Clang 11.0.0 21cd567f1c4d772d0f881df73e001d585385fa76:21cd567f1c4d772d0f881df73e001d585385fa76", "myarchname" : "x86_64-linux", "osname" : "linux" }, "platform" : "linux", "uname" : "Linux 4.19.0-16-amd64 x86_64 unknown GNU/Linux" } distmeta.t100644001750001750 17214037121045 20567 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::MetaTests. use Test::CPAN::Meta; meta_yaml_ok(); Changes.deps.all100644001750001750 172214037121045 20604 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/miscThis file contains ALL changes in dependencies in both REQUIRED / OPTIONAL dependencies for all phases (configure/build/runtime/test/develop) 0.001004 0.001003 2017-03-06T03:29:51Z [Added / develop requires] - Dist::Zilla::Plugin::MetaYAML::Minimal - Dist::Zilla::Plugin::RemovePrereqs::Provided - English - Software::License::Perl_5 - Test::MinimumVersion [Changed / develop requires] - Dist::Zilla::Plugin::Author::KENTNL::RecommendFixes 0.001001 → 0.004002 - Dist::Zilla::Plugin::Author::KENTNL::TravisCI 0 → 0.001002 - Dist::Zilla::Plugin::Test::Compile::PerFile 0 → 0.003902 - Test::More 0.88 → 0.96 [Changed / develop suggests] - Dist::Zilla::App::Command::bakeini 0.002000 → 0.002006 - Dist::Zilla::PluginBundle::Author::KENTNL 2.023003 → 2.025021 [Changed / test requires] - Test::More 0.89 → 0 [Removed / develop requires] - Dist::Zilla::Plugin::MetaYAML 0.001002 2015-02-08T12:20:42Z 0.001001 2015-02-08T06:46:52Z Changes.deps.dev100644001750001750 155014037121045 20611 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/miscThis file contains changes to DEVELOPMENT dependencies only ( both REQUIRED and OPTIONAL ) 0.001004 0.001003 2017-03-06T03:29:51Z [Added / develop requires] - Dist::Zilla::Plugin::MetaYAML::Minimal - Dist::Zilla::Plugin::RemovePrereqs::Provided - English - Software::License::Perl_5 - Test::MinimumVersion [Changed / develop requires] - Dist::Zilla::Plugin::Author::KENTNL::RecommendFixes 0.001001 → 0.004002 - Dist::Zilla::Plugin::Author::KENTNL::TravisCI 0 → 0.001002 - Dist::Zilla::Plugin::Test::Compile::PerFile 0 → 0.003902 - Test::More 0.88 → 0.96 [Changed / develop suggests] - Dist::Zilla::App::Command::bakeini 0.002000 → 0.002006 - Dist::Zilla::PluginBundle::Author::KENTNL 2.023003 → 2.025021 [Removed / develop requires] - Dist::Zilla::Plugin::MetaYAML 0.001002 2015-02-08T12:20:42Z 0.001001 2015-02-08T06:46:52Z Changes.deps.opt100644001750001750 32314037121045 20612 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/miscThis file contains changes in OPTIONAL dependencies for standard CPAN phases (configure/build/runtime/test) 0.001004 0.001003 2017-03-06T03:29:51Z 0.001002 2015-02-08T12:20:42Z 0.001001 2015-02-08T06:46:52Z ppix_documentname.t100644001750001750 771714037121045 21036 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/tuse strict; use warnings; use Test::More; use PPIx::DocumentName; use PPI::Util qw( _Document ); subtest 'Basic tests' => sub { my $sample = <<'EOF'; package Foo::Bar; 1; EOF { my $result = _Document( \$sample ); isa_ok( $result, 'PPI::Document', "_Document(\\\$sample)" ); }; { my $result = PPIx::DocumentName->extract( \$sample ); is( $result, 'Foo::Bar', "->extract() is package statement" ); } { my @result = PPIx::DocumentName->extract( \$sample ); is_deeply( \@result, ['Foo::Bar'], "->extract() is package statement (list context)" ); } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); is( $result, 'Foo::Bar', "->extract_via_statement() is correct" ); } { my @result = PPIx::DocumentName->extract_via_statement( \$sample ); is_deeply( \@result, ['Foo::Bar'], "->extract_via_statement() is correct (list context)" ); } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); is( $result, undef, "->extract_via_comment() is undef" ); } { my @result = PPIx::DocumentName->extract_via_comment( \$sample ); is_deeply( \@result, [undef], "->extract_via_comment() is undef (list context)" ); } }; subtest 'Make sure heredocs aren\'t parsed' => sub { my $sample = <<'EOF'; package Foo::Bar; my $value = <<'XXX'; # PODNAME: Bogus XXX 1; EOF { my $result = _Document( \$sample ); isa_ok( $result, 'PPI::Document', "_Document(\\\$sample)" ); }; { my $result = PPIx::DocumentName->extract( \$sample ); is( $result, 'Foo::Bar', "->extract() is package statement" ); } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); is( $result, 'Foo::Bar', "->extract_via_statement() is expected value" ); } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); is( $result, undef, "->extract_via_comment() is undef" ); } }; subtest 'Override tests' => sub { my $sample = <<'EOF'; package Foo::Bar; # PODNAME: Override 1; EOF { my $result = _Document( \$sample ); isa_ok( $result, 'PPI::Document', '_Document(\\$sample)' ); }; { my $result = PPIx::DocumentName->extract( \$sample ); is( $result, 'Override', "->extract() gets comment override" ); } { my @result = PPIx::DocumentName->extract( \$sample ); is_deeply( \@result, ['Override'], "->extract() gets comment override (list context)" ); } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); is( $result, 'Foo::Bar', "->extract_via_statement() gets package statement" ); } { my @result = PPIx::DocumentName->extract_via_statement( \$sample ); is_deeply( \@result, ['Foo::Bar'], "->extract_via_statement() gets package statement (list context)" ); } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); is( $result, 'Override', "->extract_via_comment() gets PODNAME" ); } { my @result = PPIx::DocumentName->extract_via_comment( \$sample ); is_deeply( \@result, ['Override'], "->extract_via_comment() gets PODNAME (list context)" ); } }; subtest 'Empty test' => sub { my $sample = ''; { my $result = PPIx::DocumentName->extract( \$sample ); is( $result, undef, "->extract()" ); } { my @result = PPIx::DocumentName->extract( \$sample ); is_deeply( \@result, [undef], "->extract() (list context)" ); } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); is( $result, undef, "->extract_via_statement()" ); } { # old api is inconsistent my @result = PPIx::DocumentName->extract_via_statement( \$sample ); is_deeply( \@result, [], "->extract_via_statement() (list context)" ); } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); is( $result, undef, "->extract_via_comment()" ); } { my @result = PPIx::DocumentName->extract_via_comment( \$sample ); is_deeply( \@result, [undef], "->extract_via_comment() (list context)" ); } }; done_testing; 00-report-prereqs.t100644001750001750 1345214037121045 20537 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/t#!perl use strict; use warnings; # This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.028 use Test::More tests => 1; use ExtUtils::MakeMaker; use File::Spec; # from $version::LAX my $lax_version_re = qr/(?: undef | (?: (?:[0-9]+) (?: \. | (?:\.[0-9]+) (?:_[0-9]+)? )? | (?:\.[0-9]+) (?:_[0-9]+)? ) | (?: v (?:[0-9]+) (?: (?:\.[0-9]+)+ (?:_[0-9]+)? )? | (?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)? ) )/x; # hide optional CPAN::Meta modules from prereq scanner # and check if they are available my $cpan_meta = "CPAN::Meta"; my $cpan_meta_pre = "CPAN::Meta::Prereqs"; my $HAS_CPAN_META = eval "require $cpan_meta; $cpan_meta->VERSION('2.120900')" && eval "require $cpan_meta_pre"; ## no critic # Verify requirements? my $DO_VERIFY_PREREQS = 1; sub _max { my $max = shift; $max = ( $_ > $max ) ? $_ : $max for @_; return $max; } sub _merge_prereqs { my ($collector, $prereqs) = @_; # CPAN::Meta::Prereqs object if (ref $collector eq $cpan_meta_pre) { return $collector->with_merged_prereqs( CPAN::Meta::Prereqs->new( $prereqs ) ); } # Raw hashrefs for my $phase ( keys %$prereqs ) { for my $type ( keys %{ $prereqs->{$phase} } ) { for my $module ( keys %{ $prereqs->{$phase}{$type} } ) { $collector->{$phase}{$type}{$module} = $prereqs->{$phase}{$type}{$module}; } } } return $collector; } my @include = qw( ); my @exclude = qw( ); # Add static prereqs to the included modules list my $static_prereqs = do './t/00-report-prereqs.dd'; # Merge all prereqs (either with ::Prereqs or a hashref) my $full_prereqs = _merge_prereqs( ( $HAS_CPAN_META ? $cpan_meta_pre->new : {} ), $static_prereqs ); # Add dynamic prereqs to the included modules list (if we can) my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; my $cpan_meta_error; if ( $source && $HAS_CPAN_META && (my $meta = eval { CPAN::Meta->load_file($source) } ) ) { $full_prereqs = _merge_prereqs($full_prereqs, $meta->prereqs); } else { $cpan_meta_error = $@; # capture error from CPAN::Meta->load_file($source) $source = 'static metadata'; } my @full_reports; my @dep_errors; my $req_hash = $HAS_CPAN_META ? $full_prereqs->as_string_hash : $full_prereqs; # Add static includes into a fake section for my $mod (@include) { $req_hash->{other}{modules}{$mod} = 0; } for my $phase ( qw(configure build test runtime develop other) ) { next unless $req_hash->{$phase}; next if ($phase eq 'develop' and not $ENV{AUTHOR_TESTING}); for my $type ( qw(requires recommends suggests conflicts modules) ) { next unless $req_hash->{$phase}{$type}; my $title = ucfirst($phase).' '.ucfirst($type); my @reports = [qw/Module Want Have/]; for my $mod ( sort keys %{ $req_hash->{$phase}{$type} } ) { next if $mod eq 'perl'; next if grep { $_ eq $mod } @exclude; my $file = $mod; $file =~ s{::}{/}g; $file .= ".pm"; my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; my $want = $req_hash->{$phase}{$type}{$mod}; $want = "undef" unless defined $want; $want = "any" if !$want && $want == 0; my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; if ($prefix) { my $have = MM->parse_version( File::Spec->catfile($prefix, $file) ); $have = "undef" unless defined $have; push @reports, [$mod, $want, $have]; if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META && $type eq 'requires' ) { if ( $have !~ /\A$lax_version_re\z/ ) { push @dep_errors, "$mod version '$have' cannot be parsed ($req_string)"; } elsif ( ! $full_prereqs->requirements_for( $phase, $type )->accepts_module( $mod => $have ) ) { push @dep_errors, "$mod version '$have' is not in required range '$want'"; } } } else { push @reports, [$mod, $want, "missing"]; if ( $DO_VERIFY_PREREQS && $type eq 'requires' ) { push @dep_errors, "$mod is not installed ($req_string)"; } } } if ( @reports ) { push @full_reports, "=== $title ===\n\n"; my $ml = _max( map { length $_->[0] } @reports ); my $wl = _max( map { length $_->[1] } @reports ); my $hl = _max( map { length $_->[2] } @reports ); if ($type eq 'modules') { splice @reports, 1, 0, ["-" x $ml, "", "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s\n", -$ml, $_->[0], $hl, $_->[2]) } @reports; } else { splice @reports, 1, 0, ["-" x $ml, "-" x $wl, "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s %*s\n", -$ml, $_->[0], $wl, $_->[1], $hl, $_->[2]) } @reports; } push @full_reports, "\n"; } } } if ( @full_reports ) { diag "\nVersions for all modules listed in $source (including optional ones):\n\n", @full_reports; } if ( $cpan_meta_error || @dep_errors ) { diag "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n"; } if ( $cpan_meta_error ) { my ($orig_source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; diag "\nCPAN::Meta->load_file('$orig_source') failed with: $cpan_meta_error\n"; } if ( @dep_errors ) { diag join("\n", "\nThe following REQUIRED prerequisites were not satisfied:\n", @dep_errors, "\n" ); } pass('Reported prereqs'); # vim: ts=4 sts=4 sw=4 et: kwalitee.t100644001750001750 27514037121045 20704 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/release# this test was generated with Dist::Zilla::Plugin::Test::Kwalitee 2.12 use strict; use warnings; use Test::More 0.88; use Test::Kwalitee 1.21 'kwalitee_ok'; kwalitee_ok(); done_testing; pod-syntax.t100644001750001750 25214037121045 21062 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use strict; use warnings; use Test::More; use Test::Pod 1.41; all_pod_files_ok(); 00-report-prereqs.dd100644001750001750 1114614037121045 20661 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/tdo { my $x = { 'configure' => { 'recommends' => { 'ExtUtils::MakeMaker' => '7.00' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'perl' => '5.006' } }, 'develop' => { 'recommends' => { 'Test::More' => '0.99' }, 'requires' => { 'Dist::Zilla' => '5', 'Dist::Zilla::Plugin::Author::Plicease::Upload' => '0', 'Dist::Zilla::Plugin::Git::Contributors' => '0.006', 'Dist::Zilla::Plugin::MetaConfig' => '0', 'Dist::Zilla::Plugin::MetaData::BuiltWith' => '1.004000', 'Dist::Zilla::Plugin::MetaProvides::Package' => '1.14000001', 'Dist::Zilla::Plugin::MetaTests' => '0', 'Dist::Zilla::Plugin::PodCoverageTests' => '0', 'Dist::Zilla::Plugin::PodSyntaxTests' => '0', 'Dist::Zilla::Plugin::Prereqs::AuthorDeps' => '0', 'Dist::Zilla::Plugin::Prereqs::Upgrade' => '0', 'Dist::Zilla::Plugin::RemovePrereqs::Provided' => '0', 'Dist::Zilla::Plugin::Test::CPAN::Changes' => '0', 'Dist::Zilla::Plugin::Test::Kwalitee' => '0', 'Dist::Zilla::Plugin::Test::MinimumVersion' => '0', 'Dist::Zilla::Plugin::Test::ReportPrereqs' => '0', 'Dist::Zilla::PluginBundle::Author::Plicease' => '2.61', 'File::Spec' => '0', 'FindBin' => '0', 'Perl::Critic' => '0', 'Pod::Coverage::TrustPod' => '0', 'Software::License::Perl_5' => '0', 'Test2::Require::Module' => '0.000060', 'Test2::Tools::PerlCritic' => '0', 'Test2::V0' => '0.000060', 'Test::CPAN::Changes' => '0.19', 'Test::CPAN::Meta' => '0', 'Test::EOL' => '0', 'Test::Fixme' => '0.07', 'Test::Kwalitee' => '1.21', 'Test::MinimumVersion' => '0', 'Test::More' => '0.96', 'Test::NoTabs' => '0', 'Test::Pod' => '1.41', 'Test::Pod::Coverage' => '1.08', 'Test::Pod::Spelling::CommonMistakes' => '0', 'Test::Spelling' => '0', 'Test::Strict' => '0', 'YAML' => '0' } }, 'runtime' => { 'requires' => { 'Carp' => '0', 'PPI::Util' => '0', 'overload' => '0', 'perl' => '5.006', 'strict' => '0', 'warnings' => '0' } }, 'test' => { 'recommends' => { 'CPAN::Meta' => '2.120900', 'ExtUtils::MakeMaker' => '7.00', 'Test::More' => '0.99' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'File::Spec' => '0', 'Test::More' => '0.98', 'perl' => '5.006' } } }; $x; }PPIx000755001750001750 014037121045 16101 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/libDocumentName.pm100644001750001750 2574314037121045 21211 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/lib/PPIxuse 5.006; # our use strict; use warnings; package PPIx::DocumentName; # ABSTRACT: Utility to extract a name from a PPI Document our $VERSION = '1.01'; # VERSION use PPI::Util qw( _Document ); sub log_info(&@); sub log_debug(&@); sub log_trace(&@); my %callers; BEGIN { if ( $INC{'Log/Contextual.pm'} ) { ## Hide from autoprereqs require 'Log/Contextual/WarnLogger.pm'; ## no critic (Modules::RequireBarewordIncludes) my $deflogger = Log::Contextual::WarnLogger->new( { env_prefix => 'PPIX_DOCUMENTNAME', } ); Log::Contextual->import( 'log_info', 'log_debug', 'log_trace', '-default_logger' => $deflogger ); } else { require Carp; *log_info = sub (&@) { Carp::carp( $_[0]->() ) }; *log_debug = sub (&@) { }; *log_trace = sub (&@) { }; } } sub import { my(undef, %args) = @_; if(defined $args{'-api'}) { if($args{'-api'} != 0 && $args{'-api'} != 1) { Carp::croak("illegal api level: $args{'-api'}"); } if($] < 5.010) { my($package) = caller; $callers{$package} = $args{'-api'}; require Carp; Carp::carp("Because of the age of your Perl, -api $args{'-api'} " . 'will be package scoped instead of block scoped. ' . 'Please upgrade to 5.10 or better.'); } else { $^H{'PPIx::DocumentName/api'} = $args{'-api'}; ## no critic (Variables::RequireLocalizedPunctuationVars) } } } sub _api { my ( $api ) = @_; if($] < 5.010) { my($package) = caller 1; $api = $callers{$package} unless defined $api; } else { my $hh = (caller 1)[10]; $api = $hh->{'PPIx::DocumentName/api'} if defined $hh && !defined $api; } $api = 0 unless defined $api; return $api; } sub _result { my($name, $ppi_document, $node) = @_; require PPIx::DocumentName::Result; PPIx::DocumentName::Result->_new($name, $ppi_document, $node); ## no critic (Subroutines::ProtectPrivateSubs) } ## OO sub extract { my ( $self, $ppi_document ) = @_; my $api = _api(undef); my $result = $self->extract_via_comment($ppi_document, $api) || $self->extract_via_statement($ppi_document, $api); return $result; } sub extract_via_statement { my ( undef, $ppi_document, $api ) = @_; $api = _api($api); # Keep alive until done # https://github.com/adamkennedy/PPI/issues/112 my $dom = _Document($ppi_document); my $pkg_node = $dom->find_first('PPI::Statement::Package'); if ( not $pkg_node ) { log_debug { "No PPI::Statement::Package found in <<$ppi_document>>" }; # The old API was inconsistant here, for just this method, returns # empty list on failure. This is unfortunately different from # extract_via_comment. return 1 == $api ? undef : (); } if ( not $pkg_node->namespace ) { log_debug { "PPI::Statement::Package $pkg_node has empty namespace in <<$ppi_document>>" }; return 1 == $api ? undef : (); } my $name = $pkg_node->namespace; return 1 == $api ? _result($name, $dom, $pkg_node) : $name; } sub extract_via_comment { my ( undef, $ppi_document, $api ) = @_; $api = _api($api); my $node; my $regex = qr{ ^ \s* \#+ \s* PODNAME: \s* (.+) $ }x; ## no critic (RegularExpressions) my $content; my $finder = sub { my $maybe = $_[1]; return 0 unless $maybe->isa('PPI::Token::Comment'); log_trace { "Found comment node $maybe" }; if ( $maybe->content =~ $regex ) { $content = $1; $node = $maybe; return 1; } return 0; }; # Keep alive until done # https://github.com/adamkennedy/PPI/issues/112 my $dom = _Document($ppi_document); $dom->find_first($finder); log_debug { "<<$ppi_document>> has no PODNAME comment" } if not $content; return 1 == $api && defined $content ? _result($content, $dom, $node) : $content; } 1; __END__ =pod =encoding UTF-8 =head1 NAME PPIx::DocumentName - Utility to extract a name from a PPI Document =head1 VERSION version 1.01 =head1 SYNOPSIS New API: use PPIx::DocumentName 1.00 -api => 1; my $result = PPIx::DocumentName->extract( $ppi_document ); # say the "name" of the document say $result->name; # the result object can also be stringified into the name found: say "$result"; # the line number, column, filename etc. where the name was found my $location = $result->node->location; Old API: use PPIx::DocumentName; # assumes -api => 0 my $name = PPIx::DocumentName->extract( $ppi_document ); # say the "name" of the document say $name; =head1 DESCRIPTION This module contains a few utilities for extracting a "name" out of an arbitrary Perl file. Typically, this is the C name, in the form: package Foo However, it also supports extraction of an override statement in the form: # PODNAME: OverrideName::Goes::Here Which may be more applicable for documents that lack a C statement, or the C statement may be "wrong", but they still need the document parsed under the guise of having a name ( for purposes such as POD ) =head1 METHODS =head2 extract my $result = PPIx::Document->extract( $ppi_document); This will first attempt to extract a name via the C comment notation, and then fall back to using a C statement. C<$ppi_document> is ideally a C, but will be auto-up-cast if it is any of the parameters C<< PPI::Document->new() >> understands. The C<$result> is the found name as a string under C<< -api => 0 >> and a L object under C<< -api => 1 >>. If the name is not found, then it will be C (with either API). Note that L is stringified to the found name, so in many circumstances the new API can be used in the same way as the old. =head2 extract_via_statement my $result = PPIx::DocumentName->extract_via_statement( $ppi_document ); This only extract C statement based document names. C<$ppi_document> is ideally a C, but will be auto-up-cast if it is any of the parameters C<< PPI::Document->new() >> understands. The C<$result> is the found name as a string under C<< -api => 0 >> and a L object under C<< -api => 1 >>. If the name is not found, then it will be C (with either API). =head2 extract_via_comment my $result = PPIx::DocumentName->extract_via_comment( $ppi_document ); This will only extract C comment based document names. C<$ppi_document> is ideally a C, but will be auto-up-cast if it is any of the parameters C<< PPI::Document->new() >> understands. The C<$result> is the found name as a string under C<< -api => 0 >> and a L object under C<< -api => 1 >>. If the name is not found, then it will be C (with either API). =for Pod::Coverage log_info log_debug log_trace =head1 CAVEATS The newer API (C<< -api => 1 >>) is packaged scoped in Perl 5.6 and 5.8. In newer Perls the API is block scoped as it should be. Because this can cause bugs if you are using an older version of Perl this module will complain loudly if you are using an older Perl with the newer API. If you don't like the warning, then either use the old API or upgrade to Perl 5.10+. Under the older API (C<< -api => 0 >>; the default), C, unlike the other methods in this module, returns empty list instead of undef when it does find a name. When using the newer API (C<< -api => 1 >>), calls are consistent in scalar and list context. New code should therefore use the newer API. =head1 ALTERNATIVE NAMES Other things I could have called this =over 4 =item * C - But it isn't, because it doesn't extract from C, only returns data that may be useful B C =item * C - But it kinda isn't either, because its more generic than that and is tailored to extracting "a name" out of any PPI Document, and they're I all modules. =back =head1 SEE ALSO Modules that are perceptibly similar to this ones tasks ( but are subtly different in important ways ) are as follows: =over 4 =item * L<< C|Module::Metadata >> - Module::Metadata does a bunch of things this module explicitly doesn't want or need to do, and it lacks a bunch of features this module needs. Module::Metadata is predominantly concerned with extracting I name spaces and I versions from a module for the purposes of indexing and indexing related tasks. This also means it has a notion of "hideable" name spaces with the purpose of hiding them from C. Due to being core as well, it is not able to use C for its features, so the above concerns mean it is also mostly based on careful regex parsing, which can easily be false tripped on miscellaneous in document content. Whereas C only cares about the I name of a given class, and it cares much more about nested strings being ignored intentionally. It also has a motive to show names I for documents that won't be indexed ( And C has no short term plans on exposing hidden document names ). C also has special logic for the C declaration, and may eventually support other mechanisms for extracting a name from "a document", which will be not in C's collection of desired use-cases. =item * L<< C|Module::Extract::Namespaces >> - This is probably closer to C's requirements, using C to extract content. Most of C's code seems to be glue for legacy versions of C and the remaining code is for loading modules from C<@INC> ( Which we don't need ), or special casing IO ( Which is also not necessary, as this module assumes you're moderately acquainted with C and can do IO yourself ) C also obliterates document comments, which of course stands in the way of our auxiliary requirements re C declarations. It will also not be flexible enough to support other name extraction features we may eventually add. And like C, it also focuses on extracting I C declarations where this module prefers to extract only the I. =item * L<< C|PPIx::DocumentName::Result >> - comes with this module, and contains the results of this module, when using the newer C<< -api => 1 >> API. =back =head1 ACKNOWLEDGEMENTS The bulk of this logic was extrapolated from L<< C|Pod::Weaver::Section::Name >> and a related role, L<< C|Pod::Weaver::Role::StringFromComment >>. Thanks to L<< C|cpan:///author/RJBS >> for the initial implementation and L<< C|cpan:///author/DROLSKY >> for some of the improvement patches. =head1 AUTHORS =over 4 =item * Kent Fredric =item * Graham Ollis =back =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2015-2021 by Kent Fredric . 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 maint000755001750001750 014037121045 15623 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.01cip-before-install100755001750001750 11314037121045 21343 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/maint#!/bin/bash set -ex cip sudo apt-get update cip sudo apt-get install git pod_coverage.t100644001750001750 400314037121045 21427 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires 5.010 or better' unless $] >= 5.010; plan skip_all => 'test requires Test::Pod::Coverage' unless eval q{ use Test::Pod::Coverage; 1 }; plan skip_all => 'test requires YAML' unless eval q{ use YAML; 1; }; plan skip_all => 'test does not always work in cip check' if defined $ENV{CIPSTATIC} && $ENV{CIPSTATIC} eq 'true'; }; use Test::Pod::Coverage; use YAML qw( LoadFile ); use FindBin; use File::Spec; my $config_filename = File::Spec->catfile( $FindBin::Bin, File::Spec->updir, File::Spec->updir, 'author.yml' ); my $config; $config = LoadFile($config_filename) if -r $config_filename; plan skip_all => 'disabled' if $config->{pod_coverage}->{skip}; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); my @private_classes; my %private_methods; push @{ $config->{pod_coverage}->{private} }, 'Alien::.*::Install::Files#Inline'; foreach my $private (@{ $config->{pod_coverage}->{private} }) { my($class,$method) = split /#/, $private; if(defined $class && $class ne '') { my $regex = eval 'qr{^' . $class . '$}'; if(defined $method && $method ne '') { push @private_classes, { regex => $regex, method => $method }; } else { push @private_classes, { regex => $regex, all => 1 }; } } elsif(defined $method && $method ne '') { $private_methods{$_} = 1 for split /,/, $method; } } my @classes = all_modules; plan tests => scalar @classes; foreach my $class (@classes) { SKIP: { my($is_private_class) = map { 1 } grep { $class =~ $_->{regex} && $_->{all} } @private_classes; skip "private class: $class", 1 if $is_private_class; my %methods = map {; $_ => 1 } map { split /,/, $_->{method} } grep { $class =~ $_->{regex} } @private_classes; $methods{$_} = 1 for keys %private_methods; my $also_private = eval 'qr{^' . join('|', keys %methods ) . '$}'; pod_coverage_ok $class, { also_private => [$also_private] }; }; } pod-coverage.t100644001750001750 33414037121045 21330 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. use Test::Pod::Coverage 1.08; use Pod::Coverage::TrustPod; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); cpan-changes.t100644001750001750 34414037121045 21423 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/releaseuse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::CPAN::Changes 0.012 use Test::More 0.96 tests => 1; use Test::CPAN::Changes; subtest 'changes_ok' => sub { changes_file_ok('Changes'); }; perlcritic.rc.gen.pl100644001750001750 340414037121045 21634 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/maint#!/usr/bin/env perl ## no critic (Modules::RequireVersionVar) # ABSTRACT: Write an INI file from a bundle use 5.008; # utf8 use strict; use warnings; use utf8; our $VERSION = 0.001; use Carp qw( croak carp ); use Perl::Critic::ProfileCompiler::Util qw( create_bundle ); use Path::Tiny qw(path); ## no critic (ErrorHandling::RequireUseOfExceptions) my $bundle = create_bundle('Example::Author::KENTNL'); $bundle->configure; my @stopwords = (qw( PPI hideable regex ACKNOWLEDGEMENTS )); for my $wordlist (@stopwords) { $bundle->add_or_append_policy_field( 'Documentation::PodSpelling' => ( 'stop_words' => $wordlist ) ); } $bundle->remove_policy('Subroutines::ProhibitSubroutinePrototypes'); $bundle->remove_policy('Subroutines::RequireArgUnpacking'); $bundle->remove_policy('Subroutines::RequireFinalReturn'); #$bundle->add_or_append_policy_field( # 'Subroutines::ProhibitCallsToUndeclaredSubs' => ( 'exempt_subs' => 'String::Formatter::str_rf' ), ); #$bundle->remove_policy('ErrorHandling::RequireUseOfExceptions'); #$bundle->remove_policy('ErrorHandling::RequireCarping'); #$bundle->remove_policy('NamingConventions::Capitalization'); my $inf = $bundle->actionlist->get_inflated; my $config = $inf->apply_config; { my $rcfile = path('./perlcritic.rc')->openw_utf8; $rcfile->print( $config->as_ini, "\n" ); close $rcfile or croak 'Something fubared closing perlcritic.rc'; } my $deps = $inf->own_deps; { my $target = path('./misc'); $target->mkpath if not $target->is_dir; my $depsfile = $target->child('perlcritic.deps')->openw_utf8; for my $key ( sort keys %{$deps} ) { $depsfile->printf( "%s~%s\n", $key, $deps->{$key} ); *STDERR->printf( "%s => %s\n", $key, $deps->{$key} ); } close $depsfile or carp 'Something fubared closing perlcritic.deps'; } ppix_documentname__api1.t100644001750001750 763114037121045 22102 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/tuse strict; use warnings; use Test::More; use PPIx::DocumentName -api => 1; use PPI::Util qw( _Document ); sub check_package_node { my($name, @result) = @_; return ($name, sub { isa_ok $result[0], 'PPIx::DocumentName::Result'; is "$result[0]", 'Foo::Bar'; is $result[0]->name, 'Foo::Bar'; isa_ok $result[0]->document, 'PPI::Document'; isa_ok $result[0]->node, 'PPI::Statement::Package'; is scalar(@result), 1; }); } sub check_comment { my($name, @result) = @_; return ($name, sub { isa_ok $result[0], 'PPIx::DocumentName::Result'; is "$result[0]", 'Override'; is $result[0]->name, 'Override'; isa_ok $result[0]->document, 'PPI::Document'; isa_ok $result[0]->node, 'PPI::Token::Comment'; is scalar(@result), 1; }); } subtest 'basic' => sub { my $sample = <<'EOF'; package Foo::Bar; 1; EOF { my $result = _Document( \$sample ); isa_ok( $result, 'PPI::Document', "_Document(\\\$sample)" ); }; { my $result = PPIx::DocumentName->extract( \$sample ); subtest check_package_node '->extract() is package statement', $result; } { my @result = PPIx::DocumentName->extract( \$sample ); subtest check_package_node '->extract() is package statement (list context)', @result; } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); subtest check_package_node '->extract_via_statement() is correct', $result; } { my @result = PPIx::DocumentName->extract_via_statement( \$sample ); subtest check_package_node '->extract_via_statement() is correct (list context)', @result; } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); is( $result, undef, "->extract_via_comment() is undef" ); } { my @result = PPIx::DocumentName->extract_via_comment( \$sample ); is_deeply( \@result, [undef], "->extract_via_comment() is undef (list context)" ); } }; subtest 'Override tests' => sub { my $sample = <<'EOF'; package Foo::Bar; # PODNAME: Override 1; EOF { my $result = _Document( \$sample ); isa_ok( $result, 'PPI::Document', '_Document(\\$sample)' ); }; { my $result = PPIx::DocumentName->extract( \$sample ); subtest check_comment '->extract() gets comment override', $result; } { my @result = PPIx::DocumentName->extract( \$sample ); subtest check_comment '->extract() gets comment override (list context)', @result; } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); subtest check_package_node '->extract_via_statement() is correct', $result; } { my @result = PPIx::DocumentName->extract_via_statement( \$sample ); subtest check_package_node '->extract_via_statement() is correct (list context)', @result; } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); subtest check_comment '->extract_via_comment() gets PODNAME', $result; } { my @result = PPIx::DocumentName->extract_via_comment( \$sample ); subtest check_comment '->extract_via_comment() gets PODNAME (list context)', @result; } }; subtest 'Empty test' => sub { my $sample = ''; { my $result = PPIx::DocumentName->extract( \$sample ); is( $result, undef, "->extract()" ); } { my @result = PPIx::DocumentName->extract( \$sample ); is_deeply( \@result, [undef], "->extract() (list context)" ); } { my $result = PPIx::DocumentName->extract_via_statement( \$sample ); is( $result, undef, "->extract_via_statement()" ); } { my @result = PPIx::DocumentName->extract_via_statement( \$sample ); is_deeply( \@result, [undef], "->extract_via_statement() (list context)" ); } { my $result = PPIx::DocumentName->extract_via_comment( \$sample ); is( $result, undef, "->extract_via_comment()" ); } { my @result = PPIx::DocumentName->extract_via_comment( \$sample ); is_deeply( \@result, [undef], "->extract_via_comment() (list context)" ); } }; done_testing; ppix_documentname__api2.t100644001750001750 33014037121045 22050 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/tuse strict; use warnings; use Test::More; use PPIx::DocumentName; subtest 'basic' => sub { local $@ = ''; eval { PPIx::DocumentName->import(-api => 2) }; like $@, qr/illegal api level: 2/; }; done_testing; minimum-version.t100644001750001750 15414037121045 22113 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; use Test::MinimumVersion; all_minimum_version_from_metayml_ok(); ppix_documentname_result.t100644001750001750 74614037121045 22407 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/tuse strict; use warnings; use Test::More; use PPIx::DocumentName::Result; my $result = PPIx::DocumentName::Result->_new( 'My::Name', bless({}, 'PPI::Document'), bless({}, 'PPI::Statement::Package'), ); isa_ok $result, 'PPIx::DocumentName::Result'; is $result->name, 'My::Name', '->name'; is $result->to_string, 'My::Name', '->to_string'; is "$result", 'My::Name', '""'; isa_ok $result->document, 'PPI::Document'; isa_ok $result->node, 'PPI::Statement::Package'; done_testing; DocumentName000755001750001750 014037121045 20460 5ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/lib/PPIxResult.pm100644001750001750 576614037121045 22452 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/lib/PPIx/DocumentNamepackage PPIx::DocumentName::Result; use strict; use warnings; use 5.006; use overload '""' => sub { shift->to_string }, bool => sub { 1 }, fallback => 1; # ABSTRACT: Full result set for PPIx::DocumentName our $VERSION = '1.01'; # VERSION sub _new { my($class, $name, $document, $node) = @_; bless { name => $name, document => $document, node => $node, }, $class; } sub name { shift->{name} } sub document { shift->{document} } sub node { shift->{node} } sub to_string { shift->{name} } 1; __END__ =pod =encoding UTF-8 =head1 NAME PPIx::DocumentName::Result - Full result set for PPIx::DocumentName =head1 VERSION version 1.01 =head1 SYNOPSIS use PPIx::DocumentName 1.00 -api => 1; my $result = PPIx::DocumentName->extract( $ppi_document ); # say the "name" of the document say $result->name; # the result object can also be stringified into the name found: say "$result"; # get the full PPI::Document object for the entire document my $ppi = $result->document; # get the node where we found the name # (usually a PPI::Statement::Package or PPI::Token::Comment) my $node = $result->node; # get the location where we found the name my $location = $result->node->location; =head1 DESCRIPTION This class represents the results from L when running under its new C<< -api => 1 >> API. =head1 METHODS =head2 name my $name = $result->name; Returns the name that was found in the document. =head2 to_string my $str = $result->to_string; my $str = "$result"; Convert this object to a string. This is the same as the C method. This method will also be invoked if stringified inside a double quoted string. =head2 document my $ppi = $result->document; Returns the L of the document. =head2 node my $node = $result->node; Returns the L where the name was found. This will usually be either L or L, although other types could be used in the future. =head1 SEE ALSO =over 4 =item L Main module that generates objects of this class. =back =head1 CAVEATS For C to be useful, the C object needs to remain in scope, this is the main reason the result object keeps it around, so if you want to use the C to get the location information, make sure that you do not throw away the result object. Bad: my $node = PPIx::DocumentName->extract( $ppi_document )->node; my $location = $node->location; # undef Fine: my $result = PPIx::DocumentName->extract( $ppi_document ); my $node = $result->node; my $location = $node->location; # ok =head1 AUTHORS =over 4 =item * Kent Fredric =item * Graham Ollis =back =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2015-2021 by Kent Fredric . 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 pod_spelling_common.t100644001750001750 135014037121045 23023 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::Pod::Spelling::CommonMistakes' unless eval q{ use Test::Pod::Spelling::CommonMistakes; 1 }; plan skip_all => 'test requires YAML' unless eval q{ use YAML qw( LoadFile ); 1 }; }; use Test::Pod::Spelling::CommonMistakes; use FindBin; use File::Spec; my $config_filename = File::Spec->catfile( $FindBin::Bin, File::Spec->updir, File::Spec->updir, 'author.yml' ); my $config; $config = LoadFile($config_filename) if -r $config_filename; plan skip_all => 'disabled' if $config->{pod_spelling_common}->{skip}; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); # TODO: test files in bin too. all_pod_files_ok; pod_spelling_system.t100644001750001750 237014037121045 23062 0ustar00ollisgollisg000000000000PPIx-DocumentName-1.01/xt/authoruse strict; use warnings; use Test::More; BEGIN { plan skip_all => 'test requires Test::Spelling' unless eval q{ use Test::Spelling; 1 }; plan skip_all => 'test requires YAML' unless eval q{ use YAML; 1; }; }; use Test::Spelling; use YAML qw( LoadFile ); use FindBin; use File::Spec; my $config_filename = File::Spec->catfile( $FindBin::Bin, File::Spec->updir, File::Spec->updir, 'author.yml' ); my $config; $config = LoadFile($config_filename) if -r $config_filename; plan skip_all => 'disabled' if $config->{pod_spelling_system}->{skip}; chdir(File::Spec->catdir($FindBin::Bin, File::Spec->updir, File::Spec->updir)); add_stopwords(@{ $config->{pod_spelling_system}->{stopwords} }); add_stopwords(qw( Plicease stdout stderr stdin subref loopback username os Ollis Mojolicious plicease CPAN reinstall TODO filename filenames login callback callbacks standalone VMS hostname hostnames TCP UDP IP API MSWin32 OpenBSD FreeBSD NetBSD unencrypted WebSocket WebSockets timestamp timestamps poney BackPAN portably RedHat AIX BSD XS FFI perlish optimizations subdirectory RESTful SQLite JavaScript dir plugins munge jQuery namespace PDF PDFs usernames DBI pluggable APIs SSL JSON YAML uncommented Solaris OpenVMS URI URL CGI )); all_pod_files_spelling_ok;