This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Time-Piece to CPAN version 1.23
[perl5.git] / Porting / sync-with-cpan
index 3c9c732..c3f9ce1 100755 (executable)
-#!/usr/bin/perl
+#!/usr/bin/env perl
 
-#
-# Script to help out with syncing cpan distros.
-#
-# Does the following:
-#    - Fetches the package list from CPAN. Finds the current version of
-#      the given package.
-#    - Downloads the relevant tarball; unpacks the tarball;.
-#    - Clean out the old directory (git clean -dfx)
-#    - Moves the old directory out of the way, moves the new directory in place.
-#    - Restores any .gitignore file.
-#    - Removes files from @IGNORE and EXCLUDED
-#    - git add any new files.
-#    - git rm any files that are gone.
-#    - Remove the +x bit on files in t/
-#    - Remove the +x bit on files that don't have in enabled in the current dir
-#    - Restore files mentioned in CUSTOMIZED
-#    - Adds new files to MANIFEST
-#    - Runs a "make" (assumes a configure has been run)
-#    - Cleans up
-#    - Runs tests for the package
-#    - Runs the porting tests
-#
-# TODO:  - Delete files from MANIFEST
-#        - Update Porting/Maintainers.pl
-#        - Optional, run a full test suite
-#        - Handle complicated FILES
-#
-# This is an initial version; no attempt has been made yet to make this
-# portable. It shells out instead of trying to find a Perl solution.
-# In particular, it assumes wget, git, tar, chmod, perl, make, and rm
-# to be available.
-#
-# Usage: perl Porting/sync-with-cpan <module>
-#        where <module> is the name it appears in the %Modules hash
-#        of Porting/Maintainers.pl
-#
+=head1 NAME
+
+Porting/sync-with-cpan - Synchronize with CPAN distributions
+
+=head1 SYNOPSIS
+
+  perl Porting/sync-with-cpan <module>
+
+where <module> is the name it appears in the C<%Modules> hash
+of F<Porting/Maintainers.pl>
+
+=head1 DESCRIPTION
+
+Script to help out with syncing cpan distros.
+
+Does the following:
+
+=over 4
+
+=item *
+
+Fetches the package list from CPAN. Finds the current version of the given
+package. [1]
+
+=item *
+
+Downloads the relevant tarball; unpacks the tarball. [1]
+
+=item *
+
+Clean out the old directory (C<git clean -dfx>)
+
+=item *
+
+Moves the old directory out of the way, moves the new directory in place.
+
+=item *
+
+Restores any F<.gitignore> file.
+
+=item *
+
+Removes files from C<@IGNORE> and C<EXCLUDED>
+
+=item *
+
+C<git add> any new files.
+
+=item *
+
+C<git rm> any files that are gone.
+
+=item *
+
+Remove the +x bit on files in F<t/>
+
+=item *
+
+Remove the +x bit on files that don't have it enabled in the current dir
+
+=item *
+
+Restore files mentioned in C<CUSTOMIZED>
+
+=item *
+
+Adds new files to F<MANIFEST>
+
+=item *
+
+Runs a C<make> (assumes a configure has been run)
+
+=item *
+
+Cleans up
+
+=item *
+
+Runs tests for the package
+
+=item *
+
+Runs the porting tests
+
+=back
+
+[1]  If the C<--tarball> option is given, then CPAN is not consulted.
+C<--tarball> should be the path to the tarball; the version is extracted
+from the filename -- but can be overwritten by the C<--version> option.
+
+=head1 TODO
+
+=over 4
+
+=item *
+
+Delete files from F<MANIFEST>
+
+=item *
+
+Update F<Porting/Maintainers.pl>
+
+=item *
+
+Optional, run a full test suite
+
+=item *
+
+Handle complicated C<FILES>
+
+=back
+
+This is an initial version; no attempt has been made yet to make this
+portable. It shells out instead of trying to find a Perl solution.
+In particular, it assumes wget, git, tar, chmod, perl, make, and rm
+to be available.
+
+=cut
+
+
+package Maintainers;
 
 use 5.010;
 
 use strict;
 use warnings;
-no  warnings 'syntax';
+use Getopt::Long;
+use Archive::Tar;
 
 $| = 1;
 
-die "This does not like top level directory"
+die "This does not look like a top level directory"
      unless -d "cpan" && -d "Porting";
 
-package Maintainers;
-
 our @IGNORABLE;
 our %Modules;
 
@@ -57,71 +141,157 @@ use autodie;
 
 require "Porting/Maintainers.pl";
 
-chdir "cpan";
-
 my %IGNORABLE    = map {$_ => 1} @IGNORABLE;
 
 my $package      = "02packages.details.txt";
 my $package_url  = "http://www.cpan.org/modules/$package";
 my $package_file = "/tmp/$package";
 
-#
-# Poor man's cache
-#
-unless (-f $package_file && -M $package_file < 1) {
-    system wget => $package_url, '-qO', $package_file;
-}
+my @problematic = (
+    'podlators', # weird CUSTOMIZED section due to .PL files
+);
+
+
+GetOptions ('tarball=s'  =>  \my $tarball,
+            'version=s'  =>  \my $version,
+             force       =>  \my $force,)
+        or  die "Failed to parse arguments";
 
-die "Usage: $0 module" unless @ARGV == 1;
+die "Usage: $0 module [args] [cpan package]" unless @ARGV == 1 || @ARGV == 2;
+
+my ($module)  = shift;
+my  $cpan_mod = @ARGV ? shift : $module;
 
-my ($module) = @ARGV;
 
 my  $info         = $Modules {$module} or die "Cannot find module $module";
 my  $distribution = $$info {DISTRIBUTION};
-my  $pkg_dir      = $$info {FILES};
+
+my @files         = glob $$info {FILES};
+if (!-d $files [0] || grep { $_ eq $module } @problematic) {
+    say "This looks like a setup $0 cannot handle (yet)";
+    unless ($force) {
+        say "Will not continue without a --force option";
+        exit 1;
+    }
+    say "--force is in effect, so we'll soldier on. Wish me luck!";
+}
+
+
+chdir "cpan";
+
+my  $pkg_dir      = $files[0];
     $pkg_dir      =~ s!.*/!!;
 
 my ($old_version) = $distribution =~ /-([0-9.]+)\.tar\.gz/;
 
 my  $o_module     = $module;
-if ($module =~ /-/ && $module !~ /::/) {
-    $module =~ s/-/::/g;
+if ($cpan_mod =~ /-/ && $cpan_mod !~ /::/) {
+    $cpan_mod =~ s/-/::/g;
 }
 
 #
 # Find the information from CPAN.
 #
-my  $new_line = `grep '^$module ' $package_file`
-                 or die "Cannot find $module on CPAN\n";
-chomp $new_line;
-my (undef, $new_version, $new_path) = split ' ', $new_line;
-my $new_file = (split '/', $new_path) [-1];
+my $new_file;
+my $new_version;
+unless ($tarball) {
+    #
+    # Poor man's cache
+    #
+    unless (-f $package_file && -M $package_file < 1) {
+        system wget => $package_url, '-qO', $package_file;
+    }
+
+    my  $new_line = `grep '^$cpan_mod ' $package_file`
+                     or die "Cannot find $cpan_mod on CPAN\n";
+    chomp $new_line;
+    (undef, $new_version, my $new_path) = split ' ', $new_line;
+    if (defined $version) {
+        $new_path =~ s/-$new_version\./-$version\./;
+        $new_version = $version;
+    }
+    $new_file = (split '/', $new_path) [-1];
+
+    my $url = "http://search.cpan.org/CPAN/authors/id/$new_path";
+    say "Fetching $url";
+    #
+    # Fetch the new distro
+    #
+    system wget => $url, '-qO', $new_file;
+}
+else {
+    $new_file     = $tarball;
+    $new_version  = $version // ($new_file =~ /-([0-9._]+)\.tar\.gz/) [0];
+}
 
 my  $old_dir      = "$pkg_dir-$old_version";
-my  $new_dir      = "$pkg_dir-$new_version";
 
 say "Cleaning out old directory";
 system git => 'clean', '-dfxq', $pkg_dir;
 
+say "Unpacking $new_file";
+Archive::Tar->extract_archive( $new_file );
 
+(my $new_dir = $new_file) =~ s/\.tar\.gz//;
+# ensure 'make' will update all files
+system('find', $new_dir, '-exec', 'touch', '{}', ';');
 
-my $url = "http://search.cpan.org/CPAN/authors/id/$new_path";
+say "Renaming directories";
+rename $pkg_dir => $old_dir;
 
-say "Fetching $url";
+say "Creating new package directory";
+mkdir $pkg_dir;
 
-#
-# Fetch the new distro
-#
-system wget => $url, '-qO', $new_file;
+say "Populating new package directory";
+my $map = $$info {MAP};
+my @EXCLUDED_QR;
+my %EXCLUDED_QQ;
+if ($$info {EXCLUDED}) {
+    foreach my $entry (@{$$info {EXCLUDED}}) {
+        if (ref $entry) {push @EXCLUDED_QR => $entry}
+        else            {$EXCLUDED_QQ {$entry} = 1}
+    }
+}
 
-say "Unpacking $new_file";
+FILE: for my $file ( `find $new_dir -type f` ) {
+    chomp $file;
+    my $old_file = $file;
+    $file =~ s{^$new_dir/}{};
 
-system tar => 'xfz', $new_file;
+    next if $EXCLUDED_QQ{$file};
+    for my $qr (@EXCLUDED_QR) {
+        next FILE if $file =~ $qr;
+    }
 
-say "Renaming directories";
-rename $pkg_dir => $old_dir;
-rename $new_dir => $pkg_dir;
+    if ( $map ) {
+        for my $key ( sort { length $b <=> length $a } keys %$map ) {
+            my $val = $map->{$key};
+            last if $file =~ s/^$key/$val/;
+        }
+    }
+    else {
+        $file = $files[0] . '/' . $file;
+    }
 
+    if ( $file =~ m{^cpan/} ) {
+        $file =~ s{^cpan/}{};
+    }
+    else {
+        $file = '../' . $file;
+    }
+
+    my $prefix = '';
+    my @parts = split '/', $file;
+    pop @parts;
+    for my $part (@parts) {
+        $prefix .= '/' if $prefix;
+        $prefix .= $part;
+        mkdir $prefix unless -d $prefix;
+    }
+
+    rename $old_file => $file;
+}
+system 'rm', '-rf', $new_dir;
 
 if (-f "$old_dir/.gitignore") {
     say "Restoring .gitignore";
@@ -140,18 +310,6 @@ chomp @old_files;
 s!^[^/]+/!! for @old_files;
 my %old_files = map {$_ => 1} @old_files;
 
-#
-# Find files that can be deleted.
-#
-my @EXCLUDED_QR;
-my %EXCLUDED_QQ;
-if ($$info {EXCLUDED}) {
-    foreach my $entry (@{$$info {EXCLUDED}}) {
-        if (ref $entry) {push @EXCLUDED_QR => $entry}
-        else            {$EXCLUDED_QQ {$entry} = 1}
-    }
-}
-
 my @delete;
 my @commit;
 my @gone;
@@ -163,16 +321,6 @@ foreach my $file (@new_files) {
         push @delete => $file;
         next;
     }
-    if ($EXCLUDED_QQ {$file}) {
-        push @delete => $file;
-        next;
-    }
-    foreach my $pattern (@EXCLUDED_QR) {
-        if ($file =~ /$pattern/) {
-            push @delete => $file;
-            next FILE;
-        }
-    }
     push @commit => $file;
 }
 foreach my $file (@old_files) {
@@ -254,13 +402,13 @@ print "done\n";
 
 #
 # Must clean up, or else t/porting/FindExt.t will fail.
-# Note that we can always retrieve the orginal directory with a git checkout.
+# Note that we can always retrieve the original directory with a git checkout.
 #
 print "About to clean up; hit return or abort (^C) "; <STDIN>;
 
 chdir "cpan";
 system rm => '-r', $old_dir;
-unlink $new_file;
+unlink $new_file unless $tarball;
 
 
 #
@@ -290,10 +438,48 @@ print "\n";
 say "Failed tests: @failed" if @failed;
 
 
-print "Now you ought to run a make; make test ...\n";
+say "Attempting to update Maintainers.pl";
+chdir '..';
+
+open my $Maintainers_pl, '<', 'Porting/Maintainers.pl';
+open my $new_Maintainers_pl, '>', 'Maintainers.pl';
+
+my $found;
+my $in_mod_section;
+while (<$Maintainers_pl>) {
+    if (!$found) {
+        if ($in_mod_section) {
+            if (/DISTRIBUTION/) {
+                if (s/\Q$old_version/$new_version/) {
+                    $found = 1;
+                }
+            }
+
+            if (/^    }/) {
+                $in_mod_section = 0;
+            }
+        }
+
+        if (/\Q$cpan_mod/) {
+            $in_mod_section = 1;
+        }
+    }
+
+    print $new_Maintainers_pl $_;
+}
+
+if ($found) {
+    unlink 'Porting/Maintainers.pl';
+    rename 'Maintainers.pl' => 'Porting/Maintainers.pl';
+    system chmod => 'a+x', 'Porting/Maintainers.pl';
+}
+else {
+    say "Could not update Porting/Maintainers.pl.";
+    say "Make sure you update this by hand before committing.";
+}
 
-say "Do not forget to update Porting/Maintainers.pl before committing";
 say "$o_module is now version $new_version";
+say "Now you ought to run a make; make test ...";
 
 
 __END__