Simple constructor that subclasses can inherit. Ensures the presence of required_attribute if defined by the subclass.
Defaults to Native in the base class which will let File::Spec determine the value.
Some dist formats may define a way to determine the name and version.
$packages = $dist->determine_packages(@files);
Search the specified files (or all files if unspecified) for perl packages.
$ddir = $dist->extract_into($dir); ($ddir, @dfiles) = $dist->extract_into($dir, @files);
Extracts the specified files (or all files if not specified) into the specified directory.
In list context this returns a list of the directory (which may be a subdirectory of the $dir passed in) and the files extracted (in native OS (on-disk) format).
In scalar context just the directory is returned.
Returns the content for the specified file from the dist.
Returns a checksum (hex digest) of the file content.
The Digest module is used to generate the checksums. The value specified should be one accepted by Digest->new. A small effort is made to translate simpler names like md5 into MD5 and sha1 into SHA-1 (which are the names Digest expects).
If the type of checksum is not specified md5 will be used.
Determine the files contained in the dist.
This is called from list_files and cached on the object.
Returns the OS name of the File::Spec module used for this format. This is mostly so subclasses can define a specific one (as default_file_spec) if necessary.
A file_spec attribute can be passed to the constructor to override the default.
<B>NOTEB>: This is used for the internal format of the dist. Tar archives, for example, are always in unix format. For operations outside of the dist, the format determined by File::Spec will always be used.
Used internally to put the root directory back onto the file.
Returns a list of the files in the dist starting at the dist root.
This calls find_files to get a listing of the contents of the dist, determines (and caches) the root directory (if any), caches and returns the list of files with the root dir stripped.
@files = $dist->list_files; # something like qw( README META.yml lib/Mod.pm )
The dist name if it could be determined.
$provides = $dist->packages_from_directory($dir, @files);
Determines the packages provided by the perl modules found in a directory. This is thin wrapper around package_versions_from_directory in Module::Metadata. It returns a hashref like provides in CPAN::Meta::Spec.
<B>NOTEB>: $dir must be a physical directory on the disk, therefore @files (if specified) must be in native OS format. This function is called internally from determine_packages (which calls physical_directory (which calls extract_into)) which manages these requirements.
($name, $version) = $dist->parse_name_and_version($path);
Attempt to parse name and version from the provided string. This will work for dists named like Dist-Name-1.0.
Returns the class name used for Path::Class::Dir objects.
Returns the class name used for Path::Class::File objects.
This is a shortcut for returning an object representing the provided dir utilizing path_class_dir and file_spec.
This is a shortcut for returning an object representing the provided file utilizing path_class_file and file_spec.
Returns the subset of list_files that look like perl files. Currently returns anything matching /\.pm$/
$dir = $dist->physical_directory(); ($dir, @dir_files) = $dist->physical_directory(@files);
Returns the path to a physical directory on the disk where the specified files (if any) can be found.
For in-memory formats this will make a temporary directory and write the specified files (or all files) into it.
The return value is the same as extract_into: In scalar context the path to the directory is returned. In list context the (possibly adjusted) paths to any specified files are appended to the return value.
my ($dir, @rel) = $dm->remove_root_dir(@files);
If all the @files are beneath the same root directory (as is normally the case) this will strip the root directory off of each file and return a list of the root directory and the stripped files.
If there is no root directory the first element of the list will be undef.
A single attribute that is required by the class. Subclasses can define this to make new croak if it isnt present.
Returns the root directory of the dist (if there is one).
This is a convenience method for setting the name and version if they havent already been set. This is often called by determine_name_and_version.
o Dist::Metadata::Tar - for examining a tar file o Dist::Metadata::Dir - for a directory already on the disk o Dist::Metadata::Struct - for mocking up a dist with perl data structures
Randy Stauner <firstname.lastname@example.org>
This software is copyright (c) 2011 by Randy Stauner.
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.20.3||DIST::METADATA::DIST (3)||2015-04-29|