danger-todoist 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c36d110785f3189707375cac0476f44b4acd8ec
-  data.tar.gz: 7612717fc4b352dc74d77c8e675046cb30dd79dd
+  metadata.gz: cd9c28016359b27e3cc65bfee31b76086743db32
+  data.tar.gz: 6f24675207d0aef9ce0ef092fca5b8431d91327c
 SHA512:
-  metadata.gz: 163b2adc591716885f98dcdbcd868b81c20d4bbcaedde0d0e55096bcea8f975168ff5a8b167a3624660fab15e71aaa5e15c5fffa9e605e88bd586f014bf73396
-  data.tar.gz: 202815e4b3142852421f26b183ac10c9ef1de906b918ff1f44c74173430ccc62c1a4630f09415d54cfe1e530e54c21332619bf07f60f7338cc2fc9c53246f8a5
+  metadata.gz: d67dc9615ec24a7e81100f9855194a0d07c97ff6fbae3cf9f4a4582486a310c7e86ece35d497a31f9dbe9d0d445bfe3c77c79b3c6ff880a6defeeda2f8a4e697
+  data.tar.gz: 82c158c181261b48cdefa2d5918aa999be4514ec4ca5f3edadfc0c0014b773855818b66e0187e3dc3764defa80e0140565e90c9800fc3ab05ac0b6022d81175d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master
 
+## 1.0.0
+
+* group todos by file - hanneskaeufler
+
 ## 0.3.0
 
 * exposed `todoist.todos` to dangerfile - hanneskaeufler

data/README.md

@@ -2,21 +2,18 @@
 
 # danger-todoist
 
-A description of danger-todoist.
+danger-todoist is a [https://danger.systems](danger) plugin to automatically notify you of
+todos left in the code of a pull/merge request.
 
 ## Installation
 
-    $ gem install danger-todoist
+Add `gem 'danger-todoist'` to your `Gemfile` and start using todoist in your `Dangerfile`.
 
 ## Usage
 
     Methods and attributes from this plugin are available in
     your `Dangerfile` under the `todoist` namespace.
 
-### todoist
-
-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>

data/lib/todoist/gem_version.rb

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

data/lib/todoist/plugin.rb

@@ -67,10 +67,9 @@ module Danger
 
       markdown("#### Todos left in files")
 
-      @todos.each do |todo|
-        text = ": #{todo.text}" if todo.text
-        markdown("- #{todo.file}#{text}")
-      end
+      @todos
+        .group_by(&:file)
+        .each { |file, todos| print_todos_per_file(file, todos) }
     end
 
     #
@@ -85,6 +84,13 @@ module Danger
 
     private
 
+    def print_todos_per_file(file, todos)
+      markdown("- #{file}")
+      todos
+        .select(&:text)
+        .each { |todo| markdown("  - #{todo.text}") }
+    end
+
     def call_method_for_todos(method)
       find_todos if @todos.nil?
       public_send(method, message, sticky: false) unless @todos.empty?

data/spec/spec_helper.rb

@@ -57,3 +57,15 @@ def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)
 end
+
+def failures
+  @dangerfile.status_report[:errors]
+end
+
+def warnings
+  @dangerfile.status_report[:warnings]
+end
+
+def markdowns
+  @dangerfile.status_report[:markdowns].map(&:message)
+end

data/spec/todoist_spec.rb

@@ -14,10 +14,17 @@ module Danger
 
       context "changed files containing newly introduced todos" do
         before do
+          patch = <<PATCH
++ # TODO: some todo
++ def foo
++ end
++ # TODO: more todo in same file
+PATCH
+
           modified = Git::Diff::DiffFile.new(
             "base",
             path:  "some/file.rb",
-            patch: "+ # TODO: some todo"
+            patch: patch
           )
           added = Git::Diff::DiffFile.new(
             "base",
@@ -62,14 +69,17 @@ module Danger
           expect(markdowns).to eq(
             [
               "#### Todos left in files",
-              "- some/file.rb: some todo",
-              "- another/stuff.rb: another todo"
+              "- some/file.rb",
+              "  - some todo",
+              "  - more todo in same file",
+              "- another/stuff.rb",
+              "  - another todo"
             ]
           )
         end
 
         it "exposes todos to the dangerfile" do
-          expect(@todoist.todos.length).to eq(2)
+          expect(@todoist.todos.length).to eq(3)
           expect(@todoist.todos.first.text).to eq("some todo")
           expect(@todoist.todos.last.file).to eq("another/stuff.rb")
         end
@@ -104,23 +114,13 @@ module Danger
         allow(@dangerfile.git).to receive(:added_files).and_return([])
 
         @todoist.warn_for_todos
+        @todoist.fail_for_todos
         @todoist.print_todos_table
 
         expect(warnings).to be_empty
+        expect(failures).to be_empty
         expect(markdowns).to be_empty
       end
     end
-
-    def failures
-      @dangerfile.status_report[:errors]
-    end
-
-    def warnings
-      @dangerfile.status_report[:warnings]
-    end
-
-    def markdowns
-      @dangerfile.status_report[:markdowns].map(&:message)
-    end
   end
 end

metadata

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