1 package CPANPLUS::Dist::Gentoo;
7 use File::Copy qw/copy/;
8 use File::Path qw/mkpath/;
9 use File::Spec::Functions qw/catdir catfile/;
11 use IPC::Cmd qw/run can_run/;
15 use base qw/CPANPLUS::Dist::Base/;
19 CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
27 our $VERSION = '0.04';
31 cpan2dist --format=CPANPLUS::Dist::Gentoo \
32 --dist-opts overlay=/usr/local/portage \
33 --dist-opts distdir=/usr/portage/distfiles \
34 --dist-opts manifest=yes \
35 --dist-opts keywords=x86 \
36 --dist-opts header="# Copyright 1999-2008 Gentoo Foundation" \
37 --dist-opts footer="# End" \
42 This module is a CPANPLUS backend that recursively generates Gentoo ebuilds for a given package in the specified overlay (defaults to F</usr/local/portage>), updates the manifest, and even emerges it (together with its dependencies) if the user requires it. You need write permissions on the directory where Gentoo fetches its source files (usually F</usr/portage/distfiles>). You also need to specify the correct keyword for your architecture if it differs from the default C<x86>.
44 The generated ebuilds are placed into the C<perl-gcpanp> category. They favour depending on C<perl-core>, C<dev-perl> or C<perl-gcpan> (in that order) rather than C<perl-gcpanp>.
48 After installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
52 All the methods are inherited from L<CPANPLUS::Dist::Base>. Please refer to its documentation for precise information on what's done at each step.
56 use constant CATEGORY => 'perl-gcpanp';
58 sub format_available {
59 for my $prog (qw/emerge ebuild/) {
60 unless (can_run($prog)) {
61 error "$prog is required to write ebuilds -- aborting";
70 my $stat = $self->status;
71 my $conf = $self->parent->parent->configure_object;
73 $stat->mk_accessors(qw/name version author dist desc uri src license deps
74 eb_name eb_version eb_dir eb_file fetched_arch
75 overlay distdir keywords do_manifest header footer
78 $stat->force($conf->get_conf('force'));
79 $stat->verbose($conf->get_conf('verbose'));
85 'Crypt-RSA' => 'crypt-rsa',
86 'Digest' => 'digest-base',
87 'Locale-Maketext' => 'locale-maketext',
88 'Math-Pari' => 'math-pari',
89 'Net-Ping' => 'net-ping',
90 'PathTools' => 'File-Spec',
91 'PodParser' => 'Pod-Parser',
92 'Set-Scalar' => 'set-scalar',
93 'Tie-EncryptedHash' => 'tie-encryptedhash',
99 my $mod = $self->parent;
100 my $stat = $self->status;
101 my $int = $mod->parent;
102 my $conf = $int->configure_object;
106 my $keywords = delete $opts{'keywords'};
107 $keywords = 'x86' unless defined $keywords;
108 $keywords = [ split ' ', $keywords ];
109 $stat->keywords($keywords);
111 my $manifest = delete $opts{'manifest'};
112 $manifest = 1 unless defined $manifest;
113 $manifest = 0 if $manifest =~ /^\s*no?\s*$/i;
114 $stat->do_manifest($manifest);
116 my $header = delete $opts{'header'};
117 if (defined $header) {
118 1 while chomp $header;
123 $stat->header($header);
125 my $footer = delete $opts{'footer'};
126 if (defined $footer) {
127 $footer = "\n" . $footer;
131 $stat->footer($footer);
133 my $overlay = delete $opts{'overlay'};
134 $overlay = (defined $overlay) ? abs_path $overlay : '/usr/local/portage';
135 $stat->overlay($overlay);
137 my $distdir = delete $opts{'distdir'};
138 $distdir = (defined $distdir) ? abs_path $distdir : '/usr/portage/distfiles';
139 $stat->distdir($distdir);
141 if ($stat->do_manifest && !-w $stat->distdir) {
142 error 'distdir isn\'t writable -- aborting';
145 $stat->fetched_arch($mod->status->fetch);
147 my $name = $mod->package_name;
150 my $version = $mod->package_version;
151 $stat->version($version);
153 my $author = $mod->author->cpanid;
154 $stat->author($author);
156 $stat->dist($name . '-' . $version);
158 $version =~ s/[^\d._]+//g;
159 $version =~ s/^[._]*//;
160 $version =~ s/[._]*$//;
161 $version =~ s/[._]*_[._]*/_/g;
163 ($version, my $patch, my @rest) = split /_/, $version;
164 $version .= '_p' . $patch if defined $patch;
165 $version .= join('.', '', @rest) if @rest;
167 $stat->eb_version($version);
169 $stat->eb_name($gentooism{$name} || $name);
171 $stat->eb_dir(catdir($stat->overlay, CATEGORY, $stat->eb_name));
173 my $file = catfile($stat->eb_dir,
174 $stat->eb_name . '-' . $stat->eb_version . '.ebuild');
179 1 while unlink $file;
182 error "Can't force rewriting of $file -- skipping";
185 msg 'Ebuild already generated for ' . $stat->dist . ' -- skipping';
193 $stat->eb_file($file);
195 $self->SUPER::prepare(%opts);
197 my $desc = $mod->description;
198 ($desc = $name) =~ s/-+/::/g unless $desc;
201 $stat->uri('http://search.cpan.org/dist/' . $name);
203 unless ($author =~ /^(.)(.)/) {
204 error 'Wrong author name -- aborting';
207 $stat->src("mirror://cpan/modules/by-authors/id/$1/$1$2/$author/"
210 $stat->license([ qw/Artistic GPL-2/ ]);
212 my $prereqs = $mod->status->prereqs;
214 for my $prereq (sort keys %$prereqs) {
215 next if $prereq =~ /^perl(?:-|\z)/;
216 my $obj = $int->module_tree($prereq);
218 error 'Wrong module object -- aborting';
221 next if $obj->package_is_perl_core;
224 if ($prereqs->{$prereq}) {
225 if ($obj->installed_version && $obj->installed_version < $obj->version) {
226 $version = $obj->installed_version;
228 $version = $obj->package_version;
231 push @depends, [ $obj , $version ];
234 $stat->deps(\@depends);
241 my $stat = $self->status;
243 unless ($stat->prepared) {
244 error 'Can\'t create ' . $stat->dist . ' since it was never prepared -- aborting';
248 if ($stat->created) {
249 msg $stat->dist . ' was already created -- skipping';
253 $self->SUPER::create(@_);
255 my $dir = $stat->eb_dir;
257 eval { mkpath $dir };
259 error "mkpath($dir): $@";
264 my $d = $stat->header;
265 $d .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
266 $d .= 'MODULE_AUTHOR="' . $stat->author . "\"\ninherit perl-module\n\n";
267 $d .= 'S="${WORKDIR}/' . $stat->dist . "\"\n";
268 $d .= 'DESCRIPTION="' . $stat->desc . "\"\n";
269 $d .= 'HOMEPAGE="' . $stat->uri . "\"\n";
270 $d .= 'SRC_URI="' . $stat->src . "\"\n";
271 $d .= "SLOT=\"0\"\n";
272 $d .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
273 $d .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
274 $d .= 'DEPEND="' . join "\n",
277 my $a = $_->[0]->package_name;
278 $a = $gentooism{$a} || $a;
280 if (defined $_->[1]) {
284 '|| ( ' . join(' ', map "$x$_/$a",
285 qw/perl-core dev-perl perl-gcpan/, CATEGORY)
289 $d .= "SRC_TEST=\"do\"\n";
292 my $file = $stat->eb_file;
293 open my $eb, '>', $file or do {
294 error "open($file): $! -- aborting";
300 if ($stat->do_manifest) {
301 unless (copy $stat->fetched_arch, $stat->distdir) {
302 error "Couldn\'t copy the distribution file to distdir ($!) -- aborting";
303 1 while unlink $file;
307 msg 'Adding Manifest entry for ' . $stat->dist;
308 unless ($self->_run([ 'ebuild', $file, 'manifest' ], 0)) {
309 1 while unlink $file;
319 my $stat = $self->status;
320 my $conf = $self->parent->parent->configure_object;
322 my $sudo = $conf->get_program('sudo');
323 my @cmd = ('emerge', '=' . $stat->eb_name . '-' . $stat->eb_version);
324 unshift @cmd, $sudo if $sudo;
326 return $self->_run(\@cmd, 1);
331 my $stat = $self->status;
332 my $conf = $self->parent->parent->configure_object;
334 my $sudo = $conf->get_program('sudo');
335 my @cmd = ('emerge', '-C', '=' . $stat->eb_name . '-' . $stat->eb_version);
336 unshift @cmd, $sudo if $sudo;
338 return $self->_run(\@cmd, 1);
342 my ($self, $cmd, $verbose) = @_;
343 my $stat = $self->status;
345 my ($success, $errmsg, $output) = do {
346 local $ENV{PORTDIR_OVERLAY} = $stat->overlay;
347 local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
348 run command => $cmd, verbose => $verbose;
352 error "$errmsg -- aborting";
353 if (not $verbose and defined $output and $self->status->verbose) {
354 my $msg = join '', @$output;
365 Gentoo (L<http://gentoo.org>).
367 L<CPANPLUS>, L<IPC::Cmd> (core modules since 5.9.5).
369 L<Cwd> (since perl 5) L<File::Path> (5.001), L<File::Copy> (5.002), L<File::Spec::Functions> (5.00504).
375 L<CPANPLUS::Dist::Base>, L<CPANPLUS::Dist::Deb>, L<CPANPLUS::Dist::Mdv>.
379 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
381 You can contact me by mail or on C<irc.perl.org> (vincent).
385 Please report any bugs or feature requests to C<bug-cpanplus-dist-gentoo at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CPANPLUS-Dist-Gentoo>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
389 You can find documentation for this module with the perldoc command.
391 perldoc CPANPLUS::Dist::Gentoo
393 =head1 ACKNOWLEDGEMENTS
395 The module is to some extend cargo-culted from L<CPANPLUS::Dist::Deb> and L<CPANPLUS::Dist::Mdv>.
397 Kent Fredric, for testing and suggesting improvements.
399 =head1 COPYRIGHT & LICENSE
401 Copyright 2008 Vincent Pit, all rights reserved.
403 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
407 1; # End of CPANPLUS::Dist::Gentoo