This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Pass the git tag to cmpVERSION.pl with a --tag argument.
[perl5.git] / Porting / cmpVERSION.pl
old mode 100644 (file)
new mode 100755 (executable)
index 0f808c8..ec6b869
 #!/usr/bin/perl -w
 
+# cmpVERSION - compare the current Perl source tree and a given tag
+# for modules that have identical version numbers but different contents.
 #
-# cmpVERSION - compare two Perl source trees for modules
-# that have identical version numbers but different contents.
+# with -d option, output the diffs too
+# with -x option, exclude dual-life modules (after all, there are tools
+#                 like core-cpan-diff that can already deal with them)
 #
-# withg -d option, output the diffs too
-#
-# Original by slaven@rezic.de, modified by jhi.
+# Original by slaven@rezic.de, modified by jhi and matt.w.johnson@gmail.com.
 #
 
 use strict;
 
 use ExtUtils::MakeMaker;
 use File::Compare;
-use File::Find;
-use File::Spec::Functions qw(rel2abs abs2rel catfile catdir curdir);
-use Getopt::Std;
-
-sub usage {
-die <<'EOF';
-usage: $0 [ -d ] source_dir1 source_dir2
-EOF
+use File::Spec::Functions qw(devnull);
+use Getopt::Long;
+
+my ($diffs, $exclude_dual, $tag_to_compare);
+unless (GetOptions('diffs' => \$diffs,
+                  'exclude|x' => \$exclude_dual,
+                  'tag=s' => \$tag_to_compare,
+                  ) && @ARGV == 0) {
+    die "usage: $0 [ -d -x --tag TAG]";
 }
 
-my %opts;
-getopts('d', \%opts) or usage;
-@ARGV == 2 or usage;
+die "$0: This does not look like a Perl directory\n"
+    unless -f "perl.h" && -d "Porting";
+die "$0: 'This is a Perl directory but does not look like Git working directory\n"
+    unless -d ".git";
+
+my $null = devnull();
 
-for (@ARGV[0, 1]) {
-    die "$0: '$_' does not look like Perl directory\n"
-       unless -f catfile($_, "perl.h") && -d catdir($_, "Porting");
+unless (defined $tag_to_compare) {
+    # Thanks to David Golden for this suggestion.
+
+    $tag_to_compare = `git describe --abbrev=0`;
+    chomp $tag_to_compare;
 }
 
-my $dir2 = rel2abs($ARGV[1]);
-chdir $ARGV[0] or die "$0: chdir '$ARGV[0]' failed: $!\n";
+my $tag_exists = `git --no-pager tag -l $tag_to_compare 2>$null`;
+chomp $tag_exists;
+
+die "$0: '$tag_to_compare' is not a known Git tag\n"
+    unless $tag_exists eq $tag_to_compare;
+
+my %dual_files;
+if ($exclude_dual) {
+    unshift @INC, 'Porting';
+    require Maintainers;
+
+    for my $m (grep $Maintainers::Modules{$_}{CPAN},
+                               keys %Maintainers::Modules) {
+       $dual_files{$_} = 1 for Maintainers::get_module_files($m);
+    }
+}
 
 # Files to skip from the check for one reason or another,
 # usually because they pull in their version from some other file.
 my %skip;
 @skip{
-    './lib/Carp/Heavy.pm',
-    './lib/Exporter/Heavy.pm',
-    './win32/FindExt.pm'
+    'lib/Carp/Heavy.pm',
+    'lib/Config.pm',           # no version number but contents will vary
+    'lib/Exporter/Heavy.pm',
+    'win32/FindExt.pm',
 } = ();
-my $skip_dirs = qr|^\./t/lib|;
-
-my @wanted;
-my @diffs;
-find(
-     sub { /\.pm$/ &&
-              $File::Find::dir !~ $skip_dirs &&
-              ! exists $skip{$File::Find::name}
-              &&
-              do { my $file2 =
-                       catfile(catdir($dir2, $File::Find::dir), $_);
-                   (my $xs_file1 = $_)     =~ s/\.pm$/.xs/;
-                   (my $xs_file2 = $file2) =~ s/\.pm$/.xs/;
-                   my $eq1 = compare($_, $file2) == 0;
-                   my $eq2 = 1;
-                   if (-e $xs_file1 && -e $xs_file2) {
-                       $eq2 = compare($xs_file1, $xs_file2) == 0;
-                   }
-                   return if $eq1 && $eq2;
-                   my $version1 = eval {MM->parse_version($_)};
-                   my $version2 = eval {MM->parse_version($file2)};
-                   return unless
-                       defined $version1 &&
-                       defined $version2 &&
-                        $version1 eq $version2;
-                   push @wanted, $File::Find::name;
-                   push @diffs, [ "$File::Find::dir/$_", $file2 ] unless $eq1;
-                   push @diffs, [ "$File::Find::dir/$xs_file1", $xs_file2 ]
-                                                                  unless $eq2;
-               } }, curdir);
-for (sort @wanted) {
+my $skip_dirs = qr|^t/lib|;
+
+my @all_diffs = `git --no-pager diff --name-only $tag_to_compare`;
+chomp @all_diffs;
+
+my @module_diffs = grep {
+    my $this_dir;
+    $this_dir = $1 if m/^(.*)\//;
+    /\.pm$/ &&
+    (!defined($this_dir) || ($this_dir !~ $skip_dirs)) &&
+    !exists $skip{$_} &&
+    !exists $dual_files{$_}
+} @all_diffs;
+
+my (@output_files, @output_diffs);
+
+foreach my $pm_file (@module_diffs) {
+    (my $xs_file = $pm_file) =~ s/\.pm$/.xs/;
+    my $pm_eq = compare_git_file($pm_file, $tag_to_compare);
+    next unless defined $pm_eq;
+    my $xs_eq = 1;
+    if (-e $xs_file) {
+        $xs_eq = compare_git_file($xs_file, $tag_to_compare);
+        next unless defined $xs_eq;
+    }
+    next if ($pm_eq && $xs_eq);
+    my $pm_version = eval {MM->parse_version($pm_file)};
+    my $orig_pm_content = get_file_from_git($pm_file, $tag_to_compare);
+    my $orig_pm_version = eval {MM->parse_version(\$orig_pm_content)};
+    next if ( ! defined $pm_version || ! defined $orig_pm_version );
+    next if ( $pm_version eq 'undef' || $orig_pm_version eq 'undef' ); # sigh
+    next if $pm_version ne $orig_pm_version;
+    push @output_files, $pm_file;
+    push @output_diffs, $pm_file unless $pm_eq;
+    push @output_diffs, $xs_file unless $xs_eq;
+}
+
+sub compare_git_file {
+    my ($file, $tag) = @_;
+    open(my $orig_fh, "-|", "git --no-pager show $tag:$file 2>$null");
+    return undef if eof($orig_fh);
+    my $is_eq = compare($file, $orig_fh) == 0;
+    close($orig_fh);
+    return $is_eq;
+}
+
+sub get_file_from_git {
+    my ($file, $tag) = @_;
+    local $/ = undef;
+    my $file_content = `git --no-pager show $tag:$file 2>$null`;
+    return $file_content;
+}
+
+for (sort @output_files) {
     print "$_\n";
 }
-exit unless $opts{d};
-for (sort { $a->[0] cmp $b->[0] } @diffs) {
+
+exit unless $diffs;
+
+for (sort @output_diffs) {
     print "\n";
-    system "diff -du '$_->[0]' '$_->[1]'";
+    system "git --no-pager diff $tag_to_compare '$_'";
 }