Add pre commit hook for FixMe

Author: ajgon

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## master
 
+* Add `FixMe` pre-commit hook, to ensure that no "token" words slips through.
+  These strings are things you should fix now, not later.
 * Add [`YAMLLint`](https://github.com/adrienverge/yamllint) pre-commit hook
 * Add `LicenceHeader` pre-commit enforcement to ensure open source projects
   contain proper licence comments.

README.md

@@ -487,6 +487,7 @@ issue](https://github.com/brigade/overcommit/issues/238) for more details.
 * [EsLint](lib/overcommit/hook/pre_commit/es_lint.rb)
 * [ExecutePermissions](lib/overcommit/hook/pre_commit/execute_permissions.rb)
 * [Fasterer](lib/overcommit/hook/pre_commit/fasterer.rb)
+* [FixMe](lib/overcommit/hook/pre_commit/fix_me.rb)
 * [Foodcritic](lib/overcommit/hook/pre_commit/foodcritic.rb)
 * [ForbiddenBranches](lib/overcommit/hook/pre_commit/forbidden_branches.rb)
 * [GoLint](lib/overcommit/hook/pre_commit/go_lint.rb)

config/default.yml

@@ -254,6 +254,13 @@ PreCommit:
     install_command: 'gem install fasterer'
     include: '**/*.rb'
 
+  FixMe:
+    enabled: false
+    description: 'Check for "token" strings'
+    required_executable: 'grep'
+    flags: ['-IEHnw']
+    keywords: ['BROKEN', 'BUG', 'ERROR', 'FIXME', 'HACK', 'NOTE', 'OPTIMIZE', 'REVIEW', 'TODO', 'WTF', 'XXX']
+
   Foodcritic:
     enabled: false
     description: 'Analyze with Foodcritic'

lib/overcommit/hook/pre_commit/fix_me.rb

@@ -0,0 +1,15 @@
+module Overcommit::Hook::PreCommit
+  # Check for "token" strings
+  class FixMe < Base
+    def run
+      keywords = config['keywords']
+      result = execute(command, args: [keywords.join('|')] + applicable_files)
+
+      extract_messages(
+        result.stdout.split("\n"),
+        /^(?<file>(?:\w:)?[^:]+):(?<line>\d+)/,
+        lambda { |_type| :warning }
+      )
+    end
+  end
+end

spec/overcommit/hook/pre_commit/fix_me_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Overcommit::Hook::PreCommit::FixMe do
+  let(:config)  { Overcommit::ConfigurationLoader.default_configuration }
+  let(:context) { double('context') }
+  subject { described_class.new(config, context) }
+  let(:staged_file) { 'filename.txt' }
+
+  before do
+    subject.stub(:applicable_files).and_return([staged_file])
+  end
+
+  around do |example|
+    repo do
+      File.open(staged_file, 'w') { |f| f.write(contents) }
+      `git add #{staged_file}`
+      example.run
+    end
+  end
+
+  context 'when file contains FIXME' do
+    let(:contents) { 'eval(params[:q]) # FIXME maybe this is a bad idea?' }
+
+    it { should warn }
+  end
+
+  context 'when file contains TODO with special chars around it' do
+    let(:contents) { 'users = (1..1000).map { |i| User.find(1) } #TODO: make it better' }
+
+    it { should warn }
+  end
+
+  context 'when file does not contain any FixMe words' do
+    let(:contents) { 'if HACKY_CONSTANT.blank?' }
+
+    it { should pass }
+  end
+end