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
222
223
224
225
226
|
package Pod::Readme::Plugin::requires;
use Moo::Role;
our $VERSION = 'v1.2.3';
use CPAN::Meta;
use Module::CoreList;
use Path::Tiny;
use Types::Standard qw/ Bool Str /;
use Pod::Readme::Types qw/ File HeadingLevel /;
=head1 NAME
Pod::Readme::Plugin::requires - Include requirements in README
=head1 SYNOPSIS
=for readme plugin requires
=head1 DESCRIPTION
This is a plugin for L<Pod::Readme> that includes module requirements
from the F<META.yml> file.
Because this depends on the F<META.yml> file, the F<README> should be
generated after that file has been updated.
=head1 ARGUMENTS
=head2 C<from-file>
=for readme plugin version from-file='MYMETA.yml'
By default, it will extract the version from the F<META.yml> file. If,
for some reason, this file is in a non-standard location, then you
should specify it here.
The file will be ignored if the C<zilla> attribute is set, and instead
obtain metadata from the L<Dist::Zilla> object (since the F<META.yml>
file may not exist.)
=head2 C<no-omit-core>
By default, core modules for the version of Perl specified in the
F<META.yml> file are omitted from this list. If you prefer to lise
all requirements, then specify this option.
=head2 C<title>
=for readme plugin version title='REQUIREMENTS'
This argument allows you to change the title of the heading.
=head1 KNOWN ISSUES
=over
=item *
Trailing zeros in module versions may be dropped.
If you specify a minimum version of a module with a trailing zero,
e.g. "0.30", then it may be shown as "0.3". A workaround is to
specify the module version in your F<Makefile.PL> as a string instead
of number:
requires(
'CPAN::Changes' => '0.30',
...
);
=back
=cut
requires 'parse_cmd_args';
has 'requires_from_file' => (
is => 'rw',
isa => File,
coerce => sub { File->coerce(@_) },
default => 'META.yml',
lazy => 1,
);
has 'requires_title' => (
is => 'rw',
isa => Str,
default => 'REQUIREMENTS',
lazy => 1,
);
has 'requires_omit_core' => (
is => 'rw',
isa => Bool,
default => 1,
lazy => 1,
);
has 'requires_heading_level' => (
is => 'rw',
isa => HeadingLevel,
default => 1,
lazy => 1,
);
has 'requires_run' => (
is => 'rw',
isa => Bool,
default => 0,
lazy => 1,
);
around 'depends_on' => sub {
my ( $orig, $self ) = @_;
return ( $self->requires_from_file, $self->$orig );
};
sub cmd_requires {
my ( $self, @args ) = @_;
die "The requires plugin can only be used once" if $self->requires_run;
my $res = $self->parse_cmd_args(
[qw/ from-file title omit-core no-omit-core heading-level /], @args );
foreach my $key ( keys %{$res} ) {
( my $name = "requires_${key}" ) =~ s/-/_/g;
if ( my $method = $self->can($name) ) {
$self->$method( $res->{$key} );
}
else {
die "Invalid key: '${key}'";
}
}
my $meta;
if ( $self->zilla ) {
$meta = CPAN::Meta->create( $self->zilla->distmeta,
{ lazy_validation => 1 } );
}
else {
my $file =
path( $self->base_dir, $self->requires_from_file )->stringify;
unless ( -e $file ) {
die "Cannot find META.yml file at '${file}";
}
$meta = CPAN::Meta->load_file($file);
}
my ( $prereqs, $perl ) = $self->_get_prereqs( $meta, 'requires' );
if ( %{$prereqs} ) {
my $heading = $self->can( "write_head" . $self->requires_heading_level )
or die "Invalid heading level: " . $self->requires_heading_level;
$self->$heading( $self->requires_title );
if ($perl) {
$self->write_para(
sprintf( 'This distribution requires Perl %s.',
version->parse($perl)->normal )
);
}
$self->write_para('This distribution requires the following modules:');
$self->_write_modules($prereqs);
my ($recommends) = $self->_get_prereqs( $meta, 'recommends' );
if ( %{$recommends} ) {
$self->write_para(
'This distribution recommends the following modules:');
$self->_write_modules($recommends);
}
}
$self->requires_run(1);
}
sub _get_prereqs {
my ( $self, $meta, $key ) = @_;
my %prereqs;
foreach my $type ( values %{ $meta->prereqs } ) {
# TODO: max version
$prereqs{$_} = $type->{$key}->{$_} for ( keys %{ $type->{$key} } );
}
my $perl = delete $prereqs{perl};
if ( $self->requires_omit_core && $perl ) {
foreach ( keys %prereqs ) {
my $ver = $prereqs{$_};
delete $prereqs{$_}
if Module::CoreList->first_release( $_, $prereqs{$ver} )
&& version->parse( Module::CoreList->first_release($_) ) <=
version->parse($perl);
}
}
return ( \%prereqs, $perl );
}
sub _write_modules {
my ( $self, $prereqs ) = @_;
$self->write_over(4);
foreach my $module ( sort { lc($a) cmp lc($b) } keys %{$prereqs} ) {
my $version = $prereqs->{$module};
my $text = $version ? " (version ${version})" : '';
$self->write_item( sprintf( '* L<%s>', $module ) . $text );
}
$self->write_back;
}
use namespace::autoclean;
1;
|
