pre-commit 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b088bf66a3dce520c9a2e2c7b2573a5da3dc4d
-  data.tar.gz: b2712aafb68d68ae5226e1a79800e705b8ec1947
+  metadata.gz: 0b7eca26aaae49efaf8967fb7a02d01521f272cc
+  data.tar.gz: 7e36f001ca2d85847d5038b757f442ffbb411a4e
 SHA512:
-  metadata.gz: ed5b63347c42c6cd96782865d9513f2f63a3bb7ec5e924c27ef403667981b3e5d51ef6d557e719a7542ef0e36073de715aeeee83ea172105565e9df2755280ed
-  data.tar.gz: c90634c849ddc7fd8e294fa408b3474c0c23e7f85a35bb6492e14311c289dac127ecca75b1b07bcc8ecfece8feefc61bf16d250be52298de32fd6ad53fe9b749
+  metadata.gz: f21965abc93d4cec2c941d53b519aa8bcf0416334a329784e061d8791108651f289184d7e0504e54da1b57e5b93d5395992753f856fbde69f08735c7810940e9
+  data.tar.gz: df10779b7b8a0be223b55b6f70a0cd476b080bc75074b39832a3b4409da5c966aefcd55f28ff5b95e8010142525e3e6fe611ca736247f0409b966e68f3dc2e54

data/README.md

@@ -107,4 +107,14 @@ pre-commit run <file-list>  # run on the list of files, patterns not supported
 - `yaml` - reads configuration from `/etc/pre_commit.yml`, `$HOME/.pre_commit.yml` and `config/pre_commit.yml`, allows `config/pre_commit.yml` updates
 - `env` - reads configuration from environment variables
 
+## Excluding files from checks
+
+`pre-commit` uses `git` to get list of files to check, you can ignore
+the list of git files to check with:
+
+1. `.gitignore` - git supported file shared beteen all checkouts
+2. `.git/info/exclude` - git supported file only for this checkout
+3. `.pre_commit.ignore` - `pre-commit` specific list can be shared,
+    [Allowed filters](http://www.ruby-doc.org/core-2.1.3/File.html#method-c-fnmatch)
+
 ## [Contributing](CONTRIBUTING.md)

data/lib/plugins/pre_commit/checks/before_all.rb

@@ -9,15 +9,15 @@ module PreCommit
       end
 
       def extra_grep
-        " | grep -v \/\/"
+        %w{-v //}
       end
 
       def message
-        "before(:all) found:\n"
+        "before(:all) found:"
       end
 
       def pattern
-        '-e "before.*:all"'
+        "before.*:all"
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/ci.rb

@@ -7,7 +7,9 @@ module PreCommit
 
       def call(_)
         return if system("rake #{Ci::CI_TASK_NAME} --silent")
-        "your test suite has failed, for the full output run `#{CI_TASK_NAME}`"
+        PreCommit::ErrorList.new(
+          "your test suite has failed, for the full output run `#{CI_TASK_NAME}`"
+        )
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/coffeelint.rb

@@ -8,9 +8,13 @@ module PreCommit
         staged_files = staged_files.grep(/\.coffee$/)
         return if staged_files.empty?
 
-        args = (config_file_flag + staged_files).join(' ')
+        result =
+        in_groups(staged_files).map do |files|
+          args = %w{coffeelint} + config_file_flag + files
+          execute(args)
+        end.compact
 
-        execute("coffeelint #{args}")
+        result.empty? ? nil : result.join("\n")
       end
 
       def config_file_flag

data/lib/plugins/pre_commit/checks/console_log.rb

@@ -9,15 +9,15 @@ module PreCommit
       end
 
       def extra_grep
-        " | grep -v \/\/"
+        %w{-v //}
       end
 
       def message
-        "console.log found:\n"
+        "console.log found:"
       end
 
       def pattern
-        '-e "console\\.log"'
+        "console\\.log"
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/debugger.rb

@@ -9,11 +9,11 @@ module PreCommit
       end
 
       def message
-        "debugger statement(s) found:\n"
+        "debugger statement(s) found:"
       end
 
       def pattern
-        '-e "^[ 	]*debugger"'
+        "^[ 	]*debugger"
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/gemfile_path.rb

@@ -9,15 +9,15 @@ module PreCommit
       end
 
       def message
-        "local path found in Gemfile:\n"
+        "local path found in Gemfile:"
       end
 
       def pattern
-        "'path:|:path\\s*=>'"
+        "path:|:path\\s*=>"
       end
 
       def extra_grep
-        " | grep -v '#'"
+        %w{-v #}
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/jshint.rb

@@ -4,17 +4,8 @@ module PreCommit
   module Checks
     class Jshint < Js
 
-      def js_config
-        if config_file
-          ExecJS.exec("return (#{File.read(config_file)});")
-        else
-          {}
-        end
-      end
-
       def run_check(file)
-        context = ExecJS.compile(File.read(linter_src))
-        context.call("JSHINT", File.read(file), js_config, js_config["globals"])
+        context.call("JSHINT._getErrors", File.read(file), js_config, js_config["globals"])
       end
 
       def linter_src
@@ -29,6 +20,25 @@ module PreCommit
         "Checks javascript files with JSHint."
       end
 
+      private
+
+      def context
+        @context ||= ExecJS.compile(File.read(linter_src) << <<-JAVASCRIPT)
+          ;JSHINT._getErrors = function(source, options, globals) {
+            JSHINT(source, options, globals);
+            return JSHINT.errors;
+          }
+        JAVASCRIPT
+      end
+
+      def js_config
+        @js_config ||= if config_file
+          ExecJS.exec("return (#{File.read(config_file)});")
+        else
+          {}
+        end
+      end
+
     end
   end
 end

data/lib/plugins/pre_commit/checks/local.rb

@@ -4,16 +4,22 @@ module PreCommit
   module Checks
     class Local < Plugin
 
-      DEFAULT_LOCATION = "config/pre-commit.rb"
+      attr_writer :script
 
-      def call(staged_files, script=Local::DEFAULT_LOCATION)
-        return unless File.exist?(script)
+      def call(staged_files)
+        return unless script
         output = `ruby #{script} #{staged_files.join(" ")} 2>&1`
         "#{script} failed:\n#{output}" unless $?.success?
       end
 
       def self.description
-        "Executes 'ruby #{DEFAULT_LOCATION}'."
+        "Executes a custom script located at config/pre_commit.rb"
+      end
+
+      def script
+        @script ||= ["config/pre_commit.rb", "config/pre-commit.rb"].detect do |file|
+          File.exist?(file)
+        end
       end
 
     end

data/lib/plugins/pre_commit/checks/merge_conflict.rb

@@ -5,11 +5,11 @@ module PreCommit
     class MergeConflict < Grep
 
       def message
-        "detected a merge conflict\n"
+        "detected a merge conflict"
       end
 
       def pattern
-        "'<<<<<<<'"
+        "<<<<<<<"
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/pry.rb

@@ -5,7 +5,7 @@ module PreCommit
     class Pry < Grep
 
       def message
-        "binding.pry found:\n"
+        "binding.pry found:"
       end
 
       def pattern

data/lib/plugins/pre_commit/checks/rspec_focus.rb

@@ -9,11 +9,11 @@ module PreCommit
       end
 
       def message
-        ":focus found in specs:\n"
+        ":focus found in specs:"
       end
 
       def pattern
-        "'(describe|context|it).*(:focus|focus:).*do'"
+        "(describe|context|it).*(:focus|focus:).*do"
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/rubocop.rb

@@ -21,7 +21,7 @@ module PreCommit
         staged_files = staged_files.grep(/\.rb$/)
         return if staged_files.empty?
 
-        args = config_file_flag + ["--force-exclusion"] + staged_files
+        args = config_file_flag + user_supplied_flags + ["--force-exclusion"] + staged_files
 
         success, captured = capture { ::RuboCop::CLI.new.run(args) == 0 }
         captured unless success
@@ -41,6 +41,10 @@ module PreCommit
         config_file ? ['-c', config_file] : []
       end
 
+      def user_supplied_flags
+        Array(config.get('rubocop.flags')).reject(&:empty?)
+      end
+
       def alternate_config_file
         '.rubocop.yml'
       end

data/lib/plugins/pre_commit/checks/ruby_symbol_hashrockets.rb

@@ -9,11 +9,11 @@ module PreCommit
       end
 
       def message
-        "detected :symbol => value hashrocket:\n"
+        "detected :symbol => value hashrocket:"
       end
 
       def pattern
-        '\'[^:](:{1}(?:\$|@|@@|[_A-Za-z])?\w*[=!?]?\s*=>\s*)\''
+        '[^:](:{1}(?:\$|@|@@|[_A-Za-z])?\w*[=!?]?\s*=>\s*)'
       end
 
       def self.description

data/lib/plugins/pre_commit/checks/scss_lint.rb

@@ -8,9 +8,13 @@ module PreCommit
         staged_files = staged_files.grep(/\.scss$/)
         return if staged_files.empty?
 
-        args = (config_file_flag + staged_files).join(' ')
+        result =
+        in_groups(staged_files).map do |files|
+          args = %w{scss-lint} + config_file_flag + files
+          execute(args)
+        end.compact
 
-        execute("scss-lint #{args}")
+        result.empty? ? nil : result.join("\n")
       end
 
       def config_file_flag

data/lib/plugins/pre_commit/checks/tabs.rb

@@ -5,11 +5,11 @@ module PreCommit
     class Tabs < Grep
 
       def message
-        "detected tab before initial space:\n"
+        "detected tab before initial space:"
       end
 
       def pattern
-        "'^ *\t'"
+        "^ *\t"
       end
 
       def self.description

data/lib/plugins/pre_commit/configuration/providers/yaml.rb

@@ -1,10 +1,13 @@
 require 'yaml'
+require "pre-commit/configuration/top_level"
 
 module PreCommit
   class Configuration
     class Providers
 
       class Yaml
+        include PreCommit::Configuration::TopLevel
+
         def self.priority
           20
         end
@@ -55,11 +58,6 @@ module PreCommit
           File.join(top_level, 'config', 'pre_commit.yml')
         end
 
-        def top_level
-          top_level = `git rev-parse --show-toplevel`.chomp.strip
-          raise "no git repo!" if top_level == ""
-          top_level
-        end
       end
 
     end

data/lib/pre-commit/checks/grep.rb

@@ -1,9 +1,10 @@
-require 'pre-commit/checks/plugin'
-require 'shellwords'
+require 'pre-commit/checks/shell'
+require 'pre-commit/error_list'
+require 'pre-commit/line'
 
 module PreCommit
   module Checks
-    class Grep < Plugin
+    class Grep < Shell
       class PaternNotSet < StandardError
         def message
           "Please define 'pattern' method."
@@ -17,7 +18,7 @@ module PreCommit
       end
 
       def extra_grep
-        @extra_grep or ""
+        @extra_grep or []
       end
 
       def message
@@ -31,21 +32,43 @@ module PreCommit
     # general code:
 
       def call(staged_files)
-        staged_files = files_filter(staged_files).map(&:shellescape)
+        staged_files = files_filter(staged_files)
         return if staged_files.empty?
-        errors = `#{grep} #{pattern} #{staged_files.join(" ")}#{extra_grep}`
-        return unless $?.success?
-        "#{message}#{errors}"
+
+        result =
+        in_groups(staged_files).map do |files|
+          args = grep + [pattern] + files
+          args += ["|", "grep"] + extra_grep if !extra_grep.nil? and !extra_grep.empty?
+          execute(args, success_status: false)
+        end.compact
+
+        result.empty? ? nil : parse_errors(message, result)
       end
 
     private
 
+      def parse_errors(message, list)
+        result = PreCommit::ErrorList.new(message)
+        result.errors +=
+        list.map do |group|
+          group.split(/\n/)
+        end.flatten.compact.map do |line|
+          PreCommit::Line.new(nil, *parse_error(line))
+        end
+        result
+      end
+
+      def parse_error(line)
+        matches = /^([^:]+):([[:digit:]]+):(.*)$/.match(line)
+        matches and matches.captures
+      end
+
       def grep(grep_version = nil)
         grep_version ||= detect_grep_version
         if grep_version =~ /FreeBSD/
-          "grep -EnIH"
+          %w{grep -EnIH}
         else
-          "grep -PnIH"
+          %w{grep -PnIH}
         end
       end
 

data/lib/pre-commit/checks/plugin.rb

@@ -1,5 +1,6 @@
 require 'plugins/pluginator/extensions/conversions'
 require 'pre-commit/checks/plugin/config_file'
+require 'pre-commit/line'
 
 module PreCommit
   module Checks
@@ -28,6 +29,17 @@ module PreCommit
       def alternate_config_file
         ''
       end
+
+      # group files in packs smaller then 127kB (1000 files)
+      # 127k based on http://www.in-ulm.de/~mascheck/various/argmax/
+      # and 262144 limit on OSX - my env size /2 to be safe
+      # assuming mean file length shorter then 127 chars splitting to
+      # groups of 1000 files, each_slice for simplicity, doing real
+      # check could be to time consuming
+      def in_groups(files, group_size = 1000)
+        files.each_slice(group_size)
+      end
+
     end
   end
 end

data/lib/pre-commit/checks/shell.rb

@@ -1,5 +1,5 @@
 require 'pre-commit/checks/plugin'
-require 'open3'
+require 'shellwords'
 
 module PreCommit
   module Checks
@@ -7,9 +7,22 @@ module PreCommit
 
     private
 
-      def execute(command)
-        _, stdout, stderr, process = Open3.popen3(command)
-        stdout.read + stderr.read unless process.value.success?
+      def execute(*args)
+        options = args.last.is_a?(::Hash) ? args.pop : {}
+        args = build_command(*args)
+        execute_raw(args, options)
+      end
+
+      def build_command(*args)
+        args.flatten.map do |arg|
+          arg = arg.shellescape if arg != '|' && arg != '&&' && arg != '||'
+          arg
+        end.join(" ")
+      end
+
+      def execute_raw(command, options = {})
+        result = `#{command} 2>&1`
+        $?.success? == (options.fetch(:success_status, true)) ? nil : result
       end
     end
   end