jawshooah-overcommit 0.22.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fdbbf53711cd124c0d6dd824d12d0f0d7ee1e71
+  data.tar.gz: 4e2c9e69e2cd659ab1bee8a5b58fd7962e82a282
+SHA512:
+  metadata.gz: 3f484a6d5dd6c97c8bae56ddd0eb2f0702895269f16bbc7eb16a49e2083922cdafaf0768c918a9d2f60d1d5ad55dcc41df8b8a3461915b3bd29beea8780726de
+  data.tar.gz: 2304de2cb69bbd8ade60137ec1e32119ed2250cc6e7be9e98b4f2e88705abd564b3e22b07e3e2d898cd4c6ab13ae3c84e29c2fd50b48b3671c522b205030d491

data/bin/overcommit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'overcommit'
+require 'overcommit/cli'
+
+logger = Overcommit::Logger.new(STDOUT)
+
+Overcommit::CLI.new(ARGV, logger).run

data/config/default.yml

@@ -0,0 +1,275 @@
+# Default configuration that all Overcommit configurations inherit from.
+#
+# This is an opinionated list of which hooks are valuable to run and what their
+# out-of-the-box settings should be.
+
+# Where to store hook plugins specific to a repository. These are loaded in
+# addition to the default hooks Overcommit comes with. The location is relative
+# to the root of the repository.
+plugin_directory: '.git-hooks'
+
+# Whether to check if a hook plugin has changed since Overcommit last ran it.
+# This is a defense mechanism when working with repositories which can contain
+# untrusted code (e.g. when you fetch a pull request from a third party).
+# See https://github.com/causes/overcommit#security for more information.
+verify_plugin_signatures: true
+
+# Hooks that run after HEAD changes or a file is explicitly checked out. Useful
+# for updating source tags (e.g. via ctags) or warning about new migrations,
+# etc.
+PostCheckout:
+  ALL:
+    required: false
+    quiet: false
+  IndexTags:
+    enabled: false
+    description: 'Generating tags file from source'
+
+# Hooks that are run after `git commit` is executed, before the commit message
+# editor is displayed. These hooks are ideal for syntax checkers, linters, and
+# other checks that you want to run before you allow a commit object to be
+# created.
+PreCommit:
+  ALL:
+    problem_on_unmodified_line: warn
+    requires_files: true
+    required: false
+    quiet: false
+
+  AuthorEmail:
+    description: 'Checking author email'
+    requires_files: false
+    required: true
+    quiet: true
+    pattern: '^[^@]+@.*$'
+
+  AuthorName:
+    description: 'Checking for author name'
+    requires_files: false
+    required: true
+    quiet: true
+
+  BerksfileCheck:
+    description: 'Checking Berksfile lock'
+    required_executable: 'berks'
+    install_command: 'gem install berks'
+    include:
+      - 'Berksfile'
+      - 'Berksfile.lock'
+
+  Brakeman:
+    enabled: false
+    description: 'Checking for security vulnerabilities'
+    required_executable: 'brakeman'
+    install_command: 'gem install brakeman'
+    include:
+      - '**/*.rb'
+
+  BrokenSymlinks:
+    description: 'Checking for broken symlinks'
+    quiet: true
+
+  BundleCheck:
+    description: 'Checking Gemfile dependencies'
+    required_executable: 'bundle'
+    install_command: 'gem install bundler'
+    include:
+      - 'Gemfile'
+      - 'Gemfile.lock'
+      - '*.gemspec'
+
+  ChamberSecurity:
+    enabled: false
+    description: 'Checking that settings have been secured with Chamber'
+    required_executable: 'chamber'
+    install_command: 'gem install chamber'
+    include:
+      - 'config/settings.yml'
+      - 'config/settings/**/*.yml'
+
+  CoffeeLint:
+    description: 'Analyzing with coffeelint'
+    required_executable: 'coffeelint'
+    install_command: 'npm install -g coffeelint'
+    include: '**/*.coffee'
+
+  CssLint:
+    description: 'Analyzing with csslint'
+    required_executable: 'csslint'
+    install_command: 'npm install -g csslint'
+    include: '**/*.css'
+
+  GoLint:
+    description: 'Analyzing with golint'
+    required_executable: 'golint'
+    install_command: 'go get github.com/golang/lint/golint'
+    include: '**/*.go'
+
+  HamlLint:
+    description: 'Analyzing with haml-lint'
+    required_executable: 'haml-lint'
+    install_command: 'gem install haml-lint'
+    include: '**/*.haml'
+
+  HardTabs:
+    description: 'Checking for hard tabs'
+    quiet: true
+    exclude:
+      - '**/*.go'
+      - '**/Makefile'
+      - '.gitmodules'
+
+  ImageOptim:
+    description: 'Checking for optimizable images'
+    include:
+      - '**/*.gif'
+      - '**/*.jpg'
+      - '**/*.jpeg'
+      - '**/*.png'
+
+  Jscs:
+    description: 'Analyzing with JSCS'
+    required_executable: 'jscs'
+    install_command: 'npm install -g jscs'
+    include: '**/*.js'
+
+  Jsxcs:
+    description: 'Analyzing with JSXCS'
+    required_executable: 'jsxcs'
+    install_command: 'npm install -g jsxcs'
+    include: '**/*.jsx'
+
+  JsHint:
+    description: 'Analyzing with JSHint'
+    required_executable: 'jshint'
+    install_command: 'npm install -g jshint'
+    include: '**/*.js'
+
+  JsonSyntax:
+    description: 'Validating JSON syntax'
+    include: '**/*.json'
+
+  JsxHint:
+    description: 'Analyzing with JSXHint'
+    required_executable: 'jsxhint'
+    install_command: 'npm install -g jsxhint'
+    include: '**/*.jsx'
+
+  LocalPathsInGemfile:
+    description: 'Checking for local paths in Gemfile'
+    include: '**/Gemfile'
+
+  MergeConflicts:
+    description: 'Checking for merge conflicts'
+    quiet: true
+
+  PryBinding:
+    description: 'Checking for instances of binding.pry'
+    quiet: true
+    include:
+      - '**/*.rb'
+      - '**/*.rake'
+
+  PythonFlake8:
+    description: 'Analyzing with flake8'
+    required_executable: 'flake8'
+    install_command: 'pip install flake8'
+    include: '**/*.py'
+
+  RailsSchemaUpToDate:
+    description: 'Checking if database schema is up to date'
+    include:
+      - 'db/migrate/*.rb'
+      - 'db/schema.rb'
+      - 'db/structure.sql'
+
+  Reek:
+    enabled: false
+    description: 'Analyzing with Reek'
+    required_executable: 'reek'
+    install_command: 'gem install reek'
+    include:
+      - '**/*.gemspec'
+      - '**/*.rake'
+      - '**/*.rb'
+      - '**/Gemfile'
+      - '**/Rakefile'
+
+  Rubocop:
+    description: 'Analyzing with Rubocop'
+    required_executable: 'rubocop'
+    install_command: 'gem install rubocop'
+    include:
+      - '**/*.gemspec'
+      - '**/*.rake'
+      - '**/*.rb'
+      - '**/Gemfile'
+      - '**/Rakefile'
+
+  ScssLint:
+    description: 'Analyzing with scss-lint'
+    required_executable: 'scss-lint'
+    install_command: 'gem install scss-lint'
+    include: '**/*.scss'
+
+  ShellCheck:
+    description: 'Analyzing with ShellCheck'
+    required_executable: 'shellcheck'
+    include: '**/*.sh'
+
+  TrailingWhitespace:
+    description: 'Checking for trailing whitespace'
+    exclude:
+      - '**/db/structure.sql'
+
+  TravisLint:
+    description: 'Checking Travis CI configuration'
+    required_executable: 'travis'
+    install_command: 'gem install travis'
+    include: '.travis.yml'
+
+  YamlSyntax:
+    description: 'Checking YAML syntax'
+    include: '**/*.yml'
+
+# Hooks that are run against every commit message after a user has written it.
+# These hooks are useful for enforcing policies on commit messages written for a
+# project.
+CommitMsg:
+  ALL:
+    requires_files: false
+    quiet: false
+
+  GerritChangeId:
+    enabled: false
+    description: 'Ensuring Gerrit Change-Id is present'
+    required: true
+
+  HardTabs:
+    description: 'Checking for hard tabs'
+
+  RussianNovel:
+    description: 'Checking length of commit message'
+    quiet: true
+
+  SingleLineSubject:
+    description: 'Checking subject line'
+
+  TextWidth:
+    description: 'Checking text width'
+    max_subject_width: 60
+    max_body_width: 72
+
+  TrailingPeriod:
+    description: 'Checking for trailing periods in subject'
+
+PostCommit:
+  ALL:
+    requires_files: false
+    required: false
+    quiet: false
+
+  GitGuilt:
+    description: 'Calculating changes in blame since last commit'
+    required_executable: 'git-guilt'
+    install_command: 'npm install -g git-guilt'

data/config/starter.yml

@@ -0,0 +1,31 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/causes/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/causes/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/causes/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  Rubocop:
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#   quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/lib/overcommit.rb

@@ -0,0 +1,20 @@
+require 'overcommit/constants'
+require 'overcommit/exceptions'
+require 'overcommit/configuration_validator'
+require 'overcommit/configuration'
+require 'overcommit/configuration_loader'
+require 'overcommit/hook/base'
+require 'overcommit/hook_context/base'
+require 'overcommit/hook_context'
+require 'overcommit/git_repo'
+require 'overcommit/hook_signer'
+require 'overcommit/hook_loader/base'
+require 'overcommit/hook_loader/built_in_hook_loader'
+require 'overcommit/hook_loader/plugin_hook_loader'
+require 'overcommit/interrupt_handler'
+require 'overcommit/printer'
+require 'overcommit/hook_runner'
+require 'overcommit/installer'
+require 'overcommit/logger'
+require 'overcommit/utils'
+require 'overcommit/version'

data/lib/overcommit/cli.rb

@@ -0,0 +1,205 @@
+require 'optparse'
+
+module Overcommit
+  # Responsible for parsing command-line options and executing appropriate
+  # application logic based on those options.
+  class CLI # rubocop:disable ClassLength
+    def initialize(arguments, logger)
+      @arguments = arguments
+      @log       = logger
+      @options   = {}
+    end
+
+    def run
+      parse_arguments
+
+      case @options[:action]
+      when :install, :uninstall
+        install_or_uninstall
+      when :template_dir
+        print_template_directory_path
+      when :sign_plugins
+        sign_plugins
+      when :run_all
+        run_all
+      end
+    rescue Overcommit::Exceptions::HookContextLoadError => ex
+      puts ex
+      exit 64 # EX_USAGE
+    end
+
+    private
+
+    attr_reader :log
+
+    def parse_arguments
+      @parser = create_option_parser
+
+      begin
+        @parser.parse!(@arguments)
+
+        # Default action is to install
+        @options[:action] ||= :install
+
+        # Unconsumed arguments are our targets
+        @options[:targets] = @arguments
+      rescue OptionParser::InvalidOption => ex
+        print_help @parser.help, ex
+      end
+    end
+
+    def create_option_parser
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{opts.program_name} [options] [target-repo]"
+
+        add_information_options(opts)
+        add_installation_options(opts)
+        add_other_options(opts)
+      end
+    end
+
+    def add_information_options(opts)
+      opts.on_tail('-h', '--help', 'Show this message') do
+        print_help opts.help
+      end
+
+      opts.on_tail('-v', '--version', 'Show version') do
+        print_version(opts.program_name)
+      end
+
+      opts.on_tail('-l', '--list-hooks', 'List installed hooks') do
+        print_installed_hooks
+      end
+    end
+
+    def add_installation_options(opts)
+      opts.on('-u', '--uninstall', 'Remove Overcommit hooks from a repository') do
+        @options[:action] = :uninstall
+      end
+
+      opts.on('-i', '--install', 'Install Overcommit hooks in a repository') do
+        @options[:action] = :install
+      end
+
+      opts.on('-f', '--force', 'Overwrite any previously installed hooks') do
+        @options[:force] = true
+      end
+
+      opts.on('-r', '--run', 'Run pre-commit hook against all git tracked files') do
+        @options[:action] = :run_all
+      end
+    end
+
+    def add_other_options(opts)
+      opts.on('-s', '--sign hook', 'Update plugin signatures for hook', String) do |hook|
+        @options[:action] = :sign_plugins
+        @options[:hook_to_sign] = hook
+      end
+
+      opts.on('-t', '--template-dir', 'Print location of template directory') do
+        @options[:action] = :template_dir
+      end
+    end
+
+    def install_or_uninstall
+      if Array(@options[:targets]).empty?
+        @options[:targets] = [Overcommit::Utils.repo_root].compact
+      end
+
+      if @options[:targets].empty?
+        log.warning 'You are not in a git repository.'
+        log.log 'You must either specify the path to a repository or ' \
+                'change your current directory to a repository.'
+        halt 64 # EX_USAGE
+      end
+
+      @options[:targets].each do |target|
+        begin
+          Installer.new(log).run(target, @options)
+        rescue Overcommit::Exceptions::InvalidGitRepo => error
+          log.warning "Invalid repo #{target}: #{error}"
+          halt 69 # EX_UNAVAILABLE
+        rescue Overcommit::Exceptions::PreExistingHooks => error
+          log.warning "Unable to install into #{target}: #{error}"
+          halt 73 # EX_CANTCREAT
+        end
+      end
+    end
+
+    def print_template_directory_path
+      puts File.join(OVERCOMMIT_HOME, 'template-dir')
+      halt
+    end
+
+    def print_help(message, error = nil)
+      log.error "#{error}\n" if error
+      log.log message
+      halt(error ? 64 : 0) # 64 = EX_USAGE
+    end
+
+    def print_version(program_name)
+      log.log "#{program_name} #{Overcommit::VERSION}"
+      halt
+    end
+
+    # Prints the hooks available in the current repo and whether they're
+    # enabled/disabled.
+    def print_installed_hooks
+      config = Overcommit::ConfigurationLoader.load_repo_config
+
+      config.all_hook_configs.each do |hook_type, hook_configs|
+        print_hooks_for_hook_type(config, hook_configs, hook_type)
+      end
+
+      halt
+    end
+
+    def print_hooks_for_hook_type(repo_config, hook_configs, hook_type)
+      log.log "#{hook_type}:"
+      hook_configs.each do |hook_name, config|
+        log.partial "  #{hook_name}: "
+
+        if config['enabled']
+          log.success('enabled', true)
+        else
+          log.error('disabled', true)
+        end
+
+        if repo_config.plugin_hook?(hook_type, hook_name)
+          log.warning(' (plugin)')
+        else
+          log.newline
+        end
+      end
+    end
+
+    def sign_plugins
+      config = Overcommit::ConfigurationLoader.load_repo_config
+      context = Overcommit::HookContext.create(@options[:hook_to_sign],
+                                               config,
+                                               @arguments)
+      Overcommit::HookLoader::PluginHookLoader.new(config,
+                                                   context,
+                                                   log).update_signatures
+      halt
+    end
+
+    def run_all
+      config  = Overcommit::ConfigurationLoader.load_repo_config
+      context = Overcommit::HookContext.create('run-all', config, @arguments)
+      config.apply_environment!(context, ENV)
+
+      printer = Overcommit::Printer.new(log, context)
+      runner  = Overcommit::HookRunner.new(config, log, context, printer)
+
+      status = runner.run
+
+      halt(status ? 0 : 65)
+    end
+
+    # Used for ease of stubbing in tests
+    def halt(status = 0)
+      exit status
+    end
+  end
+end