Merge pull request #814 from metacpan/haarg/interesting-file-locations

 improve choices for interesting files

Author: oalders

lib/MetaCPAN/Model/Release.pm

@@ -267,27 +267,54 @@ sub set_main_module {
 
 }
 
-sub get_changes_file {
-    my $self          = shift;
-    my @files         = @{ $_[0] };
-    my @changes_files = qw(
-        Changelog
-        ChangeLog
-        CHANGELOG
-        Changes
-        CHANGES
-        NEWS
+my @changes_files = qw(
+    CHANGELOG
+    ChangeLog
+    Changelog
+    CHANGES
+    Changes
+    NEWS
+);
+my @exclude_dirs = qw(
+    corpus
+    fatlib
+    inc
+    local
+    perl5
+    share
+    t
+    xt
+);
+
+# this should match the same set of files as MetaCPAN::Query::File->interesting_files
+my ($changes_match) = map qr/^(?:$_)$/, join '|',
+    ( map quotemeta, @changes_files ),
+    (
+          "(?:(?!"
+        . join( '|', map "$_/", @exclude_dirs )
+        . ").*/)?(?:"
+        . join(
+        '|', map quotemeta, map +( "$_.pm", "$_.pod" ), @changes_files
+        )
+        . ')'
     );
 
+sub get_changes_file {
+    my $self  = shift;
+    my @files = @{ $_[0] };
     if ( $files[0]->distribution eq 'perl' ) {
         foreach my $file (@files) {
             if ( $file->name eq 'perldelta.pod' ) {
                 return $file->path;
             }
         }
     }
+
+    # prioritize files in the top level but otherwise alphabetical
+    @files = sort { $a->level <=> $b->level || $a->path cmp $b->path } @files;
+
     foreach my $file (@files) {
-        return $file->path if grep { $_ eq $file->path } @changes_files;
+        return $file->path if $file->path =~ $changes_match;
     }
 }
 

lib/MetaCPAN/Query/File.pm

@@ -55,49 +55,61 @@ sub interesting_files {
                     { term => { release   => $release } },
                     { term => { author    => $author } },
                     { term => { directory => \0 } },
-                    { not  => { prefix    => { 'path' => 'xt/' } } },
+                    { not  => { prefix    => { 'path' => 'corpus/' } } },
+                    { not  => { prefix    => { 'path' => 'fatlib/' } } },
+                    { not  => { prefix    => { 'path' => 'inc/' } } },
+                    { not  => { prefix    => { 'path' => 'local/' } } },
+                    { not  => { prefix    => { 'path' => 'perl5/' } } },
+                    { not  => { prefix    => { 'path' => 'share/' } } },
                     { not  => { prefix    => { 'path' => 't/' } } },
+                    { not  => { prefix    => { 'path' => 'xt/' } } },
                     {
                         bool => {
                             should => [
                                 {
                                     bool => {
                                         must => [
+                                            { term => { level => 0 } },
                                             {
                                                 terms => {
                                                     name => [
                                                         qw(
+                                                            alienfile
                                                             AUTHORS
                                                             Build.PL
                                                             CHANGELOG
+                                                            ChangeLog
+                                                            Changelog
                                                             CHANGES
+                                                            Changes
                                                             CONTRIBUTING
                                                             CONTRIBUTING.md
-                                                            CONTRIBUTING.pod
-                                                            Contributing.pm
-                                                            Contributing.pod
+                                                            Contributing
                                                             COPYING
+                                                            Copying
                                                             COPYRIGHT
+                                                            cpanfile
                                                             CREDITS
-                                                            ChangeLog
-                                                            Changelog
-                                                            Changes
-                                                            Copying
+                                                            DEVELOPMENT
+                                                            DEVELOPMENT.md
+                                                            Development
+                                                            Development.md
+                                                            dist.ini
                                                             FAQ
+                                                            FAQ.md
                                                             HACKING
                                                             HACKING.md
-                                                            HACKING.pod
-                                                            Hacking.pm
-                                                            Hacking.pod
                                                             Hacking
+                                                            Hacking.md
                                                             INSTALL
                                                             INSTALL.md
                                                             LICENCE
                                                             LICENSE
                                                             MANIFEST
+                                                            Makefile.PL
                                                             META.json
                                                             META.yml
-                                                            Makefile.PL
+                                                            minil.toml
                                                             NEWS
                                                             README
                                                             README.markdown
@@ -106,12 +118,47 @@ sub interesting_files {
                                                             README.mkdn
                                                             THANKS
                                                             TODO
+                                                            TODO.md
                                                             ToDo
+                                                            ToDo.md
                                                             Todo
-                                                            cpanfile
-                                                            alienfile
-                                                            dist.ini
-                                                            minil.toml
+                                                            Todo.md
+                                                            )
+                                                    ]
+                                                }
+                                            }
+                                        ]
+                                    }
+                                },
+                                {
+                                    bool => {
+                                        must => [
+                                            {
+                                                terms => {
+                                                    name => [
+                                                        qw(
+                                                            CONTRIBUTING.pm
+                                                            CONTRIBUTING.pod
+                                                            Contributing.pm
+                                                            Contributing.pod
+                                                            ChangeLog.pm
+                                                            ChangeLog.pod
+                                                            Changelog.pm
+                                                            Changelog.pod
+                                                            CHANGES.pm
+                                                            CHANGES.pod
+                                                            Changes.pm
+                                                            Changes.pod
+                                                            HACKING.pm
+                                                            HACKING.pod
+                                                            Hacking.pm
+                                                            Hacking.pod
+                                                            TODO.pm
+                                                            TODO.pod
+                                                            ToDo.pm
+                                                            ToDo.pod
+                                                            Todo.pm
+                                                            Todo.pod
                                                             )
                                                     ]
                                                 }