This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix a thinko in filtering excluded module files
[perl5.git] / Porting / Maintainers.pm
CommitLineData
0cf51544
JH
1#
2# Maintainers.pm - show information about maintainers
3#
4
5package Maintainers;
6
7use strict;
2b4af749 8use warnings;
0cf51544
JH
9
10use lib "Porting";
357244ac
NC
11# Please don't use post 5.008 features as this module is used by
12# Porting/makemeta, and that in turn has to be run by the perl just built.
13use 5.008;
0cf51544
JH
14
15require "Maintainers.pl";
16use vars qw(%Modules %Maintainers);
17
d8528f07 18use vars qw(@ISA @EXPORT_OK $VERSION);
0cf51544
JH
19@ISA = qw(Exporter);
20@EXPORT_OK = qw(%Modules %Maintainers
21 get_module_files get_module_pat
da92fd60 22 show_results process_options files_to_modules
2b4af749 23 finish_tap_output
da92fd60 24 reload_manifest);
394fdf77 25$VERSION = 0.06;
2b4af749 26
0cf51544
JH
27require Exporter;
28
29use File::Find;
30use Getopt::Long;
31
32my %MANIFEST;
da92fd60
DM
33
34# (re)read the MANIFEST file, blowing away any previous effort
35
36sub reload_manifest {
37 %MANIFEST = ();
2b4af749
JV
38
39 my $manifest_path = 'MANIFEST';
40 if (! -e $manifest_path) {
41 $manifest_path = "../MANIFEST";
42 }
43
44 if (open(my $manfh, $manifest_path )) {
45 while (<$manfh>) {
da92fd60
DM
46 if (/^(\S+)/) {
47 $MANIFEST{$1}++;
48 }
49 else {
50 warn "MANIFEST:$.: malformed line: $_\n";
51 }
0cf51544 52 }
2b4af749 53 close $manfh;
da92fd60 54 } else {
2b4af749 55 die "$0: Failed to open MANIFEST for reading: $!\n";
0cf51544 56 }
0cf51544
JH
57}
58
da92fd60
DM
59reload_manifest;
60
61
0cf51544
JH
62sub get_module_pat {
63 my $m = shift;
64 split ' ', $Modules{$m}{FILES};
65}
66
adcdf46b
DM
67# exand dir/ or foo* into a full list of files
68#
69sub expand_glob {
70 sort { lc $a cmp lc $b }
71 map {
d9ef0156 72 -f $_ && $_ !~ /[*?]/ ? # File as-is.
adcdf46b 73 $_ :
d9ef0156 74 -d _ && $_ !~ /[*?]/ ? # Recurse into directories.
adcdf46b
DM
75 do {
76 my @files;
77 find(
78 sub {
79 push @files, $File::Find::name
80 if -f $_ && exists $MANIFEST{$File::Find::name};
81 }, $_);
82 @files;
83 }
84 # The rest are globbable patterns; expand the glob, then
47e01c32 85 # recursively perform directory expansion on any results
adcdf46b
DM
86 : expand_glob(grep -e $_,glob($_))
87 } @_;
88}
89
5fcec77c
FR
90sub filter_excluded {
91 my ($m, @files) = @_;
92
93 return @files
94 unless my $excluded = $Modules{$m}{EXCLUDED};
95
96 my ($pat) = map { qr/$_/ } join '|' => map {
394fdf77 97 ref $_ ? $_ : qr/\Q$_\E/
5fcec77c
FR
98 } @{ $excluded };
99
100 return grep { $_ !~ $pat } @files;
101}
102
0cf51544
JH
103sub get_module_files {
104 my $m = shift;
5fcec77c 105 return filter_excluded $m => map { expand_glob($_) } get_module_pat($m);
0cf51544
JH
106}
107
adcdf46b 108
0cf51544
JH
109sub get_maintainer_modules {
110 my $m = shift;
111 sort { lc $a cmp lc $b }
112 grep { $Modules{$_}{MAINTAINER} eq $m }
113 keys %Modules;
114}
115
116sub usage {
b7bed276
DM
117 warn <<__EOF__;
118$0: Usage:
119 --maintainer M | --module M [--files]
120 List modules or maintainers matching the pattern M.
121 With --files, list all the files associated with them
122or
123 --check | --checkmani [commit | file ... | dir ... ]
124 Check consistency of Maintainers.pl
3428fdd5
RB
125 with a file checks if it has a maintainer
126 with a dir checks all files have a maintainer
b7bed276
DM
127 with a commit checks files modified by that commit
128 no arg checks for multiple maintainers
129 --checkmani is like --check, but only reports on unclaimed
130 files if they are in MANIFEST
131or
132 --opened | file ....
133 List the module ownership of modified or the listed files
134
2b4af749
JV
135 --tap-output
136 Show results as valid TAP output. Currently only compatible
137 with --check, --checkmani
138
0cf51544
JH
139Matching is case-ignoring regexp, author matching is both by
140the short id and by the full name and email. A "module" may
141not be just a module, it may be a file or files or a subdirectory.
142The options may be abbreviated to their unique prefixes
143__EOF__
144 exit(0);
145}
146
147my $Maintainer;
148my $Module;
149my $Files;
678b26d7 150my $Check;
bfca551d 151my $Checkmani;
d933dc9e 152my $Opened;
2b4af749
JV
153my $TestCounter = 0;
154my $TapOutput;
0cf51544
JH
155
156sub process_options {
157 usage()
158 unless
159 GetOptions(
160 'maintainer=s' => \$Maintainer,
161 'module=s' => \$Module,
162 'files' => \$Files,
678b26d7 163 'check' => \$Check,
bfca551d 164 'checkmani' => \$Checkmani,
d933dc9e 165 'opened' => \$Opened,
2b4af749 166 'tap-output' => \$TapOutput,
0cf51544
JH
167 );
168
d933dc9e 169 my @Files;
1be1464a 170
d933dc9e 171 if ($Opened) {
b7bed276 172 usage if @ARGV;
fdd40f96 173 chomp (@Files = `git ls-files -m --full-name`);
d933dc9e 174 die if $?;
29638d28
NC
175 } elsif (@ARGV == 1 &&
176 $ARGV[0] =~ /^(?:HEAD|[0-9a-f]{4,40})(?:~\d+)?\^*$/) {
177 my $command = "git diff --name-only $ARGV[0]^ $ARGV[0]";
178 chomp (@Files = `$command`);
179 die "'$command' failed: $?" if $?;
d933dc9e
NC
180 } else {
181 @Files = @ARGV;
182 }
0cf51544
JH
183
184 usage() if @Files && ($Maintainer || $Module || $Files);
185
186 for my $mean ($Maintainer, $Module) {
187 warn "$0: Did you mean '$0 $mean'?\n"
188 if $mean && -e $mean && $mean ne '.' && !$Files;
189 }
190
191 warn "$0: Did you mean '$0 -mo $Maintainer'?\n"
192 if defined $Maintainer && exists $Modules{$Maintainer};
193
194 warn "$0: Did you mean '$0 -ma $Module'?\n"
195 if defined $Module && exists $Maintainers{$Module};
196
197 return ($Maintainer, $Module, $Files, @Files);
198}
199
e1ae7bac
NC
200sub files_to_modules {
201 my @Files = @_;
202 my %ModuleByFile;
203
204 for (@Files) { s:^\./:: }
205
206 @ModuleByFile{@Files} = ();
207
208 # First try fast match.
209
210 my %ModuleByPat;
211 for my $module (keys %Modules) {
212 for my $pat (get_module_pat($module)) {
213 $ModuleByPat{$pat} = $module;
214 }
215 }
216 # Expand any globs.
217 my %ExpModuleByPat;
218 for my $pat (keys %ModuleByPat) {
219 if (-e $pat) {
220 $ExpModuleByPat{$pat} = $ModuleByPat{$pat};
221 } else {
222 for my $exp (glob($pat)) {
223 $ExpModuleByPat{$exp} = $ModuleByPat{$pat};
224 }
225 }
226 }
227 %ModuleByPat = %ExpModuleByPat;
228 for my $file (@Files) {
229 $ModuleByFile{$file} = $ModuleByPat{$file}
230 if exists $ModuleByPat{$file};
231 }
232
233 # If still unresolved files...
234 if (my @ToDo = grep { !defined $ModuleByFile{$_} } keys %ModuleByFile) {
235
236 # Cannot match what isn't there.
237 @ToDo = grep { -e $_ } @ToDo;
238
239 if (@ToDo) {
240 # Try prefix matching.
241
8cf77941
NC
242 # Need to try longst prefixes first, else lib/CPAN may match
243 # lib/CPANPLUS/... and similar
244
245 my @OrderedModuleByPat
246 = sort {length $b <=> length $a} keys %ModuleByPat;
247
e1ae7bac
NC
248 # Remove trailing slashes.
249 for (@ToDo) { s|/$|| }
250
251 my %ToDo;
252 @ToDo{@ToDo} = ();
253
8cf77941 254 for my $pat (@OrderedModuleByPat) {
e1ae7bac
NC
255 last unless keys %ToDo;
256 if (-d $pat) {
257 my @Done;
258 for my $file (keys %ToDo) {
259 if ($file =~ m|^$pat|i) {
260 $ModuleByFile{$file} = $ModuleByPat{$pat};
261 push @Done, $file;
262 }
263 }
264 delete @ToDo{@Done};
265 }
266 }
267 }
268 }
269 \%ModuleByFile;
270}
0cf51544
JH
271sub show_results {
272 my ($Maintainer, $Module, $Files, @Files) = @_;
273
274 if ($Maintainer) {
275 for my $m (sort keys %Maintainers) {
276 if ($m =~ /$Maintainer/io || $Maintainers{$m} =~ /$Maintainer/io) {
277 my @modules = get_maintainer_modules($m);
278 if ($Module) {
279 @modules = grep { /$Module/io } @modules;
280 }
281 if ($Files) {
282 my @files;
283 for my $module (@modules) {
284 push @files, get_module_files($module);
285 }
286 printf "%-15s @files\n", $m;
287 } else {
288 if ($Module) {
289 printf "%-15s @modules\n", $m;
290 } else {
291 printf "%-15s $Maintainers{$m}\n", $m;
292 }
293 }
294 }
295 }
296 } elsif ($Module) {
297 for my $m (sort { lc $a cmp lc $b } keys %Modules) {
298 if ($m =~ /$Module/io) {
299 if ($Files) {
300 my @files = get_module_files($m);
301 printf "%-15s @files\n", $m;
302 } else {
adc42316 303 printf "%-15s %-12s %s\n", $m, $Modules{$m}{MAINTAINER}, $Modules{$m}{UPSTREAM}||'unknown';
0cf51544
JH
304 }
305 }
306 }
bfca551d 307 } elsif ($Check or $Checkmani) {
3428fdd5 308 if( @Files ) {
2b4af749
JV
309 missing_maintainers(
310 $Checkmani
311 ? sub { -f $_ and exists $MANIFEST{$File::Find::name} }
312 : sub { /\.(?:[chty]|p[lm]|xs)\z/msx },
313 @Files
314 );
315 } else {
316 duplicated_maintainers();
317 }
0cf51544 318 } elsif (@Files) {
e1ae7bac 319 my $ModuleByFile = files_to_modules(@Files);
0cf51544 320 for my $file (@Files) {
e1ae7bac
NC
321 if (defined $ModuleByFile->{$file}) {
322 my $module = $ModuleByFile->{$file};
323 my $maintainer = $Modules{$ModuleByFile->{$file}}{MAINTAINER};
c5654d5b
NC
324 my $upstream = $Modules{$module}{UPSTREAM}||'unknown';
325 printf "%-15s [%-7s] $module $maintainer $Maintainers{$maintainer}\n", $file, $upstream;
0cf51544
JH
326 } else {
327 printf "%-15s ?\n", $file;
328 }
329 }
330 }
fdd40f96 331 elsif ($Opened) {
f340d83a 332 print STDERR "(No files are modified)\n";
fdd40f96 333 }
0cf51544
JH
334 else {
335 usage();
336 }
337}
338
3428fdd5
RB
339my %files;
340
341sub maintainers_files {
342 %files = ();
678b26d7
RGS
343 for my $k (keys %Modules) {
344 for my $f (get_module_files($k)) {
345 ++$files{$f};
346 }
347 }
3428fdd5
RB
348}
349
350sub duplicated_maintainers {
351 maintainers_files();
678b26d7 352 for my $f (keys %files) {
2b4af749
JV
353 if ($TapOutput) {
354 if ($files{$f} > 1) {
355 print "not ok ".++$TestCounter." - File $f appears $files{$f} times in Maintainers.pl\n";
356 } else {
357 print "ok ".++$TestCounter." - File $f appears $files{$f} times in Maintainers.pl\n";
358 }
359 } else {
360 if ($files{$f} > 1) {
361 warn "File $f appears $files{$f} times in Maintainers.pl\n";
362 }
363 }
678b26d7
RGS
364 }
365}
366
357244ac
NC
367sub warn_maintainer {
368 my $name = shift;
2b4af749
JV
369 if ($TapOutput) {
370 if ($files{$name}) {
371 print "ok ".++$TestCounter." - $name has a maintainer\n";
372 } else {
373 print "not ok ".++$TestCounter." - $name has NO maintainer\n";
374
375 }
376
377 } else {
378 warn "File $name has no maintainer\n" if not $files{$name};
379 }
357244ac
NC
380}
381
3428fdd5
RB
382sub missing_maintainers {
383 my($check, @path) = @_;
384 maintainers_files();
385 my @dir;
357244ac 386 for my $d (@path) {
2b4af749 387 if( -d $d ) { push @dir, $d } else { warn_maintainer($d) }
357244ac 388 }
2b4af749
JV
389 find sub { warn_maintainer($File::Find::name) if $check->() }, @dir if @dir;
390}
391
392sub finish_tap_output {
393 print "1..".$TestCounter."\n";
3428fdd5
RB
394}
395
0cf51544
JH
3961;
397