overcommit 0.5.0 → 0.6.0

data/lib/overcommit/configuration_loader.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module Overcommit
+  # Manages configuration file loading.
+  class ConfigurationLoader
+    DEFAULT_CONFIG_PATH = File.join(OVERCOMMIT_HOME, 'config', 'default.yml')
+    FILE_NAME = '.overcommit.yml'
+
+    def self.load_repo_config
+      overcommit_yml = File.join(Overcommit::Utils.repo_root, FILE_NAME)
+
+      if File.exists?(overcommit_yml)
+        load_file(overcommit_yml)
+      else
+        default_configuration
+      end
+    end
+
+    def self.default_configuration
+      @default_config ||= load_from_file(DEFAULT_CONFIG_PATH)
+    end
+
+  private
+
+    # Loads a configuration, ensuring it extends the default configuration.
+    def self.load_file(file)
+      config = load_from_file(file)
+
+      default_configuration.merge(config)
+    rescue => error
+      raise Overcommit::Exceptions::ConfigurationError,
+            "Unable to load configuration from '#{file}': #{error}",
+            error.backtrace
+    end
+
+    def self.load_from_file(file)
+      hash =
+        if yaml = YAML.load_file(file)
+          yaml.to_hash
+        else
+          {}
+        end
+
+      Overcommit::Configuration.new(hash)
+    end
+  end
+end

data/lib/overcommit/constants.rb

@@ -0,0 +1,7 @@
+# Global application constants.
+module Overcommit
+  OVERCOMMIT_HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+
+  REPO_URL = 'https://github.com/causes/overcommit'
+  BUG_REPORT_URL = "#{REPO_URL}/issues"
+end

data/lib/overcommit/exceptions.rb

@@ -0,0 +1,16 @@
+module Overcommit::Exceptions
+  # Raised when a {Configuration} could not be loaded from a file.
+  class ConfigurationError < StandardError; end
+
+  # Raised when a hook could not be loaded by a {HookRunner}.
+  class HookLoadError < StandardError; end
+
+  # Raised when a {HookRunner} could not be loaded.
+  class HookContextLoadError < StandardError; end
+
+  # Raised when an installation target is not a valid git repository.
+  class InvalidGitRepo < StandardError; end
+
+  # Raised when an installation target already contains non-Overcommit hooks.
+  class PreExistingHooks < StandardError; end
+end

data/lib/overcommit/hook/base.rb

@@ -0,0 +1,91 @@
+require 'forwardable'
+
+module Overcommit::Hook
+  # Functionality common to all hooks.
+  class Base
+    extend Forwardable
+
+    def_delegators :@context, :modified_files
+
+    def initialize(config, context)
+      @config = config.for_hook(self)
+      @context = context
+    end
+
+    # Runs the hook.
+    def run
+      raise NotImplementedError, 'Hook must define `run`'
+    end
+
+    def name
+      self.class.name.split('::').last
+    end
+
+    def description
+      @config['description'] || "Running #{name}"
+    end
+
+    def required?
+      @config['required']
+    end
+
+    def quiet?
+      @config['quiet']
+    end
+
+    def enabled?
+      @config['enabled'] != false
+    end
+
+    def skip?
+      @config['skip']
+    end
+
+    def run?
+      enabled? &&
+        (!skip? || required?) &&
+        !(requires_modified_files? && applicable_files.empty?)
+    end
+
+    def in_path?(cmd)
+      Overcommit::Utils.in_path?(cmd)
+    end
+
+    def command(cmd)
+      Overcommit::Utils.command(cmd)
+    end
+
+    # Gets a list of staged files that apply to this hook based on its
+    # configured `include` and `exclude` lists.
+    def applicable_files
+      @applicable_files ||= modified_files.select { |file| applicable_file?(file) }
+    end
+
+  private
+
+    def requires_modified_files?
+      @config['requires_files']
+    end
+
+    def applicable_file?(file)
+      includes = Array(@config['include']).map { |glob| convert_glob_to_absolute(glob) }
+      included = includes.empty? ||
+                 includes.any? { |glob| File.fnmatch(glob, file) }
+
+      excludes = Array(@config['exclude']).map { |glob| convert_glob_to_absolute(glob) }
+      excluded = excludes.any? { |glob| File.fnmatch(glob, file) }
+
+      included && !excluded
+    end
+
+    def convert_glob_to_absolute(glob)
+      repo_root = Overcommit::Utils.repo_root
+
+      if glob.start_with?('**')
+        repo_root + glob # Want ** to match items in the repo root as well
+      else
+        File.join(repo_root, glob)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'forwardable'
+
+module Overcommit::Hook::CommitMsg
+  # Functionality common to all commit-msg hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context, :commit_message, :update_commit_message,
+                   :commit_message_lines, :commit_message_file
+  end
+end

data/lib/overcommit/hook/commit_msg/gerrit_change_id.rb

@@ -0,0 +1,18 @@
+module Overcommit::Hook::CommitMsg
+  # Ensures a Gerrit Change-Id line is included in the commit message.
+  #
+  # It may seem odd to do this here instead of in a prepare-commit-msg hook, but
+  # the reality is that if you want to _ensure_ the Change-Id is included then
+  # you need to do it in a commit-msg hook. This is because the user could still
+  # edit the message after a prepare-commit-msg hook was run.
+  class GerritChangeId < Base
+    def run
+      result = command("#{SCRIPT_LOCATION} #{commit_message_file}")
+      return (result.success? ? :good : :bad), result.stdout
+    end
+
+  private
+
+    SCRIPT_LOCATION = Overcommit::Utils.script_path('gerrit-change-id')
+  end
+end

data/lib/overcommit/{plugins → hook}/commit_msg/hard_tabs.rb

@@ -1,10 +1,9 @@
-module Overcommit::GitHook
-  class HardTabs < HookSpecificCheck
-    include HookRegistry
-
-    def run_check
+module Overcommit::Hook::CommitMsg
+  # Checks for hard tabs in commit messages.
+  class HardTabs < Base
+    def run
       # Catches hard tabs entered by the user (not auto-generated)
-      if commit_message.join.index /\t/
+      if commit_message.index(/\t/)
         return :warn, "Don't use hard tabs in commit messages"
       end
 

data/lib/overcommit/hook/commit_msg/russian_novel.rb

@@ -0,0 +1,14 @@
+module Overcommit::Hook::CommitMsg
+  # Checks for long commit messages (not good or bad--just fun to point out)
+  class RussianNovel < Base
+    RUSSIAN_NOVEL_LENGTH = 30
+
+    def run
+      if commit_message_lines.length >= RUSSIAN_NOVEL_LENGTH
+        return :warn, 'You seem to have authored a Russian novel; congratulations!'
+      end
+
+      :good
+    end
+  end
+end

data/lib/overcommit/hook/commit_msg/single_line_subject.rb

@@ -0,0 +1,12 @@
+module Overcommit::Hook::CommitMsg
+  # Ensures commit message subject lines are followed by a blank line.
+  class SingleLineSubject < Base
+    def run
+      unless commit_message_lines[1].to_s.strip.empty?
+        return :warn, 'Subject should be one line and followed by a blank line'
+      end
+
+      :good
+    end
+  end
+end

data/lib/overcommit/hook/commit_msg/text_width.rb

@@ -0,0 +1,20 @@
+module Overcommit::Hook::CommitMsg
+  # Ensures the number of columns the subject and commit message lines occupy is
+  # under the preferred limits.
+  class TextWidth < Base
+    def run
+      if commit_message_lines.first.size > 60
+        return :warn, 'Please keep the subject < ~60 characters'
+      end
+
+      commit_message_lines.each do |line|
+        chomped = line.chomp
+        if chomped.size > 72
+          return :warn, "> 72 characters, please hard wrap: '#{chomped}'"
+        end
+      end
+
+      :good
+    end
+  end
+end

data/lib/overcommit/hook/commit_msg/trailing_period.rb

@@ -0,0 +1,12 @@
+module Overcommit::Hook::CommitMsg
+  # Ensures commit message subject lines do not have a trailing period
+  class TrailingPeriod < Base
+    def run
+      if commit_message_lines.first.rstrip.end_with?('.')
+        return :warn, 'Please omit trailing period from commit message subject'
+      end
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'forwardable'
+
+module Overcommit::Hook::PostCheckout
+  # Functionality common to all post-checkout hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context,
+                   :previous_head, :new_head, :branch_checkout?, :file_checkout?
+  end
+end

data/lib/overcommit/hook/post_checkout/bundle_check.rb

@@ -0,0 +1,29 @@
+module Overcommit::Hook::PostCheckout
+  # If Gemfile dependencies were modified since HEAD was changed, check if
+  # currently installed gems satisfy the dependencies.
+  class BundleCheck < Base
+    def run
+      unless in_path?('bundle')
+        return :warn, 'bundler not installed -- run `gem install bundler`'
+      end
+
+      return :bad if dependencies_changed? && !dependencies_satisfied?
+
+      :good
+    end
+
+  private
+
+    def dependencies_changed?
+      result = command("git diff --exit-code #{new_head} #{previous_head} --name-only")
+
+      result.stdout.split("\n").any? do |file|
+        Array(@config['include']).any? { |glob| File.fnmatch(glob, file) }
+      end
+    end
+
+    def dependencies_satisfied?
+      command('bundle check').success?
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Overcommit::Hook::PostCheckout
+  # Scans source code each time HEAD changes to generate an up-to-date index of
+  # all function/variable definitions, etc.
+  class IndexTags < Base
+    def run
+      unless in_path?('ctags')
+        return :good # Silently ignore
+      end
+
+      index_tags_in_background
+
+      :good
+    end
+
+  private
+
+    SCRIPT_LOCATION = Overcommit::Utils.script_path('index-tags')
+
+    def index_tags_in_background
+      # TODO: come up with Ruby 1.8-friendly way to do this
+      Process.detach(Process.spawn(SCRIPT_LOCATION))
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Overcommit::Hook::PreCommit
+  # Checks the format of an author's email address.
+  class AuthorEmail < Base
+    def run
+      result = command('git config --get user.email')
+      email = result.stdout.chomp
+
+      unless email =~ /#{@config['pattern']}/
+        return :bad, "Author has an invalid email address: '#{email}'\n" <<
+                     'Set your email with ' <<
+                     '`git config --global user.email your_email@example.com`'
+      end
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Overcommit::Hook::PreCommit
+  # Ensures that a commit author has a name with at least first and last names.
+  class AuthorName < Base
+    def run
+      result = command('git config --get user.name')
+      name = result.stdout.chomp
+
+      unless name.split(' ').count >= 2
+        return :bad, 'Author must have at least first and last name, but ' <<
+                     "was: '#{name}'.\nSet your name with " <<
+                     "`git config --global user.name 'Your Name'`"
+      end
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'forwardable'
+
+module Overcommit::Hook::PreCommit
+  # Functionality common to all pre-commit hooks.
+  class Base < Overcommit::Hook::Base
+    extend Forwardable
+
+    def_delegators :@context, :modified_lines
+  end
+end

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

@@ -0,0 +1,30 @@
+module Overcommit::Hook::PreCommit
+  # Check if local Gemfile.lock matches Gemfile when either changes, unless
+  # Gemfile.lock is ignored by git.
+  class BundleCheck < Base
+    def run
+      unless in_path?('bundle')
+        return :warn, 'bundler not installed -- run `gem install bundler`'
+      end
+
+      # Ignore if Gemfile.lock is not tracked by git
+      return :good if command("git check-ignore #{LOCK_FILE}").success?
+
+      result = command('bundle check')
+      unless result.success?
+        return :bad, result.stdout
+      end
+
+      result = command("git diff --quiet -- #{LOCK_FILE}")
+      unless result.success?
+        return :bad, "#{LOCK_FILE} is not up-to-date -- run `bundle check`"
+      end
+
+      :good
+    end
+
+  private
+
+    LOCK_FILE = 'Gemfile.lock'
+  end
+end

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

@@ -0,0 +1,14 @@
+module Overcommit::Hook::PreCommit
+  # Runs `coffeelint` against any modified CoffeeScript files.
+  class CoffeeLint < Base
+    def run
+      unless in_path?('coffeelint')
+        return :warn, 'Run `npm install -g coffeelint`'
+      end
+
+      result = command("coffeelint --quiet #{applicable_files.join(' ')}")
+      return :good if result.success?
+      return :bad, result.stdout
+    end
+  end
+end