danger-todoist 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 963bf19dfcad9629d89f40c8f237618c1f69c2a1
-  data.tar.gz: 89e8d53b71cc005750a9d96eda9243b604c12125
+  metadata.gz: 6c36d110785f3189707375cac0476f44b4acd8ec
+  data.tar.gz: 7612717fc4b352dc74d77c8e675046cb30dd79dd
 SHA512:
-  metadata.gz: 5153ffc9cc8daeae7f893a440399a3e0a1a227db1fd9a8c7880ca14c5122656df3aca73baffea70ac56af3631477bb6a57e858471d1201ee05f3cc0e33dd8354
-  data.tar.gz: aad90c81b1f8f581a2732b29080f78885a61a2ff303b4c7043e9744c83b53326d77efd07cd87a53489fa134db37ab2a000bb1ab94d007492e3fe9a5638691db9
+  metadata.gz: 163b2adc591716885f98dcdbcd868b81c20d4bbcaedde0d0e55096bcea8f975168ff5a8b167a3624660fab15e71aaa5e15c5fffa9e605e88bd586f014bf73396
+  data.tar.gz: 202815e4b3142852421f26b183ac10c9ef1de906b918ff1f44c74173430ccc62c1a4630f09415d54cfe1e530e54c21332619bf07f60f7338cc2fc9c53246f8a5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master
 
+## 0.3.0
+
+* exposed `todoist.todos` to dangerfile - hanneskaeufler
+
 ## 0.2.0
 
 * warning is not sticky anymore - hanneskaeufler

data/README.md

@@ -15,14 +15,21 @@ A description of danger-todoist.
 
 ### todoist
 
-<blockquote>Ensure there are no TODOS left in the modified code
+This is a danger plugin to detect any TODO/FIXME entries left in the code.
+
+<blockquote>Ensure, by warning, there are no TODOS left in the modified code
   <pre>
 todoist.warn_for_todos</pre>
 </blockquote>
 
-<blockquote>Set custom warning message
+<blockquote>Ensure, by failing the build, no TODOS left in the modified code
   <pre>
-todois.message = "Please fix all TODOS"
+todoist.fail_for_todos</pre>
+</blockquote>
+
+<blockquote>Set custom warning message for warning
+  <pre>
+todoist.message = "Please fix all TODOS"
 todoist.warn_for_todos</pre>
 </blockquote>
 
@@ -32,6 +39,11 @@ todoist.warn_for_todos
 todoist.print_todos_table</pre>
 </blockquote>
 
+<blockquote>Do anything with the todos. Todos have `text` and `file` properties
+  <pre>
+todoist.todos.each { |todo| puts todo.text }</pre>
+</blockquote>
+
 #### Attributes
 
 `message` - Message to be shown
@@ -40,8 +52,12 @@ todoist.print_todos_table</pre>
 
 `warn_for_todos` - Adds a warning if there are todos found in the modified code
 
+`fail_for_todos` - Adds an error if there are todos found in the modified code
+
 `print_todos_table` - Adds a list of offending files to the danger comment
 
+`todos` - Returns the list of todos in the current diff set
+
 ## Development
 
 1. Clone this repo

data/lib/danger_plugin.rb

@@ -1,2 +1,3 @@
 require "todoist/plugin"
 require "todoist/diff_todo_finder"
+require "todoist/todo"

data/lib/todoist/diff_todo_finder.rb

@@ -18,13 +18,10 @@ module Danger
         next if matches.empty?
 
         matches.each do |match|
-          todos << Todo.new(diff.path, match.first.strip)
+          todos << Danger::Todo.new(diff.path, match.first.strip)
         end
       end
       todos
     end
-
-    class Todo < Struct.new(:file, :text)
-    end
   end
 end

data/lib/todoist/gem_version.rb

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

data/lib/todoist/plugin.rb

@@ -20,6 +20,10 @@ module Danger
   #          todoist.warn_for_todos
   #          todoist.print_todos_table
   #
+  # @example Do anything with the todos. Todos have `text` and `file` properties
+  #
+  #          todoist.todos.each { |todo| puts todo.text }
+  #
   # @see  hanneskaeufler/danger-todoist
   # @tags todos, fixme
   #
@@ -58,7 +62,7 @@ module Danger
     # @return [void]
     #
     def print_todos_table
-      return if @todos.nil?
+      find_todos if @todos.nil?
       return if @todos.empty?
 
       markdown("#### Todos left in files")
@@ -69,15 +73,28 @@ module Danger
       end
     end
 
+    #
+    # Returns the list of todos in the current diff set
+    #
+    # @return [Array of todos]
+    #
+    def todos
+      find_todos if @todos.nil?
+      @todos
+    end
+
     private
 
     def call_method_for_todos(method)
+      find_todos if @todos.nil?
+      public_send(method, message, sticky: false) unless @todos.empty?
+    end
+
+    def find_todos
       @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

data/lib/todoist/todo.rb

@@ -0,0 +1,4 @@
+module Danger
+  class Todo < Struct.new(:file, :text)
+  end
+end

data/spec/todoist_spec.rb

@@ -26,12 +26,10 @@ module Danger
           )
 
           allow(@dangerfile.git).to receive(:diff_for_file)
-            .with("some/file.rb")
-            .and_return(modified)
+            .with("some/file.rb").and_return(modified)
 
           allow(@dangerfile.git).to receive(:diff_for_file)
-            .with("another/stuff.rb")
-            .and_return(added)
+            .with("another/stuff.rb").and_return(added)
 
           allow(@dangerfile.git).to receive(:modified_files)
             .and_return(["some/file.rb"])
@@ -58,8 +56,7 @@ module Danger
           expect(warnings).to eq(["changed message"])
         end
 
-        it "can print a report" do
-          @todoist.warn_for_todos
+        it "can print a report, even without warning first" do
           @todoist.print_todos_table
 
           expect(markdowns).to eq(
@@ -70,6 +67,12 @@ module Danger
             ]
           )
         end
+
+        it "exposes todos to the dangerfile" do
+          expect(@todoist.todos.length).to eq(2)
+          expect(@todoist.todos.first.text).to eq("some todo")
+          expect(@todoist.todos.last.file).to eq("another/stuff.rb")
+        end
       end
 
       context "changed files not containing a todo" do
@@ -80,8 +83,7 @@ module Danger
             patch: "+ some added line"
           )
           allow(@dangerfile.git).to receive(:diff_for_file)
-            .with("some/file.rb")
-            .and_return(modified)
+            .with("some/file.rb").and_return(modified)
 
           allow(@dangerfile.git).to receive(:modified_files)
             .and_return(["some/file.rb"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-todoist
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Hannes Käufler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -173,6 +173,7 @@ files:
 - lib/todoist/diff_todo_finder.rb
 - lib/todoist/gem_version.rb
 - lib/todoist/plugin.rb
+- lib/todoist/todo.rb
 - spec/diff_todo_finder_spec.rb
 - spec/spec_helper.rb
 - spec/todoist_spec.rb