danger-todoist 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7782f6aba04d5997bb0d3ef2c5e1d50e89565a92
-  data.tar.gz: e02a1a37c15ff38f7b1a0050c5ab9e72f0d69dab
+  metadata.gz: 45658ff29d4eb2568b06f4243fe8c986c1167cef
+  data.tar.gz: 7e772b86afd289fa5340d70fe6b5234b28e64dc9
 SHA512:
-  metadata.gz: 09aadc7a07af5ff482941b9926b40412e4c8d857c065d7fbf94f99d65e715d8b9b25e416cb0dfb2ecfd04823821228c71eda28af095dd7c2090b8733c1ce023d
-  data.tar.gz: 5e82b7e875b6878601c53698e7e63fd558ef0301fc432e9396381b2c0b0ceae205ba63eea79c91ee7dba2bd182f567ede97a6fe483ae4b44fb5d28582c6e4158
+  metadata.gz: 7547e35d1ed8baf09bdca508d9bc61a589f4a94ab5537552aad116dec55cc79b0028a7bbe3b684639c318cae57cf29214e662e0c672df29b45980584685ed4dc
+  data.tar.gz: 279263f5a9fea83c92a67124661456e35e77c305b59bf34e7cfb2cc1d7c07fa7d0432f4b610d893ac3115353769fccff1bf12dfc2f044cc169259fe318124927

data/.travis.yml

@@ -8,5 +8,8 @@ rvm:
   - 2.1.3
   - 2.3.1
 
+before_script:
+  - bundle exec danger
+
 script:
-    - bundle exec rake spec
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## master
+
+## 0.0.3
+
+* Only find newly introduced todos - hanneskaeufler
+* Don't find todos obviously occuring in code - hanneskaeufler
+
+## 0.0.2
+
+* Add documentation - hanneskaeufler
+
+## 0.0.1
+
+ * Initial release - hanneskaeufler

data/Dangerfile

@@ -0,0 +1,16 @@
+# Make it more obvious that a PR is a work in progress and shouldn't be merged yet
+warn("PR is classed as Work in Progress") if github.pr_title.include? "[WIP]"
+
+# Warn when there is a big PR
+warn("Big PR") if git.lines_of_code > 500
+
+# Identify leftover todos
+todoist.message = "There are still some things to do in this PR."
+todoist.warn_for_todos
+todoist.print_todos_table
+
+# Mainly to encourage writing up some reasoning about the PR, rather than
+# just leaving a title
+if github.pr_body.length < 5
+  fail "Please provide a summary in the Pull Request description"
+end

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/hanneskaeufler/danger-todoist.svg?branch=master)](https://travis-ci.org/hanneskaeufler/danger-todoist)
+[![Build Status](https://travis-ci.org/hanneskaeufler/danger-todoist.svg?branch=master)](https://travis-ci.org/hanneskaeufler/danger-todoist) [![Gem Version](https://badge.fury.io/rb/danger-todoist.svg)](https://badge.fury.io/rb/danger-todoist)
 
 # danger-todoist
 

data/lib/danger_plugin.rb

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

data/lib/todoist/diff_todo_finder.rb

@@ -0,0 +1,22 @@
+module Danger
+  # Identify todos in a set of diffs
+  class DiffTodoFinder
+    TODO_REGEXP = /\+.*(TODO|FIXME)[\s:]/i
+
+    def find_diffs_containing_todos(diffs)
+      diffs
+        .select { |diff| contains_new_todo(diff) }
+        .map { |diff| Todo.new(diff.path) }
+    end
+
+    private
+
+    def contains_new_todo(diff)
+      # TODO: This will match removed todos as well
+      !(diff.patch =~ TODO_REGEXP).nil?
+    end
+
+    class Todo < Struct.new(:file)
+    end
+  end
+end

data/lib/todoist/gem_version.rb

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

data/lib/todoist/plugin.rb

@@ -21,7 +21,6 @@ module Danger
   #
   class DangerTodoist < Plugin
     DEFAULT_MESSAGE = "There remain todo items in the modified code.".freeze
-    TODO_REGEXP = /TODO|FIXME/i
 
     #
     # Message to be shown
@@ -40,8 +39,7 @@ module Danger
       @todos = []
       return if files_of_interest.empty?
 
-      diffs_containing_todo_markers
-        .each { |diff| @todos << Todo.new(diff.path) }
+      @todos = DiffTodoFinder.new.find_diffs_containing_todos(diffs_of_interest)
 
       warn(message) unless @todos.empty?
     end
@@ -75,17 +73,5 @@ module Danger
       files_of_interest
         .map { |file| git.diff_for_file(file) }
     end
-
-    def diffs_containing_todo_markers
-      diffs_of_interest
-        .select { |diff| contains_new_todo(diff) }
-    end
-
-    def contains_new_todo(diff)
-      !(diff.patch =~ TODO_REGEXP).nil?
-    end
-
-    class Todo < Struct.new(:file)
-    end
   end
 end

data/spec/diff_todo_finder_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DiffTodoFinder do
+    let(:subject) { Danger::DiffTodoFinder.new }
+
+    describe "#find_diffs_containing_todos" do
+      %w(TODO TODO: todo todo: FIXME fixme FIXME: fixme).each do |marker|
+        it "identifies a new '#{marker}' as a todo" do
+          diffs = [
+            Git::Diff::DiffFile.new(
+              "base",
+              path:  "some/file.rb",
+              patch: "+ #{marker} some todo"
+            )
+          ]
+
+          todos = subject.find_diffs_containing_todos(diffs)
+
+          expect(todos).to_not be_empty
+        end
+      end
+
+      it "does not identify removed todos as a todo" do
+        diffs = [
+          Git::Diff::DiffFile.new(
+            "base",
+            path:  "some/file.rb",
+            patch: "- TODO: some todo"
+          )
+        ]
+
+        todos = subject.find_diffs_containing_todos(diffs)
+
+        expect(todos).to be_empty
+      end
+
+      [
+        "+ class TodosController",
+        "+ function foo(todo) {",
+        "+ def todo()"
+      ].each do |patch|
+        it "does not identify occurences in e.g. a new class name" do
+          diffs = [
+            Git::Diff::DiffFile.new(
+              "base",
+              path:  "some/file.rb",
+              patch: patch
+            )
+          ]
+
+          todos = subject.find_diffs_containing_todos(diffs)
+
+          expect(todos).to be_empty
+        end
+      end
+    end
+  end
+end

data/spec/todoist_spec.rb

@@ -12,7 +12,7 @@ module Danger
         @todoist = @dangerfile.todoist
       end
 
-      context "changed files containing a todo" do
+      context "changed files containing newly introduced todos" do
         before do
           modified = Git::Diff::DiffFile.new(
             "base",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-todoist
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Hannes Käufler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -160,6 +160,8 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
+- Dangerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -168,8 +170,10 @@ files:
 - danger-todoist.gemspec
 - lib/danger_plugin.rb
 - lib/danger_todoist.rb
+- lib/todoist/diff_todo_finder.rb
 - lib/todoist/gem_version.rb
 - lib/todoist/plugin.rb
+- spec/diff_todo_finder_spec.rb
 - spec/spec_helper.rb
 - spec/todoist_spec.rb
 homepage: https://github.com/hanneskaeufler/danger-todoist
@@ -198,5 +202,6 @@ specification_version: 4
 summary: Marking something with a todo is very common during implementing a new feature.
   Often those todos will get missed in code review.
 test_files:
+- spec/diff_todo_finder_spec.rb
 - spec/spec_helper.rb
 - spec/todoist_spec.rb