Merge pull request #8 from dr2m/todo

Add TODO and FIXME checker

lib/face_control/checkers.rb

@@ -1,2 +1,3 @@
 require 'face_control/checkers/rubocop'
 require 'face_control/checkers/coffeelint'
+require 'face_control/checkers/comments'

lib/face_control/checkers/comments.rb

@@ -0,0 +1,23 @@
+require 'face_control/comment'
+
+module FaceControl
+  module Checkers
+    class Comments
+
+      def command(filenames)
+        "grep -inEH '(todo|fixme)' #{filenames}"
+      end
+
+      def parse(command_output)
+        command_output.lines.map do |line|
+          file, line_num = line.split(":", 3)
+          Comment.new(
+            file: file,
+            line: line_num,
+            text: "Do not bury this task in code. Do it now or create a JIRA issue."
+          )
+        end
+      end
+    end
+  end
+end

lib/face_control/cli.rb

@@ -28,7 +28,8 @@ def check(pull_request, ignored_severities, logger)
 
       checkers = [
         FaceControl::CheckerRunner.new(FaceControl::Checkers::RuboCop, filenames, ignored_severities: ignored_severities),
-        FaceControl::CheckerRunner.new(FaceControl::Checkers::CoffeeLint, filenames)
+        FaceControl::CheckerRunner.new(FaceControl::Checkers::CoffeeLint, filenames),
+        FaceControl::CheckerRunner.new(FaceControl::Checkers::Comments, filenames)
       ]
 
       checkers.map(&:comments).flatten

test/face_control/cli_test.rb

@@ -2,9 +2,9 @@
 
 class CLITest < Minitest::Test
   def test_check
-    pull_request = OpenStruct.new(filenames_with_added_lines: %w(test/fixtures/foo.rb test/fixtures/foo.coffee))
+    pull_request = OpenStruct.new(filenames_with_added_lines: %w(test/fixtures/foo.rb test/fixtures/commented.rb test/fixtures/foo.coffee))
     logger = Logger.new('/dev/null')
     comments = FaceControl::CLI.new.check(pull_request, %w(foo), logger)
-    assert_equal 2, comments.size
+    assert_equal 5, comments.size
   end
 end

test/fixtures/commented.rb

@@ -0,0 +1,7 @@
+class Foo
+  # FIXME: incorrect format of annotation keyword
+  # TODO: something
+  def something
+    "something"
+  end
+end