overcommit 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34fb07971b06d936af3a8a4b2cbd4584bfd96506
-  data.tar.gz: a6201349bc528c292c3173d3b4c631dd0fdf76aa
+  metadata.gz: b609412f41e430a857ae1b1b9b5a3d31cf97eb9b
+  data.tar.gz: 1f3ebdf4981de86e51503d69fdc7ed851cb91aca
 SHA512:
-  metadata.gz: 35ab2d145525645843ce83eada23ffda314dd443b792213e01dac7e19642a286c5e4fd719f14afcc25505a4fdd1a27f65ea7f1c721af0f572870dfd025d3d970
-  data.tar.gz: 7074b3298a4276c38096f5f6020bf669148cf46591c4be95b67ecfe3af12caddfb09d4c380eab8d3372fae16bc0c8d12f85269beaca362c2725445b2f9252f31
+  metadata.gz: 46b3a66583a3522bbec747ba4a0a579839b5fe09ea77ac62b57149b52e7413b05388fbd1db399d953d2503ff590331f6d8bf789191f45983027aea6dd11bcbb2
+  data.tar.gz: 072a5ce0c265bc2da606332369a5e2ea53e77f4f4aec07b3f94f056fb2e8644358737192ff6c495a4e5fda27fd5fa9b3e5625ad58f916a562056195895e88d26

data/bin/overcommit

@@ -5,6 +5,4 @@ require 'overcommit/cli'
 
 logger = Overcommit::Logger.new(STDOUT)
 
-Overcommit::CLI.new(ARGV, logger).tap do |cli|
-  cli.run
-end
+Overcommit::CLI.new(ARGV, logger).run

data/config/default.yml

@@ -22,8 +22,8 @@ PostCheckout:
     required: false
     quiet: false
   IndexTags:
-    description: 'Generating tags file from source'
     enabled: false
+    description: 'Generating tags file from source'
 
 # Hooks that are run after `git commit` is executed, before the commit message
 # editor is displayed. These hooks are ideal for syntax checkers, linters, and
@@ -50,6 +50,8 @@ PreCommit:
 
   BerksfileCheck:
     description: 'Checking Berksfile lock'
+    required_executable: 'berks'
+    install_command: 'gem install berks'
     include:
       - 'Berksfile'
       - 'Berksfile.lock'
@@ -57,11 +59,19 @@ PreCommit:
   Brakeman:
     enabled: false
     description: 'Checking for security vulnerabilities'
+    required_executable: 'brakeman'
+    install_command: 'gem install brakeman'
     include:
       - '**/*.rb'
 
+  BrokenSymlinks:
+    description: 'Checking for broken symlinks'
+    quiet: true
+
   BundleCheck:
     description: 'Checking Gemfile dependencies'
+    required_executable: 'bundle'
+    install_command: 'gem install bundler'
     include:
       - 'Gemfile'
       - 'Gemfile.lock'
@@ -70,22 +80,34 @@ PreCommit:
   ChamberSecurity:
     enabled: false
     description: 'Checking that settings have been secured with Chamber'
-    include: 'config/settings.yml'
+    required_executable: 'chamber'
+    install_command: 'gem install chamber'
+    include:
+      - 'config/settings.yml'
+      - 'config/settings/**/*.yml'
 
   CoffeeLint:
     description: 'Analyzing with coffeelint'
+    required_executable: 'coffeelint'
+    install_command: 'npm install -g coffeelint'
     include: '**/*.coffee'
 
   CssLint:
     description: 'Analyzing with csslint'
+    required_executable: 'csslint'
+    install_command: 'npm install -g csslint'
     include: '**/*.css'
 
   GoLint:
     description: 'Analyzing with golint'
+    required_executable: 'golint'
+    install_command: 'go get github.com/golang/lint/golint'
     include: '**/*.go'
 
   HamlLint:
     description: 'Analyzing with haml-lint'
+    required_executable: 'haml-lint'
+    install_command: 'gem install haml-lint'
     include: '**/*.haml'
 
   HardTabs:
@@ -105,10 +127,14 @@ PreCommit:
 
   Jscs:
     description: 'Analyzing with JSCS'
+    required_executable: 'jscs'
+    install_command: 'npm install -g jscs'
     include: '**/*.js'
 
   JsHint:
     description: 'Analyzing with JSHint'
+    required_executable: 'jshint'
+    install_command: 'npm install -g jshint'
     include: '**/*.js'
 
   JsonSyntax:
@@ -117,6 +143,8 @@ PreCommit:
 
   JsxHint:
     description: 'Analyzing with JSXHint'
+    required_executable: 'jsxhint'
+    install_command: 'npm install -g jsxhint'
     include: '**/*.jsx'
 
   LocalPathsInGemfile:
@@ -134,6 +162,8 @@ PreCommit:
 
   PythonFlake8:
     description: 'Analyzing with flake8'
+    required_executable: 'flake8'
+    install_command: 'pip install flake8'
     include: '**/*.py'
 
   RailsSchemaUpToDate:
@@ -145,6 +175,8 @@ PreCommit:
 
   Rubocop:
     description: 'Analyzing with Rubocop'
+    required_executable: 'rubocop'
+    install_command: 'gem install rubocop'
     include:
       - '**/*.gemspec'
       - '**/*.rake'
@@ -154,6 +186,8 @@ PreCommit:
 
   ScssLint:
     description: 'Analyzing with scss-lint'
+    required_executable: 'scss-lint'
+    install_command: 'gem install scss-lint'
     include: '**/*.scss'
 
   TrailingWhitespace:
@@ -163,6 +197,8 @@ PreCommit:
 
   TravisLint:
     description: 'Checking Travis CI configuration'
+    required_executable: 'travis-lint'
+    install_command: 'gem install travis-lint'
     include: '.travis.yml'
 
   YamlSyntax:

data/lib/overcommit/cli.rb

@@ -3,7 +3,7 @@ require 'optparse'
 module Overcommit
   # Responsible for parsing command-line options and executing appropriate
   # application logic based on those options.
-  class CLI
+  class CLI # rubocop:disable ClassLength
     def initialize(arguments, logger)
       @arguments = arguments
       @log       = logger
@@ -21,7 +21,7 @@ module Overcommit
       end
     end
 
-  private
+    private
 
     attr_reader :log
 
@@ -59,6 +59,10 @@ module Overcommit
       opts.on_tail('-v', '--version', 'Show version') do
         print_version(opts.program_name)
       end
+
+      opts.on_tail('-l', '--list-hooks', 'List installed hooks') do
+        print_installed_hooks
+      end
     end
 
     def add_installation_options(opts)
@@ -122,6 +126,37 @@ module Overcommit
       halt
     end
 
+    # Prints the hooks available in the current repo and whether they're
+    # enabled/disabled.
+    def print_installed_hooks
+      config = Overcommit::ConfigurationLoader.load_repo_config
+
+      config.all_hook_configs.each do |hook_type, hook_configs|
+        print_hooks_for_hook_type(config, hook_configs, hook_type)
+      end
+
+      halt
+    end
+
+    def print_hooks_for_hook_type(repo_config, hook_configs, hook_type)
+      log.log "#{hook_type}:"
+      hook_configs.each do |hook_name, config|
+        log.partial "  #{hook_name}: "
+
+        if config['enabled']
+          log.success('enabled', true)
+        else
+          log.error('disabled', true)
+        end
+
+        if repo_config.plugin_hook?(hook_type, hook_name)
+          log.warning(' (plugin)')
+        else
+          log.log
+        end
+      end
+    end
+
     # Used for ease of stubbing in tests
     def halt(status = 0)
       exit status

data/lib/overcommit/configuration.rb

@@ -1,6 +1,6 @@
 module Overcommit
   # Stores configuration for Overcommit and the hooks it runs.
-  class Configuration
+  class Configuration # rubocop:disable ClassLength
     # Creates a configuration from the given hash.
     def initialize(hash)
       @hash = ConfigurationValidator.new.validate(hash)
@@ -21,6 +21,58 @@ module Overcommit
       @hash['verify_plugin_signatures'] != false
     end
 
+    # Returns configuration for all hooks in each hook type.
+    #
+    # @return [Hash]
+    def all_hook_configs
+      smart_merge(all_builtin_hook_configs, all_plugin_hook_configs)
+    end
+
+    # Returns configuration for all built-in hooks in each hook type.
+    #
+    # @return [Hash]
+    def all_builtin_hook_configs
+      hook_configs = {}
+
+      Overcommit::Utils.supported_hook_type_classes.each do |hook_type|
+        hook_names = @hash[hook_type].keys.reject { |name| name == 'ALL' }
+
+        hook_configs[hook_type] = Hash[
+          hook_names.map do |hook_name|
+            [hook_name, for_hook(hook_name, hook_type)]
+          end
+        ]
+      end
+
+      hook_configs
+    end
+
+    # Returns configuration for all plugin hooks in each hook type.
+    #
+    # @return [Hash]
+    def all_plugin_hook_configs
+      hook_configs = {}
+
+      Overcommit::Utils.supported_hook_types.each do |hook_type|
+        hook_type_class_name = Overcommit::Utils.camel_case(hook_type)
+
+        directory = File.join(plugin_directory, hook_type.gsub('-', '_'))
+        plugin_paths = Dir[File.join(directory, '*.rb')].sort
+
+        hook_names = plugin_paths.map do |path|
+          Overcommit::Utils.camel_case(File.basename(path, '.rb'))
+        end
+
+        hook_configs[hook_type_class_name] = Hash[
+          hook_names.map do |hook_name|
+            [hook_name, for_hook(hook_name, Overcommit::Utils.camel_case(hook_type))]
+          end
+        ]
+      end
+
+      hook_configs
+    end
+
     # Returns the built-in hooks that have been enabled for a hook type.
     def enabled_builtin_hooks(hook_context)
       @hash[hook_context.hook_class_name].keys.
@@ -38,7 +90,13 @@ module Overcommit
       end
 
       # Merge hook configuration with special 'ALL' config
-      smart_merge(@hash[hook_type]['ALL'], @hash[hook_type][hook] || {}).freeze
+      hook_config = smart_merge(@hash[hook_type]['ALL'], @hash[hook_type][hook] || {})
+
+      # Need to specially handle `enabled` option since not setting it does not
+      # necessarily mean the hook is disabled
+      hook_config['enabled'] = hook_enabled?(hook_type, hook)
+
+      hook_config.freeze
     end
 
     # Merges the given configuration with this one, returning a new
@@ -66,11 +124,23 @@ module Overcommit
       end
     end
 
-  protected
+    def plugin_hook?(hook_context_or_type, hook_name)
+      hook_type_name =
+        if hook_context_or_type.is_a?(String)
+          Overcommit::Utils.snake_case(hook_context_or_type)
+        else
+          hook_context_or_type.hook_type_name
+        end
+      hook_name = Overcommit::Utils.snake_case(hook_name)
+
+      File.exist?(File.join(plugin_directory, hook_type_name, "#{hook_name}.rb"))
+    end
+
+    protected
 
     attr_reader :hash
 
-  private
+    private
 
     def built_in_hook?(hook_context, hook_name)
       hook_name = Overcommit::Utils.snake_case(hook_name)
@@ -79,22 +149,16 @@ module Overcommit
                             hook_context.hook_type_name, "#{hook_name}.rb"))
     end
 
-    def plugin_hook?(hook_context, hook_name)
-      hook_name = Overcommit::Utils.snake_case(hook_name)
-
-      File.exist?(File.join(plugin_directory,
-                            hook_context.hook_type_name,
-                            "#{hook_name}.rb"))
-    end
-
     def hook_exists?(hook_context, hook_name)
       built_in_hook?(hook_context, hook_name) ||
         plugin_hook?(hook_context, hook_name)
     end
 
-    def hook_enabled?(hook_context, hook_name)
-      hook_type = hook_context.hook_class_name
-      individual_enabled = @hash[hook_type][hook_name]['enabled']
+    def hook_enabled?(hook_context_or_type, hook_name)
+      hook_type = hook_context_or_type.is_a?(String) ? hook_context_or_type :
+                                                       hook_context_or_type.hook_class_name
+
+      individual_enabled = @hash[hook_type].fetch(hook_name, {})['enabled']
       return individual_enabled unless individual_enabled.nil?
 
       all_enabled = @hash[hook_type]['ALL']['enabled']

data/lib/overcommit/configuration_loader.rb

@@ -21,7 +21,7 @@ module Overcommit
         @default_config ||= load_from_file(DEFAULT_CONFIG_PATH)
       end
 
-    private
+      private
 
       # Loads a configuration, ensuring it extends the default configuration.
       def load_file(file)

data/lib/overcommit/configuration_validator.rb

@@ -9,7 +9,7 @@ module Overcommit
       hash
     end
 
-  private
+    private
 
     # Ensures that keys for all supported hook types exist (PreCommit,
     # CommitMsg, etc.)

data/lib/overcommit/git_repo.rb

@@ -66,10 +66,10 @@ module Overcommit
       # conflict. This is necessary since stashing removes the merge state.
       if merge_head != 'MERGE_HEAD'
         @merge_head = merge_head
-
-        merge_msg_file = File.expand_path('.git/MERGE_MSG', Overcommit::Utils.repo_root)
-        @merge_msg = File.open(merge_msg_file).read if File.exist?(merge_msg_file)
       end
+
+      merge_msg_file = File.expand_path('.git/MERGE_MSG', Overcommit::Utils.repo_root)
+      @merge_msg = File.open(merge_msg_file).read if File.exist?(merge_msg_file)
     end
 
     # Store any relevant files that are present when repo is in the middle of a

data/lib/overcommit/hook/base.rb

@@ -8,6 +8,8 @@ module Overcommit::Hook
     def_delegators :@context, :modified_files
     attr_reader :config
 
+    # @param config [Overcommit::Configuration]
+    # @param context [Overcommit::HookContext]
     def initialize(config, context)
       @config = config.for_hook(self)
       @context = context
@@ -25,7 +27,11 @@ module Overcommit::Hook
     # implement `#run`, and we needed a wrapper step to transform the status
     # based on any custom configuration.
     def run_and_transform
-      status, output = run
+      if output = check_for_executable
+        status = :fail
+      else
+        status, output = run
+      end
 
       [transform_status(status), output]
     end
@@ -68,13 +74,21 @@ module Overcommit::Hook
       Overcommit::Utils.execute(cmd)
     end
 
+    def executable
+      @config['required_executable']
+    end
+
+    def install_command
+      @config['install_command']
+    end
+
     # Gets a list of staged files that apply to this hook based on its
     # configured `include` and `exclude` lists.
     def applicable_files
       @applicable_files ||= modified_files.select { |file| applicable_file?(file) }
     end
 
-  private
+    private
 
     def requires_modified_files?
       @config['requires_files']
@@ -107,6 +121,20 @@ module Overcommit::Hook
       )
     end
 
+    # 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)
+
+      output = "'#{executable}' is not installed (or is not in your PATH)"
+
+      if install_command
+        output += "\nInstall it by running: #{install_command}"
+      end
+
+      output
+    end
+
     # Transforms the hook's status based on custom configuration.
     #
     # This allows users to change failures into warnings, or vice versa.

data/lib/overcommit/hook/post_checkout/index_tags.rb

@@ -12,7 +12,7 @@ module Overcommit::Hook::PostCheckout
       :pass
     end
 
-  private
+    private
 
     SCRIPT_LOCATION = Overcommit::Utils.script_path('index-tags')
 

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

@@ -5,15 +5,11 @@ module Overcommit::Hook::PreCommit
     LOCK_FILE = 'Berksfile.lock'
 
     def run
-      unless in_path?('berks')
-        return :warn, 'Berkshelf not installed -- run `gem install berkshelf`'
-      end
-
       # Ignore if Berksfile.lock is not tracked by git
       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[berks list --quiet])
+      result = execute(%W[#{executable} list --quiet])
       unless result.success?
         return :fail, result.stderr
       end

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

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

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

@@ -0,0 +1,15 @@
+module Overcommit::Hook::PreCommit
+  # Checks for broken symlinks.
+  class BrokenSymlinks < Base
+    def run
+      broken_symlinks = applicable_files.
+        select { |file| Overcommit::Utils.broken_symlink?(file) }
+
+      if broken_symlinks.any?
+        return :fail, "Broken symlinks detected:\n#{broken_symlinks.join("\n")}"
+      end
+
+      :pass
+    end
+  end
+end

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

@@ -5,22 +5,18 @@ module Overcommit::Hook::PreCommit
     LOCK_FILE = 'Gemfile.lock'
 
     def run
-      unless in_path?('bundle')
-        return :warn, 'bundler not installed -- run `gem install bundler`'
-      end
-
       # Ignore if Gemfile.lock is not tracked by git
       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[bundle check])
+      result = execute(%W[#{executable} check])
       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 `bundle check`"
+        return :fail, "#{LOCK_FILE} is not up-to-date -- run `#{executable} check`"
       end
 
       :pass

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `chamber secure` against any modified Chamber settings files
   class ChamberSecurity < Base
     def run
-      unless in_path?('chamber')
-        return :warn, 'Run `gem install chamber`'
-      end
-
-      result = execute(%w[chamber secure --echo --files] + applicable_files)
+      result = execute(%W[#{executable} secure --files] + 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,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `coffeelint` against any modified CoffeeScript files.
   class CoffeeLint < Base
     def run
-      unless in_path?('coffeelint')
-        return :warn, 'Run `npm install -g coffeelint`'
-      end
-
-      result = execute(%w[coffeelint --quiet] + applicable_files)
+      result = execute(%W[#{executable} --quiet] + applicable_files)
       return :pass if result.success?
 
       [:fail, result.stdout]

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

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

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `golint` against any modified Golang files.
   class GoLint < Base
     def run
-      unless in_path?('golint')
-        return :warn, 'Run `go get `github.com/golang/lint/golint`'
-      end
-
-      result = execute(%w[golint] + applicable_files)
+      result = execute([executable] + applicable_files)
       # Unfortunately the exit code is always 0
       return :pass if result.stdout.empty?
 

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `haml-lint` against any modified HAML files.
   class HamlLint < Base
     def run
-      unless in_path?('haml-lint')
-        return :warn, 'haml-lint not installed -- run `gem install haml-lint`'
-      end
-
-      result = execute(%w[haml-lint] + applicable_files)
+      result = execute([executable] + applicable_files)
       return :pass if result.success?
 
       # Keep lines from the output for files that we actually modified

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

@@ -11,7 +11,7 @@ module Overcommit::Hook::PreCommit
       optimized_images =
         begin
           optimize_images(applicable_files)
-        rescue ::ImageOptim::BinNotFoundError => e
+        rescue ::ImageOptim::BinResolver::BinNotFound => e
           return :fail, "#{e.message}. The image_optim gem is dependendent on this binary."
         end
 
@@ -25,7 +25,7 @@ module Overcommit::Hook::PreCommit
       :pass
     end
 
-  private
+    private
 
     def optimize_images(image_paths)
       image_optim = ::ImageOptim.new(:pngout => false)

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `jshint` against any modified JavaScript files.
   class JsHint < Base
     def run
-      unless in_path?('jshint')
-        return :warn, 'jshint not installed -- run `npm install -g jshint`'
-      end
-
-      result = execute(%w[jshint] + applicable_files)
+      result = execute([executable] + applicable_files)
       output = result.stdout
 
       return :pass if output.empty?

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

@@ -3,11 +3,7 @@ module Overcommit::Hook::PreCommit
   # files.
   class Jscs < Base
     def run
-      unless in_path?('jscs')
-        return :warn, 'jscs not installed -- run `npm install -g jscs`'
-      end
-
-      result = execute(%w[jscs --reporter=inline] + applicable_files)
+      result = execute(%W[#{executable} --reporter=inline] + applicable_files)
       return :pass if result.success?
 
       if result.status == 1

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `jsxhint` against any modified JSX files.
   class JsxHint < Base
     def run
-      unless in_path?('jsxhint')
-        return :warn, 'jsxhint not installed -- run `npm install -g jsxhint`'
-      end
-
-      result = execute(%w[jsxhint] + applicable_files)
+      result = execute([executable] + applicable_files)
       output = result.stdout
 
       return :pass if output.empty?

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `flake8` against any modified Python files.
   class PythonFlake8 < Base
     def run
-      unless in_path?('flake8')
-        return :warn, 'flake8 not installed -- run `pip install flake8`'
-      end
-
-      result = execute(%w[flake8] + applicable_files)
+      result = execute([executable] + applicable_files)
       return :pass if result.success?
 
       [:fail, result.stdout]

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

@@ -1,7 +1,7 @@
 module Overcommit::Hook::PreCommit
   # Check to see whether the schema file is in line with the migrations
   class RailsSchemaUpToDate < Base
-    def run # rubocop:disable CyclomaticComplexity
+    def run # rubocop:disable CyclomaticComplexity, PerceivedComplexity
       if migration_files.any? && schema_files.none?
         return :fail, "It looks like you're adding a migration, but did not update the schema file"
       elsif migration_files.none? && schema_files.any?
@@ -28,7 +28,7 @@ module Overcommit::Hook::PreCommit
       :pass
     end
 
-  private
+    private
 
     def migration_files
       @migration_files ||= applicable_files.select do |file|

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `rubocop` against any modified Ruby files.
   class Rubocop < Base
     def run
-      unless in_path?('rubocop')
-        return :warn, 'Rubocop not installed -- run `gem install rubocop`'
-      end
-
-      result = execute(%w[rubocop --format=emacs --force-exclusion] + applicable_files)
+      result = execute(%W[#{executable} --format=emacs --force-exclusion] + applicable_files)
       return :pass if result.success?
 
       output = result.stdout + result.stderr

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `scss-lint` against any modified SCSS files.
   class ScssLint < Base
     def run
-      unless in_path?('scss-lint')
-        return :warn, 'scss-lint not installed -- run `gem install scss-lint`'
-      end
-
-      result = execute(%w[scss-lint] + applicable_files)
+      result = execute([executable] + applicable_files)
       return :pass if result.success?
 
       # Keep lines from the output for files that we actually modified

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

@@ -2,11 +2,7 @@ module Overcommit::Hook::PreCommit
   # Runs `travis-lint` against any modified Travis CI files.
   class TravisLint < Base
     def run
-      unless in_path?('travis-lint')
-        return :warn, 'Run `gem install travis-lint`'
-      end
-
-      result = execute(%w[travis-lint] + applicable_files)
+      result = execute([executable] + applicable_files)
       return :pass if result.success?
 
       [:fail, result.stdout.strip]

data/lib/overcommit/hook_context/commit_msg.rb

@@ -23,7 +23,7 @@ module Overcommit::HookContext
       @args[0]
     end
 
-  private
+    private
 
     def raw_commit_message_lines
       ::IO.readlines(commit_message_file)

data/lib/overcommit/hook_context/pre_commit.rb

@@ -67,7 +67,7 @@ module Overcommit::HookContext
       @modified_lines[file] ||= Overcommit::GitRepo.extract_modified_lines(file, :staged => true)
     end
 
-  private
+    private
 
     # Clears the working tree so that the stash can be applied.
     def clear_working_tree
@@ -114,6 +114,7 @@ module Overcommit::HookContext
       @modified_times = {}
 
       modified_files.each do |file|
+        next if Overcommit::Utils.broken_symlink?(file)
         @modified_times[file] = File.mtime(file)
       end
     end
@@ -122,6 +123,7 @@ module Overcommit::HookContext
     # appear like they never changed.
     def restore_modified_times
       modified_files.each do |file|
+        next if Overcommit::Utils.broken_symlink?(file)
         time = @modified_times[file]
         File.utime(time, time, file)
       end

data/lib/overcommit/hook_loader/base.rb

@@ -20,7 +20,7 @@ module Overcommit::HookLoader
       raise NotImplementedError
     end
 
-  private
+    private
 
     attr_reader :log
 

data/lib/overcommit/hook_loader/plugin_hook_loader.rb

@@ -18,12 +18,12 @@ module Overcommit::HookLoader
       end
     end
 
-  private
+    private
 
     def check_for_modified_plugins(plugin_paths)
       modified_plugins = plugin_paths.
         map { |path| Overcommit::HookSigner.new(path, @config, @context) }.
-        select { |signer| signer.signature_changed? }
+        select(&:signature_changed?)
 
       return if modified_plugins.empty?
 
@@ -45,7 +45,7 @@ module Overcommit::HookLoader
         raise Overcommit::Exceptions::HookCancelled
       end
 
-      modified_plugins.each { |signer| signer.update_signature! }
+      modified_plugins.each(&:update_signature!)
     end
   end
 end

data/lib/overcommit/hook_runner.rb

@@ -31,7 +31,7 @@ module Overcommit
       end
     end
 
-  private
+    private
 
     attr_reader :log
 

data/lib/overcommit/hook_signer.rb

@@ -38,7 +38,7 @@ module Overcommit
       end
     end
 
-  private
+    private
 
     # Calculates a hash of a hook using a combination of its configuration and
     # file contents.

data/lib/overcommit/installer.rb

@@ -23,7 +23,7 @@ module Overcommit
       end
     end
 
-  private
+    private
 
     attr_reader :log
 

data/lib/overcommit/logger.rb

@@ -18,34 +18,35 @@ module Overcommit
       @out.puts(*args)
     end
 
-    def bold(str)
-      color('1', str)
+    def bold(*args)
+      color('1', *args)
     end
 
-    def error(str)
-      color(31, str)
+    def error(*args)
+      color(31, *args)
     end
 
-    def bold_error(str)
-      color('1;31', str)
+    def bold_error(*args)
+      color('1;31', *args)
     end
 
-    def success(str)
-      color(32, str)
+    def success(*args)
+      color(32, *args)
     end
 
-    def warning(str)
-      color(33, str)
+    def warning(*args)
+      color(33, *args)
     end
 
-    def bold_warning(str)
-      color('1;33', str)
+    def bold_warning(*args)
+      color('1;33', *args)
     end
 
-  private
+    private
 
-    def color(code, str)
-      log(@out.tty? ? "\033[#{code}m#{str}\033[0m" : str)
+    def color(code, str, partial = false)
+      send(partial ? :partial : :log,
+           @out.tty? ? "\033[#{code}m#{str}\033[0m" : str)
     end
   end
 end

data/lib/overcommit/printer.rb

@@ -59,7 +59,7 @@ module Overcommit
       print_result(hook, status, output)
     end
 
-  private
+    private
 
     def print_header(hook)
       hook_name = "[#{hook.name}] "

data/lib/overcommit/user_input.rb

@@ -13,7 +13,7 @@ module Overcommit
       @io.gets
     end
 
-  private
+    private
 
     # Git hooks are not interactive and will close STDIN by default.
     def reopen_tty

data/lib/overcommit/utils.rb

@@ -42,7 +42,7 @@ module Overcommit
       # Returns a list of supported hook classes (PreCommit, CommitMsg, etc.)
       def supported_hook_type_classes
         supported_hook_types.map do |file|
-          file.split('-').map { |part| part.capitalize }.join
+          file.split('-').map(&:capitalize).join
         end
       end
 
@@ -86,6 +86,15 @@ module Overcommit
       ensure
         old_env.each { |var, value| ENV[var.to_s] = value }
       end
+
+      # Returns whether a file is a broken symlink.
+      #
+      # @return [true,false]
+      def broken_symlink?(file)
+        # JRuby's implementation of File.exist? returns true for broken
+        # symlinks, so we need use File.size?
+        File.symlink?(file) && File.size?(file).nil?
+      end
     end
   end
 end

data/lib/overcommit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-03 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.26.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.26.0
 description: Utility to install, configure, and extend Git hooks
 email:
 - eng@causes.com
@@ -123,6 +123,7 @@ files:
 - lib/overcommit/hook/pre_commit/jscs.rb
 - lib/overcommit/hook/pre_commit/scss_lint.rb
 - lib/overcommit/hook/pre_commit/base.rb
+- lib/overcommit/hook/pre_commit/broken_symlinks.rb
 - lib/overcommit/hook/pre_commit/json_syntax.rb
 - lib/overcommit/hook_signer.rb
 - lib/overcommit/git_repo.rb