overcommit 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe8456581eecc5b4f317667847ef8fbd1584f1db
-  data.tar.gz: dd15307f76b68cb942311d50b3c8263fc246e511
+  metadata.gz: 043d9e4f69b46108c0de597ecf9640f31149c98e
+  data.tar.gz: 9b61ce0b7846dae6580ec4d8934b4f2ec6484eab
 SHA512:
-  metadata.gz: e20922efd93d40a9085233a95f6eae0b945965328b12bf4652ac787b90ae729a856d56278f9ed5d0987065834723bd87be400767cc7a338b35b4f853ad349ee3
-  data.tar.gz: 6dc2b6b044f372951ba79b9802d68557160fcf86fa1be811185f167083263d3e8898fb2862deec96f254f02b6479c71c9d557f7ede669cf68b8499fcb27c2ac8
+  metadata.gz: c4f4dc8af420e79565d242caf90eb37148fe7cbc4f1cd015627a4f8863a16f8237da519ed738c7620dff9c35b0a6f86614e5fae0923f0a4f1cb2c3f9f1fc2876
+  data.tar.gz: e1fd1a72991e8e708503cf870c68f333c4321eab536e010bc80eb2cff2b1f116c10f8710a540697d3d4ecd202e3e16e4a326ab8f37ede4762d800323c5d8af71

data/config/starter.yml

@@ -0,0 +1,31 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/causes/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/causes/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/causes/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  Rubocop:
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#   quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/lib/overcommit/configuration_loader.rb

@@ -4,11 +4,11 @@ module Overcommit
   # Manages configuration file loading.
   class ConfigurationLoader
     DEFAULT_CONFIG_PATH = File.join(OVERCOMMIT_HOME, 'config', 'default.yml')
-    FILE_NAME = '.overcommit.yml'
 
     class << self
       def load_repo_config
-        overcommit_yml = File.join(Overcommit::Utils.repo_root, FILE_NAME)
+        overcommit_yml = File.join(Overcommit::Utils.repo_root,
+                                   OVERCOMMIT_CONFIG_FILE_NAME)
 
         if File.exist?(overcommit_yml)
           load_file(overcommit_yml)

data/lib/overcommit/constants.rb

@@ -1,6 +1,7 @@
 # Global application constants.
 module Overcommit
   OVERCOMMIT_HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+  OVERCOMMIT_CONFIG_FILE_NAME = '.overcommit.yml'
 
   REPO_URL = 'https://github.com/causes/overcommit'
   BUG_REPORT_URL = "#{REPO_URL}/issues"

data/lib/overcommit/exceptions.rb

@@ -5,6 +5,9 @@ module Overcommit::Exceptions
   # Raised when trying to read/write to/from the local repo git config fails.
   class GitConfigError < StandardError; end
 
+  # Raised when a {HookContext} is unable to setup the environment before a run.
+  class HookSetupFailed < StandardError; end
+
   # Raised when a hook run was cancelled by the user.
   class HookCancelled < StandardError; end
 

data/lib/overcommit/hook/base.rb

@@ -6,6 +6,7 @@ module Overcommit::Hook
     extend Forwardable
 
     def_delegators :@context, :modified_files
+    attr_reader :config
 
     def initialize(config, context)
       @config = config.for_hook(self)
@@ -17,6 +18,18 @@ module Overcommit::Hook
       raise NotImplementedError, 'Hook must define `run`'
     end
 
+    # Runs the hook and transforms the status returned based on the hook's
+    # configuration.
+    #
+    # Poorly named because we already have a bunch of hooks in the wild that
+    # implement `#run`, and we needed a wrapper step to transform the status
+    # based on any custom configuration.
+    def run_and_transform
+      status, output = run
+
+      [transform_status(status), output]
+    end
+
     def name
       self.class.name.split('::').last
     end
@@ -93,5 +106,19 @@ module Overcommit::Hook
                     File::FNM_DOTMATCH   # Wildcards match dotfiles
       )
     end
+
+    # Transforms the hook's status based on custom configuration.
+    #
+    # This allows users to change failures into warnings, or vice versa.
+    def transform_status(status)
+      case status
+      when :fail, :bad
+        @config.fetch('on_fail', :fail).to_sym
+      when :warn
+        @config.fetch('on_warn', :warn).to_sym
+      else
+        status
+      end
+    end
   end
 end

data/lib/overcommit/hook/commit_msg/gerrit_change_id.rb

@@ -10,9 +10,9 @@ module Overcommit::Hook::CommitMsg
 
     def run
       result = execute([SCRIPT_LOCATION, commit_message_file])
-      return :good if result.success?
+      return :pass if result.success?
 
-      [:bad, result.stdout]
+      [:fail, result.stdout]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Overcommit::Hook::CommitMsg
         return :warn, "Don't use hard tabs in commit messages"
       end
 
-      :good
+      :pass
     end
   end
 end

data/lib/overcommit/hook/commit_msg/russian_novel.rb

@@ -8,7 +8,7 @@ module Overcommit::Hook::CommitMsg
         return :warn, 'You seem to have authored a Russian novel; congratulations!'
       end
 
-      :good
+      :pass
     end
   end
 end

data/lib/overcommit/hook/commit_msg/single_line_subject.rb

@@ -6,7 +6,7 @@ module Overcommit::Hook::CommitMsg
         return :warn, 'Subject should be one line and followed by a blank line'
       end
 
-      :good
+      :pass
     end
   end
 end

data/lib/overcommit/hook/commit_msg/text_width.rb

@@ -5,8 +5,8 @@ module Overcommit::Hook::CommitMsg
     def run
       errors = []
 
-      max_subject_width = @config['max_subject_width']
-      max_body_width = @config['max_body_width']
+      max_subject_width = config['max_subject_width']
+      max_body_width = config['max_body_width']
 
       if commit_message_lines.first.size > max_subject_width
         errors << "Please keep the subject <= #{max_subject_width} characters"
@@ -25,7 +25,7 @@ module Overcommit::Hook::CommitMsg
 
       return :warn, errors.join("\n") if errors.any?
 
-      :good
+      :pass
     end
   end
 end

data/lib/overcommit/hook/commit_msg/trailing_period.rb

@@ -6,7 +6,7 @@ module Overcommit::Hook::CommitMsg
         return :warn, 'Please omit trailing period from commit message subject'
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -11,7 +11,7 @@ module Overcommit::Hook::PostCheckout
         return :warn, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
       end
 
-      :good
+      :pass
     end
 
   private
@@ -22,7 +22,7 @@ module Overcommit::Hook::PostCheckout
       result = execute(%w[git diff --exit-code --name-only] + [new_head, previous_head])
 
       result.stdout.split("\n").any? do |file|
-        Array(@config['include']).any? { |glob| Dir[glob].include?(file) }
+        Array(config['include']).any? { |glob| Dir[glob].include?(file) }
       end
     end
 

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

@@ -4,12 +4,12 @@ module Overcommit::Hook::PostCheckout
   class IndexTags < Base
     def run
       unless in_path?('ctags')
-        return :good # Silently ignore
+        return :pass # Silently ignore
       end
 
       index_tags_in_background
 
-      :good
+      :pass
     end
 
   private
@@ -17,7 +17,7 @@ module Overcommit::Hook::PostCheckout
     SCRIPT_LOCATION = Overcommit::Utils.script_path('index-tags')
 
     def index_tags_in_background
-      ctags_args = @config['ctags_arguments']
+      ctags_args = config['ctags_arguments']
 
       # TODO: come up with Ruby 1.8-friendly way to do this
       Process.detach(Process.spawn("#{SCRIPT_LOCATION} #{ctags_args}"))

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

@@ -5,13 +5,14 @@ module Overcommit::Hook::PreCommit
       result = execute(%w[git config --get user.email])
       email = result.stdout.chomp
 
-      unless email =~ /#{@config['pattern']}/
-        return :bad, "Author has an invalid email address: '#{email}'\n" \
-                     'Set your email with ' \
-                     '`git config --global user.email your_email@example.com`'
+      unless email =~ /#{config['pattern']}/
+        return :fail,
+               "Author has an invalid email address: '#{email}'\n" \
+               'Set your email with ' \
+               '`git config --global user.email your_email@example.com`'
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -6,12 +6,12 @@ module Overcommit::Hook::PreCommit
       name = result.stdout.chomp
 
       unless name.split(' ').count >= 2
-        return :bad, 'Author must have at least first and last name, but ' \
-                     "was: '#{name}'.\nSet your name with " \
-                     "`git config --global user.name 'Your Name'`"
+        return :fail,
+               "Author must have at least first and last name, but was: #{name}." \
+               "\nSet your name with `git config --global user.name 'Your Name'`"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -11,14 +11,14 @@ module Overcommit::Hook::PreCommit
 
       # Ignore if Berksfile.lock is not tracked by git
       ignored_files = execute(%w[git ls-files -o -i --exclude-standard]).stdout.split("\n")
-      return :good if ignored_files.include?(LOCK_FILE)
+      return :pass if ignored_files.include?(LOCK_FILE)
 
       result = execute(%w[berks list --quiet])
       unless result.success?
-        return :bad, result.stderr
+        return :fail, result.stderr
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -8,9 +8,9 @@ module Overcommit::Hook::PreCommit
 
       result = execute(%w[brakeman --exit-on-warn --quiet --summary --only-files] +
                        applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
-      [:bad, result.stdout]
+      [:fail, result.stdout]
     end
   end
 end

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

@@ -11,19 +11,19 @@ module Overcommit::Hook::PreCommit
 
       # Ignore if Gemfile.lock is not tracked by git
       ignored_files = execute(%w[git ls-files -o -i --exclude-standard]).stdout.split("\n")
-      return :good if ignored_files.include?(LOCK_FILE)
+      return :pass if ignored_files.include?(LOCK_FILE)
 
       result = execute(%w[bundle check])
       unless result.success?
-        return :bad, result.stdout
+        return :fail, result.stdout
       end
 
       result = execute(%w[git diff --quiet --] + [LOCK_FILE])
       unless result.success?
-        return :bad, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
+        return :fail, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -8,8 +8,8 @@ module Overcommit::Hook::PreCommit
 
       result = execute(%w[chamber secure --echo --files] + applicable_files)
 
-      return :good if result.stdout.empty?
-      [:bad, "These settings appear to need to be secured but were not: #{result.stdout}"]
+      return :pass if result.stdout.empty?
+      [:fail, "These settings appear to need to be secured but were not: #{result.stdout}"]
     end
   end
 end

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

@@ -7,9 +7,9 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[coffeelint --quiet] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
-      [:bad, result.stdout]
+      [:fail, result.stdout]
     end
   end
 end

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

@@ -7,9 +7,9 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[csslint --quiet --format=compact] + applicable_files)
-      return :good if result.stdout !~ /Error - (?!Unknown @ rule)/
+      return :pass if result.stdout !~ /Error - (?!Unknown @ rule)/
 
-      [:bad, result.stdout]
+      [:fail, result.stdout]
     end
   end
 end

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

@@ -8,9 +8,9 @@ module Overcommit::Hook::PreCommit
 
       result = execute(%w[golint] + applicable_files)
       # Unfortunately the exit code is always 0
-      return :good if result.stdout.empty?
+      return :pass if result.stdout.empty?
 
-      [:bad, result.stdout]
+      [:fail, result.stdout]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[haml-lint] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       # Keep lines from the output for files that we actually modified
       error_lines, warning_lines = result.stdout.split("\n").partition do |output_line|
@@ -18,7 +18,7 @@ module Overcommit::Hook::PreCommit
         modified_lines(file).include?(line.to_i)
       end
 
-      return :bad, error_lines.join("\n") unless error_lines.empty?
+      return :fail, error_lines.join("\n") unless error_lines.empty?
 
       [:warn, "Modified files have lints (on lines you didn't modify)\n" <<
               warning_lines.join("\n")]

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

@@ -5,10 +5,10 @@ module Overcommit::Hook::PreCommit
       # Catches hard tabs
       result = execute(%w[grep -IHn] + ["\t"] + applicable_files)
       unless result.stdout.empty?
-        return :bad, "Hard tabs detected:\n#{result.stdout}"
+        return :fail, "Hard tabs detected:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -12,17 +12,17 @@ module Overcommit::Hook::PreCommit
         begin
           optimize_images(applicable_files)
         rescue ::ImageOptim::BinNotFoundError => e
-          return :bad, "#{e.message}. The image_optim gem is dependendent on this binary."
+          return :fail, "#{e.message}. The image_optim gem is dependendent on this binary."
         end
 
       if optimized_images.any?
-        return :bad,
+        return :fail,
           "The following images are optimizable:\n#{optimized_images.join("\n")}" \
           "\n\nOptimize them by running:\n" \
           "  image_optim #{optimized_images.join(' ')}"
       end
 
-      :good
+      :pass
     end
 
   private

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

@@ -9,9 +9,9 @@ module Overcommit::Hook::PreCommit
       result = execute(%w[jshint] + applicable_files)
       output = result.stdout
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
-      [:bad, output]
+      [:fail, output]
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[jscs --reporter=inline] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       if result.status == 1
         return :warn, result.stderr.chomp
@@ -23,7 +23,7 @@ module Overcommit::Hook::PreCommit
         modified_lines(file).include?(line.to_i)
       end
 
-      return :bad, error_lines.join("\n") unless error_lines.empty?
+      return :fail, error_lines.join("\n") unless error_lines.empty?
 
       [:warn, "Modified files have lints (on lines you didn't modify)\n" <<
               warning_lines.join("\n")]

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

@@ -14,9 +14,9 @@ module Overcommit::Hook::PreCommit
         end
       end
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
-      [:bad, output]
+      [:fail, output]
     end
   end
 end

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

@@ -9,9 +9,9 @@ module Overcommit::Hook::PreCommit
       result = execute(%w[jsxhint] + applicable_files)
       output = result.stdout
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
-      [:bad, output]
+      [:fail, output]
     end
   end
 end

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

@@ -8,7 +8,7 @@ module Overcommit::Hook::PreCommit
         return :warn, "Avoid pointing to local paths in Gemfiles:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -5,10 +5,10 @@ module Overcommit::Hook::PreCommit
       result = execute(%w[grep -IHn ^<<<<<<<\s] + applicable_files)
 
       unless result.stdout.empty?
-        return :bad, "Merge conflict markers detected:\n#{result.stdout}"
+        return :fail, "Merge conflict markers detected:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -5,10 +5,10 @@ module Overcommit::Hook::PreCommit
       result = execute(%w[grep -IHnE ^\s*binding\.pry] + applicable_files)
 
       unless result.stdout.empty?
-        return :bad, "Found a `binding.pry` call left in:\n#{result.stdout}"
+        return :fail, "Found a `binding.pry` call left in:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -7,9 +7,9 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[flake8] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
-      [:bad, result.stdout]
+      [:fail, result.stdout]
     end
   end
 end

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

@@ -3,22 +3,22 @@ module Overcommit::Hook::PreCommit
   class RailsSchemaUpToDate < Base
     def run # rubocop:disable CyclomaticComplexity
       if migration_files.any? && schema_files.none?
-        return :bad, "It looks like you're adding a migration, but did not update the schema file"
+        return :fail, "It looks like you're adding a migration, but did not update the schema file"
       elsif migration_files.none? && schema_files.any?
-        return :bad, "You're trying to change the schema without adding a migration file"
+        return :fail, "You're trying to change the schema without adding a migration file"
       elsif migration_files.any? && schema_files.any?
         latest_version = migration_files.map  { |file| file[/\d+/] }.sort.last
         schema         = schema_files.map     { |file| File.read(file) }.join
         up_to_date     = schema.include?(latest_version)
 
         unless up_to_date
-          return :bad, "The latest migration version you're committing is " \
+          return :fail, "The latest migration version you're committing is " \
                        "#{latest_version}, but your schema file " \
                        "#{schema_files.join(' or ')} is on a different version."
         end
       end
 
-      :good
+      :pass
     end
 
   private

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

@@ -7,7 +7,7 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[rubocop --format=emacs --force-exclusion] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       output = result.stdout + result.stderr
 
@@ -20,7 +20,7 @@ module Overcommit::Hook::PreCommit
         modified_lines(file).include?(line.to_i)
       end
 
-      return :bad, error_lines.join("\n") unless error_lines.empty?
+      return :fail, error_lines.join("\n") unless error_lines.empty?
 
       [:warn, "Modified files have lints (on lines you didn't modify)\n" <<
               warning_lines.join("\n")]

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

@@ -7,7 +7,7 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[scss-lint] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       # Keep lines from the output for files that we actually modified
       error_lines, warning_lines = result.stdout.split("\n").partition do |output_line|
@@ -18,7 +18,7 @@ module Overcommit::Hook::PreCommit
         modified_lines(file).include?(line.to_i)
       end
 
-      return :bad, error_lines.join("\n") unless error_lines.empty?
+      return :fail, error_lines.join("\n") unless error_lines.empty?
 
       [:warn, "Modified files have lints (on lines you didn't modify)\n" <<
               warning_lines.join("\n")]

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

@@ -4,10 +4,10 @@ module Overcommit::Hook::PreCommit
     def run
       result = execute(%w[grep -IHn \s$] + applicable_files)
       unless result.stdout.empty?
-        return :bad, "Trailing whitespace detected:\n#{result.stdout}"
+        return :fail, "Trailing whitespace detected:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

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

@@ -7,9 +7,9 @@ module Overcommit::Hook::PreCommit
       end
 
       result = execute(%w[travis-lint] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
-      [:bad, result.stdout.strip]
+      [:fail, result.stdout.strip]
     end
   end
 end

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

@@ -14,9 +14,9 @@ module Overcommit::Hook::PreCommit
         end
       end
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
-      [:bad, output]
+      [:fail, output]
     end
   end
 end

data/lib/overcommit/hook_context/pre_commit.rb

@@ -16,10 +16,22 @@ module Overcommit::HookContext
       Overcommit::GitRepo.store_cherry_pick_state
 
       if !initial_commit? && any_changes?
+        @stash_attempted = true
+
+        result = Overcommit::Utils.execute(
+          %w[git stash save --keep-index --quiet] +
+          ["Overcommit: Stash of repo state before hook run at #{Time.now}"]
+        )
+
+        unless result.success?
+          # Failure to stash in this case is likely due to a configuration
+          # issue (e.g. author/email not set or GPG signing key incorrect)
+          raise Overcommit::Exceptions::HookSetupFailed,
+                "Unable to setup environment for #{hook_script_name} hook run:" \
+                "\n#{result.stderr}"
+        end
+
         @changes_stashed = true
-        `git stash save --keep-index --quiet #{<<-MSG}`
-          "Overcommit: Stash of repo state before hook run at #{Time.now}"
-        MSG
       end
 
       # While running the hooks make it appear as if nothing changed
@@ -29,7 +41,7 @@ module Overcommit::HookContext
     # Restore unstaged changes and reset file modification times so it appears
     # as if nothing ever changed.
     def cleanup_environment
-      unless initial_commit?
+      unless initial_commit? || (@stash_attempted && !@changes_stashed)
         `git reset --hard &> /dev/null` # Ensure working tree is clean before popping stash
       end
 

data/lib/overcommit/hook_runner.rb

@@ -40,16 +40,16 @@ module Overcommit
         @hooks.each do |hook|
           hook_status = run_hook(hook)
 
-          run_failed = true if hook_status == :bad
+          run_failed = true if [:bad, :fail].include?(hook_status)
 
-          if hook_status == :interrupted
+          if hook_status == :interrupt
             # Stop running any more hooks and assume a bad result
             interrupted = true
             break
           end
         end
 
-        @printer.end_run(interrupted, run_failed)
+        @printer.end_run(run_failed, interrupted)
 
         !(run_failed || interrupted)
       else
@@ -68,12 +68,12 @@ module Overcommit
         # Ctrl-C actually stops the current hook from being run, but doesn't
         # halt the entire process.
         InterruptHandler.disable!
-        status, output = hook.run
+        status, output = hook.run_and_transform
       rescue => ex
-        status = :bad
+        status = :fail
         output = "Hook raised unexpected error\n#{ex.message}"
       rescue Interrupt
-        status = :interrupted
+        status = :interrupt
         output = 'Hook was interrupted by Ctrl-C; restoring repo state...'
       ensure
         InterruptHandler.enable!

data/lib/overcommit/installer.rb

@@ -33,6 +33,7 @@ module Overcommit
       ensure_hooks_directory
       install_master_hook
       install_hook_symlinks
+      install_starter_config
 
       log.success "Successfully installed hooks into #{@target}"
     end
@@ -51,6 +52,8 @@ module Overcommit
       unless FileUtils.compare_file(MASTER_HOOK, master_hook_install_path)
         install_master_hook
         install_hook_symlinks
+
+        log.success "Hooks updated to Overcommit version #{Overcommit::VERSION}"
         true
       end
     end
@@ -119,6 +122,13 @@ module Overcommit
       end
     end
 
+    def install_starter_config
+      repo_config_file = File.join(@target, OVERCOMMIT_CONFIG_FILE_NAME)
+
+      return if File.exist?(repo_config_file)
+      FileUtils.cp(File.join(OVERCOMMIT_HOME, 'config', 'starter.yml'), repo_config_file)
+    end
+
     def overcommit_symlink?(file)
       File.symlink?(file) && File.readlink(file) == 'overcommit-hook'
     rescue Errno::ENOENT

data/lib/overcommit/printer.rb

@@ -54,7 +54,7 @@ module Overcommit
     def end_hook(hook, status, output)
       # Want to print the header for quiet hooks only if the result wasn't good
       # so that the user knows what failed
-      print_header(hook) if hook.quiet? && status != :good
+      print_header(hook) if hook.quiet? && ![:good, :pass].include?(status)
 
       print_result(hook, status, output)
     end
@@ -62,23 +62,40 @@ module Overcommit
   private
 
     def print_header(hook)
+      hook_name = "[#{hook.name}] "
       log.partial hook.description
-      log.partial '.' * (70 - hook.description.length)
+      log.partial '.' * [70 - hook.description.length - hook_name.length, 0].max
+      log.partial hook_name
     end
 
-    def print_result(hook, status, output)
+    def print_result(hook, status, output) # rubocop:disable CyclomaticComplexity, MethodLength
       case status
-      when :good
+      when :pass
         log.success 'OK' unless hook.quiet?
+      when :good
+        log.success 'OK'
+        log.bold_error 'Hook returned a status of `:good`. This is deprecated ' \
+                       'in favor of `:pass` and will be removed in a future ' \
+                       'version of Overcommit'
       when :warn
         log.warning 'WARNING'
         print_report(output, :bold_warning)
       when :bad
         log.error 'FAILED'
+        log.bold_error 'Hook returned a status of `:bad`. This is deprecated ' \
+                       'in favor of `:fail` and will be removed in a future ' \
+                       'version of Overcommit'
         print_report(output, :bold_error)
-      when :interrupted
+      when :fail
+        log.error 'FAILED'
+        print_report(output, :bold_error)
+      when :interrupt
         log.error 'INTERRUPTED'
         print_report(output, :bold_error)
+      else
+        log.error '???'
+        print_report("Hook returned unknown status `#{status.inspect}` -- ignoring.",
+                     :bold_error)
       end
     end
 

data/lib/overcommit/version.rb

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

data/template-dir/hooks/commit-msg

@@ -55,7 +55,7 @@ begin
   # Ensure master hook is up-to-date
   installer = Overcommit::Installer.new(logger)
   if installer.run(Overcommit::Utils.repo_root, :action => :update)
-    exec $0 # Execute the updated hook
+    exec($0, *ARGV) # Execute the updated hook with all original arguments
   end
 
   config = Overcommit::ConfigurationLoader.load_repo_config
@@ -78,6 +78,9 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
+rescue Overcommit::Exceptions::HookSetupFailed => error
+  puts error
+  exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
   exit 1

data/template-dir/hooks/overcommit-hook

@@ -55,7 +55,7 @@ begin
   # Ensure master hook is up-to-date
   installer = Overcommit::Installer.new(logger)
   if installer.run(Overcommit::Utils.repo_root, :action => :update)
-    exec $0 # Execute the updated hook
+    exec($0, *ARGV) # Execute the updated hook with all original arguments
   end
 
   config = Overcommit::ConfigurationLoader.load_repo_config
@@ -78,6 +78,9 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
+rescue Overcommit::Exceptions::HookSetupFailed => error
+  puts error
+  exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
   exit 1

data/template-dir/hooks/post-checkout

@@ -55,7 +55,7 @@ begin
   # Ensure master hook is up-to-date
   installer = Overcommit::Installer.new(logger)
   if installer.run(Overcommit::Utils.repo_root, :action => :update)
-    exec $0 # Execute the updated hook
+    exec($0, *ARGV) # Execute the updated hook with all original arguments
   end
 
   config = Overcommit::ConfigurationLoader.load_repo_config
@@ -78,6 +78,9 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
+rescue Overcommit::Exceptions::HookSetupFailed => error
+  puts error
+  exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
   exit 1

data/template-dir/hooks/pre-commit

@@ -55,7 +55,7 @@ begin
   # Ensure master hook is up-to-date
   installer = Overcommit::Installer.new(logger)
   if installer.run(Overcommit::Utils.repo_root, :action => :update)
-    exec $0 # Execute the updated hook
+    exec($0, *ARGV) # Execute the updated hook with all original arguments
   end
 
   config = Overcommit::ConfigurationLoader.load_repo_config
@@ -78,6 +78,9 @@ rescue Overcommit::Exceptions::HookContextLoadError => error
   puts error
   puts 'Are you running an old version of Overcommit?'
   exit 69 # EX_UNAVAILABLE
+rescue Overcommit::Exceptions::HookSetupFailed => error
+  puts error
+  exit 74 # EX_IOERR
 rescue Overcommit::Exceptions::HookCancelled
   puts 'You cancelled the hook run'
   exit 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +78,7 @@ extra_rdoc_files: []
 files:
 - bin/overcommit
 - config/default.yml
-- config/templates.yml
+- config/starter.yml
 - lib/overcommit.rb
 - lib/overcommit/version.rb
 - lib/overcommit/hook_context.rb

data/config/templates.yml

@@ -1,13 +0,0 @@
----
-default:
-  excludes:
-    commit_msg:
-      - change_id
-      - release_note
-    pre_commit:
-      - causes_email
-      - image_optimization
-      - restricted_paths
-      - test_history
-all:
-  excludes: