summaryrefslogtreecommitdiff
path: root/cpan
diff options
context:
space:
mode:
authorSteve Hay <steve.m.hay@googlemail.com>2015-06-05 08:49:15 +0100
committerSteve Hay <steve.m.hay@googlemail.com>2015-06-05 08:49:15 +0100
commit72b8c7a2166f738711a9747c4906273b38c52517 (patch)
treecf7bd022cf40b7c92f5af8203e3ec74384c0de20 /cpan
parenta4f8ff4607cb674cb0c6feeb56b8eb80bbe28259 (diff)
downloadperl-72b8c7a2166f738711a9747c4906273b38c52517.tar.gz
Upgrade Module-Metadata from version 1.000026 to 1.000027
Diffstat (limited to 'cpan')
-rw-r--r--cpan/Module-Metadata/lib/Module/Metadata.pm57
-rw-r--r--cpan/Module-Metadata/t/metadata.t1
-rw-r--r--cpan/Module-Metadata/t/taint.t4
3 files changed, 28 insertions, 34 deletions
diff --git a/cpan/Module-Metadata/lib/Module/Metadata.pm b/cpan/Module-Metadata/lib/Module/Metadata.pm
index 7ea1210a24..2fa75c1b4a 100644
--- a/cpan/Module-Metadata/lib/Module/Metadata.pm
+++ b/cpan/Module-Metadata/lib/Module/Metadata.pm
@@ -1,6 +1,6 @@
# -*- mode: cperl; tab-width: 8; indent-tabs-mode: nil; basic-offset: 2 -*-
# vim:ts=8:sw=2:et:sta:sts=2
-package Module::Metadata; # git description: v1.000025-7-g47ca1b2
+package Module::Metadata; # git description: v1.000026-12-g9b12bf1
# Adapted from Perl-licensed code originally distributed with
# Module-Build by Ken Williams
@@ -13,7 +13,7 @@ sub __clean_eval { eval $_[0] }
use strict;
use warnings;
-our $VERSION = '1.000026';
+our $VERSION = '1.000027';
use Carp qw/croak/;
use File::Spec;
@@ -26,7 +26,10 @@ BEGIN {
use version 0.87;
BEGIN {
if ($INC{'Log/Contextual.pm'}) {
- Log::Contextual->import('log_info');
+ require "Log/Contextual/WarnLogger.pm"; # Hide from AutoPrereqs
+ Log::Contextual->import('log_info',
+ '-default_logger' => Log::Contextual::WarnLogger->new({ env_prefix => 'MODULE_METADATA', }),
+ );
} else {
*log_info = sub (&) { warn $_[0]->() };
}
@@ -814,13 +817,9 @@ This module provides a standard way to gather metadata about a .pm file through
version of a module, the C<$VERSION> assignment is C<eval>ed, as is traditional
in the CPAN toolchain.
-=head1 USAGE
-
-=head2 Class methods
-
-=over 4
+=head1 CLASS METHODS
-=item C<< new_from_file($filename, collect_pod => 1) >>
+=head2 C<< new_from_file($filename, collect_pod => 1) >>
Constructs a C<Module::Metadata> object given the path to a file. Returns
undef if the filename does not exist.
@@ -833,7 +832,7 @@ If the file begins by an UTF-8, UTF-16BE or UTF-16LE byte-order mark, then
it is skipped before processing, and the content of the file is also decoded
appropriately starting from perl 5.8.
-=item C<< new_from_handle($handle, $filename, collect_pod => 1) >>
+=head2 C<< new_from_handle($handle, $filename, collect_pod => 1) >>
This works just like C<new_from_file>, except that a handle can be provided
as the first argument.
@@ -846,7 +845,7 @@ mandatory or undef will be returned.
You are responsible for setting the decoding layers on C<$handle> if
required.
-=item C<< new_from_module($module, collect_pod => 1, inc => \@dirs) >>
+=head2 C<< new_from_module($module, collect_pod => 1, inc => \@dirs) >>
Constructs a C<Module::Metadata> object given a module or package name.
Returns undef if the module cannot be found.
@@ -860,7 +859,7 @@ If the file that contains the module begins by an UTF-8, UTF-16BE or
UTF-16LE byte-order mark, then it is skipped before processing, and the
content of the file is also decoded appropriately starting from perl 5.8.
-=item C<< find_module_by_name($module, \@dirs) >>
+=head2 C<< 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
@@ -868,7 +867,7 @@ of directories can be passed in as an optional parameter, otherwise
Can be called as either an object or a class method.
-=item C<< find_module_dir_by_name($module, \@dirs) >>
+=head2 C<< find_module_dir_by_name($module, \@dirs) >>
Returns the entry in C<@dirs> (or C<@INC> by default) that contains
the module C<$module>. A list of directories can be passed in as an
@@ -876,7 +875,7 @@ optional parameter, otherwise @INC is searched.
Can be called as either an object or a class method.
-=item C<< provides( %options ) >>
+=head2 C<< provides( %options ) >>
This is a convenience wrapper around C<package_versions_from_directory>
to generate a CPAN META C<provides> data structure. It takes key/value
@@ -925,7 +924,7 @@ is a hashref of the form:
'OtherPackage::Name' => ...
}
-=item C<< package_versions_from_directory($dir, \@files?) >>
+=head2 C<< package_versions_from_directory($dir, \@files?) >>
Scans C<$dir> for .pm files (unless C<@files> is given, in which case looks
for those files in C<$dir> - and reads each file for packages and versions,
@@ -947,36 +946,33 @@ Note that the file path is relative to C<$dir> if that is specified.
This B<must not> be used directly for CPAN META C<provides>. See
the C<provides> method instead.
-=item C<< log_info (internal) >>
+=head2 C<< log_info (internal) >>
Used internally to perform logging; imported from Log::Contextual if
Log::Contextual has already been loaded, otherwise simply calls warn.
-=back
-
-=head2 Object methods
+=head1 OBJECT METHODS
-=over 4
-
-=item C<< name() >>
+=head2 C<< name() >>
Returns the name of the package represented by this module. If there
is more than one package, it makes a best guess based on the
filename. If it's a script (i.e. not a *.pm) the package name is
'main'.
-=item C<< version($package) >>
+=head2 C<< version($package) >>
Returns the version as defined by the $VERSION variable for the
package as returned by the C<name> 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.
-=item C<< filename() >>
+=head2 C<< filename() >>
Returns the absolute path to the file.
+Note that this file may not actually exist on disk yet, e.g. if the module was read from an in-memory filehandle.
-=item C<< packages_inside() >>
+=head2 C<< packages_inside() >>
Returns a list of packages. Note: this is a raw list of packages
discovered (or assumed, in the case of C<main>). It is not
@@ -986,27 +982,25 @@ for example "Foo:Bar". Strange but valid package names are
returned, for example "Foo::Bar::", and are left up to the caller
on how to handle.
-=item C<< pod_inside() >>
+=head2 C<< pod_inside() >>
Returns a list of POD sections.
-=item C<< contains_pod() >>
+=head2 C<< contains_pod() >>
Returns true if there is any POD in the file.
-=item C<< pod($section) >>
+=head2 C<< pod($section) >>
Returns the POD data in the given section.
-=item C<< is_indexable($package) >> or C<< is_indexable() >>
+=head2 C<< is_indexable($package) >> or C<< is_indexable() >>
Returns a boolean indicating whether the package (if provided) or any package
(otherwise) is eligible for indexing by PAUSE, the Perl Authors Upload Server.
Note This only checks for valid C<package> declarations, and does not take any
ownership information into account.
-=back
-
=head1 AUTHOR
Original code from Module::Build::ModuleInfo by Ken Williams
@@ -1025,4 +1019,3 @@ This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=cut
-
diff --git a/cpan/Module-Metadata/t/metadata.t b/cpan/Module-Metadata/t/metadata.t
index ca928631e9..67c68a9c5f 100644
--- a/cpan/Module-Metadata/t/metadata.t
+++ b/cpan/Module-Metadata/t/metadata.t
@@ -1,4 +1,3 @@
-#!/usr/bin/perl -w
# -*- mode: cperl; tab-width: 8; indent-tabs-mode: nil; basic-offset: 2 -*-
# vim:ts=8:sw=2:et:sta:sts=2
diff --git a/cpan/Module-Metadata/t/taint.t b/cpan/Module-Metadata/t/taint.t
index 80ae7ea12b..18f0300742 100644
--- a/cpan/Module-Metadata/t/taint.t
+++ b/cpan/Module-Metadata/t/taint.t
@@ -2,7 +2,9 @@
use strict;
use warnings;
-use Test::More tests => 2;
+use Config;
+use Test::More $Config{ccflags} =~ /-DSILENT_NO_TAINT_SUPPORT/
+ ? ( skip_all => 'No taint support' ) : ( tests => 2 );
use Module::Metadata;
use Carp 'croak';