overcommit 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea70d2648519c5c2f90bfa96c690a45414c1df2a
-  data.tar.gz: 65e1c6ccda24f2eb76fa6982439112964414dd4e
+  metadata.gz: be12e52142407d34b856e8cf7c3b9e1743f9318b
+  data.tar.gz: cbbf986c4d3e2a45d26b281e9716de2ef15cd2c2
 SHA512:
-  metadata.gz: bae413ee48cbf60e6de660988fbdc8dc2c3a8044249d7089618500a033629df0b0fb6d22a8465732d774c043c2a8fd0abba3d0f30c618041f99b8292885303af
-  data.tar.gz: 26f3e6ffb0999a3f25573a53b48b8e2f236ba880423598845c43e0609e0c8aeec9c9236d7caee8f659e01b886f38461931e99781d20920e0690119cbddfc9ae4
+  metadata.gz: 9ccfb37216d910e8c14b7d935c42a74b2ab372016bfe2b3e8eee4f63195028db62d34dbedec808d9b704d49f75991951eeabcdc3a857bbddccd8ebd55c4f00ee
+  data.tar.gz: 2fe6b8c2563e6f709e7d844f4055386fd8a60f4239e82dedf9792b8efeb59d46ecf761c4f2c28998d1628cab1452c35cb125226090c29e35359776ebf83bbfe0

data/config/default.yml

@@ -52,6 +52,7 @@ PreCommit:
   BerksfileCheck:
     description: 'Checking Berksfile lock'
     required_executable: 'berks'
+    flags: ['list', '--quiet']
     install_command: 'gem install berks'
     include:
       - 'Berksfile'
@@ -61,6 +62,7 @@ PreCommit:
     enabled: false
     description: 'Checking for security vulnerabilities'
     required_executable: 'brakeman'
+    flags: ['--exit-on-warn', '--quiet', '--summary', '--only-files']
     install_command: 'gem install brakeman'
     include:
       - '**/*.rb'
@@ -72,6 +74,7 @@ PreCommit:
   BundleCheck:
     description: 'Checking Gemfile dependencies'
     required_executable: 'bundle'
+    flags: ['check']
     install_command: 'gem install bundler'
     include:
       - 'Gemfile'
@@ -82,6 +85,7 @@ PreCommit:
     enabled: false
     description: 'Checking that settings have been secured with Chamber'
     required_executable: 'chamber'
+    flags: ['secure', '--files']
     install_command: 'gem install chamber'
     include:
       - 'config/settings.yml'
@@ -90,12 +94,14 @@ PreCommit:
   CoffeeLint:
     description: 'Analyzing with coffeelint'
     required_executable: 'coffeelint'
+    flags: ['--quiet']
     install_command: 'npm install -g coffeelint'
     include: '**/*.coffee'
 
   CssLint:
     description: 'Analyzing with csslint'
     required_executable: 'csslint'
+    flags: ['--quiet', '--format=compact']
     install_command: 'npm install -g csslint'
     include: '**/*.css'
 
@@ -114,6 +120,8 @@ PreCommit:
   HardTabs:
     description: 'Checking for hard tabs'
     quiet: true
+    required_executable: 'grep'
+    flags: ['-IHn', "\t"]
     exclude:
       - '**/*.go'
       - '**/Makefile'
@@ -130,12 +138,14 @@ PreCommit:
   Jscs:
     description: 'Analyzing with JSCS'
     required_executable: 'jscs'
+    flags: ['--reporter=inline', '--verbose']
     install_command: 'npm install -g jscs'
     include: '**/*.js'
 
   Jsxcs:
     description: 'Analyzing with JSXCS'
     required_executable: 'jsxcs'
+    flags: ['--reporter=inline']
     install_command: 'npm install -g jsxcs'
     include: '**/*.jsx'
 
@@ -157,11 +167,15 @@ PreCommit:
 
   LocalPathsInGemfile:
     description: 'Checking for local paths in Gemfile'
+    required_executable: 'grep'
+    flags: ['-IHnE', '(\bpath:)|(:path\s*=>)']
     include: '**/Gemfile'
 
   MergeConflicts:
     description: 'Checking for merge conflicts'
     quiet: true
+    required_executable: 'grep'
+    flags: ['-IHn', '^<<<<<<<\s']
 
   PryBinding:
     description: 'Checking for instances of binding.pry'
@@ -184,8 +198,10 @@ PreCommit:
       - 'db/structure.sql'
 
   Reek:
+    enabled: false
     description: 'Analyzing with Reek'
     required_executable: 'reek'
+    flags: ['--single-line', '--no-color']
     install_command: 'gem install reek'
     include:
       - '**/*.gemspec'
@@ -197,6 +213,7 @@ PreCommit:
   Rubocop:
     description: 'Analyzing with Rubocop'
     required_executable: 'rubocop'
+    flags: ['--format=emacs', '--force-exclusion']
     install_command: 'gem install rubocop'
     include:
       - '**/*.gemspec'
@@ -214,16 +231,20 @@ PreCommit:
   ShellCheck:
     description: 'Analyzing with ShellCheck'
     required_executable: 'shellcheck'
+    flags: ['--format=gcc']
     include: '**/*.sh'
 
   TrailingWhitespace:
     description: 'Checking for trailing whitespace'
+    required_executable: 'grep'
+    flags: ['-IHn', '\s$']
     exclude:
       - '**/db/structure.sql'
 
   TravisLint:
     description: 'Checking Travis CI configuration'
     required_executable: 'travis'
+    flags: ['lint']
     install_command: 'gem install travis'
     include: '.travis.yml'
 

data/lib/overcommit/hook/base.rb

@@ -14,7 +14,7 @@ module Overcommit::Hook
   MESSAGE_TYPES = [:error, :warning]
 
   # Functionality common to all hooks.
-  class Base
+  class Base # rubocop:disable Metrics/ClassLength
     extend Forwardable
 
     def_delegators :@context, :modified_files
@@ -111,10 +111,42 @@ module Overcommit::Hook
       Overcommit::Utils.execute(cmd)
     end
 
-    def executable
+    def required_executable
       @config['required_executable']
     end
 
+    # Return command to execute for this hook.
+    #
+    # This is intended to be configurable so hooks can prefix their commands
+    # with `bundle exec` or similar. It will appends the command line flags
+    # specified by the `flags` option after.
+    #
+    # Note that any files intended to be passed must be handled by the hook
+    # itself.
+    #
+    # @return [Array<String>]
+    def command
+      Array(@config['command'] || required_executable) + flags
+    end
+
+    # Return command line flags to be passed to the command.
+    #
+    # This excludes the list of files, as that must be handled by the hook
+    # itself.
+    #
+    # The intention here is to provide flexibility for when a tool
+    # removes/renames its flags. Rather than wait for Overcommit to update the
+    # flags it uses, you can update your configuration to use the new flags
+    # right away without being blocked.
+    #
+    # Also note that any flags containing dynamic content must be passed in the
+    # hook's {#run} method.
+    #
+    # @return [Array<String>]
+    def flags
+      Array(@config['flags'])
+    end
+
     # Gets a list of staged files that apply to this hook based on its
     # configured `include` and `exclude` lists.
     def applicable_files
@@ -146,9 +178,9 @@ module Overcommit::Hook
     # If the hook defines a required executable, check if it's in the path and
     # display the install command if one exists.
     def check_for_executable
-      return unless executable && !in_path?(executable)
+      return unless required_executable && !in_path?(required_executable)
 
-      output = "'#{executable}' is not installed (or is not in your PATH)"
+      output = "'#{required_executable}' is not installed (or is not in your PATH)"
 
       if install_command = @config['install_command']
         output += "\nInstall it by running: #{install_command}"

data/lib/overcommit/hook/pre_commit/berksfile_check.rb

@@ -9,7 +9,7 @@ module Overcommit::Hook::PreCommit
       ignored_files = execute(%w[git ls-files -o -i --exclude-standard]).stdout.split("\n")
       return :pass if ignored_files.include?(LOCK_FILE)
 
-      result = execute(%W[#{executable} list --quiet])
+      result = execute(command)
       unless result.success?
         return :fail, result.stderr
       end

data/lib/overcommit/hook/pre_commit/brakeman.rb

@@ -2,8 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `brakeman` against any modified Ruby/Rails files.
   class Brakeman < Base
     def run
-      result = execute(%W[#{executable} --exit-on-warn --quiet --summary --only-files] <<
-                       applicable_files.join(','))
+      result = execute(command + [applicable_files.join(',')])
       return :pass if result.success?
 
       [:fail, result.stdout]

data/lib/overcommit/hook/pre_commit/bundle_check.rb

@@ -9,14 +9,14 @@ module Overcommit::Hook::PreCommit
       ignored_files = execute(%w[git ls-files -o -i --exclude-standard]).stdout.split("\n")
       return :pass if ignored_files.include?(LOCK_FILE)
 
-      result = execute(%W[#{executable} check])
+      result = execute(command)
       unless result.success?
         return :fail, result.stdout
       end
 
       result = execute(%w[git diff --quiet --] + [LOCK_FILE])
       unless result.success?
-        return :fail, "#{LOCK_FILE} is not up-to-date -- run `#{executable} check`"
+        return :fail, "#{LOCK_FILE} is not up-to-date -- run `#{command.join(' ')} check`"
       end
 
       :pass

data/lib/overcommit/hook/pre_commit/chamber_security.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `chamber secure` against any modified Chamber settings files
   class ChamberSecurity < Base
     def run
-      result = execute(%W[#{executable} secure --files] + applicable_files)
+      result = execute(command + applicable_files)
 
       return :pass if result.stdout.empty?
       [:fail, "These settings appear to need to be secured but were not: #{result.stdout}"]

data/lib/overcommit/hook/pre_commit/coffee_lint.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `coffeelint` against any modified CoffeeScript files.
   class CoffeeLint < Base
     def run
-      result = execute(%W[#{executable} --quiet] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       [:fail, result.stdout]

data/lib/overcommit/hook/pre_commit/css_lint.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `csslint` against any modified CSS files.
   class CssLint < Base
     def run
-      result = execute(%W[#{executable} --quiet --format=compact] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.stdout !~ /Error - (?!Unknown @ rule)/
 
       [:fail, result.stdout]

data/lib/overcommit/hook/pre_commit/go_lint.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `golint` against any modified Golang files.
   class GoLint < Base
     def run
-      result = execute([executable] + applicable_files)
+      result = execute(command + applicable_files)
       # Unfortunately the exit code is always 0
       return :pass if result.stdout.empty?
 

data/lib/overcommit/hook/pre_commit/haml_lint.rb

@@ -6,7 +6,7 @@ module Overcommit::Hook::PreCommit
     end
 
     def run
-      result = execute([executable] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       extract_messages(

data/lib/overcommit/hook/pre_commit/hard_tabs.rb

@@ -3,7 +3,7 @@ module Overcommit::Hook::PreCommit
   class HardTabs < Base
     def run
       # Catches hard tabs
-      result = execute(%w[grep -IHn] + ["\t"] + applicable_files)
+      result = execute(command + applicable_files)
       unless result.stdout.empty?
         return :fail, "Hard tabs detected:\n#{result.stdout}"
       end

data/lib/overcommit/hook/pre_commit/js_hint.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `jshint` against any modified JavaScript files.
   class JsHint < Base
     def run
-      result = execute([executable] + applicable_files)
+      result = execute(command + applicable_files)
       output = result.stdout
 
       return :pass if output.empty?

data/lib/overcommit/hook/pre_commit/jscs.rb

@@ -3,7 +3,7 @@ module Overcommit::Hook::PreCommit
   # files.
   class Jscs < Base
     def run
-      result = execute(%W[#{executable} --reporter=inline --verbose] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       if result.status == 1

data/lib/overcommit/hook/pre_commit/jsx_hint.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `jsxhint` against any modified JSX files.
   class JsxHint < Base
     def run
-      result = execute([executable] + applicable_files)
+      result = execute(command + applicable_files)
       output = result.stdout
 
       return :pass if output.empty?

data/lib/overcommit/hook/pre_commit/jsxcs.rb

@@ -3,7 +3,7 @@ module Overcommit::Hook::PreCommit
   # against any modified JavaScript files.
   class Jsxcs < Base
     def run
-      result = execute(%W[#{executable} --reporter=inline] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       if result.status == 1

data/lib/overcommit/hook/pre_commit/local_paths_in_gemfile.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Checks for local paths in files and issues a warning
   class LocalPathsInGemfile < Base
     def run
-      result = execute(%w[grep -IHnE (\s*path:\s*)|(\s*:path\s*=>)] + applicable_files)
+      result = execute(command + applicable_files)
 
       unless result.stdout.empty?
         return :warn, "Avoid pointing to local paths in Gemfiles:\n#{result.stdout}"

data/lib/overcommit/hook/pre_commit/merge_conflicts.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Checks for unresolved merge conflicts
   class MergeConflicts < Base
     def run
-      result = execute(%w[grep -IHn ^<<<<<<<\s] + applicable_files)
+      result = execute(command + applicable_files)
 
       unless result.stdout.empty?
         return :fail, "Merge conflict markers detected:\n#{result.stdout}"

data/lib/overcommit/hook/pre_commit/python_flake8.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `flake8` against any modified Python files.
   class PythonFlake8 < Base
     def run
-      result = execute([executable] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       [:fail, result.stdout]

data/lib/overcommit/hook/pre_commit/reek.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `reek` against any modified Ruby files.
   class Reek < Base
     def run
-      result = execute(%W[#{executable} --single-line --no-color] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       output = scrub_output(result.stdout + result.stderr)

data/lib/overcommit/hook/pre_commit/rubocop.rb

@@ -6,7 +6,7 @@ module Overcommit::Hook::PreCommit
     end
 
     def run
-      result = execute(%W[#{executable} --format=emacs --force-exclusion] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       extract_messages(

data/lib/overcommit/hook/pre_commit/scss_lint.rb

@@ -6,7 +6,7 @@ module Overcommit::Hook::PreCommit
     end
 
     def run
-      result = execute([executable] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       extract_messages(

data/lib/overcommit/hook/pre_commit/shell_check.rb

@@ -6,7 +6,7 @@ module Overcommit::Hook::PreCommit
     end
 
     def run
-      result = execute(%W[#{executable} --format=gcc] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       extract_messages(

data/lib/overcommit/hook/pre_commit/trailing_whitespace.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Checks for trailing whitespace in files.
   class TrailingWhitespace < Base
     def run
-      result = execute(%w[grep -IHn \s$] + applicable_files)
+      result = execute(command + applicable_files)
       unless result.stdout.empty?
         return :fail, "Trailing whitespace detected:\n#{result.stdout}"
       end

data/lib/overcommit/hook/pre_commit/travis_lint.rb

@@ -2,7 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `travis-lint` against any modified Travis CI files.
   class TravisLint < Base
     def run
-      result = execute([executable, 'lint'] + applicable_files)
+      result = execute(command + applicable_files)
       return :pass if result.success?
 
       [:fail, (result.stdout + result.stderr).strip]

data/lib/overcommit/utils.rb

@@ -83,10 +83,16 @@ module Overcommit
         end
       end
 
-      # Returns whether a command can be found given the current environment path.
+      # @param cmd [String]
+      # @return [true,false] whether a command can be found given the current
+      #   environment path.
       def in_path?(cmd)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        # ENV['PATH'] doesn't include the repo root, but that is a valid
+        # location for executables, so we want to add it to the list of places
+        # we are checking for the executable.
+        paths = [repo_root] + ENV['PATH'].split(File::PATH_SEPARATOR)
+        exts  = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        paths.each do |path|
           exts.each do |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return true if File.executable?(exe)

data/lib/overcommit/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.21.0'
+  VERSION = '0.22.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -179,4 +179,3 @@ signing_key:
 specification_version: 4
 summary: Git hook manager
 test_files: []
-has_rdoc: