diff options
author | dakkar <dakkar@thenautilus.net> | 2016-08-29 16:51:59 +0100 |
---|---|---|
committer | dakkar <dakkar@thenautilus.net> | 2016-08-29 16:51:59 +0100 |
commit | c06804f6922dce1548dc6328f66d374a62fd322e (patch) | |
tree | b50c9dbd6f20c8944da9f835aabcf6f34b082da6 | |
parent | v2.02 (diff) | |
download | PPIx-XPath-e57c78d43be4396f40615a6ae3ca283cac4a971e.tar.gz PPIx-XPath-e57c78d43be4396f40615a6ae3ca283cac4a971e.tar.bz2 PPIx-XPath-e57c78d43be4396f40615a6ae3ca283cac4a971e.zip |
Dzil-build release 2.02 (from b0325e7 on master)v2.02
-rw-r--r-- | .gitignore | 14 | ||||
-rw-r--r-- | Changes | 2 | ||||
-rw-r--r-- | LICENSE | 379 | ||||
-rw-r--r-- | MANIFEST | 16 | ||||
-rw-r--r-- | META.json | 63 | ||||
-rw-r--r-- | META.yml | 30 | ||||
-rw-r--r-- | Makefile.PL | 57 | ||||
-rw-r--r-- | dist.ini | 83 | ||||
-rw-r--r-- | lib/PPIx/XPath.pm | 265 | ||||
-rw-r--r-- | t/author-critic.t | 20 | ||||
-rw-r--r-- | t/author-no-tabs.t | 25 | ||||
-rw-r--r-- | t/author-pod-coverage.t | 15 | ||||
-rw-r--r-- | t/author-pod-syntax.t | 15 | ||||
-rw-r--r-- | weaver.ini | 31 |
14 files changed, 773 insertions, 242 deletions
diff --git a/.gitignore b/.gitignore deleted file mode 100644 index c4e5fd1..0000000 --- a/.gitignore +++ /dev/null @@ -1,14 +0,0 @@ -blib -pm_to_blib -*.sw? -Makefile -Makefile.old -MANIFEST.bak -*.tar.gz -/inc/ -/META.* -/MYMETA.* -.prove -*~ -/.build/ -/PPIx-XPath-*
\ No newline at end of file @@ -1,5 +1,3 @@ -{{$NEXT}} - 2.02 2016-08-29 16:51:53+01:00 Europe/London - fixed example code as per RT#116737, thanks Alastair Cooke - more documentation @@ -0,0 +1,379 @@ +This software is copyright (c) 2016 by Gianni Ceccarelli <dakkar@thenautilus.net>. + +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) 2016 by Gianni Ceccarelli <dakkar@thenautilus.net>. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2016 by Gianni Ceccarelli <dakkar@thenautilus.net>. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..d304fa7 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,16 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.007. +Changes +LICENSE +MANIFEST +META.json +META.yml +Makefile.PL +lib/PPIx/XPath.pm +perlcritic.rc +t/01-use.t +t/02-back-compat.t +t/03-advanced.t +t/author-critic.t +t/author-no-tabs.t +t/author-pod-coverage.t +t/author-pod-syntax.t diff --git a/META.json b/META.json new file mode 100644 index 0000000..9023c1d --- /dev/null +++ b/META.json @@ -0,0 +1,63 @@ +{ + "abstract" : "an XPath implementation for the PDOM", + "author" : [ + "Gianni Ceccarelli <dakkar@thenautilus.net>" + ], + "dynamic_config" : 0, + "generated_by" : "Dist::Zilla version 6.007, CPAN::Meta::Converter version 2.150005", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : 2 + }, + "name" : "PPIx-XPath", + "no_index" : { + "directory" : [ + "t/lib" + ] + }, + "prereqs" : { + "configure" : { + "requires" : { + "ExtUtils::MakeMaker" : "0" + } + }, + "develop" : { + "requires" : { + "Pod::Coverage::TrustPod" : "0", + "Test::More" : "0.88", + "Test::NoTabs" : "0", + "Test::Pod" : "1.41", + "Test::Pod::Coverage" : "1.08" + } + }, + "runtime" : { + "requires" : { + "Carp" : "0", + "PPI" : "0", + "Scalar::Util" : "0", + "Tree::XPathEngine" : "0", + "perl" : "5.006", + "strict" : "0", + "warnings" : "0" + } + }, + "test" : { + "requires" : { + "Test::Most" : "0" + } + } + }, + "release_status" : "stable", + "resources" : { + "repository" : { + "type" : "git", + "url" : "git://luxion/PPIx-XPath" + } + }, + "version" : "2.02", + "x_serialization_backend" : "Cpanel::JSON::XS version 3.0217" +} + diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..4881d4d --- /dev/null +++ b/META.yml @@ -0,0 +1,30 @@ +--- +abstract: 'an XPath implementation for the PDOM' +author: + - 'Gianni Ceccarelli <dakkar@thenautilus.net>' +build_requires: + Test::Most: '0' +configure_requires: + ExtUtils::MakeMaker: '0' +dynamic_config: 0 +generated_by: 'Dist::Zilla version 6.007, CPAN::Meta::Converter version 2.150005' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: PPIx-XPath +no_index: + directory: + - t/lib +requires: + Carp: '0' + PPI: '0' + Scalar::Util: '0' + Tree::XPathEngine: '0' + perl: '5.006' + strict: '0' + warnings: '0' +resources: + repository: git://luxion/PPIx-XPath +version: '2.02' +x_serialization_backend: 'YAML::Tiny version 1.69' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..49965e3 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,57 @@ +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.007. +use strict; +use warnings; + +use 5.006; + +use ExtUtils::MakeMaker; + +my %WriteMakefileArgs = ( + "ABSTRACT" => "an XPath implementation for the PDOM", + "AUTHOR" => "Gianni Ceccarelli <dakkar\@thenautilus.net>", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "PPIx-XPath", + "LICENSE" => "perl", + "MIN_PERL_VERSION" => "5.006", + "NAME" => "PPIx::XPath", + "PREREQ_PM" => { + "Carp" => 0, + "PPI" => 0, + "Scalar::Util" => 0, + "Tree::XPathEngine" => 0, + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "Test::Most" => 0 + }, + "VERSION" => "2.02", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "Carp" => 0, + "PPI" => 0, + "Scalar::Util" => 0, + "Test::Most" => 0, + "Tree::XPathEngine" => 0, + "strict" => 0, + "warnings" => 0 +); + + +unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { + delete $WriteMakefileArgs{TEST_REQUIRES}; + delete $WriteMakefileArgs{BUILD_REQUIRES}; + $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; +} + +delete $WriteMakefileArgs{CONFIGURE_REQUIRES} + unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; + +WriteMakefile(%WriteMakefileArgs); diff --git a/dist.ini b/dist.ini deleted file mode 100644 index d0862f3..0000000 --- a/dist.ini +++ /dev/null @@ -1,83 +0,0 @@ -name = PPIx-XPath -author = Gianni Ceccarelli <dakkar@thenautilus.net> -license = Perl_5 -copyright_holder = Gianni Ceccarelli <dakkar@thenautilus.net> -copyright_year = 2016 - -[GatherDir] - -[PodWeaver] -; authordep Pod::Elemental::Transformer::List - -[PruneCruft] - -[PruneFiles] -match = ~$ -filename = dist.ini -filename = weaver.ini - -[Git::Check] -allow_dirty = dist.ini - -[Git::NextVersion] -first_version = 0.0.1 - -[CheckChangeLog] - -[NextRelease] - -[AutoPrereqs] - -[OurPkgVersion] - -[ManifestSkip] - -[Test::NoTabs] - -[Test::Perl::Critic] - -[PodCoverageTests] - -[PodSyntaxTests] - -[ExtraTests] - -[Repository] - -[MetaNoIndex] -directory = t/lib - -[MetaYAML] - -[MetaJSON] - -[ExecDir] -dir = scripts - -[ShareDir] - -[MakeMaker] - -[Manifest] - -[License] - -[TestRelease] - -[Git::Commit] - -[Git::CommitBuild] -branch = -release_branch = release/%b -release_message = Dzil-build release %v (from %h on %b) -multiple_inheritance = 1 - -[Git::Tag / master] -tag_format = v%v%t-dzilla - -[Git::Tag / release] -branch = release/master -tag_format = v%v%t - -[ConfirmRelease] -[UploadToCPAN] diff --git a/lib/PPIx/XPath.pm b/lib/PPIx/XPath.pm index a4e7609..8fc6b95 100644 --- a/lib/PPIx/XPath.pm +++ b/lib/PPIx/XPath.pm @@ -6,67 +6,10 @@ use Carp; use Scalar::Util qw(reftype blessed); use Tree::XPathEngine; use 5.006; -# VERSION +our $VERSION = '2.02'; # VERSION # ABSTRACT: an XPath implementation for the PDOM -=head1 SYNOPSIS - - use PPI; - use PPIx::XPath; - use Tree::XPathEngine; - - my $pdom = PPI::Document->new('some_code.pl'); - my $xpath = Tree::XPathEngine->new(); - my @subs = $xpath->findnodes('//Statement-Sub',$pdom); - my @vars = $xpath->findnodes('//Token-Symbol',$pdom); - -Deprecated interface, backward-compatible with C<PPIx::XPath> version -1: - - use PPIx::XPath; - - my $pxp = PPIx::XPath->new("some_code.pl"); - my @subs = $pxp->match("//Statement::Sub"); - my $vars = $pxp->match("//Token::Symbol"); - -=head1 DESCRIPTION - -This module augments L<PPI>'s classes with the methods required by -L<Tree::XPathEngine>, allowing you to perform complex XPath matches -against any PDOM tree. - -See L<Tree::XPathEngine> for details about its methods. - -=head2 Mapping the PDOM to the XPath data model - -=begin :list - -* Each node in the PDOM is an element as seen by XPath - -* The name of the element is the class name of the node, minus the -initial C<PPI::>, with C<::> replaced by C<->. That is: - - ($xpath_name = substr($pdom_node->class,5)) =~ s/::/-/g; - -* Only "significant" nodes are seen by XPath - -* all scalar-valued accessors of PDOM nodes are visible as attributes - -* "here-docs" contents are I<not> mapped - -=end :list - -=method C<new> - - my $pxp = PPIx::XPath->new("some_code.pl"); - - my $pxp = PPIx::XPath->new($pdom); - -Only useful for the backward-compatible, and deprecated, interface. -Returns an instance of C<PPIx::XPath> tied to the given document. - -=cut sub new { my ($class,$source) = @_; @@ -89,21 +32,6 @@ sub new { return bless {doc=>$doc},$class; } -=method C<clean_xpath_expr> - - my $new_xpath_expr = $pxp->clean_xpath_expr($old_xpath_expr); - -C<PPIx::XPath> version 1.0.0 allowed the use of partial package names -(like C<Token::Number>) as element names: this collides with the axis -specification of proper XPath. For this reason, in newer version of -C<PPIx::XPath>, the element name is the class name of the PDOM node, -minus the initial C<PPI::>, with C<::> replaced by C<-> (like -C<Token-Number>). - -This method replaces all occurrences of PPI package names in the given -string with the new names. - -=cut { my $legacy_names_rx;my %new_name_for; @@ -158,23 +86,6 @@ string with the new names. $legacy_names_rx=qr{$legacy_names_rx}; } -=method C<match> - - my @subs = $pxp->match("//Statement::Sub"); - my $vars = $pxp->match("//Token::Symbol"); - -Only useful for the backward-compatible, and deprecated, -interface. From the document this instance was built against, returns -the nodes that match the given XPath expression. - -You should not use this method, you should call L<< -C<findnodes>|Tree::XPathEngine/findnodes >> instead: - - my $xpath = Tree::XPathEngine->new(); - my @subs = $xpath->findnodes('//Statement-Sub',$pdom); - my @vars = $xpath->findnodes('//Token-Symbol',$pdom); - -=cut sub match { my ($self,$expr) = @_; @@ -184,28 +95,6 @@ sub match { Tree::XPathEngine->new()->findnodes($expr,$self->{doc}); } -=head1 BUGS and LIMITATIONS - -=for :list -* "here-docs" contents are I<not> mapped -* node ordering is slow, because I could not find a way in PPI to -compare two nodes for document order; suggestions are most welcome - -=head1 SEE ALSO - -L<PPI> - -L<Tree::XPathEngine> - -L<http://www.w3.org/TR/xpath> (the XPath specification) - -=head1 AUTHORS - -Dan Brook <cpan@broquaint.com> original author - -Gianni Ceccarelli <dakkar@thenautilus.net> Tree::XPathEngine-based re-implementation - -=cut package PPI::Element; ## no critic(ProhibitMultiplePackages) use strict; @@ -507,3 +396,155 @@ sub xpath_cmp { } 1; + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +PPIx::XPath - an XPath implementation for the PDOM + +=head1 VERSION + +version 2.02 + +=head1 SYNOPSIS + + use PPI; + use PPIx::XPath; + use Tree::XPathEngine; + + my $pdom = PPI::Document->new('some_code.pl'); + my $xpath = Tree::XPathEngine->new(); + my @subs = $xpath->findnodes('//Statement-Sub',$pdom); + my @vars = $xpath->findnodes('//Token-Symbol',$pdom); + +Deprecated interface, backward-compatible with C<PPIx::XPath> version +1: + + use PPIx::XPath; + + my $pxp = PPIx::XPath->new("some_code.pl"); + my @subs = $pxp->match("//Statement::Sub"); + my $vars = $pxp->match("//Token::Symbol"); + +=head1 DESCRIPTION + +This module augments L<PPI>'s classes with the methods required by +L<Tree::XPathEngine>, allowing you to perform complex XPath matches +against any PDOM tree. + +See L<Tree::XPathEngine> for details about its methods. + +=head2 Mapping the PDOM to the XPath data model + +=over 4 + +=item * + +Each node in the PDOM is an element as seen by XPath + +=item * + +The name of the element is the class name of the node, minus the + +initial C<PPI::>, with C<::> replaced by C<->. That is: + + ($xpath_name = substr($pdom_node->class,5)) =~ s/::/-/g; + +=item * + +Only "significant" nodes are seen by XPath + +=item * + +all scalar-valued accessors of PDOM nodes are visible as attributes + +=item * + +"here-docs" contents are I<not> mapped + +=back + +=head1 METHODS + +=head2 C<new> + + my $pxp = PPIx::XPath->new("some_code.pl"); + + my $pxp = PPIx::XPath->new($pdom); + +Only useful for the backward-compatible, and deprecated, interface. +Returns an instance of C<PPIx::XPath> tied to the given document. + +=head2 C<clean_xpath_expr> + + my $new_xpath_expr = $pxp->clean_xpath_expr($old_xpath_expr); + +C<PPIx::XPath> version 1.0.0 allowed the use of partial package names +(like C<Token::Number>) as element names: this collides with the axis +specification of proper XPath. For this reason, in newer version of +C<PPIx::XPath>, the element name is the class name of the PDOM node, +minus the initial C<PPI::>, with C<::> replaced by C<-> (like +C<Token-Number>). + +This method replaces all occurrences of PPI package names in the given +string with the new names. + +=head2 C<match> + + my @subs = $pxp->match("//Statement::Sub"); + my $vars = $pxp->match("//Token::Symbol"); + +Only useful for the backward-compatible, and deprecated, +interface. From the document this instance was built against, returns +the nodes that match the given XPath expression. + +You should not use this method, you should call L<< +C<findnodes>|Tree::XPathEngine/findnodes >> instead: + + my $xpath = Tree::XPathEngine->new(); + my @subs = $xpath->findnodes('//Statement-Sub',$pdom); + my @vars = $xpath->findnodes('//Token-Symbol',$pdom); + +=head1 BUGS and LIMITATIONS + +=over 4 + +=item * + +"here-docs" contents are I<not> mapped + +=item * + +node ordering is slow, because I could not find a way in PPI to + +compare two nodes for document order; suggestions are most welcome + +=back + +=head1 SEE ALSO + +L<PPI> + +L<Tree::XPathEngine> + +L<http://www.w3.org/TR/xpath> (the XPath specification) + +=head1 AUTHORS + +Dan Brook <cpan@broquaint.com> original author + +Gianni Ceccarelli <dakkar@thenautilus.net> Tree::XPathEngine-based re-implementation + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2016 by Gianni Ceccarelli <dakkar@thenautilus.net>. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=cut diff --git a/t/author-critic.t b/t/author-critic.t new file mode 100644 index 0000000..f521491 --- /dev/null +++ b/t/author-critic.t @@ -0,0 +1,20 @@ +#!perl + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + print "1..0 # SKIP these tests are for testing by the author\n"; + exit + } +} + + +use strict; +use warnings; + +use Test::More; +use English qw(-no_match_vars); + +eval "use Test::Perl::Critic"; +plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; +Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; +all_critic_ok(); diff --git a/t/author-no-tabs.t b/t/author-no-tabs.t new file mode 100644 index 0000000..b08d52b --- /dev/null +++ b/t/author-no-tabs.t @@ -0,0 +1,25 @@ + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + print "1..0 # SKIP these tests are for testing by the author\n"; + exit + } +} + +use strict; +use warnings; + +# this test was generated with Dist::Zilla::Plugin::Test::NoTabs 0.15 + +use Test::More 0.88; +use Test::NoTabs; + +my @files = ( + 'lib/PPIx/XPath.pm', + 't/01-use.t', + 't/02-back-compat.t', + 't/03-advanced.t' +); + +notabs_ok($_) foreach @files; +done_testing; diff --git a/t/author-pod-coverage.t b/t/author-pod-coverage.t new file mode 100644 index 0000000..463d8eb --- /dev/null +++ b/t/author-pod-coverage.t @@ -0,0 +1,15 @@ +#!perl + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + print "1..0 # SKIP these tests are for testing by the author\n"; + exit + } +} + +# 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' }); diff --git a/t/author-pod-syntax.t b/t/author-pod-syntax.t new file mode 100644 index 0000000..858ff45 --- /dev/null +++ b/t/author-pod-syntax.t @@ -0,0 +1,15 @@ +#!perl + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + print "1..0 # SKIP these tests are for testing by the author\n"; + exit + } +} + +# 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(); diff --git a/weaver.ini b/weaver.ini deleted file mode 100644 index 443e9cf..0000000 --- a/weaver.ini +++ /dev/null @@ -1,31 +0,0 @@ -[@CorePrep] - -[-SingleEncoding] - -[Name] -[Version] - -[Region / prelude] - -[Generic / SYNOPSIS] -[Generic / DESCRIPTION] -[Generic / OVERVIEW] - -[Collect / ATTRIBUTES] -command = attr - -[Collect / METHODS] -command = method - -[Collect / FUNCTIONS] -command = func - -[Leftovers] - -[Region / postlude] - -[Legal] - -[-Transformer / Lists] -transformer = List -format_name = list |