Deprecate :good status in favor of :pass

Similar to the deprecation of `:bad`, we want to standardize on verbs
for statuses going forward.

Change-Id: Iee9df48a6ea6050b5148dd3a8fdcb9fd05577c91
Reviewed-on: http://gerrit.causes.com/40975
Tested-by: jenkins <jenkins@causes.com>
Reviewed-by: Shane da Silva <shane.dasilva@brigade.com>

Author: sds

CHANGELOG.md

@@ -9,6 +9,8 @@
   updated hook
 * Display message when `overcommit-hook` file is automatically updated
 * Deprecate `:bad` status in favor of `:fail`
+Blah
+* Deprecate `:good` status in favor of `:pass`
 
 ## 0.14.1
 

README.md

@@ -194,7 +194,7 @@ module Overcommit::Hook::PreCommit
 
     return :fail, errors.join("\n") if errors.any?
 
-    :good
+    :pass
   end
 end
 ```

lib/overcommit/hook/commit_msg/gerrit_change_id.rb

@@ -10,7 +10,7 @@ class GerritChangeId < Base
 
     def run
       result = execute([SCRIPT_LOCATION, commit_message_file])
-      return :good if result.success?
+      return :pass if result.success?
 
       [:fail, result.stdout]
     end

lib/overcommit/hook/commit_msg/hard_tabs.rb

@@ -7,7 +7,7 @@ def run
         return :warn, "Don't use hard tabs in commit messages"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/commit_msg/russian_novel.rb

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

lib/overcommit/hook/commit_msg/single_line_subject.rb

@@ -6,7 +6,7 @@ def run
         return :warn, 'Subject should be one line and followed by a blank line'
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/commit_msg/text_width.rb

@@ -25,7 +25,7 @@ def run
 
       return :warn, errors.join("\n") if errors.any?
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/commit_msg/trailing_period.rb

@@ -6,7 +6,7 @@ def run
         return :warn, 'Please omit trailing period from commit message subject'
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/post_checkout/bundle_check.rb

@@ -11,7 +11,7 @@ def run
         return :warn, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
       end
 
-      :good
+      :pass
     end
 
   private

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

lib/overcommit/hook/pre_commit/author_email.rb

@@ -12,7 +12,7 @@ def run
                '`git config --global user.email your_email@example.com`'
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/author_name.rb

@@ -11,7 +11,7 @@ def run
                "\nSet your name with `git config --global user.name 'Your Name'`"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/berksfile_check.rb

@@ -11,14 +11,14 @@ def run
 
       # 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 :fail, result.stderr
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/brakeman.rb

@@ -8,7 +8,7 @@ def run
 
       result = execute(%w[brakeman --exit-on-warn --quiet --summary --only-files] +
                        applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       [:fail, result.stdout]
     end

lib/overcommit/hook/pre_commit/bundle_check.rb

@@ -11,7 +11,7 @@ def run
 
       # 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?
@@ -23,7 +23,7 @@ def run
         return :fail, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/chamber_security.rb

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

lib/overcommit/hook/pre_commit/coffee_lint.rb

@@ -7,7 +7,7 @@ def run
       end
 
       result = execute(%w[coffeelint --quiet] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       [:fail, result.stdout]
     end

lib/overcommit/hook/pre_commit/css_lint.rb

@@ -7,7 +7,7 @@ def run
       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)/
 
       [:fail, result.stdout]
     end

lib/overcommit/hook/pre_commit/go_lint.rb

@@ -8,7 +8,7 @@ def run
 
       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?
 
       [:fail, result.stdout]
     end

lib/overcommit/hook/pre_commit/haml_lint.rb

@@ -7,7 +7,7 @@ def run
       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|

lib/overcommit/hook/pre_commit/hard_tabs.rb

@@ -8,7 +8,7 @@ def run
         return :fail, "Hard tabs detected:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/image_optim.rb

@@ -22,7 +22,7 @@ def run
           "  image_optim #{optimized_images.join(' ')}"
       end
 
-      :good
+      :pass
     end
 
   private

lib/overcommit/hook/pre_commit/js_hint.rb

@@ -9,7 +9,7 @@ def run
       result = execute(%w[jshint] + applicable_files)
       output = result.stdout
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
       [:fail, output]
     end

lib/overcommit/hook/pre_commit/jscs.rb

@@ -8,7 +8,7 @@ def run
       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

lib/overcommit/hook/pre_commit/json_syntax.rb

@@ -14,7 +14,7 @@ def run
         end
       end
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
       [:fail, output]
     end

lib/overcommit/hook/pre_commit/jsx_hint.rb

@@ -9,7 +9,7 @@ def run
       result = execute(%w[jsxhint] + applicable_files)
       output = result.stdout
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
       [:fail, output]
     end

lib/overcommit/hook/pre_commit/local_paths_in_gemfile.rb

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

lib/overcommit/hook/pre_commit/merge_conflicts.rb

@@ -8,7 +8,7 @@ def run
         return :fail, "Merge conflict markers detected:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/pry_binding.rb

@@ -8,7 +8,7 @@ def run
         return :fail, "Found a `binding.pry` call left in:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/python_flake8.rb

@@ -7,7 +7,7 @@ def run
       end
 
       result = execute(%w[flake8] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       [:fail, result.stdout]
     end

lib/overcommit/hook/pre_commit/rails_schema_up_to_date.rb

@@ -18,7 +18,7 @@ def run # rubocop:disable CyclomaticComplexity
         end
       end
 
-      :good
+      :pass
     end
 
   private

lib/overcommit/hook/pre_commit/rubocop.rb

@@ -7,7 +7,7 @@ def run
       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
 

lib/overcommit/hook/pre_commit/scss_lint.rb

@@ -7,7 +7,7 @@ def run
       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|

lib/overcommit/hook/pre_commit/trailing_whitespace.rb

@@ -7,7 +7,7 @@ def run
         return :fail, "Trailing whitespace detected:\n#{result.stdout}"
       end
 
-      :good
+      :pass
     end
   end
 end

lib/overcommit/hook/pre_commit/travis_lint.rb

@@ -7,7 +7,7 @@ def run
       end
 
       result = execute(%w[travis-lint] + applicable_files)
-      return :good if result.success?
+      return :pass if result.success?
 
       [:fail, result.stdout.strip]
     end

lib/overcommit/hook/pre_commit/yaml_syntax.rb

@@ -14,7 +14,7 @@ def run
         end
       end
 
-      return :good if output.empty?
+      return :pass if output.empty?
 
       [:fail, output]
     end

lib/overcommit/printer.rb

@@ -54,7 +54,7 @@ def required_hook_not_skipped(hook)
     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
@@ -68,8 +68,13 @@ def print_header(hook)
 
     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)

spec/overcommit/hook_signer_spec.rb

@@ -16,7 +16,7 @@
       module Overcommit::Hook::PreCommit
         class SomeHook
           def run
-            :good
+            :pass
           end
         end
       end

spec/support/matchers/hook.rb

@@ -61,7 +61,7 @@ def failure_message(actual, error_message)
 end
 
 RSpec::Matchers.define :pass do |*args|
-  check_matcher = HookMatcher.new(:good, args)
+  check_matcher = HookMatcher.new(:pass, args)
 
   match do
     check_matcher.matches?(actual)