Module::Metadata - Gather package and POD information from perl module files
use Module::Metadata;# information about a .pm filemy $info = Module::Metadata->new_from_file( $file );my $version = $info->version;# CPAN META 'provides' field for .pm files in a directorymy $provides = Module::Metadata->provides( dir => 'lib', version => 2);This module provides a standard way to gather metadata about a .pm file without executing unsafe code.
new_from_file($filename, collect_pod => 1)Construct aModule::Metadata object given the path to a file. Takes an optional argumentcollect_pod which is a boolean that determines whether POD data is collected and stored for reference. POD data is not collected by default. POD headings are always collected. Returns undef if the filename does not exist.
new_from_handle($handle, $filename, collect_pod => 1)This works just likenew_from_file, except that a handle can be provided as the first argument. Note that there is no validation to confirm that the handle is a handle or something that can act like one. Passing something that isn't a handle will cause a exception when trying to read from it. Thefilename argument is mandatory or undef will be returned.
new_from_module($module, collect_pod => 1, inc => \@dirs)Construct aModule::Metadata object given a module or package name. In addition to accepting thecollect_pod argument as described above, this method accepts ainc argument which is a reference to an array of of directories to search for the module. If none are given, the default is @INC. Returns undef if the module cannot be found.
find_module_by_name($module, \@dirs)Returns the path to a module given the module or package name. A list of directories can be passed in as an optional parameter, otherwise @INC is searched.
Can be called as either an object or a class method.
find_module_dir_by_name($module, \@dirs)Returns the entry in@dirs (or@INC by default) that contains the module$module. A list of directories can be passed in as an optional parameter, otherwise @INC is searched.
Can be called as either an object or a class method.
provides( %options )This is a convenience wrapper aroundpackage_versions_from_directory to generate a CPAN METAprovides data structure. It takes key/value pairs. Valid option keys include:
Specifies which version of theCPAN::Meta::Spec should be used as the format of theprovides output. Currently only '1.4' and '2' are supported (and their format is identical). This may change in the future as the definition ofprovides changes.
Theversion option is required. If it is omitted or if an unsupported version is given, thenprovides will throw an error.
Directory to search recursively for.pm files. May not be specified withfiles.
Array reference of files to examine. May not be specified withdir.
String to prepend to thefile field of the resulting output. This defaults tolib, which is the common case for most CPAN distributions with their.pm files inlib. This option ensures the META information has the correct relative path even when thedir orfiles arguments are absolute or have relative paths from a location other than the distribution root.
For example, givendir of 'lib' andprefix of 'lib', the return value is a hashref of the form:
{ 'Package::Name' => { version => '0.123', file => 'lib/Package/Name.pm' }, 'OtherPackage::Name' => ...}package_versions_from_directory($dir, \@files?)Scans$dir for .pm files (unless@files is given, in which case looks for those files in$dir - and reads each file for packages and versions, returning a hashref of the form:
{ 'Package::Name' => { version => '0.123', file => 'Package/Name.pm' }, 'OtherPackage::Name' => ...}TheDB andmain packages are always omitted, as are any "private" packages that have leading underscores in the namespace (e.g.Foo::_private)
Note that the file path is relative to$dir if that is specified. Thismust not be used directly for CPAN METAprovides. See theprovides method instead.
log_info (internal)Used internally to perform logging; imported from Log::Contextual if Log::Contextual has already been loaded, otherwise simply calls warn.
name()Returns the name of the package represented by this module. If there are more than one packages, it makes a best guess based on the filename. If it's a script (i.e. not a *.pm) the package name is 'main'.
version($package)Returns the version as defined by the $VERSION variable for the package as returned by thename method if no arguments are given. If given the name of a package it will attempt to return the version of that package if it is specified in the file.
filename()Returns the absolute path to the file.
packages_inside()Returns a list of packages. Note: this is a raw list of packages discovered (or assumed, in the case ofmain). It is not filtered forDB,main or private packages the way theprovides method does.
pod_inside()Returns a list of POD sections.
contains_pod()Returns true if there is any POD in the file.
pod($section)Returns the POD data in the given section.
Original code from Module::Build::ModuleInfo by Ken Williams <kwilliams@cpan.org>, Randy W. Sims <RandyS@ThePierianSpring.org>
Released as Module::Metadata by Matt S Trout (mst) <mst@shadowcat.co.uk> with assistance from David Golden (xdg) <dagolden@cpan.org>.
Original code Copyright (c) 2001-2011 Ken Williams. Additional code Copyright (c) 2010-2011 Matt Trout and David Golden. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.