overcommit 0.22.0 → 0.23.0

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

@@ -0,0 +1,19 @@
+module Overcommit::Hook::PreCommit
+  # Runs `pep8` against any modified Python files.
+  class Pep8 < Base
+    def run
+      result = execute(command + applicable_files)
+      output = result.stdout.chomp
+
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.py:88:5: E301 expected 1 blank line, found 0
+      extract_messages(
+        output.split("\n"),
+        /^(?<file>[^:]+):(?<line>\d+):\d+:\s(?<type>E|W)/,
+        lambda { |type| type.include?('W') ? :warning : :error }
+      )
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Overcommit::Hook::PreCommit
+  # Runs `pyflakes` against any modified Python files.
+  class Pyflakes < Base
+    MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+):/
+
+    def run
+      result = execute(command + applicable_files)
+      return :pass if result.success?
+
+      errors = get_messages(result.stderr, :error)
+      warnings = get_messages(result.stdout, :warning)
+
+      errors + warnings
+    end
+
+    private
+
+    def get_messages(output, type)
+      # example message:
+      #   path/to/file.py:57: local variable 'x' is assigned to but never used
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX,
+        proc { type }
+      )
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Overcommit::Hook::PreCommit
+  # Runs `pylint` against any modified Python files.
+  class Pylint < Base
+    MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):(?<type>[CEFRW])/
+
+    # Classify 'E' and 'F' message codes as errors,
+    # everything else as warnings.
+    #   http://pylint.readthedocs.org/en/latest/tutorial.html#getting-started
+    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
+      'EF'.include?(type) ? :error : :warning
+    end
+
+    def run
+      result = execute(command + applicable_files)
+      return :pass if result.success?
+
+      output = result.stdout.chomp
+
+      # example message:
+      #   path/to/file.py:64:C: Missing function docstring (missing-docstring)
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX,
+        MESSAGE_TYPE_CATEGORIZER
+      )
+    end
+  end
+end

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

@@ -1,11 +1,28 @@
 module Overcommit::Hook::PreCommit
   # Runs `flake8` against any modified Python files.
   class PythonFlake8 < Base
+    MESSAGE_REGEX = /^(?<file>.+):(?<line>\d+):\d+:\s(?<type>\w\d+)/
+
+    # Classify 'Exxx' and 'Fxxx' message codes as errors,
+    # everything else as warnings.
+    #   http://flake8.readthedocs.org/en/latest/warnings.html
+    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
+      'EF'.include?(type[0]) ? :error : :warning
+    end
+
     def run
       result = execute(command + applicable_files)
       return :pass if result.success?
 
-      [:fail, result.stdout]
+      output = result.stdout.chomp
+
+      # example message:
+      #   path/to/file.py:2:13: F812 list comprehension redefines name from line 1
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX,
+        MESSAGE_TYPE_CATEGORIZER
+      )
     end
   end
 end

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

@@ -0,0 +1,26 @@
+module Overcommit::Hook::PreCommit
+  # Runs `scalastyle` against any modified Scala files.
+  class Scalastyle < Base
+    MESSAGE_REGEX = /
+      ^(?<type>error|warning)\s
+      file=(?<file>.+)\s
+      message=.+\s
+      line=(?<line>\d+)
+    /x
+
+    def run
+      result = execute(command + applicable_files)
+      output = result.stdout.chomp
+      messages = output.split("\n").grep(MESSAGE_REGEX)
+      return :pass if result.success? && messages.empty?
+
+      # example message:
+      #   error file=/path/to/file.scala message=Error message line=1 column=1
+      extract_messages(
+        messages,
+        MESSAGE_REGEX,
+        lambda { |type| type.to_sym }
+      )
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Overcommit::Hook::PreCommit
+  # Runs `semistandard` against any modified JavaScript files.
+  class SemiStandard < Base
+    def run
+      result = execute(command + applicable_files)
+      output = result.stderr.chomp
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.js:1:1: Error message (ruleName)
+      extract_messages(
+        output.split("\n")[1..-1], # ignore header line
+        /^(?<file>[^:]+):(?<line>\d+)/
+      )
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Overcommit::Hook::PreCommit
+  # Runs `standard` against any modified JavaScript files.
+  class Standard < Base
+    def run
+      result = execute(command + applicable_files)
+      output = result.stderr.chomp
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.js:1:1: Error message (ruleName)
+      extract_messages(
+        output.split("\n")[1..-1], # ignore header line
+        /^(?<file>[^:]+):(?<line>\d+)/
+      )
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Overcommit::Hook::PreCommit
+  # Runs `w3c_validators` against any modified CSS files.
+  class W3cCss < Base
+    def run
+      begin
+        require 'w3c_validators'
+      rescue LoadError
+        return :fail, 'w3c_validators not installed -- run `gem install w3c_validators`'
+      end
+
+      result_messages =
+        begin
+          collect_messages
+        rescue W3CValidators::ValidatorUnavailable => e
+          return :fail, e.message
+        rescue W3CValidators::ParsingError => e
+          return :fail, e.message
+        end
+
+      return :pass if result_messages.empty?
+
+      result_messages
+    end
+
+    private
+
+    def collect_messages
+      applicable_files.collect do |path|
+        results = validator.validate_file(path)
+        messages = results.errors + results.warnings
+        messages.collect do |msg|
+          # Some warnings are not per-line, so use 0 as a default
+          line = Integer(msg.line || 0)
+
+          # Build message by hand to reduce noise from the validator response
+          text = "#{msg.type.to_s.upcase}; URI: #{path}; line #{line}: #{msg.message.strip}"
+          Overcommit::Hook::Message.new(msg.type, path, line, text)
+        end
+      end.flatten
+    end
+
+    def validator
+      unless @validator
+        @validator = W3CValidators::CSSValidator.new(opts)
+        @validator.set_language!(language) unless language.nil?
+        @validator.set_profile!(profile) unless profile.nil?
+        @validator.set_warn_level!(warn_level) unless warn_level.nil?
+      end
+      @validator
+    end
+
+    def opts
+      @opts ||= {
+        validator_uri: config['validator_uri'],
+        proxy_server:  config['proxy_server'],
+        proxy_port:    config['proxy_port'],
+        proxy_user:    config['proxy_user'],
+        proxy_pass:    config['proxy_pass']
+      }
+    end
+
+    def language
+      @language ||= config['language']
+    end
+
+    # Values specified at
+    #   http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#CSS_PROFILES
+    def profile
+      @profile ||= config['profile']
+    end
+
+    # One of 0, 1, 2, 'no'
+    def warn_level
+      @warn_level ||= config['warn_level']
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Overcommit::Hook::PreCommit
+  # Runs `w3c_validators` against any modified HTML files.
+  class W3cHtml < Base
+    def run
+      begin
+        require 'w3c_validators'
+      rescue LoadError
+        return :fail, 'w3c_validators not installed -- run `gem install w3c_validators`'
+      end
+
+      result_messages =
+        begin
+          collect_messages
+        rescue W3CValidators::ValidatorUnavailable => e
+          return :fail, e.message
+        rescue W3CValidators::ParsingError => e
+          return :fail, e.message
+        end
+
+      return :pass if result_messages.empty?
+
+      result_messages
+    end
+
+    private
+
+    def collect_messages
+      applicable_files.collect do |path|
+        results = validator.validate_file(path)
+        messages = results.errors + results.warnings
+        messages.collect do |msg|
+          # Some warnings are not per-line, so use 0 as a default
+          line = Integer(msg.line || 0)
+
+          # Build message by hand to reduce noise from the validator response
+          text = "#{msg.type.to_s.upcase}; URI: #{path}; line #{line}: #{msg.message.strip}"
+          Overcommit::Hook::Message.new(msg.type, path, line, text)
+        end
+      end.flatten
+    end
+
+    def validator
+      unless @validator
+        @validator = W3CValidators::MarkupValidator.new(opts)
+        @validator.set_charset!(charset, true) unless charset.nil?
+        @validator.set_doctype!(doctype, true) unless doctype.nil?
+        @validator.set_debug!
+      end
+      @validator
+    end
+
+    def opts
+      @opts ||= {
+        validator_uri: config['validator_uri'],
+        proxy_server:  config['proxy_server'],
+        proxy_port:    config['proxy_port'],
+        proxy_user:    config['proxy_user'],
+        proxy_pass:    config['proxy_pass']
+      }
+    end
+
+    # Values specified at
+    #   http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#CHARSETS
+    def charset
+      @charset ||= config['charset']
+    end
+
+    # Values specified at
+    #   http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#DOCTYPES
+    def doctype
+      @doctype ||= config['doctype']
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Overcommit::Hook::PreCommit
+  # Runs `xmllint` against any modified XML files.
+  class XmlLint < Base
+    MESSAGE_REGEX = /^(?<file>[^:]+):(?<line>\d+):/
+
+    def run
+      result = execute(command + applicable_files)
+      output = result.stderr.chomp
+
+      return :pass if result.success? && output.empty?
+
+      # example message:
+      #   path/to/file.xml:1: parser error : Error message
+      extract_messages(
+        output.split("\n").grep(MESSAGE_REGEX),
+        MESSAGE_REGEX
+      )
+    end
+  end
+end

data/lib/overcommit/hook_context/post_commit.rb

@@ -0,0 +1,31 @@
+module Overcommit::HookContext
+  # Contains helpers related to contextual information used by post-commit
+  # hooks.
+  class PostCommit < Base
+    # Get a list of files that were added, copied, or modified in the last
+    # commit. Renames and deletions are ignored, since there should be nothing
+    # to check.
+    def modified_files
+      subcmd = 'show --format=%n'
+      @modified_files ||= Overcommit::GitRepo.modified_files(subcmd: subcmd)
+    end
+
+    # Returns the set of line numbers corresponding to the lines that were
+    # changed in a specified file.
+    def modified_lines_in_file(file)
+      subcmd = 'show --format=%n'
+      @modified_lines ||= {}
+      @modified_lines[file] ||=
+        Overcommit::GitRepo.extract_modified_lines(file, subcmd: subcmd)
+    end
+
+    # Returns whether the commit that triggered this hook is the first commit on
+    # the branch.
+    #
+    # @return [true,false]
+    def initial_commit?
+      return @initial_commit unless @initial_commit.nil?
+      @initial_commit = !Overcommit::Utils.execute(%w[git rev-parse HEAD~]).success?
+    end
+  end
+end

data/lib/overcommit/hook_context/post_merge.rb

@@ -0,0 +1,35 @@
+module Overcommit::HookContext
+  # Contains helpers related to contextual information used by post-merge
+  # hooks.
+  class PostMerge < Base
+    attr_accessor :args
+    # Get a list of files that were added, copied, or modified in the merge
+    # commit. Renames and deletions are ignored, since there should be nothing
+    # to check.
+    def modified_files
+      staged = squash?
+      refs = 'HEAD^ HEAD' if merge_commit?
+      @modified_files ||= Overcommit::GitRepo.modified_files(staged: staged, refs: refs)
+    end
+
+    # Returns the set of line numbers corresponding to the lines that were
+    # changed in a specified file.
+    def modified_lines_in_file(file)
+      staged = squash?
+      refs = 'HEAD^ HEAD' if merge_commit?
+      @modified_lines ||= {}
+      @modified_lines[file] ||=
+        Overcommit::GitRepo.extract_modified_lines(file, staged: staged, refs: refs)
+    end
+
+    # Returns whether this merge was made using --squash
+    def squash?
+      @args[0].to_i == 1
+    end
+
+    # Returns whether this merge was made without --squash
+    def merge_commit?
+      !squash?
+    end
+  end
+end

data/lib/overcommit/hook_context/post_rewrite.rb

@@ -0,0 +1,18 @@
+module Overcommit::HookContext
+  # Contains helpers for contextual information used by post-rewrite hooks.
+  class PostRewrite < Base
+    # Returns whether this post-rewrite was triggered by `git commit --amend`.
+    #
+    # @return [true,false]
+    def amend?
+      @args[0] == 'amend'
+    end
+
+    # Returns whether this post-rewrite was triggered by `git rebase`.
+    #
+    # @return [true,false]
+    def rebase?
+      @args[0] == 'rebase'
+    end
+  end
+end

data/lib/overcommit/hook_context/run_all.rb

@@ -6,16 +6,18 @@ module Overcommit::HookContext
   # This results in pre-commit hooks running against the entire repository,
   # which is useful for automated CI scripts.
   class RunAll < Base
-    EMPTY_SET = Set.new
-
     def modified_files
-      all_files
+      @modified_files ||= Overcommit::GitRepo.all_files
     end
 
-    # Return an empty set since in this context the user didn't actually touch
-    # any lines.
-    def modified_lines_in_file(_file)
-      EMPTY_SET
+    # Returns all lines in the file since in this context the entire repo is
+    # being scrutinized.
+    #
+    # @param file [String]
+    # @return [Set]
+    def modified_lines_in_file(file)
+      @modified_lines_in_file ||= {}
+      @modified_lines_in_file[file] ||= Set.new(1..(count_lines(file) + 1))
     end
 
     def hook_class_name
@@ -32,8 +34,9 @@ module Overcommit::HookContext
 
     private
 
-    def all_files
-      @all_files ||= Overcommit::GitRepo.all_files
+    def count_lines(file)
+      result = Overcommit::Utils.execute(%w[wc -l] + [file])
+      result.success? ? result.stdout.to_i : 0
     end
   end
 end

data/lib/overcommit/utils.rb

@@ -101,19 +101,38 @@ module Overcommit
         false
       end
 
-      # Wrap external subshell calls. This is necessary in order to allow
-      # Overcommit to call other Ruby executables without requiring that they be
-      # specified in Overcommit's Gemfile--a nasty consequence of using
-      # `bundle exec overcommit` while developing locally.
+      # Execute a command in a subprocess, capturing exit status and output from
+      # both standard and error streams.
+      #
+      # This is intended to provide a centralized place to perform any checks or
+      # filtering of the command before executing it.
+      #
+      # @param args [Array<String>]
+      # @return [Overcommit::Subprocess::Result] status, stdout, and stderr
       def execute(args)
         if args.include?('|')
           raise Overcommit::Exceptions::InvalidCommandArgs,
                 'Cannot pipe commands with the `execute` helper'
         end
 
-        with_environment 'RUBYOPT' => nil do
-          Subprocess.spawn(args)
+        Subprocess.spawn(args)
+      end
+
+      # Execute a command in a subprocess, returning immediately.
+      #
+      # This provides a convenient way to execute long-running processes for
+      # which we do not need to know the result.
+      #
+      # @param args [Array<String>]
+      # @return [Thread] thread watching the resulting child process
+      def execute_in_background(args)
+        if args.include?('|')
+          raise Overcommit::Exceptions::InvalidCommandArgs,
+                'Cannot pipe commands with the `execute_in_background` helper'
         end
+
+        # Dissociate process from parent's input/output streams
+        Process.detach(Process.spawn({}, *args, [:in, :out, :err] => '/dev/null'))
       end
 
       # Calls a block of code with a modified set of environment variables,

data/lib/overcommit/version.rb

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

data/template-dir/hooks/post-commit

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+# Entrypoint for Overcommit hook integration. Installing Overcommit will result
+# in all of your git hooks being symlinked to this file, allowing the framework
+# to manage your hooks for you.
+
+# Prevent a Ruby stack trace from appearing when we interrupt the hook.
+# Note that this will be overridden when Overcommit is loaded, since the
+# InterruptHandler will redefine the trap at that time.
+Signal.trap('INT') do
+  puts 'Hook run interrupted'
+  exit 130
+end
+
+# Allow hooks to be disabled via environment variable so git commands can be run
+# in scripts without Overcommit running hooks
+if ENV['OVERCOMMIT_DISABLE'].to_i != 0 || ENV['OVERCOMMIT_DISABLED'].to_i != 0
+  exit
+end
+
+hook_type = File.basename($0)
+if hook_type == 'overcommit-hook'
+  puts "Don't run `overcommit-hook` directly; it is intended to be symlinked " \
+       "by each hook in a repository's .git/hooks directory."
+  exit 64 # EX_USAGE
+end
+
+begin
+  require 'overcommit'
+rescue LoadError
+  puts 'This repository contains hooks installed by Overcommit, but the ' \
+       "overcommit gem is not installed.\n" \
+       'Install it with `gem install overcommit`.'
+  exit
+end
+
+begin
+  logger = Overcommit::Logger.new(STDOUT)
+
+  # Ensure master hook is up-to-date
+  installer = Overcommit::Installer.new(logger)
+  if installer.run(Overcommit::Utils.repo_root, action: :update)
+    exec($0, *ARGV) # Execute the updated hook with all original arguments
+  end
+
+  config = Overcommit::ConfigurationLoader.load_repo_config
+
+  context = Overcommit::HookContext.create(hook_type, config, ARGV)
+  config.apply_environment!(context, ENV)
+
+  printer = Overcommit::Printer.new(logger, context)
+  runner = Overcommit::HookRunner.new(config, logger, context, printer)
+
+  status = runner.run
+
+  exit(status ? 0 : 65) # 65 = EX_DATAERR
+rescue Overcommit::Exceptions::ConfigurationError => error
+  puts error
+  exit 78 # EX_CONFIG
+rescue Overcommit::Exceptions::HookContextLoadError => error
+  puts error
+  puts 'Are you running an old version of Overcommit?'
+  exit 69 # EX_UNAVAILABLE
+rescue Overcommit::Exceptions::HookSetupFailed,
+       Overcommit::Exceptions::HookCleanupFailed => error
+  puts error.message
+  exit 74 # EX_IOERR
+rescue Overcommit::Exceptions::HookCancelled
+  puts 'You cancelled the hook run'
+  exit 130 # Ctrl-C cancel
+rescue Overcommit::Exceptions::InvalidGitRepo => error
+  puts error
+  exit 64 # EX_USAGE
+rescue Overcommit::Exceptions::InvalidHookSignature
+  exit 1
+rescue => error
+  puts error.message
+  puts error.backtrace
+  puts "Report this bug at #{Overcommit::BUG_REPORT_URL}"
+  exit 70 # EX_SOFTWARE
+end