handle GNU tar named gnutar, and improve diagnostic messages
[p5sagit/Distar.git] / lib / Distar.pm
index 02db44e..2efc6d2 100644 (file)
@@ -5,8 +5,9 @@ use base qw(Exporter);
 use ExtUtils::MakeMaker ();
 use ExtUtils::MM ();
 use File::Spec ();
+use File::Basename ();
 
-our $VERSION = '0.002000';
+our $VERSION = '0.003000';
 $VERSION = eval $VERSION;
 
 my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;
@@ -18,7 +19,11 @@ our @EXPORT = qw(
 sub import {
   strict->import;
   warnings->import(FATAL => 'all');
-  shift->export_to_level(1,@_);
+  if (!(@MM::ISA == 1 && $MM::ISA[0] eq 'Distar::MM')) {
+    @Distar::MM::ISA = @MM::ISA;
+    @MM::ISA = qw(Distar::MM);
+  }
+  goto &Exporter::import;
 }
 
 sub author {
@@ -72,8 +77,6 @@ sub write_manifest_skip {
 
 {
   package Distar::MM;
-  our @ISA = @MM::ISA;
-  @MM::ISA = (__PACKAGE__);
 
   sub new {
     my ($class, $args) = @_;
@@ -85,7 +88,9 @@ sub write_manifest_skip {
     return $class->SUPER::new({
       LICENSE => 'perl_5',
       MIN_PERL_VERSION => '5.006',
-      AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
+      ($Distar::Author ? (
+        AUTHOR => ($MM_VER >= 6.5702 ? $Distar::Author : join(', ', @$Distar::Author)),
+      ) : ()),
       (exists $args->{ABSTRACT} ? () : (ABSTRACT_FROM => $args->{VERSION_FROM})),
       %$args,
       test => \%test,
@@ -128,6 +133,69 @@ sub write_manifest_skip {
     $targets;
   }
 
+  sub init_dist {
+    my $self = shift;
+    my $pre_tar = $self->{TAR};
+    my $out = $self->SUPER::init_dist(@_);
+
+    my $dn = File::Spec->devnull;
+    my $tar = $self->{TAR};
+    my $gtar;
+    my $set_user;
+    for my $maybe_tar ($tar, qw(gtar gnutar)) {
+      my $version = `$maybe_tar --version 2>$dn`;
+      if ($version =~ /GNU tar/) {
+        $tar = $maybe_tar;
+        $gtar = 1;
+        last;
+      }
+    }
+    my $tarflags = $self->{TARFLAGS};
+    if (my ($flags) = $tarflags =~ /^-?([cvhlLf]+)$/) {
+      if ($flags =~ s/c// && $flags =~ s/f//) {
+        $tarflags = '--format=ustar -c'.$flags.'f';
+        if ($gtar) {
+          $tarflags = '--owner=0 --group=0 '.$tarflags;
+          $set_user = 1;
+        }
+      }
+    }
+
+    if (!$set_user) {
+      my $warn = '';
+      if ($> >= 2**21) {
+        $warn .= "uid ($>)";
+      }
+      if ($) >= 2**21) {
+        $warn .= ($warn ? ' and ' : '').'gid('.(0+$)).')';
+      }
+      if ($warn) {
+        warn "Current $warn too large to create portable dist archives!  Max is ".(2**21-1).".\n"
+          ."Dist creation will most likely fail.  Install GNU tar and re-run Makefile.PL to fix this issue.\n";
+        my @try;
+        my $brew = `which brew 2>$dn`;
+        chomp $brew;
+        if (-x $brew) {
+          push @try, 'brew install gnu-tar';
+        }
+        my $ports = `which ports 2>$dn`;
+        chomp $ports;
+        if (-x $ports) {
+          push @try, 'sudo ports install gnutar';
+        }
+        if (@try) {
+          warn "Try" . (@try > 1 ? ' one of' : '') . ":\n"
+            . join '', map "    $_\n", @try;
+        }
+      }
+    }
+
+    $self->{TAR} = $tar;
+    $self->{TARFLAGS} = $tarflags;
+
+    $out;
+  }
+
   sub tarfile_target {
     my $self = shift;
     my $out = $self->SUPER::tarfile_target(@_);
@@ -150,21 +218,30 @@ END_FRAG
     my @bump_targets =
       grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
 
-    my $distar = File::Spec->catdir(
-      File::Spec->catpath((File::Spec->splitpath(__FILE__))[0,1], ''),
-      File::Spec->updir,
-    );
-    my $helpers = File::Spec->catdir($distar, 'helpers');
+    my $distar_lib = File::Basename::dirname(__FILE__);
+    my $helpers = File::Spec->catdir($distar_lib, File::Spec->updir, 'helpers');
+
+    my $licenses = $self->{LICENSE} || $self->{META_ADD}{license} || $self->{META_MERGE}{license};
+    my $authors = $self->{AUTHOR};
+    $_ = ref $_ ? $_ : [$_ || ()]
+      for $licenses, $authors;
 
     my %vars = (
-      DISTAR => $self->quote_literal($distar),
+      DISTAR_LIB => $self->quote_literal($distar_lib),
       HELPERS => $self->quote_literal($helpers),
-      REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR)/lib', '-mDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
+      REMAKE => join(' ', '$(PERLRUN)', '-I$(DISTAR_LIB)', '-MDistar', 'Makefile.PL', map { $self->quote_literal($_) } @ARGV),
       BRANCH => $self->{BRANCH} ||= 'master',
       CHANGELOG => $self->{CHANGELOG} ||= 'Changes',
       DEV_NULL_STDOUT => ($self->{DEV_NULL} ? '>'.File::Spec->devnull : ''),
-      FAKE_RELEASE => '',
       DISTTEST_MAKEFILE_PARAMS => '',
+      AUTHORS => $self->quote_literal(join(', ', @$authors)),
+      LICENSES => join(' ', map $self->quote_literal($_), @$licenses),
+      GET_CHANGELOG => '$(ABSPERLRUN) $(HELPERS)/get-changelog $(VERSION) $(CHANGELOG)',
+      UPDATE_DISTAR => (
+        -e File::Spec->catdir($distar_lib, File::Spec->updir, '.git')
+          ? 'git -C $(DISTAR_LIB) pull'
+          : '$(ECHO) "Distar code is not in a git repo, unable to update!"'
+      ),
     );
 
     my $dist_test = $self->SUPER::dist_test(@_);
@@ -186,10 +263,12 @@ check-cpan-upload:
        $(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
 releasetest:
        $(MAKE) disttest RELEASE_TESTING=1 DISTTEST_MAKEFILE_PARAMS="PREREQ_FATAL=1" PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
+       $(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(ECHO) "Failed to generate $(DISTVNAME)/LICENSE!" >&2
+       $(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE
 release: preflight
        $(MAKE) releasetest
-       git commit -a -m "Release commit for $(VERSION)"
-       git tag v$(VERSION) -m "release v$(VERSION)"
+       $(GET_CHANGELOG) -p"Release commit for $(VERSION)" | git commit -a -F -
+       $(GET_CHANGELOG) -p"release v$(VERSION)" | git tag -a -F - "v$(VERSION)"
        $(RM_RF) $(DISTVNAME)
        $(MAKE) $(DISTVNAME).tar$(SUFFIX)
        $(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
@@ -198,21 +277,27 @@ pushrelease ::
 pushrelease$(FAKE_RELEASE) ::
        cpan-upload $(DISTVNAME).tar$(SUFFIX)
        git push origin v$(VERSION) HEAD
-distdir: readmefile
+distdir: readmefile licensefile
 readmefile: create_distdir
        $(NOECHO) $(TEST_F) $(DISTVNAME)/README || $(MAKE) $(DISTVNAME)/README
 $(DISTVNAME)/README: $(VERSION_FROM)
        $(NOECHO) $(MKPATH) $(DISTVNAME)
        pod2text $(VERSION_FROM) >$(DISTVNAME)/README
        $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
-distsignature: readmefile
+distsignature: readmefile licensefile
+licensefile: create_distdir
+       $(NOECHO) $(TEST_F) $(DISTVNAME)/LICENSE || $(MAKE) $(DISTVNAME)/LICENSE || $(TRUE)
+$(DISTVNAME)/LICENSE: Makefile.PL
+       $(NOECHO) $(MKPATH) $(DISTVNAME)
+       $(ABSPERLRUN) $(HELPERS)/generate-license -o $(DISTVNAME)/LICENSE $(AUTHORS) $(LICENSES)
+       $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) LICENSE
 disttest: distmanicheck
 distmanicheck: create_distdir
        cd $(DISTVNAME) && $(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"
 nextrelease:
        $(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)
 refresh:
-       cd $(DISTAR) && git pull || $(TRUE)
+       $(UPDATE_DISTAR)
        $(RM_F) $(FIRST_MAKEFILE)
        $(REMAKE)
 END