overcommit 0.23.0 → 0.24.0

data/lib/overcommit/git_version.rb

@@ -0,0 +1,15 @@
+# Returns the version of the available git binary.
+#
+# This is intended to be used to conveniently execute code based on a specific
+# git version. Simply compare to a version string:
+#
+# @example
+#   if GIT_VERSION <= '1.8.5'
+#     ...
+#   end
+module Overcommit
+  GIT_VERSION = begin
+    version = `git --version`.chomp[/[\d\.]+/, 0]
+    Overcommit::Utils::Version.new(version)
+  end
+end

data/lib/overcommit/hook/base.rb

@@ -39,7 +39,7 @@ module Overcommit::Hook
     # implement `#run`, and we needed a wrapper step to transform the status
     # based on any custom configuration.
     def run_and_transform
-      if output = check_for_executable
+      if output = check_for_requirements
         status = :fail
       else
         status, output = process_hook_return_value(run)
@@ -62,7 +62,7 @@ module Overcommit::Hook
     # @return [Array<Symbol,String>] tuple of status and output
     def process_hook_return_value(hook_return_value)
       if hook_return_value.is_a?(Array) &&
-         hook_return_value.first.is_a?(Message)
+         (hook_return_value.first.is_a?(Message) || hook_return_value.empty?)
         # Process messages into a status and output
         Overcommit::MessageProcessor.new(
           self,
@@ -119,6 +119,10 @@ module Overcommit::Hook
       @config['required_executable']
     end
 
+    def required_libraries
+      Array(@config['required_library'] || @config['required_libraries'])
+    end
+
     # Return command to execute for this hook.
     #
     # This is intended to be configurable so hooks can prefix their commands
@@ -179,18 +183,51 @@ module Overcommit::Hook
       included && !excluded
     end
 
+    # Check for any required executables or libraries.
+    #
+    # Returns output if any requirements are not met.
+    def check_for_requirements
+      check_for_executable || check_for_libraries
+    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 required_executable && !in_path?(required_executable)
 
       output = "'#{required_executable}' is not installed (or is not in your PATH)"
+      output << install_command_prompt
+
+      output
+    end
 
+    def install_command_prompt
       if install_command = @config['install_command']
-        output += "\nInstall it by running: #{install_command}"
+        "\nInstall it by running: #{install_command}"
+      else
+        ''
       end
+    end
 
-      output
+    # If the hook defines required library paths that it wants to load, attempt
+    # to load them.
+    def check_for_libraries
+      output = []
+
+      required_libraries.each do |library|
+        begin
+          require library
+        rescue LoadError
+          install_command = @config['install_command']
+          install_command = " -- install via #{install_command}" if install_command
+
+          output << "Unable to load '#{library}'#{install_command}"
+        end
+      end
+
+      return if output.empty?
+
+      output.join("\n")
     end
 
     # Transforms the hook's status based on custom configuration.
@@ -198,7 +235,7 @@ module Overcommit::Hook
     # This allows users to change failures into warnings, or vice versa.
     def transform_status(status)
       case status
-      when :fail, :bad
+      when :fail
         @config.fetch('on_fail', :fail).to_sym
       when :warn
         @config.fetch('on_warn', :warn).to_sym

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

@@ -0,0 +1,13 @@
+module Overcommit::Hook::CommitMsg
+  # Ensures commit message subject lines start with a capital letter.
+  class CapitalizedSubject < Base
+    def run
+      first_letter = commit_message_lines[0].to_s.match(/^[[:punct:]]*(.)/)[1]
+      unless first_letter.match(/[[:upper:]]/)
+        return :warn, 'Subject should start with a capital letter'
+      end
+
+      :pass
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'tempfile'
+
+module Overcommit::Hook::CommitMsg
+  # Checks the commit message for potential misspellings
+  class SpellCheck < Base
+    Misspelling = Struct.new(:word, :suggestions)
+
+    MISSPELLING_REGEX = /^[&#]\s(?<word>\w+)(?:.+?:\s(?<suggestions>.*))?/
+
+    def run
+      result = execute(command + [uncommented_commit_msg_file])
+      return [:fail, "Error running spellcheck: #{result.stderr.chomp}"] unless result.success?
+
+      misspellings = parse_misspellings(result.stdout)
+      return :pass if misspellings.empty?
+
+      messages = misspellings.map do |misspelled|
+        msg = "Potential misspelling: #{misspelled.word}."
+        msg += " Suggestions: #{misspelled.suggestions}" unless misspelled.suggestions.nil?
+        msg
+      end
+
+      [:warn, messages.join("\n")]
+    end
+
+    private
+
+    def uncommented_commit_msg_file
+      ::Tempfile.open('commit-msg') do |file|
+        file.write(commit_message)
+        file.path
+      end
+    end
+
+    def parse_misspellings(output)
+      output.scan(MISSPELLING_REGEX).map do |word, suggestions|
+        Misspelling.new(word, suggestions)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Overcommit::Hook::PostCheckout
+  # Checks the status of submodules in the current repository and
+  # notifies the user if any are uninitialized, out of date with
+  # the current index, or contain merge conflicts.
+  class SubmoduleStatus < Base
+    def run
+      messages = []
+      submodule_statuses.each do |submodule_status|
+        path = submodule_status.path
+        if submodule_status.uninitialized?
+          messages << "Submodule #{path} is uninitialized."
+        elsif submodule_status.outdated?
+          messages << "Submodule #{path} is out of date with the current index."
+        elsif submodule_status.merge_conflict?
+          messages << "Submodule #{path} has merge conflicts."
+        end
+      end
+
+      return :pass if messages.empty?
+
+      [:warn, messages.join("\n")]
+    end
+
+    private
+
+    def submodule_statuses
+      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
+    end
+  end
+end

data/lib/overcommit/hook/post_commit/submodule_status.rb

@@ -0,0 +1,30 @@
+module Overcommit::Hook::PostCommit
+  # Checks the status of submodules in the current repository and
+  # notifies the user if any are uninitialized, out of date with
+  # the current index, or contain merge conflicts.
+  class SubmoduleStatus < Base
+    def run
+      messages = []
+      submodule_statuses.each do |submodule_status|
+        path = submodule_status.path
+        if submodule_status.uninitialized?
+          messages << "Submodule #{path} is uninitialized."
+        elsif submodule_status.outdated?
+          messages << "Submodule #{path} is out of date with the current index."
+        elsif submodule_status.merge_conflict?
+          messages << "Submodule #{path} has merge conflicts."
+        end
+      end
+
+      return :pass if messages.empty?
+
+      [:warn, messages.join("\n")]
+    end
+
+    private
+
+    def submodule_statuses
+      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
+    end
+  end
+end

data/lib/overcommit/hook/post_merge/submodule_status.rb

@@ -0,0 +1,30 @@
+module Overcommit::Hook::PostMerge
+  # Checks the status of submodules in the current repository and
+  # notifies the user if any are uninitialized, out of date with
+  # the current index, or contain merge conflicts.
+  class SubmoduleStatus < Base
+    def run
+      messages = []
+      submodule_statuses.each do |submodule_status|
+        path = submodule_status.path
+        if submodule_status.uninitialized?
+          messages << "Submodule #{path} is uninitialized."
+        elsif submodule_status.outdated?
+          messages << "Submodule #{path} is out of date with the current index."
+        elsif submodule_status.merge_conflict?
+          messages << "Submodule #{path} has merge conflicts."
+        end
+      end
+
+      return :pass if messages.empty?
+
+      [:warn, messages.join("\n")]
+    end
+
+    private
+
+    def submodule_statuses
+      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
+    end
+  end
+end

data/lib/overcommit/hook/post_rewrite/submodule_status.rb

@@ -0,0 +1,30 @@
+module Overcommit::Hook::PostRewrite
+  # Checks the status of submodules in the current repository and
+  # notifies the user if any are uninitialized, out of date with
+  # the current index, or contain merge conflicts.
+  class SubmoduleStatus < Base
+    def run
+      messages = []
+      submodule_statuses.each do |submodule_status|
+        path = submodule_status.path
+        if submodule_status.uninitialized?
+          messages << "Submodule #{path} is uninitialized."
+        elsif submodule_status.outdated?
+          messages << "Submodule #{path} is out of date with the current index."
+        elsif submodule_status.merge_conflict?
+          messages << "Submodule #{path} has merge conflicts."
+        end
+      end
+
+      return :pass if messages.empty?
+
+      [:warn, messages.join("\n")]
+    end
+
+    private
+
+    def submodule_statuses
+      Overcommit::GitRepo.submodule_statuses(recursive: config['recursive'])
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Overcommit::Hook::PreCommit
   class Base < Overcommit::Hook::Base
     extend Forwardable
 
-    def_delegators :@context, :modified_lines_in_file
+    def_delegators :@context, :modified_lines_in_file, :amendment?
 
     private
 
@@ -32,7 +32,7 @@ module Overcommit::Hook::PreCommit
         end
 
         file = extract_file(match, message)
-        line = extract_line(match, message)
+        line = extract_line(match, message) unless match[:line].nil?
         type = extract_type(match, message, type_categorizer)
 
         Overcommit::Hook::Message.new(type, file, line, message)

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

@@ -16,7 +16,7 @@ module Overcommit::Hook::PreCommit
 
       result = execute(%w[git diff --quiet --] + [LOCK_FILE])
       unless result.success?
-        return :fail, "#{LOCK_FILE} is not up-to-date -- run `#{command.join(' ')} check`"
+        return :fail, "#{LOCK_FILE} is not up-to-date -- run `#{command.join(' ')}`"
       end
 
       :pass

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

@@ -0,0 +1,20 @@
+module Overcommit::Hook::PreCommit
+  # Checks for files that would conflict in case-insensitive filesystems
+  # Adapted from https://github.com/pre-commit/pre-commit-hooks
+  class CaseConflicts < Base
+    def run
+      paths = Set.new(applicable_files.map { |file| File.dirname(file) + File::SEPARATOR })
+      repo_files = Set.new(Overcommit::GitRepo.list_files(paths.to_a) + applicable_files)
+      conflict_hash = repo_files.classify(&:downcase).
+        select { |_, files| files.size > 1 }
+      conflict_files = applicable_files.
+        select { |file| conflict_hash.include?(file.downcase) }
+
+      conflict_files.map do |file|
+        conflicts = conflict_hash[file.downcase].map { |f| File.basename(f) }
+        msg = "Conflict detected for case-insensitive file systems: #{conflicts.join(', ')}"
+        Overcommit::Hook::Message.new(:error, file, nil, msg)
+      end
+    end
+  end
+end

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

@@ -3,9 +3,36 @@ module Overcommit::Hook::PreCommit
   class CoffeeLint < Base
     def run
       result = execute(command + applicable_files)
-      return :pass if result.success?
 
-      [:fail, result.stdout]
+      begin
+        parse_json_messages(result.stdout)
+      rescue JSON::ParserError => e
+        [:fail, "Error parsing coffeelint output: #{e.message}"]
+      end
+    end
+
+    private
+
+    def parse_json_messages(output)
+      JSON.parse(output).collect do |file, messages|
+        messages.collect { |msg| extract_message(file, msg) }
+      end.flatten
+    end
+
+    def extract_message(file, message_hash)
+      type = message_hash['level'].include?('w') ? :warning : :error
+      line = message_hash['lineNumber']
+      rule = message_hash['rule']
+      msg = message_hash['message']
+      text =
+        if rule == 'coffeescript_error'
+          # Syntax errors are output in different format.
+          # Splice in the file name and grab the first line.
+          msg.sub('[stdin]', file).split("\n")[0]
+        else
+          "#{file}:#{line}: #{msg} (#{rule})"
+        end
+      Overcommit::Hook::Message.new(type, file, line, text)
     end
   end
 end

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

@@ -13,17 +13,10 @@ module Overcommit::Hook::PreCommit
       return :pass if result.success? && output.empty?
 
       extract_messages(
-        output.split("\n").collect(&method(:add_line_number)),
+        output.split("\n").reject(&:empty?),
         MESSAGE_REGEX,
         lambda { |type| type.downcase.to_sym }
       )
     end
-
-    private
-
-    # Hack to include messages that apply to the entire file
-    def add_line_number(message)
-      message.sub(/(?<!\d,\s)(Error|Warning)/, 'line 0, \1')
-    end
   end
 end

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

@@ -3,10 +3,16 @@ module Overcommit::Hook::PreCommit
   class GoLint < Base
     def run
       result = execute(command + applicable_files)
+      output = result.stdout + result.stderr
       # Unfortunately the exit code is always 0
-      return :pass if result.stdout.empty?
+      return :pass if output.empty?
 
-      [:fail, result.stdout]
+      # example message:
+      #   path/to/file.go:1:1: Error message
+      extract_messages(
+        output.split("\n"),
+        /^(?<file>[^:]+):(?<line>\d+)/
+      )
     end
   end
 end

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

@@ -0,0 +1,20 @@
+module Overcommit::Hook::PreCommit
+  # Runs `go vet` against any modified Golang files.
+  class GoVet < Base
+    def run
+      result = execute(command + applicable_files)
+      return :pass if result.success?
+
+      if result.stderr =~ /no such tool "vet"/
+        return :fail, "`go tool vet` is not installed#{install_command_prompt}"
+      end
+
+      # example message:
+      #   path/to/file.go:7: Error message
+      extract_messages(
+        result.stderr.split("\n"),
+        /^(?<file>[^:]+):(?<line>\d+)/
+      )
+    end
+  end
+end

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

@@ -11,19 +11,10 @@ module Overcommit::Hook::PreCommit
     def run
       # example message:
       #   line 4 column 24 - Warning: <html> proprietary attribute "class"
-      messages = collect_messages
-
-      return :pass if messages.empty?
-
-      messages
-    end
-
-    private
-
-    def collect_messages
       applicable_files.collect do |file|
         result = execute(command + [file])
         output = result.stderr.chomp
+
         extract_messages(
           output.split("\n").collect { |msg| "#{file}: #{msg}" },
           MESSAGE_REGEX,