overcommit 0.1.0

data/lib/overcommit/plugins/commit_msg/change_id.rb

@@ -0,0 +1,14 @@
+module Overcommit::GitHook
+  class ChangeID < HookSpecificCheck
+    include HookRegistry
+
+    stealth! # Not really a 'check', but we need it to run
+
+    SCRIPT_LOCATION = Overcommit::Utils.script_path 'gerrit-change-id'
+
+    def run_check
+      system `#{SCRIPT_LOCATION} #{@arguments.join(' ')}`
+      :good
+    end
+  end
+end

data/lib/overcommit/plugins/commit_msg/release_note.rb

@@ -0,0 +1,14 @@
+module Overcommit::GitHook
+  class ReleaseNote < HookSpecificCheck
+    include HookRegistry
+
+    EMPTY_RELEASE_NOTE = /^release notes?\s*[:.]?\n{2,}/im
+    def run_check
+      if user_commit_message.join =~ EMPTY_RELEASE_NOTE
+        return :warn, 'Empty release note found, either add one or remove it'
+      end
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Overcommit::GitHook
+  class RussianNovel < HookSpecificCheck
+    include HookRegistry
+
+    stealth!
+
+    RUSSIAN_NOVEL_LENGTH = 30
+    def run_check
+      if user_commit_message.length > RUSSIAN_NOVEL_LENGTH
+        return :warn, 'You seem to have authored a Russian novel; congratulations!'
+      end
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Overcommit::GitHook
+  class TextWidth < HookSpecificCheck
+    include HookRegistry
+
+    def run_check
+      if user_commit_message.first.size > 60
+        return :warn, 'Please keep the subject < ~60 characters'
+      end
+
+      user_commit_message.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/plugins/commit_msg/trailing_period.rb

@@ -0,0 +1,13 @@
+module Overcommit::GitHook
+  class TrailingPeriod < HookSpecificCheck
+    include HookRegistry
+
+    def run_check
+      if commit_message[0].rstrip.end_with?('.')
+        return :warn, 'Please omit trailing period from commit message subject.'
+      end
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Overcommit::GitHook
+  class AuthorName < HookSpecificCheck
+    include HookRegistry
+
+    def run_check
+      name = `git config --get user.name`.chomp
+      unless name.split(' ').count >= 2
+        return :bad, "Author must have at least first and last name; " <<
+                     "was: '#{name}'.\n Set your name with " <<
+                     "`git config --global user.name 'Your Name'`"
+      end
+
+      :good
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/causes_email.rb

@@ -0,0 +1,15 @@
+module Overcommit::GitHook
+  class CausesEmail < HookSpecificCheck
+    include HookRegistry
+
+    def run_check
+      email = `git config --get user.email`.chomp
+      unless email =~ /@causes\.com$/
+        return :bad, "Author must use a causes.com address; was '#{email}'.\n" <<
+                     "Set user with `git config --global user.email YOUR_EMAIL@causes.com`"
+      end
+
+      :good
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/css_linter.rb

@@ -0,0 +1,17 @@
+module Overcommit::GitHook
+  class CssLinter < HookSpecificCheck
+    include HookRegistry
+    file_type :css
+
+    CSS_LINTER_PATH = Overcommit::Utils.script_path 'csslint-rhino.js'
+
+    def run_check
+      return :warn, "Rhino is not installed" unless in_path? 'rhino'
+
+      paths = staged.join(' ')
+      output = `rhino #{CSS_LINTER_PATH} --quiet --format=compact #{paths} | grep 'Error - '`
+
+      return (output !~ /Error - (?!Unknown @ rule)/ ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/erb_syntax.rb

@@ -0,0 +1,21 @@
+require 'erb'
+
+module Overcommit::GitHook
+  class ErbSyntax < HookSpecificCheck
+    include HookRegistry
+    file_type :erb
+    ERB_CHECKER = 'bin/check-rails-erb'
+
+    def skip?
+      return 'Bundler is not installed' unless in_path? 'bundle'
+      unless File.executable? ERB_CHECKER
+        return "Can't find/execute #{ERB_CHECKER}"
+      end
+    end
+
+    def run_check
+      output = `bundle exec #{ERB_CHECKER} #{staged.join(' ')}`
+      return (output !~ /: compile error$/ ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/haml_syntax.rb

@@ -0,0 +1,23 @@
+module Overcommit::GitHook
+  class HamlSyntax < HookSpecificCheck
+    include HookRegistry
+    file_type :haml
+
+    def run_check
+      begin
+        require 'haml'
+      rescue LoadError
+        return :warn, "'haml' gem not installed -- run `gem install haml`"
+      end
+
+      staged.each do |path|
+        begin
+          Haml::Engine.new(File.read(path), :check_syntax => true)
+        rescue Haml::Error => e
+          return :bad, e.message
+        end
+      end
+      return :good, nil
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/js_console_log.rb

@@ -0,0 +1,16 @@
+module Overcommit::GitHook
+  class JSConsoleLog < HookSpecificCheck
+    include HookRegistry
+    file_type :js
+
+    # https://www.pivotaltracker.com/story/show/18119495
+    def run_check
+      paths = staged.join(' ')
+      output = `grep -n -e 'console\\.log' #{paths}`.split("\n").reject do |line|
+        /^\d+:\s*\/\// =~ line ||     # Skip comments
+          /ALLOW_CONSOLE_LOG/ =~ line # and lines with ALLOW_CONSOLE_LOG
+      end.join("\n")
+      return (output.empty? ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/js_syntax.rb

@@ -0,0 +1,18 @@
+module Overcommit::GitHook
+  class JSSyntax < HookSpecificCheck
+    include HookRegistry
+    file_type :js
+
+    JS_HINT_PATH        = Overcommit::Utils.script_path 'jshint.js'
+    JS_HINT_RUNNER_PATH = Overcommit::Utils.script_path 'jshint_runner.js'
+
+    def run_check
+      return :warn, "Rhino is not installed" unless in_path? 'rhino'
+
+      paths = staged.join(' ')
+
+      output = `rhino -strict -f #{JS_HINT_PATH} #{JS_HINT_RUNNER_PATH} #{paths} 2>&1 | grep -v warning | grep -v -e '^js: '`
+      return (output !~ /^ERROR/ ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/restricted_paths.rb

@@ -0,0 +1,15 @@
+module Overcommit::GitHook
+  class RestrictedPaths < HookSpecificCheck
+    include HookRegistry
+    RESTRICTED_PATHS = %w[vendor]
+
+    def run_check
+      RESTRICTED_PATHS.each do |path|
+        if !system("git diff --cached --quiet -- #{path}")
+          return :stop, "changes staged under #{path}"
+        end
+      end
+      return :good
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/ruby_syntax.rb

@@ -0,0 +1,19 @@
+module Overcommit::GitHook
+  class RubySyntax < HookSpecificCheck
+    include HookRegistry
+    file_type :rb
+
+    def run_check
+      clean = true
+      output = []
+      staged.each do |staged|
+        syntax = `ruby -c #{staged} 2>&1`
+        unless $?.success?
+          output += syntax.lines.to_a
+          clean = false
+        end
+      end
+      return (clean ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/scss_lint.rb

@@ -0,0 +1,20 @@
+module Overcommit::GitHook
+  class ScssLint < HookSpecificCheck
+    include HookRegistry
+    file_type :scss
+
+    def run_check
+      begin
+        require 'scss_lint'
+      rescue LoadError
+        return :warn, 'scss-lint not installed -- run `gem install scss-lint`'
+      end
+
+      paths = staged.join(' ')
+
+      output = `scss-lint #{paths} 2>&1`
+
+      return (output.empty? ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/test_history.rb

@@ -0,0 +1,58 @@
+module Overcommit::GitHook
+  class TestHistory < HookSpecificCheck
+    include HookRegistry
+
+    def relevant_tests
+      @relevant_test ||=
+        `relevant-tests 2> /dev/null -- #{modified_files.join(' ')}`.
+        split("\n").map { |r| File.expand_path r }
+    end
+
+    def skip?
+      !FileTest.exist?('spec/support/record_results_formatter.rb')
+    end
+
+    TEST_RESULTS_FILE = '.spec-results'
+    def run_check
+      output = []
+      unless relevant_tests.any?
+        return :warn, 'No relevant tests for this change...write some?'
+      end
+
+      begin
+        good_tests = File.open(TEST_RESULTS_FILE, 'r').readlines.map do |spec_file|
+          File.expand_path spec_file.strip
+        end
+      rescue Errno::ENOENT
+        good_tests = []
+      end
+
+      unless good_tests.any?
+        return :bad,
+          'The relevant tests for this change have not yet been run using `specr`'
+      end
+
+      missed_tests = (relevant_tests - good_tests)
+      unless missed_tests.empty?
+        output << 'The following relevant tests have not been run recently:'
+        output << missed_tests.sort
+        return :bad, output
+      end
+
+      # Find files modified after the tests were run
+      test_time = File.mtime(TEST_RESULTS_FILE)
+      untested_files = modified_files.reject do |file|
+        File.mtime(file) < test_time
+      end
+
+      unless untested_files.empty?
+        output << 'The following files were modified after `specr` was run.'
+        output << '(their associated tests may be broken):'
+        output << untested_files.sort
+        return :bad, output
+      end
+
+      return :good
+    end
+  end
+end

data/lib/overcommit/plugins/pre_commit/whitespace.rb

@@ -0,0 +1,19 @@
+module Overcommit::GitHook
+  class Whitespace < HookSpecificCheck
+    include HookRegistry
+
+    def run_check
+      # Catches hard tabs
+      output = `grep -Inl "\t" #{staged.join(' ')}`
+      unless output.empty?
+        return :stop, "Don't use hard tabs:\n#{output}"
+      end
+
+      # Catches trailing whitespace, conflict markers etc
+      output = `git diff --check --cached`
+      return :stop, output unless $?.exitstatus.zero?
+
+      :good
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'yaml'
+
+module Overcommit::GitHook
+  class YamlSyntax < HookSpecificCheck
+    include HookRegistry
+    file_type :yml
+
+    def run_check
+      clean = true
+      output = []
+      staged.each do |path|
+        begin
+          YAML.load_file(path)
+        rescue ArgumentError => e
+          output << "#{e.message} parsing #{path}"
+          clean = false
+        end
+      end
+      return (clean ? :good : :bad), output
+    end
+  end
+end

data/lib/overcommit/reporter.rb

@@ -0,0 +1,80 @@
+module Overcommit
+  class Reporter
+    include ConsoleMethods
+
+    def initialize(name, checks)
+      @name    = name
+      @checks  = checks
+      @width   = 70 - (@checks.map { |s| s.name.length }.max || 0)
+      @results = []
+    end
+
+    def with_status(check, &block)
+      title = "  Checking #{check.name}..."
+      print title unless check.stealth?
+
+      status, output = yield
+
+      print_incremental_result(title, status, output, check.stealth?)
+      @results << status
+    end
+
+    def print_header
+      puts "Running #{@name} checks"
+    end
+
+    def print_result
+      puts
+      case final_result
+      when :good
+        success "+++ All #{@name} checks passed"
+        exit 0
+      when :bad
+        error "!!! One or more #{@name} checks failed"
+        exit 1
+      when :stop
+        warning "*** One or more #{@name} checks needs attention"
+        warning "*** If you really want to commit, use SKIP_CHECKS"
+        warning "*** (takes a space-separated list of checks to skip, or 'all')"
+        exit 1
+      end
+    end
+
+  private
+
+    def print_incremental_result(title, status, output, stealth = false)
+      if stealth
+        return if status == :good
+        print title
+      end
+
+      print '.' * (@width - title.length)
+      case status
+      when :good
+        success 'OK'
+      when :bad
+        error 'FAILED'
+        print_report output
+      when :warn
+        warning output
+      when :stop
+        warning 'UH OH'
+        print_report output
+      else
+        error '???'
+        print_report "Check didn't return a status"
+        exit 1
+      end
+    end
+
+    def final_result
+      return :bad  if @results.include?(:bad)
+      return :stop if @results.include?(:stop)
+      return :good
+    end
+
+    def print_report(*report)
+      puts report.flatten.map { |line| "    #{line}" }.join("\n")
+    end
+  end
+end