danger-todoist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee3034cbc74c2f326f4ae999d205832415ff0d8
-  data.tar.gz: c81b838cf5d97b239d02348ee2599210d32be027
+  metadata.gz: 963bf19dfcad9629d89f40c8f237618c1f69c2a1
+  data.tar.gz: 89e8d53b71cc005750a9d96eda9243b604c12125
 SHA512:
-  metadata.gz: 99523e0d23a2e0feba7df3af2dbc3ad70291066c866437cee9cbce839a32373b837ee2e8dedc82151b2abe9faf1003794ad0cb05e570b197ebb38a86d2a12f03
-  data.tar.gz: 485f0e6e33c18224e5593a3e33afcc9d35098fe0f10aa56c7cab22fabf20e3cb633d2f700a72d7ece2f3d9abea25cc3f3a4cce779358b5838d427feafd1609c4
+  metadata.gz: 5153ffc9cc8daeae7f893a440399a3e0a1a227db1fd9a8c7880ca14c5122656df3aca73baffea70ac56af3631477bb6a57e858471d1201ee05f3cc0e33dd8354
+  data.tar.gz: aad90c81b1f8f581a2732b29080f78885a61a2ff303b4c7043e9744c83b53326d77efd07cd87a53489fa134db37ab2a000bb1ab94d007492e3fe9a5638691db9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## master
 
+## 0.2.0
+
+* warning is not sticky anymore - hanneskaeufler
+* add `fail_for_todos` to fail instead of warn - hanneskaeufler
+* find multiple todos in the same diff - hanneskaeufler
+
 ## 0.1.0
 
 * extract and show todo text as well - hanneskaeufler

data/lib/todoist/diff_todo_finder.rb

@@ -4,7 +4,7 @@ module Danger
     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
+      [^a-z0-9\+]*        # anything looking like a comment indicator, not a +
       \s+                 # followed by at least one space
       (TODO|FIXME)        # our todo indicator
       [\s:]{1}            # followed by a space or colon
@@ -14,11 +14,12 @@ module Danger
     def find_diffs_containing_todos(diffs)
       todos = []
       diffs.each do |diff|
-        matches = diff.patch.match(TODO_REGEXP)
-        next if matches.nil?
+        matches = diff.patch.scan(TODO_REGEXP)
+        next if matches.empty?
 
-        text = matches[1] if matches[1]
-        todos << Todo.new(diff.path, text.strip)
+        matches.each do |match|
+          todos << Todo.new(diff.path, match.first.strip)
+        end
       end
       todos
     end

data/lib/todoist/gem_version.rb

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

data/lib/todoist/plugin.rb

@@ -2,13 +2,17 @@ module Danger
   #
   # This is a danger plugin to detect any TODO/FIXME entries left in the code.
   #
-  # @example Ensure there are no TODOS left in the modified code
+  # @example Ensure, by warning, there are no TODOS left in the modified code
   #
   #          todoist.warn_for_todos
   #
-  # @example Set custom warning message
+  # @example Ensure, by failing the build, no TODOS left in the modified code
   #
-  #          todois.message = "Please fix all TODOS"
+  #          todoist.fail_for_todos
+  #
+  # @example Set custom warning message for warning
+  #
+  #          todoist.message = "Please fix all TODOS"
   #          todoist.warn_for_todos
   #
   # @example List every todo item
@@ -36,12 +40,16 @@ module Danger
     # @return [void]
     #
     def warn_for_todos
-      @todos = []
-      return if files_of_interest.empty?
-
-      @todos = DiffTodoFinder.new.find_diffs_containing_todos(diffs_of_interest)
+      call_method_for_todos(:warn)
+    end
 
-      warn(message) unless @todos.empty?
+    #
+    # Adds an error if there are todos found in the modified code
+    #
+    # @return [void]
+    #
+    def fail_for_todos
+      call_method_for_todos(:fail)
     end
 
     #
@@ -63,6 +71,15 @@ module Danger
 
     private
 
+    def call_method_for_todos(method)
+      @todos = []
+      return if files_of_interest.empty?
+
+      @todos = DiffTodoFinder.new.find_diffs_containing_todos(diffs_of_interest)
+
+      public_send(method, message, sticky: false) unless @todos.empty?
+    end
+
     def message
       return @message unless @message.nil?
       DEFAULT_MESSAGE

data/spec/diff_todo_finder_spec.rb

@@ -58,7 +58,8 @@ module Danger
         "+ def todo foo",
         "+ * this looks like a todo but isnt",
         "+ TODO_REGEXP = /",
-        "+          todos = subject.find_diffs_containing_todos(diffs)"
+        "+          todos = subject.find_diffs_containing_todos(diffs)",
+        "++ # FIXME: with you the force is"
       ].each do |patch|
         it "does not identify occurences in '#{patch}'" do
           diffs = [
@@ -88,6 +89,29 @@ module Danger
 
         expect(todos.first.text).to eql("practice you must")
       end
+
+      it "finds multiple todos in the same diff" do
+        patch = <<PATCH
++ # TODO: practice you must
++ def practice
++   return false
++ end
++ # FIXME: with you the force is
+PATCH
+
+        diffs = [
+          Git::Diff::DiffFile.new(
+            "base",
+            path:  "some/file.rb",
+            patch: patch
+          )
+        ]
+
+        todos = subject.find_diffs_containing_todos(diffs)
+
+        expect(todos.map(&:text))
+          .to eql(["practice you must", "with you the force is"])
+      end
     end
   end
 end

data/spec/todoist_spec.rb

@@ -34,9 +34,9 @@ module Danger
             .and_return(added)
 
           allow(@dangerfile.git).to receive(:modified_files)
-            .and_return([modified_with_todo])
+            .and_return(["some/file.rb"])
           allow(@dangerfile.git).to receive(:added_files)
-            .and_return([added_with_todo])
+            .and_return(["another/stuff.rb"])
         end
 
         it "warns when files in the changeset" do
@@ -45,6 +45,12 @@ module Danger
           expect(warnings).to eq([DangerTodoist::DEFAULT_MESSAGE])
         end
 
+        it "fails when files in the changeset" do
+          @todoist.fail_for_todos
+
+          expect(failures).to eq([DangerTodoist::DEFAULT_MESSAGE])
+        end
+
         it "allows the message to be changed" do
           @todoist.message = "changed message"
           @todoist.warn_for_todos
@@ -78,7 +84,7 @@ module Danger
             .and_return(modified)
 
           allow(@dangerfile.git).to receive(:modified_files)
-            .and_return([modified_with_todo])
+            .and_return(["some/file.rb"])
           allow(@dangerfile.git).to receive(:added_files).and_return([])
         end
 
@@ -103,12 +109,8 @@ module Danger
       end
     end
 
-    def modified_with_todo
-      "some/file.rb"
-    end
-
-    def added_with_todo
-      "another/stuff.rb"
+    def failures
+      @dangerfile.status_report[:errors]
     end
 
     def warnings

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-todoist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hannes Käufler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api