Merge branch 'dev' of github.com:petdance/ack2 into dev

Author: petdance

.gitignore

@@ -14,3 +14,5 @@ stderr.log
 stdout.log
 .timings.json
 xt/.perlcritic-history
+completion.bash
+completion.zsh

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Before You Report an Issue...
+
+Before you report an issue, please consult the [FAQ](http://beyondgrep.com/documentation/ack-2.12-man.html#faq).
+
+# Reporting an Issue
+
+If you have an issue with ack, please add the following to your ticket:
+
+  - What OS you're on
+  - What version of ack you're using
+
+Please try to reproduce your issue against the latest ack from git.  If you are not able to
+reproduce the issue with ack built from git, you should probably file the issue anyway, as
+that probably means someone needs to make a release. =)
+
+Also appreciated with an issue are the following:
+
+  - Example invocations along with expected vs received output (see [#439](https://github.com/petdance/ack2/issues/439), great job!)
+  - A `.t` test file that tests and verifies the behavior you expect
+  - A patch that fixes your issue
+
+# Ack 1.x
+
+Keep in mind that if you're using ack 1.x, you should probably upgrade, as ack 1.x is no longer supported.
+
+# Getting Help
+
+Also, feel free to discuss your issues on the [ack mailing list](http://groups.google.com/group/ack-users)!

Changes

@@ -1,10 +1,32 @@
 History file for ack.  http://beyondgrep.com/
 
+NEXT
+====================================
+[FIXES]
+The -s flag would fail to suppress certain warnings.  Thanks, Kassio
+Borges. (GitHub ticket #439)
+
+The -w flag would fail to work properly with regex features such as
+alternation.  Thanks to Ed Avis for the report (GitHub ticket #443)
+
+The -g flag should now work faster on larger codebases.  Thanks to
+Manuel Meurer for the report (GitHub ticket #458)
+
+[ENHANCEMENTS]
+ack now ignores JavaScript and CSS source maps.  Thanks, Chris
+Rebert.
+
+ack now ships with customized shell completion scripts for bash and zsh.
+
+
 2.13_06 Sat Jan 25 23:36:09 CST 2014
 ====================================
 [FIXES]
 More fixes for Windows tests.  Thanks to GitHub user @ispedals.
 
+[ENHANCEMENTS]
+
+Add docs for available colors in ack.
 
 2.13_05 Thu Jan  9 22:41:33 CST 2014
 ====================================

ConfigDefault.pm

@@ -139,6 +139,10 @@ sub _options_block {
 --ignore-file=match:/[.]min[.]css$/
 --ignore-file=match:/[.]css[.]min$/
 
+# JS and CSS source maps
+--ignore-file=match:/[.]js[.]map$/
+--ignore-file=match:/[.]css[.]map$/
+
 # PDFs, because they pass Perl's -T detection
 --ignore-file=ext:pdf
 
@@ -162,7 +166,8 @@ sub _options_block {
 --type-add=make:ext:mak
 --type-add=make:is:makefile
 --type-add=make:is:Makefile
---type-add=make:is:GNUmakefile
+--type-add=make:is:Makefile.Debug
+--type-add=make:is:Makefile.Release
 
 # Rakefiles
 # http://rake.rubyforge.org/
@@ -330,6 +335,10 @@ sub _options_block {
 # http://www.r-project.org/
 --type-add=rr:ext:R
 
+# reStructured Text
+# http://docutils.sourceforge.net/rst.html
+--type-add=rst:ext:rst
+
 # Ruby
 # http://www.ruby-lang.org/
 --type-add=ruby:ext:rb,rhtml,rjs,rxml,erb,rake,spec

ConfigLoader.pm

@@ -217,6 +217,8 @@ EOT
     * Your new option is explained when a user invokes ack --man.
       (See the POD at the end of ./ack)
     * Add your option to t/config-loader.t
+    * Add your option to t/Util.pm#get_options
+    * Add your option's description and aliases to dev/generate-completion-scripts.pl
     * Go through the list of options already available, and consider
       whether your new option can be considered mutually exclusive
       with another option.

DESIGN.md

@@ -21,3 +21,14 @@ It seems not.  Brian M. Carlson investigated this and reported his
 findings here: https://github.com/petdance/ack2/issues/398
 
 There seemed to be no effect.
+
+## Can we make --sort be the default?
+
+No.  Sorting the filenames requires reading in the entire directory
+of filenames before searching, and this can be a performance hit.
+In fact, it can kill ack entirely on directories with absurdly large
+numbers of files in them.
+
+## Why not make ack use /usr/bin/env in the shebang instead of /usr/bin/perl?
+
+The Perl toolchain takes care of the shebang at install time.

Makefile.PL

@@ -53,7 +53,7 @@ my %parms = (
     },
     MAN3PODS            => {}, # no need for man pages for any of the .pm files
     dist                => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
-    clean               => { FILES => 'ack-2* nytprof* stderr.log stdout.log' },
+    clean               => { FILES => 'ack-2* nytprof* stderr.log stdout.log completion.*' },
 );
 
 if ( $ExtUtils::MakeMaker::VERSION =~ /^\d\.\d\d$/ and $ExtUtils::MakeMaker::VERSION > 6.30 ) {
@@ -159,6 +159,12 @@ time-head: ack-standalone
 timings: ack-standalone
 	./dev/timings.pl
 
+completion.bash: pm_to_blib
+	./dev/generate-completion-scripts.pl completion.bash
+
+completion.zsh: pm_to_blib
+	./dev/generate-completion-scripts.pl completion.zsh
+
 MAKE_FRAG
 
     return $postamble;

Resources.pm

@@ -7,6 +7,28 @@ use File::Next 1.10;
 use warnings;
 use strict;
 
+sub _generate_error_handler {
+    my $opt = shift;
+
+    if ( $opt->{dont_report_bad_filenames} ) {
+        return sub {
+            my $msg = shift;
+            # XXX restricting to specific error messages for now; I would
+            #     prefer a different way of doing this
+            if ( $msg =~ /Permission denied/ ) {
+                return;
+            }
+            App::Ack::warn( $msg );
+        };
+    }
+    else {
+        return sub {
+            my $msg = shift;
+            App::Ack::warn( $msg );
+        };
+    }
+}
+
 =head1 SYNOPSIS
 
 This is the base class for App::Ack::Resources, an iterator factory
@@ -40,7 +62,8 @@ sub from_argv {
         File::Next::files( {
             file_filter     => $opt->{file_filter},
             descend_filter  => $descend_filter,
-            error_handler   => sub { my $msg = shift; App::Ack::warn( $msg ) },
+            error_handler   => _generate_error_handler($opt),
+            warning_handler => sub {},
             sort_files      => $opt->{sort_files},
             follow_symlinks => $opt->{follow},
         }, @{$start} );
@@ -62,8 +85,8 @@ sub from_file {
 
     my $iter =
         File::Next::from_file( {
-            error_handler   => sub { my $msg = shift; App::Ack::warn( $msg ) },
-            warning_handler => sub { my $msg = shift; App::Ack::warn( $msg ) },
+            error_handler   => _generate_error_handler($opt),
+            warning_handler => _generate_error_handler($opt),
             sort_files      => $opt->{sort_files},
         }, $file ) or return undef;
 

ack

@@ -172,7 +172,19 @@ sub _compile_file_filter {
         }
     }
 
+    my $match_filenames = $opt->{g};
+    my $match_regex     = $opt->{regex};
+    my $is_inverted     = $opt->{v};
+
     return sub {
+        if ( $match_filenames ) {
+            if ( $File::Next::name =~ /$match_regex/ && $is_inverted ) {
+                return;
+            }
+            if ( $File::Next::name !~ /$match_regex/ && !$is_inverted ) {
+                return;
+            }
+        }
         # ack always selects files that are specified on the command
         # line, regardless of filetype.  If you want to ack a JPEG,
         # and say "ack foo whatever.jpg" it will do it for you.
@@ -307,8 +319,11 @@ sub build_regex {
 
     $str = quotemeta( $str ) if $opt->{Q};
     if ( $opt->{w} ) {
-        $str = "\\b$str" if $str =~ /^\w/;
-        $str = "$str\\b" if $str =~ /\w$/;
+        my $pristine_str = $str;
+
+        $str = "(?:$str)";
+        $str = "\\b$str" if $pristine_str =~ /^\w/;
+        $str = "$str\\b" if $pristine_str =~ /\w$/;
     }
 
     my $regex_is_lc = $str eq lc $str;
@@ -803,14 +818,24 @@ sub resource_has_match {
         }
     }
     else {
-        my $opt_v = $opt->{v};
-        my $re    = $opt->{regex};
-        while ( <$fh> ) {
-            if (/$re/o xor $opt_v) {
-                $has_match = 1;
-                last;
+        my $re = $opt->{regex};
+        if ( $opt->{v} ) {
+            while ( <$fh> ) {
+                if (!/$re/o) {
+                    $has_match = 1;
+                    last;
+                }
             }
         }
+        else {
+            # XXX read in chunks
+            # XXX only do this for certain file sizes?
+            my $content = do {
+                local $/;
+                <$fh>;
+            };
+            $has_match = $content =~ /$re/og;
+        }
         close $fh;
     }
 
@@ -828,10 +853,18 @@ sub count_matches_in_resource {
         }
     }
     else {
-        my $opt_v = $opt->{v};
-        my $re    = $opt->{regex};
-        while ( <$fh> ) {
-            ++$nmatches if (/$re/o xor $opt_v);
+        my $re = $opt->{regex};
+        if ( $opt->{v} ) {
+            while ( <$fh> ) {
+                ++$nmatches if (!/$re/o);
+            }
+        }
+        else {
+            my $content = do {
+                local $/;
+                <$fh>;
+            };
+            $nmatches =()= ($content =~ /$re/og);
         }
         close $fh;
     }
@@ -942,19 +975,16 @@ RESOURCES:
             last RESOURCES if defined($max_count) && $nmatches >= $max_count;
         }
         elsif ( $opt->{g} ) {
-            my $is_match = ( $resource->name =~ /$opt->{regex}/o );
-            if ( $opt->{v} ? !$is_match : $is_match ) {
-                if ( $opt->{show_types} ) {
-                    show_types( $resource, $ors );
-                }
-                else {
-                    local $opt->{show_filename} = 0; # XXX Why is this local?
+            if ( $opt->{show_types} ) {
+                show_types( $resource, $ors );
+            }
+            else {
+                local $opt->{show_filename} = 0; # XXX Why is this local?
 
-                    print_line_with_options($opt, '', $resource->name, 0, $ors);
-                }
-                ++$nmatches;
-                last RESOURCES if defined($max_count) && $nmatches >= $max_count;
+                print_line_with_options($opt, '', $resource->name, 0, $ors);
             }
+            ++$nmatches;
+            last RESOURCES if defined($max_count) && $nmatches >= $max_count;
         }
         elsif ( $opt->{lines} ) {
             my $print_filename = $opt->{show_filename};
@@ -1670,6 +1700,27 @@ If you are not on Windows, you never need to use C<ACK_PAGER_COLOR>.
 
 =back
 
+=head1 AVAILABLE COLORS
+
+F<ack> uses the colors available in Perl's L<Term::ANSIColor> module, which
+provides the following listed values. Note that case does not matter when using
+these values.
+
+=head2 Foreground colors
+
+    black  red  green  yellow  blue  magenta  cyan  white
+
+    bright_black  bright_red      bright_green  bright_yellow
+    bright_blue   bright_magenta  bright_cyan   bright_white
+
+=head2 Background colors
+
+    on_black  on_red      on_green  on_yellow
+    on_blue   on_magenta  on_cyan   on_white
+
+    on_bright_black  on_bright_red      on_bright_green  on_bright_yellow
+    on_bright_blue   on_bright_magenta  on_bright_cyan   on_bright_white
+
 =head1 ACK & OTHER TOOLS
 
 =head2 Vim integration
@@ -2183,6 +2234,9 @@ L<https://github.com/petdance/ack2>
 How appropriate to have I<ack>nowledgements!
 
 Thanks to everyone who has contributed to ack in any way, including
+Stephen Thirlwall,
+Jonah Bishop,
+Chris Rebert,
 Denis Howe,
 RaE<uacute>l GundE<iacute>n,
 James McCoy,