This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Module-Metadata to CPAN version 1.000005
authorChris 'BinGOs' Williams <chris@bingosnet.co.uk>
Wed, 3 Aug 2011 08:28:11 +0000 (09:28 +0100)
committerChris 'BinGOs' Williams <chris@bingosnet.co.uk>
Wed, 3 Aug 2011 08:28:11 +0000 (09:28 +0100)
  [DELTA]

  1.0.5 2011-08-02 09:45:00

  - Localize $package::VERSION during version discovery (MIYAGAWA)
  - Fix references to Module::Build::ModuleInfo [RT #66133] (DAGOLDEN)
  - Added 'new_from_handle()' method [RT #68875] (DAGOLDEN)
  - Improved documentation (SYNOPSIS, broke out class/object method, and
    other minor edits) (DAGOLDEN)

MANIFEST
Porting/Maintainers.pl
cpan/Module-Metadata/lib/Module/Metadata.pm
cpan/Module-Metadata/t/lib/0.1/Foo.pm [new file with mode: 0644]
cpan/Module-Metadata/t/lib/0.2/Foo.pm [new file with mode: 0644]
cpan/Module-Metadata/t/metadata.t
cpan/Module-Metadata/t/version.t [new file with mode: 0644]
pod/perldelta.pod

index 6fbbc3e..f33a68b 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -1689,10 +1689,13 @@ cpan/Module-Load/t/to_load/Must/Be/Loaded.pm    Module::Load tests
 cpan/Module-Load/t/to_load/TestModule.pm       Module::Load tests
 cpan/Module-Load/t/to_load/ToBeLoaded          Module::Load tests
 cpan/Module-Metadata/lib/Module/Metadata.pm
+cpan/Module-Metadata/t/lib/0.1/Foo.pm
+cpan/Module-Metadata/t/lib/0.2/Foo.pm
 cpan/Module-Metadata/t/lib/DistGen.pm
 cpan/Module-Metadata/t/lib/MBTest.pm
 cpan/Module-Metadata/t/lib/Tie/CPHash.pm
 cpan/Module-Metadata/t/metadata.t
+cpan/Module-Metadata/t/version.t
 cpan/Module-Pluggable/lib/Devel/InnerPackage.pm                Find inner packages
 cpan/Module-Pluggable/lib/Module/Pluggable/Object.pm   Module::Pluggable
 cpan/Module-Pluggable/lib/Module/Pluggable.pm          Module::Pluggable
index 728d6b4..639f1fd 100755 (executable)
@@ -1286,9 +1286,9 @@ use File::Glob qw(:case);
     'Module::Metadata' =>
        {
        'MAINTAINER'    => 'dagolden',
-       'DISTRIBUTION'  => 'DAGOLDEN/Module-Metadata-1.000004.tar.gz',
+       'DISTRIBUTION'  => 'DAGOLDEN/Module-Metadata-1.000005.tar.gz',
        'FILES'         => q[cpan/Module-Metadata],
-       'EXCLUDED'      => [ ],
+       'EXCLUDED'      => [ qr{^maint}, qr{^xt} ],
        'UPSTREAM'      => 'cpan',
        },
 
index 9d60226..514dd1c 100644 (file)
@@ -11,7 +11,7 @@ package Module::Metadata;
 
 use strict;
 use vars qw($VERSION);
-$VERSION = '1.000004';
+$VERSION = '1.000005';
 $VERSION = eval $VERSION;
 
 use File::Spec;
@@ -69,6 +69,18 @@ sub new_from_file {
   return $class->_init(undef, $filename, @_);
 }
 
+sub new_from_handle {
+  my $class    = shift;
+  my $handle   = shift;
+  my $filename = shift;
+  return undef unless defined($handle) && defined($filename);
+  $filename = File::Spec->rel2abs( $filename );
+
+  return $class->_init(undef, $filename, @_, handle => $handle);
+
+}
+
+
 sub new_from_module {
   my $class   = shift;
   my $module  = shift;
@@ -183,7 +195,6 @@ sub new_from_module {
   
         if ( $package eq $prime_package ) {
           if ( exists( $prime{$package} ) ) {
-            # M::B::ModuleInfo will handle this conflict
             die "Unexpected conflict in '$package'; multiple versions found.\n";
           } else {
             $prime{$package}{file} = $mapped_filename;
@@ -282,6 +293,7 @@ sub _init {
   my $filename = shift;
   my %props = @_;
 
+  my $handle = delete $props{handle};
   my( %valid_props, @valid_props );
   @valid_props = qw( collect_pod inc );
   @valid_props{@valid_props} = delete( @props{@valid_props} );
@@ -302,7 +314,12 @@ sub _init {
 
   my $self = bless(\%data, $class);
 
-  $self->_parse_file();
+  if ( $handle ) {
+    $self->_parse_fh($handle);
+  }
+  else {
+    $self->_parse_file();
+  }
 
   unless($self->{module} and length($self->{module})) {
     my ($v, $d, $f) = File::Spec->splitpath($self->{filename});
@@ -517,9 +534,9 @@ sub _evaluate_version_line {
     use version;
     no strict;
 
-    local $sigil$var;
-    \$$var=undef;
       \$vsub = sub {
+        local $sigil$var;
+        \$$var=undef;
         $line;
         \$$var
       };
@@ -648,60 +665,54 @@ sub pod {
 
 Module::Metadata - Gather package and POD information from perl module files
 
-=head1 DESCRIPTION
-
-=over 4
+=head1 SYNOPSIS
 
-=item new_from_file($filename, collect_pod => 1)
+  use Module::Metadata;
 
-Construct a C<ModuleInfo> object given the path to a file. Takes an optional
-argument C<collect_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.
+  # information about a .pm file
+  my $info = Module::Metadata->new_from_file( $file );
+  my $version = $info->version;
 
-=item new_from_module($module, collect_pod => 1, inc => \@dirs)
+  # information about a directory full of .pm files
+  my $provides =
+    Module::Metadata->package_versions_from_directory('lib');
 
-Construct a C<ModuleInfo> object given a module or package name. In addition
-to accepting the C<collect_pod> argument as described above, this
-method accepts a C<inc> argument which is a reference to an array of
-of directories to search for the module. If none are given, the
-default is @INC.
-
-=item 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'.
-
-=item 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.
+=head1 DESCRIPTION
 
-=item filename()
+This module provides a standard way to gather metadata about a .pm file
+without executing unsafe code.
 
-Returns the absolute path to the file.
+=head1 USAGE
 
-=item packages_inside()
+=head2 Class methods
 
-Returns a list of packages.
+=over 4
 
-=item pod_inside()
+=item C<< new_from_file($filename, collect_pod => 1) >>
 
-Returns a list of POD sections.
+Construct a C<Module::Metadata> object given the path to a file. Takes an
+optional argument C<collect_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.
 
-=item contains_pod()
+=item C<< new_from_handle($handle, $filename, collect_pod => 1) >>
 
-Returns true if there is any POD in the file.
+This works just like C<new_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.  The
+C<filename> argument is mandatory or undef will be returned.
 
-=item pod($section)
+=item C<< new_from_module($module, collect_pod => 1, inc => \@dirs) >>
 
-Returns the POD data in the given section.
+Construct a C<Module::Metadata> object given a module or package name. In addition
+to accepting the C<collect_pod> argument as described above, this
+method accepts a C<inc> 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.
 
-=item find_module_by_name($module, \@dirs)
+=item 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
@@ -709,7 +720,7 @@ of directories can be passed in as an optional parameter, otherwise
 
 Can be called as either an object or a class method.
 
-=item find_module_dir_by_name($module, \@dirs)
+=item 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
@@ -717,7 +728,7 @@ optional parameter, otherwise @INC is searched.
 
 Can be called as either an object or a class method.
 
-=item package_versions_from_directory($dir, \@files?)
+=item 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,
@@ -731,23 +742,66 @@ returning a hashref of the form:
     'OtherPackage::Name' => ...
   }
 
-=item log_info (internal)
+=item 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
+
+=over 4
+
+=item C<< 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'.
+
+=item 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() >>
+
+Returns the absolute path to the file.
+
+=item C<< packages_inside() >>
+
+Returns a list of packages.
+
+=item C<< pod_inside() >>
+
+Returns a list of POD sections.
+
+=item C<< contains_pod() >>
+
+Returns true if there is any POD in the file.
+
+=item C<< pod($section) >>
+
+Returns the POD data in the given section.
+
+=back
+
 =head1 AUTHOR
 
-Ken Williams <kwilliams@cpan.org>, Randy W. Sims <RandyS@ThePierianSpring.org>
+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>
+assistance from David Golden (xdg) <dagolden@cpan.org>.
 
 =head1 COPYRIGHT
 
-Copyright (c) 2001-2011 Ken Williams.  All rights reserved.
+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.
diff --git a/cpan/Module-Metadata/t/lib/0.1/Foo.pm b/cpan/Module-Metadata/t/lib/0.1/Foo.pm
new file mode 100644 (file)
index 0000000..f1ecaca
--- /dev/null
@@ -0,0 +1,3 @@
+package Foo;
+$Foo::VERSION = '0.1';
+1;
diff --git a/cpan/Module-Metadata/t/lib/0.2/Foo.pm b/cpan/Module-Metadata/t/lib/0.2/Foo.pm
new file mode 100644 (file)
index 0000000..8f8ef06
--- /dev/null
@@ -0,0 +1,3 @@
+package Foo;
+$Foo::VERSION = '0.2';
+1;
index f3d08aa..60cb316 100644 (file)
@@ -4,6 +4,7 @@
 
 use strict;
 use lib 't/lib';
+use IO::File;
 use MBTest;
 
 # parse various module $VERSION lines
@@ -173,7 +174,7 @@ our $VERSION = '1.23_00_00';
 );
 my %modules = reverse @modules;
 
-plan tests => 37 + 2 * keys( %modules );
+plan tests => 39 + 2 * keys( %modules );
 
 require_ok('Module::Metadata');
 
@@ -210,6 +211,14 @@ $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
 $pm_info = Module::Metadata->new_from_file( $file );
 ok( defined( $pm_info ), 'new_from_file() succeeds' );
 
+# construct from filehandle
+my $handle = IO::File->new($file);
+$pm_info = Module::Metadata->new_from_handle( $handle, $file );
+ok( defined( $pm_info ), 'new_from_handle() succeeds' );
+$pm_info = Module::Metadata->new_from_handle( $handle );
+is( $pm_info, undef, "new_from_handle() without filename returns undef" );
+
+
 # construct from module name, using custom include path
 $pm_info = Module::Metadata->new_from_module(
             $dist->name, inc => [ 'lib', @INC ] );
diff --git a/cpan/Module-Metadata/t/version.t b/cpan/Module-Metadata/t/version.t
new file mode 100644 (file)
index 0000000..4acc358
--- /dev/null
@@ -0,0 +1,22 @@
+use strict;
+use Test::More;
+use Module::Metadata;
+use lib "t/lib/0.2";
+
+plan tests => 4;
+
+require Foo;
+is $Foo::VERSION, 0.2;
+
+my $meta = Module::Metadata->new_from_module("Foo", inc => [ "t/lib/0.1" ] );
+is $meta->version, 0.1;
+
+is $Foo::VERSION, 0.2;
+
+ok eval "use Foo 0.2; 1";
+
+
+
+
+
+
index 6ab99d0..07f5dd3 100644 (file)
@@ -147,6 +147,12 @@ L<Module::Load> has been upgraded from version 0.18 to version 0.20
 
 =item *
 
+L<Module::Metadata> has been upgraded from version 1.000004 to version 1.000005
+
+Added C<new_from_handle()> method.
+
+=item *
+
 L<Params::Check> has been upgraded from version 0.28 to version 0.30
 
 =item *