Perl::PrereqScanner - a tool to scan your Perl code for its prerequisites
version 1.100
use Perl::PrereqScanner;
my $scanner = Perl::PrereqScanner->new;
my $prereqs = $scanner->scan_ppi_document( $ppi_doc );
my $prereqs = $scanner->scan_file( $file_path );
my $prereqs = $scanner->scan_string( $perl_code );
my $prereqs = $scanner->scan_module( $module_name );
The scanner will extract loosely your distribution prerequisites from your files.
The extraction may not be perfect but tries to do its best. It will currently find the following prereqs:
• |
plain lines beginning with "use" or "require" in your perl modules and scripts, including minimum perl version |
||
• |
regular inheritance declared with the "base" and "parent" pragmata |
||
• |
Moose inheritance declared with the "extends" keyword |
||
• |
Moose roles included with the "with" keyword |
||
• |
OO namespace aliasing using the "aliased" module |
Scanner Plugins
Perl::PrereqScanner works by running a series of scanners over a PPI::Document representing the code to scan. By default the "Perl5", "Moose", "TestMore", "POE", and "Aliased" scanners are run. You can supply your own scanners when constructing your PrereqScanner:
# Us only the Perl5 scanner:
my $scanner = Perl::PrereqScanner->new({ scanners => [ qw(Perl5) ] });
# Use any stock scanners, plus Example:
my $scanner = Perl::PrereqScanner->new({ extra_scanners => [ qw(Example) ] });
This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
scan_string
my $prereqs = $scanner->scan_string( $perl_code );
Given a string containing Perl source code, this method returns a CPAN::Meta::Requirements object describing the modules it requires.
This method will throw an exception if PPI fails to parse the code.
Warning! It isn’t entirely clear whether PPI prefers to receive strings as octet strings or character strings. For now, my advice is to pass octet strings.
scan_file
my $prereqs = $scanner->scan_file( $path );
Given a file path to a Perl document, this method returns a CPAN::Meta::Requirements object describing the modules it requires.
This method will throw an exception if PPI fails to parse the code.
scan_ppi_document
my $prereqs = $scanner->scan_ppi_document( $ppi_doc );
Given a PPI::Document, this method returns a CPAN::Meta::Requirements object describing the modules it requires.
scan_module
my $prereqs = $scanner->scan_module( $module_name );
Given the name of a module, eg 'PPI::Document', this method returns a CPAN::Meta::Requirements object describing the modules it requires.
scan-perl-prereqs, in this distribution, is a command-line interface to the scanner
• |
Jerome Quelin |
|||
• |
Ricardo Signes <cpan AT semiotic DOT systems> |
• |
bowtie <bowtie AT cpan DOT org> |
||
• |
celogeek <me AT celogeek DOT com> |
||
• |
Christopher J. Madsen <perl AT cjmweb DOT net> |
||
• |
Dan Book <grinnz AT grinnz DOT com> |
||
• |
David Golden <dagolden AT cpan DOT org> |
||
• |
David Steinbrunner <dsteinbrunner AT pobox DOT com> |
||
• |
Ed J <mohawk2 AT users DOT noreply DOT github DOT com> |
||
• |
Florian Ragwitz <rafl AT debian DOT org> |
||
• |
Jakob Voss <voss AT gbv DOT de> |
||
• |
Jérôme Quelin <jquelin AT gmail DOT com> |
||
• |
John SJ Anderson <genehack AT genehack DOT org> |
||
• |
Karen Etheridge <ether AT cpan DOT org> |
||
• |
Mark Gardner <gardnerm AT gsicommerce DOT com> |
||
• |
Neil Bowers <neil AT bowers DOT com> |
||
• |
Randy Stauner <rwstauner AT cpan DOT org> |
||
• |
Ricardo Signes <rjbs AT semiotic DOT systems> |
||
• |
Tina Mueller <tinita AT cpan DOT org> |
||
• |
Vyacheslav Matjukhin <mmcleric@yandex-team.ru> |
This software is copyright (c) 2009 by Jerome Quelin.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.