]> git.vpit.fr Git - perl/modules/CPANPLUS-Dist-Gentoo.git/blobdiff - lib/CPANPLUS/Dist/Gentoo.pm
Complete the bootstrapping process description
[perl/modules/CPANPLUS-Dist-Gentoo.git] / lib / CPANPLUS / Dist / Gentoo.pm
index 8a75c24e09e546feba90ed628a26fb6631aa2a90..c86573c0e17f3053f009551419643bfce310e19f 100644 (file)
@@ -3,19 +3,21 @@ package CPANPLUS::Dist::Gentoo;
 use strict;
 use warnings;
 
-use Cwd qw/abs_path/;
-use List::Util qw/reduce/;
+use Cwd        ();
+use List::Util qw<reduce>;
 use File::Copy ();
 use File::Path ();
 use File::Spec;
 
-use IPC::Cmd qw/run can_run/;
+use IPC::Cmd          ();
 use Parse::CPAN::Meta ();
 
 use CPANPLUS::Error ();
 
-use base qw/CPANPLUS::Dist::Base/;
+use base qw<CPANPLUS::Dist::Base>;
 
+use CPANPLUS::Dist::Gentoo::Atom;
+use CPANPLUS::Dist::Gentoo::Guard;
 use CPANPLUS::Dist::Gentoo::Maps;
 
 =head1 NAME
@@ -24,11 +26,11 @@ CPANPLUS::Dist::Gentoo - CPANPLUS backend generating Gentoo ebuilds.
 
 =head1 VERSION
 
-Version 0.08
+Version 0.10
 
 =cut
 
-our $VERSION = '0.08';
+our $VERSION = '0.10';
 
 =head1 SYNOPSIS
 
@@ -52,7 +54,54 @@ They favour depending on a C<virtual>, on C<perl-core>, C<dev-perl> or C<perl-gc
 
 =head1 INSTALLATION
 
-After installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
+Before installing this module, you should append C<perl-gcpanp> to your F</etc/portage/categories> file.
+
+You have two ways for installing this module :
+
+=over 4
+
+=item *
+
+Use the perl overlay located at L<http://git.overlays.gentoo.org/gitweb/?p=proj/perl-overlay.git>.
+It contains an ebuild for L<CPANPLUS::Dist::Gentoo> which will most likely be up-to-date given the reactivity of Gentoo's Perl herd.
+
+=item *
+
+Bootstrap an ebuild for L<CPANPLUS::Dist::Gentoo> using itself.
+
+First, make sure your system C<perl> is C<5.10> or greater, so that the L<CPANPLUS> toolchain is available.
+
+    $ perl -v
+    This is perl 5, version 12, subversion 2 (v5.12.2)...
+
+C<perl> C<5.12> is the current stable Perl version in Gentoo.
+If you still have C<perl> C<5.8.x>, you can upgrade it by running the following commands as root :
+
+    # emerge -tv ">=dev-lang/perl-5.10"
+    # perl-cleaner --all
+
+Then, fetch the L<CPANPLUS::Dist::Gentoo> tarball :
+
+    $ cd /tmp
+    $ wget http://search.cpan.org/CPAN/authors/id/V/VP/VPIT/CPANPLUS-Dist-Gentoo-0.10.tar.gz
+
+Log in as root and unpack it in e.g. your home directory :
+
+    # cd
+    # tar xzf /tmp/CPANPLUS-Dist-Gentoo-0.10.tar.gz
+    # cd CPANPLUS-Dist-Gentoo-0.10
+
+Bootstrap L<CPANPLUS::Dist::Gentoo> using the bundled shell script C<g-cpanp> :
+
+    # perl Makefile.PL
+    # make
+    # PERL5LIB=blib/lib samples/g-cpanp CPANPLUS::Dist::Gentoo
+
+Finally, emerge the C<CPANPLUS-Dist-Gentoo> ebuild you've just generated :
+
+    # emerge -tv CPANPLUS-Dist-Gentoo
+
+=back
 
 =head1 METHODS
 
@@ -68,6 +117,7 @@ my $default_keywords;
 my $default_distdir;
 my $main_portdir;
 
+my %dependencies;
 my %forced;
 
 my $unquote = sub {
@@ -82,8 +132,8 @@ my $format_available;
 sub format_available {
  return $format_available if defined $format_available;
 
- for my $prog (qw/emerge ebuild/) {
-  unless (can_run($prog)) {
+ for my $prog (qw<emerge ebuild>) {
+  unless (IPC::Cmd::can_run($prog)) {
    __PACKAGE__->_abort("$prog is required to write ebuilds");
    return $format_available = 0;
   }
@@ -91,24 +141,27 @@ sub format_available {
 
  if (IPC::Cmd->can_capture_buffer) {
   my $buffers;
-  my ($success, $errmsg) = run command => [ qw/emerge --info/ ],
-                               verbose => 0,
-                               buffer  => \$buffers;
+  my ($success, $errmsg) = IPC::Cmd::run(
+   command => [ qw<emerge --info> ],
+   verbose => 0,
+   buffer  => \$buffers,
+  );
   if ($success) {
    if ($buffers =~ /^PORTDIR_OVERLAY=(.*)$/m) {
-    $overlays = [ map abs_path($_), split ' ', $unquote->($1) ];
+    $overlays = [ map Cwd::abs_path($_), split ' ', $unquote->($1) ];
    }
    if ($buffers =~ /^ACCEPT_KEYWORDS=(.*)$/m) {
     $default_keywords = [ split ' ', $unquote->($1) ];
    }
    if ($buffers =~ /^DISTDIR=(.*)$/m) {
-    $default_distdir = abs_path($unquote->($1));
+    $default_distdir = Cwd::abs_path($unquote->($1));
    }
    if ($buffers =~ /^PORTDIR=(.*)$/m) {
-    $main_portdir = abs_path($unquote->($1));
+    $main_portdir = Cwd::abs_path($unquote->($1));
    }
   } else {
    __PACKAGE__->_abort($errmsg);
+   return $format_available = 0;
   }
  }
 
@@ -123,12 +176,15 @@ sub init {
  my $stat = $self->status;
  my $conf = $self->parent->parent->configure_object;
 
- $stat->mk_accessors(qw/name version author distribution desc uri src license
-                        fetched_arch deps
-                        ebuild_name ebuild_version ebuild_dir ebuild_file
-                        portdir_overlay
-                        overlay distdir keywords do_manifest header footer
-                        force verbose/);
+ $stat->mk_accessors(qw<
+  name version author distribution desc uri src license
+  meta min_perl
+  fetched_arch
+  requires configure_requires recursive_requires
+  ebuild_name ebuild_version ebuild_dir ebuild_file
+  portdir_overlay overlay distdir keywords do_manifest header footer
+  force verbose
+ >);
 
  $stat->force($conf->get_conf('force'));
  $stat->verbose($conf->get_conf('verbose'));
@@ -136,6 +192,25 @@ sub init {
  return 1;
 }
 
+my $filter_prereqs = sub {
+ my ($int, $prereqs) = @_;
+
+ my @requires;
+ for my $prereq (sort keys %$prereqs) {
+  next if $prereq =~ /^perl(?:-|\z)/;
+
+  my $obj = $int->module_tree($prereq);
+  next unless $obj; # Not in the module tree (e.g. Config)
+  next if $obj->package_is_perl_core;
+
+  my $version = $prereqs->{$prereq} || undef;
+
+  push @requires, [ $obj->package_name, $version ];
+ }
+
+ return \@requires;
+};
+
 sub prepare {
  my $self = shift;
  my $mod  = $self->parent;
@@ -167,7 +242,12 @@ sub prepare {
   1 while chomp $header;
   $header .= "\n\n";
  } else {
-  $header = '';
+  my $year = (localtime)[5] + 1900;
+  $header = <<"  DEF_HEADER";
+# Copyright 1999-$year Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+# \$Header: \$
+  DEF_HEADER
  }
  $stat->header($header);
 
@@ -180,11 +260,11 @@ sub prepare {
  $stat->footer($footer);
 
  my $overlay = delete $opts{overlay};
- $overlay = (defined $overlay) ? abs_path $overlay : '/usr/local/portage';
+ $overlay = (defined $overlay) ? Cwd::abs_path($overlay) : '/usr/local/portage';
  $stat->overlay($overlay);
 
  my $distdir = delete $opts{distdir};
- $distdir = (defined $distdir) ? abs_path $distdir : $default_distdir;
+ $distdir = (defined $distdir) ? Cwd::abs_path($distdir) : $default_distdir;
  $stat->distdir($distdir);
 
  return $FAIL->("distdir isn't writable") if $stat->do_manifest && !-w $distdir;
@@ -213,7 +293,7 @@ sub prepare {
 
  $stat->distribution($name . '-' . $version);
 
- $stat->ebuild_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($version));
+ $stat->ebuild_version(CPANPLUS::Dist::Gentoo::Maps::version_c2g($name, $version));
 
  $stat->ebuild_name(CPANPLUS::Dist::Gentoo::Maps::name_c2g($name));
 
@@ -244,20 +324,23 @@ sub prepare {
    1 while unlink $file;
   }
  } else {
-  if (my @match = $self->_cpan2portage($name, $version)) {
-   $stat->dist($match[1]);
+  if (my $atom = $self->_cpan2portage($name, $version)) {
+   $stat->dist($atom->ebuild);
    return $SKIP->('Ebuild already generated for', $stat->distribution);
   }
  }
 
  $stat->prepared(0);
 
- $self->SUPER::prepare(%opts);
+ $self->SUPER::prepare(@_);
 
  return $FAIL->() unless $stat->prepared;
 
  my $desc = $mod->description;
- ($desc = $name) =~ s/-+/::/g unless $desc;
+ $desc    = $mod->comment                unless $desc;
+ $desc    = "$name Perl distribution (provides " . $mod->module . ')'
+                                         unless $desc;
+ $desc    = substr($desc, 0, 77) . '...' if length $desc > 80;
  $stat->desc($desc);
 
  $stat->uri('http://search.cpan.org/dist/' . $name);
@@ -267,28 +350,50 @@ sub prepare {
 
  $stat->license($self->intuit_license);
 
- my $prereqs = $mod->status->prereqs;
- my @depends;
- for my $prereq (sort keys %$prereqs) {
-  next if $prereq =~ /^perl(?:-|\z)/;
-  my $obj = $int->module_tree($prereq);
-  next unless $obj; # Not in the module tree (e.g. Config)
-  next if $obj->package_is_perl_core;
-  {
-   my $version;
-   if ($prereqs->{$prereq}) {
-    if ($obj->installed_version && $obj->installed_version < $obj->version) {
-     $version = $obj->installed_version;
-    } else {
-     $version = $obj->package_version;
-    }
-   }
-   push @depends, [ $obj->package_name, $version ];
+ my $mstat = $mod->status;
+ $stat->configure_requires($int->$filter_prereqs($mstat->configure_requires));
+ $stat->requires($int->$filter_prereqs($mstat->requires));
+ $stat->recursive_requires([ ]);
+
+ $dependencies{$name} = [ map $_->[0], @{ $stat->requires } ];
+
+ my $meta = $self->meta;
+ $stat->min_perl(CPANPLUS::Dist::Gentoo::Maps::perl_version_c2g(
+  $meta->{requires}->{perl},
+ ));
+
+ return $OK->();
+}
+
+=head2 C<meta>
+
+Returns the contents of the F<META.yml> or F<META.json> files as parsed by L<Parse::CPAN::Meta>.
+
+=cut
+
+sub meta {
+ my $self = shift;
+ my $mod  = $self->parent;
+ my $stat = $self->status;
+
+ my $meta = $stat->meta;
+ return $meta if defined $meta;
+
+ my $extract_dir = $mod->status->extract;
+
+ for my $name (qw<META.json META.yml>) {
+  my $meta_file = File::Spec->catdir($extract_dir, $name);
+  next unless -e $meta_file;
+
+  local $@;
+  my $meta = eval { Parse::CPAN::Meta::LoadFile($meta_file) };
+  if (defined $meta) {
+   $stat->meta($meta);
+   return $meta;
   }
  }
- $stat->deps(\@depends);
 
- return $OK->();
+ return;
 }
 
 =head2 C<intuit_license>
@@ -316,20 +421,11 @@ sub intuit_license {
   return \@licenses if @licenses;
  }
 
- my $extract_dir = $mod->status->extract;
-
- for my $meta_file (qw/META.json META.yml/) {
-  my $meta = eval {
-   Parse::CPAN::Meta::LoadFile(File::Spec->catdir(
-    $extract_dir,
-    $meta_file,
-   ));
-  } or next;
-  my $license = $meta->{license};
-  if (defined $license) {
-   my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($license);
-   return \@licenses if @licenses;
-  }
+ my $meta    = $self->meta;
+ my $license = $meta->{license};
+ if (defined $license) {
+  my @licenses = CPANPLUS::Dist::Gentoo::Maps::license_c2g($license);
+  return \@licenses if @licenses;
  }
 
  return [ CPANPLUS::Dist::Gentoo::Maps::license_c2g('perl') ];
@@ -341,7 +437,24 @@ sub create {
 
  my $file;
 
+ my $guard = CPANPLUS::Dist::Gentoo::Guard->new(sub {
+  if (defined $file and -e $file and -w _) {
+   1 while unlink $file;
+  }
+ });
+
+ my $SIG_INT = $SIG{INT};
+ local $SIG{INT} = sub {
+  if ($SIG_INT) {
+   local $@;
+   eval { $SIG_INT->() };
+   die $@ if $@;
+  }
+  die 'Caught SIGINT';
+ };
+
  my $OK   = sub {
+  $guard->unarm;
   $stat->created(1);
   $stat->dist($file) if defined $file;
   1;
@@ -351,9 +464,6 @@ sub create {
   $stat->created(0);
   $stat->dist(undef);
   $self->_abort(@_) if @_;
-  if (defined $file and -f $file) {
-   1 while unlink $file;
-  }
   0;
  };
 
@@ -432,26 +542,83 @@ Returns the source of the ebuild for the current dist object, or C<undef> when o
 
 =cut
 
+my $dep_tree_contains;
+{
+ my %seen;
+
+ $dep_tree_contains = sub {
+  my ($dist, $target) = @_;
+
+  return 0 if $seen{$dist};
+  local $seen{$dist} = 1;
+
+  for my $kid (@{ $dependencies{$dist} }) {
+   return 1 if $kid eq $target
+            or $dep_tree_contains->($kid, $target);
+  }
+
+  return 0;
+ }
+}
+
 sub ebuild_source {
  my $self = shift;
  my $stat = $self->status;
 
+ {
+  my $name = $stat->name;
+  my %recursive_kids = map { $_ => 1 }
+                        grep $dep_tree_contains->($_, $name),
+                         @{ $dependencies{$name} };
+  if (%recursive_kids) {
+   my (@requires, @recursive_requires);
+   for (@{ $stat->requires }) {
+    if ($recursive_kids{$_->[0]}) {
+     push @recursive_requires, $_;
+    } else {
+     push @requires, $_;
+    }
+   }
+   $stat->requires(\@requires);
+   $stat->recursive_requires(\@recursive_requires);
+  }
+ }
+
  # We must resolve the deps now and not inside prepare because _cpan2portage
  # has to see the ebuilds already generated for the dependencies of the current
  # dist.
- my @deps;
- for (@{$stat->deps}) {
-  my $dep = $self->_cpan2portage(@$_);
-  unless (defined $dep) {
-   $self->_abort(
-    "Couldn't find an appropriate ebuild for $_->[0] in the portage tree"
-   );
-   return;
+
+ my (@configure_requires, @requires, @recursive_requires);
+
+ my @phases = (
+  [ configure_requires => \@configure_requires ],
+  [ requires           => \@requires           ],
+  [ recursive_requires => \@recursive_requires ],
+ );
+
+ push @requires, CPANPLUS::Dist::Gentoo::Atom->new(
+  category => 'dev-lang',
+  name     => 'perl',
+  version  => $stat->min_perl,
+ );
+
+ for (@phases) {
+  my ($phase, $list) = @$_;
+
+  for (@{ $stat->$phase }) {
+   my $atom = $self->_cpan2portage(@$_);
+   unless (defined $atom) {
+    $self->_abort(
+     "Couldn't find an appropriate ebuild for $_->[0] in the portage tree"
+    );
+    return;
+   }
+
+   push @$list, $atom;
   }
-  push @deps, $dep;
- }
 
- @deps = do { my %seen; sort grep !$seen{$_}++, 'dev-lang/perl', @deps };
+  @$list = CPANPLUS::Dist::Gentoo::Atom->fold(@$list);
+ }
 
  my $d = $stat->header;
  $d   .= "# Generated by CPANPLUS::Dist::Gentoo version $VERSION\n\n";
@@ -463,7 +630,10 @@ sub ebuild_source {
  $d   .= "SLOT=\"0\"\n";
  $d   .= 'LICENSE="|| ( ' . join(' ', sort @{$stat->license}) . " )\"\n";
  $d   .= 'KEYWORDS="' . join(' ', sort @{$stat->keywords}) . "\"\n";
- $d   .= 'DEPEND="' . join("\n", @deps) . "\"\n";
+ $d   .= 'RDEPEND="' . join("\n", sort @requires) . "\"\n" if @requires;
+ $d   .= 'PDEPEND="' . join("\n", sort @recursive_requires) . "\"\n"
+                                                         if @recursive_requires;
+ $d   .= 'DEPEND="' . join("\n", '${RDEPEND}', sort @configure_requires) . "\"\n";
  $d   .= "SRC_TEST=\"do\"\n";
  $d   .= $stat->footer;
 
@@ -471,39 +641,35 @@ sub ebuild_source {
 }
 
 sub _cpan2portage {
- my ($self, $name, $version) = @_;
+ my ($self, $dist_name, $dist_version) = @_;
 
- $name = CPANPLUS::Dist::Gentoo::Maps::name_c2g($name);
- my $ver;
- $ver = CPANPLUS::Dist::Gentoo::Maps::version_c2g($version) if defined $version;
+ my $name    = CPANPLUS::Dist::Gentoo::Maps::name_c2g($dist_name);
+ my $version = CPANPLUS::Dist::Gentoo::Maps::version_c2g($dist_name, $dist_version);
 
  my @portdirs = ($main_portdir, @{$self->status->portdir_overlay});
 
- for my $category (qw/virtual perl-core dev-perl perl-gcpan/, CATEGORY) {
-  my $atom = ($category eq 'virtual' ? 'perl-' : '') . $name;
+ for my $category (qw<virtual perl-core dev-perl perl-gcpan>, CATEGORY) {
+  my $name = ($category eq 'virtual' ? 'perl-' : '') . $name;
 
   for my $portdir (@portdirs) {
    my @ebuilds = glob File::Spec->catfile(
     $portdir,
     $category,
-    $atom,
-    "$atom-*.ebuild",
+    $name,
+    "$name-*.ebuild",
    ) or next;
 
-   my $last = reduce {
-    CPANPLUS::Dist::Gentoo::Maps::version_gcmp($b->[1], $a->[1]) >= 0 ? $b : $a
-   } map [ $_, /\Q$atom\E-v?([\d._pr-]+).*?\.ebuild$/ ? $1 : 0 ], @ebuilds;
-
-   my $dep;
-   if (defined $ver) { # implies that $version is defined
-    next unless
-              CPANPLUS::Dist::Gentoo::Maps::version_gcmp($last->[1], $ver) >= 0;
-    $dep = ">=$category/$atom-$ver";
-   } else {
-    $dep = "$category/$atom";
-   }
+   my $last = reduce { $a < $b ? $b : $a } # handles overloading
+               map CPANPLUS::Dist::Gentoo::Atom->new_from_ebuild($_),
+                @ebuilds;
+   next if defined $version and $last < $version;
 
-   return wantarray ? ($dep, $last->[0]) : $dep;
+   return CPANPLUS::Dist::Gentoo::Atom->new(
+    category => $last->category,
+    name     => $last->name,
+    version  => $version,
+    ebuild   => $last->ebuild,
+   );
   }
 
  }
@@ -548,7 +714,10 @@ sub _run {
  my ($success, $errmsg, $output) = do {
   local $ENV{PORTDIR_OVERLAY}     = join ' ', @{$stat->portdir_overlay};
   local $ENV{PORTAGE_RO_DISTDIRS} = $stat->distdir;
-  run command => $cmd, verbose => $verbose;
+  IPC::Cmd::run(
+   command => $cmd,
+   verbose => $verbose,
+  );
  };
 
  unless ($success) {
@@ -620,7 +789,7 @@ Kent Fredric, for testing and suggesting improvements.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2008-2009 Vincent Pit, all rights reserved.
+Copyright 2008,2009,2010 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.