perl::prereqscanner::scanner::perl5(3pm) [debian man page]

Perl::PrereqScanner::Scanner::Perl5(3pm)		User Contributed Perl Documentation		  Perl::PrereqScanner::Scanner::Perl5(3pm)

NAME

       Perl::PrereqScanner::Scanner::Perl5 - scan for core Perl 5 language indicators of required modules

VERSION

       version 1.012

DESCRIPTION

       This scanner will look for the following indicators:

       o   plain lines beginning with "use" or "require" in your perl modules and scripts, including minimum perl version

       o   regular inheritance declared with the "base" and "parent" pragmata

       Since Perl does not allow you to supply a version requirement with a "require" statement, the scanner will check the statement after the
       "require Module" to see if it is "Module->VERSION( minimum_version );".

       In order to provide a minimum version, that method call must meet the following requirements:

       o   it must be the very next statement after "require Module".  Nothing can separate them but whitespace and comments (and one semicolon).

       o   "Module" must be a bareword, and match the "require" exactly.

       o   "minimum_version" must be a literal number, v-string, or single-quoted string.  Double quotes are not allowed.

AUTHORS

       o   Jerome Quelin

       o   Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       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.

perl v5.14.2							    2012-06-27				  Perl::PrereqScanner::Scanner::Perl5(3pm)

Perl::PrereqScanner(3pm)				User Contributed Perl Documentation				  Perl::PrereqScanner(3pm)

NAME

       Perl::PrereqScanner - a tool to scan your Perl code for its prerequisites

VERSION

       version 1.012

SYNOPSIS

	 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 );

DESCRIPTION

       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:

       o   plain lines beginning with "use" or "require" in your perl modules and scripts, including minimum perl version

       o   regular inheritance declared with the "base" and "parent" pragmata

       o   Moose inheritance declared with the "extends" keyword

       o   Moose roles included with the "with" keyword

       o   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) ] });

METHODS

   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.

   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.

AUTHORS

       o   Jerome Quelin

       o   Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       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.

perl v5.14.2							    2012-06-27						  Perl::PrereqScanner(3pm)