overcommit 0.50.0 → 0.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f824ec83fa10a7b483e568728c32d9e2c15105d36bad7d76b4cb6ff3f162186e
-  data.tar.gz: a625d3bc126d5004119d534b31643ab5efc514b654f879afe2849816dd6eb673
+  metadata.gz: 0efc67b235f1b64200fb3f1980dbbffdadafe330138488842faba82901de4536
+  data.tar.gz: 75e7f62941308e828f498906bd5b8681b9a238336a616aa4c9c69465db4411d5
 SHA512:
-  metadata.gz: 189cce42c8f838a56d74602acad8d549ee08734f11fcfd76f744a32c5b15799c35c0ee1316ec2fb3270679b07b70af97834e7e6ce38ec38d9301b0d0c22fc9fb
-  data.tar.gz: 136a4b200e1d74532c01a8b850b20f98624ba03cb6ef0e08bb633fcbd5cea86b1d730010fd7bd358fa2400497486003fa013b4d2d75106b26876eb565d15e45e
+  metadata.gz: 92d6182180b1ea2888f3e93124f011fa22ac6af31e610ed8537e1432a46b2ef731a525743ad39fa3981b772d324504665fd3c391bd157eda305a951962d8bbf9
+  data.tar.gz: ddc6c719c3662f64f9e80d671acf6958e6a9aa75b873d8cef948b17f71d81ae33025cedaa4f1770a7bb39523c1a497bbfff8ebb1e59351e5168be41a31259e26

data/config/default.yml

@@ -337,6 +337,23 @@ PreCommit:
     flags: ['-IEHnw']
     keywords: ['FContext','FDescribe','FIt','FMeasure','FSpecify','FWhen']
 
+  GoFmt:
+    enabled: true
+    description: 'Fix with go fmt'
+    required_executable: 'go'
+    command: ['go', 'fmt']
+    parallelize: false
+    include: '**/*.go'
+
+  GolangciLint:
+    enabled: false
+    description: 'Analyze with golangci-lint'
+    required_executable: 'golangci-lint'
+    install_command: 'go get github.com/golangci/golangci-lint/cmd/golangci-lint'
+    flags: ['--out-format=line-number', '--print-issued-lines=false']
+    command: ['golangci-lint', 'run']
+    include: '**/*.go'
+
   GoLint:
     enabled: false
     description: 'Analyze with golint'
@@ -868,7 +885,7 @@ PreCommit:
     enabled: false
     description: 'Analyze with YAMLlint'
     required_executable: 'yamllint'
-    flags: ['--format=parsable']
+    flags: ['--format=parsable', '--strict']
     install_command: 'pip install yamllint'
     include:
       - '**/*.yaml'
@@ -1253,6 +1270,20 @@ PrePush:
     required_executable: 'git-lfs'
     install_command: 'brew install git-lfs'
 
+  GolangciLint:
+    enabled: false
+    description: 'Analyze with golangci-lint'
+    required_executable: 'golangci-lint'
+    install_command: 'go get github.com/golangci/golangci-lint/cmd/golangci-lint'
+    flags: ['--out-format=line-number', '--print-issued-lines=false']
+    command: ['golangci-lint', 'run']
+
+  GoTest:
+    enabled: false
+    description: 'Run go test suite'
+    required_executable: 'go'
+    command: ['go', 'test', './...']
+
   Minitest:
     enabled: false
     description: 'Run Minitest test suite'
@@ -1266,6 +1297,13 @@ PrePush:
     flags: ['--bootstrap', 'vendor/autoload.php', 'tests']
     install_command: 'composer require --dev phpunit/phpunit'
 
+  Pronto:
+    enabled: false
+    description: 'Analyzing with pronto'
+    required_executable: 'pronto'
+    install_command: 'gem install pronto'
+    flags: ['run', '--exit-code']
+
   ProtectedBranches:
     enabled: false
     description: 'Check for illegal pushes to protected branches'

data/lib/overcommit/hook/base.rb

@@ -79,12 +79,18 @@ module Overcommit::Hook
       @config['enabled'] != false
     end
 
+    def excluded?
+      exclude_branches.any? { |p| File.fnmatch(p, current_branch) }
+    end
+
     def skip?
-      @config['skip']
+      @config['skip'] ||
+        (@config['skip_if'] ? execute(@config['skip_if']).success? : false)
     end
 
     def run?
       enabled? &&
+      !excluded? &&
         !(@config['requires_files'] && applicable_files.empty?)
     end
 
@@ -276,5 +282,13 @@ module Overcommit::Hook
         status
       end
     end
+
+    def exclude_branches
+      @config['exclude_branches'] || []
+    end
+
+    def current_branch
+      @current_branch ||= Overcommit::GitRepo.current_branch
+    end
   end
 end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs go fmt for all modified Go files
+  class GoFmt < Base
+    def run
+      errors = []
+      applicable_files.each do |file|
+        result = execute(command, args: [file])
+        errors << (result.stdout + result.stderr) unless result.success?
+      end
+      return :pass if errors.empty?
+
+      [:fail, errors.join("\n")]
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PreCommit
+  # Runs `golangci-lint run` against any modified packages
+  #
+  # @see https://github.com/golangci/golangci-lint
+  class GolangciLint < Base
+    def run
+      packages = applicable_files.map { |f| File.dirname(f) }.uniq
+      result = execute(command, args: packages)
+      return :pass if result.success?
+      return [:fail, result.stderr] unless result.stderr.empty?
+
+      extract_messages(
+        result.stdout.split("\n"),
+        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)/,
+        nil
+      )
+    end
+  end
+end

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

@@ -19,9 +19,9 @@ module Overcommit::Hook::PreCommit
       json_messages.map do |message|
         Overcommit::Hook::Message.new(
           :error,
-          message[:filename],
-          message[:line],
-          message[:description]
+          message['filename'],
+          message['line'],
+          "#{message['filename']}:#{message['line']} #{message['rule']} #{message['description']}"
         )
       end
     end

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

@@ -12,21 +12,14 @@ module Overcommit::Hook::PreCommit
     def run
       messages = []
 
-      applicable_files.each do |file|
-        result = execute(command, args: [file])
-        if result.status
-          rows = result.stdout.split("\n")
-
-          # Discard the csv header
-          rows.shift
-
-          # Push each of the errors in the particular file into the array
-          rows.map do |row|
-            messages << row
-          end
-        end
+      result = execute(command, args: applicable_files)
+      if result.status
+        messages = result.stdout.split("\n")
+        # Discard the csv header
+        messages.shift
       end
 
+      return :fail if messages.empty? && !result.success?
       return :pass if messages.empty?
 
       parse_messages(messages)

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

@@ -1,23 +1,12 @@
 # frozen_string_literal: true
 
+require 'overcommit/hook/shared/pronto'
+
 module Overcommit::Hook::PreCommit
   # Runs `pronto`
   #
   # @see https://github.com/mmozuras/pronto
   class Pronto < Base
-    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
-      type.include?('E') ? :error : :warning
-    end
-
-    def run
-      result = execute(command)
-      return :pass if result.success?
-
-      extract_messages(
-        result.stdout.split("\n"),
-        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+) (?<type>[^ ]+)/,
-        MESSAGE_TYPE_CATEGORIZER,
-      )
-    end
+    include Overcommit::Hook::Shared::Pronto
   end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'overcommit/utils/messages_utils'
 
 module Overcommit::Hook::PrePush
   # Functionality common to all pre-push hooks.
@@ -8,5 +9,25 @@ module Overcommit::Hook::PrePush
     extend Forwardable
 
     def_delegators :@context, :remote_name, :remote_url, :pushed_refs
+
+    def run?
+      super &&
+        !exclude_remotes.include?(remote_name) &&
+        (include_remote_ref_deletions? || !@context.remote_ref_deletion?)
+    end
+
+    private
+
+    def extract_messages(*args)
+      Overcommit::Utils::MessagesUtils.extract_messages(*args)
+    end
+
+    def exclude_remotes
+      @config['exclude_remotes'] || []
+    end
+
+    def include_remote_ref_deletions?
+      @config['include_remote_ref_deletions']
+    end
   end
 end

data/lib/overcommit/hook/pre_push/go_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PrePush
+  # Runs `go test ./...` command on prepush
+  class GoTest < Base
+    def run
+      result = execute(command)
+      return :pass if result.success?
+
+      output = result.stdout + result.stderr
+      [:fail, output]
+    end
+  end
+end

data/lib/overcommit/hook/pre_push/golangci_lint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PrePush
+  # Runs golangci-lint
+  #
+  # @see https://github.com/golangci/golangci-lint
+  class GolangciLint < Base
+    def run
+      result = execute(command)
+      return :pass if result.success?
+
+      output = result.stdout + result.stderr
+      [:fail, output]
+    end
+  end
+end

data/lib/overcommit/hook/pre_push/pronto.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'overcommit/hook/shared/pronto'
+
+module Overcommit::Hook::PrePush
+  # Runs `pronto`
+  #
+  # @see https://github.com/mmozuras/pronto
+  class Pronto < Base
+    include Overcommit::Hook::Shared::Pronto
+  end
+end

data/lib/overcommit/hook/pre_push/protected_branches.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Overcommit::Hook::PrePush
-  # Prevents destructive updates to specified branches.
+  # Prevents updates to specified branches.
+  # Accepts a 'destructive_only' option globally or per branch
+  # to only prevent destructive updates.
   class ProtectedBranches < Base
     def run
       return :pass unless illegal_pushes.any?
@@ -17,32 +19,55 @@ module Overcommit::Hook::PrePush
 
     def illegal_pushes
       @illegal_pushes ||= pushed_refs.select do |pushed_ref|
-        protected?(pushed_ref.remote_ref) && allow_non_destructive?(pushed_ref)
+        protected?(pushed_ref)
       end
     end
 
-    def protected?(remote_ref)
+    def protected?(ref)
+      find_pattern(ref.remote_ref)&.destructive?(ref)
+    end
+
+    def find_pattern(remote_ref)
       ref_name = remote_ref[%r{refs/heads/(.*)}, 1]
-      return false if ref_name.nil?
-      protected_branch_patterns.any? do |pattern|
-        File.fnmatch(pattern, ref_name)
+      return if ref_name.nil?
+
+      patterns.find do |pattern|
+        File.fnmatch(pattern.to_s, ref_name)
       end
     end
 
-    def protected_branch_patterns
-      @protected_branch_patterns ||= Array(config['branches']).
-        concat(Array(config['branch_patterns']))
+    def patterns
+      @patterns ||= fetch_patterns
     end
 
-    def destructive_only?
+    def fetch_patterns
+      branch_configurations.map do |pattern|
+        if pattern.is_a?(Hash)
+          Pattern.new(pattern.keys.first, pattern['destructive_only'])
+        else
+          Pattern.new(pattern, global_destructive_only?)
+        end
+      end
+    end
+
+    def branch_configurations
+      config['branches'].to_a + config['branch_patterns'].to_a
+    end
+
+    def global_destructive_only?
       config['destructive_only'].nil? || config['destructive_only']
     end
 
-    def allow_non_destructive?(ref)
-      if destructive_only?
-        ref.destructive?
-      else
-        true
+    Pattern = Struct.new('Pattern', :name, :destructive_only) do
+      alias_method :to_s, :name
+      alias_method :destructive_only?, :destructive_only
+
+      def destructive?(ref)
+        if destructive_only?
+          ref.destructive?
+        else
+          true
+        end
       end
     end
   end

data/lib/overcommit/hook/prepare_commit_msg/replace_branch.rb

@@ -17,7 +17,7 @@ module Overcommit::Hook::PrepareCommitMsg
       Overcommit::Utils.log.debug("Writing #{commit_message_filename} with #{new_template}")
 
       modify_commit_message do |old_contents|
-        "#{new_template}\n#{old_contents}"
+        "#{new_template} #{old_contents}"
       end
 
       :pass

data/lib/overcommit/hook/shared/pronto.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::Shared
+  # Shared code used by all Pronto hooks. Runs pronto linter.
+  module Pronto
+    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
+      type.include?('E') ? :error : :warning
+    end
+
+    def run
+      result = execute(command)
+      return :pass if result.success?
+
+      extract_messages(
+        result.stdout.split("\n"),
+        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+) (?<type>[^ ]+)/,
+        MESSAGE_TYPE_CATEGORIZER,
+      )
+    end
+  end
+end

data/lib/overcommit/hook_context/commit_msg.rb

@@ -34,7 +34,9 @@ module Overcommit::HookContext
     end
 
     def post_fail_message
-      "Failed commit message:\n" + commit_message_lines.join
+      "Failed commit message:\n#{commit_message_lines.join.chomp}\n\n" \
+      "Try again with your existing commit message by running:\n" \
+      "git commit --edit --file=#{commit_message_file}"
     end
 
     private

data/lib/overcommit/hook_context/pre_commit.rb

@@ -49,29 +49,15 @@ module Overcommit::HookContext
       Overcommit::GitRepo.store_merge_state
       Overcommit::GitRepo.store_cherry_pick_state
 
-      if !initial_commit? && any_changes?
-        @stash_attempted = true
-
-        stash_message = "Overcommit: Stash of repo state before hook run at #{Time.now}"
-        result = Overcommit::Utils.with_environment('GIT_LITERAL_PATHSPECS' => '0') do
-          Overcommit::Utils.execute(
-            %w[git -c commit.gpgsign=false stash save --keep-index --quiet] + [stash_message]
-          )
-        end
-
-        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:" \
-                "\nSTDOUT:#{result.stdout}\nSTDERR:#{result.stderr}"
-        end
+      # Don't attempt to stash changes if all changes are staged, as this
+      # prevents us from modifying files at all, which plays better with
+      # editors/tools which watch for file changes.
+      if !initial_commit? && unstaged_changes?
+        stash_changes
 
-        @changes_stashed = `git stash list -1`.include?(stash_message)
+        # While running hooks make it appear as if nothing changed
+        restore_modified_times
       end
-
-      # While running the hooks make it appear as if nothing changed
-      restore_modified_times
     end
 
     # Restore unstaged changes and reset file modification times so it appears
@@ -82,19 +68,14 @@ module Overcommit::HookContext
     # modification time on the file was newer. This helps us play more nicely
     # with file watchers.
     def cleanup_environment
-      unless initial_commit? || (@stash_attempted && !@changes_stashed)
-        clear_working_tree # Ensure working tree is clean before restoring it
-        restore_modified_times
-      end
-
       if @changes_stashed
+        clear_working_tree
         restore_working_tree
         restore_modified_times
       end
 
       Overcommit::GitRepo.restore_merge_state
       Overcommit::GitRepo.restore_cherry_pick_state
-      restore_modified_times
     end
 
     # Get a list of added, copied, or modified files that have been staged.
@@ -140,6 +121,27 @@ module Overcommit::HookContext
 
     private
 
+    def stash_changes
+      @stash_attempted = true
+
+      stash_message = "Overcommit: Stash of repo state before hook run at #{Time.now}"
+      result = Overcommit::Utils.with_environment('GIT_LITERAL_PATHSPECS' => '0') do
+        Overcommit::Utils.execute(
+          %w[git -c commit.gpgsign=false stash save --keep-index --quiet] + [stash_message]
+        )
+      end
+
+      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:" \
+              "\nSTDOUT:#{result.stdout}\nSTDERR:#{result.stderr}"
+      end
+
+      @changes_stashed = `git stash list -1`.include?(stash_message)
+    end
+
     # Clears the working tree so that the stash can be applied.
     def clear_working_tree
       removed_submodules = Overcommit::GitRepo.staged_submodule_removals
@@ -172,14 +174,11 @@ module Overcommit::HookContext
       end
     end
 
-    # Returns whether there are any changes to the working tree, staged or
-    # otherwise.
-    def any_changes?
-      modified_files = `git status -z --untracked-files=no`.
-        split("\0").
-        map { |line| line.gsub(/[^\s]+\s+(.+)/, '\\1') }
-
-      modified_files.any?
+    # Returns whether there are any changes to tracked files which have not yet
+    # been staged.
+    def unstaged_changes?
+      result = Overcommit::Utils.execute(%w[git --no-pager diff --quiet])
+      !result.success?
     end
 
     # Stores the modification times for all modified files to make it appear like

data/lib/overcommit/hook_context/pre_push.rb

@@ -13,6 +13,15 @@ module Overcommit::HookContext
       @args[1]
     end
 
+    def remote_ref_deletion?
+      return @remote_ref_deletion if defined?(@remote_ref_deletion)
+
+      @remote_ref_deletion ||= input_lines.
+                               first&.
+                               split(' ')&.
+                               first == '(deleted)'
+    end
+
     def pushed_refs
       input_lines.map do |line|
         PushedRef.new(*line.split(' '))

data/lib/overcommit/printer.rb

@@ -51,6 +51,7 @@ module Overcommit
     def run_interrupted
       log.newline
       log.warning '⚠  Hook run interrupted by user'
+      log.warning '⚠  If files appear modified/missing, check your stash to recover them'
       log.newline
     end
 

data/lib/overcommit/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.50.0'
+  VERSION = '0.54.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.50.0
+  version: 0.54.0
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -19,7 +19,7 @@ dependencies:
         version: 0.6.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.6.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: iniparse
   requirement: !ruby/object:Gem::Requirement
@@ -139,8 +139,10 @@ files:
 - lib/overcommit/hook/pre_commit/foodcritic.rb
 - lib/overcommit/hook/pre_commit/forbidden_branches.rb
 - lib/overcommit/hook/pre_commit/ginkgo_focus.rb
+- lib/overcommit/hook/pre_commit/go_fmt.rb
 - lib/overcommit/hook/pre_commit/go_lint.rb
 - lib/overcommit/hook/pre_commit/go_vet.rb
+- lib/overcommit/hook/pre_commit/golangci_lint.rb
 - lib/overcommit/hook/pre_commit/hadolint.rb
 - lib/overcommit/hook/pre_commit/haml_lint.rb
 - lib/overcommit/hook/pre_commit/hard_tabs.rb
@@ -210,8 +212,11 @@ files:
 - lib/overcommit/hook/pre_push/base.rb
 - lib/overcommit/hook/pre_push/brakeman.rb
 - lib/overcommit/hook/pre_push/cargo_test.rb
+- lib/overcommit/hook/pre_push/go_test.rb
+- lib/overcommit/hook/pre_push/golangci_lint.rb
 - lib/overcommit/hook/pre_push/minitest.rb
 - lib/overcommit/hook/pre_push/php_unit.rb
+- lib/overcommit/hook/pre_push/pronto.rb
 - lib/overcommit/hook/pre_push/protected_branches.rb
 - lib/overcommit/hook/pre_push/pytest.rb
 - lib/overcommit/hook/pre_push/python_nose.rb
@@ -227,6 +232,7 @@ files:
 - lib/overcommit/hook/shared/composer_install.rb
 - lib/overcommit/hook/shared/index_tags.rb
 - lib/overcommit/hook/shared/npm_install.rb
+- lib/overcommit/hook/shared/pronto.rb
 - lib/overcommit/hook/shared/rake_target.rb
 - lib/overcommit/hook/shared/submodule_status.rb
 - lib/overcommit/hook/shared/yarn_install.rb
@@ -290,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
 summary: Git hook manager