overcommit 0.46.0 → 0.47.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Runs `vint` against any modified Vim script files.
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Runs `w3c_validators` against any modified CSS files.
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Runs `w3c_validators` against any modified HTML files.
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Runs `xmllint` against any modified XML files.
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Checks the syntax of any modified XML files.
   class XmlSyntax < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Runs `YAMLLint` against any modified YAML files.
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Checks the syntax of any modified YAML files.
   class YamlSyntax < Base

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

@@ -1,4 +1,6 @@
 
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreCommit
   # Class to check yard documentation coverage.
   #

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

@@ -12,7 +12,7 @@ module Overcommit::Hook::PreCommit
     # (are caused by bad package specification, in the hands of the upstream maintainer)
     # So limit reporting to errors the developer can do something about
     ACTIONABLE_ERRORS = [
-      'Lockfile does not contain pattern'.freeze,
+      'Lockfile does not contain pattern',
     ].freeze
 
     def run

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Overcommit::Hook::PrePush

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `brakeman` whenever Ruby/Rails files change.
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `cargo test` before push if Rust files changed
   class CargoTest < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `minitest` test suite before push
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `phpunit` test suite before push
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Prevents destructive updates to specified branches.
   class ProtectedBranches < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `pytest` test suite before push
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `nose` test suite before push
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `rspec` test suite before push
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'overcommit/hook/shared/rake_target'
 
 module Overcommit::Hook::PrePush

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PrePush
   # Runs `test-unit` test suite before push
   #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Overcommit::Hook::PreRebase

data/lib/overcommit/hook/pre_rebase/merged_commits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::PreRebase
   # Prevents rebasing commits that have already been merged into one of
   # a specified set of branches.

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Overcommit::Hook::PrepareCommitMsg
+  # Functionality common to all prepare-commit-msg hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context,
+                   :commit_message_filename, :commit_message_source, :commit, :lock
+
+    def modify_commit_message
+      raise 'This expects a block!' unless block_given?
+      # NOTE: this assumes all the hooks of the same type share the context's
+      # memory. If that's not the case, this won't work.
+      lock.synchronize do
+        contents = File.read(commit_message_filename)
+        File.open(commit_message_filename, 'w') do |f|
+          f << (yield contents)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::PrepareCommitMsg
+  # Prepends the commit message with a message based on the branch name.
+  # It's possible to reference parts of the branch name through the captures in
+  # the `branch_pattern` regex.
+  class ReplaceBranch < Base
+    def run
+      return :pass unless !commit_message_source ||
+        commit_message_source == :commit # NOTE: avoid 'merge' and 'rebase'
+      Overcommit::Utils.log.debug(
+        "Checking if '#{Overcommit::GitRepo.current_branch}' matches #{branch_pattern}"
+      )
+      if branch_pattern.match(Overcommit::GitRepo.current_branch)
+        Overcommit::Utils.log.debug("Writing #{commit_message_filename} with #{new_template}")
+        modify_commit_message do |old_contents|
+          "#{new_template}\n#{old_contents}"
+        end
+        :pass
+      else
+        :warn
+      end
+    end
+
+    def new_template
+      @new_template ||= Overcommit::GitRepo.current_branch.gsub(branch_pattern, replacement_text)
+    end
+
+    def branch_pattern
+      @branch_pattern ||=
+        begin
+          pattern = config['branch_pattern']
+          Regexp.new((pattern || '').empty? ? '\A.*\w+[-_](\d+).*\z' : pattern)
+        end
+    end
+
+    def replacement_text
+      @replacement_text ||=
+        begin
+          if File.exist?(replacement_text_config)
+            File.read(replacement_text_config)
+          else
+            replacement_text_config
+          end
+        end
+    end
+
+    def replacement_text_config
+      @replacement_text_config ||= config['replacement_text']
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all BowerInstall hooks. Runs `bower install` when a
   # change is detected in the repository's dependencies.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all BundleInstall hooks. Runs `bundle install` when a
   # change is detected in the repository's dependencies.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all ComposerInstall hooks. Runs `composer install` when
   # a change is detected in the repository's dependencies.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all IndexTags hooks. It runs ctags in the background so
   # your tag definitions are up-to-date.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all NpmInstall hooks. Runs `npm install` when a change
   # is detected in the repository's dependencies.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # runs specified rake targets. It fails on the first non-
   # successfull exit.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all `SubmoduleStatus` hooks to notify the user if any
   # submodules are uninitialized, out of date with the current index, or contain

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::Hook::Shared
   # Shared code used by all YarnInstall hooks. Runs `yarn install` when a change
   # is detected in the repository's dependencies.

data/lib/overcommit/hook_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Utility module which manages the creation of {HookContext}s.
 module Overcommit::HookContext
   def self.create(hook_type, config, args, input)

data/lib/overcommit/hook_context/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to the context with which a hook is being run.
   #

data/lib/overcommit/hook_context/commit_msg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to contextual information used by commit-msg hooks.
   class CommitMsg < Base

data/lib/overcommit/hook_context/post_checkout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to contextual information used by post-checkout
   # hooks.

data/lib/overcommit/hook_context/post_commit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to contextual information used by post-commit
   # hooks.

data/lib/overcommit/hook_context/post_merge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to contextual information used by post-merge
   # hooks.

data/lib/overcommit/hook_context/post_rewrite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers for contextual information used by post-rewrite hooks.
   class PostRewrite < Base

data/lib/overcommit/hook_context/pre_commit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'set'
 
@@ -19,7 +21,8 @@ module Overcommit::HookContext
       # containing unicode characters, we replace the offending characters,
       # since the pattern we're looking for will consist of ASCII characters
       unless cmd.valid_encoding?
-        cmd.encode!('UTF-16be', invalid: :replace, replace: '?').encode!('UTF-8')
+        cmd = Overcommit::Utils.parent_command.encode('UTF-16be', invalid: :replace, replace: '?').
+                                               encode('UTF-8')
       end
 
       return @amendment if

data/lib/overcommit/hook_context/pre_push.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to contextual information used by pre-push hooks.
   class PrePush < Base

data/lib/overcommit/hook_context/pre_rebase.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookContext
   # Contains helpers related to contextual information used by pre-rebase
   # hooks.

data/lib/overcommit/hook_context/prepare_commit_msg.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Overcommit::HookContext
+  # Contains helpers related to contextual information used by prepare-commit-msg
+  # hooks.
+  class PrepareCommitMsg < Base
+    # Returns the name of the file that contains the commit log message
+    def commit_message_filename
+      @args[0]
+    end
+
+    # Returns the source of the commit message, and can be: message (if a -m or
+    # -F option was given); template (if a -t option was given or the
+    # configuration option commit.template is set); merge (if the commit is a
+    # merge or a .git/MERGE_MSG file exists); squash (if a .git/SQUASH_MSG file
+    # exists); or commit, followed by a commit SHA-1 (if a -c, -C or --amend
+    # option was given)
+    def commit_message_source
+      @args[1].to_sym if @args[1]
+    end
+
+    # Returns the commit's SHA-1.
+    # If commit_message_source is :commit, it's passed through the command-line.
+    def commit_message_source_ref
+      @args[2] || `git rev-parse HEAD`
+    end
+
+    # Lock for the pre_commit_message file. Should be shared by all
+    # prepare-commit-message hooks
+    def lock
+      @lock ||= Monitor.new
+    end
+  end
+end

data/lib/overcommit/hook_context/run_all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Overcommit::HookContext

data/lib/overcommit/hook_loader/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookLoader
   # Responsible for loading hooks from a file.
   class Base

data/lib/overcommit/hook_loader/built_in_hook_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit::HookLoader
   # Responsible for loading hooks that ship with Overcommit.
   class BuiltInHookLoader < Base

data/lib/overcommit/hook_loader/plugin_hook_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest'
 
 module Overcommit::HookLoader