new

  Dist::Metadata->new(file => $path);

A dist can be represented by a tar file, a directory, or a data structure.

The format will be determined by the presence of the following options (checked in this order):

• "struct" - hash of data to build a mock dist; See Dist::Metadata::Struct.
• "dir" - path to the root directory of a dist
• "file" - the path to a .tar.gz file

You can also slyly pass in your own object as a "dist" parameter in which case this module will just use that. This can be useful if you need to use your own subclass (perhaps while developing a new format).

Other options that can be specified:

• "name" - dist name
• "version" - dist version
• "determine_packages" - boolean to indicate whether dist should be searched for packages if no META file is found. Defaults to true.
• "include_inner_packages" - When determining provided packages the default behavior is to only include packages that match the name of the file that defines them (like "Foo::Bar" matches "*/Bar.pm"). This way only modules that can be loaded (via "use" or "require") will be returned (and "inner" packages will be ignored). This mimics the behavior of PAUSE. Set this to true to include any "inner" packages provided by the dist (that are not otherwise excluded by another mechanism (such as "no_index")).

dist

default_metadata

determine_metadata

determine_packages

  my $provides = $dm->determine_packages($meta);

Attempt to determine packages provided by the dist. This is used when the META file does not include a "provides" section and "determine_packages" is not set to false in the constructor.

If a CPAN::Meta object is not provided a default one will be used. Files contained in the dist and packages found therein will be checked against the meta object's "no_index" attribute (see "should_index_file" in CPAN::Meta and "should_index_package" in CPAN::Meta). By default this ignores any files found in inc/, t/, or xt/ directories.

load_meta

meta

meta_from_struct

  $meta = $dm->meta_from_struct(\%struct);

Passes the provided "\%struct" to "create" in CPAN::Meta and returns the result.

package_versions

  $pv = $dm->package_versions();
  # { 'Package::Name' => '1.0', 'Module::2' => '2.1' }

Returns a simplified version of "provides": a hashref with package names as keys and versions as values.

This can also be called as a class method which will operate on a passed in hashref.

  $pv = Dist::Metadata->package_versions(\%provides);

module_info

The hashref starts with the same data as "provides" but additional data can be added to the output by specifying options in a hashref:

"checksum"

Use the specified algorithm to compute a hex digest of the file. The type you specify will be the key in the returned hashref. You can use an arrayref to specify more than one type.

  $dm->module_info({checksum => ['sha256', 'md5']});
  # returns:
  {
    'Mod::Name' => {
      file    => 'lib/Mod/Name.pm',
      version => '0.1',
      md5     => '258e88dcbd3cd44d8e7ab43f6ecb6af0',
      sha256  => 'f22136124cd3e1d65a48487cecf310771b2fd1e83dc032e3d19724160ac0ff71',
    },
  }
    

See "file_checksum" in Dist::Metadata::Dist for more information.

"provides"

The default is to start with the hashref returned from "provides" but you can pass in an alternate hashref using this key.

Other options may be added in the future.

Dependencies

• CPAN::Meta
• Module::Metadata
• CPAN::DistnameInfo

Related Modules

• MyCPAN::Indexer
• CPAN::ParseDistribution

Perldoc

  perldoc Dist::Metadata

Websites

•

MetaCPAN

A modern, open-source CPAN search engine, useful to view POD in HTML format.

<http://metacpan.org/release/Dist-Metadata>

Bugs / Feature Requests

Source Code

  git clone https://github.com/rwstauner/Dist-Metadata.git