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
|
package Dist::Zilla::Plugin::ReadmeFromPod;
our $AUTHORITY = 'cpan:AVAR';
$Dist::Zilla::Plugin::ReadmeFromPod::VERSION = '0.40';
use Moose;
use List::Util 1.33 qw( first );
with 'Dist::Zilla::Role::InstallTool' => { -version => 5 }; # after PodWeaver
with 'Dist::Zilla::Role::FilePruner';
use IO::String;
use Pod::Readme v1.2.0;
use Path::Tiny 0.004;
has filename => (
is => 'ro',
isa => 'Str',
lazy => 1,
builder => '_build_filename',
);
sub _build_filename {
my $self = shift;
# copied from Dist::Zilla::Plugin::ReadmeAnyFromPod
my $pm = $self->zilla->main_module->name;
(my $pod = $pm) =~ s/\.pm$/\.pod/;
return -e $pod ? $pod : $pm;
}
has type => (
is => 'ro',
isa => 'Str',
default => 'text',
);
my %FORMATS = (
'gfm' => { class => 'Pod::Markdown::Github' },
'github' => { class => 'Pod::Markdown::Github' },
'html' => { class => 'Pod::Simple::HTML' },
'markdown' => { class => 'Pod::Markdown' },
'pod' => { class => undef },
'rtf' => { class => 'Pod::Simple::RTF' },
'text' => { class => 'Pod::Simple::Text' },
);
has pod_class => (
is => 'ro',
isa => 'Maybe[Str]',
lazy => 1,
builder => '_build_pod_class',
);
sub _build_pod_class {
my $self = shift;
my $fmt = $FORMATS{$self->type}
or $self->log_fatal("Unsupported type: " . $self->type);
$fmt->{class};
}
has readme => (
is => 'ro',
isa => 'Str',
);
sub prune_files {
my ($self) = @_;
my $readme_file = first { $_->name =~ m{^README\z} } @{ $self->zilla->files };
if ($readme_file and $readme_file->added_by =~ /Dist::Zilla::Plugin::Readme/) {
$self->log_debug([ 'pruning %s', $readme_file->name ]);
$self->zilla->prune_file($readme_file);
}
}
sub setup_installer {
my ($self, $arg) = @_;
my $pod_class = $self->pod_class;
my $readme_name = $self->readme;
## guess pod_class from exisiting file, like GitHub will have README.md created
my $readme_file;
if (not $readme_name) {
my %ext = (
'md' => 'markdown',
'mkdn' => 'markdown',
'markdown' => 'markdown',
'html' => 'html',
'htm' => 'html',
'rtf' => 'rtf',
'txt' => 'text',
'' => 'text',
'pod' => 'pod'
);
foreach my $e (keys %ext) {
my $test_readme_file = path($self->zilla->root)->child($e ? "README.$e" : 'README');
if (-e "$test_readme_file") {
$readme_file = $test_readme_file;
$pod_class = $FORMATS{ $ext{$e} }->{class};
last;
}
}
}
my $content;
my $prf = Pod::Readme->new(
input_file => $self->filename,
translate_to_fh => IO::String->new($content),
translation_class => $pod_class,
force => 1,
zilla => $self->zilla,
);
$prf->run();
if ($readme_file) {
return $readme_file->spew_raw($content);
}
$readme_name ||= $prf->default_readme_file;
my $file = first { $_->name eq $readme_name } @{ $self->zilla->files };
if ( $file ) {
$file->content( $content );
$self->zilla->log("Override README from [ReadmeFromPod]");
} else {
require Dist::Zilla::File::InMemory;
$file = Dist::Zilla::File::InMemory->new({
content => $content,
name => "${readme_name}", # stringify, as it may be Path::Tiny
});
$self->add_file($file);
}
return;
}
no Moose;
__PACKAGE__->meta->make_immutable;
1;
=head1 NAME
Dist::Zilla::Plugin::ReadmeFromPod - dzil plugin to generate README from POD
=head1 SYNOPSIS
# dist.ini
[ReadmeFromPod]
# or
[ReadmeFromPod]
filename = lib/XXX.pod
type = markdown
readme = READTHIS.md
=head1 DESCRIPTION
This plugin generates the F<README> from C<main_module> (or specified)
by L<Pod::Readme>.
=head2 Options
The following options are supported:
=head3 C<filename>
The name of the file to extract the F<README> from. This defaults to
the main module of the distribution.
=head3 C<type>
The type of F<README> you want to generate. This defaults to "text".
Other options are "html", "pod", "markdown" and "rtf".
=head3 C<pod_class>
This is the L<Pod::Simple> class used to translate a file to the
format you want. The default is based on the L</type> setting, but if
you want to generate an alternative type, you can set this option
instead.
=head3 C<readme>
The name of the file, which defaults to one based on the L</type>.
=head2 Conflicts with Other Plugins
We will remove the README created by L<Dist::Zilla::Plugin::Readme> automatically.
=head1 AUTHORS
Fayland Lam <fayland@gmail.com> and
E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason <avar@cpan.org>
Robert Rothenberg <rrwo@cpan.org> modified this plugin to use
L<Pod::Readme>.
=head1 LICENSE AND COPYRIGHT
Copyright 2010-2015 Fayland Lam <fayland@gmail.com> and E<AElig>var
ArnfjE<ouml>rE<eth> Bjarmason <avar@cpan.org>
This program is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|
