danger-todoist 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45658ff29d4eb2568b06f4243fe8c986c1167cef
-  data.tar.gz: 7e772b86afd289fa5340d70fe6b5234b28e64dc9
+  metadata.gz: 8ee3034cbc74c2f326f4ae999d205832415ff0d8
+  data.tar.gz: c81b838cf5d97b239d02348ee2599210d32be027
 SHA512:
-  metadata.gz: 7547e35d1ed8baf09bdca508d9bc61a589f4a94ab5537552aad116dec55cc79b0028a7bbe3b684639c318cae57cf29214e662e0c672df29b45980584685ed4dc
-  data.tar.gz: 279263f5a9fea83c92a67124661456e35e77c305b59bf34e7cfb2cc1d7c07fa7d0432f4b610d893ac3115353769fccff1bf12dfc2f044cc169259fe318124927
+  metadata.gz: 99523e0d23a2e0feba7df3af2dbc3ad70291066c866437cee9cbce839a32373b837ee2e8dedc82151b2abe9faf1003794ad0cb05e570b197ebb38a86d2a12f03
+  data.tar.gz: 485f0e6e33c18224e5593a3e33afcc9d35098fe0f10aa56c7cab22fabf20e3cb633d2f700a72d7ece2f3d9abea25cc3f3a4cce779358b5838d427feafd1609c4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master
 
+## 0.1.0
+
+* extract and show todo text as well - hanneskaeufler
+* much more robust todo matching - hanneskaeufler
+
 ## 0.0.3
 
 * Only find newly introduced todos - hanneskaeufler

data/lib/todoist/diff_todo_finder.rb

@@ -1,22 +1,29 @@
 module Danger
   # Identify todos in a set of diffs
   class DiffTodoFinder
-    TODO_REGEXP = /\+.*(TODO|FIXME)[\s:]/i
+    TODO_REGEXP = /
+      ^\+                 # we only look at additions, marked by + in diffs
+      \s*                 # followed by optional space
+      [^a-z0-9]*          # anything looking like a comment indicator
+      \s+                 # followed by at least one space
+      (TODO|FIXME)        # our todo indicator
+      [\s:]{1}            # followed by a space or colon
+      (?<text>.*)$        # matching any text until the end of the line
+    /ix
 
     def find_diffs_containing_todos(diffs)
-      diffs
-        .select { |diff| contains_new_todo(diff) }
-        .map { |diff| Todo.new(diff.path) }
-    end
-
-    private
+      todos = []
+      diffs.each do |diff|
+        matches = diff.patch.match(TODO_REGEXP)
+        next if matches.nil?
 
-    def contains_new_todo(diff)
-      # TODO: This will match removed todos as well
-      !(diff.patch =~ TODO_REGEXP).nil?
+        text = matches[1] if matches[1]
+        todos << Todo.new(diff.path, text.strip)
+      end
+      todos
     end
 
-    class Todo < Struct.new(:file)
+    class Todo < Struct.new(:file, :text)
     end
   end
 end

data/lib/todoist/gem_version.rb

@@ -1,3 +1,3 @@
 module Todoist
-  VERSION = "0.0.3".freeze
+  VERSION = "0.1.0".freeze
 end

data/lib/todoist/plugin.rb

@@ -55,7 +55,10 @@ module Danger
 
       markdown("#### Todos left in files")
 
-      @todos.each { |todo| markdown("- #{todo.file}") }
+      @todos.each do |todo|
+        text = ": #{todo.text}" if todo.text
+        markdown("- #{todo.file}#{text}")
+      end
     end
 
     private

data/spec/diff_todo_finder_spec.rb

@@ -11,7 +11,23 @@ module Danger
             Git::Diff::DiffFile.new(
               "base",
               path:  "some/file.rb",
-              patch: "+ #{marker} some todo"
+              patch: "+ # #{marker} some todo"
+            )
+          ]
+
+          todos = subject.find_diffs_containing_todos(diffs)
+
+          expect(todos).to_not be_empty
+        end
+      end
+
+      %w(# {{ -- //).each do |comment|
+        it "identifies todos in languages with '#{comment}' as comments" do
+          diffs = [
+            Git::Diff::DiffFile.new(
+              "base",
+              path:  "some/file.rb",
+              patch: "+ #{comment} TODO: some todo"
             )
           ]
 
@@ -38,9 +54,13 @@ module Danger
       [
         "+ class TodosController",
         "+ function foo(todo) {",
-        "+ def todo()"
+        "+ def todo()",
+        "+ def todo foo",
+        "+ * this looks like a todo but isnt",
+        "+ TODO_REGEXP = /",
+        "+          todos = subject.find_diffs_containing_todos(diffs)"
       ].each do |patch|
-        it "does not identify occurences in e.g. a new class name" do
+        it "does not identify occurences in '#{patch}'" do
           diffs = [
             Git::Diff::DiffFile.new(
               "base",
@@ -54,6 +74,20 @@ module Danger
           expect(todos).to be_empty
         end
       end
+
+      it "identifies the todo text as well" do
+        diffs = [
+          Git::Diff::DiffFile.new(
+            "base",
+            path:  "some/file.rb",
+            patch: "+ # TODO: practice you must"
+          )
+        ]
+
+        todos = subject.find_diffs_containing_todos(diffs)
+
+        expect(todos.first.text).to eql("practice you must")
+      end
     end
   end
 end

data/spec/todoist_spec.rb

@@ -17,12 +17,12 @@ module Danger
           modified = Git::Diff::DiffFile.new(
             "base",
             path:  "some/file.rb",
-            patch: "+ TODO: some todo"
+            patch: "+ # TODO: some todo"
           )
           added = Git::Diff::DiffFile.new(
             "base",
             path:  "another/stuff.rb",
-            patch: "+ fixme: another todo"
+            patch: "+ # fixme: another todo"
           )
 
           allow(@dangerfile.git).to receive(:diff_for_file)
@@ -59,8 +59,8 @@ module Danger
           expect(markdowns).to eq(
             [
               "#### Todos left in files",
-              "- some/file.rb",
-              "- another/stuff.rb"
+              "- some/file.rb: some todo",
+              "- another/stuff.rb: another todo"
             ]
           )
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-todoist
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Hannes Käufler