NAME

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

VERSION

version 0.100491

SYNOPSIS

  use Perl::PrereqScanner;
  my $scan    = Perl::PrereqScanner->new;
  my $prereqs = $scan->scan_ppi_document( $ppi_doc );
  my $prereqs = $scan->scan_file( $file_path );
  my $prereqs = $scan->scan_string( $perl_code );

  # or using class methods
  my $prereqs = Perl::PrereqScanner->scan_ppi_document( $ppi_doc );

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:

• plain lines beginning with use or require in your perl modules and scripts. This includes minimum perl version.

• regular inheritance declated with the base and parent pragamata.

• Moose inheritance declared with the extends keyword.

• Moose roles included with the with keyword.

It will trim the following pragamata: strict, warnings, base and lib. However, parent is kept, since it's not in a core module.

METHODS

my $prereqs = $scanner->scan_string( $perl_code );

Return a list of prereqs with their minimum version (0 if no minimum specified) given a string of Perl code.

my $prereqs = $scanner->scan_file( $path );

Return a list of prereqs with their minimum version (0 if no minimum specified) given a path to a Perl file.

my $prereqs = $scanner->scan_ppi_document( $ppi_doc );

Return a list of prereqs with their minimum version (0 if no minimum specified) given a PPI document.

AUTHOR

  Jerome Quelin

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.