jawshooah-overcommit 0.22.0

data/lib/overcommit/utils.rb

@@ -0,0 +1,163 @@
+require 'pathname'
+require 'overcommit/subprocess'
+
+module Overcommit
+  # Utility functions for general use.
+  module Utils
+    class << self
+      def script_path(script)
+        File.join(OVERCOMMIT_HOME, 'libexec', script)
+      end
+
+      # Returns an absolute path to the root of the repository.
+      #
+      # We do this ourselves rather than call `git rev-parse --show-toplevel` to
+      # solve an issue where the .git directory might not actually be valid in
+      # tests.
+      #
+      # @return [String]
+      def repo_root
+        @repo_root ||=
+          begin
+            git_dir = Pathname.new(File.expand_path('.')).enum_for(:ascend).find do |path|
+              File.exist?(File.join(path, '.git'))
+            end
+
+            unless git_dir
+              raise Overcommit::Exceptions::InvalidGitRepo, 'no .git directory found'
+            end
+
+            git_dir.to_s
+          end
+      end
+
+      # Returns an absolute path to the .git directory for a repo.
+      #
+      # @param repo_dir [String] root directory of git repo
+      # @return [String]
+      def git_dir(repo_dir = repo_root)
+        @git_dir ||=
+          begin
+            git_dir = File.expand_path('.git', repo_dir)
+
+            # .git could also be a file that contains the location of the git directory
+            unless File.directory?(git_dir)
+              git_dir = File.read(git_dir)[/^gitdir: (.*)$/, 1]
+
+              # Resolve relative paths
+              unless git_dir.start_with?('/')
+                git_dir = File.expand_path(git_dir, repo_dir)
+              end
+            end
+
+            git_dir
+          end
+      end
+
+      # Shamelessly stolen from:
+      # stackoverflow.com/questions/1509915/converting-camel-case-to-underscore-case-in-ruby
+      def snake_case(str)
+        str.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').
+            tr('-', '_').
+            downcase
+      end
+
+      # Converts a string containing underscores/hyphens/spaces into CamelCase.
+      def camel_case(str)
+        str.split(/_|-| /).map { |part| part.sub(/^\w/) { |c| c.upcase } }.join
+      end
+
+      # Returns a list of supported hook types (pre-commit, commit-msg, etc.)
+      def supported_hook_types
+        Dir[File.join(OVERCOMMIT_HOME, 'lib', 'overcommit', 'hook', '*')].
+          select { |file| File.directory?(file) }.
+          map { |file| File.basename(file, '.rb').gsub('_', '-') }
+      end
+
+      # Returns a list of supported hook classes (PreCommit, CommitMsg, etc.)
+      def supported_hook_type_classes
+        supported_hook_types.map do |file|
+          file.split('-').map(&:capitalize).join
+        end
+      end
+
+      # @param cmd [String]
+      # @return [true,false] whether a command can be found given the current
+      #   environment path.
+      def in_path?(cmd)
+        # ENV['PATH'] doesn't include the repo root, but that is a valid
+        # location for executables, so we want to add it to the list of places
+        # we are checking for the executable.
+        paths = [repo_root] + ENV['PATH'].split(File::PATH_SEPARATOR)
+        exts  = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+        paths.each do |path|
+          exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return true if File.executable?(exe)
+          end
+        end
+        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.
+      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)
+        end
+      end
+
+      # Calls a block of code with a modified set of environment variables,
+      # restoring them once the code has executed.
+      def with_environment(env)
+        old_env = {}
+        env.each do |var, value|
+          old_env[var] = ENV[var.to_s]
+          ENV[var.to_s] = value
+        end
+
+        yield
+      ensure
+        old_env.each { |var, value| ENV[var.to_s] = value }
+      end
+
+      # Returns whether a file is a broken symlink.
+      #
+      # @return [true,false]
+      def broken_symlink?(file)
+        # JRuby's implementation of File.exist? returns true for broken
+        # symlinks, so we need use File.size?
+        File.symlink?(file) && File.size?(file).nil?
+      end
+
+      # Convert a glob pattern to an absolute path glob pattern rooted from the
+      # repository root directory.
+      #
+      # @param glob [String]
+      # @return [String]
+      def convert_glob_to_absolute(glob)
+        File.join(repo_root, glob)
+      end
+
+      # Return whether a pattern matches the given path.
+      #
+      # @param pattern [String]
+      # @param path [String]
+      def matches_path?(pattern, path)
+        File.fnmatch?(pattern, path,
+                      File::FNM_PATHNAME | # Wildcard doesn't match separator
+                      File::FNM_DOTMATCH   # Wildcards match dotfiles
+        )
+      end
+    end
+  end
+end

data/lib/overcommit/version.rb

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

data/libexec/gerrit-change-id

@@ -0,0 +1,174 @@
+#!/bin/sh
+# From Gerrit Code Review 2.5.1
+#
+# Part of Gerrit Code Review (http://code.google.com/p/gerrit/)
+#
+# Copyright (C) 2009 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+CHANGE_ID_AFTER="Bug|Issue|Story"
+MSG="$1"
+
+# Check for, and add if missing, a unique Change-Id
+#
+add_ChangeId() {
+        clean_message=`sed -e '
+                /^diff --git a\/.*/{
+                        s///
+                        q
+                }
+                /^Signed-off-by:/d
+                /^#/d
+        ' "$MSG" | git stripspace`
+        if test -z "$clean_message"
+        then
+                return
+        fi
+
+        # Does Change-Id: already exist? if so, exit (no change).
+        if grep -i '^Change-Id:' "$MSG" >/dev/null
+        then
+                return
+        fi
+
+        id=`_gen_ChangeId`
+        T="$MSG.tmp.$$"
+        AWK=awk
+        if [ -x /usr/xpg4/bin/awk ]; then
+                # Solaris AWK is just too broken
+                AWK=/usr/xpg4/bin/awk
+        fi
+
+        # How this works:
+        # - parse the commit message as (textLine+ blankLine*)*
+        # - assume textLine+ to be a footer until proven otherwise
+        # - exception: the first block is not footer (as it is the title)
+        # - read textLine+ into a variable
+        # - then count blankLines
+        # - once the next textLine appears, print textLine+ blankLine* as these
+        #   aren't footer
+        # - in END, the last textLine+ block is available for footer parsing
+        $AWK '
+        BEGIN {
+                # while we start with the assumption that textLine+
+                # is a footer, the first block is not.
+                isFooter = 0
+                footerComment = 0
+                blankLines = 0
+        }
+
+        # Skip lines starting with "#" without any spaces before it.
+        /^#/ { next }
+
+        # Skip the line starting with the diff command and everything after it,
+        # up to the end of the file, assuming it is only patch data.
+        # If more than one line before the diff was empty, strip all but one.
+        /^diff --git a/ {
+                blankLines = 0
+                while (getline) { }
+                next
+        }
+
+        # Count blank lines outside footer comments
+        /^$/ && (footerComment == 0) {
+                blankLines++
+                next
+        }
+
+        # Catch footer comment
+        /^\[[a-zA-Z0-9-]+:/ && (isFooter == 1) {
+                footerComment = 1
+        }
+
+        /]$/ && (footerComment == 1) {
+                footerComment = 2
+        }
+
+        # We have a non-blank line after blank lines. Handle this.
+        (blankLines > 0) {
+                print lines
+                for (i = 0; i < blankLines; i++) {
+                        print ""
+                }
+
+                lines = ""
+                blankLines = 0
+                isFooter = 1
+                footerComment = 0
+        }
+
+        # Detect that the current block is not the footer
+        (footerComment == 0) && (!/^\[?[a-zA-Z0-9-]+:/ || /^[a-zA-Z0-9-]+:\/\//) {
+                isFooter = 0
+        }
+
+        {
+                # We need this information about the current last comment line
+                if (footerComment == 2) {
+                        footerComment = 0
+                }
+                if (lines != "") {
+                        lines = lines "\n";
+                }
+                lines = lines $0
+        }
+
+        # Footer handling:
+        # If the last block is considered a footer, splice in the Change-Id at the
+        # right place.
+        # Look for the right place to inject Change-Id by considering
+        # CHANGE_ID_AFTER. Keys listed in it (case insensitive) come first,
+        # then Change-Id, then everything else (eg. Signed-off-by:).
+        #
+        # Otherwise just print the last block, a new line and the Change-Id as a
+        # block of its own.
+        END {
+                unprinted = 1
+                if (isFooter == 0) {
+                        print lines "\n"
+                        lines = ""
+                }
+                changeIdAfter = "^(" tolower("'"$CHANGE_ID_AFTER"'") "):"
+                numlines = split(lines, footer, "\n")
+                for (line = 1; line <= numlines; line++) {
+                        if (unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
+                                unprinted = 0
+                                print "Change-Id: I'"$id"'"
+                        }
+                        print footer[line]
+                }
+                if (unprinted) {
+                        print "Change-Id: I'"$id"'"
+                }
+        }' "$MSG" > $T && mv $T "$MSG" || rm -f $T
+}
+_gen_ChangeIdInput() {
+        echo "tree `git write-tree`"
+        if parent=`git rev-parse "HEAD^0" 2>/dev/null`
+        then
+                echo "parent $parent"
+        fi
+        echo "author `git var GIT_AUTHOR_IDENT`"
+        echo "committer `git var GIT_COMMITTER_IDENT`"
+        echo
+        printf '%s' "$clean_message"
+}
+_gen_ChangeId() {
+        _gen_ChangeIdInput |
+        git hash-object -t commit --stdin
+}
+
+
+add_ChangeId

data/libexec/index-tags

@@ -0,0 +1,17 @@
+#!/bin/sh
+# Indexes all tags for this repository for easy navigation with Vim, storing the
+# file in <repo>/.git/tags. If you're using Fugitive.vim, you'll automatically
+# have access to the tags file; otherwise you'll have to modify your `tags`
+# option in your vimrc to search the generated file.
+
+set -e
+
+trap "rm -f $GIT_DIR/tags.$$" EXIT
+err_file=$GIT_DIR/ctags.err
+if ctags --tag-relative -Rf$GIT_DIR/tags.$$ --exclude=.git "$@" 2>${err_file}; then
+  mv $GIT_DIR/tags.$$ $GIT_DIR/tags
+  [ -e ${err_file} ] && rm -f ${err_file}
+else
+  # Ignore STDERR unless `ctags` returned a non-zero exit code
+  cat ${err_file}
+fi

data/template-dir/hooks/commit-msg

@@ -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

data/template-dir/hooks/overcommit-hook

@@ -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