1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
# NAME
Module::Metadata - Gather package and POD information from perl module files
# SYNOPSIS
use Module::Metadata;
# information about a .pm file
my $info = Module::Metadata->new_from_file( $file );
my $version = $info->version;
# CPAN META 'provides' field for .pm files in a directory
my $provides = Module::Metadata->provides(
dir => 'lib', version => 2
);
# DESCRIPTION
This module provides a standard way to gather metadata about a .pm file through
(mostly) static analysis and (some) code execution. When determining the
version of a module, the `$VERSION` assignment is `eval`ed, as is traditional
in the CPAN toolchain.
# USAGE
## Class methods
- `new_from_file($filename, collect_pod => 1)`
Constructs a `Module::Metadata` object given the path to a file. Returns
undef if the filename does not exist.
`collect_pod` is a optional boolean argument that determines whether POD
data is collected and stored for reference. POD data is not collected by
default. POD headings are always collected.
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.
- `new_from_handle($handle, $filename, collect_pod => 1)`
This works just like `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 `filename` argument is
mandatory or undef will be returned.
You are responsible for setting the decoding layers on `$handle` if
required.
- `new_from_module($module, collect_pod => 1, inc => \@dirs)`
Constructs a `Module::Metadata` object given a module or package name.
Returns undef if the module cannot be found.
In addition to accepting the `collect_pod` argument as described above,
this method accepts a `inc` argument which is a reference to an array of
directories to search for the module. If none are given, the default is
@INC.
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.
- `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 around `package_versions_from_directory`
to generate a CPAN META `provides` data structure. It takes key/value
pairs. Valid option keys include:
- version **(required)**
Specifies which version of the [CPAN::Meta::Spec](https://metacpan.org/pod/CPAN::Meta::Spec) should be used as
the format of the `provides` output. Currently only '1.4' and '2'
are supported (and their format is identical). This may change in
the future as the definition of `provides` changes.
The `version` option is required. If it is omitted or if
an unsupported version is given, then `provides` will throw an error.
- dir
Directory to search recursively for `.pm` files. May not be specified with
`files`.
- files
Array reference of files to examine. May not be specified with `dir`.
- prefix
String to prepend to the `file` field of the resulting output. This defaults
to `lib`, which is the common case for most CPAN distributions with their
`.pm` files in `lib`. This option ensures the META information has the
correct relative path even when the `dir` or `files` arguments are
absolute or have relative paths from a location other than the distribution
root.
For example, given `dir` of 'lib' and `prefix` 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' => ...
}
The `DB` and `main` 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.
This **must not** be used directly for CPAN META `provides`. See
the `provides` 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.
## Object methods
- `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'.
- `version($package)`
Returns the version as defined by the $VERSION variable for the
package as returned by the `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.
- `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 of `main`). It is not
filtered for `DB`, `main` or private packages the way the
`provides` method does. Invalid package names are not returned,
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.
- `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.
- `is_indexable($package)` or `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 `package` declarations, and does not take any
ownership information into account.
# AUTHOR
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>.
# COPYRIGHT & LICENSE
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.
|
