make functions return 1 to avoid borkage on do
[p5sagit/Distar.git] / lib / Distar.pm
index c0950ca..e048045 100644 (file)
@@ -5,9 +5,10 @@ use base qw(Exporter);
 use ExtUtils::MakeMaker ();
 use ExtUtils::MM ();
 use File::Spec ();
+use File::Basename ();
 
-our $VERSION = '0.002000';
-$VERSION = eval $VERSION;
+our $VERSION = '0.003000';
+$VERSION =~ tr/_//d;
 
 my $MM_VER = eval $ExtUtils::MakeMaker::VERSION;
 
@@ -18,13 +19,18 @@ 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 {
   our $Author = shift;
   $Author = [ $Author ]
     if !ref $Author;
+  1;
 }
 
 our @Manifest = (
@@ -41,6 +47,7 @@ our @Manifest = (
 
 sub manifest_include {
   push @Manifest, @_;
+  1;
 }
 
 sub readme_generator {
@@ -72,18 +79,39 @@ sub write_manifest_skip {
 
 {
   package Distar::MM;
-  our @ISA = @MM::ISA;
-  @MM::ISA = (__PACKAGE__);
+
+  sub _gen_make_section {
+    return join '',
+      map {
+        my @lines;
+        if (ref) {
+          @lines = @$_;
+          s/^\t?/\t/mg for @lines;
+        }
+        else {
+          @lines = $_;
+        }
+        s/\n?\z/\n/ for @lines;
+        @lines;
+      } @_;
+  }
 
   sub new {
     my ($class, $args) = @_;
+    my %test = %{$args->{test}||{}};
+    my $tests = $test{TESTS} || 't/*.t';
+    $tests !~ /\b\Q$_\E\b/ and $tests .= " $_"
+      for 'xt/*.t', 'xt/*/*.t';
+    $test{TESTS} = $tests;
     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 => { TESTS => ($args->{test}{TESTS}||'t/*.t').' xt/*.t xt/*/*.t' },
+      test => \%test,
       realclean => { FILES => (
         ($args->{realclean}{FILES}||'')
         . ' Distar/ MANIFEST.SKIP MANIFEST MANIFEST.bak'
@@ -93,7 +121,11 @@ sub write_manifest_skip {
 
   sub flush {
     my $self = shift;
-    Distar::write_manifest_skip($self);
+    `git ls-files --error-unmatch MANIFEST.SKIP 2>&1`;
+    my $maniskip_tracked = !$?;
+
+    Distar::write_manifest_skip($self)
+      unless $maniskip_tracked;
     $self->SUPER::flush(@_);
   }
 
@@ -119,86 +151,188 @@ sub write_manifest_skip {
     $targets;
   }
 
-  sub dist_test {
+  sub init_dist {
     my $self = shift;
-
-    my $include = '';
-    if (open my $fh, '<', 'maint/Makefile.include') {
-      $include = "\n# --- Makefile.include:\n\n" . do { local $/; <$fh> };
-      $include =~ s/\n?\z/\n/;
+    my $out = $self->SUPER::init_dist(@_);
+
+    my $dn = File::Spec->devnull;
+    my $tar = $self->{TAR};
+
+    my $tarflags = $self->{TARFLAGS};
+    if (my ($flags) = $tarflags =~ /^-?([cvhlLf]+)$/) {
+      if ($flags =~ s/c// && $flags =~ s/f//) {
+        $tarflags = '--format=ustar -c'.$flags.'f';
+        my $me = __FILE__;
+        for my $options ('--owner=0 --group=0', '--uid=0 --gid=0') {
+          my $try = `$tar -c $options "$me" 2>$dn`;
+          if (length $try) {
+            $tarflags = "$options $tarflags";
+            last;
+          }
+        }
+      }
     }
 
-    my @bump_targets =
-      grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
+    $self->{TAR} = $tar;
+    $self->{TARFLAGS} = $tarflags;
 
-    my $distar = File::Spec->catdir(
-      File::Spec->catpath((File::Spec->splitpath(__FILE__))[0,1], ''),
-      File::Spec->updir,
-    );
-    my $helpers = File::Spec->catdir($distar, 'helpers');
+    $out;
+  }
+
+  sub libscan {
+    my $self = shift;
+    my ($path) = @_;
+
+    # default setup for Distar involves checking it out as a subdirectory at
+    # the top of the dist.  Without NORECURS, EUMM would try to include
+    # Distar's Makefile.PL.  Prevent EUMM from looking inside.
+    return ''
+      if $path eq 'Distar';
+
+    $self->SUPER::libscan(@_);
+  }
+
+  sub tarfile_target {
+    my $self = shift;
+    my $out = $self->SUPER::tarfile_target(@_);
+    my $verify = _gen_make_section([
+      '$(ABSPERLRUN) $(HELPERS)/verify-tarball $(DISTVNAME).tar $(DISTVNAME)/MANIFEST --tar="$(TAR)"',
+    ]);
+    $out =~ s{(\$\(TAR\).*\n)}{$1$verify};
+    $out;
+  }
+
+  sub dist_test {
+    my $self = shift;
+
+    my $distar_lib = File::Basename::dirname(__FILE__);
+    my $helpers = File::Spec->catdir($distar_lib, 'Distar', '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)', '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(@_);
+    $dist_test =~ s/(\bMakefile\.PL\b)/$1 \$(DISTTEST_MAKEFILE_PARAMS)/;
+
+    my $include = '';
+    if (open my $fh, '<', 'maint/Makefile.include') {
+      $include = do { local $/; <$fh> };
+      $include =~ s/\n?\z/\n/;
+    }
+
+    my @out;
+
+    push @out, (
+      'preflight: check-version check-manifest check-cpan-upload' => [
+        '$(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)',
+      ],
+      'check-version:' => [
+        '$(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)',
+      ],
+      'check-manifest:' => [
+        '$(ABSPERLRUN) $(HELPERS)/check-manifest',
+      ],
+      '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',
+        '$(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)',
+      ],
+      'pushrelease ::' => [
+        '$(NOECHO) $(NOOP)',
+      ],
+      'pushrelease$(FAKE_RELEASE) ::' => [
+        'cpan-upload $(DISTVNAME).tar$(SUFFIX)',
+        'git push origin v$(VERSION) HEAD',
+      ],
+      '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 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' => [
+        $self->cd('$(DISTVNAME)',
+          '$(ABSPERLRUN) "-MExtUtils::Manifest=manicheck" -e "exit manicheck"',
+        ),
+      ],
+      'nextrelease:' => [
+        '$(ABSPERLRUN) $(HELPERS)/add-changelog-heading --git $(VERSION) $(CHANGELOG)',
+      ],
+      'refresh:' => [
+        '$(UPDATE_DISTAR)',
+        '$(RM_F) $(FIRST_MAKEFILE)',
+        '$(REMAKE)',
+      ],
+    );
+
+    my @bump_targets =
+      grep { $include !~ /^bump$_(?: +\w+)*:/m } ('', 'minor', 'major');
+
+    push @out, map +(
+      "bump$_:" => [
+        '$(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) '.($_ || '$(V)'),
+        '$(RM_F) $(FIRST_MAKEFILE)',
+        '$(REMAKE)',
+      ],
+    ), @bump_targets;
+
     join('',
-      $self->SUPER::dist_test(@_),
+      $dist_test,
       "\n\n# --- Distar section:\n\n",
       (map "$_ = $vars{$_}\n", sort keys %vars),
-      <<'END',
-
-preflight: check-version check-manifest check-cpan-upload
-       $(ABSPERLRUN) $(HELPERS)/preflight $(VERSION) --changelog=$(CHANGELOG) --branch=$(BRANCH)
-check-version:
-       $(ABSPERLRUN) $(HELPERS)/check-version $(VERSION) $(TO_INST_PM) $(EXE_FILES)
-check-manifest:
-       $(ABSPERLRUN) $(HELPERS)/check-manifest
-check-cpan-upload:
-       $(NOECHO) cpan-upload -h $(DEV_NULL_STDOUT)
-releasetest:
-       $(MAKE) disttest RELEASE_TESTING=1 PASTHRU="$(PASTHRU) TEST_FILES=\"$(TEST_FILES)\""
-release: preflight
-       $(MAKE) releasetest
-       git commit -a -m "Release commit for $(VERSION)"
-       git tag v$(VERSION) -m "release v$(VERSION)"
-       $(RM_RF) $(DISTVNAME)
-       $(MAKE) $(DISTVNAME).tar$(SUFFIX)
-       $(NOECHO) $(MAKE) pushrelease FAKE_RELEASE=$(FAKE_RELEASE)
-pushrelease ::
-       $(NOECHO) $(NOOP)
-pushrelease$(FAKE_RELEASE) ::
-       cpan-upload $(DISTVNAME).tar$(SUFFIX)
-       git push origin v$(VERSION) HEAD
-distdir: readmefile
-readmefile: create_distdir
-       $(NOECHO) $(MAKE) $(DISTVNAME)/README
-$(DISTVNAME)/README: $(VERSION_FROM)
-       $(NOECHO) $(MKPATH) $(DISTVNAME)
-       pod2text $(VERSION_FROM) >$(DISTVNAME)/README
-       $(NOECHO) $(ABSPERLRUN) $(HELPERS)/add-to-manifest -d $(DISTVNAME) README
-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
-       $(RM_F) $(FIRST_MAKEFILE)
-       $(REMAKE)
-END
-      map(sprintf(<<'END', "bump$_", ($_ || '$(V)')), @bump_targets),
-%s:
-       $(ABSPERLRUN) $(HELPERS)/bump-version --git $(VERSION) %s
-       $(RM_F) $(FIRST_MAKEFILE)
-       $(REMAKE)
-END
-      $include,
+      "\n",
+      _gen_make_section(@out),
+      ($include ? (
+        "\n",
+        "# --- Makefile.include:\n",
+        "\n",
+        $include,
+        "\n"
+      ) : ()),
       "\n",
     );
   }
@@ -216,7 +350,7 @@ Distar - Additions to ExtUtils::MakeMaker for dist authors
 F<Makefile.PL>:
 
   use ExtUtils::MakeMaker;
-  (do 'maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
+  (do './maint/Makefile.PL.include' or die $@) unless -f 'META.yml';
 
   WriteMakefile(...);
 
@@ -241,8 +375,12 @@ make commmands:
   $ make nextrelease      # add version heading to Changes file
   $ make releasetest      # build dist and test (with xt/ and RELEASE_TESTING=1)
   $ make preflight        # check that repo and file state is release ready
-  $ make release          # check releasetest and preflight, then build and
-                          # upload to CPAN, tag release, push tag and branch
+  $ make release          # check releasetest and preflight, commits and tags,
+                          # builds and uploads to CPAN, and pushes commits and
+                          # tag
+  $ make release FAKE_RELEASE=1
+                          # builds a release INCLUDING committing and tagging,
+                          # but does not upload to cpan or push anything to git
 
 =head1 DESCRIPTION
 
@@ -308,7 +446,7 @@ C<preflight> and C<releasetest> commands.
 Releasing will generate a dist tarball and upload it to CPAN using cpan-upload.
 It will also create a git tag for the release, and push the tag and branch.
 
-=head2 FAKE_RELEASE
+=head3 FAKE_RELEASE
 
 If release is run with FAKE_RELEASE=1 set, it will skip uploading to CPAN and
 pushing to git.  A release commit will still be created and tagged locally.
@@ -352,13 +490,40 @@ change.
 =head2 bump
 
 Bumps the version number.  This will try to preserve the length and format of
-the version number.  The least significant digit will be incremented.
+the version number.  The least significant digit will be incremented.  Versions
+with underscores will preserve the underscore in the same position.
 
 Optionally accepts a C<V> option to set the version to a specific value.
 
 The version changes will automatically be committed.  Unstaged modifications to
 the files will be left untouched.
 
+=head3 V
+
+The V option will be passed along to the version bumping script.  It can accept
+a space separated list of options, including an explicit version number.
+
+Options:
+
+=over 4
+
+=item --force
+
+Updates version numbers even if they do not match the current expected version
+number.
+
+=item --stable
+
+Attempts to convert the updated version to a stable version, removing any
+underscore.
+
+=item --alpha
+
+Attempts to convert the updated version to an alpha version, adding an
+underscore in an appropriate place.
+
+=back
+
 =head2 bumpminor
 
 Like bump, but increments the minor segment of the version.  This will treat
@@ -388,7 +553,7 @@ mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
 
 haarg - Graham Knop (cpan:HAARG) <haarg@cpan.org>
 
-ether = Karen Etheridge (cpan:ETHER) <ether@cpan.org>
+ether - Karen Etheridge (cpan:ETHER) <ether@cpan.org>
 
 frew - Arthur Axel "fREW" Schmidt (cpan:FREW) <frioux@gmail.com>