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
|
package Catmandu::Importer::Modules;
use Catmandu::Sane;
our $VERSION = '1.2024';
use Module::Info;
use File::Spec;
use Path::Iterator::Rule;
use Moo;
use Catmandu::Util qw(array_split pod_section read_file);
use namespace::clean;
with 'Catmandu::Importer';
has inc => (
is => 'ro',
lazy => 1,
default => sub {[@INC]},
coerce => \&array_split,
);
has namespace =>
(is => 'ro', default => sub {[""]}, coerce => \&array_split,);
has max_depth => (is => 'ro', predicate => 1,);
has pattern => (is => 'ro',);
has primary => (is => 'ro',);
has about => (is => 'ro', default => sub {1});
sub generator {
my ($self) = @_;
sub {
state $pattern = $self->pattern;
state $files = {};
state $names = {};
# array of [ $directory => $namespace ]
state $search = [
map {
my $ns = $_;
my $parts = [map {grep length, split(/::/, $_)} $ns];
map {[File::Spec->catdir($_, @$parts) => $ns]} @{$self->inc};
} @{$self->namespace}
];
state $cur = shift(@$search) // return;
state $iter = do {
my $rule = Path::Iterator::Rule->new;
$rule->file->name('*.pm');
$rule->max_depth($self->max_depth) if $self->has_max_depth;
$rule->iter($cur->[0], {depthfirst => 1});
};
while (1) {
my ($dir, $ns) = @$cur;
if (defined(my $file = $iter->())) {
my $path = File::Spec->abs2rel($file, $dir);
my $name = join('::', File::Spec->splitdir($path));
$name =~ s/\.pm$//;
$name = join('::', $ns, $name) if $ns;
next if defined $pattern && $name !~ $pattern;
my $info = Module::Info->new_from_file($file);
my $file = File::Spec->rel2abs($file);
next if $files->{$file};
$files->{$file} = 1;
if ($self->primary) {
next if $names->{$name};
$names->{$name} = 1;
}
my $data = {file => $file, name => $name, path => $dir,};
if (defined $info->version && $info->version ne 'undef') {
$data->{version} = "" . $info->version;
}
elsif (open(my $fh, '<:encoding(UTF-8)', $file)) {
while (my $line = <$fh>) {
if (my ($version)
= $line
=~ /^\s*our\s+\$VERSION\s*=\s*['"]([^'"]+)['"]\s*;/
)
{
$data->{version} = $version;
last;
}
}
close($fh);
}
if ($self->about) {
my $about = pod_section($file, 'NAME');
$about =~ s/[^-]+(\s*-?\s*)?//;
$about =~ s/\n/ /mg;
$about =~ s/ *$//;
$data->{about} = $about if $about ne '';
}
return $data;
}
else {
$cur = shift(@$search) // return;
my $rule = Path::Iterator::Rule->new;
$rule->file->name('*.pm');
$rule->max_depth($self->max_depth) if $self->has_max_depth;
$iter = $rule->iter($cur->[0], {depthfirst => 1});
}
}
};
}
1;
__END__
=pod
=head1 NAME
Catmandu::Importer::Modules - list installed perl modules in a given namespace
=head1 DESCRIPTION
This L<Catmandu::Importer> list perl modules from all perl library paths with
their C<name>, C<version>, absolute C<file>, library C<path>, and short
description (C<about>).
=head1 CONFIGURATION
=over
=item file
Read input from a local file given by its path. Alternatively a scalar
reference can be passed to read from a string.
=item fh
Read input from an L<IO::Handle>. If not specified, L<Catmandu::Util::io> is used to
create the input stream from the C<file> argument or by using STDIN.
=item encoding
Binmode of the input stream C<fh>. Set to C<:utf8> by default.
=item fix
An ARRAY of one or more fixes or file scripts to be applied to imported items.
=item namespace
Namespace(s) for the modules to list, given as array or comma-separated list
=item inc
List of library paths (defaults to C<@INC>)
=item max_depth
Maximum depth to recurse into the namespace e.g. if the namespace is
Catmandu::Fix then Catmandu::Fix::add_field has a depth of 1 and
Catmandu::Fix::Condition::exists a depth of 2
=item pattern
Filter modules by the given regex pattern
=item primary
Filter modules to the first module of each name
=item about
Include short description as given in the NAME section of each module's
documentation. Enabled by default.
=back
=head1 METHODS
Every L<Catmandu::Importer> is a L<Catmandu::Iterable> all its methods are
inherited.
=head1 SEE ALSO
L<Catmandu::Importer::CPAN>, L<Catmandu::Cmd::info>
=cut
|
