overcommit-jeygeethanmedia 0.53.1

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

@@ -0,0 +1,15 @@
+# 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.
+  #
+  # @see http://bower.io/
+  module BowerInstall
+    def run
+      result = execute(command)
+      return :fail, result.stderr unless result.success?
+      :pass
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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.
+  #
+  # @see http://bundler.io/
+  module BundleInstall
+    def run
+      result = execute(command)
+      return :fail, result.stdout unless result.success?
+      :pass
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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.
+  #
+  # @see https://getcomposer.org/
+  module ComposerInstall
+    def run
+      result = execute(command)
+      return :fail, result.stdout unless result.success?
+      :pass
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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.
+  #
+  # @see http://ctags.sourceforge.net/
+  module IndexTags
+    def run
+      execute_in_background([Overcommit::Utils.script_path('index-tags')])
+      :pass
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# 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.
+  #
+  # @see https://www.npmjs.com/
+  module NpmInstall
+    def run
+      result = execute(command)
+      return :fail, result.stderr unless result.success?
+      :pass
+    end
+  end
+end

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/shared/rake_target.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Overcommit::Hook::Shared
+  # runs specified rake targets. It fails on the first non-
+  # successful exit.
+  #
+  module RakeTarget
+    def run
+      targets = config['targets']
+
+      if Array(targets).empty?
+        raise 'RakeTarget: targets parameter is empty. Add at least one task to ' \
+          'the targets parameter. Valid: Array of target names or String of ' \
+          'target names'
+      end
+
+      targets.each do |task|
+        result = execute(command + [task])
+        unless result.success?
+          return :fail, "Rake target #{task}:\n#{result.stdout}"
+        end
+      end
+      :pass
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# 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
+  # merge conflicts.
+  module SubmoduleStatus
+    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/shared/yarn_install.rb

@@ -0,0 +1,15 @@
+# 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.
+  #
+  # @see https://yarnpkg.com/
+  module YarnInstall
+    def run
+      result = execute(command)
+      return :fail, result.stderr unless result.success?
+      :pass
+    end
+  end
+end

data/lib/overcommit/hook_context.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Utility module which manages the creation of {HookContext}s.
+module Overcommit::HookContext
+  def self.create(hook_type, config, args, input)
+    hook_type_class = Overcommit::Utils.camel_case(hook_type)
+    underscored_hook_type = Overcommit::Utils.snake_case(hook_type)
+
+    require "overcommit/hook_context/#{underscored_hook_type}"
+
+    Overcommit::HookContext.const_get(hook_type_class).new(config, args, input)
+  rescue LoadError, NameError => error
+    # Could happen when a symlink was created for a hook type Overcommit does
+    # not yet support.
+    raise Overcommit::Exceptions::HookContextLoadError,
+          "Unable to load '#{hook_type}' hook context: '#{error}'",
+          error.backtrace
+  end
+end

data/lib/overcommit/hook_context/base.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Overcommit::HookContext
+  # Contains helpers related to the context with which a hook is being run.
+  #
+  # It acts as an adapter to the arguments passed to the hook, as well as
+  # context-specific information such as staged files, providing a single source
+  # of truth for this context.
+  #
+  # This is also important to house in a separate object so that any
+  # calculations can be memoized across all hooks in a single object, which
+  # helps with performance.
+  #
+  # @abstract
+  class Base
+    # Creates a hook context from the given configuration and input options.
+    #
+    # @param config [Overcommit::Configuration]
+    # @param args [Array<String>]
+    # @param input [IO] standard input stream
+    def initialize(config, args, input)
+      @config = config
+      @args = args
+      @input = input
+    end
+
+    # Executes a command as if it were a regular git hook, passing all
+    # command-line arguments and the standard input stream.
+    #
+    # This is intended to be used by ad hoc hooks so developers can link up
+    # their existing git hooks with Overcommit.
+    def execute_hook(command)
+      Overcommit::Utils.execute(command, args: @args, input: input_string)
+    end
+
+    # Returns the camel-cased type of this hook (e.g. PreCommit)
+    #
+    # @return [String]
+    def hook_class_name
+      self.class.name.split('::').last
+    end
+
+    # Returns the snake-cased type of this hook (e.g. pre_commit)
+    #
+    # @return [String]
+    def hook_type_name
+      Overcommit::Utils.snake_case(hook_class_name)
+    end
+
+    # Returns the actual name of the hook script being run (e.g. pre-commit).
+    #
+    # @return [String]
+    def hook_script_name
+      hook_type_name.tr('_', '-')
+    end
+
+    # Initializes anything related to the environment.
+    #
+    # This is called before the hooks are run by the [HookRunner]. Different
+    # hook types can perform different setup.
+    def setup_environment
+      # Implemented by subclass, if applicable
+    end
+
+    # Resets the environment to an appropriate state.
+    #
+    # This is called after the hooks have been run by the [HookRunner].
+    # Different hook types can perform different cleanup operations, which are
+    # intended to "undo" the results of the call to {#setup_environment}.
+    def cleanup_environment
+      # Implemented by subclass, if applicable
+    end
+
+    # Returns a list of files that have been modified.
+    #
+    # By default, this returns an empty list. Subclasses should implement if
+    # there is a concept of files changing for the type of hook being run.
+    #
+    # @return [Array<String>]
+    def modified_files
+      []
+    end
+
+    # Returns the full list of files tracked by git
+    #
+    # @return [Array<String>]
+    def all_files
+      Overcommit::GitRepo.all_files
+    end
+
+    # Returns the contents of the entire standard input stream that were passed
+    # to the hook.
+    #
+    # @return [String]
+    def input_string
+      @input_string ||= @input.read
+    end
+
+    # Returns an array of lines passed to the hook via the standard input
+    # stream.
+    #
+    # @return [Array<String>]
+    def input_lines
+      @input_lines ||= input_string.split("\n")
+    end
+
+    # Returns a message to display on failure.
+    #
+    # @return [String]
+    def post_fail_message
+      nil
+    end
+
+    private
+
+    def filter_modified_files(modified_files)
+      filter_directories(filter_nonexistent(modified_files))
+    end
+
+    # Filter out non-existent files (unless it's a broken symlink, in which case
+    # it's a file that points to a non-existent file). This could happen if a
+    # file was renamed as part of an amendment, leading to the old file no
+    # longer existing.
+    def filter_nonexistent(modified_files)
+      modified_files.select do |file|
+        File.exist?(file) || Overcommit::Utils.broken_symlink?(file)
+      end
+    end
+
+    # Filter out directories. This could happen when changing a symlink to a
+    # directory as part of an amendment, since the symlink will still appear as
+    # a file, but the actual working tree will have a directory.
+    def filter_directories(modified_files)
+      modified_files.reject do |file|
+        File.directory?(file) && !Overcommit::Utils::FileUtils.symlink?(file)
+      end
+    end
+  end
+end

data/lib/overcommit/hook_context/commit_msg.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Overcommit::HookContext
+  # Contains helpers related to contextual information used by commit-msg hooks.
+  class CommitMsg < Base
+    def empty_message?
+      commit_message.strip.empty?
+    end
+
+    # User commit message stripped of comments and diff (from verbose output).
+    def commit_message
+      commit_message_lines.join
+    end
+
+    # Updates the commit message to the specified text.
+    def update_commit_message(message)
+      ::File.open(commit_message_file, 'w') do |file|
+        file.write(message)
+      end
+    end
+
+    def commit_message_lines
+      raw_commit_message_lines.
+        take_while { |line| !line.start_with?('diff --git') }.
+        reject     { |line| line.start_with?(comment_character) }
+    end
+
+    def comment_character
+      @comment_character ||= Overcommit::GitConfig.comment_character
+    end
+
+    def commit_message_file
+      @args[0]
+    end
+
+    def post_fail_message
+      "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
+
+    def raw_commit_message_lines
+      ::IO.readlines(commit_message_file)
+    end
+  end
+end

data/lib/overcommit/hook_context/post_checkout.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Overcommit::HookContext
+  # Contains helpers related to contextual information used by post-checkout
+  # hooks.
+  class PostCheckout < Base
+    # Returns the ref of the HEAD that we transitioned from.
+    def previous_head
+      @args[0]
+    end
+
+    # Returns the ref of the new current HEAD.
+    def new_head
+      @args[1]
+    end
+
+    # Returns whether this checkout was the result of changing/updating a
+    # branch.
+    def branch_checkout?
+      @args[2].to_i == 1
+    end
+
+    # Returns whether this checkout was for a single file.
+    def file_checkout?
+      !branch_checkout?
+    end
+
+    # Get a list of files that have been added or modified between
+    # `previous_head` and `new_head`. Renames and deletions are ignored, since
+    # there should be nothing to check.
+    def modified_files
+      @modified_files ||=
+        Overcommit::GitRepo.modified_files(refs: "#{previous_head} #{new_head}")
+    end
+  end
+end

data/lib/overcommit/hook_context/post_commit.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+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