new metric: no_dot_underscore_files (tweaked version of RT#40898, as other ._ files are also problematic, especially for Module::Pluggable and others)

https://rt.cpan.org/Ticket/Display.html?id=40898

Author: charsbar

Changes

@@ -8,6 +8,10 @@ Changes - Revision history for Module-CPANTS-Analyse
 
 =over
 
+=item add metric C<no_dot_underscore_files>
+(L<daxim|https://metacpan.org/author/daxim>,
+L<charsbar|https://metacpan.org/author/ishigaki>)
+
 =item remove metrics C<distributed_by_debian>,
 C<latest_version_distributed_by_debian>, C<has_no_bugs_reported_in_debian>,
 C<has_no_patches_in_debian>, C<no_cpants_errors>, C<uses_test_nowarnings>,

lib/Module/CPANTS/Kwalitee/Files.pm

@@ -34,6 +34,7 @@ sub analyse {
     my $size = 0;
     my %files;
     my %licenses;
+    my @dot_underscore_files;
     foreach my $name (@files) { 
         my $path = catfile($distdir, $name);
         $files{$name}{size} += -s $path || 0;
@@ -56,6 +57,10 @@ sub analyse {
         if ($name =~ /[\*\?"<>\|:[:^ascii:]]/) {
             push @{$me->d->{non_portable_filenames} ||= []}, $name;
         }
+
+        if ($name =~ m!(^|/)\._!) {
+            push @dot_underscore_files, $name;
+        }
     }
 
     if (%licenses) {
@@ -90,6 +95,7 @@ sub analyse {
     $me->d->{dirs_array}=\@dirs;
     $me->d->{symlinks}=scalar @symlinks;
     $me->d->{symlinks_list}=join(';',@symlinks);
+    $me->d->{error}{no_dot_underscore_files} = \@dot_underscore_files if @dot_underscore_files;
 
     # find special files
     my %reqfiles;
@@ -324,6 +330,16 @@ sub kwalitee_indicators {
             return 1;
         },
     },
+    {
+        name=>'no_dot_underscore_files',
+        error=>qq{This distribution has dot underscore files which may cause various problems.},
+        remedy=>q{If you use Mac OS X, set COPYFILE_DISABLE (for OS 10.5 and better) or COPY_EXTENDED_ATTRIBUTES_DISABLE (for OS 10.4) environmental variable to true to exclude dot underscore files from a distribution.},
+        code=>sub {
+            my $d=shift;
+            return 0 if $d->{error}{no_dot_underscore_files};
+            return 1;
+        },
+    },
 ];
 }
 
@@ -406,6 +422,8 @@ Returns the Kwalitee Indicators datastructure.
 
 =item * non_portable_filenames
 
+=item * no_dot_underscore_files
+
 =back
 
 =head1 SEE ALSO

t/02_kwalitee.t

@@ -7,8 +7,8 @@ use Test::NoWarnings;
 use Module::CPANTS::Kwalitee;
 
 my $CORE = 26;
-my $OPTIONAL = 10; #is_extra set
-my $EXTRA = 15; #experimental?
+my $OPTIONAL = 8; #is_extra set
+my $EXTRA = 10; #experimental?
 my $METRICS = $CORE + $OPTIONAL + $EXTRA;
 
 plan tests => 8 + 2 * $METRICS;